pythonfmu3 0.3.2__py3-none-any.whl → 0.3.3__py3-none-any.whl

pythonfmu3/_version.py

@@ -1 +1 @@
-__version__ = "0.3.2"
+__version__ = "0.3.3"

pythonfmu3/builder.py

@@ -13,7 +13,7 @@ from typing import Iterable, Optional, Tuple, Union
 from xml.dom.minidom import parseString
 from xml.etree.ElementTree import Element, SubElement, tostring
 from .osutil import get_lib_extension, get_platform
-from .fmi3slave import FMI3_MODEL_OPTIONS, Fmi3Slave, Fmi3SlaveBase
+from .fmi3slave import FMI3_MODEL_OPTIONS_COMMON, FMI3_MODEL_OPTIONS_COSIM, FMI3_MODEL_OPTIONS_MX, Fmi3Slave, Fmi3SlaveBase
 
 FilePath = Union[str, Path]
 HERE = Path(__file__).parent
@@ -137,16 +137,20 @@ class FmuBuilder:
             dest_file = dest / f"{model_identifier}.fmu"
 
             type_node = xml.find("CoSimulation")
-            option_names = [opt.name for opt in FMI3_MODEL_OPTIONS]
-            if type_node:
+            option_names = [opt.name for opt in FMI3_MODEL_OPTIONS_COMMON]
+            cosim_option_names = option_names.copy()
+            cosim_option_names.extend(opt.name for opt in FMI3_MODEL_OPTIONS_COSIM)
+            if type_node is not None:
                 for option, value in options.items():
-                    if option in option_names:
+                    if option in cosim_option_names:
                         type_node.set(option, str(value).lower())
 
             type_node = xml.find("ModelExchange")
-            if type_node:
+            mx_option_names = option_names.copy()
+            mx_option_names.extend(opt.name for opt in FMI3_MODEL_OPTIONS_MX)
+            if type_node is not None:
                 for option, value in options.items():
-                    if option in option_names:
+                    if option in mx_option_names:
                         type_node.set(option, str(value).lower())
 
             with zipfile.ZipFile(dest_file, "w") as zip_fmu:
@@ -247,7 +251,25 @@ def create_command_parser(parser: argparse.ArgumentParser):
         default=None
     )
 
-    for option in FMI3_MODEL_OPTIONS:
+    for option in FMI3_MODEL_OPTIONS_COMMON:
+        action = "store_false" if option.value else "store_true"
+        parser.add_argument(
+            f"--{option.cli}",
+            dest=option.name,
+            help=f"If given, {option.name}={action[6:]}",
+            action=action
+        )
+
+    for option in FMI3_MODEL_OPTIONS_COSIM:
+        action = "store_false" if option.value else "store_true"
+        parser.add_argument(
+            f"--{option.cli}",
+            dest=option.name,
+            help=f"If given, {option.name}={action[6:]}",
+            action=action
+        )
+    
+    for option in FMI3_MODEL_OPTIONS_MX:
         action = "store_false" if option.value else "store_true"
         parser.add_argument(
             f"--{option.cli}",

pythonfmu3/fmi3slave.py

@@ -21,14 +21,22 @@ from .unit import Unit
 
 ModelOptions = namedtuple("ModelOptions", ["name", "value", "cli"])
 
-FMI3_MODEL_OPTIONS: List[ModelOptions] = [
+FMI3_MODEL_OPTIONS_COMMON: List[ModelOptions] = [
     ModelOptions("needsExecutionTool", True, "no-external-tool"),
-    ModelOptions("canHandleVariableCommunicationStepSize", True, "no-variable-step"),
     ModelOptions("canBeInstantiatedOnlyOncePerProcess", False, "only-one-per-process"),
     ModelOptions("canGetAndSetFMUState", False, "handle-state"),
     ModelOptions("canSerializeFMUState", False, "serialize-state")
 ]
 
+FMI3_MODEL_OPTIONS_COSIM: List[ModelOptions] = [
+    ModelOptions("canHandleVariableCommunicationStepSize", True, "no-variable-step"),
+]
+
+FMI3_MODEL_OPTIONS_MX: List[ModelOptions] = [
+    ModelOptions("needsCompletedIntegratorStep", False, "needs-completed-step"),
+]
+
+
 class Fmi3StepResult(NamedTuple):
     status: Fmi3Status = Fmi3Status.ok
     eventHandlingNeeded: bool = False
@@ -103,23 +111,26 @@ class Fmi3SlaveBase(object):
         root = Element("fmiModelDescription", attrib)
 
         options = dict()
-        for option in FMI3_MODEL_OPTIONS:
+        for option in FMI3_MODEL_OPTIONS_COMMON:
             value = model_options.get(option.name, option.value)
             options[option.name] = str(value).lower()
+        
         options["modelIdentifier"] = self.modelName
-        options["canNotUseMemoryManagementFunctions"] = "true"
+
+        options_cs = options.copy()
+        for option in FMI3_MODEL_OPTIONS_COSIM:
+            options_cs[option.name] = str(value).lower()
         
-        options_me = dict()
-        options_me["canGetAndSetFMUState"] = "true"
-        options_me["modelIdentifier"] = self.modelName
-        options_me["needsCompletedIntegratorStep"] = "false"
+        options_me = options.copy()
+        for option in FMI3_MODEL_OPTIONS_MX:
+            options_me[option.name] = str(value).lower()
 
         # check if we have cosim mixin or model exchange mixin
         if isinstance(self, ModelExchange):
             SubElement(root, "ModelExchange", attrib=options_me)
         
         if isinstance(self, CoSimulation):
-            SubElement(root, "CoSimulation", attrib=options)
+            SubElement(root, "CoSimulation", attrib=options_cs)
 
         if self.units:
             unit_defs = SubElement(root, "UnitDefinitions")

pythonfmu3/tests/test_docs.py

@@ -0,0 +1,98 @@
+import pytest
+import pathlib
+import re
+import tempfile
+
+def extract_python_code_from_md(md_file):
+    """Extract Python code blocks from markdown, excluding skip blocks"""
+    content = pathlib.Path(md_file).read_text()
+    
+    # Find all python code blocks that aren't marked as skip
+    python_blocks = []
+    
+    # Pattern to match python blocks but not python skip
+    pattern = r'```python(?!\s+skip)(?:[^\n]*)\n(.*?)\n```'
+    matches = re.findall(pattern, content, re.DOTALL)
+    
+    for match in matches:
+        # Skip blocks that are wrapped in skip-test comments
+        if '<!-- skip-test -->' not in content.split(match)[0][-100:]:
+            python_blocks.append(match)
+    
+    return python_blocks
+
+@pytest.mark.doc
+def test_readme():
+    test_dir = pathlib.Path(__file__).parent
+    fpath = test_dir.parent.parent / "README.md"
+    
+    # extract Python code
+    code_blocks = extract_python_code_from_md(fpath)
+
+    namespace = {}
+    exec("from pythonfmu3 import *", namespace)
+
+    for i, code in enumerate(code_blocks):
+        try:
+            exec(code, namespace)
+            print(f"✅ Code block {i+1} executed successfully")
+        except Exception as e:
+            pytest.fail(f"Code block {i+1} failed: {e}\nCode:\n{code}")
+    
+
+
+
+@pytest.mark.doc
+def test_cosimulation_examples():
+    """Test that all Python examples in usage.md actually work"""
+    test_dir = pathlib.Path(__file__).parent
+    usage_file = test_dir.parent.parent / "docs" / "usage.md"
+    
+    # Extract Python code
+    code_blocks = extract_python_code_from_md(usage_file)
+    
+    # Create a test namespace
+    namespace = {}
+    exec("from pythonfmu3 import *", namespace)
+    
+    # Execute each code block
+    for i, code in enumerate(code_blocks):
+        try:
+            exec(code, namespace)
+            print(f"✅ Code block {i+1} executed successfully")
+        except Exception as e:
+            pytest.fail(f"Code block {i+1} failed: {e}\nCode:\n{code}")
+            
+    assert 'LinearTransform' in namespace, "LinearTransform class not found"
+    assert 'PIDController' in namespace, "PIDController class not found"
+
+    # Test instantiation
+    lt = namespace['LinearTransform'](instance_name="test")
+    pc = namespace['PIDController'](instance_name="test")
+
+
+@pytest.mark.doc
+def test_model_exchange_examples():
+    """Test Model Exchange examples"""
+    test_dir = pathlib.Path(__file__).parent
+    mx_file = test_dir.parent.parent / "docs" / "usageMX.md"
+    
+    code_blocks = extract_python_code_from_md(mx_file)
+    
+    namespace = {}
+    exec("from pythonfmu3 import *", namespace)
+    
+    for i, code in enumerate(code_blocks):
+        try:
+            exec(code, namespace)
+        except Exception as e:
+            pytest.fail(f"MX Code block {i+1} failed: {e}")
+    
+    # Test that classes were actually created
+    assert 'VanDerPol' in namespace, "VanDerPol class not found"
+    assert 'BouncingBall' in namespace, "BouncingBall class not found"
+    
+    # Test instantiation
+    vdp = namespace['VanDerPol'](instance_name="test")
+    
+    bb = namespace['BouncingBall'](instance_name="test")

{pythonfmu3-0.3.2.dist-info → pythonfmu3-0.3.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonfmu3
-Version: 0.3.2
+Version: 0.3.3
 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
@@ -173,6 +173,7 @@ To create a model exchange FMU you must inherit from `Fmi3SlaveBase` and one of
 ```python
 
 from pythonfmu3 import Fmi3Causality, Fmi3SlaveBase, Float64, ModelExchange
+from typing import List
 
 
 class PythonSlaveMX(Fmi3SlaveBase, ModelExchange):

{pythonfmu3-0.3.2.dist-info → pythonfmu3-0.3.3.dist-info}/RECORD

@@ -1,12 +1,12 @@
 pythonfmu3/__init__.py,sha256=VJ4QqOZTU8sBI8xhiRVD540Hsp381ma24xGWHABZ724,551
 pythonfmu3/__main__.py,sha256=gC1T8x2d02hhqshyNQGSS70SyCk-3I3t8zPqoRo2Xd8,1543
-pythonfmu3/_version.py,sha256=vNiWJ14r_cw5t_7UDqDQIVZvladKFGyHH2avsLpN7Vg,22
-pythonfmu3/builder.py,sha256=w7c9ZFv1Udz99cb7rj2NpD0CgrcHRu1SR_axm0ew__Y,10103
+pythonfmu3/_version.py,sha256=8KcCYTXH99C2-gCLuPILJvtT9YftRWJsartIx6TQ2ZY,22
+pythonfmu3/builder.py,sha256=DLpy6Hd9ZmbeQLVMw_FcxnS5LB_-yRXzkPjlupyiYsg,11060
 pythonfmu3/cosimulation.py,sha256=EZ5pa_5hy1AwoaZRzZqNz_IX8kjxoFM9sPgeqrUiRuw,179
 pythonfmu3/default_experiment.py,sha256=FJ0l0FpU7pT4Pox2RiA2y-Cb_e7DE2XlbWKySRYQaVk,293
 pythonfmu3/deploy.py,sha256=eqFWVxZUkJCLvmq1-GuMNjn2j0VCGoaXPhRWrCk2Vxg,3741
 pythonfmu3/enums.py,sha256=ZmC6vGeBTGt7HarPQ4uYV10ezPsvIxAHH1ypjNq7G3E,729
-pythonfmu3/fmi3slave.py,sha256=dq0rru4QsLm75irlpM8nquKVbn22FgFG33PVnNUumGc,19458
+pythonfmu3/fmi3slave.py,sha256=LmVDNKJjuUuzepBMijudqsjMFZoZAhAAPxlcgKGz_So,19688
 pythonfmu3/logmsg.py,sha256=0wn11GLwq0LLWqyC2ktLRjQFWlpj07wWliZ8rUHx1gg,359
 pythonfmu3/modelexchange.py,sha256=pdC3gvr-vCXA8qvJ_urWplJZWEi1YKjMcNczme7GOOo,1884
 pythonfmu3/osutil.py,sha256=1qN6qudN4zCupZwc15pzp52WObkqi6jGy9a-MehNt9Q,656
@@ -30,11 +30,12 @@ pythonfmu3/pythonfmu-export/src/pythonfmu/PySlaveInstance.cpp,sha256=Dmnvn7CprYx
 pythonfmu3/pythonfmu-export/src/pythonfmu/PySlaveInstance.hpp,sha256=kdLzY-vrRyRnJfqZ0ZQiz7g7i3gP1MLzmvUD7u0ylPM,5392
 pythonfmu3/pythonfmu-export/src/pythonfmu/PyState.hpp,sha256=CjFEIrZu8b1jxQAIgfI_o36hyItW_SdQ5VSkImf7JNs,2977
 pythonfmu3/resources/binaries/x86_64-linux/libpythonfmu-export.so,sha256=MYOFAGHaNBGS-o7DFQPmdYrfSgG1QXkhznwlh7fsRfY,367904
-pythonfmu3/resources/binaries/x86_64-windows/pythonfmu-export.dll,sha256=j3ye1lnsJbgczHEDAqR15Li_rhUuesX7gc6Jei2rSXc,427008
+pythonfmu3/resources/binaries/x86_64-windows/pythonfmu-export.dll,sha256=MTUolw2jI9rDWEQmqt0XyI_xmu2F880RHfcxpb85Fok,427008
 pythonfmu3/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pythonfmu3/tests/conftest.py,sha256=B6XxTnBdeF_tEJ3w2DlfPKUfvlk-oULgIhQtXkgOJIc,171
 pythonfmu3/tests/test_builder.py,sha256=GrD4ziin3RLOe_36rBQCMnKrSkhc3IqnxE1a6kCFPok,6842
 pythonfmu3/tests/test_deploy.py,sha256=JCDo-O93-izxrP9Q4K0njBcfZ-gAXYx9aZ4plgctz7k,1783
+pythonfmu3/tests/test_docs.py,sha256=VZZFUj2j35mBKvWATIUzJnWNDfiETsLdHZnRZGutOVM,3134
 pythonfmu3/tests/test_fmi3slave.py,sha256=VSd3o3ejOcTG6TlnqxVK7YQc4QCKFTCQnpIgleaxJl4,4801
 pythonfmu3/tests/test_integration.py,sha256=34rus-OU9S5FlAVAfpZyoHrXoziG14d4_yw4Wdt5uVU,12513
 pythonfmu3/tests/test_logger.py,sha256=OcHQhxUtNBPH-0zdmheC4I9OWz1yu48W8MYDshNVkf8,5765
@@ -50,9 +51,9 @@ pythonfmu3/tests/slaves/pythonslaveMX.py,sha256=rmtiKWj-7DNCEGKAzCoS-6ybkWKabYMh
 pythonfmu3/tests/slaves/pythonslaveMXCS.py,sha256=P1aKY92obd-y9VGwDRin9fwmnAlSmdHguFW8E5-LU4I,1417
 pythonfmu3/tests/slaves/pythonslave_read_file.py,sha256=t2sDaZSr2veD91gdqCO9W9CN-AN3TyXABXXfV9Rt0Xs,791
 pythonfmu3/tests/slaves/slavewithdep.py,sha256=hHDFB0dw8wkHiGzxeAVbz9O5LR6ghsFeONgRFdiK_t0,812
-pythonfmu3-0.3.2.dist-info/licenses/LICENSE,sha256=RL2018BU2DKcTi8Eb4ODF-XF3wnr7SDKvMP5S49x4rQ,1188
-pythonfmu3-0.3.2.dist-info/METADATA,sha256=uDfgPNTvIe_vJrgWUk5LGwqdzQDLemg01w4ckpv7B4c,9351
-pythonfmu3-0.3.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pythonfmu3-0.3.2.dist-info/entry_points.txt,sha256=GgkWYs0DKGHLcijMEYZGkhkHOK2RVUpjGwvl1fwyDwQ,60
-pythonfmu3-0.3.2.dist-info/top_level.txt,sha256=6ne7bh_cME1hepxCx1BG8N5QVhVAufrp7LLok6vq7nE,11
-pythonfmu3-0.3.2.dist-info/RECORD,,
+pythonfmu3-0.3.3.dist-info/licenses/LICENSE,sha256=RL2018BU2DKcTi8Eb4ODF-XF3wnr7SDKvMP5S49x4rQ,1188
+pythonfmu3-0.3.3.dist-info/METADATA,sha256=IXN1NfJJ8MAqrE9a7wOmHD95jpATxsMaCLMi3TTayyM,9375
+pythonfmu3-0.3.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pythonfmu3-0.3.3.dist-info/entry_points.txt,sha256=GgkWYs0DKGHLcijMEYZGkhkHOK2RVUpjGwvl1fwyDwQ,60
+pythonfmu3-0.3.3.dist-info/top_level.txt,sha256=6ne7bh_cME1hepxCx1BG8N5QVhVAufrp7LLok6vq7nE,11
+pythonfmu3-0.3.3.dist-info/RECORD,,