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

Code climate: sdoc_source_code/reader_c: rewrite some missing coverage code

Author: stanislaw

strictdoc/backend/sdoc/models/inline_link.py

@@ -1,4 +1,3 @@
-# mypy: disable-error-code="no-untyped-call,no-untyped-def"
 from typing import Any
 
 from strictdoc.helpers.auto_described import auto_described

strictdoc/backend/sdoc_source_code/reader_c.py

@@ -312,8 +312,9 @@ def read(
                         function_name
                     ] = new_function
             elif node_.type == "comment":
-                if node_.text is None:
-                    raise NotImplementedError("Comment without a text")
+                assert node_.text is not None, (
+                    f"Comment without a text: {node_}"
+                )
 
                 node_text_string = node_.text.decode("utf8")
 
@@ -335,7 +336,7 @@ def read(
                     ):
                         line_marker_processor(line_marker_, parse_context)
                     else:
-                        continue
+                        pass
             else:
                 pass
 

strictdoc/backend/sdoc_source_code/reader_python.py

@@ -216,8 +216,9 @@ def read(
                     function_markers
                 )
             elif node_.type == "comment":
-                if node_.text is None:
-                    raise NotImplementedError("Comment without a text")
+                assert node_.text is not None, (
+                    f"Comment without a text: {node_}"
+                )
 
                 node_text_string = node_.text.decode("utf8")
 
@@ -240,7 +241,7 @@ def read(
                     ):
                         line_marker_processor(line_marker, parse_context)
                     else:
-                        continue
+                        pass
             else:
                 pass
 

strictdoc/helpers/auto_described.py

@@ -3,12 +3,14 @@
 # for simplicity.
 __version__ = "0.0.1"
 
+from typing import Any, Optional
+
 
 # Maybe there is a better way to generate __str__ and __repr__.
 # But for now, this solution works good enough:
 # https://stackoverflow.com/a/33800620/598057
 # https://stackoverflow.com/a/24617244/598057
-def auto_described(cls=None, str_and_repr=True):
+def auto_described(cls: Optional[Any] = None, str_and_repr: bool = True):
     def configure_class(clz):
         def __str__(self):
             return auto_str(self)

tests/unit/strictdoc/backend/sdoc_source_code/readers/test_reader_c.py

@@ -8,9 +8,6 @@
 from strictdoc.backend.sdoc_source_code.reader_c import (
     SourceFileTraceabilityReader_C,
 )
-from strictdoc.backend.sdoc_source_code.reader_python import (
-    SourceFileTraceabilityReader_Python,
-)
 
 pytestmark = pytest.mark.skipif(
     sys.version_info < (3, 9), reason="Requires Python 3.9 or higher"
@@ -20,7 +17,7 @@
 def test_00_empty_file():
     input_string = b""""""
 
-    reader = SourceFileTraceabilityReader_Python()
+    reader = SourceFileTraceabilityReader_C()
 
     info = reader.read(input_string)