OpenSMI-Core 0.1__tar.gz → 0.2__tar.gz

opensmi_core-0.2/.github/workflows/api-docs.yml

@@ -0,0 +1,58 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Publish API doc to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+          
+      - name: Install dependencies
+        run: |
+          pip install pydoctor
+
+      - name: Generate API documentation
+        run: |
+          pydoctor
+          
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+        
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './apidocs'
+          
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

{opensmi_core-0.1 → opensmi_core-0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OpenSMI-Core
-Version: 0.1
+Version: 0.2
 Summary: Smart Machine Interface core functionality for server and client applications.
 Author-email: Carsten Harms <Carsten.Harms@dfki.de>, Simon Jungbluth <Simon.Jungbluth@smartfactory.de>
 Classifier: Development Status :: 4 - Beta

{opensmi_core-0.1 → opensmi_core-0.2}/pyproject.toml

@@ -176,5 +176,5 @@ add-package = ["src/opensmi/core"]
 docformat = "restructuredtext"
 theme = "readthedocs"
 # verbose = 1
-warnings-as-errors = true
+# warnings-as-errors = true
 intersphinx = ["https://opcua-asyncio.readthedocs.io/en/latest/objects.inv"] # TODO(CaHa): does not work

{opensmi_core-0.1 → opensmi_core-0.2}/src/OpenSMI_Core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OpenSMI-Core
-Version: 0.1
+Version: 0.2
 Summary: Smart Machine Interface core functionality for server and client applications.
 Author-email: Carsten Harms <Carsten.Harms@dfki.de>, Simon Jungbluth <Simon.Jungbluth@smartfactory.de>
 Classifier: Development Status :: 4 - Beta

{opensmi_core-0.1 → opensmi_core-0.2}/src/OpenSMI_Core.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@
 LICENSE
 README.md
 pyproject.toml
+.github/workflows/api-docs.yml
 .github/workflows/python-publish.yml
 LICENSES/MIT.txt
 src/OpenSMI_Core.egg-info/PKG-INFO

{opensmi_core-0.1 → opensmi_core-0.2}/src/OpenSMI_Core.egg-info/scm_file_list.json

@@ -1,5 +1,6 @@
 {
   "files": [
+    ".github/workflows/api-docs.yml",
     ".github/workflows/python-publish.yml",
     ".gitignore",
     ".gitlab-ci.yml",

opensmi_core-0.2/src/OpenSMI_Core.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.2",
+  "distance": 0,
+  "node": "g90c7c0325f86ebe6f93c7c832b29f4672c03faa6",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-09-23"
+}

{opensmi_core-0.1 → opensmi_core-0.2}/src/opensmi/core/base_ua_object.py

@@ -21,11 +21,14 @@ _ServerType = TypeVar("_ServerType", bound="BaseServer")
 class BaseUaObject(Generic[_ServerType]):
     """Base class for all UA objects, both client- and server-side."""
 
+    _parent: "BaseUaObject[_ServerType] | None" = None
+
     def __init__(
         self,
         *,
         name: str | None = None,
         server: _ServerType | None = None,
+        parent: "BaseUaObject[_ServerType] | None" = None,
         **kwargs,
     ) -> None:
         """*Cooperative* constructor.
@@ -33,6 +36,8 @@ class BaseUaObject(Generic[_ServerType]):
         :param name: The name of the UA object. Defaults to the class name.
         :param server: The associated server of the UA object. Note that there must be at least one non ``None`` in
             the hierarchy.
+        :param parent: The parent of the UA object. Only Machines are allowed to have no parent. Can be set later before
+            asynchronous initialization.
         """
         if name is None:
             name = self.__class__.__name__
@@ -42,6 +47,8 @@ class BaseUaObject(Generic[_ServerType]):
 
         self._name: str = name
         self._server: _ServerType | None = server
+        if parent is not None:
+            self.parent = parent  # via setter to allow optional runtime type checking
         self._ua_node: Node | None = None
         self._logger: structlog.BoundLogger = structlog.get_logger(
             f"opensmi.{self.__class__.__name__}", name=self.name
@@ -76,16 +83,17 @@ class BaseUaObject(Generic[_ServerType]):
     @property
     @deprecated("Use path instead")
     def full_name(self) -> str:
-        parent = getattr(self, "parent", None)
-        if isinstance(parent, BaseUaObject):
-            return f"{parent.full_name}/{self.name}"
+        if self.parent is not None:
+            assert isinstance(self.parent, BaseUaObject)
+            return f"{self.parent.full_name}/{self.name}"
         return f"/{self.name}"
 
     @property
     def path(self) -> PurePosixPath:
         """Return the full path of the object."""
-        if isinstance(parent := getattr(self, "parent", None), BaseUaObject):
-            return parent.path / self.name
+        if self.parent is not None:
+            assert isinstance(self.parent, BaseUaObject)
+            return self.parent.path / self.name
         return PurePosixPath("/") / self.name
 
     @property
@@ -93,6 +101,17 @@ class BaseUaObject(Generic[_ServerType]):
         """Logger associated with the `UaObject` instance."""
         return self._logger  # type: ignore
 
+    @property
+    def parent(self) -> "BaseUaObject[_ServerType] | None":
+        """Return the untyped parent of the UA object."""
+        return self._parent
+
+    @parent.setter
+    def parent(self, parent: "BaseUaObject[_ServerType]") -> None:
+        """Set the parent of the UA object. Given ``parent`` must be an instance of `BaseUaObject`."""
+        assert isinstance(parent, BaseUaObject)
+        self._parent = parent
+
     # TODO
     # @override
     # def _repr_items(self) -> Iterator[tuple[str, object]]:

{opensmi_core-0.1 → opensmi_core-0.2}/src/opensmi/core/ua_node_util.py

@@ -21,6 +21,8 @@ from opensmi.core import Unit
 NULL_NODE_ID = ua.NodeId()
 """ This node id indicates an invalid Node ID and should be treated as 'None'. """
 
+_LOGGER = structlog.getLogger(__name__)
+
 
 async def read_value(node: Node) -> Any:
     """Read the value of the given node and transforms the NULL_NODE_ID into None."""
@@ -126,17 +128,22 @@ async def get_properties(node: Node, *, logger: structlog.stdlib.BoundLogger | N
     return result
 
 
-async def get_type_definition(ua_node: Node) -> str:
-    """Return the browse name of the OPC UA type definition of the given node."""
-    try:
-        type_definition_list = await ua_node.get_references(
-            ua.object_ids.ObjectIds.HasTypeDefinition,
-            ua.BrowseDirection.Forward,
-        )
+async def get_type_definition(ua_node: Node, *, default: str = "UNKNOWN") -> str:
+    """Return the browse name of the OPC UA type definition of the given node.
+
+    :param ua_node: OPC UA node to operate on.
+    :param default: Default value to return if type definition cannot be determined.
+    """
+    assert ua_node is not None, "No node node given!"
+    type_definition_list = await ua_node.get_references(
+        ua.object_ids.ObjectIds.HasTypeDefinition,
+        ua.BrowseDirection.Forward,
+    )
+    if len(type_definition_list) > 0:
         return type_definition_list[0].BrowseName.Name
-    except Exception as ex:
-        msg = f"Could not find type definition for node {ua_node.nodeid.to_string()}!"
-        raise RuntimeError(msg) from ex
+
+    _LOGGER.warning("Could not determine type definition!", ua_node = ua_node.nodeid.to_string(), default=default)
+    return default
 
 
 def get_node_id(

{opensmi_core-0.1 → opensmi_core-0.2}/src/opensmi/core/unit_all.py

@@ -1,7 +1,7 @@
 """Units as type-checkable enum."""
 
 # !!! autogenerated code, do not change manually !!!
-# generated on 2026-09-10 08:32:16
+# generated on 2026-09-15 14:19:13
 from opensmi.core.unit_base import BaseUnit
 
 
@@ -73,7 +73,7 @@ class Unit(BaseUnit):
     BARREL_UK_PETROLEUM_PER_MINUTE = ("bbl (UK liq.)/min", 4863288)
     BARREL_UK_PETROLEUM_PER_SECOND = ("bbl (UK liq.)/s", 4863537)
     BARREL_US = ("barrel (US)", 4344908)
-    BARREL_US_PER_DAY = ("barrel\xa0(US)/d", 16945)
+    BARREL_US_PER_DAY = ("barrel (US)/d", 16945)
     BARREL_US_PER_MINUTE = ("barrel (US)/min", 13633)
     BARREL_US_PETROLEUM_PER_HOUR = ("bbl (US)/h", 4863538)
     BARREL_US_PETROLEUM_PER_SECOND = ("bbl (US)/s", 4863539)
@@ -119,9 +119,9 @@ class Unit(BaseUnit):
     BOTTLE = ("bottle", 16975)
     BOX = ("box", 16984)
     BRAKE_HORSE_POWER = ("BHP", 4343888)
-    BRITISH_THERMAL_UNIT_39_F = ("Btu (39 ºF) ", 5125686)
+    BRITISH_THERMAL_UNIT_39_F = ("Btu (39 ºF)", 5125686)
     BRITISH_THERMAL_UNIT_59_F = ("Btu (59 ºF)", 5125687)
-    BRITISH_THERMAL_UNIT_60_F = ("Btu (60 ºF) ", 5125688)
+    BRITISH_THERMAL_UNIT_60_F = ("Btu (60 ºF)", 5125688)
     BRITISH_THERMAL_UNIT_INTERNATIONAL_TABLE = ("BtuIT", 4346965)
     BRITISH_THERMAL_UNIT_INTERNATIONAL_TABLE_FOOT_PER_HOUR_SQUARE_FOOT_DEGREE_FAHRENHEIT = (
         "BtuIT·ft/(h·ft²·°F)",
@@ -167,10 +167,10 @@ class Unit(BaseUnit):
     BRITISH_THERMAL_UNIT_THERMOCHEMICAL_PER_POUND_DEGREE_FAHRENHEIT = ("Btuth/(lb·°F)", 4863280)
     BRITISH_THERMAL_UNIT_THERMOCHEMICAL_PER_POUND_DEGREE_RANKINE = ("(Btuth/°R)/lb", 5125684)
     BRITISH_THERMAL_UNIT_THERMOCHEMICAL_PER_SECOND = ("Btuth/s", 4863282)
-    BRITISH_THERMAL_UNIT_THERMOCHEMICAL_PER_SECOND_SQUARE_FOOT_DEGREE_FAHRENHEIT = ("Btuth/(s·ft²·ºF) ", 5125943)
+    BRITISH_THERMAL_UNIT_THERMOCHEMICAL_PER_SECOND_SQUARE_FOOT_DEGREE_FAHRENHEIT = ("Btuth/(s·ft²·ºF)", 5125943)
     BRITISH_THERMAL_UNIT_THERMOCHEMICAL_PER_SQUARE_FOOT = ("Btuth/ft²", 5255992)
     BRITISH_THERMAL_UNIT_THERMOCHEMICAL_PER_SQUARE_FOOT_HOUR = ("Btuth/(ft²·h)", 5125425)
-    BRITISH_THERMAL_UNIT_THERMOCHEMICAL_PER_SQUARE_FOOT_MINUTE = ("Btuth/(ft²·min) ", 5125426)
+    BRITISH_THERMAL_UNIT_THERMOCHEMICAL_PER_SQUARE_FOOT_MINUTE = ("Btuth/(ft²·min)", 5125426)
     BRITISH_THERMAL_UNIT_THERMOCHEMICAL_PER_SQUARE_FOOT_SECOND = ("Btuth/(ft²·s)", 5125428)
     BRUSH = ("brush", 16968)
     BTU_PER_CUBIC_FOOT = ("BTU/ft³", 16944)
@@ -261,7 +261,7 @@ class Unit(BaseUnit):
     CENTIPOISE_PER_BAR = ("cP/bar", 4863796)
     CENTIPOISE_PER_KELVIN = ("cP/K", 4863795)
     CENTISTOKES = ("cSt", 13379)
-    CHAIN_BASED_ON_U_S_SURVEY_FOOT = ("ch (US survey) ", 5059641)
+    CHAIN_BASED_ON_U_S_SURVEY_FOOT = ("ch (US survey)", 5059641)
     CHEST = ("chest", 23090)
     CHEVAL_VAPEUR = ("CV", 4272693)
     CIRCULAR_MIL = ("cmil", 5059639)
@@ -562,7 +562,7 @@ class Unit(BaseUnit):
     FOOT_POUND_FORCE_PER_MINUTE = ("ft·lbf/min", 4927798)
     FOOT_POUND_FORCE_PER_SECOND = ("ft·lbf/s", 4273972)
     FOOT_TO_THE_FOURTH_POWER = ("ft⁴", 5124663)
-    FOOT_U_S_SURVEY = ("ft (US survey) ", 5059889)
+    FOOT_U_S_SURVEY = ("ft (US survey)", 5059889)
     FORMAZIN_NEPHELOMETRIC_UNIT = ("FNU", 4607573)
     FORTY_FOOT_CONTAINER = ("forty foot container", 12849)
     FOUR_PACK = ("four pack", 20532)
@@ -1235,7 +1235,7 @@ class Unit(BaseUnit):
     MICROWATT_PER_SQUARE_METRE = ("µW/m²", 4470837)
     MICRO_INCH = ("µin", 19767)
     MIL = ("mil", 5059635)
-    MILE_BASED_ON_U_S_SURVEY_FOOT = ("mi (US survey) ", 5059890)
+    MILE_BASED_ON_U_S_SURVEY_FOOT = ("mi (US survey)", 5059890)
     MILE_PER_HOUR_STATUTE_MILE = ("mile/h", 18509)
     MILE_PER_MINUTE = ("mi/min", 5059895)
     MILE_PER_SECOND = ("mi/s", 5059896)
@@ -1297,7 +1297,7 @@ class Unit(BaseUnit):
     MILLIHENRY = ("mH", 4403508)
     MILLIHENRY_PER_KILOOHM = ("mH/kΩ", 4730933)
     MILLIHENRY_PER_OHM = ("mH/Ω", 4730934)
-    MILLIHERTZ = ("mHz\xa0", 5067866)
+    MILLIHERTZ = ("mHz", 5067866)
     MILLIJOULE = ("mJ", 4403509)
     MILLILITRE = ("ml", 5065812)
     MILLILITRE_OF_WATER = ("millilitre of water", 22359)
@@ -1487,7 +1487,7 @@ class Unit(BaseUnit):
     OERSTED = ("Oe", 13878)
     OHM = ("Ω", 5195853)
     OHM_CENTIMETRE = ("Ω·cm", 4404784)
-    OHM_CIRCULAR_MIL_PER_FOOT = ("Ω·cmil/ft ", 5255731)
+    OHM_CIRCULAR_MIL_PER_FOOT = ("Ω·cmil/ft", 5255731)
     OHM_KILOMETRE = ("Ω·km", 5059124)
     OHM_METRE = ("Ω·m", 4404785)
     OHM_PER_KILOMETRE = ("Ω/km", 4601142)
@@ -1598,8 +1598,8 @@ class Unit(BaseUnit):
     PERCENT_PER_VOLT = ("%/V", 4733237)
     PERCENT_VOLUME = ("percent volume", 22096)
     PERCENT_WEIGHT = ("percent weight", 13872)
-    PERM_0_C = ("perm (0 ºC) ", 5257521)
-    PERM_23_C = ("perm (23 ºC) ", 5257522)
+    PERM_0_C = ("perm (0 ºC)", 5257521)
+    PERM_23_C = ("perm (23 ºC)", 5257522)
     PERSON = ("person", 18757)
     PER_MILLE_PER_PSI = ("‰/psi", 4862258)
     PETABIT = ("Pbit", 4536120)
@@ -2114,7 +2114,7 @@ class Unit(BaseUnit):
     UNIT_15_C_CALORIE = ("cal₁₅", 16689)
     UNIT_30_DAY_MONTH = ("mo (30 days)", 5059382)
     UNIT_8_PART_CLOUD_COVER = ("8-part cloud cover", 4273465)
-    UNIT_POLE = ("unit pole ", 5256499)
+    UNIT_POLE = ("unit pole", 5256499)
     USAGE_PER_TELECOMMUNICATION_LINE_AVERAGE = ("usage per telecommunication line average", 21830)
     USE = ("use", 4535605)
     US_GALLON_PER_MINUTE = ("gal (US) /min", 18226)

{opensmi_core-0.1 → opensmi_core-0.2}/tools/auto_generate_units.py

@@ -108,7 +108,7 @@ def _parse(path: Path) -> dict[str, _UneceUnit]:
 
             unit = _UneceUnit(
                 name=name,
-                symbol=str(symbol),
+                symbol=str(symbol).replace("\xa0", " ").strip(),  # replace non-breaking space with space,
                 common_code=str(common_code),
                 level=str(level),
             )

opensmi_core-0.1/src/OpenSMI_Core.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "0.1",
-  "distance": 0,
-  "node": "g00bee2346bf90929caf7a2fb0ea251f864e2174c",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-09-15"
-}