🧪 Reset SN for testing

Author: ubmarco

sphinx_needs/directives/need.py

@@ -50,10 +50,15 @@ class NeedDirective(SphinxDirective):
 
     required_arguments = 1
     optional_arguments = 0
-    option_spec = NEED_DEFAULT_OPTIONS
+    option_spec = NEED_DEFAULT_OPTIONS.copy()
 
     final_argument_whitespace = True
 
+    @classmethod
+    def reset(cls) -> None:
+        """Reset the directive to its initial state."""
+        cls.option_spec = NEED_DEFAULT_OPTIONS
+
     @measure_time("need")
     def run(self) -> Sequence[nodes.Node]:
         if self.options.get("delete"):

sphinx_needs/directives/needbar.py

@@ -3,6 +3,7 @@
 import hashlib
 import math
 from collections.abc import Sequence
+from typing import Any, Callable
 
 from docutils import nodes
 from docutils.parsers.rst import directives
@@ -26,6 +27,27 @@ class Needbar(nodes.General, nodes.Element):
     pass
 
 
+OPTION_SPEC_DEFAULT = {
+    "style": directives.unchanged_required,
+    "colors": directives.unchanged_required,
+    "text_color": directives.unchanged_required,
+    "x_axis_title": directives.unchanged_required,
+    "xlabels": directives.unchanged_required,
+    "xlabels_rotation": directives.unchanged_required,
+    "y_axis_title": directives.unchanged_required,
+    "ylabels": directives.unchanged_required,
+    "ylabels_rotation": directives.unchanged_required,
+    "separator": directives.unchanged_required,
+    "legend": directives.flag,
+    "stacked": directives.flag,
+    "show_sum": directives.flag,
+    "show_top_sum": directives.flag,
+    "sum_rotation": directives.unchanged_required,
+    "transpose": directives.flag,
+    "horizontal": directives.flag,
+}
+
+
 class NeedbarDirective(FilterBase):
     """
     Directive to plot diagrams with the help of matplotlib
@@ -39,25 +61,12 @@ class NeedbarDirective(FilterBase):
     optional_arguments = 1
     final_argument_whitespace = True
 
-    option_spec = {
-        "style": directives.unchanged_required,
-        "colors": directives.unchanged_required,
-        "text_color": directives.unchanged_required,
-        "x_axis_title": directives.unchanged_required,
-        "xlabels": directives.unchanged_required,
-        "xlabels_rotation": directives.unchanged_required,
-        "y_axis_title": directives.unchanged_required,
-        "ylabels": directives.unchanged_required,
-        "ylabels_rotation": directives.unchanged_required,
-        "separator": directives.unchanged_required,
-        "legend": directives.flag,
-        "stacked": directives.flag,
-        "show_sum": directives.flag,
-        "show_top_sum": directives.flag,
-        "sum_rotation": directives.unchanged_required,
-        "transpose": directives.flag,
-        "horizontal": directives.flag,
-    }
+    option_spec: dict[str, Callable[[str], Any]] = OPTION_SPEC_DEFAULT.copy()
+
+    @classmethod
+    def reset(cls) -> None:
+        """Reset the directive to its initial state."""
+        cls.option_spec = OPTION_SPEC_DEFAULT
 
     # Algorithm:
     # 1. define constants

sphinx_needs/directives/needextend.py

@@ -22,6 +22,11 @@ class Needextend(nodes.General, nodes.Element):
     pass
 
 
+OPTION_SPEC_DEFAULT = {
+    "strict": directives.unchanged_required,
+}
+
+
 class NeedextendDirective(SphinxDirective):
     """
     Directive to modify existing needs
@@ -32,9 +37,12 @@ class NeedextendDirective(SphinxDirective):
     optional_arguments = 0
     final_argument_whitespace = True
 
-    option_spec: dict[str, Callable[[str], Any]] = {
-        "strict": directives.unchanged_required,
-    }
+    option_spec: dict[str, Callable[[str], Any]] = OPTION_SPEC_DEFAULT.copy()
+
+    @classmethod
+    def reset(cls) -> None:
+        """Reset the directive to its initial state."""
+        cls.option_spec = OPTION_SPEC_DEFAULT
 
     def run(self) -> Sequence[nodes.Node]:
         env = self.env

sphinx_needs/directives/needextract.py

@@ -2,6 +2,7 @@
 
 import re
 from collections.abc import Sequence
+from typing import Any, Callable
 
 from docutils import nodes
 from docutils.parsers.rst import directives
@@ -30,6 +31,13 @@ class Needextract(nodes.General, nodes.Element):
     pass
 
 
+OPTION_SPEC_DEFAULT = {
+    "layout": directives.unchanged_required,
+    "style": directives.unchanged_required,
+    "show_filters": directives.flag,
+}
+
+
 class NeedextractDirective(FilterBase):
     """
     Directive to filter needs and present them as normal needs with given layout and style.
@@ -38,14 +46,17 @@ class NeedextractDirective(FilterBase):
     optional_arguments = 1
     final_argument_whitespace = True
 
-    option_spec = {
-        "layout": directives.unchanged_required,
-        "style": directives.unchanged_required,
-        "show_filters": directives.flag,
-    }
+    option_spec: dict[str, Callable[[str], Any]] = OPTION_SPEC_DEFAULT.copy()
+
     # Update the options_spec with values defined in the FilterBase class
     option_spec.update(FilterBase.base_option_spec)
 
+    @classmethod
+    def reset(cls) -> None:
+        """Reset the directive to its initial state."""
+        cls.option_spec = OPTION_SPEC_DEFAULT
+        cls.option_spec.update(FilterBase.base_option_spec)
+
     def run(self) -> Sequence[nodes.Node]:
         env = self.env
 

sphinx_needs/directives/needgantt.py

@@ -4,6 +4,7 @@
 import re
 from collections.abc import Sequence
 from datetime import datetime
+from typing import Any, Callable
 
 from docutils import nodes
 from docutils.parsers.rst import directives
@@ -34,29 +35,40 @@ class Needgantt(nodes.General, nodes.Element):
     pass
 
 
+OPTION_SPEC_DEFAULT = {
+    "starts_with_links": directives.unchanged,
+    "starts_after_links": directives.unchanged,
+    "ends_with_links": directives.unchanged,
+    "milestone_filter": directives.unchanged,
+    "start_date": directives.unchanged,
+    "timeline": directives.unchanged,
+    "duration_option": directives.unchanged,
+    "completion_option": directives.unchanged,
+    "no_color": directives.flag,
+}
+
+
 class NeedganttDirective(FilterBase, DiagramBase):
     """
     Directive to get gantt diagrams.
     """
 
     optional_arguments = 1
     final_argument_whitespace = True
-    option_spec = {
-        "starts_with_links": directives.unchanged,
-        "starts_after_links": directives.unchanged,
-        "ends_with_links": directives.unchanged,
-        "milestone_filter": directives.unchanged,
-        "start_date": directives.unchanged,
-        "timeline": directives.unchanged,
-        "duration_option": directives.unchanged,
-        "completion_option": directives.unchanged,
-        "no_color": directives.flag,
-    }
+
+    option_spec: dict[str, Callable[[str], Any]] = OPTION_SPEC_DEFAULT.copy()
 
     # Update the options_spec with values defined in the FilterBase class
     option_spec.update(FilterBase.base_option_spec)
     option_spec.update(DiagramBase.base_option_spec)
 
+    @classmethod
+    def reset(cls) -> None:
+        """Reset the directive to its initial state."""
+        cls.option_spec = OPTION_SPEC_DEFAULT
+        cls.option_spec.update(FilterBase.base_option_spec)
+        cls.option_spec.update(DiagramBase.base_option_spec)
+
     def run(self) -> Sequence[nodes.Node]:
         env = self.env
         needs_config = NeedsSphinxConfig(env.config)

sphinx_needs/directives/needimport.py

@@ -4,6 +4,7 @@
 import os
 import re
 from collections.abc import Sequence
+from typing import Any, Callable
 from urllib.parse import urlparse
 
 import requests
@@ -27,29 +28,37 @@ class Needimport(nodes.General, nodes.Element):
     pass
 
 
+OPTION_SPEC_DEFAULT = {
+    "version": directives.unchanged_required,
+    "hide": directives.flag,
+    "collapse": string_to_boolean,
+    "ids": directives.unchanged_required,
+    "filter": directives.unchanged_required,
+    "id_prefix": directives.unchanged_required,
+    "tags": directives.unchanged_required,
+    "style": directives.unchanged_required,
+    "layout": directives.unchanged_required,
+    "template": directives.unchanged_required,
+    "pre_template": directives.unchanged_required,
+    "post_template": directives.unchanged_required,
+}
+
+
 class NeedimportDirective(SphinxDirective):
     has_content = False
 
     required_arguments = 1
     optional_arguments = 0
 
-    option_spec = {
-        "version": directives.unchanged_required,
-        "hide": directives.flag,
-        "collapse": string_to_boolean,
-        "ids": directives.unchanged_required,
-        "filter": directives.unchanged_required,
-        "id_prefix": directives.unchanged_required,
-        "tags": directives.unchanged_required,
-        "style": directives.unchanged_required,
-        "layout": directives.unchanged_required,
-        "template": directives.unchanged_required,
-        "pre_template": directives.unchanged_required,
-        "post_template": directives.unchanged_required,
-    }
+    option_spec: dict[str, Callable[[str], Any]] = OPTION_SPEC_DEFAULT.copy()
 
     final_argument_whitespace = True
 
+    @classmethod
+    def reset(cls) -> None:
+        """Reset the directive to its initial state."""
+        cls.option_spec = OPTION_SPEC_DEFAULT
+
     @measure_time("needimport")
     def run(self) -> Sequence[nodes.Node]:
         needs_config = NeedsSphinxConfig(self.config)

sphinx_needs/directives/needlist.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Sequence
+from typing import Any, Callable
 
 from docutils import nodes
 from docutils.parsers.rst import directives
@@ -24,20 +25,29 @@ class Needlist(nodes.General, nodes.Element):
     pass
 
 
+OPTION_SPEC_DEFAULT = option_spec = {
+    "show_status": directives.flag,
+    "show_tags": directives.flag,
+    "show_filters": directives.flag,
+}
+
+
 class NeedlistDirective(FilterBase):
     """
     Directive to filter needs and present them inside a list
     """
 
-    option_spec = {
-        "show_status": directives.flag,
-        "show_tags": directives.flag,
-        "show_filters": directives.flag,
-    }
+    option_spec: dict[str, Callable[[str], Any]] = OPTION_SPEC_DEFAULT.copy()
 
     # Update the options_spec with values defined in the FilterBase class
     option_spec.update(FilterBase.base_option_spec)
 
+    @classmethod
+    def reset(cls) -> None:
+        """Reset the directive to its initial state."""
+        cls.option_spec = OPTION_SPEC_DEFAULT
+        cls.option_spec.update(FilterBase.base_option_spec)
+
     def run(self) -> Sequence[nodes.Node]:
         env = self.env
 

sphinx_needs/directives/needpie.py

@@ -2,6 +2,7 @@
 
 import hashlib
 from collections.abc import Iterable, Sequence
+from typing import Any, Callable
 
 from docutils import nodes
 from docutils.parsers.rst import directives
@@ -29,6 +30,17 @@ class Needpie(nodes.General, nodes.Element):
     pass
 
 
+OPTION_SPEC_DEFAULT = {
+    "legend": directives.flag,
+    "explode": directives.unchanged_required,
+    "labels": directives.unchanged_required,
+    "style": directives.unchanged_required,
+    "colors": directives.unchanged_required,
+    "text_color": directives.unchanged_required,
+    "shadow": directives.flag,
+}
+
+
 class NeedpieDirective(FilterBase):
     """
     Directive to plot diagrams with the help of matplotlib
@@ -42,17 +54,26 @@ class NeedpieDirective(FilterBase):
     optional_arguments = 1
     final_argument_whitespace = True
 
-    option_spec = {
-        "legend": directives.flag,
-        "explode": directives.unchanged_required,
-        "labels": directives.unchanged_required,
-        "style": directives.unchanged_required,
-        "colors": directives.unchanged_required,
-        "text_color": directives.unchanged_required,
-        "shadow": directives.flag,
-        "filter-func": FilterBase.base_option_spec["filter-func"],
-        "filter_warning": FilterBase.base_option_spec["filter_warning"],
-    }
+    option_spec: dict[str, Callable[[str], Any]] = OPTION_SPEC_DEFAULT.copy()
+
+    # Update the options_spec with values defined in the FilterBase class
+    option_spec.update(
+        {
+            "filter-func": FilterBase.base_option_spec["filter-func"],
+            "filter_warning": FilterBase.base_option_spec["filter_warning"],
+        }
+    )
+
+    @classmethod
+    def reset(cls) -> None:
+        """Reset the directive to its initial state."""
+        cls.option_spec = OPTION_SPEC_DEFAULT
+        cls.option_spec.update(
+            {
+                "filter-func": FilterBase.base_option_spec["filter-func"],
+                "filter_warning": FilterBase.base_option_spec["filter_warning"],
+            }
+        )
 
     # Update the options_spec only with value filter-func defined in the FilterBase class