sphinx-needs 2.0.0__tar.gz → 3.0.0__tar.gz

sphinx_needs-3.0.0/AUTHORS

@@ -0,0 +1,41 @@
+Maintainers
+-----------
+
+Daniel Woste <daniel@useblocks.com>
+
+Contributors
+------------
+
+Marco Heinemann <marco@useblocks.com>
+
+Trevor Lovett <trevor.lovett@gmail.com>
+
+Magnus Lööf <magnus.loof@gmail.com>
+
+Harri Kaimio
+
+Anders Thuné
+
+Daniel Eades <danieleades@hotmail.com>
+
+Philip Partsch <philip.partsch@googlemail.com>
+
+David Le Nir <david.lenir.e@thalesdigital.io>
+
+Baran Barış Yıldızlı <arisbbyil@gmail.com>
+
+Roberto Rötting <roberto.roetting@gmail.com>
+
+Nirmal Sasidharan <nirmal.sasidharan@de.bosch.com>
+
+Jacob Allen <jacob.allen@etas.com>
+
+Jörg Kreuzberger <j.kreuzberger@procitec.de>
+
+Duodu Randy <duodurandy19@gmail.com>
+
+Christian Wappler <chri.wapp@gmail.com>
+
+Chris Sewell <chrisj_sewell@hotmail.com>
+
+Simon Leiner <simon@leiner.me>

{sphinx_needs-2.0.0 → sphinx_needs-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sphinx-needs
-Version: 2.0.0
+Version: 3.0.0
 Summary: Sphinx needs extension for managing needs/requirements and specifications
 Home-page: http://github.com/useblocks/sphinx-needs
 License: MIT
@@ -26,25 +26,31 @@ Provides-Extra: docs
 Provides-Extra: plotting
 Provides-Extra: test
 Provides-Extra: test-parallel
+Provides-Extra: theme-furo
+Provides-Extra: theme-im
+Provides-Extra: theme-pds
+Provides-Extra: theme-rtd
+Requires-Dist: defusedxml (>=0.7.1,<0.8.0) ; extra == "test"
+Requires-Dist: furo (>=2024.5.4,<2025.0.0) ; extra == "theme-furo"
 Requires-Dist: jsonschema (>=3.2.0)
 Requires-Dist: lxml (>=4.6.5,<5.0.0) ; extra == "test"
 Requires-Dist: matplotlib (>=3.3.0) ; extra == "plotting" or extra == "test" or extra == "docs"
 Requires-Dist: memray (>=1.3.1,<2.0.0) ; extra == "benchmark"
-Requires-Dist: pydantic (==2.4.2) ; extra == "docs"
+Requires-Dist: pydata-sphinx-theme (>=0.15.2,<0.16.0) ; extra == "theme-pds"
 Requires-Dist: pytest (>=7,<8) ; extra == "test"
 Requires-Dist: pytest-benchmark (>=4.0.0,<5.0.0) ; extra == "benchmark"
 Requires-Dist: pytest-cov (>=4,<5) ; extra == "test"
 Requires-Dist: pytest-xdist ; extra == "test-parallel"
 Requires-Dist: pytest-xprocess (>=0.22.2,<0.23.0) ; extra == "test"
-Requires-Dist: requests (>=2.25.1,<3.0.0)
-Requires-Dist: requests-file (>=1.5.1,<2.0.0)
-Requires-Dist: requests-mock (>=1.9.3) ; extra == "test"
+Requires-Dist: requests (>=2.32,<3.0)
+Requires-Dist: requests-file (>=2.1,<3.0)
 Requires-Dist: responses (>=0.22.0,<0.23.0) ; extra == "test"
-Requires-Dist: sphinx (>=5.0,<8)
+Requires-Dist: sphinx (>=6.0,<9)
 Requires-Dist: sphinx-copybutton (>=0.5,<0.6) ; extra == "docs"
-Requires-Dist: sphinx-data-viewer (>=0.1.1,<0.2.0)
-Requires-Dist: sphinx-design (>=0.5,<0.6) ; extra == "docs"
-Requires-Dist: sphinx-immaterial (==0.11.7) ; extra == "docs"
+Requires-Dist: sphinx-data-viewer (>=0.1.5,<0.2.0)
+Requires-Dist: sphinx-design (>=0.6,<0.7) ; extra == "docs"
+Requires-Dist: sphinx-immaterial (>=0.11.11,<0.12.0) ; extra == "theme-im"
+Requires-Dist: sphinx_rtd_theme (>=2.0.0,<3.0.0) ; extra == "theme-rtd"
 Requires-Dist: sphinxcontrib-jquery (>=4,<5)
 Requires-Dist: sphinxcontrib-plantuml (>=0,<1) ; extra == "test" or extra == "docs"
 Requires-Dist: sphinxcontrib-programoutput (>=0.17,<0.18) ; extra == "docs"

{sphinx_needs-2.0.0 → sphinx_needs-3.0.0}/pyproject.toml

@@ -2,7 +2,7 @@
 name = "sphinx-needs"
 
 # !! Don't miss updates in sphinx_needs.__version__, changelog.rst, and .github/workflows/docker !!!
-version = "2.0.0"
+version = "3.0.0"
 
 description = "Sphinx needs extension for managing needs/requirements and specifications"
 authors = ["team useblocks <info@useblocks.com>"]
@@ -33,11 +33,11 @@ packages = [
 # [project.dependencies]
 [tool.poetry.dependencies]
 python = ">=3.8,<4"
-sphinx = ">=5.0,<8"
-requests-file = "^1.5.1"  # external links
-requests = "^2.25.1"  # external_links
+sphinx = ">=6.0,<9"
+requests-file = "^2.1"  # external links
+requests = "^2.32"  # external_links
 jsonschema = ">=3.2.0"  # needsimport schema validation
-sphinx-data-viewer = "^0.1.1"  # needservice debug output
+sphinx-data-viewer = "^0.1.5"  # needservice debug output
 sphinxcontrib-jquery = "^4"  # needed for datatables in sphinx>=6
 
 # [project.optional-dependencies.plotting]
@@ -48,11 +48,11 @@ matplotlib = { version = ">=3.3.0", optional = true }
 pytest = { version = "^7", optional = true }
 pytest-cov = { version = "^4", optional = true }
 lxml = { version = "^4.6.5", optional = true }
-requests-mock = { version = ">=1.9.3", optional = true }
 responses = { version = "^0.22.0", optional = true }
 sphinxcontrib-plantuml = { version = "^0", optional = true }
 syrupy = { version = "^3", optional = true }
 pytest-xprocess = { version = "^0.22.2", optional = true }
+defusedxml = { version = "^0.7.1", optional = true }
 
 # [project.optional-dependencies.test-parallel]
 pytest-xdist = { version = "*", optional = true }
@@ -64,19 +64,26 @@ memray = { version = "^1.3.1", optional = true }
 # [project.optional-dependencies.docs]
 sphinx-copybutton = { version="^0.5", optional = true }
 sphinxcontrib-programoutput = { version="^0.17", optional = true }
-sphinx-design = { version="^0.5", optional = true }
-sphinx-immaterial = { version="0.11.7", optional = true }
-pydantic = { version="2.4.2", optional = true }
+sphinx-design = { version="^0.6", optional = true }
+
+# [project.optional-dependencies.theme-im]
+sphinx-immaterial = { version="^0.11.11", optional = true }
+# [project.optional-dependencies.theme-furo]
+furo = { version="^2024.5.4", optional = true }
+# [project.optional-dependencies.theme-pds]
+pydata-sphinx-theme = { version="^0.15.2", optional = true }
+# [project.optional-dependencies.theme-rtd]
+sphinx_rtd_theme = { version="^2.0.0", optional = true }
 
 [tool.poetry.extras]
 plotting = ["matplotlib"]
 test = [
+  "defusedxml",
   "matplotlib",
   "pytest",
   "pytest-cov",
   "syrupy",
   "sphinxcontrib-plantuml",
-  "requests-mock",
   "lxml",
   "responses",
   "pytest-xprocess"
@@ -89,9 +96,11 @@ docs = [
   "sphinx-copybutton",
   "sphinxcontrib-programoutput",
   "sphinx-design",
-  "sphinx-immaterial",
-  "pydantic"  # note this is only required because of https://github.com/jbms/sphinx-immaterial/issues/302
 ]
+theme-im = ["sphinx-immaterial"]
+theme-furo = ["furo"]
+theme-pds = ["pydata-sphinx-theme"]
+theme-rtd = ["sphinx_rtd_theme"]
 
 [tool.poetry.dev-dependencies]
 pre-commit = "^3"
@@ -100,12 +109,25 @@ pre-commit = "^3"
 markers = [
     "jstest: marks tests as JavaScript test (deselect with '-m \"not jstest\"')",
 ]
+filterwarnings = [
+  "ignore:.*removed in Python 3.14.*:DeprecationWarning",
+  "ignore::PendingDeprecationWarning:sphinx_data_viewer.*",
+]
 
-[tool.black]
-line-length = 120
 
-[tool.isort]
-profile = "black"
+[tool.ruff.lint]
+extend-select = [
+  "B",   # flake8-bugbear  
+  "C4",  # flake8-comprehensions
+  "I",   # isort
+  "ICN", # flake8-import-conventions
+  "ISC", # flake8-implicit-str-concat
+  "N",   # pep8-naming
+  "RUF", # Ruff-specific rules
+  "SIM", # flake8-simplify
+  "UP",  # pyupgrade
+]
+extend-ignore = ["B904", "ISC001", "ICN001", "N818", "RUF005", "RUF013", "RUF012", "SIM108", "SIM118"]
 
 [tool.mypy]
 files = "sphinx_needs"
@@ -130,17 +152,11 @@ module = [
 ]
 ignore_missing_imports = true
 
-[[tool.mypy.overrides]]
-module = [
-  'sphinx_needs.api.need',
-  'sphinx_needs.directives.needuml',
-]
-ignore_errors = true
-
 [[tool.mypy.overrides]]
 module = [
   "sphinx_needs.directives.needextend",
   "sphinx_needs.functions.functions",
+  "sphinx_needs.api.need",
 ]
 # TODO dynamically overriding TypeDict keys is a bit tricky
 disable_error_code = "literal-required"
@@ -151,8 +167,50 @@ module = [
 ]
 disable_error_code = ["attr-defined", "no-any-return"]
 
-
 [build-system]
 requires = ["setuptools", "poetry_core>=1.0.8"]  # setuptools for deps like plantuml
 build-backend = "poetry.core.masonry.api"
 
+[tool.tox]
+# To use tox, see https://tox.readthedocs.io
+# $ pipx install tox
+# it is suggested to use with https://github.com/tox-dev/tox-uv or https://github.com/tox-dev/tox-conda
+# $ pipx inject tox tox-uv
+
+legacy_tox_ini = """
+[tox]
+envlist = py38
+
+[testenv]
+usedevelop = true
+
+[testenv:py{38,39,310,311,312}]
+extras =
+  test
+  test-parallel
+commands =
+  pytest --ignore tests/benchmarks {posargs:tests}
+
+[testenv:docs-{alabaster,furo,im,pds,rtd}]
+extras = 
+  docs
+  furo: theme-furo
+  im: theme-im
+  pds: theme-pds
+  rtd: theme-rtd
+passenv =
+    BUILDER
+    CLEAN
+    READTHEDOCS
+    TERM
+setenv =
+    alabaster: DOCS_THEME=alabaster
+    furo: DOCS_THEME=furo
+    im: DOCS_THEME=sphinx_immaterial
+    pds: DOCS_THEME=pydata_sphinx_theme
+    rtd: DOCS_THEME=sphinx_rtd_theme
+commands_pre =
+  python -c "import shutil; shutil.rmtree('docs/_build/{env:BUILDER:html}/{env:DOCS_THEME:}', ignore_errors=True) if '{env:CLEAN:}' else None"
+commands = 
+  sphinx-build -nW --keep-going -b {env:BUILDER:html} docs/ docs/_build/{env:BUILDER:html}/{env:DOCS_THEME:} {posargs:-T}
+"""

{sphinx_needs-2.0.0 → sphinx_needs-3.0.0}/sphinx_needs/api/configuration.py

@@ -3,20 +3,22 @@ API to get or add specific sphinx needs configuration parameters.
 
 All functions here are available under ``sphinxcontrib.api``. So do not import this module directly.
 """
-from typing import Callable, List, Optional
 
-from docutils.parsers.rst import directives
+from __future__ import annotations
+
+from typing import Callable
+
 from sphinx.application import Sphinx
 from sphinx.util.logging import SphinxLoggerAdapter
 
-from sphinx_needs.api.exceptions import NeedsApiConfigException, NeedsApiConfigWarning
+from sphinx_needs.api.exceptions import NeedsApiConfigException
 from sphinx_needs.config import NEEDS_CONFIG, NeedsSphinxConfig
 from sphinx_needs.data import NeedsInfoType
 from sphinx_needs.functions import register_func
 from sphinx_needs.functions.functions import DynamicFunction
 
 
-def get_need_types(app: Sphinx) -> List[str]:
+def get_need_types(app: Sphinx) -> list[str]:
     """
     Returns a list of directive-names from all configured need_types.
 
@@ -34,7 +36,12 @@ def get_need_types(app: Sphinx) -> List[str]:
 
 
 def add_need_type(
-    app: Sphinx, directive: str, title: str, prefix: str, color: str = "#ffffff", style: str = "node"
+    app: Sphinx,
+    directive: str,
+    title: str,
+    prefix: str,
+    color: str = "#ffffff",
+    style: str = "node",
 ) -> None:
     """
     Adds a new need_type to the configuration.
@@ -65,11 +72,21 @@ def add_need_type(
     if directive in type_names:
         raise NeedsApiConfigException(f"{directive} already exists as need type")
 
-    needs_types.append({"directive": directive, "title": title, "prefix": prefix, "color": color, "style": style})
+    needs_types.append(
+        {
+            "directive": directive,
+            "title": title,
+            "prefix": prefix,
+            "color": color,
+            "style": style,
+        }
+    )
     app.add_directive(directive, sphinx_needs.directives.need.NeedDirective)
 
 
-def add_extra_option(app: Sphinx, name: str) -> None:
+def add_extra_option(
+    app: Sphinx, name: str, *, description: str = "Added by add_extra_option API"
+) -> None:
     """
     Adds an extra option to the configuration. This option can then later be used inside needs or ``add_need``.
 
@@ -85,12 +102,12 @@ def add_extra_option(app: Sphinx, name: str) -> None:
     :param name: Name as string of the extra option
     :return: None
     """
-    if name in NEEDS_CONFIG.extra_options:
-        raise NeedsApiConfigWarning(f"Option {name} already registered.")
-    NEEDS_CONFIG.extra_options[name] = directives.unchanged
+    NEEDS_CONFIG.add_extra_option(name, description)
 
 
-def add_dynamic_function(app: Sphinx, function: DynamicFunction, name: Optional[str] = None) -> None:
+def add_dynamic_function(
+    app: Sphinx, function: DynamicFunction, name: str | None = None
+) -> None:
     """
     Registers a new dynamic function for sphinx-needs.
 
@@ -122,7 +139,10 @@ WarningCheck = Callable[[NeedsInfoType, SphinxLoggerAdapter], bool]
 
 
 def add_warning(
-    app: Sphinx, name: str, function: Optional[WarningCheck] = None, filter_string: Optional[str] = None
+    app: Sphinx,
+    name: str,
+    function: WarningCheck | None = None,
+    filter_string: str | None = None,
 ) -> None:
     """
     Registers a warning.
@@ -136,11 +156,14 @@ def add_warning(
     :return: None
     """
     if function is None and filter_string is None:
-        raise NeedsApiConfigException("Function or filter_string must be given for add_warning_func")
+        raise NeedsApiConfigException(
+            "Function or filter_string must be given for add_warning_func"
+        )
 
     if function is not None and filter_string is not None:
         raise NeedsApiConfigException(
-            "For add_warning_func only function or filter_string is allowed to be set, " "not both."
+            "For add_warning_func only function or filter_string is allowed to be set, "
+            "not both."
         )
 
     warning_check = function or filter_string

{sphinx_needs-2.0.0 → sphinx_needs-3.0.0}/sphinx_needs/api/exceptions.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from sphinx.errors import SphinxError, SphinxWarning
 
 
@@ -17,10 +19,6 @@ class NeedsNoIdException(SphinxError):
     pass
 
 
-class NeedsDuplicatedId(SphinxError):
-    pass
-
-
 class NeedsStatusNotAllowed(SphinxError):
     pass