Merge pull request #162 from strictdoc-project/stanislaw/actions

CI: update Python action version

Author: stanislaw

.github/workflows/ci-linux.yml

@@ -15,10 +15,10 @@ jobs:
         python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 

.github/workflows/ci-mac.yml

@@ -8,17 +8,17 @@ on:
 
 jobs:
   build:
-    runs-on: macOS-latest
+    runs-on: macos-13
 
     strategy:
       matrix:
         python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 

.github/workflows/ci-windows.yml

@@ -15,16 +15,10 @@ jobs:
         python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
     steps:
-    - uses: actions/checkout@v2
-
-    - name: "Print Debug info"
-      run: |
-        echo $env:USERPROFILE
-        echo $env:PATH
-        echo "$PWD"
+    - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 

reqif/__init__.py

@@ -2,6 +2,4 @@
 
 __version__ = "0.0.41"
 
-PATH_TO_REQIF_ROOT = os.path.abspath(
-    os.path.join(os.path.dirname(__file__), os.pardir)
-)
+PATH_TO_REQIF_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), os.pardir))

reqif/cli/cli_arg_parser.py

@@ -11,9 +11,7 @@ def formatter(prog):
     main_parser = argparse.ArgumentParser()
     main_parser.formatter_class = formatter
 
-    command_subparsers = main_parser.add_subparsers(
-        title="command", dest="command"
-    )
+    command_subparsers = main_parser.add_subparsers(title="command", dest="command")
     command_subparsers.required = True
 
     # Command – Passthrough
@@ -60,10 +58,7 @@ def formatter(prog):
     # Command – Format
     command_parser_format = command_subparsers.add_parser(
         "format",
-        help=(
-            "Read a ReqIF file and pretty-print its contents to "
-            "an output file."
-        ),
+        help=("Read a ReqIF file and pretty-print its contents to " "an output file."),
         formatter_class=formatter,
     )
     command_parser_format.add_argument(
@@ -169,14 +164,10 @@ def get_convert_config(self) -> ConvertCommandConfig:
         return ConvertCommandConfig(self.args.input_file, self.args.output_file)
 
     def get_passthrough_config(self) -> PassthroughCommandConfig:
-        return PassthroughCommandConfig(
-            self.args.input_file, self.args.output_file
-        )
+        return PassthroughCommandConfig(self.args.input_file, self.args.output_file)
 
     def get_anonymize_config(self) -> AnonimizeCommandConfig:
-        return AnonimizeCommandConfig(
-            self.args.input_file, self.args.output_file
-        )
+        return AnonimizeCommandConfig(self.args.input_file, self.args.output_file)
 
     def get_dump_config(self) -> DumpCommandConfig:
         return DumpCommandConfig(self.args.input_file, self.args.output_file)
@@ -185,9 +176,7 @@ def get_format_config(self) -> FormatCommandConfig:
         return FormatCommandConfig(self.args.input_file, self.args.output_file)
 
     def get_validate_config(self) -> ValidateCommandConfig:
-        return ValidateCommandConfig(
-            self.args.input_file, self.args.use_reqif_schema
-        )
+        return ValidateCommandConfig(self.args.input_file, self.args.use_reqif_schema)
 
 
 def create_reqif_args_parser(testing_args=None) -> ReqIFArgsParser:

reqif/cli/main.py

@@ -2,9 +2,7 @@
 import sys
 
 try:
-    ROOT_PATH = os.path.abspath(
-        os.path.join(os.path.dirname(__file__), "..", "..")
-    )
+    ROOT_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", ".."))
     if not os.path.isdir(ROOT_PATH):
         raise FileNotFoundError(ROOT_PATH)
     sys.path.append(ROOT_PATH)

reqif/commands/anonymize/anonymize.py

@@ -19,9 +19,7 @@
 
 def anonymize_string(string: str) -> str:
     # https://stackoverflow.com/a/42089311/598057
-    hash_number = (
-        int(hashlib.sha256(string.encode("utf8")).hexdigest(), 16) % 10**10
-    )
+    hash_number = int(hashlib.sha256(string.encode("utf8")).hexdigest(), 16) % 10**10
     return "..." + ANONYMIZED + "-" + str(hash_number) + "..."
 
 
@@ -80,9 +78,7 @@ def _anonymize(config: AnonimizeCommandConfig):
             )
 
         # Clear out all SPECIFICATION names.
-        xml_specifications = xml_reqif.xpath(
-            "//reqif:SPECIFICATION", namespaces=fixns
-        )
+        xml_specifications = xml_reqif.xpath("//reqif:SPECIFICATION", namespaces=fixns)
         for xml_specification in xml_specifications:
             if "LONG-NAME" in xml_specification.attrib:
                 xml_specification.attrib["LONG-NAME"] = anonymize_string(
@@ -95,9 +91,7 @@ def _anonymize(config: AnonimizeCommandConfig):
         )
         for xml_attribute_value_string in xml_attribute_value_strings:
             if "THE-VALUE" in xml_attribute_value_string.attrib:
-                xml_attribute_value_string.attrib[
-                    "THE-VALUE"
-                ] = anonymize_string(
+                xml_attribute_value_string.attrib["THE-VALUE"] = anonymize_string(
                     xml_attribute_value_string.attrib["THE-VALUE"]
                 )
 
@@ -106,8 +100,8 @@ def _anonymize(config: AnonimizeCommandConfig):
             "//reqif:ATTRIBUTE-VALUE-XHTML/reqif:THE-VALUE", namespaces=fixns
         )
         for xml_attribute_value_xhtml in xml_attribute_value_xhtmls:
-            xml_attribute_value_xhtml_text: str = (
-                lxml_stringify_namespaced_children(xml_attribute_value_xhtml)
+            xml_attribute_value_xhtml_text: str = lxml_stringify_namespaced_children(
+                xml_attribute_value_xhtml
             )
             for child in list(xml_attribute_value_xhtml):
                 xml_attribute_value_xhtml.remove(child)

reqif/commands/passthrough/passthrough.py

@@ -45,8 +45,6 @@ def _passthrough(passthrough_config: PassthroughCommandConfig) -> bytes:
     def _passthrough_reqifz(
         passthrough_config: PassthroughCommandConfig,
     ) -> bytes:
-        reqifz_bundle: ReqIFZBundle = ReqIFZParser.parse(
-            passthrough_config.input_file
-        )
+        reqifz_bundle: ReqIFZBundle = ReqIFZParser.parse(passthrough_config.input_file)
         reqifz_output = ReqIFZUnparser.unparse(reqifz_bundle)
         return reqifz_output

reqif/commands/validate/validate.py

@@ -194,9 +194,7 @@ def _validate_specifications(
             for hierarchy in reqif_bundle.iterate_specification_hierarchy(
                 specification
             ):
-                if not reqif_bundle.lookup.spec_object_exists(
-                    hierarchy.spec_object
-                ):
+                if not reqif_bundle.lookup.spec_object_exists(hierarchy.spec_object):
                     warnings.append(
                         ReqIFSpecHierarchyMissingSpecObjectException(
                             xml_node=hierarchy.xml_node,

reqif/experimental/reqif_schema.py

@@ -19,9 +19,7 @@ def __init__(self, reqif_bundle: ReqIFBundle):
         spec_object_type_attributes: Dict[str, SpecAttributeDefinition] = {}
         spec_object_type_names: Dict[str, str] = {}
         detected_section_spec_type: Optional[ReqIFSpecObjectType] = None
-        detected_chapter_name_attribute: Optional[
-            SpecAttributeDefinition
-        ] = None
+        detected_chapter_name_attribute: Optional[SpecAttributeDefinition] = None
         detected_schema_type: ReqIFSchema.ReqIFSchemaType = (
             ReqIFSchema.ReqIFSchemaType.DEFAULT
         )
@@ -47,27 +45,25 @@ def __init__(self, reqif_bundle: ReqIFBundle):
             for attribute_definition in spec_type.attribute_definitions:
                 if attribute_definition.long_name == "ReqIF.ChapterName":
                     detected_chapter_name_attribute = attribute_definition
-                spec_object_type_attributes[
-                    attribute_definition.identifier
-                ] = attribute_definition
+                spec_object_type_attributes[attribute_definition.identifier] = (
+                    attribute_definition
+                )
 
         assert reqif_bundle.core_content.req_if_content.data_types is not None
         for data_type in reqif_bundle.core_content.req_if_content.data_types:
             data_type_definitions[data_type.identifier] = data_type
 
         self.data_type_definitions: Dict[str, Any] = data_type_definitions
-        self.spec_object_type_attributes: Dict[
-            str, SpecAttributeDefinition
-        ] = spec_object_type_attributes
+        self.spec_object_type_attributes: Dict[str, SpecAttributeDefinition] = (
+            spec_object_type_attributes
+        )
         self.spec_object_type_names: Dict[str, str] = spec_object_type_names
         self.reqif_bundle: ReqIFBundle = reqif_bundle
         self.detected_heading_spec_type = detected_section_spec_type
-        self.detected_chapter_name_attribute: Optional[
-            SpecAttributeDefinition
-        ] = detected_chapter_name_attribute
-        self.detected_schema_type: ReqIFSchema.ReqIFSchemaType = (
-            detected_schema_type
+        self.detected_chapter_name_attribute: Optional[SpecAttributeDefinition] = (
+            detected_chapter_name_attribute
         )
+        self.detected_schema_type: ReqIFSchema.ReqIFSchemaType = detected_schema_type
 
     def is_spec_object_a_heading(self, spec_object: ReqIFSpecObject):
         if self.detected_heading_spec_type is not None:
@@ -92,4 +88,7 @@ def iterate_unique_field_names(self):
             if attribute_definition_.long_name in unique_names_so_far:
                 continue
             unique_names_so_far.add(attribute_definition_.long_name)
-            yield attribute_definition_.long_name, attribute_definition_.attribute_type.name
+            yield (
+                attribute_definition_.long_name,
+                attribute_definition_.attribute_type.name,
+            )