pythonfmu3 0.1.10__tar.gz → 0.1.16__tar.gz

{pythonfmu3-0.1.10/pythonfmu3.egg-info → pythonfmu3-0.1.16}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pythonfmu3
-Version: 0.1.10
+Version: 0.1.16
 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
@@ -19,8 +19,10 @@ Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Scientific/Engineering
 Description-Content-Type: text/markdown
-Provides-Extra: tests
 License-File: LICENSE
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: fmpy; extra == "tests"
 
 # PythonFMU3
 
@@ -38,13 +40,7 @@ This project is a fork of the original PythonFMU repository available at https:/
 
 ### Support:
 
-We currently support a basic FMU which follows the FMI3 standard. This includes support for:
-
-- Float64, Int32, UInt64, String, Boolean variables
-- Step Mode
-- Arrays, which requires the numpy package
-
-Please take a look at the examples bouncingBall.py and linearTransform.py for a demonstration of these features.
+Please take a look at the examples to see the supported features.
 
 ### Future
 
@@ -53,7 +49,6 @@ In no particular order, we plan to add support for:
 - Support more variable types from FMI3
 - Improve array support
 - Add event mode
-- Include FMI3 related testing
 
 ### How do I build an FMU from python code?
 
@@ -136,16 +131,18 @@ from pythonfmu3 import Fmi3Causality, Fmi3Slave, Boolean, Int32, Float64, String
 
 class PythonSlave(Fmi3Slave):
 
-    author = "John Doe"
-    description = "A simple description"
-
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
+        self.author = "John Doe"
+        self.description = "A simple description"
+
+        self.time = 0.0
         self.intOut = 1
         self.realOut = 3.0
         self.booleanVariable = True
         self.stringVariable = "Hello World!"
+        self.register_variable(Float64("time", causality=Fmi3Causality.independent))
         self.register_variable(Int32("intOut", causality=Fmi3Causality.output))
         self.register_variable(Float64("realOut", causality=Fmi3Causality.output))
         self.register_variable(Boolean("booleanVariable", causality=Fmi3Causality.local))

{pythonfmu3-0.1.10 → pythonfmu3-0.1.16}/README.md

@@ -14,13 +14,7 @@ This project is a fork of the original PythonFMU repository available at https:/
 
 ### Support:
 
-We currently support a basic FMU which follows the FMI3 standard. This includes support for:
-
-- Float64, Int32, UInt64, String, Boolean variables
-- Step Mode
-- Arrays, which requires the numpy package
-
-Please take a look at the examples bouncingBall.py and linearTransform.py for a demonstration of these features.
+Please take a look at the examples to see the supported features.
 
 ### Future
 
@@ -29,7 +23,6 @@ In no particular order, we plan to add support for:
 - Support more variable types from FMI3
 - Improve array support
 - Add event mode
-- Include FMI3 related testing
 
 ### How do I build an FMU from python code?
 
@@ -112,16 +105,18 @@ from pythonfmu3 import Fmi3Causality, Fmi3Slave, Boolean, Int32, Float64, String
 
 class PythonSlave(Fmi3Slave):
 
-    author = "John Doe"
-    description = "A simple description"
-
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
+        self.author = "John Doe"
+        self.description = "A simple description"
+
+        self.time = 0.0
         self.intOut = 1
         self.realOut = 3.0
         self.booleanVariable = True
         self.stringVariable = "Hello World!"
+        self.register_variable(Float64("time", causality=Fmi3Causality.independent))
         self.register_variable(Int32("intOut", causality=Fmi3Causality.output))
         self.register_variable(Float64("realOut", causality=Fmi3Causality.output))
         self.register_variable(Boolean("booleanVariable", causality=Fmi3Causality.local))

{pythonfmu3-0.1.10 → pythonfmu3-0.1.16}/pythonfmu3/__init__.py

@@ -4,4 +4,5 @@ from .enums import Fmi3Causality, Fmi3Initial, Fmi3Variability
 from .fmi3slave import Fmi3Slave
 from .variables import Boolean, Enumeration, Int32, Int64, UInt64, Float64, String, Dimension
 from .default_experiment import DefaultExperiment
-from .type_definitions import TypeDefinitions, Item, EnumerationType
+from .variable_types import Float64Type, EnumerationType
+from .unit import BaseUnit, Unit

pythonfmu3-0.1.16/pythonfmu3/_version.py

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

{pythonfmu3-0.1.10 → pythonfmu3-0.1.16}/pythonfmu3/fmi3slave.py

@@ -11,10 +11,11 @@ from xml.etree.ElementTree import Element, SubElement
 
 from .logmsg import LogMsg
 from .default_experiment import DefaultExperiment
-from .type_definitions import TypeDefinitions
 from ._version import __version__ as VERSION
 from .enums import Fmi3Type, Fmi3Status, Fmi3Causality, Fmi3Initial, Fmi3Variability
 from .variables import Boolean, Enumeration, Int32, Int64, UInt64, Float64, ModelVariable, String
+from .variable_types import VariableType
+from .unit import Unit
 
 ModelOptions = namedtuple("ModelOptions", ["name", "value", "cli"])
 
@@ -54,7 +55,9 @@ class Fmi3Slave(ABC):
         self.modelName: Optional[str] = self.__class__.__name__
         self.description: Optional[str] = None
         self.default_experiment: Optional[DefaultExperiment] = None
-        self.type_definitions: Optional[TypeDefinitions] = None
+
+        self.type_definitions: Dict[str, VariableType] = {}
+        self.units: Dict[str, Unit] = {}
 
     def to_xml(self, model_options: Dict[str, str] = dict()) -> Element:
         """Build the XML representation of the model.
@@ -99,8 +102,15 @@ class Fmi3Slave(ABC):
 
         SubElement(root, "CoSimulation", attrib=options)
 
-        if self.type_definitions is not None:
-            root.append(self.type_definitions.to_xml())
+        if self.units:
+            unit_defs = SubElement(root, "UnitDefinitions")
+            for _, unit in self.units.items():
+                unit_defs.append(unit.to_xml())
+
+        if self.type_definitions:
+            type_defs = SubElement(root, "TypeDefinitions")
+            for _, val in self.type_definitions.items():
+                type_defs.append(val.to_xml())
 
         if len(self.log_categories) > 0:
             categories = SubElement(root, "LogCategories")
@@ -178,7 +188,7 @@ class Fmi3Slave(ABC):
             raise Exception(f"Unsupported type {type(var)}!")
         var.start = refs if len(getattr(var, "dimensions", [])) > 0 else refs[0]
 
-    def register_variable(self, var: ModelVariable, nested: bool = True):
+    def register_variable(self, var: ModelVariable, nested: bool = True, var_type: Any = None):
         """Register a variable as FMU interface.
         
         Args:
@@ -206,10 +216,18 @@ class Fmi3Slave(ABC):
                 var.setter = lambda v: setattr(owner, var.local_name, np.reshape(v, newshape=getattr(owner, var.local_name).shape))
             else:
                 var.setter = lambda v: setattr(owner, var.local_name, v)
+        
+        if var_type:
+            self.type_definitions[var_type.name] = var_type
+            var.declared_type = var_type.name
 
     def setup_experiment(self, start_time: float):
         pass
 
+    def register_units(self, units: List[Unit]):
+        for unit in units:
+            self.units[unit.name] = unit
+
     def enter_initialization_mode(self):
         pass
 

{pythonfmu3-0.1.10 → pythonfmu3-0.1.16}/pythonfmu3/osutil.py

@@ -1,5 +1,4 @@
 import sys
-import platform
 
 import platform
 
@@ -8,7 +7,8 @@ def get_fmu_arch():
     system = platform.system()
     is_x86 = platform.machine() in ["i386", "AMD64", "x86_64"]
     platforms = {"Windows": "windows", "Linux": "linux", "Darwin": "darwin"}
-    return "x86_64" if is_x86 else "x86" + "-" + platforms.get(system, "unknown")
+    arch = "x86_64" if is_x86 else "x86"
+    return arch + "-" + platforms.get(system, "unknown")
 
 def get_platform() -> str:
     """Get FMU binary platform folder name."""

{pythonfmu3-0.1.10 → pythonfmu3-0.1.16}/pythonfmu3/pythonfmu-export/src/cppfmu/cppfmu_common.hpp

@@ -105,11 +105,9 @@ public:
 
     Logger(
         FMIComponentEnvironment component,
-        String instanceName,
         fmi3LogMessageCallback logCallback,
         std::shared_ptr<Settings> settings)
         : m_component{component}
-        , m_instanceName(std::move(instanceName))
         , m_fmiLogger{logCallback}
         , m_settings{settings}
     {
@@ -154,7 +152,6 @@ public:
 
 private:
     const FMIComponentEnvironment m_component;
-    const String m_instanceName;
     const FMICallbackLogger m_fmiLogger;
     std::shared_ptr<Settings> m_settings;
 };

{pythonfmu3-0.1.10 → pythonfmu3-0.1.16}/pythonfmu3/pythonfmu-export/src/cppfmu/fmi_functions.cpp

@@ -47,10 +47,10 @@ struct Component
         modelError = 1 << 12,
         modelFatal = 1 << 13,
     };
-    Component(cppfmu::FMIString instanceName,
+    Component(cppfmu::FMIComponentEnvironment instanceEnvironment,
         cppfmu::FMICallbackLogger logCallback,
         cppfmu::FMIBoolean loggingOn) : loggerSettings{std::make_shared<cppfmu::Logger::Settings>()},
-        logger{this, instanceName, logCallback, loggerSettings}, lastSuccessfulTime{std::numeric_limits<cppfmu::FMIFloat64>::quiet_NaN()}
+        logger{instanceEnvironment, logCallback, loggerSettings}, lastSuccessfulTime{std::numeric_limits<cppfmu::FMIFloat64>::quiet_NaN()}
     {
         loggerSettings->debugLoggingEnabled = (loggingOn == cppfmu::FMITrue);
     }
@@ -96,7 +96,8 @@ fmi3Instance fmi3InstantiateCoSimulation(
     fmi3IntermediateUpdateCallback intermediateUpdate )
 {
     try {
-        auto component = new Component(instanceName,
+        auto component = new Component(
+            environment,
             logMessage,
             loggingOn);
         component->slave = CppfmuInstantiateSlave(

pythonfmu3-0.1.16/pythonfmu3/pythonfmu-export/src/pythonfmu/IPyState.hpp

@@ -0,0 +1,18 @@
+#ifndef PYTHONFMU_IPYTHONSTATE_HPP
+#define PYTHONFMU_IPYTHONSTATE_HPP
+
+namespace pythonfmu
+{
+    class IPyState
+    {
+    public:
+        IPyState() = default;
+        IPyState(IPyState const& other) = delete;
+        IPyState(IPyState&& other) = delete;
+        IPyState& operator=(IPyState const& other) = delete;
+        IPyState& operator=(IPyState&& other) = delete;
+        virtual ~IPyState() = default;
+    };
+}
+
+#endif //PYTHONFMU_IPYTHONSTATE_HPP

{pythonfmu3-0.1.10 → pythonfmu3-0.1.16}/pythonfmu3/pythonfmu-export/src/pythonfmu/PySlaveInstance.cpp

@@ -1,4 +1,5 @@
 
+#include "pythonfmu/IPyState.hpp"
 #include "pythonfmu/PySlaveInstance.hpp"
 
 #include "pythonfmu/PyState.hpp"
@@ -7,6 +8,7 @@
 
 #include <fstream>
 #include <functional>
+#include <mutex>
 #include <regex>
 #include <sstream>
 #include <utility>
@@ -44,8 +46,9 @@ inline void py_safe_run(const std::function<void(PyGILState_STATE gilState)>& f)
     PyGILState_Release(gil_state);
 }
 
-PySlaveInstance::PySlaveInstance(std::string instanceName, std::string resources, const cppfmu::Logger& logger, const bool visible)
-    : instanceName_(std::move(instanceName))
+PySlaveInstance::PySlaveInstance(std::string instanceName, std::string resources, const cppfmu::Logger& logger, const bool visible, std::shared_ptr<IPyState> pyState)
+    : pyState_{ std::move(pyState) }
+    , instanceName_(std::move(instanceName))
     , resources_(std::move(resources))
     , logger_(logger)
     , visible_(visible)
@@ -441,9 +444,14 @@ void PySlaveInstance::GetUInt64(const cppfmu::FMIValueReference* vr, std::size_t
         }
 
         for (int i = 0; i < nvr; i++) {
-            PyObject* value = PyList_GetItem(refs, i);
-            values[i] = static_cast<cppfmu::FMIUInt64>(PyLong_AsUnsignedLongLong(value));
+            PyObject* item = PyList_GetItem(refs, i);
+            PyObject* value = PyObject_GetAttrString(item, "value");
+            if (value && PyLong_Check(value))
+            {
+                values[i] = static_cast<cppfmu::FMIUInt64>(PyLong_AsUnsignedLongLong(value));
+            }
         }
+
         Py_DECREF(refs);
         clearLogBuffer();
     });
@@ -625,7 +633,10 @@ PySlaveInstance::~PySlaveInstance()
 
 } // namespace pythonfmu
 
-std::unique_ptr<pythonfmu::PyState> pyState = nullptr;
+namespace {
+    std::mutex pyStateMutex{};
+    std::shared_ptr<pythonfmu::PyState> pyState{};
+}
 
 std::unique_ptr<cppfmu::SlaveInstance> CppfmuInstantiateSlave(
     cppfmu::FMIString instanceName,
@@ -650,9 +661,57 @@ std::unique_ptr<cppfmu::SlaveInstance> CppfmuInstantiateSlave(
 #endif
     }
 
-    if (pyState == nullptr) {
-        pyState = std::make_unique<pythonfmu::PyState>();
+    {
+        auto const ensurePyStateAlive = [&]() {
+            auto const lock = std::lock_guard{pyStateMutex};
+            if (nullptr == pyState) pyState = std::make_shared<pythonfmu::PyState>();
+            };
+
+        ensurePyStateAlive();
+        return std::make_unique<pythonfmu::PySlaveInstance>(
+            instanceName, resources, logger, visible, pyState);
     }
+}
+
+extern "C" {
 
-    return std::make_unique<pythonfmu::PySlaveInstance>(instanceName, resources, logger, visible);
+    // The PyState instance owns it's own thread for constructing and destroying the Py* from the same thread.
+    // Creation of an std::thread increments ref counter of a shared library. So, when the client unloads the library
+    // the library won't be freed, as std::thread is alive, and the std::thread itself waits for de-initialization request.
+    // Thus, use DllMain on Windows and __attribute__((destructor)) on Linux for signaling to the PyState about de-initialization.
+    void finalizePythonInterpreter()
+    {
+        pyState = nullptr;
+    }
+}
+
+namespace
+{
+#ifdef _WIN32
+#include <windows.h>
+
+    BOOL APIENTRY DllMain(HMODULE hModule,
+        DWORD ul_reason_for_call,
+        LPVOID lpReserved)
+    {
+        switch (ul_reason_for_call) {
+            case DLL_PROCESS_ATTACH:
+                break;
+            case DLL_THREAD_ATTACH:
+            case DLL_THREAD_DETACH:
+                break;
+            case DLL_PROCESS_DETACH:
+                finalizePythonInterpreter();
+                break;
+        }
+        return TRUE;
+}
+#elif defined(__linux__)
+    __attribute__((destructor)) void onLibraryUnload()
+    {
+        finalizePythonInterpreter();
+}
+#else
+#error port the code
+#endif
 }

{pythonfmu3-0.1.10 → pythonfmu3-0.1.16}/pythonfmu3/pythonfmu-export/src/pythonfmu/PySlaveInstance.hpp

@@ -3,6 +3,7 @@
 #define PYTHONFMU_SLAVEINSTANCE_HPP
 
 #include "cppfmu/cppfmu_cs.hpp"
+#include "pythonfmu/IPyState.hpp"
 
 #include <Python.h>
 #include <string>
@@ -15,7 +16,7 @@ class PySlaveInstance : public cppfmu::SlaveInstance
 {
 
 public:
-    PySlaveInstance(std::string instanceName, std::string resources, const cppfmu::Logger& logger, bool visible);
+    PySlaveInstance(std::string instanceName, std::string resources, const cppfmu::Logger& logger, bool visible, std::shared_ptr<IPyState> pyState);
 
     void initialize(PyGILState_STATE gilState);
 
@@ -53,6 +54,7 @@ public:
     ~PySlaveInstance() override;
 
 private:
+    std::shared_ptr<IPyState> pyState_;
     PyObject* pClass_;
     PyObject* pInstance_{};
     PyObject* pMessages_{};

pythonfmu3-0.1.16/pythonfmu3/pythonfmu-export/src/pythonfmu/PyState.hpp

@@ -0,0 +1,85 @@
+
+#ifndef PYTHONFMU_PYTHONSTATE_HPP
+#define PYTHONFMU_PYTHONSTATE_HPP
+
+#include "IPyState.hpp"
+#include <Python.h>
+#include <condition_variable>
+#include <iostream>
+#include <mutex>
+#include <thread>
+
+namespace pythonfmu
+{
+    class PyState : public IPyState
+    {
+    public:
+        PyState()
+            : _initDeinitPyThread_{ &PyState::Worker, this }
+        {
+            auto lock = std::unique_lock{ mutex_ };
+            conditionalVariable_.wait(lock, [&] { return consructed_; });
+        }
+
+        ~PyState() override
+        {
+            {
+                auto const lock = std::lock_guard{ mutex_ };
+                destroyRequested_ = true;
+            }
+            conditionalVariable_.notify_one();
+            if (_initDeinitPyThread_.joinable()) _initDeinitPyThread_.join();
+        }
+
+    private:
+
+        // In accordance to the documentation https://docs.python.org/3/c-api/init.html#c.Py_FinalizeEx 
+        // the Py_Initialize/Py_Finalize should be called from the same
+        // thread. The FMI standard allows to call fmi functions from different threads, also different threads
+        // could be used for loading unloading the FMU libraries. There is a deadlock, when the simulation tool 
+        // unloads the FMU library from the thread which is differs from the thread where the Py_Initialize was called.
+        // Create a new thread which is used for calling Py_Initialize and Py_Deinitialize. The thread waits for
+        // notification from destructor and then calls Py_Deinitialize.
+
+        void Worker()
+        {
+            // It will be nullptr in case when some other tool already called Py_IsInitialized.
+            // There is no need to call Py_Finalize thus, this thread can exit ASAP.
+            auto const mainPyThread = []() -> PyThreadState* {
+                auto const justInitialized = !Py_IsInitialized();
+                if (justInitialized) {
+                    Py_SetProgramName(L"./PythonFMU");
+                    Py_Initialize();
+#if PY_VERSION_HEX < 0x03070000
+                    PyEval_InitThreads();
+#endif
+                    return PyEval_SaveThread();
+                }
+                return nullptr;
+                }();
+
+                {
+                    auto const lock = std::lock_guard{ mutex_ };
+                    consructed_ = true;
+                }
+                conditionalVariable_.notify_one();
+
+                if (nullptr != mainPyThread) {
+                    auto lock = std::unique_lock{ mutex_ };
+                    conditionalVariable_.wait(lock, [&] { return destroyRequested_; });
+
+                    PyEval_RestoreThread(mainPyThread);
+                    Py_Finalize();
+                }
+        }
+
+        bool consructed_ = false;
+        bool destroyRequested_ = false;
+        std::condition_variable conditionalVariable_;
+        std::mutex mutex_;
+        std::thread _initDeinitPyThread_;
+    };
+
+} // namespace pythonfmu
+
+#endif //PYTHONFMU_PYTHONSTATE_HPP

{pythonfmu3-0.1.10 → pythonfmu3-0.1.16}/pythonfmu3/tests/slaves/PythonSlaveWithException.py

@@ -1,4 +1,4 @@
-from pythonfmu3.fmi3slave import Fmi3Slave, Fmi3Causality, Float64
+from pythonfmu3.fmi3slave import Fmi3Slave, Fmi3Causality, Float64, Fmi3Variability
 
 
 class PythonSlaveWithException(Fmi3Slave):
@@ -8,6 +8,9 @@ class PythonSlaveWithException(Fmi3Slave):
 
         self.realIn = 22.0
         self.realOut = 0.0
+        self.time = 0
+
+        self.register_variable(Float64("time", causality=Fmi3Causality.independent, variability=Fmi3Variability.continuous))
         self.register_variable(Float64("realIn", causality=Fmi3Causality.input))
         self.register_variable(Float64("realOut", causality=Fmi3Causality.output))
 

{pythonfmu3-0.1.10 → pythonfmu3-0.1.16}/pythonfmu3/tests/slaves/pythonslave.py

@@ -21,6 +21,9 @@ class PythonSlave(Fmi3Slave):
         self.realIn = 2. / 3.
         self.booleanParameter = False
         self.stringParameter = "dog"
+        self.time = 0
+
+        self.register_variable(Float64("time", causality=Fmi3Causality.independent, variability=Fmi3Variability.continuous))
         self.register_variable(
             Int32("intParam", causality=Fmi3Causality.parameter, variability=Fmi3Variability.tunable))
         self.register_variable(Float64("realIn", causality=Fmi3Causality.input))

{pythonfmu3-0.1.10 → pythonfmu3-0.1.16}/pythonfmu3/tests/slaves/pythonslave_read_file.py

@@ -1,4 +1,4 @@
-from pythonfmu3.fmi3slave import Fmi3Slave, Fmi3Causality, Fmi3Variability, String, DefaultExperiment
+from pythonfmu3.fmi3slave import Fmi3Slave, Fmi3Causality, Fmi3Variability, String, DefaultExperiment, Float64
 
 
 class PythonSlaveReadFile(Fmi3Slave):
@@ -11,6 +11,9 @@ class PythonSlaveReadFile(Fmi3Slave):
         with (open(f'{self.resources}/hello.txt', 'r')) as file:
             data = file.read()
 
+        self.time = 0
+
+        self.register_variable(Float64("time", causality=Fmi3Causality.independent, variability=Fmi3Variability.continuous))
         self.register_variable(
             String("file_content", getter=lambda: data,
                    causality=Fmi3Causality.output,

{pythonfmu3-0.1.10 → pythonfmu3-0.1.16}/pythonfmu3/tests/slaves/slavewithdep.py

@@ -1,5 +1,5 @@
 import math
-from pythonfmu3.fmi3slave import Fmi3Slave, Fmi3Causality, Float64
+from pythonfmu3.fmi3slave import Fmi3Slave, Fmi3Causality, Float64, Fmi3Variability
 from localmodule import get_amplitude, get_time_constant
 
 
@@ -10,6 +10,9 @@ class PythonSlaveWithDep(Fmi3Slave):
 
         self.realIn = 22.0
         self.realOut = 0.0
+        self.time = 0
+
+        self.register_variable(Float64("time", causality=Fmi3Causality.independent, variability=Fmi3Variability.continuous))
         self.register_variable(Float64("realIn", causality=Fmi3Causality.input))
         self.register_variable(Float64("realOut", causality=Fmi3Causality.output))