recursive-diff 1.2.0__tar.gz → 1.3.0__tar.gz

recursive_diff-1.3.0/.dprint.jsonc

@@ -0,0 +1,35 @@
+{
+  "json": {
+    "lineWidth": 88,
+    "array.preferSingleLine": true,
+  },
+  "markdown": {
+    "lineWidth": 88,
+    "emphasisKind": "asterisks",
+  },
+  "markup": {
+    "printWidth": 88,
+  },
+  "toml": {
+    "lineWidth": 88,
+  },
+  "yaml": {
+    "printWidth": 88,
+    "formatComments": true,
+    "braceSpacing": false,
+  },
+  "excludes": [
+    "**/*-lock.json",
+    "**/*.lock",
+    "**/node_modules/",
+    "dist/",
+    "doc/requirements.yml",
+  ],
+  "plugins": [
+    "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.5.1.wasm",
+    "https://plugins.dprint.dev/json-0.20.0.wasm",
+    "https://plugins.dprint.dev/markdown-0.19.0.wasm",
+    "https://plugins.dprint.dev/toml-0.7.0.wasm",
+    "https://plugins.dprint.dev/g-plane/markup_fmt-v0.22.0.wasm",
+  ],
+}

{recursive_diff-1.2.0 → recursive_diff-1.3.0}/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +1,2 @@
 - [ ] Closes #xxxx
 - [ ] Tests added / passed
-- [ ] Passes `pre-commit run --all-files`

recursive_diff-1.3.0/.github/workflows/docs.yml

@@ -0,0 +1,38 @@
+name: Documentation
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ["*"]
+
+defaults:
+  run:
+    shell: bash -l {0}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: prefix-dev/setup-pixi@v0.8.10
+        with:
+          pixi-version: v0.56.0
+          cache: true
+          environments: docs
+
+      - name: Regenerate readthedocs environment
+        run: pixi run doc-requirements
+
+      - name: Check that readthedocs environment is up to date in git
+        run: git diff --exit-code doc/requirements.yml
+
+      - name: Build docs
+        run: pixi run -e docs docs
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: recursive-diff-docs
+          path: build/html

recursive_diff-1.3.0/.github/workflows/lint.yml

@@ -0,0 +1,22 @@
+name: Linting
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ["*"]
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: prefix-dev/setup-pixi@v0.8.10
+        with:
+          pixi-version: v0.56.0
+          cache: true
+          environments: lint
+      - name: Run linters
+        run: pixi run lint
+      - name: Check for changed files after linting
+        run: git diff --exit-code

recursive_diff-1.3.0/.github/workflows/pytest.yml

@@ -0,0 +1,74 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ["*"]
+  workflow_dispatch: # allows you to trigger manually
+
+# When this workflow is queued, automatically cancel any previous running
+# or pending jobs from the same branch
+concurrency:
+  group: pytest-${{ github.ref }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash -l {0}
+
+jobs:
+  test:
+    name: ${{ matrix.os }} ${{ matrix.environment }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest # x86-64
+          - ubuntu-24.04-arm # ARM
+          - macos-15-intel # x86-64
+          - macos-latest # ARM
+          - windows-latest # x86-64
+        environment:
+          - smoke
+          - mindeps
+          - no-optional
+          - py39
+          - py311
+          - py314
+        include:
+          - os: ubuntu-latest
+            environment: upstream
+          - os: ubuntu-latest
+            environment: nogil
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Disregard pixi.lock (upstream only)
+        if: matrix.environment == 'upstream' || matrix.environment == 'nogil'
+        run: rm pixi.lock
+
+      - uses: prefix-dev/setup-pixi@v0.8.10
+        with:
+          pixi-version: v0.56.0
+          environments: ${{ matrix.environment }}
+          cache: ${{ matrix.environment != 'upstream' && matrix.environment != 'nogil' }}
+          locked: ${{ matrix.environment != 'upstream' && matrix.environment != 'nogil' }}
+
+      - name: Smoke test
+        run: pixi run -e ${{ matrix.environment }} smoke-test
+
+      - name: pytest with coverage
+        if: matrix.environment != 'nogil' && matrix.environment != 'smoke'
+        run: pixi run -e ${{ matrix.environment }} coverage
+
+      - name: Free-threading stress test
+        if: matrix.environment == 'nogil'
+        run: pixi run -e nogil tests --parallel-threads=4
+
+      - name: codecov.io
+        if: matrix.environment != 'nogil' && matrix.environment != 'smoke'
+        uses: codecov/codecov-action@v5

recursive_diff-1.3.0/.github/workflows/wheels.yml

@@ -0,0 +1,50 @@
+name: Wheels
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ["*"]
+
+defaults:
+  run:
+    shell: bash -l {0}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch full git history for hatch-vcs
+          fetch-tags: true # Fetch tags for hatch-vcs
+
+      - uses: prefix-dev/setup-pixi@v0.8.10
+        with:
+          pixi-version: v0.56.0
+          cache: true
+          environments: dist
+
+      - name: Build sdist and wheels
+        run: pixi run dist
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Install wheel
+        run: pip install dist/*.whl
+
+      - name: Smoke test
+        working-directory: /tmp
+        run: |
+          cp ${{ github.workspace }}/smoke_test.py .
+          python smoke_test.py
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*
+          if-no-files-found: error

{recursive_diff-1.2.0 → recursive_diff-1.3.0}/.gitignore

@@ -60,3 +60,4 @@ Icon*
 doc/_build
 Untitled.ipynb
 htmlcov/
+.~lock.*

{recursive_diff-1.2.0 → recursive_diff-1.3.0}/.readthedocs.yaml

@@ -6,14 +6,15 @@ build:
     python: mambaforge-22.9
 
 conda:
-  environment: ci/requirements-docs.yml
+  environment: doc/requirements.yml
 
 python:
-   install:
-      - method: pip
-        path: .
+  install:
+    - method: pip
+      path: .
 
 sphinx:
   builder: html
   configuration: doc/conf.py
+  # This is deliberately laxer than the setting in CI
   fail_on_warning: false

{recursive_diff-1.2.0 → recursive_diff-1.3.0}/HOW_TO_RELEASE

@@ -8,7 +8,7 @@ Time required: about an hour.
     (check the date!) and add a brief summary note describing the release at the
     top.
  3. If you have any doubts, run the full test suite one final time!
-      py.test
+      pixi run tests
  4. On the main branch, commit the release in git:
       git commit -a -m 'Release vX.Y.Z'
  5. Tag the release:
@@ -25,10 +25,7 @@ Time required: about an hour.
     We also update the stable branch with `git cherrypick` for documentation
     only fixes that apply the current released version.
  8. Build and test the release package
-      python -m pip install --upgrade build twine
-      rm -rf dist
-      python -m build
-      python -m twine check dist/*
+      pixi run dist
  9. Add a section for the next release to doc/whats-new.rst.
 10. Commit your changes and push to main again:
       git commit -a -m 'Revert to dev version'
@@ -39,7 +36,7 @@ Time required: about an hour.
     "Draft a new release" and paste in the latest from whats-new.rst.
 12. Use twine to register and upload the release on pypi. Be careful, you can't
     take this back!
-      twine upload dist/*
+      pixi run twine-upload
     You will need to be listed as a package owner at
     https://pypi.python.org/pypi/recursive_diff for this to work.
 13. Update the docs. Login to https://readthedocs.org/projects/recursive_diff/versions/
@@ -60,5 +57,6 @@ Time required: about an hour.
 14g.  The next day, test the conda-forge release
         conda search recursive_diff
         conda create -n recursive_diff-test recursive_diff
+        conda activate recursive_diff-test
         conda list
-        python -m 'import recursive_diff'
+        python -c 'import recursive_diff'

{recursive_diff-1.2.0 → recursive_diff-1.3.0}/MANIFEST.in

@@ -2,7 +2,6 @@ include HOW_TO_RELEASE
 include LICENSE
 include *.md
 include *.py
-recursive-include ci *
 recursive-include doc *
 recursive-include recursive_diff *
 prune doc/_build

recursive_diff-1.3.0/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: recursive_diff
+Version: 1.3.0
+Summary: Recursively compare two Python data structures
+Project-URL: homepage, https://github.com/crusaderky/recursive_diff
+Project-URL: issues, https://github.com/crusaderky/recursive_diff/issues
+Project-URL: documentation, https://recursive-diff.readthedocs.io/
+Project-URL: changelog, https://recursive-diff.readthedocs.io/en/latest/whats-new.html
+Author-email: Guido Imperiale <crusaderky@gmail.com>
+License: Apache
+License-File: LICENSE
+Keywords: diff,pandas,recursive,xarray
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Free Threading :: 2 - Beta
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Requires-Dist: numpy>=1.23
+Requires-Dist: pandas>=1.5
+Requires-Dist: xarray>=2023.8.0
+Description-Content-Type: text/plain
+
+Recursively compare two Python data structures

{recursive_diff-1.2.0 → recursive_diff-1.3.0}/README.md

@@ -1,10 +1,11 @@
-recursive_diff
-=============
+# recursive_diff
+
 [![doc-badge](https://github.com/crusaderky/recursive_diff/actions/workflows/docs.yml/badge.svg)](https://github.com/crusaderky/recursive_diff/actions)
-[![pre-commit-badge](https://github.com/crusaderky/recursive_diff/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/crusaderky/recursive_diff/actions)
+[![lint-badge](https://github.com/crusaderky/recursive_diff/actions/workflows/lint.yml/badge.svg)](https://github.com/crusaderky/recursive_diff/actions)
+[![wheels-badge](https://github.com/crusaderky/recursive_diff/actions/workflows/wheels.yml/badge.svg)](https://github.com/crusaderky/recursive_diff/actions)
 [![pytest-badge](https://github.com/crusaderky/recursive_diff/actions/workflows/pytest.yml/badge.svg)](https://github.com/crusaderky/recursive_diff/actions)
 [![codecov-badge](https://codecov.io/gh/crusaderky/recursive_diff/branch/main/graph/badge.svg)](https://codecov.io/gh/crusaderky/recursive_diff/branch/main)
 
 Recursively compare two Python data structures
 
-Full documentation at http://recursive_diff.readthedocs.io/
+Full documentation at http://recursive-diff.readthedocs.io/

{recursive_diff-1.2.0 → recursive_diff-1.3.0}/doc/_static/style.css

@@ -1,15 +1,15 @@
 @import url("theme.css");
 
-.wy-side-nav-search>a img.logo,
-.wy-side-nav-search .wy-dropdown>a img.logo {
-  width: 12rem
+.wy-side-nav-search > a img.logo,
+.wy-side-nav-search .wy-dropdown > a img.logo {
+  width: 12rem;
 }
 
 .wy-side-nav-search {
   background-color: #eee;
 }
 
-.wy-side-nav-search>div.version {
+.wy-side-nav-search > div.version {
   display: none;
 }
 

recursive_diff-1.3.0/doc/_templates/layout.html

@@ -0,0 +1 @@
+{% extends "!layout.html" %} {% set css_files = css_files + ["_static/style.css"] %}

{recursive_diff-1.2.0 → recursive_diff-1.3.0}/doc/api.rst

@@ -1,5 +1,5 @@
-Python API
-**********
+API Reference
+=============
 
 .. autofunction:: recursive_diff.recursive_diff
 

{recursive_diff-1.2.0 → recursive_diff-1.3.0}/doc/conf.py

@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 # documentation build configuration file, created by
 # sphinx-quickstart on Thu Feb  6 18:57:54 2014.
 #
@@ -19,7 +17,7 @@ import recursive_diff
 
 print("python exec:", sys.executable)
 print("sys.path:", sys.path)
-print("TEMPLATE version: ", recursive_diff.__version__)
+print("recursive_diff version: ", recursive_diff.__version__)
 
 
 # -- General configuration ------------------------------------------------
@@ -39,8 +37,8 @@ extensions = [
 ]
 
 extlinks = {
-    "issue": ("https://github.com/crusaderky/recursive_diff/issues/%s", "#"),
-    "pull": ("https://github.com/crusaderky/recursive_diff/pull/%s", "#"),
+    "issue": ("https://github.com/crusaderky/recursive_diff/issues/%s", "#%s"),
+    "pull": ("https://github.com/crusaderky/recursive_diff/pull/%s", "#%s"),
 }
 
 autosummary_generate = True
@@ -59,7 +57,7 @@ master_doc = "index"
 
 # General information about the project.
 project = "recursive_diff"
-copyright = "2018-%s, recursive_diff Developers" % datetime.datetime.now().year
+copyright = f"2018-{datetime.datetime.now().year}, recursive_diff Developers"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -200,7 +198,7 @@ html_last_updated_fmt = today_fmt
 # html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "recursive_diffdoc"
+htmlhelp_basename = "recursive_diff_doc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -296,11 +294,11 @@ texinfo_documents = [
 # texinfo_no_detailmenu = False
 
 
-# Example configuration for intersphinx: refer to the Python standard library.
+# Configuration for intersphinx
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3/", None),
     "dask": ("https://docs.dask.org/en/latest/", None),
     "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
     "numpy": ("https://docs.scipy.org/doc/numpy/", None),
-    "xarray": ("https://xarray.pydata.org/en/stable/", None),
+    "xarray": ("https://docs.xarray.dev/en/stable/", None),
 }

recursive_diff-1.3.0/doc/develop.rst

@@ -0,0 +1,105 @@
+Development Guidelines
+======================
+
+
+Reporting issues
+----------------
+
+If you find a bug or want to suggest a new feature, please report it on the
+`GitHub issues page <https://github.com/crusaderky/recursive_diff/issues>`_.
+
+Before you report an issue, please check if it can still be reproduced with the
+latest version of this software.
+
+For bug reports, please include the following information:
+
+- A description of the bug
+- The expected behavior
+- The actual behavior
+- Steps to reproduce the bug (preferably with a minimal example)
+- Any relevant error messages or stack traces
+
+
+Deploying a development environment
+-----------------------------------
+
+1. Clone this repository with git:
+
+.. code-block:: bash
+
+     git clone git@github.com:crusaderky/recursive_diff.git
+     cd recursive_diff
+
+2. `Install pixi <https://pixi.sh/latest/#installation>`_
+3. To keep a fork in sync with the upstream source:
+
+.. code-block:: bash
+
+   cd recursive_diff
+   git remote add upstream git@github.com:crusaderky/recursive_diff.git
+   git remote -v
+   git fetch -a upstream
+   git checkout main
+   git pull upstream main
+   git push origin main
+
+
+Test
+----
+
+Test using pixi:
+
+.. code-block:: bash
+
+   pixi run tests
+
+Test with coverage:
+
+.. code-block:: bash
+
+   pixi run coverage
+
+Test with coverage and open HTML report in your browser:
+
+.. code-block:: bash
+
+   pixi run open-coverage
+
+
+Code Formatting
+---------------
+
+This project uses several code linters (ruff, mypy, etc.), which are enforced by
+CI. Developers should run them locally before they submit a PR, through the single
+command
+
+.. code-block:: bash
+
+    pixi run lint
+
+Optionally, you may wish to run the linters automatically every time you make a
+git commit. This can be done by running:
+
+.. code-block:: bash
+
+   pixi run install-git-hooks
+
+Now the code linters will be run each time you commit changes.
+You can skip these checks with ``git commit --no-verify`` or with
+the short version ``git commit -n``.
+
+
+Documentation
+-------------
+
+Build the documentation in ``build/html`` using pixi:
+
+.. code-block:: bash
+
+    pixi run docs
+
+Build the documentation and open it in your browser:
+
+.. code-block:: bash
+
+    pixi run open-docs

{recursive_diff-1.2.0 → recursive_diff-1.3.0}/doc/extend.rst

@@ -1,5 +1,5 @@
 Extending recursive_diff/recursive_eq
-*************************************
+=====================================
 
 Without any changes, :func:`~recursive_diff.recursive_diff` and
 :func:`~recursive_diff.recursive_eq` can compare arbitrary objects using the
@@ -43,4 +43,4 @@ collections, will be recursively descended into::
 
     >>> list(recursive_diff(
     ...     Rectangle(1, 2), Rectangle(1.1, 2.7), abs_tol=.5))
-    ['[h]: 2.0 != 2.7 (abs: 7.0e-01, rel: 3.5e-01)']
+    ['[h]: 2.0 != 2.7 (abs: 7.0e-01, rel: 3.5e-01)']

{recursive_diff-1.2.0 → recursive_diff-1.3.0}/doc/index.rst

@@ -1,11 +1,11 @@
 recursive_diff: Compare two Python data structures
-**************************************************
+==================================================
 JSON, YAML and msgpack are massively popular formats used to represent nested data. A
 problem arises when you want to compare two large JSON data structures, because the `==`
 operator will tell you if the two structures differ *somewhere*, but won't tell you
 where*. Additionally, if the structures contain floating-point numbers, == won't allow
 to set a tolerance: 1.00000000000001 is different from 1.0, which is majorly problematic
-as floating point arithmetics are naturally characterised by noise around the 15th
+as floating point arithmetic is naturally characterised by noise around the 15th
 decimal position (the size of the double-precision mantissa). Tests on floating point
 numbers are typically performed with :func:`math.isclose` or :func:`numpy.isclose`,
 which however are not usable if the numbers to be tested lie deep inside a nested
@@ -30,7 +30,7 @@ directories full of NetCDF files, as long as they can be loaded with
 :func:`xarray.open_dataset`.
 
 Examples
-========
+--------
 
 .. code::
 
@@ -82,19 +82,20 @@ py.test output::
     [foo][2][0]: one != two
 
 Index
-=====
+-----
 
 .. toctree::
 
    installing
-   whats-new
-   extend
    api
+   extend
    ncdiff
+   develop
+   whats-new
 
 
 Credits
-=======
+-------
 - recursive_diff, recursive_eq and ncdiff were originally developed by
   Legal & General and released to the open source community in 2018.
 - All boilerplate is from
@@ -102,11 +103,11 @@ Credits
   which in turn is from `xarray`_.
 
 License
-=======
+-------
 
-recursive_diff is available under the open source `Apache License`_.
+This software is available under the open source `Apache License`_.
 
 .. _numpy: http://www.numpy.org
 .. _pandas: https://pandas.pydata.org
-.. _xarray: http://xarray.pydata.org
+.. _xarray: https://docs.xarray.dev
 .. _Apache License: http://www.apache.org/licenses/LICENSE-2.0.html

recursive_diff-1.3.0/doc/installing.rst

@@ -0,0 +1,38 @@
+Installation
+============
+
+Required dependencies
+---------------------
+
+- `xarray <http://xarray.pydata.org/>`__
+- For :doc:`ncdiff`: one or more NetCDF engines;
+  see :func:`xarray.open_dataset`
+
+
+Installing with conda
+---------------------
+
+.. code-block:: bash
+
+    conda install recursive_diff
+
+
+Installing with pip
+-------------------
+
+.. code-block:: bash
+
+    pip install recursive-diff
+
+
+.. _mindeps_policy:
+
+Minimum dependency versions
+---------------------------
+
+This project adopts a rolling policy based on `SPEC 0
+<https://scientific-python.org/specs/spec-0000/>`_ regarding the minimum
+supported version of its dependencies.
+
+You can see the actual minimum tested versions in `pyproject.toml
+<https://github.com/crusaderky/recursive_diff/blob/main/pyproject.toml>`_.

{recursive_diff-1.2.0 → recursive_diff-1.3.0}/doc/ncdiff.rst

@@ -2,6 +2,7 @@ ncdiff
 ======
 Compare either two NetCDF files or all NetCDF files in two directories.
 
+
 Usage
 -----
 ::
@@ -58,6 +59,7 @@ This has the big advantage of simplicity, but a few disadvantages:
   See also `xarray#2039 <https://github.com/pydata/xarray/issues/2039>`_.
 - Huge RAM usage in case of monolithic variables
 
+
 Further limitations
 -------------------
 - Won't compare NetCDF settings, e.g. store version, compression,