fundamental environment renovation - NO FUNCTIONAL CHANGES

Author: c0fec0de

.codespellignore

@@ -0,0 +1,2 @@
+udo
+anchestors

.pre-commit-config.yaml

@@ -1,3 +1,4 @@
+exclude: ^tests/refdata/.*
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.

CONTRIBUTING.md

@@ -12,6 +12,7 @@ Please install these tools:
 * [`make`](https://www.gnu.org/software/make/)
 * [`git`](https://git-scm.com/)
 * [Visual Studio Code](https://code.visualstudio.com/)
+* [`graphviz`](https://graphviz.org/)
 
 
 ### Editor
@@ -31,6 +32,8 @@ make all
 
 See `make help` for any further details.
 
+Please note that `tests/refdata` contains reference data from test runs.
+`make test2refdata` updates this directory.
 
 ## Project Structure
 
@@ -63,6 +66,8 @@ Next to that, there are some temporary files ignored by version control system.
     * 2.x.x can be merged to 3.x.x
 * `main`
     * 2.x.x can be merged to main
+
+
 ### Release
 
 ```bash

Makefile

@@ -31,19 +31,23 @@ test: .venv/.valid ## [ALL] Run Unittests via 'pytest' with {PYTEST_OPTIONS}
 	@echo  "See coverage report:\n\n    file://${PWD}/htmlcov/index.html\n"
 
 
+.PHONY: test2refdata
+test2refdata: .venv/.valid ## Run Unittests via 'pytest' with {PYTEST_OPTIONS} and update tests/refdata
+	rm -rf tests/refdata
+	touch .test2ref
+	${ENV} pytest -vv ${PYTEST_OPTIONS}
+	@echo  "See coverage report:\n\n    file://${PWD}/htmlcov/index.html\n"
+	rm .test2ref
+
+
 .PHONY: checktypes
 checktypes: .venv/.valid ## [ALL] Run Type-Checking via 'mypy'
-	${ENV} mypy .
+	${ENV} mypy src
 
 
 .PHONY: doc
 doc: .venv/.valid ## [ALL] Build Documentation via 'mkdocs'
-	${ENV} mkdocs build --strict
-
-
-.PHONY: doc-serve
-doc-serve: .venv/.valid ## Start Local Documentation Server via 'mkdocs'
-	${ENV} mkdocs serve --no-strict
+	${ENV} make html -C docs
 
 
 .PHONY: code

conftest.py

@@ -5,11 +5,9 @@
 
 @pytest.fixture(autouse=True)
 def _docdir(request):
-
     # Trigger ONLY for the doctests.
     doctest_plugin = request.config.pluginmanager.getplugin("doctest")
     if isinstance(request.node, doctest_plugin.DoctestItem):
-
         # Get the fixture dynamically by its name.
         tmpdir = request.getfixturevalue("tmpdir")
 

docs/index.rst

@@ -17,25 +17,9 @@ Any Python Tree Data
 .. image:: https://readthedocs.org/projects/anytree/badge/?version=stable
     :target: https://anytree.readthedocs.io/en/stable/
 
-.. image:: https://api.codeclimate.com/v1/badges/e6d325d6fd23a93aab20/maintainability
-   :target: https://codeclimate.com/github/c0fec0de/anytree/maintainability
-   :alt: Maintainability
-
 .. image:: https://img.shields.io/pypi/pyversions/anytree.svg
    :target: https://pypi.python.org/pypi/anytree
 
-.. image:: https://img.shields.io/badge/code%20style-pep8-brightgreen.svg
-   :target: https://www.python.org/dev/peps/pep-0008/
-
-.. image:: https://img.shields.io/badge/code%20style-pep257-brightgreen.svg
-   :target: https://www.python.org/dev/peps/pep-0257/
-
-.. image:: https://img.shields.io/badge/linter-pylint-%231674b1?style=flat
-   :target: https://www.pylint.org/
-
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-   :target: https://github.com/psf/black
-
 .. image:: https://img.shields.io/github/contributors/c0fec0de/anytree.svg
    :target: https://github.com/c0fec0de/anytree/graphs/contributors/
 
@@ -204,7 +188,7 @@ Node('/Mary')
 
 **Extending any python class to become a tree node**
 
-The enitre tree magic is encapsulated by :any:`NodeMixin`,
+The entire tree magic is encapsulated by :any:`NodeMixin`,
 add it as base class and the class becomes a tree node:
 
 >>> from anytree import NodeMixin, RenderTree

docs/tricks/consistencychecks.rst

@@ -10,4 +10,3 @@ In case of any concerns about the internal data consistency or just for safety,
 
 >>> import anytree
 >>> anytree.config.ASSERTIONS = True
-

docs/tricks/readonly.rst

@@ -136,4 +136,3 @@ a
 │   └── a1a
 └── a2
     └── a0
-

docs/tricks/weightededges.rst

@@ -42,4 +42,3 @@ a (0)
 ... ).to_picture("weight.png")  # doctest: +SKIP
 
 .. image:: ../static/weight.png
-

docs/tricks/yaml.rst

@@ -98,4 +98,3 @@ AnyNode(a='root')
 .. _YAML: https://en.wikipedia.org/wiki/YAML
 
 .. _PYYAML: http://pyyaml.org/wiki/PyYAMLDocumentation
-

pyproject.toml

@@ -3,18 +3,14 @@
 name = "anytree"
 dynamic = ["version"]
 description = "Powerful and Lightweight Python Tree Data Structure with various plugins"
-authors = [
-    "c0fec0de <[email protected]>"
+authors = [{ name = "c0fec0de", email = "[email protected]" }]
+dependencies = [
+    "six>=1.17.0",
 ]
+requires-python = ">=3.9.2,<4.0"
 readme = "README.rst"
 license = "Apache-2.0"
-keywords = [
-    "tree",
-    "tree data",
-    "treelib",
-    "tree walk",
-    "tree structure",
-]
+keywords = ["tree", "tree data", "treelib", "tree walk", "tree structure"]
 
 classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
@@ -38,12 +34,13 @@ dev = [
     "coveralls>=3.3.1",
     "mypy>=1.9.0",
     "pytest-cov>=5.0.0",
-    "pytest-xdist>=3.6.1",
     "ruff>=0.11.2",
     "pre-commit>=4.2.0",
     "sphinx>=5.3.0",
     "sphinx-rtd-theme>=2.0.0",
     "sphinxemoji>=0.3.1",
+    "test2ref>=0.4.2",
+    "types-six>=1.17.0.20250403",
 ]
 
 [build-system]
@@ -69,72 +66,78 @@ select = [
     # pyflakes
     "F",
     # pycodestyle
-    "E", "W",
+    "E",
+    "W",
     # pydocstyle
     "D",
-    # pep8-naming
-    "N",
-    # flake8-2020
-    "YTT",
-    # flake8-bugbear
-    "B",
-    # flake8-quotes
-    "Q",
-    # flake8-debugger
-    "T10",
-    # flake8-gettext
-    "INT",
-    # pylint
-    "PL",
-    # misc lints
-    "PIE",
-    # flake8-pyi
-    "PYI",
-    # tidy imports
-    "TID",
-    # implicit string concatenation
-    "ISC",
-    # type-checking imports
-    "TC",
-    # comprehensions
-    "C",
-    "C4",
-    # pygrep-hooks
-    "PGH",
-    # Ruff-specific rules
-    "RUF",
-    # flake8-bandit: exec-builtin
-    "S102",
-    # numpy-legacy-random
-    "NPY002",
-    # Perflint
-    "PERF",
-    # flynt
-    "FLY",
-    # flake8-logging-format
-    "G",
-    # pyupgrade
-    "UP",
-    # annotation
-    # "ANN"
-    # bandit
-    "S",
-    # Argument
-    # "ARG",
-    # Pathlib
-    "PTH",
-    # Simplify
-    # "SIM",
-    # Return
-    "RET",
-    # Raise
-    "RSE",
+    # # pep8-naming
+    # "N",
+    # # flake8-2020
+    # "YTT",
+    # # flake8-bugbear
+    # "B",
+    # # flake8-quotes
+    # "Q",
+    # # flake8-debugger
+    # "T10",
+    # # flake8-gettext
+    # "INT",
+    # # pylint
+    # "PL",
+    # # misc lints
+    # "PIE",
+    # # flake8-pyi
+    # "PYI",
+    # # tidy imports
+    # "TID",
+    # # implicit string concatenation
+    # "ISC",
+    # # type-checking imports
+    # "TC",
+    # # comprehensions
+    # "C",
+    # "C4",
+    # # pygrep-hooks
+    # "PGH",
+    # # Ruff-specific rules
+    # "RUF",
+    # # flake8-bandit: exec-builtin
+    # "S102",
+    # # numpy-legacy-random
+    # "NPY002",
+    # # Perflint
+    # "PERF",
+    # # flynt
+    # "FLY",
+    # # flake8-logging-format
+    # "G",
+    # # pyupgrade
+    # "UP",
+    # # annotation
+    # # "ANN"
+    # # bandit
+    # "S",
+    # # Argument
+    # # "ARG",
+    # # Pathlib
+    # "PTH",
+    # # Simplify
+    # # "SIM",
+    # # Return
+    # "RET",
+    # # Raise
+    # "RSE",
 ]
 ignore = [
     # too-many-arguments
     'PLR0913',
     # Ambiguous doc
-    'D203', 'D212', 'D402', 'D406',
+    "D100",
+    "D101",
+    'D203',
+    'D212',
+    'D402',
+    'D406',
     # Multiline doc is ok.
     'D200',
     # We use the class for constructor doc
@@ -156,30 +159,37 @@ ignore = [
     "PLR2004",
     # Argument
     "ARG001",
+    # doc
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    # Unused variables
+    "F841",
 ]
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"
 
 [tool.pytest.ini_options]
-addopts ="""
+filterwarnings = [
+    "ignore::DeprecationWarning",
+]
+addopts = """
     --cov src/anytree
     --cov-report term
     --cov-report html
-    --doctest-glob=docs/*
+    --doctest-glob=docs/*.rst
     --doctest-modules
     --ignore-glob=tests/testdata/*
     --log-level=INFO
     --junitxml=report.xml
 """
-filterwarnings = [
-    "error",
-]
 
 [tool.coverage.report]
 exclude_lines = [
     'return NotImplemented',
-    'raise NotImplementedError()',
+    'raise NotImplementedError',
     'pragma: no cover',
     'assert False',
 ]