update

Author: chrisjsewell

sphinx_needs/api/need.py

@@ -4,7 +4,7 @@
 import os
 import re
 import warnings
-from collections.abc import Iterable, Iterator
+from collections.abc import Iterable, Iterator, Sequence
 from contextlib import contextmanager
 from pathlib import Path
 from typing import Any, TypeVar
@@ -64,7 +64,7 @@ def generate_need(
     parts: dict[str, NeedsPartType] | None = None,
     arch: dict[str, str] | None = None,
     signature: None | str = None,
-    sections: list[str] | None = None,
+    sections: Sequence[str] | None = None,
     jinja_content: bool | None = None,
     hide: None | bool = None,
     collapse: None | bool = None,
@@ -353,7 +353,7 @@ def generate_need(
         "modifications": 0,
         "has_dead_links": False,
         "has_forbidden_dead_links": False,
-        "sections": sections or [],
+        "sections": tuple(sections or ()),
         "signature": signature,
     }
 

sphinx_needs/data.py

@@ -328,7 +328,7 @@ class CoreFieldParameters(TypedDict):
     },
     "constraints": {
         "description": "List of constraint names, which are defined for this need.",
-        "schema": {"type": "array", "items": {"type": "string"}, "default": []},
+        "schema": {"type": "array", "items": {"type": "string"}, "default": ()},
         "allow_default": "str_list",
         "allow_df": True,
         "allow_extend": True,
@@ -361,7 +361,7 @@ class CoreFieldParameters(TypedDict):
     },
     "sections": {
         "description": "Sections of the need.",
-        "schema": {"type": "array", "items": {"type": "string"}, "default": []},
+        "schema": {"type": "array", "items": {"type": "string"}, "default": ()},
         "exclude_import": True,
     },
     "section_name": {
@@ -469,7 +469,7 @@ class NeedsInfoType(TypedDict):
 
     # additional source information
     # set in analyse_need_locations transform
-    sections: list[str]
+    sections: tuple[str, ...]
     signature: None | str
     """Derived from a docutils desc_name node."""
 
@@ -496,7 +496,7 @@ class NeedsInfoComputedType(TypedDict):
     """Simply the first section."""
     parent_need: None | str
     """Simply the first parent id."""
-    constraints: list[str]
+    constraints: tuple[str, ...]
     """List of constraint names, which are defined for this need."""
     constraints_passed: bool
     """True if all constraints passed, False if any failed, None if not yet checked."""

sphinx_needs/directives/need.py

@@ -319,7 +319,7 @@ def analyse_need_locations(app: Sphinx, doctree: nodes.document) -> None:
 
         # first we initialize to default values
         if "sections" not in need_info:
-            need_info["sections"] = []
+            need_info["sections"] = ()
 
         if "section_name" not in need_info:
             need_info["section_name"] = None
@@ -341,7 +341,7 @@ def analyse_need_locations(app: Sphinx, doctree: nodes.document) -> None:
 
         # append / set values from need
         if sections:
-            need_info["sections"] = sections
+            need_info["sections"] = tuple(sections)
 
         if signature:
             need_info["signature"] = str(signature)

sphinx_needs/need_item.py

@@ -265,7 +265,7 @@ def _recompute(self) -> None:
             "is_modified": self._core["modifications"] > 0,
             "id_parent": self._core["id"],
             "id_complete": self._core["id"],
-            "constraints": list(self._core["constraints_results"]),
+            "constraints": tuple(self._core["constraints_results"]),
             "constraints_passed": all(
                 result
                 for check in self._core["constraints_results"].values()