Format with ruff

Author: t-sommer

.github/workflows/build.yml

@@ -14,6 +14,7 @@ jobs:
     - run: ruff check
     - run: ruff format --check --diff
   build-win32-binaries:
+    needs: [lint]
     runs-on: windows-2022
     steps:
     - uses: actions/checkout@v4
@@ -25,6 +26,7 @@ jobs:
        path: ./FMI/Resources/Library/win32/ModelicaFMI.dll
        if-no-files-found: error
   build-win64-binaries:
+    needs: [lint]
     runs-on: windows-2022
     steps:
     - uses: actions/checkout@v4
@@ -36,6 +38,7 @@ jobs:
         path: ./FMI/Resources/Library/win64/ModelicaFMI.dll
         if-no-files-found: error
   build-linux64-binaries:
+    needs: [lint]
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v4
@@ -47,6 +50,7 @@ jobs:
         path: ./FMI/Resources/Library/linux64/libModelicaFMI.so
         if-no-files-found: error
   build-darwin64-binaries:
+    needs: [lint]
     runs-on: macos-13
     steps:
     - uses: actions/checkout@v4

modelica_fmi/src/modelica_fmi/__init__.py

@@ -1 +1 @@
-__version__ = '0.0.6'
+__version__ = "0.0.6"

modelica_fmi/src/modelica_fmi/__main__.py

@@ -1,8 +1,6 @@
-""" Entry point for the command line interface """
-
-
-if __name__ == '__main__':
+"""Entry point for the command line interface"""
 
+if __name__ == "__main__":
     from modelica_fmi import cli
 
     cli.main()

modelica_fmi/src/modelica_fmi/cli.py

@@ -1,22 +1,32 @@
 """The Command Line Interface (CLI)"""
 
-def main():
 
+def main():
     import argparse
     from . import __version__ as version
     from .import_fmu_to_modelica import import_fmu_to_modelica
 
     parser = argparse.ArgumentParser(
-        prog='modelica-fmi',
+        prog="modelica-fmi",
         description="Import an FMU into a Modelica library",
-        formatter_class=argparse.RawDescriptionHelpFormatter
+        formatter_class=argparse.RawDescriptionHelpFormatter,
     )
 
-    parser.add_argument('-v', '--version', action='version', version=f'%(prog)s version {version}', help="print the program version")
+    parser.add_argument(
+        "-v",
+        "--version",
+        action="version",
+        version=f"%(prog)s version {version}",
+        help="print the program version",
+    )
 
-    parser.add_argument('fmu_path', help="Path of the FMU to import")
-    parser.add_argument('model_path', help="Path of the Modelica file to generate")
+    parser.add_argument("fmu_path", help="Path of the FMU to import")
+    parser.add_argument("model_path", help="Path of the Modelica file to generate")
 
     args = parser.parse_args()
 
-    import_fmu_to_modelica(fmu_path=args.fmu_path, model_path=args.model_path, interface_type='CoSimulation')
+    import_fmu_to_modelica(
+        fmu_path=args.fmu_path,
+        model_path=args.model_path,
+        interface_type="CoSimulation",
+    )

modelica_fmi/src/modelica_fmi/cross_check.py

@@ -6,29 +6,41 @@
 
 models = [
     [
-        'Dymola',
+        "Dymola",
         [
-            ('https://github.com/CATIA-Systems/dymola-fmi-compatibility/raw/refs/heads/main/2025x%20Refresh%201,%202025-04-11/CoupledClutches_fmi2_Dassl.fmu', '3f2dfb10c7ee6b7a1c16a51e6f2c34796bf47b0e7d62342922170dbee79461eb'),
-            ('https://github.com/CATIA-Systems/dymola-fmi-compatibility/raw/refs/heads/main/2025x%20Refresh%201,%202025-04-11/CoupledClutches_fmi3_Dassl.fmu', 'b45f7f2d71ad2f29f1af24de82b518c98feb53e57a0ad9680e079dcfbc758923'),
+            (
+                "https://github.com/CATIA-Systems/dymola-fmi-compatibility/raw/refs/heads/main/2025x%20Refresh%201,%202025-04-11/CoupledClutches_fmi2_Dassl.fmu",
+                "3f2dfb10c7ee6b7a1c16a51e6f2c34796bf47b0e7d62342922170dbee79461eb",
+            ),
+            (
+                "https://github.com/CATIA-Systems/dymola-fmi-compatibility/raw/refs/heads/main/2025x%20Refresh%201,%202025-04-11/CoupledClutches_fmi3_Dassl.fmu",
+                "b45f7f2d71ad2f29f1af24de82b518c98feb53e57a0ad9680e079dcfbc758923",
+            ),
         ],
     ],
     [
-        'Dymola',
+        "Dymola",
         [
-            ('https://github.com/CATIA-Systems/dymola-fmi-compatibility/raw/refs/heads/main/2025x%20Refresh%201,%202025-04-11/CoupledClutches_fmi2_Dassl.fmu', '3f2dfb10c7ee6b7a1c16a51e6f2c34796bf47b0e7d62342922170dbee79461eb'),
-            ('https://github.com/CATIA-Systems/dymola-fmi-compatibility/raw/refs/heads/main/2025x%20Refresh%201,%202025-04-11/CoupledClutches_fmi3_Dassl.fmu', 'b45f7f2d71ad2f29f1af24de82b518c98feb53e57a0ad9680e079dcfbc758923'),
+            (
+                "https://github.com/CATIA-Systems/dymola-fmi-compatibility/raw/refs/heads/main/2025x%20Refresh%201,%202025-04-11/CoupledClutches_fmi2_Dassl.fmu",
+                "3f2dfb10c7ee6b7a1c16a51e6f2c34796bf47b0e7d62342922170dbee79461eb",
+            ),
+            (
+                "https://github.com/CATIA-Systems/dymola-fmi-compatibility/raw/refs/heads/main/2025x%20Refresh%201,%202025-04-11/CoupledClutches_fmi3_Dassl.fmu",
+                "b45f7f2d71ad2f29f1af24de82b518c98feb53e57a0ad9680e079dcfbc758923",
+            ),
         ],
     ],
 ]
 
 
 def import_dymola_fmus():
-
     for url, checksum in models:
         filename = download_file(url, checksum)
         model_name, _ = os.path.splitext(filename)
-        model_path = rf'E:\WS\Modelica-FMI\FMI\Tests\Dymola\{model_name}.mo'
+        model_path = rf"E:\WS\Modelica-FMI\FMI\Tests\Dymola\{model_name}.mo"
         import_fmu_to_modelica(filename, model_path)
 
-if __name__ == '__main__':
+
+if __name__ == "__main__":
     import_dymola_fmus()

modelica_fmi/src/modelica_fmi/generate_examples.py

@@ -3,64 +3,69 @@
 
 
 def generate_examples():
-
     from fmpy import extract
     from fmpy.util import download_file
     from pathlib import Path
     from .import_fmu_to_modelica import import_fmu_to_modelica
 
-    url = 'https://github.com/modelica/Reference-FMUs/releases/download/v0.0.38/Reference-FMUs-0.0.38.zip'
-    checksum = 'dc3d1467ddea24cf6d171f7eb4d790d7d6f3f7b8856cf76c0cd832c78e8e629a'
+    url = "https://github.com/modelica/Reference-FMUs/releases/download/v0.0.38/Reference-FMUs-0.0.38.zip"
+    checksum = "dc3d1467ddea24cf6d171f7eb4d790d7d6f3f7b8856cf76c0cd832c78e8e629a"
     archive = download_file(url=url, checksum=checksum)
 
     dist = Path(extract(archive))
 
-    examples_dir = Path(__file__).parent.parent.parent.parent / 'FMI' / 'Examples'
+    examples_dir = Path(__file__).parent.parent.parent.parent / "FMI" / "Examples"
 
     shutil.rmtree(examples_dir, ignore_errors=True)
 
     os.makedirs(examples_dir)
 
-    with open(examples_dir / 'package.mo', 'w') as file:
+    with open(examples_dir / "package.mo", "w") as file:
         file.write("""within FMI;
 package Examples
 extends Modelica.Icons.ExamplesPackage;
 end Examples;
 """)
 
-    with open(examples_dir.parent / 'package.order', 'r') as f:
+    with open(examples_dir.parent / "package.order", "r") as f:
         package_order = list(map(lambda line: line.strip(), f.readlines()))
 
-    if 'Examples' not in package_order:
-        with open(examples_dir.parent / 'package.order', 'a') as file:
+    if "Examples" not in package_order:
+        with open(examples_dir.parent / "package.order", "a") as file:
             file.write("Examples\n")
 
     for fmi_version in [2, 3]:
+        os.makedirs(examples_dir / f"FMI{fmi_version}")
 
-        os.makedirs(examples_dir / f'FMI{fmi_version}')
-
-        with open(examples_dir / f'FMI{fmi_version}' / 'package.mo', 'w') as file:
+        with open(examples_dir / f"FMI{fmi_version}" / "package.mo", "w") as file:
             file.write(f"""within FMI.Examples;
 package FMI{fmi_version}
 extends Modelica.Icons.ExamplesPackage;
 end FMI{fmi_version};
 """)
 
-        with open(examples_dir / 'package.order', 'a') as file:
+        with open(examples_dir / "package.order", "a") as file:
             file.write(f"FMI{fmi_version}\n")
 
-        models = ['BouncingBall', 'Dahlquist', 'Feedthrough', 'Stair', 'Resource', 'VanDerPol']
+        models = [
+            "BouncingBall",
+            "Dahlquist",
+            "Feedthrough",
+            "Stair",
+            "Resource",
+            "VanDerPol",
+        ]
 
         if fmi_version == 3:
-            models.append('StateSpace')
+            models.append("StateSpace")
 
         for model in models:
             import_fmu_to_modelica(
-                fmu_path=dist / f'{fmi_version}.0' / f'{model}.fmu',
-                model_path=examples_dir / f'FMI{fmi_version}' / f'{model}.mo',
-                interface_type='CoSimulation',
+                fmu_path=dist / f"{fmi_version}.0" / f"{model}.fmu",
+                model_path=examples_dir / f"FMI{fmi_version}" / f"{model}.mo",
+                interface_type="CoSimulation",
             )
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     generate_examples()

modelica_fmi/src/modelica_fmi/generate_functions.py

@@ -3,72 +3,79 @@
 import jinja2
 
 
-loader = jinja2.FileSystemLoader(searchpath=Path(__file__).parent / 'templates')
+loader = jinja2.FileSystemLoader(searchpath=Path(__file__).parent / "templates")
 
 environment = jinja2.Environment(
     loader=loader,
     trim_blocks=True,
-    block_start_string='@@',
-    block_end_string='@@',
-    variable_start_string='@=',
-    variable_end_string='=@'
+    block_start_string="@@",
+    block_end_string="@@",
+    variable_start_string="@=",
+    variable_end_string="=@",
 )
 
-library_dir = Path(__file__).parent.parent.parent.parent / 'FMI'
-
-for variable_type, prefix in product(['Real', 'Integer', 'Boolean', 'String'], ['Get', 'Set']):
+library_dir = Path(__file__).parent.parent.parent.parent / "FMI"
 
+for variable_type, prefix in product(
+    ["Real", "Integer", "Boolean", "String"], ["Get", "Set"]
+):
     for package, level in [
-        (library_dir / 'FMI2' / 'Functions', ''),
-        (library_dir / 'Internal' / 'FMI2', 'Internal')
+        (library_dir / "FMI2" / "Functions", ""),
+        (library_dir / "Internal" / "FMI2", "Internal"),
     ]:
+        template = environment.get_template(f"FMI2_{level}{prefix}.mo")
 
-        template = environment.get_template(f'FMI2_{level}{prefix}.mo')
-
-        class_text = template.render(
-            variable_type=variable_type
-        )
+        class_text = template.render(variable_type=variable_type)
 
-        function_name = f'FMI2{prefix}{variable_type}'
+        function_name = f"FMI2{prefix}{variable_type}"
 
-        with open(package / f'{function_name}.mo', 'w') as f:
+        with open(package / f"{function_name}.mo", "w") as f:
             f.write(class_text)
 
-        package_order_file = package / 'package.order'
+        package_order_file = package / "package.order"
 
-        with open(package_order_file, 'r') as f:
+        with open(package_order_file, "r") as f:
             package_order = list(map(lambda line: line.strip(), f.readlines()))
 
         if function_name not in package_order:
-            with open(package_order_file, 'a') as f:
-                f.write(function_name + '\n')
+            with open(package_order_file, "a") as f:
+                f.write(function_name + "\n")
 
 for variable_type, (prefix, suffix) in product(
-        ['Float32', 'Float64', 'Int8', 'UInt8', 'Int16', 'UInt16', 'Int32', 'UInt32', 'Int64', 'UInt64', 'Boolean', 'String'],
-        [('Get', ''), ('Set', ''), ('Get', 'Matrix'), ('Set', 'Matrix')]
+    [
+        "Float32",
+        "Float64",
+        "Int8",
+        "UInt8",
+        "Int16",
+        "UInt16",
+        "Int32",
+        "UInt32",
+        "Int64",
+        "UInt64",
+        "Boolean",
+        "String",
+    ],
+    [("Get", ""), ("Set", ""), ("Get", "Matrix"), ("Set", "Matrix")],
 ):
-
     for package, level in [
-        (library_dir / 'FMI3' / 'Functions', ''),
-        (library_dir / 'Internal' / 'FMI3', 'Internal')
+        (library_dir / "FMI3" / "Functions", ""),
+        (library_dir / "Internal" / "FMI3", "Internal"),
     ]:
+        template = environment.get_template(f"FMI3_{level}{prefix}{suffix}.mo")
 
-        template = environment.get_template(f'FMI3_{level}{prefix}{suffix}.mo')
-
-        class_text = template.render(
-            variable_type=variable_type
-        )
+        class_text = template.render(variable_type=variable_type)
 
-        function_name = f'FMI3{prefix}{variable_type}{suffix}'
+        function_name = f"FMI3{prefix}{variable_type}{suffix}"
 
-        with open(package / f'{function_name}.mo', 'w') as f:
+        with open(package / f"{function_name}.mo", "w") as f:
             f.write(class_text)
 
-        package_order_file = package / 'package.order'
+        package_order_file = package / "package.order"
 
-        with open(package_order_file, 'r') as f:
+        with open(package_order_file, "r") as f:
             package_order = list(map(lambda line: line.strip(), f.readlines()))
 
         if function_name not in package_order:
-            with open(package_order_file, 'a') as f:
-                f.write(function_name + '\n')
+            with open(package_order_file, "a") as f:
+                f.write(function_name + "\n")