Add compile option to compile project files to bytecode ref #22 (#23)

Author: StephenSmith25

README.md

@@ -36,7 +36,7 @@ pip install pythonfmu3
 3. Run `pythonfmu3 build` to create the fmu.
 
 ```
-usage: pythonfmu3 build [-h] -f SCRIPT_FILE [-d DEST] [--doc DOCUMENTATION_FOLDER] [--terminals TERMINALS_FILE] [--no-external-tool]
+usage: pythonfmu3 build [-h] -f SCRIPT_FILE [-d DEST] [--doc DOCUMENTATION_FOLDER] [--terminals TERMINALS_FILE] [--compile] [--no-external-tool]
                        [--no-variable-step] [--interpolate-inputs] [--only-one-per-process] [--handle-state]
                        [--serialize-state] [--use-memory-management]
                        [Project files [Project files ...]]
@@ -55,6 +55,7 @@ optional arguments:
                         Documentation folder to include in the FMU.
   --terminals TERMINALS_FILE
                         Terminals file (terminalsAndIcons.xml) to include in the FMU.
+  --compile             If given, the script file and project files will be compiled to byte code.
   --no-external-tool    If given, needsExecutionTool=false
   --no-variable-step    If given, canHandleVariableCommunicationStepSize=false
   --interpolate-inputs  If given, canInterpolateInputs=true

pythonfmu3/builder.py

@@ -3,6 +3,7 @@
 import importlib
 import itertools
 import logging
+import py_compile
 import re
 import shutil
 import sys
@@ -20,11 +21,29 @@
 
 logger = logging.getLogger(__name__)
 
+def compile_source_file(source_file: FilePath, clean_existing: bool = False) -> Path:
+    compiled_file = source_file.with_suffix(".pyc")
+    py_compile.compile(source_file, cfile=compiled_file)
+    if clean_existing:
+        source_file.unlink(missing_ok=True)
+    return compiled_file
 
 def get_class_name(file_name: Path) -> str:
-    with open(str(file_name), 'r') as file:
-        data = file.read()
-        return re.search(r'class (\w+)\(\s*Fmi3Slave\s*\)\s*:', data).group(1)
+
+    if file_name.suffix == ".py":
+        with open(str(file_name), 'r') as file:
+            data = file.read()
+            return re.search(r'class (\w+)\(\s*Fmi3Slave\s*\)\s*:', data).group(1)
+
+    elif file_name.suffix == ".pyc":
+        # For .pyc files, use importlib to load the module and inspect its classes
+        import importlib.util
+        spec = importlib.util.spec_from_file_location("module_name", file_name)
+        module = importlib.util.module_from_spec(spec)
+        spec.loader.exec_module(module)
+        for name, obj in vars(module).items():
+            if isinstance(obj, type) and issubclass(obj, Fmi3Slave) and obj is not Fmi3Slave:
+                return name
 
 
 def get_model_description(filepath: Path, module_name: str) -> Tuple[str, Element]:
@@ -86,7 +105,7 @@ def build_FMU(
                 raise ValueError(
                     f"The documentation folder does not exists {documentation_folder!s}"
                 )
-        
+
         if terminals is not None:
             terminals = Path(terminals)
             if not terminals.exists():
@@ -99,11 +118,14 @@ def build_FMU(
                 )
 
         module_name = script_file.stem
+        compile_flag = options.get("compile", False)
 
         with tempfile.TemporaryDirectory(prefix="pythonfmu_") as tempd:
             temp_dir = Path(tempd)
             shutil.copy2(script_file, temp_dir)
 
+            if compile_flag:
+                script_file = compile_source_file(temp_dir / script_file.name, clean_existing=True)
             # Embed pythonfmu in the FMU so it does not need to be included
             dep_folder = temp_dir / "pythonfmu3"
             dep_folder.mkdir()
@@ -130,6 +152,11 @@ def build_FMU(
                     else:
                         shutil.copy2(file_, temp_dir)
 
+            for f in temp_dir.rglob("*.py"):
+                if f.suffix == ".py" and compile_flag:
+                    compile_source_file(f, clean_existing=True)
+
+
             model_identifier, xml = get_model_description(
                 temp_dir.absolute() / script_file.name, module_name
             )
@@ -194,7 +221,7 @@ def build_FMU(
                     terminalsFolder = Path("terminalsAndIcons")
                     relative_f = terminals.relative_to(terminals.parent)
                     zip_fmu.write(f, arcname=(terminalsFolder / relative_f))
-                    
+
 
                 # Add the model description
                 xml_str = parseString(tostring(xml, "UTF-8"))
@@ -240,6 +267,13 @@ def create_command_parser(parser: argparse.ArgumentParser):
         default=None
     )
 
+    parser.add_argument(
+        "--compile",
+        dest="compile",
+        help="If given, the Python script and project files will be compiled to bytecode.",
+        action="store_true"
+    )
+
     for option in FMI3_MODEL_OPTIONS:
         action = "store_false" if option.value else "store_true"
         parser.add_argument(

pythonfmu3/tests/test_builder.py

@@ -22,16 +22,18 @@
 )
 
 
-def test_zip_content(tmp_path):
-
+@pytest.mark.parametrize("compile", [False, True])
+def test_zip_content(tmp_path, compile):
+    extension = ".pyc" if compile else ".py" 
     script_name = "pythonslave.py"
     script_file = Path(__file__).parent / "slaves" / script_name
-    fmu = FmuBuilder.build_FMU(script_file, dest=tmp_path)
+    fmu = FmuBuilder.build_FMU(script_file, dest=tmp_path, compile=compile)
     assert fmu.exists()
     assert zipfile.is_zipfile(fmu)
 
     with zipfile.ZipFile(fmu) as files:
         names = files.namelist()
+        script_name = script_name.replace(".py", extension)
 
         assert "modelDescription.xml" in names
         assert "/".join(("resources", script_name)) in names
@@ -60,8 +62,11 @@ def test_zip_content(tmp_path):
 
         # Check pythonfmu is embedded
         pkg_folder = Path(pythonfmu3.__path__[0])
-        for f in pkg_folder.rglob("*.py"):
+        for f in pkg_folder.rglob(f"*.py"):
             relative_f = f.relative_to(pkg_folder).as_posix()
+            # change relative f suffix
+            if relative_f.endswith(".py"):
+                relative_f = relative_f.replace(".py", extension)
             if "test" not in relative_f:
                 assert "/".join(("resources", "pythonfmu3", relative_f)) in names
 
@@ -101,7 +106,6 @@ def build():
                     project_files.add(full_name.parent)
 
             return FmuBuilder.build_FMU(script_file, dest=tmp_path, project_files=project_files)
-
     fmu = build()
     with zipfile.ZipFile(fmu) as files:
         names = files.namelist()
@@ -119,7 +123,8 @@ def build():
 
 
 @pytest.mark.parametrize("pfiles", PROJECT_TEST_CASES)
-def test_project_files_containing_script(tmp_path, pfiles):
+@pytest.mark.parametrize("compile", [False, True])
+def test_project_files_containing_script(tmp_path, pfiles, compile):
     orig_script_file = Path(__file__).parent / "slaves/pythonslave.py"
     pfiles = map(Path, pfiles)
 
@@ -139,7 +144,7 @@ def build():
                     full_name.mkdir(parents=True, exist_ok=True)
 
             return FmuBuilder.build_FMU(
-                script_file, dest=tmp_path, project_files=[script_file.parent]
+                script_file, dest=tmp_path, project_files=[script_file.parent], compile=compile
             )
 
     fmu = build()