stidapi 1.4.4__tar.gz → 1.4.5__tar.gz

{stidapi-1.4.4 → stidapi-1.4.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stidapi
-Version: 1.4.4
+Version: 1.4.5
 Summary: Python client for connecting to Equinor STIDapi
 Author: Åsmund Våge Fannemel
 Author-email: Åsmund Våge Fannemel <asmf@equinor.com>
@@ -11,7 +11,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: eq-api-connector>=1.1.1,<2
+Requires-Dist: eq-api-connector>=1.2.0,<2
 Requires-Python: >=3.10, <4
 Project-URL: repository, https://github.com/equinor/STIDapi-python
 Description-Content-Type: text/markdown

{stidapi-1.4.4 → stidapi-1.4.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "stidapi"
-version = "1.4.4"
+version = "1.4.5"
 description = "Python client for connecting to Equinor STIDapi"
 requires-python = ">=3.10,<4"
 readme = "README.md"
@@ -13,7 +13,7 @@ classifiers = [
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
 ]
-dependencies = ["eq-api-connector>=1.1.1,<2"]
+dependencies = ["eq-api-connector>=1.2.0,<2"]
 
 [[project.authors]]
 name = "Åsmund Våge Fannemel"
@@ -31,5 +31,5 @@ dev = [
 ]
 
 [build-system]
-requires = ["uv_build>=0.11.16,<0.13.0"]
+requires = ["uv_build>=0.11.16,<0.14.0"]
 build-backend = "uv_build"

{stidapi-1.4.4 → stidapi-1.4.5}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "stidapi"
-version = "1.4.4"
+version = "1.4.5"
 description = "Python client for connecting to Equinor STIDapi"
 authors = [{ name = "Åsmund Våge Fannemel", email = "asmf@equinor.com" }]
 requires-python = ">=3.10,<4"
@@ -14,7 +14,7 @@ classifiers = [
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
 ]
-dependencies = ["eq-api-connector>=1.1.1,<2"]
+dependencies = ["eq-api-connector>=1.2.0,<2"]
 
 [project.urls]
 repository = "https://github.com/equinor/STIDapi-python"
@@ -28,5 +28,5 @@ dev = [
 ]
 
 [build-system]
-requires = ["uv_build>=0.11.16,<0.13.0"]
+requires = ["uv_build>=0.11.16,<0.14.0"]
 build-backend = "uv_build"

{stidapi-1.4.4 → stidapi-1.4.5}/src/stidapi/doc.py

@@ -220,7 +220,7 @@ class Doc:
             raise ValueError("doc_no must be a non-empty string")
 
         self._data: Dict[str, Any] = {}
-        self._full_data_loaded = data is None or "currentRevision" in data
+        self._full_data_loaded = data is None or self._has_full_data(data)
 
         if data is not None:
             self._data = data
@@ -244,6 +244,15 @@ class Doc:
         """Get document number."""
         return self._data.get("docNo", "")
 
+    @staticmethod
+    def _has_full_data(data: Dict[str, Any]) -> bool:
+        """Return whether document data contains usable revision information."""
+        current_revision = data.get("currentRevision")
+        if isinstance(current_revision, dict) and current_revision:
+            return True
+        project_revisions = data.get("projectRevisions")
+        return isinstance(project_revisions, list) and bool(project_revisions)
+
     def _ensure_full_data(self) -> None:
         """Reload document data once when initialized from a partial reference."""
         if self._full_data_loaded:
@@ -354,10 +363,8 @@ class Doc:
         if not inst_code or not doc_no:
             return None
 
-        url = urljoin(
-            u.get_api_url(), str(inst_code) + "/document?docNo=" + str(doc_no)
-        )
-        return u.get_json(url)
+        url = u.build_url(f"{inst_code}/document", {"docNo": doc_no})
+        return u.get_json_dict(url)
 
     @staticmethod
     def from_data(data: Dict[str, Any]) -> "Doc":

{stidapi-1.4.4 → stidapi-1.4.5}/src/stidapi/plant.py

@@ -91,10 +91,9 @@ class Plant:
     @classmethod
     def get_all_data(cls):
         if len(cls._plant_list) == 0:
-            parsed_json = u.get_json("/plants")
+            parsed_json = u.get_json_list("/plants")
 
-            if isinstance(parsed_json, list):
-                cls._plant_list = [x for x in parsed_json if "instCode" in x]
+            cls._plant_list = [x for x in parsed_json if isinstance(x, dict) and "instCode" in x]
 
         return cls._plant_list
 

{stidapi-1.4.4 → stidapi-1.4.5}/src/stidapi/system.py

@@ -1,6 +1,4 @@
 from typing import Any, Dict, List, Optional
-from urllib.parse import urljoin
-
 import stidapi.utils as u
 
 
@@ -50,9 +48,8 @@ class System:
         Returns:
             List of dictionaries containing system data.
         """
-        url = urljoin(u.get_api_url(), f"{inst_code}/system?isValid={is_valid}")
-        parsed_json = u.get_json(url)
-        return parsed_json if isinstance(parsed_json, list) else []
+        url = u.build_url(f"{inst_code}/system", {"isValid": is_valid})
+        return [item for item in u.get_json_list(url) if isinstance(item, dict)]
 
     @staticmethod
     def get_system(inst_code: str, get_statistics: bool = False) -> List["System"]:

{stidapi-1.4.4 → stidapi-1.4.5}/src/stidapi/tag.py

@@ -1,6 +1,4 @@
 from typing import Any, Dict, List, Optional, Tuple, Union
-from urllib.parse import urljoin
-
 from stidapi import Doc
 import stidapi.utils as u
 
@@ -41,28 +39,6 @@ class Tag:
         else:
             self._data = data
 
-        if self.is_function:
-            function_prop = [("functionBlock", "FB")]
-            for prop in function_prop:
-                if prop[0] in self._data:
-                    self.__setattr__(prop[1], self._data[prop[0]])
-
-        if self.is_signal:
-            signal_prop = [("signalType", "signalType")]
-            for prop in signal_prop:
-                if prop[0] in self._data:
-                    self.__setattr__(prop[1], self._data[prop[0]])
-
-        optional_prop = [
-            ("setpointL", "L"),
-            ("setpointLl", "LL"),
-            ("setpointH", "H"),
-            ("setpointHh", "HH"),
-        ]
-        for prop in optional_prop:
-            if prop[0] in self._data and self._data[prop[0]] is not None:
-                self.__setattr__(prop[1], self._data[prop[0]])
-
     @property
     def data(self) -> Dict[str, Any]:
         """Get the tag data dictionary."""
@@ -107,15 +83,67 @@ class Tag:
 
     @property
     def is_function(self) -> bool:
-        """Check if tag is a function block."""
-        return bool(
-            self.data.get("isFunction", self.category_description == "FUNCTION")
+        """Check if tag is a function tag.
+
+        True when the tag category is FUNCTION or when STID flags the tag as
+        having function data (``isFunction``).
+        """
+        return self.category_description == "FUNCTION" or bool(
+            self.data.get("isFunction", False)
         )
 
     @property
     def is_signal(self) -> bool:
-        """Check if tag is a signal."""
-        return bool(self.data.get("isSignal", self.category_description == "SIGNAL"))
+        """Check if tag is a signal tag.
+
+        True when the tag category is SIGNAL or when STID flags the tag as
+        having signal data (``isSignal``).
+        """
+        return self.category_description == "SIGNAL" or bool(
+            self.data.get("isSignal", False)
+        )
+
+    @property
+    def FB(self) -> Optional[str]:
+        """Get the function-block code for function tags.
+
+        Returns "" for tags identified by is_function without a defined function
+        block and None for tags that are not identified as functions.
+        """
+        if not self.is_function:
+            return None
+        return str(self.data.get("functionBlock") or "")
+
+    @property
+    def signalType(self) -> Optional[str]:
+        """Get the signal type for signal tags.
+
+        Returns "" for tags identified by is_signal without a defined signal
+        type and None for tags that are not identified as signals.
+        """
+        if not self.is_signal:
+            return None
+        return str(self.data.get("signalType") or "")
+
+    @property
+    def L(self) -> Optional[str]:
+        """Get the low setpoint, if defined."""
+        return self.data.get("setpointL")
+
+    @property
+    def LL(self) -> Optional[str]:
+        """Get the low-low setpoint, if defined."""
+        return self.data.get("setpointLl")
+
+    @property
+    def H(self) -> Optional[str]:
+        """Get the high setpoint, if defined."""
+        return self.data.get("setpointH")
+
+    @property
+    def HH(self) -> Optional[str]:
+        """Get the high-high setpoint, if defined."""
+        return self.data.get("setpointHh")
 
     @property
     def status(self) -> str:
@@ -190,12 +218,11 @@ class Tag:
         Returns:
             List[dict]: List of dicts describing document references.
         """
-        url = urljoin(
-            u.get_api_url(),
-            f"{str(self.inst_code)}/tag/document-refs?tagNo={str(self.tag_no)}&noContentAs200=true",
+        url = u.build_url(
+            f"{self.inst_code}/tag/document-refs",
+            {"tagNo": self.tag_no, "noContentAs200": True},
         )
-        json_data = u.get_json(url)
-        return json_data if isinstance(json_data, list) else []
+        return [item for item in u.get_json_list(url) if isinstance(item, dict)]
 
     def get_functional_location(self) -> str:
         """Get functional location of Tagged item or empty string if it does not have a functional location.
@@ -203,11 +230,10 @@ class Tag:
         Returns:
             str: Functional location or empty string if tagged item does not have a functional location.
         """
-        url = urljoin(
-            u.get_api_url(),
-            f"portal/{self.inst_code}/tag/sap-tag?tagNo={self.tag_no}",
+        url = u.build_url(
+            f"portal/{self.inst_code}/tag/sap-tag", {"tagNo": self.tag_no}
         )
-        json_data = u.get_json(url)
+        json_data = u.get_json_dict(url)
 
         if isinstance(json_data, dict) and "functionalLocation" in json_data:
             return json_data.get("functionalLocation", "")
@@ -237,7 +263,7 @@ class Tag:
         if not inst_code or not tag_no:
             return {}
 
-        url = urljoin(u.get_api_url(), str(inst_code) + "/tag?tagNo=" + str(tag_no))
+        url = u.build_url(f"{inst_code}/tag", {"tagNo": tag_no})
         data = u.get_json(url)
 
         if isinstance(data, list) and len(data) == 1:
@@ -279,53 +305,20 @@ class Tag:
             List[Tag]: List of Tag objects with a bit less data than when getting
         """
 
-        # Build query parameters
-        if len(tag_no) > 0:
-            tag_no = "tagNo=" + tag_no + "&"
-
-        if len(description) > 0:
-            description = "description=" + description + "&"
-
-        if len(tag_status) > 0:
-            tag_status = "tagStatus=" + tag_status + "&"
-
-        if tag_category > 0:
-            tag_category_string = "tagCategory=" + str(tag_category) + "&"
-        else:
-            tag_category_string = ""
-
-        if len(tag_type) > 0:
-            tag_type = "tagType=" + tag_type + "&"
-
-        if len(system) > 0:
-            system = "system=" + system + "&"
-
-        if len(discipline_code) > 0:
-            discipline_code = "disciplineCode=" + discipline_code + "&"
-
-        skip_string = "skip=" + str(skip) + "&"
-
-        # take shall be last, thus no trailing &
-        take_string = "take=" + str(take)
-
-        url = urljoin(
-            u.get_api_url(),
-            f"/{inst_code}/tags"
-            + "?"
-            + str(tag_no)
-            + str(description)
-            + str(tag_status)
-            + str(tag_category_string)
-            + str(tag_type)
-            + str(system)
-            + str(skip_string)
-            + str(take_string),
-        )
-
-        result = u.get_json(url)
-        if isinstance(result, list):
-            return [Tag(data=x) for x in result]
-        return []
+        query = {
+            "tagNo": tag_no,
+            "description": description,
+            "tagStatus": tag_status,
+            "tagCategory": tag_category if tag_category > 0 else None,
+            "tagType": tag_type,
+            "system": system,
+            "disciplineCode": discipline_code,
+            "skip": skip,
+            "take": take,
+        }
+        url = u.build_url(f"{inst_code}/tags", query)
+
+        return [Tag(data=x) for x in u.get_json_list(url) if isinstance(x, dict)]
 
     @staticmethod
     def search_additional_field(
@@ -341,17 +334,17 @@ class Tag:
         Returns:
             List[Tag]: List of Tag objects
         """
-        url = urljoin(
-            u.get_api_url(),
-            f"/{inst_code}/tag-additional-field/{field_name}?searchValue={value}&noContentAs200=true",
+        url = u.build_url(
+            f"{inst_code}/tag-additional-field/{field_name}",
+            {"searchValue": value, "noContentAs200": True},
         )
-        res = u.get_json(url)
+        res = u.get_json_list(url)
 
-        if isinstance(res, list):
-            return [Tag(inst_code=inst_code, tag_no=x["tagNo"], data=x) for x in res]
-        return []
-
-        raise ValueError(f"Invalid data {res} returned from query {url}")
+        return [
+            Tag(inst_code=inst_code, tag_no=x["tagNo"], data=x)
+            for x in res
+            if isinstance(x, dict) and "tagNo" in x
+        ]
 
     @staticmethod
     def get_from_additional_field(

{stidapi-1.4.4 → stidapi-1.4.5}/src/stidapi/utils.py

@@ -1,6 +1,7 @@
 import json
 import logging
-from typing import List, Optional, Union
+from typing import Any, Dict, List, Optional, Union
+from urllib.parse import urlencode, urljoin
 from eq_api_connector import APIConnector
 from types import SimpleNamespace
 
@@ -47,10 +48,24 @@ def set_api_client(client: STIDApiClient):
     _client = client
 
 
-def get_api_url():
+def get_api_url() -> str:
     return get_api_client().url
 
 
+def build_url(path: str, query: Optional[Dict[str, Any]] = None) -> str:
+    """Build an API URL with URL-encoded query parameters."""
+    url = urljoin(get_api_url(), path.lstrip("/"))
+    if query:
+        query = {
+            key: value
+            for key, value in query.items()
+            if value is not None and value != ""
+        }
+        if query:
+            url = f"{url}?{urlencode(query)}"
+    return url
+
+
 def get_object_from_json(text: str):
     if isinstance(text, list):
         obj = [json.loads(x, object_hook=lambda d: SimpleNamespace(**d)) for x in text]
@@ -59,8 +74,27 @@ def get_object_from_json(text: str):
     return obj
 
 
-def get_json(url: str, raise_for_status=False):
+def get_json(url: str, raise_for_status: bool = False) -> Any:
+    """Fetch JSON and propagate connector errors."""
     c = get_api_client()
     c.raise_for_status = raise_for_status
 
     return c.get_json(url=url)
+
+
+def get_json_dict(
+    url: str, raise_for_status: bool = False
+) -> Optional[Dict[str, Any]]:
+    """Fetch JSON and return an object, or None for another response shape."""
+    data = get_json(url, raise_for_status=raise_for_status)
+    if data is None:
+        return None
+    return data if isinstance(data, dict) else None
+
+
+def get_json_list(url: str, raise_for_status: bool = False) -> List[Any]:
+    """Fetch JSON and return an array, or an empty list for another shape."""
+    data = get_json(url, raise_for_status=raise_for_status)
+    if data is None:
+        return []
+    return data if isinstance(data, list) else []