From 841a759b380f0d35b922585c43a3f2d4f3478f7e Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Thu, 20 Nov 2025 21:20:42 +0100 Subject: [PATCH 1/8] Bumped dependencies. --- doc/Dependency.rst | 8 ++++---- pyproject.toml | 2 +- tests/requirements.txt | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/Dependency.rst b/doc/Dependency.rst index d951f7e2..f1862e76 100644 --- a/doc/Dependency.rst +++ b/doc/Dependency.rst @@ -53,7 +53,7 @@ When installed as ``pyTooling``: +-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Package** | **Version** | **License** | **Dependencies** | +=================================================================+=============+===========================================================================================+========================================================================================================================================================+ -| `pyTooling `__ | ≥8.7 | `Apache License, 2.0 `__ | *None* | +| `pyTooling `__ | ≥8.8 | `Apache License, 2.0 `__ | *None* | +-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ .. TODO:: document the dependency to @@ -102,7 +102,7 @@ the mandatory dependencies too. +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ | **Package** | **Version** | **License** | **Dependencies** | +=====================================================================+=============+========================================================================================+======================+ -| `pytest `__ | ≥8.4 | `MIT `__ | *Not yet evaluated.* | +| `pytest `__ | ≥9.0 | `MIT `__ | *Not yet evaluated.* | +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ | `pytest-cov `__ | ≥7.0 | `MIT `__ | *Not yet evaluated.* | +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ @@ -152,7 +152,7 @@ the mandatory dependencies too. +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Package** | **Version** | **License** | **Dependencies** | +=================================================================================================+==============+==========================================================================================================+======================================================================================================================================================+ -| `pyTooling `__ | ≥8.7 | `Apache License, 2.0 `__ | *None* | +| `pyTooling `__ | ≥8.8 | `Apache License, 2.0 `__ | *None* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | `Sphinx `__ | ≥8.2 | `BSD 3-Clause `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -213,7 +213,7 @@ install the mandatory dependencies too. +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Package** | **Version** | **License** | **Dependencies** | +============================================================================+==============+==========================================================================================================+======================================================================================================================================================+ -| `pyTooling `__ | ≥8.7 | `Apache License, 2.0 `__ | *None* | +| `pyTooling `__ | ≥8.8 | `Apache License, 2.0 `__ | *None* | +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | `wheel `__ | ≥0.45 | `MIT `__ | *Not yet evaluated.* | +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/pyproject.toml b/pyproject.toml index de687bd1..f7ba80c8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,7 +2,7 @@ requires = [ "setuptools >= 80.0", "wheel ~= 0.45", - "pyTooling ~= 8.7" + "pyTooling ~= 8.8" ] build-backend = "setuptools.build_meta" diff --git a/tests/requirements.txt b/tests/requirements.txt index 787c2e67..7a7add36 100644 --- a/tests/requirements.txt +++ b/tests/requirements.txt @@ -4,7 +4,7 @@ Coverage ~= 7.11 # Test Runner -pytest ~= 8.4 +pytest ~= 9.0 pytest-cov ~= 7.0 # Static Type Checking From d1c243549cabe1fa3b2e95a9094e875cb3b79c8d Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Thu, 20 Nov 2025 21:21:54 +0100 Subject: [PATCH 2/8] Updated pyproject configuration to pytest v9.0 --- pyproject.toml | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index f7ba80c8..8e25d222 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -21,23 +21,21 @@ namespace_packages = true html_report = "report/typing" [tool.pytest] -junit_xml = "report/unit/UnittestReportSummary.xml" - -[tool.pyedaa-reports] -junit_xml = "report/unit/unittest.xml" - -[tool.pytest.ini_options] -addopts = "--tb=native" +addopts = ["--tb=native"] # Don't set 'python_classes = *' otherwise, pytest doesn't search for classes # derived from unittest.Testcase -python_files = "*" -python_functions = "test_*" +python_files = ["*"] +python_functions = ["test_*"] filterwarnings = [ "error::DeprecationWarning", "error::PendingDeprecationWarning" ] +junit_xml = "report/unit/UnittestReportSummary.xml" junit_logging = "all" +[tool.pyedaa-reports] +junit_xml = "report/unit/unittest.xml" + [tool.interrogate] color = true verbose = 1 # possible values: 0 (minimal output), 1 (-v), 2 (-vv) From 0278cfa18a8eb6fcd521502e9e05435697eaa926 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Thu, 20 Nov 2025 21:23:02 +0100 Subject: [PATCH 3/8] Removed code specific to Python 3.9/3.10. --- sphinx_reports/Common.py | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/sphinx_reports/Common.py b/sphinx_reports/Common.py index b9957bec..d5b1d29d 100644 --- a/sphinx_reports/Common.py +++ b/sphinx_reports/Common.py @@ -32,7 +32,6 @@ **Common exceptions, classes and helper functions.** """ from enum import Flag -from sys import version_info from typing import List from pyTooling.Decorators import export @@ -41,15 +40,7 @@ @export class ReportExtensionError(ExtensionError): - # WORKAROUND: for Python <3.11 - # Implementing a dummy method for Python versions before - __notes__: List[str] - if version_info < (3, 11): # pragma: no cover - def add_note(self, message: str) -> None: - try: - self.__notes__.append(message) - except AttributeError: - self.__notes__ = [message] + pass @export From 581c781977fd96454216febea16f0bbd8d259449 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Tue, 2 Dec 2025 23:13:57 +0100 Subject: [PATCH 4/8] Bumped dependencies. Allow Sphinx 9.x. --- .github/workflows/Pipeline.yml | 1 - doc/Dependency.rst | 8 ++++---- doc/Overview.rst | 6 +++--- doc/requirements.txt | 6 +++--- requirements.txt | 6 +++--- run.ps1 | 2 +- sphinx_reports/__init__.py | 4 ++-- tests/requirements.txt | 8 ++++---- 8 files changed, 20 insertions(+), 21 deletions(-) diff --git a/.github/workflows/Pipeline.yml b/.github/workflows/Pipeline.yml index ba002c0e..2a8d1d5e 100644 --- a/.github/workflows/Pipeline.yml +++ b/.github/workflows/Pipeline.yml @@ -12,7 +12,6 @@ jobs: uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r6 with: package_name: 'sphinx_reports' - unittest_python_version: '3.13' unittest_python_version_list: '3.11 3.12 3.13 3.14' unittest_disable_list: 'windows-arm:* windows-arm:pypy-3.11' bandit: 'true' diff --git a/doc/Dependency.rst b/doc/Dependency.rst index f1862e76..500d6b48 100644 --- a/doc/Dependency.rst +++ b/doc/Dependency.rst @@ -106,9 +106,9 @@ the mandatory dependencies too. +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ | `pytest-cov `__ | ≥7.0 | `MIT `__ | *Not yet evaluated.* | +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ -| `Coverage `__ | ≥7.11 | `Apache License, 2.0 `__ | *Not yet evaluated.* | +| `Coverage `__ | ≥7.12 | `Apache License, 2.0 `__ | *Not yet evaluated.* | +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ -| `mypy `__ | ≥1.18 | `MIT `__ | *Not yet evaluated.* | +| `mypy `__ | ≥1.19 | `MIT `__ | *Not yet evaluated.* | +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ | `typing-extensions `__ | ≥4.15 | `PSF-2.0 `__ | *Not yet evaluated.* | +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ @@ -154,9 +154,9 @@ the mandatory dependencies too. +=================================================================================================+==============+==========================================================================================================+======================================================================================================================================================+ | `pyTooling `__ | ≥8.8 | `Apache License, 2.0 `__ | *None* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `Sphinx `__ | ≥8.2 | `BSD 3-Clause `__ | *Not yet evaluated.* | +| `Sphinx `__ | ≥9.0 | `BSD 3-Clause `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `sphinxcontrib-mermaid `__ | ≥1.0 | `BSD `__ | *Not yet evaluated.* | +| `sphinxcontrib-mermaid `__ | ≥1.2 | `BSD `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | `autoapi `__ | ≥2.0.1 | `Apache License, 2.0 `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/doc/Overview.rst b/doc/Overview.rst index 290928d6..fcfb05f4 100644 --- a/doc/Overview.rst +++ b/doc/Overview.rst @@ -37,14 +37,14 @@ See the following :file:`doc/requirements.txt` file as an example with commonly -r ../requirements.txt # Enforce latest version on ReadTheDocs - sphinx ~= 8.2 - docutils ~= 0.21 + sphinx ~= 9.0 + docutils ~= 0.22 # ReadTheDocs Theme sphinx_rtd_theme ~= 3.0 # Sphinx Extenstions - sphinxcontrib-mermaid ~= 1.0 + sphinxcontrib-mermaid ~= 1.2 autoapi ~= 2.0.1 sphinx_design ~= 0.6 sphinx-copybutton ~= 0.5 diff --git a/doc/requirements.txt b/doc/requirements.txt index b6ac51f2..1afd882c 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,15 +1,15 @@ -r ../requirements.txt # Enforce latest version on ReadTheDocs -sphinx ~= 8.2 -docutils ~= 0.21 +sphinx >= 8.0, < 10.0 +docutils ~= 0.22 docutils_stubs ~= 0.0.22 # ReadTheDocs Theme sphinx_rtd_theme ~= 3.0 # Sphinx Extenstions -sphinxcontrib-mermaid ~= 1.0 +sphinxcontrib-mermaid ~= 1.2 autoapi ~= 2.0.1 sphinx_design ~= 0.6 sphinx-copybutton ~= 0.5 diff --git a/requirements.txt b/requirements.txt index e38554e3..f1065b02 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,9 +1,9 @@ pyTooling >= 6.7, <9.0 pyEDAA.Reports ~= 0.17 -sphinx ~= 8.2 -docutils ~= 0.21 +sphinx >= 8.0, < 10.0 +docutils >= 0.21, < 0.23 docutils_stubs ~= 0.0.22 -Coverage ~= 7.11 +Coverage ~= 7.12 docstr_coverage ~= 2.3.2 diff --git a/run.ps1 b/run.ps1 index f52dca16..13f574f2 100644 --- a/run.ps1 +++ b/run.ps1 @@ -32,7 +32,7 @@ Param( ) $PackageName = "sphinx_reports" -$PackageVersion = "0.9.9" +$PackageVersion = "0.9.10" # set default values $EnableDebug = [bool]$PSCmdlet.MyInvocation.BoundParameters["Debug"] diff --git a/sphinx_reports/__init__.py b/sphinx_reports/__init__.py index 02daa9cd..25e6f32f 100644 --- a/sphinx_reports/__init__.py +++ b/sphinx_reports/__init__.py @@ -43,7 +43,7 @@ __email__ = "Paebbels@gmail.com" __copyright__ = "2023-2025, Patrick Lehmann" __license__ = "Apache License, Version 2.0" -__version__ = "0.9.9" +__version__ = "0.9.10" __keywords__ = [ "Python3", "Sphinx", "Extension", "Report", "doc-string", "interrogate", "Code Coverage", "Coverage", "Documentation Coverage", "Unittest", "Dependencies", "Summary" @@ -215,7 +215,7 @@ def AddCSSFiles(sphinxApplication: Sphinx) -> None: cssContent = readResourceFile(ResourcePackage, cssFilename) # Compute md5 hash of CSS file - hash = md5(cssContent.encode("utf8")).hexdigest() + hash = md5(cssContent.encode("utf8")).hexdigest() # nosec B324 # Write the CSS file into output directory cssFile = staticDirectory / f"sphinx-reports.{hash}.css" diff --git a/tests/requirements.txt b/tests/requirements.txt index 7a7add36..a728b72b 100644 --- a/tests/requirements.txt +++ b/tests/requirements.txt @@ -1,13 +1,13 @@ -r ../requirements.txt # Coverage collection -Coverage ~= 7.11 +Coverage ~= 7.12 # Test Runner pytest ~= 9.0 pytest-cov ~= 7.0 # Static Type Checking -mypy[reports] ~= 1.18 -typing_extensions ~= 4.15 -lxml >= 5.4, <7.0 +mypy[reports] ~= 1.19; sys_platform != 'win32' +typing_extensions ~= 4.15; sys_platform != 'win32' +lxml >= 5.4, <7.0; sys_platform != 'win32' From 62127019b7dafac7157a24d5aa8918147cbbe91b Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Tue, 20 Jan 2026 20:30:04 +0100 Subject: [PATCH 5/8] Bumped dependencies. --- .github/workflows/Pipeline.yml | 2 +- .idea/sphinx-reports.iml | 4 ++-- dist/requirements.txt | 2 +- doc/Dependency.rst | 14 +++++++------- doc/Overview.rst | 10 +++++----- doc/requirements.txt | 8 ++++---- pyproject.toml | 4 ++-- requirements.txt | 13 ++++++------- sphinx_reports/__init__.py | 2 +- tests/requirements.txt | 15 ++------------- tests/typing/requirements.txt | 6 ++++++ tests/unit/requirements.txt | 9 ++++++++- 12 files changed, 45 insertions(+), 44 deletions(-) create mode 100644 tests/typing/requirements.txt diff --git a/.github/workflows/Pipeline.yml b/.github/workflows/Pipeline.yml index 2a8d1d5e..a4c71782 100644 --- a/.github/workflows/Pipeline.yml +++ b/.github/workflows/Pipeline.yml @@ -9,7 +9,7 @@ on: jobs: Pipeline: - uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r6 + uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r7 with: package_name: 'sphinx_reports' unittest_python_version_list: '3.11 3.12 3.13 3.14' diff --git a/.idea/sphinx-reports.iml b/.idea/sphinx-reports.iml index 35658e80..caa32691 100644 --- a/.idea/sphinx-reports.iml +++ b/.idea/sphinx-reports.iml @@ -2,15 +2,15 @@ - + - + diff --git a/dist/requirements.txt b/dist/requirements.txt index cacbc6fb..e87980bd 100644 --- a/dist/requirements.txt +++ b/dist/requirements.txt @@ -1,2 +1,2 @@ -wheel ~= 0.45 +wheel ~= 0.45.0 twine ~= 6.2 diff --git a/doc/Dependency.rst b/doc/Dependency.rst index 500d6b48..e94d8655 100644 --- a/doc/Dependency.rst +++ b/doc/Dependency.rst @@ -53,7 +53,7 @@ When installed as ``pyTooling``: +-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Package** | **Version** | **License** | **Dependencies** | +=================================================================+=============+===========================================================================================+========================================================================================================================================================+ -| `pyTooling `__ | ≥8.8 | `Apache License, 2.0 `__ | *None* | +| `pyTooling `__ | ≥8.11 | `Apache License, 2.0 `__ | *None* | +-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ .. TODO:: document the dependency to @@ -106,7 +106,7 @@ the mandatory dependencies too. +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ | `pytest-cov `__ | ≥7.0 | `MIT `__ | *Not yet evaluated.* | +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ -| `Coverage `__ | ≥7.12 | `Apache License, 2.0 `__ | *Not yet evaluated.* | +| `Coverage `__ | ≥7.13 | `Apache License, 2.0 `__ | *Not yet evaluated.* | +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ | `mypy `__ | ≥1.19 | `MIT `__ | *Not yet evaluated.* | +---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ @@ -152,21 +152,21 @@ the mandatory dependencies too. +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Package** | **Version** | **License** | **Dependencies** | +=================================================================================================+==============+==========================================================================================================+======================================================================================================================================================+ -| `pyTooling `__ | ≥8.8 | `Apache License, 2.0 `__ | *None* | +| `pyTooling `__ | ≥8.11 | `Apache License, 2.0 `__ | *None* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | `Sphinx `__ | ≥9.0 | `BSD 3-Clause `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `sphinx_rtd_theme `__ | ≥3.1 | `MIT `__ | *Not yet evaluated.* | ++-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | `sphinxcontrib-mermaid `__ | ≥1.2 | `BSD `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | `autoapi `__ | ≥2.0.1 | `Apache License, 2.0 `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `sphinx_btd_theme `__ | ≥0.5.2 | `MIT `__ | *Not yet evaluated.* | -+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | `sphinx_design `__ | ≥0.6 | `MIT `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | `sphinx-copybutton `__ | ≥0.5 | `MIT `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `sphinx_autodoc_typehints `__ | ≥3.5 | `MIT `__ | *Not yet evaluated.* | +| `sphinx_autodoc_typehints `__ | ≥3.6 | `MIT `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ .. TODO:: document the usage of @@ -213,7 +213,7 @@ install the mandatory dependencies too. +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Package** | **Version** | **License** | **Dependencies** | +============================================================================+==============+==========================================================================================================+======================================================================================================================================================+ -| `pyTooling `__ | ≥8.8 | `Apache License, 2.0 `__ | *None* | +| `pyTooling `__ | ≥8.11 | `Apache License, 2.0 `__ | *None* | +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | `wheel `__ | ≥0.45 | `MIT `__ | *Not yet evaluated.* | +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/doc/Overview.rst b/doc/Overview.rst index fcfb05f4..3d11191b 100644 --- a/doc/Overview.rst +++ b/doc/Overview.rst @@ -37,18 +37,18 @@ See the following :file:`doc/requirements.txt` file as an example with commonly -r ../requirements.txt # Enforce latest version on ReadTheDocs - sphinx ~= 9.0 + sphinx ~= 9.1 docutils ~= 0.22 # ReadTheDocs Theme - sphinx_rtd_theme ~= 3.0 + sphinx_rtd_theme ~= 3.1 # Sphinx Extenstions sphinxcontrib-mermaid ~= 1.2 autoapi ~= 2.0.1 - sphinx_design ~= 0.6 - sphinx-copybutton ~= 0.5 - sphinx_autodoc_typehints ~= 3.5 + sphinx_design ~= 0.7.0 + sphinx-copybutton ~= 0.5.0 + sphinx_autodoc_typehints ~= 3.6 sphinx_reports ~= 1.0 # <= new entry Finally, the extension needs to be enabled in Sphinx's :file:`conf.py`, so the extension is loaded by Sphinx. diff --git a/doc/requirements.txt b/doc/requirements.txt index 1afd882c..4337f97b 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,7 +2,7 @@ # Enforce latest version on ReadTheDocs sphinx >= 8.0, < 10.0 -docutils ~= 0.22 +docutils >= 0.22.0 docutils_stubs ~= 0.0.22 # ReadTheDocs Theme @@ -11,6 +11,6 @@ sphinx_rtd_theme ~= 3.0 # Sphinx Extenstions sphinxcontrib-mermaid ~= 1.2 autoapi ~= 2.0.1 -sphinx_design ~= 0.6 -sphinx-copybutton ~= 0.5 -sphinx_autodoc_typehints ~= 3.5 +sphinx_design ~= 0.7.0 +sphinx-copybutton ~= 0.5.0 +sphinx_autodoc_typehints ~= 3.6 diff --git a/pyproject.toml b/pyproject.toml index 8e25d222..f3eca8a2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,8 +1,8 @@ [build-system] requires = [ "setuptools >= 80.0", - "wheel ~= 0.45", - "pyTooling ~= 8.8" + "wheel ~= 0.45.0", + "pyTooling ~= 8.11" ] build-backend = "setuptools.build_meta" diff --git a/requirements.txt b/requirements.txt index f1065b02..e00d7d66 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,9 +1,8 @@ -pyTooling >= 6.7, <9.0 -pyEDAA.Reports ~= 0.17 +pyTooling >= 8.0 +pyEDAA.Reports ~= 0.17.0 +sphinx >= 9.0 +docutils >= 0.22.0 +docutils_stubs >= 0.0.22 -sphinx >= 8.0, < 10.0 -docutils >= 0.21, < 0.23 -docutils_stubs ~= 0.0.22 - -Coverage ~= 7.12 +Coverage ~= 7.13 docstr_coverage ~= 2.3.2 diff --git a/sphinx_reports/__init__.py b/sphinx_reports/__init__.py index 25e6f32f..50e1b02a 100644 --- a/sphinx_reports/__init__.py +++ b/sphinx_reports/__init__.py @@ -43,7 +43,7 @@ __email__ = "Paebbels@gmail.com" __copyright__ = "2023-2025, Patrick Lehmann" __license__ = "Apache License, Version 2.0" -__version__ = "0.9.10" +__version__ = "0.10.0" __keywords__ = [ "Python3", "Sphinx", "Extension", "Report", "doc-string", "interrogate", "Code Coverage", "Coverage", "Documentation Coverage", "Unittest", "Dependencies", "Summary" diff --git a/tests/requirements.txt b/tests/requirements.txt index a728b72b..e9c2fe89 100644 --- a/tests/requirements.txt +++ b/tests/requirements.txt @@ -1,13 +1,2 @@ --r ../requirements.txt - -# Coverage collection -Coverage ~= 7.12 - -# Test Runner -pytest ~= 9.0 -pytest-cov ~= 7.0 - -# Static Type Checking -mypy[reports] ~= 1.19; sys_platform != 'win32' -typing_extensions ~= 4.15; sys_platform != 'win32' -lxml >= 5.4, <7.0; sys_platform != 'win32' +-r unit/requirements.txt +-r typing/requirements.txt diff --git a/tests/typing/requirements.txt b/tests/typing/requirements.txt new file mode 100644 index 00000000..95ab13e1 --- /dev/null +++ b/tests/typing/requirements.txt @@ -0,0 +1,6 @@ +-r ../../requirements.txt + +# Static Type Checking +mypy[reports] ~= 1.19 +typing_extensions ~= 4.15 +lxml >= 5.4, <7.0 diff --git a/tests/unit/requirements.txt b/tests/unit/requirements.txt index 3c8d7e78..a2ffbaa9 100644 --- a/tests/unit/requirements.txt +++ b/tests/unit/requirements.txt @@ -1 +1,8 @@ --r ../requirements.txt +-r ../../requirements.txt + +# Coverage collection +Coverage ~= 7.13 + +# Test Runner +pytest ~= 9.0 +pytest-cov ~= 7.0 From ac34000248f501da5c93636e514f2b2f85850f40 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Tue, 20 Jan 2026 20:33:34 +0100 Subject: [PATCH 6/8] Bumped version information. --- setup.py | 2 +- sphinx_reports/Adapter/Coverage.py | 2 +- sphinx_reports/Adapter/__init__.py | 2 +- sphinx_reports/CodeCoverage.py | 2 +- sphinx_reports/Common.py | 2 +- sphinx_reports/DataModel/CodeCoverage.py | 2 +- sphinx_reports/DataModel/Dependency.py | 2 +- sphinx_reports/DataModel/__init__.py | 2 +- sphinx_reports/Dependency.py | 2 +- sphinx_reports/DocCoverage.py | 2 +- sphinx_reports/Sphinx.py | 2 +- sphinx_reports/Unittest.py | 2 +- sphinx_reports/__init__.py | 4 ++-- sphinx_reports/static/__init__.py | 2 +- tests/__init__.py | 2 +- tests/unit/CodeCoverage.py | 2 +- tests/unit/__init__.py | 2 +- 17 files changed, 18 insertions(+), 18 deletions(-) diff --git a/setup.py b/setup.py index 9190d949..1fc4c97c 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # diff --git a/sphinx_reports/Adapter/Coverage.py b/sphinx_reports/Adapter/Coverage.py index 5440b57a..e2cdb8e6 100644 --- a/sphinx_reports/Adapter/Coverage.py +++ b/sphinx_reports/Adapter/Coverage.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # diff --git a/sphinx_reports/Adapter/__init__.py b/sphinx_reports/Adapter/__init__.py index db930969..2ebd130c 100644 --- a/sphinx_reports/Adapter/__init__.py +++ b/sphinx_reports/Adapter/__init__.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # diff --git a/sphinx_reports/CodeCoverage.py b/sphinx_reports/CodeCoverage.py index 671e90b1..6b35399f 100644 --- a/sphinx_reports/CodeCoverage.py +++ b/sphinx_reports/CodeCoverage.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # diff --git a/sphinx_reports/Common.py b/sphinx_reports/Common.py index d5b1d29d..e34875b3 100644 --- a/sphinx_reports/Common.py +++ b/sphinx_reports/Common.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # diff --git a/sphinx_reports/DataModel/CodeCoverage.py b/sphinx_reports/DataModel/CodeCoverage.py index e3bd5d0f..ecdbbf48 100644 --- a/sphinx_reports/DataModel/CodeCoverage.py +++ b/sphinx_reports/DataModel/CodeCoverage.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # diff --git a/sphinx_reports/DataModel/Dependency.py b/sphinx_reports/DataModel/Dependency.py index 430def40..93507a4a 100644 --- a/sphinx_reports/DataModel/Dependency.py +++ b/sphinx_reports/DataModel/Dependency.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # diff --git a/sphinx_reports/DataModel/__init__.py b/sphinx_reports/DataModel/__init__.py index a0271c5c..33b8484b 100644 --- a/sphinx_reports/DataModel/__init__.py +++ b/sphinx_reports/DataModel/__init__.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # diff --git a/sphinx_reports/Dependency.py b/sphinx_reports/Dependency.py index 4188a099..542e66ed 100644 --- a/sphinx_reports/Dependency.py +++ b/sphinx_reports/Dependency.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # diff --git a/sphinx_reports/DocCoverage.py b/sphinx_reports/DocCoverage.py index 49eb4173..f9c9b31d 100644 --- a/sphinx_reports/DocCoverage.py +++ b/sphinx_reports/DocCoverage.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # diff --git a/sphinx_reports/Sphinx.py b/sphinx_reports/Sphinx.py index 8d3f9923..d031a8ce 100644 --- a/sphinx_reports/Sphinx.py +++ b/sphinx_reports/Sphinx.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # diff --git a/sphinx_reports/Unittest.py b/sphinx_reports/Unittest.py index fe6a8470..59d4f11a 100644 --- a/sphinx_reports/Unittest.py +++ b/sphinx_reports/Unittest.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # diff --git a/sphinx_reports/__init__.py b/sphinx_reports/__init__.py index 50e1b02a..993901e5 100644 --- a/sphinx_reports/__init__.py +++ b/sphinx_reports/__init__.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # @@ -41,7 +41,7 @@ """ __author__ = "Patrick Lehmann" __email__ = "Paebbels@gmail.com" -__copyright__ = "2023-2025, Patrick Lehmann" +__copyright__ = "2023-2026, Patrick Lehmann" __license__ = "Apache License, Version 2.0" __version__ = "0.10.0" __keywords__ = [ diff --git a/sphinx_reports/static/__init__.py b/sphinx_reports/static/__init__.py index 85af0e5c..d162fd1c 100644 --- a/sphinx_reports/static/__init__.py +++ b/sphinx_reports/static/__init__.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # diff --git a/tests/__init__.py b/tests/__init__.py index 84f7cc54..c57dd7db 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # diff --git a/tests/unit/CodeCoverage.py b/tests/unit/CodeCoverage.py index 407143fc..dda40ccd 100644 --- a/tests/unit/CodeCoverage.py +++ b/tests/unit/CodeCoverage.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # diff --git a/tests/unit/__init__.py b/tests/unit/__init__.py index 84f7cc54..c57dd7db 100644 --- a/tests/unit/__init__.py +++ b/tests/unit/__init__.py @@ -11,7 +11,7 @@ # # # License: # # ==================================================================================================================== # -# Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany # +# Copyright 2023-2026 Patrick Lehmann - Bötzingen, Germany # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # From 45b723663194a2730416b3fbac791de11458e469 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Tue, 20 Jan 2026 20:34:33 +0100 Subject: [PATCH 7/8] Added missing type hints. --- sphinx_reports/Adapter/Dependency.py | 2 +- sphinx_reports/DataModel/Dependency.py | 6 +++--- sphinx_reports/Unittest.py | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/sphinx_reports/Adapter/Dependency.py b/sphinx_reports/Adapter/Dependency.py index fa198d7b..ccedd7bf 100644 --- a/sphinx_reports/Adapter/Dependency.py +++ b/sphinx_reports/Adapter/Dependency.py @@ -16,7 +16,7 @@ class DependencyScanner: _distribution: Distribution - def __init__(self, distributionName: str): + def __init__(self, distributionName: str) -> None: md1 = importlib_metadata(distributionName) self._distribution = Distribution(distributionName) diff --git a/sphinx_reports/DataModel/Dependency.py b/sphinx_reports/DataModel/Dependency.py index 93507a4a..663ea0e7 100644 --- a/sphinx_reports/DataModel/Dependency.py +++ b/sphinx_reports/DataModel/Dependency.py @@ -38,7 +38,7 @@ class VersionSpecifier: _spec: str - def __init__(self, spec: str): + def __init__(self, spec: str) -> None: self._spec = spec @@ -46,7 +46,7 @@ def __init__(self, spec: str): class License: _name: str - def __init__(self, name: str): + def __init__(self, name: str) -> None: self._name = name @@ -58,7 +58,7 @@ class Distribution: _licenses: List[License] _dependencies: List["Distribution"] - def __init__(self, name: str): + def __init__(self, name: str) -> None: self._name = name self._packages = [] diff --git a/sphinx_reports/Unittest.py b/sphinx_reports/Unittest.py index 59d4f11a..a9928109 100644 --- a/sphinx_reports/Unittest.py +++ b/sphinx_reports/Unittest.py @@ -64,7 +64,7 @@ class ShowTestcases(Flag): all = passed | failed | skipped | excluded | errors | aborted not_passed = all & ~passed - def __eq__(self, other): + def __eq__(self, other: Any) -> bool: if isinstance(other, TestcaseStatus): if other is TestcaseStatus.Passed: return ShowTestcases.passed in self From 20331904e98bcff561c02eb2e1ddf27144968488 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Tue, 20 Jan 2026 20:52:42 +0100 Subject: [PATCH 8/8] Dependency fine tuning. --- doc/Dependency.rst | 2 +- doc/Overview.rst | 2 +- doc/requirements.txt | 10 +++++----- requirements.txt | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/Dependency.rst b/doc/Dependency.rst index e94d8655..5e477e6b 100644 --- a/doc/Dependency.rst +++ b/doc/Dependency.rst @@ -158,7 +158,7 @@ the mandatory dependencies too. +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | `sphinx_rtd_theme `__ | ≥3.1 | `MIT `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `sphinxcontrib-mermaid `__ | ≥1.2 | `BSD `__ | *Not yet evaluated.* | +| `sphinxcontrib-mermaid `__ | ≥2.0 | `BSD `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | `autoapi `__ | ≥2.0.1 | `Apache License, 2.0 `__ | *Not yet evaluated.* | +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/doc/Overview.rst b/doc/Overview.rst index 3d11191b..c88b872f 100644 --- a/doc/Overview.rst +++ b/doc/Overview.rst @@ -44,7 +44,7 @@ See the following :file:`doc/requirements.txt` file as an example with commonly sphinx_rtd_theme ~= 3.1 # Sphinx Extenstions - sphinxcontrib-mermaid ~= 1.2 + sphinxcontrib-mermaid ~= 2.0 autoapi ~= 2.0.1 sphinx_design ~= 0.7.0 sphinx-copybutton ~= 0.5.0 diff --git a/doc/requirements.txt b/doc/requirements.txt index 4337f97b..485b36e0 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,15 +1,15 @@ -r ../requirements.txt # Enforce latest version on ReadTheDocs -sphinx >= 8.0, < 10.0 -docutils >= 0.22.0 -docutils_stubs ~= 0.0.22 +#sphinx >= 9.0, < 10.0 +#docutils >= 0.22.0 +#docutils_stubs ~= 0.0.22 # ReadTheDocs Theme -sphinx_rtd_theme ~= 3.0 +sphinx_rtd_theme ~= 3.1 # Sphinx Extenstions -sphinxcontrib-mermaid ~= 1.2 +sphinxcontrib-mermaid ~= 2.0 autoapi ~= 2.0.1 sphinx_design ~= 0.7.0 sphinx-copybutton ~= 0.5.0 diff --git a/requirements.txt b/requirements.txt index e00d7d66..6f30248b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,6 @@ pyTooling >= 8.0 pyEDAA.Reports ~= 0.17.0 -sphinx >= 9.0 +sphinx >= 9.0, < 10.0 docutils >= 0.22.0 docutils_stubs >= 0.0.22