pythonfmu3 0.1.17__tar.gz → 0.1.18__tar.gz

{pythonfmu3-0.1.17/pythonfmu3.egg-info → pythonfmu3-0.1.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pythonfmu3
-Version: 0.1.17
+Version: 0.1.18
 Summary: A lightweight framework that enables the packaging of Python3.x code as co-simulation FMUs.
 Home-page: https://github.com/stephensmith25/PythonFMU3
 Author: Stephen Smith
@@ -62,7 +62,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_FOLDER] [--no-external-tool]
+usage: pythonfmu3 build [-h] -f SCRIPT_FILE [-d DEST] [--doc DOCUMENTATION_FOLDER] [--terminals TERMINALS_FILE] [--no-external-tool]
                        [--no-variable-step] [--interpolate-inputs] [--only-one-per-process] [--handle-state]
                        [--serialize-state] [--use-memory-management]
                        [Project files [Project files ...]]
@@ -79,8 +79,8 @@ optional arguments:
   -d DEST, --dest DEST  Where to save the FMU.
   --doc DOCUMENTATION_FOLDER
                         Documentation folder to include in the FMU.
-  --terminals TERMINALS_FOLDER
-                        Folder of terminals to include in the FMU.
+  --terminals TERMINALS_FILE
+                        Terminals file (terminalsAndIcons.xml) to include in the FMU.
   --no-external-tool    If given, needsExecutionTool=false
   --no-variable-step    If given, canHandleVariableCommunicationStepSize=false
   --interpolate-inputs  If given, canInterpolateInputs=true

{pythonfmu3-0.1.17 → pythonfmu3-0.1.18}/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_FOLDER] [--no-external-tool]
+usage: pythonfmu3 build [-h] -f SCRIPT_FILE [-d DEST] [--doc DOCUMENTATION_FOLDER] [--terminals TERMINALS_FILE] [--no-external-tool]
                        [--no-variable-step] [--interpolate-inputs] [--only-one-per-process] [--handle-state]
                        [--serialize-state] [--use-memory-management]
                        [Project files [Project files ...]]
@@ -53,8 +53,8 @@ optional arguments:
   -d DEST, --dest DEST  Where to save the FMU.
   --doc DOCUMENTATION_FOLDER
                         Documentation folder to include in the FMU.
-  --terminals TERMINALS_FOLDER
-                        Folder of terminals to include in the FMU.
+  --terminals TERMINALS_FILE
+                        Terminals file (terminalsAndIcons.xml) to include in the FMU.
   --no-external-tool    If given, needsExecutionTool=false
   --no-variable-step    If given, canHandleVariableCommunicationStepSize=false
   --interpolate-inputs  If given, canInterpolateInputs=true

pythonfmu3-0.1.18/pythonfmu3/_version.py

@@ -0,0 +1 @@
+__version__ = "0.1.18"

{pythonfmu3-0.1.17 → pythonfmu3-0.1.18}/pythonfmu3/builder.py

@@ -66,7 +66,7 @@ class FmuBuilder:
         dest: FilePath = ".",
         project_files: Iterable[FilePath] = set(),
         documentation_folder: Optional[FilePath] = None,
-        terminals_folder: Optional[FilePath] = None,
+        terminals : Optional[FilePath] = None,
         **options,
     ) -> Path:
         script_file = Path(script_file)
@@ -87,11 +87,15 @@ class FmuBuilder:
                     f"The documentation folder does not exists {documentation_folder!s}"
                 )
         
-        if terminals_folder is not None:
-            terminals_folder = Path(terminals_folder)
-            if not terminals_folder.exists():
+        if terminals is not None:
+            terminals = Path(terminals)
+            if not terminals.exists():
                 raise ValueError(
-                    f"The terminals folder does not exists {terminals_folder!s}"
+                    f"The specified terminalsAndIcons file does not exists {terminals!s}"
+                )
+            if not terminals.name == "terminalsAndIcons.xml":
+                raise ValueError(
+                    f"Incorrect terminal name {terminals!s}. Terminal file must be named terminalsAndIcons.xml"
                 )
 
         module_name = script_file.stem
@@ -186,12 +190,10 @@ class FmuBuilder:
                             relative_f = f.relative_to(documentation_folder)
                             zip_fmu.write(f, arcname=(documentation / relative_f))
 
-                if terminals_folder is not None:
-                    terminals = Path("terminalsAndIcons")
-                    for f in terminals_folder.rglob("*.xml"):
-                        if f.is_file():
-                            relative_f = f.relative_to(terminals_folder)
-                            zip_fmu.write(f, arcname=(terminals / relative_f))
+                if terminals is not None:
+                    terminalsFolder = Path("terminalsAndIcons")
+                    relative_f = terminals.relative_to(terminals.parent)
+                    zip_fmu.write(f, arcname=(terminalsFolder / relative_f))
                     
 
                 # Add the model description
@@ -233,8 +235,8 @@ def create_command_parser(parser: argparse.ArgumentParser):
 
     parser.add_argument(
         "--terminals",
-        dest="terminals_folder",
-        help="Folder containing terminals to include in the FMU.",
+        dest="terminals",
+        help="Terminals file (terminalsAndIcons.xml) to include in the FMU.",
         default=None
     )
 

{pythonfmu3-0.1.17 → pythonfmu3-0.1.18}/pythonfmu3/tests/test_builder.py

@@ -183,16 +183,13 @@ def test_terminals(tmp_path):
     def build():
         with tempfile.TemporaryDirectory() as terminals_dir:
             terminals_dir = Path(terminals_dir)
-            terminal1 = terminals_dir / "terminal1.xml"
-            terminal1.write_text("Dummy Terminal 1")
+            terminals = terminals_dir / "terminalsAndIcons.xml"
+            terminals.write_text("Dummy Terminal 1")
 
-            terminal2 = terminals_dir / "terminal2.xml"
-            terminal2.write_text("Dummy Terminal 2")
-            return FmuBuilder.build_FMU(script_file, dest=tmp_path, terminals_folder=terminals_dir)
+            return FmuBuilder.build_FMU(script_file, dest=tmp_path, terminals=terminals)
 
     fmu = build()
     with zipfile.ZipFile(fmu) as files:
         names = files.namelist()
 
-        assert "terminalsAndIcons/terminal1.xml" in names
-        assert "terminalsAndIcons/terminal2.xml" in names
+        assert "terminalsAndIcons/terminalsAndIcons.xml" in names

{pythonfmu3-0.1.17 → pythonfmu3-0.1.18/pythonfmu3.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pythonfmu3
-Version: 0.1.17
+Version: 0.1.18
 Summary: A lightweight framework that enables the packaging of Python3.x code as co-simulation FMUs.
 Home-page: https://github.com/stephensmith25/PythonFMU3
 Author: Stephen Smith
@@ -62,7 +62,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_FOLDER] [--no-external-tool]
+usage: pythonfmu3 build [-h] -f SCRIPT_FILE [-d DEST] [--doc DOCUMENTATION_FOLDER] [--terminals TERMINALS_FILE] [--no-external-tool]
                        [--no-variable-step] [--interpolate-inputs] [--only-one-per-process] [--handle-state]
                        [--serialize-state] [--use-memory-management]
                        [Project files [Project files ...]]
@@ -79,8 +79,8 @@ optional arguments:
   -d DEST, --dest DEST  Where to save the FMU.
   --doc DOCUMENTATION_FOLDER
                         Documentation folder to include in the FMU.
-  --terminals TERMINALS_FOLDER
-                        Folder of terminals to include in the FMU.
+  --terminals TERMINALS_FILE
+                        Terminals file (terminalsAndIcons.xml) to include in the FMU.
   --no-external-tool    If given, needsExecutionTool=false
   --no-variable-step    If given, canHandleVariableCommunicationStepSize=false
   --interpolate-inputs  If given, canInterpolateInputs=true

pythonfmu3-0.1.17/pythonfmu3/_version.py

@@ -1 +0,0 @@
-__version__ = "0.1.17"