🔧 Remove unwrap function (#1017)

This run-time null check is effectively now replaced by the static
type-checking.

Author: chrisjsewell

sphinx_needs/api/need.py

@@ -28,7 +28,7 @@
 from sphinx_needs.logging import get_logger
 from sphinx_needs.nodes import Need
 from sphinx_needs.roles.need_part import find_parts, update_need_with_parts
-from sphinx_needs.utils import jinja_parse, unwrap
+from sphinx_needs.utils import jinja_parse
 
 logger = get_logger(__name__)
 
@@ -512,7 +512,7 @@ def del_need(app: Sphinx, need_id: str) -> None:
     :param app: Sphinx application object.
     :param need_id: Sphinx need id.
     """
-    env = unwrap(app.env)
+    env = app.env
     needs = SphinxNeedsData(env).get_or_create_needs()
     if need_id in needs:
         del needs[need_id]

sphinx_needs/builder.py

@@ -10,7 +10,6 @@
 from sphinx_needs.data import NeedsInfoType, SphinxNeedsData
 from sphinx_needs.logging import get_logger
 from sphinx_needs.needsfile import NeedsList
-from sphinx_needs.utils import unwrap
 
 log = get_logger(__name__)
 
@@ -25,7 +24,7 @@ def write_doc(self, docname: str, doctree: nodes.document) -> None:
         pass
 
     def finish(self) -> None:
-        env = unwrap(self.env)
+        env = self.env
         data = SphinxNeedsData(env)
         filters = data.get_or_create_filters()
         version = getattr(env.config, "version", "unset")
@@ -82,7 +81,7 @@ def get_target_uri(self, _docname: str, _typ: Optional[str] = None) -> str:
 
 
 def build_needs_json(app: Sphinx, _exception: Exception) -> None:
-    env = unwrap(app.env)
+    env = app.env
 
     if not NeedsSphinxConfig(env.config).build_json:
         return
@@ -107,7 +106,7 @@ def write_doc(self, docname: str, doctree: nodes.document) -> None:
         pass
 
     def finish(self) -> None:
-        env = unwrap(self.env)
+        env = self.env
         needumls = SphinxNeedsData(env).get_or_create_umls().values()
 
         for needuml in needumls:
@@ -140,7 +139,7 @@ def get_target_uri(self, _docname: str, _typ: Optional[str] = None) -> str:
 
 
 def build_needumls_pumls(app: Sphinx, _exception: Exception) -> None:
-    env = unwrap(app.env)
+    env = app.env
     config = NeedsSphinxConfig(env.config)
 
     if not config.build_needumls:
@@ -174,7 +173,7 @@ def write_doc(self, docname: str, doctree: nodes.document) -> None:
         pass
 
     def finish(self) -> None:
-        env = unwrap(self.env)
+        env = self.env
         data = SphinxNeedsData(env)
         needs = data.get_or_create_needs().values()  # We need a list of needs for later filter checks
         version = getattr(env.config, "version", "unset")
@@ -216,7 +215,7 @@ def get_target_uri(self, _docname: str, _typ: Optional[str] = None) -> str:
 
 
 def build_needs_id_json(app: Sphinx, _exception: Exception) -> None:
-    env = unwrap(app.env)
+    env = app.env
 
     if not NeedsSphinxConfig(env.config).build_json_per_id:
         return

sphinx_needs/diagrams_common.py

@@ -18,7 +18,7 @@
 from sphinx_needs.data import NeedsFilteredBaseType, NeedsPartsInfoType
 from sphinx_needs.errors import NoUri
 from sphinx_needs.logging import get_logger
-from sphinx_needs.utils import get_scale, split_link_types, unwrap
+from sphinx_needs.utils import get_scale, split_link_types
 
 try:
     from typing import TypedDict
@@ -169,7 +169,7 @@ def calculate_link(app: Sphinx, need_info: NeedsPartsInfoType, _fromdocname: str
     :param fromdocname:
     :return:
     """
-    builder = unwrap(app.builder)
+    builder = app.builder
     try:
         if need_info["is_external"]:
             assert need_info["external_url"] is not None, "external_url must be set for external needs"

sphinx_needs/directives/need.py

@@ -28,7 +28,7 @@
 from sphinx_needs.logging import get_logger
 from sphinx_needs.need_constraints import process_constraints
 from sphinx_needs.nodes import Need
-from sphinx_needs.utils import add_doc, profile, unwrap
+from sphinx_needs.utils import add_doc, profile
 
 logger = get_logger(__name__)
 
@@ -296,8 +296,7 @@ def analyse_need_locations(app: Sphinx, doctree: nodes.document) -> None:
     (i.e. ones that should not be rendered in the output)
     are removed from the doctree.
     """
-    builder = unwrap(app.builder)
-    env = unwrap(builder.env)
+    env = app.env
 
     needs = SphinxNeedsData(env).get_or_create_needs()
 
@@ -376,8 +375,7 @@ def process_need_nodes(app: Sphinx, doctree: nodes.document, fromdocname: str) -
                 node.parent.remove(node)  # type: ignore
         return
 
-    builder = unwrap(app.builder)
-    env = unwrap(builder.env)
+    env = app.env
 
     # If no needs were defined, we do not need to do anything
     if not hasattr(env, "needs_all_needs"):
@@ -430,8 +428,7 @@ def print_need_nodes(app: Sphinx, doctree: nodes.document, fromdocname: str, fou
     :param fromdocname:
     :return:
     """
-    builder = unwrap(app.builder)
-    env = unwrap(builder.env)
+    env = app.env
     needs = SphinxNeedsData(env).get_or_create_needs()
 
     # We try to avoid findall as much as possibles. so we reuse the already found need nodes in the current document.

sphinx_needs/directives/needbar.py

@@ -10,7 +10,7 @@
 from sphinx_needs.config import NeedsSphinxConfig
 from sphinx_needs.data import SphinxNeedsData
 from sphinx_needs.filter_common import FilterBase, filter_needs, prepare_need_list
-from sphinx_needs.utils import add_doc, save_matplotlib_figure, unwrap
+from sphinx_needs.utils import add_doc, save_matplotlib_figure
 
 if not os.environ.get("DISPLAY"):
     matplotlib.use("Agg")
@@ -168,8 +168,7 @@ def run(self) -> Sequence[nodes.Node]:
 # 9. final storage
 # 10. cleanup matplotlib
 def process_needbar(app: Sphinx, doctree: nodes.document, fromdocname: str, found_nodes: List[nodes.Element]) -> None:
-    builder = unwrap(app.builder)
-    env = unwrap(builder.env)
+    env = app.env
     needs_config = NeedsSphinxConfig(env.config)
 
     # NEEDFLOW

sphinx_needs/directives/needextend.py

@@ -15,7 +15,7 @@
 from sphinx_needs.data import SphinxNeedsData
 from sphinx_needs.filter_common import filter_needs
 from sphinx_needs.logging import get_logger
-from sphinx_needs.utils import add_doc, unwrap
+from sphinx_needs.utils import add_doc
 
 logger = get_logger(__name__)
 
@@ -75,8 +75,7 @@ def process_needextend(app: Sphinx, doctree: nodes.document, fromdocname: str) -
     """
     Perform all modifications on needs
     """
-    builder = unwrap(app.builder)
-    env = unwrap(builder.env)
+    env = app.env
     needs_config = NeedsSphinxConfig(env.config)
     data = SphinxNeedsData(env)
     workflow = data.get_or_create_workflow()

sphinx_needs/directives/needextract.py

@@ -19,7 +19,7 @@
 )
 from sphinx_needs.filter_common import FilterBase, process_filters
 from sphinx_needs.layout import create_need
-from sphinx_needs.utils import add_doc, unwrap
+from sphinx_needs.utils import add_doc
 
 
 class Needextract(nodes.General, nodes.Element):
@@ -75,7 +75,7 @@ def process_needextract(
     """
     Replace all needextract nodes with a list of the collected needs.
     """
-    env = unwrap(app.env)
+    env = app.env
     needs_config = NeedsSphinxConfig(app.config)
 
     for node in found_nodes:

sphinx_needs/directives/needfilter.py

@@ -12,7 +12,7 @@
 from sphinx_needs.data import SphinxNeedsData
 from sphinx_needs.diagrams_common import create_legend
 from sphinx_needs.filter_common import FilterBase, process_filters
-from sphinx_needs.utils import add_doc, row_col_maker, unwrap
+from sphinx_needs.utils import add_doc, row_col_maker
 
 
 class Needfilter(nodes.General, nodes.Element):
@@ -74,8 +74,8 @@ def process_needfilters(
 ) -> None:
     # Replace all needlist nodes with a list of the collected needs.
     # Augment each need with a backlink to the original location.
-    builder = unwrap(app.builder)
-    env = unwrap(builder.env)
+    builder = app.builder
+    env = app.env
     needs_config = NeedsSphinxConfig(env.config)
     all_needs = SphinxNeedsData(env).get_or_create_needs()
 

sphinx_needs/directives/needflow.py

@@ -21,7 +21,7 @@
 from sphinx_needs.diagrams_common import calculate_link, create_legend
 from sphinx_needs.filter_common import FilterBase, filter_single_need, process_filters
 from sphinx_needs.logging import get_logger
-from sphinx_needs.utils import add_doc, get_scale, split_link_types, unwrap
+from sphinx_needs.utils import add_doc, get_scale, split_link_types
 
 logger = get_logger(__name__)
 
@@ -271,7 +271,7 @@ def cal_needs_node(
 def process_needflow(app: Sphinx, doctree: nodes.document, fromdocname: str, found_nodes: List[nodes.Element]) -> None:
     # Replace all needflow nodes with a list of the collected needs.
     # Augment each need with a backlink to the original location.
-    env = unwrap(app.env)
+    env = app.env
     needs_config = NeedsSphinxConfig(app.config)
     env_data = SphinxNeedsData(env)
     all_needs = env_data.get_or_create_needs()

sphinx_needs/directives/needgantt.py

@@ -135,7 +135,7 @@ def get_link_type_option(self, name: str, default: str = "") -> List[str]:
 
 def process_needgantt(app: Sphinx, doctree: nodes.document, fromdocname: str, found_nodes: List[nodes.Element]) -> None:
     # Replace all needgantt nodes with a list of the collected needs.
-    env = app.builder.env
+    env = app.env
     needs_config = NeedsSphinxConfig(app.config)
 
     # link_types = needs_config.extra_links