dir-content-diff 1.9.1__tar.gz → 1.11.0__tar.gz

dir_content_diff-1.11.0/.codespellrc

@@ -0,0 +1,2 @@
+[codespell]
+skip = .git/*,*.pdf

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/.copier-answers.yml

@@ -1,6 +1,6 @@
 # Changes here will be overwritten by Copier
 
-_commit: 0.1.54
+_commit: 0.1.67
 _src_path: git@bbpgitlab.epfl.ch:neuromath/python-template.git
 author_email: ''
 author_name: Blue Brain Project, EPFL

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/.github/workflows/commitlint.yml

@@ -8,6 +8,8 @@ jobs:
   check-pr-title:
     name: Check PR title
     runs-on: ubuntu-latest
+    env:
+      PR_TITLE: ${{ github.event.pull_request.title }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -16,4 +18,4 @@ jobs:
       - run: npm install -g --force commitlint @commitlint/cli commitlint-plugin-cleanfeet
       - run: npm install conventional-changelog-conventionalcommits
       - run: touch .git/COMMIT_EDITMSG
-      - run: echo "${{ github.event.pull_request.title }}" | commitlint
+      - run: echo "$PR_TITLE" | commitlint

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/.github/workflows/run-tox.yml

@@ -59,7 +59,7 @@ jobs:
         pip install tox
         tox run -e min_versions
     - name: JUnit Report Action
-      uses: mikepenz/action-junit-report@v4
+      uses: mikepenz/action-junit-report@v5
       if: always() # always run even if the previous step fails
       with:
         report_paths: 'reports/pytest-*.xml'

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/.pre-commit-config.yaml

@@ -1,8 +1,6 @@
-default_language_version:
-  python: python3.10
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict
@@ -13,22 +11,22 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
-    rev: v9.5.0
+    rev: v9.18.0
     hooks:
         - id: commitlint
           stages:
             - commit-msg
           additional_dependencies: ['conventional-changelog-conventionalcommits']
   - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
   - repo: https://github.com/psf/black
-    rev: 23.9.1
+    rev: 24.10.0
     hooks:
       - id: black
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.5
+    rev: v2.3.0
     hooks:
       - id: codespell
         args: ["-x", ".codespellignorelines"]
@@ -38,6 +36,6 @@ repos:
       - id: pydocstyle
         additional_dependencies: ["tomli"]
   - repo: https://github.com/PyCQA/flake8
-    rev: 6.1.0
+    rev: 7.1.1
     hooks:
       - id: flake8

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/.pylintrc

@@ -3,6 +3,7 @@ disable=
 	arguments-differ,
 	invalid-name,
 	too-many-lines,
+	too-many-positional-arguments
 
 [FORMAT]
 # Regexp for a line that is allowed to be longer than the limit.

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/.readthedocs.yml

@@ -6,9 +6,9 @@
 version: 2
 
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools:
-    python: "3.9"
+    python: "3.11"
 
 sphinx:
   configuration: docs/source/conf.py

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [1.11.0](https://github.com/BlueBrain/dir-content-diff/compare/1.10.0..1.11.0)
+
+> 6 November 2024
+
+### Build
+
+- Drop support for Python 3.8 (dependabot[bot] - [#66](https://github.com/BlueBrain/dir-content-diff/pull/66))
+
+## [1.10.0](https://github.com/BlueBrain/dir-content-diff/compare/1.9.1..1.10.0)
+
+> 10 September 2024
+
+### New Features
+
+- Add parameters for load and save methods of base comparators (Adrien Berchet - [#64](https://github.com/BlueBrain/dir-content-diff/pull/64))
+
 ## [1.9.1](https://github.com/BlueBrain/dir-content-diff/compare/1.9.0..1.9.1)
 
 > 29 August 2024

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/CONTRIBUTING.md

@@ -59,7 +59,7 @@ When you wish to contribute to the code base, please consider the following guid
   or
 
   ```shell
-  tox -e py310 -e lint -e docs -e check-packaging
+  tox run -e py39,lint,docs,check-packaging
   ```
 
 * Commit your changes using a descriptive commit message.

{dir_content_diff-1.9.1/dir_content_diff.egg-info → dir_content_diff-1.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dir-content-diff
-Version: 1.9.1
+Version: 1.11.0
 Summary: Simple tool to compare directory contents.
 Home-page: https://dir-content-diff.readthedocs.io
 Author: Blue Brain Project, EPFL
@@ -46,7 +46,7 @@ Requires-Dist: rst2pdf>=0.99; extra == "test"
 Requires-Dist: packaging>=20; extra == "test"
 Requires-Dist: pandas>=1.4; extra == "test"
 Requires-Dist: pytest>=6.2; extra == "test"
-Requires-Dist: pytest-html<4,>=2; extra == "test"
+Requires-Dist: pytest-html>=3.2; extra == "test"
 Provides-Extra: pandas
 Requires-Dist: pandas>=1.4; extra == "pandas"
 Requires-Dist: pyarrow>=11; extra == "pandas"

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/dir_content_diff/__init__.py

@@ -2,6 +2,7 @@
 
 Simple tool to compare directory contents.
 """
+
 import copy
 import importlib.metadata
 import re
@@ -176,18 +177,22 @@ def export_formatted_file(file, formatted_file, comparator, **kwargs):
             file,
             **kwargs.get(
                 "load_kwargs",
-                comparator._default_load_kwargs
-                if hasattr(comparator, "_default_load_kwargs")
-                else {},
+                (
+                    comparator._default_load_kwargs
+                    if hasattr(comparator, "_default_load_kwargs")
+                    else {}
+                ),
             ),
         )
         formatted_data = comparator.format_data(
             data,
             **kwargs.get(
                 "format_data_kwargs",
-                comparator._default_format_data_kwargs
-                if hasattr(comparator, "_default_format_data_kwargs")
-                else {},
+                (
+                    comparator._default_format_data_kwargs
+                    if hasattr(comparator, "_default_format_data_kwargs")
+                    else {}
+                ),
             ),
         )
         Path(formatted_file).parent.mkdir(parents=True, exist_ok=True)
@@ -196,9 +201,11 @@ def export_formatted_file(file, formatted_file, comparator, **kwargs):
             formatted_file,
             **kwargs.get(
                 "save_kwargs",
-                comparator._default_save_kwargs
-                if hasattr(comparator, "_default_save_kwargs")
-                else {},
+                (
+                    comparator._default_save_kwargs
+                    if hasattr(comparator, "_default_save_kwargs")
+                    else {}
+                ),
             ),
         )
     else:

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/dir_content_diff/base_comparators.py

@@ -1,4 +1,5 @@
 """Module containing the base comparators."""
+
 import configparser
 import filecmp
 import json
@@ -406,16 +407,16 @@ class JsonComparator(DictComparator):
     This comparator is based on the :class:`DictComparator` and uses the same parameters.
     """
 
-    def load(self, path):
+    def load(self, path, **kwargs):
         """Open a JSON file."""
         with open(path) as file:  # pylint: disable=unspecified-encoding
-            data = json.load(file)
+            data = json.load(file, **kwargs)
         return data
 
-    def save(self, data, path):
+    def save(self, data, path, **kwargs):
         """Save formatted data into a JSON file."""
         with open(path, "w", encoding="utf-8") as file:
-            json.dump(data, file)
+            json.dump(data, file, **kwargs)
 
 
 class YamlComparator(DictComparator):
@@ -424,16 +425,16 @@ class YamlComparator(DictComparator):
     This comparator is based on the :class:`DictComparator` and uses the same parameters.
     """
 
-    def load(self, path):
+    def load(self, path, **kwargs):
         """Open a YAML file."""
         with open(path) as file:  # pylint: disable=unspecified-encoding
-            data = yaml.full_load(file)
+            data = yaml.full_load(file, **kwargs)
         return data
 
-    def save(self, data, path):
+    def save(self, data, path, **kwargs):
         """Save formatted data into a YAML file."""
         with open(path, "w", encoding="utf-8") as file:
-            yaml.dump(data, file)
+            yaml.dump(data, file, **kwargs)
 
 
 class XmlComparator(DictComparator):
@@ -468,10 +469,10 @@ class XmlComparator(DictComparator):
             data = self.xmltodict(file.read())
         return data
 
-    def save(self, data, path):
+    def save(self, data, path, root=False, **kwargs):
         """Save formatted data into a XML file."""
         with open(path, "w", encoding="utf-8") as file:
-            file.write(dicttoxml(data["root"]).decode())
+            file.write(dicttoxml(data, root=root, **kwargs).decode())
 
     @staticmethod
     def _cast_from_attribute(text, attr):
@@ -544,10 +545,10 @@ class IniComparator(DictComparator):
         data.read(path)
         return self.configparser_to_dict(data)
 
-    def save(self, data, path):
+    def save(self, data, path, **kwargs):
         """Save formatted data into a INI file."""
         with open(path, "w", encoding="utf-8") as file:
-            self.dict_to_configparser(data).write(file)
+            self.dict_to_configparser(data, **kwargs).write(file)
 
     @staticmethod
     def configparser_to_dict(config):

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/dir_content_diff/comparators/morphio.py

@@ -1,4 +1,5 @@
 """Extension module to process morphology files with MorphIO and morph-tool."""
+
 from dir_content_diff import register_comparator
 from dir_content_diff.base_comparators import BaseComparator
 from dir_content_diff.util import import_error_message

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/dir_content_diff/comparators/pandas.py

@@ -1,4 +1,5 @@
 """Extension module to process files with Pandas."""
+
 from dir_content_diff import register_comparator
 from dir_content_diff.base_comparators import BaseComparator
 from dir_content_diff.util import import_error_message

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/dir_content_diff/comparators/voxcell.py

@@ -1,4 +1,5 @@
 """Extension module to process files with Voxcell."""
+
 from dir_content_diff import register_comparator
 from dir_content_diff.base_comparators import BaseComparator
 from dir_content_diff.comparators.pandas import DataframeComparator

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/dir_content_diff/pytest_plugin.py

@@ -11,6 +11,7 @@ When this feature is triggered, the files that are processed by a comparator wit
 capability will be formatted and exported to a directory whose name is built from the compared
 directory with a suffix added. The default suffix is ``_FORMATTED`` and can be customized.
 """
+
 from dir_content_diff import _DEFAULT_EXPORT_SUFFIX
 from dir_content_diff import assert_equal_trees
 

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/dir_content_diff/util.py

@@ -1,4 +1,5 @@
 """Some utils used by the ``dir-content-diff`` package."""
+
 import importlib.resources
 import json
 import logging

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0/dir_content_diff.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dir-content-diff
-Version: 1.9.1
+Version: 1.11.0
 Summary: Simple tool to compare directory contents.
 Home-page: https://dir-content-diff.readthedocs.io
 Author: Blue Brain Project, EPFL
@@ -46,7 +46,7 @@ Requires-Dist: rst2pdf>=0.99; extra == "test"
 Requires-Dist: packaging>=20; extra == "test"
 Requires-Dist: pandas>=1.4; extra == "test"
 Requires-Dist: pytest>=6.2; extra == "test"
-Requires-Dist: pytest-html<4,>=2; extra == "test"
+Requires-Dist: pytest-html>=3.2; extra == "test"
 Provides-Extra: pandas
 Requires-Dist: pandas>=1.4; extra == "pandas"
 Requires-Dist: pyarrow>=11; extra == "pandas"

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/dir_content_diff.egg-info/requires.txt

@@ -35,7 +35,7 @@ rst2pdf>=0.99
 packaging>=20
 pandas>=1.4
 pytest>=6.2
-pytest-html<4,>=2
+pytest-html>=3.2
 
 [voxcell]
 voxcell>=3.1.1

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/docs/source/conf.py

@@ -14,10 +14,11 @@ from importlib import metadata
 
 # -- Project information -----------------------------------------------------
 
-project = "Directory Content Difference"
+project_name = "Directory Content Difference"
+package_name = "dir-content-diff"
 
 # The short X.Y version
-version = metadata.version("dir-content-diff")
+version = metadata.version(package_name)
 
 # The full version, including alpha/beta/rc tags
 release = version
@@ -61,10 +62,10 @@ html_theme = "sphinx-bluebrain-theme"
 # html_static_path = ['_static']
 
 html_theme_options = {
-    "metadata_distribution": "dir-content-diff",
+    "metadata_distribution": package_name,
 }
 
-html_title = project
+html_title = project_name
 
 # If true, links to the reST sources are added to the pages.
 html_show_sourcelink = False

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/setup.py

@@ -1,4 +1,5 @@
 """Setup for the dir-content-diff package."""
+
 import json
 from pathlib import Path
 
@@ -33,7 +34,7 @@ test_reqs = [
     "packaging>=20",
     "pandas>=1.4",
     "pytest>=6.2",
-    "pytest-html>=2,<4",
+    "pytest-html>=3.2",
 ]
 
 setup(

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/tests/comparators/test_morphio.py

@@ -1,4 +1,5 @@
 """Test the MorphIO extensions of the ``dir-content-diff`` package."""
+
 # pylint: disable=redefined-outer-name
 # pylint: disable=unused-argument
 import re

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/tests/comparators/test_pandas.py

@@ -1,4 +1,5 @@
 """Test the Pandas extension of the ``dir-content-diff`` package."""
+
 # pylint: disable=missing-function-docstring
 # pylint: disable=redefined-outer-name
 # pylint: disable=unused-argument

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/tests/comparators/test_voxcell.py

@@ -1,4 +1,5 @@
 """Test the Voxcell extension of the ``dir-content-diff`` package."""
+
 # pylint: disable=missing-function-docstring
 # pylint: disable=redefined-outer-name
 # pylint: disable=unused-argument

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/tests/conftest.py

@@ -1,4 +1,5 @@
 """Configuration for the pytest test suite."""
+
 # pylint: disable=redefined-outer-name
 from pathlib import Path
 

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/tests/generate_test_files.py

@@ -1,4 +1,5 @@
 """Function to create base files used for tests."""
+
 import configparser
 import copy
 import json

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/tests/test_base.py

@@ -1,4 +1,5 @@
 """Test the base features of the ``dir-content-diff`` package."""
+
 # pylint: disable=missing-function-docstring
 # pylint: disable=redefined-outer-name
 # pylint: disable=unused-argument
@@ -410,9 +411,35 @@ class TestBaseComparator:
         assert kwargs_msg in no_report_diff_default
         assert no_report_diff_default.replace(kwargs_msg, "") == diff
 
+    @staticmethod
+    def common_test_load_save(tmp_path, comparator):
+        """Test load and save capabilities of the given comparator."""
+        initial_data = {
+            "a": {
+                "b": 1,
+                "c": [1, 2, 3],
+                "d": {
+                    "test_str": "a str",
+                    "test_int": 999,
+                },
+            }
+        }
+
+        initial_file = tmp_path / "initial_file.json"
+        comparator.save(initial_data, initial_file)
+
+        loaded_data = comparator.load(initial_file)
+
+        assert loaded_data == initial_data
+
     class TestJsonComparator:
         """Test the JSON comparator."""
 
+        def test_load_save(self, tmp_path):
+            """Test load and save capabilities of the comparator."""
+            comparator = dir_content_diff.JsonComparator()
+            TestBaseComparator.common_test_load_save(tmp_path, comparator)
+
         def test_format_data(self):
             """Test data formatting."""
             data = {
@@ -490,6 +517,11 @@ class TestBaseComparator:
     class TestXmlComparator:
         """Test the XML comparator."""
 
+        def test_load_save(self, tmp_path):
+            """Test load and save capabilities of the comparator."""
+            comparator = dir_content_diff.XmlComparator()
+            TestBaseComparator.common_test_load_save(tmp_path, comparator)
+
         def test_xmltodict(self):
             """Test all types of the xmltodict auto cast feature."""
             comparator = dir_content_diff.XmlComparator()
@@ -574,6 +606,11 @@ class TestBaseComparator:
     class TestIniComparator:
         """Test the INI comparator."""
 
+        def test_load_save(self, tmp_path):
+            """Test load and save capabilities of the comparator."""
+            comparator = dir_content_diff.IniComparator()
+            TestBaseComparator.common_test_load_save(tmp_path, comparator)
+
         def test_initodict(self, ref_tree):
             """Test conversion of INI files into dict."""
             data = configparser.ConfigParser()

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/tests/test_missing_deps.py

@@ -1,4 +1,5 @@
 """Test comparators with missing deps."""
+
 import importlib
 from subprocess import run
 

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/tests/test_pytest_plugin.py

@@ -1,4 +1,5 @@
 """Test the pytest plugin."""
+
 # pylint: disable=missing-function-docstring
 # pylint: disable=redefined-outer-name
 # pylint: disable=unused-argument

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/tests/test_util.py

@@ -1,4 +1,5 @@
 """Test the ``dir-content-diff.util`` package."""
+
 import pytest
 
 import dir_content_diff.util

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/tests/test_version.py

@@ -1,4 +1,5 @@
 """Test the version of the ``dir-content-diff`` package."""
+
 from importlib.metadata import version
 
 import dir_content_diff

{dir_content_diff-1.9.1 → dir_content_diff-1.11.0}/tox.ini

@@ -30,6 +30,8 @@ commands =
         --html reports/pytest-{envname}.html \
         --junit-xml=reports/pytest-{envname}.xml \
         --self-contained-html \
+        --durations 10 \
+        --durations-min=2.0 \
         {posargs}
     coverage html -d reports/coverage-{envname}
     coverage xml -o reports/coverage-{envname}.xml
@@ -101,6 +103,6 @@ commands = make html SPHINXOPTS=-W
 [gh-actions]
 python =
   3.9: py39, lint
-  3.10: py310, docs
-  3.11: py311, check-packaging
+  3.10: py310, check-packaging
+  3.11: py311, docs
   3.12: py312

dir_content_diff-1.9.1/.codespellrc

@@ -1,2 +0,0 @@
-[codespell]
-skip = .git/*