Merge pull request #2185 from strictdoc-project/stanislaw/remove_free_text

Code climate: helpers/coverage: exclude dead code from code coverage

Author: stanislaw

strictdoc/core/traceability_index.py

@@ -326,7 +326,7 @@ def get_node_by_uid_weak(
                     if node.reserved_uid == uid:
                         return node
                 else:
-                    raise NotImplementedError
+                    raise NotImplementedError  # pragma: no cover
         return None
 
     def get_linkable_node_by_uid_weak(

strictdoc/export/html/generators/view_objects/document_screen_view_object.py

@@ -101,7 +101,7 @@ def render_screen(self, jinja_environment: JinjaEnvironment) -> Markup:
                 "screens/document/pdf/index.jinja", view_object=self
             )
         else:
-            raise NotImplementedError(self.document_type)
+            raise NotImplementedError(self.document_type)  # pragma: no cover
 
     def render_table_screen(
         self, jinja_environment: JinjaEnvironment
@@ -152,7 +152,7 @@ def render_updated_nodes_and_toc(
                 else:
                     template_folder = "requirement"
             else:
-                raise NotImplementedError
+                raise NotImplementedError  # pragma: no cover
             content = jinja_environment.render_template_as_markup(
                 f"components/{template_folder}/index_extends_node.jinja",
                 view_object=self,
@@ -263,8 +263,8 @@ def render_document_link(
     def render_standalone_document_link(
         document: SDocDocument, context_document: SDocDocument
     ):
-        if context_document is not None:
-            raise NotImplementedError
+        # FIXME: Check if the context_document can be removed.
+        assert context_document is None
         root_prefix = document.meta.get_root_path_prefix()
         document_link = document.meta.get_html_standalone_document_link()
         return (

strictdoc/helpers/coverage.py

@@ -13,28 +13,32 @@ def register_code_coverage_hook() -> None:
 
     current_coverage = coverage.Coverage.current()
 
-    if current_coverage:
-
-        def save_coverage() -> None:
-            print(  # noqa: T201
-                "strictdoc/server: exit hook: saving code coverage...",
-                flush=True,
-            )
-            current_coverage.stop()
-            current_coverage.save()
-
-        atexit.register(save_coverage)
-
-        def handle_signal(
-            signum: int,
-            frame: Optional[types.FrameType],  # noqa: ARG001
-        ) -> None:
-            print(  # noqa: T201
-                f"strictdoc: caught signal {signum}.", flush=True
-            )
-            save_coverage()
-            signal.signal(signum, signal.SIG_DFL)
-            os.kill(os.getpid(), signum)
-
-        for sig in (signal.SIGINT, signal.SIGTERM):
-            signal.signal(sig, handle_signal)
+    assert current_coverage is not None
+
+    def save_coverage() -> None:
+        print(  # noqa: T201
+            "strictdoc/server: exit hook: saving code coverage...",
+            flush=True,
+        )
+        current_coverage.stop()
+        # Code coverage is stopped at this point. Marking the next line to
+        # be excluded from code coverage.
+        current_coverage.save()  # pragma: no cover
+
+    atexit.register(save_coverage)
+
+    def handle_signal(
+        signum: int,
+        frame: Optional[types.FrameType],  # noqa: ARG001
+    ) -> None:
+        print(  # noqa: T201
+            f"strictdoc: caught signal {signum}.", flush=True
+        )
+        save_coverage()
+        # Code coverage is stopped at this point. Marking the next line to
+        # be excluded from code coverage.
+        signal.signal(signum, signal.SIG_DFL)  # pragma: no cover
+        os.kill(os.getpid(), signum)  # pragma: no cover
+
+    for sig in (signal.SIGINT, signal.SIGTERM):
+        signal.signal(sig, handle_signal)

tasks.py

@@ -1018,7 +1018,7 @@ def check_file_owner(filepath):
     )
 
 
-@task()
+@task(aliases=["q"])
 def qualification(context):
     test_all(context, coverage=True)
     coverage_combine(context)