stidapi 1.4.0__tar.gz → 1.4.2__tar.gz

{stidapi-1.4.0 → stidapi-1.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stidapi
-Version: 1.4.0
+Version: 1.4.2
 Summary: Python client for connecting to Equinor STIDapi
 License: Proprietary
 Author: Åsmund Våge Fannemel
@@ -13,7 +13,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.0.1,<2.0.0)
+Requires-Dist: eq-api-connector (>=1.1.0,<2.0.0)
 Project-URL: repository, https://github.com/equinor/STIDapi-python
 Description-Content-Type: text/markdown
 

{stidapi-1.4.0 → stidapi-1.4.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "stidapi"
-version = "1.4.0"
+version = "1.4.2"
 description = "Python client for connecting to Equinor STIDapi"
 authors = ["Åsmund Våge Fannemel <asmf@equinor.com>"]
 license = "Proprietary"
@@ -11,12 +11,12 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.10"
-eq-api-connector = "^1.0.1"
+eq-api-connector = "^1.1.0"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^7.4.4"
-pytest-cov = "^5.0.0"
-black = "^24.10.0"
+pytest = "^9.0.0"
+pytest-cov = "^7.0.0"
+black = "^25.10.0"
 diff-cover = "^10.2.0"
 
 [build-system]

stidapi-1.4.2/stidapi/doc.py

@@ -0,0 +1,260 @@
+from typing import Any, Dict, List, Optional
+from urllib.parse import urljoin
+import stidapi.utils as u
+
+
+class File:
+    """Class for internal use. Copy of File as returned by document endpoint."""
+
+    # "id": 0,
+    # "instCode": "string",
+    # "fileName": "string",
+    # "objectType": "string",
+    # "description": "string",
+    # "fileOrder": 0,
+    # "prodViewCode": "string",
+    # "insertedDate": "2024-04-09T11:46:07.501Z",
+    # "thumbnail": "string",
+    # "fileSize": 0,
+    # "blobId": "string"
+
+    def __init__(self, data: Dict[str, Any]) -> None:
+        """Initialize File object from data dictionary.
+
+        Args:
+            data: Dictionary containing file properties.
+        """
+        self._description: str = ""
+
+        for prop in data.keys():
+            self.__setattr__(prop, data[prop])
+
+    @property
+    def inst_code(self) -> str:
+        """Get installation code."""
+        return getattr(self, "instCode", "")
+
+    @property
+    def file_name(self) -> str:
+        """Get file name."""
+        return getattr(self, "fileName", "")
+
+    @property
+    def description(self) -> str:
+        """Get file description."""
+        return self._description
+
+    @description.setter
+    def description(self, value: str) -> None:
+        """Set file description."""
+        self._description = value
+
+    @property
+    def object_type(self) -> str:
+        """Get object type."""
+        return getattr(self, "objectType", "")
+
+    def __str__(self) -> str:
+        return f"InstCode: {self.inst_code}, FileName: {self.file_name}, Description: {self.description}, ObjectType: {self.object_type}"
+
+
+class Revision:
+    """Class for internal use. Copy of Revision as returned by document endpoint."""
+
+    # "revNo": "string",
+    # "revStatus": "string",
+    # "revStatusDescription": "string",
+    # "revDate": "2024-04-09T11:46:07.501Z",
+    # "isCurrent": true,
+    # "projectCode": "string",
+    # "projectCodeDescription": "string",
+    # "reasonForIssue": "string",
+    # "acceptanceCode": 0,
+    # "acceptanceCodeDescription": "string",
+    # "files": [File objects]
+
+    def __init__(self, data: Dict[str, Any]) -> None:
+        """Initialize Revision object from data dictionary.
+
+        Args:
+            data: Dictionary containing revision properties.
+        """
+        self._data: Dict[str, Any] = data
+        for prop in data.keys():
+            if prop == "files":
+                continue
+            self.__setattr__(prop, data[prop])
+
+    @property
+    def rev_date(self) -> str:
+        """Get revision date."""
+        return self._data.get("revDate", "")
+
+    @property
+    def rev_no(self) -> str:
+        """Get revision number."""
+        return self._data.get("revNo", "")
+
+    @property
+    def rev_status(self) -> str:
+        """Get revision status."""
+        return self._data.get("revStatus", "")
+
+    def get_files(self) -> List[File]:
+        """Get list of files in this revision.
+
+        Returns:
+            List of File objects.
+        """
+        return [File(x) for x in self._data.get("files", [])]
+
+    def __str__(self) -> str:
+        return f"RevNo: {self.rev_no}, RevStatus: {self.rev_status}, RevDate: {self.rev_date}"
+
+
+class Doc:
+    """Represents a technical document in STID."""
+
+    # "instCode": "string", "instCodeDescription": "string",
+    # "docNo": "string", "docTitle": "string",
+    # "docCategory": "string", "docCategoryDescription": "string",
+    # "docType": "string", "docTypeDescription": "string",
+    # "projectCode": "string", "projectCodeDescription": "string",
+    # "contrCode": "string", "contrCodeDescription": "string",
+    # "disciplineCode": "string","disciplineCodeDescription": "string",
+    # "locationCode": "string","locationCodeDescription": "string",
+    # "docClass": "string","docClassName": "string",        "docClassDescription": "string",
+    # "poNo": "string","poNoDescription": "string",
+    # "system": "string","systemDescription": "string",
+    # "remark": "string",
+    # "supplDocNo": "string",
+    # "companyCode": "string",
+    # "source": "string",
+    # "size": "string",
+    # "priority": "string",        "priorityDescription": "string",
+    # "weightBearing": "string",
+    # "productCode": "string",
+    # "insulationClass": "string",        "insulationClassDescription": "string",
+    # "tagRefCount": 0,        "docRefCount": 0,
+    # "currentRevision": { Revision object },
+    # "projectRevisions": [ { Revision object }],
+    # "additionalFields": [{"type": "string","typeDescription": "string","value": "string","description": "string"}],
+    # "projects": [{"instCode": "string","projectCode": "string","description": "string","stidDeliveryCode": "string",
+    #        "insertedDate": "2024-04-09T11:46:07.501Z","isPrimary": true,"isValid": true,}],
+    # "purchaseOrders": [
+    #    {"instCode": "string","poNo": "string","description": "string","insertedDate": "2024-04-09T11:46:07.501Z","isPrimary": true,"isValid": true}],
+    # "apiResponseTime": "string",
+
+    def __init__(
+        self, inst_code: str, doc_no: str, data: Optional[Dict[str, Any]] = None
+    ) -> None:
+        """Initialize Doc object.
+
+        Args:
+            inst_code: STID installation code.
+            doc_no: Document number as found in STID.
+            data: (Optional) Dictionary of data as returned from Doc.get().
+
+        Raises:
+            ValueError: If inst_code or doc_no are empty/invalid.
+        """
+        if not inst_code or not isinstance(inst_code, str):
+            raise ValueError("inst_code must be a non-empty string")
+        if not doc_no or not isinstance(doc_no, str):
+            raise ValueError("doc_no must be a non-empty string")
+
+        self._data: Dict[str, Any] = {}
+
+        if data is not None:
+            self._data = data
+        else:
+            fetched_data = Doc.get(inst_code=inst_code, doc_no=doc_no)
+            if fetched_data:
+                self._data = fetched_data
+            else:
+                raise ValueError(f"No document found for {inst_code}/{doc_no}")
+
+        self.docNo = self.no
+        self.description = self.title
+
+    @property
+    def inst_code(self) -> str:
+        """Get installation code."""
+        return self._data.get("instCode", "")
+
+    @property
+    def no(self) -> str:
+        """Get document number."""
+        return self._data.get("docNo", "")
+
+    @property
+    def category(self) -> str:
+        """Get document category description."""
+        return self._data.get("docCategoryDescription", "")
+
+    @property
+    def discipline(self) -> str:
+        """Get discipline code description."""
+        return self._data.get("disciplineCodeDescription", "")
+
+    @property
+    def type(self) -> str:
+        """Get document type description."""
+        return self._data.get("docTypeDescription", "")
+
+    @property
+    def title(self) -> str:
+        """Get document title."""
+        return self._data.get("docTitle", "")
+
+    def get_current_revision(self) -> Revision:
+        """Get the current revision of this document.
+
+        Returns:
+            Revision object for the current revision.
+        """
+        return Revision(self._data.get("currentRevision", {}))
+
+    def get_files(self) -> List[File]:
+        """Get files from the current revision.
+
+        Returns:
+            List of File objects from the current revision.
+        """
+        return self.get_current_revision().get_files()
+
+    def __str__(self) -> str:
+        return f"InstCode: {self.inst_code}, No: {self.no}, Title: {self.title}"
+
+    @staticmethod
+    def get(inst_code: str, doc_no: str) -> Optional[Dict[str, Any]]:
+        """Get data from STID for a single document.
+
+        Args:
+            inst_code: STID installation code.
+            doc_no: STID document number.
+
+        Returns:
+            Dictionary of data from STID for the document, or None if not found.
+        """
+        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)
+
+    @staticmethod
+    def from_data(data: Dict[str, Any]) -> "Doc":
+        """Create Doc object from data dictionary.
+
+        Args:
+            data: Dictionary of data for document.
+
+        Returns:
+            Doc object created from data.
+        """
+        return Doc(
+            inst_code=data.get("instCode", ""), doc_no=data.get("docNo", ""), data=data
+        )

stidapi-1.4.2/stidapi/system.py

@@ -0,0 +1,69 @@
+from typing import Any, Dict, List, Optional
+from urllib.parse import urljoin
+
+import stidapi.utils as u
+
+
+class System:
+    """Represents a system within a STID plant."""
+
+    def __init__(self, data: Optional[Dict[str, Any]] = None) -> None:
+        """Initialize System object.
+
+        Args:
+            inst_code: Installation code.
+            data: (Optional) Dictionary of system data.
+        """
+        self._data: Dict[str, Any] = {}
+
+        if isinstance(data, dict) and len(data) > 0:
+            self._data = data
+
+    @property
+    def inst_code(self) -> str:
+        """Get installation code."""
+        return self._data.get("instCode", "")
+
+    @property
+    def no(self) -> str:
+        """Get system number."""
+        return self._data.get("system", "")
+
+    @property
+    def description(self) -> str:
+        """Get system description."""
+        return self._data.get("description", "")
+
+    @property
+    def valid(self) -> bool:
+        """Get system validity flag."""
+        return self._data.get("validFlg", False)
+
+    @staticmethod
+    def get_all_data(inst_code: str, is_valid: bool = False) -> List[Dict[str, Any]]:
+        """Get all system data for an installation.
+
+        Args:
+            inst_code: Installation code.
+            is_valid: If True, return only valid systems.
+
+        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 []
+
+    @staticmethod
+    def get_system(inst_code: str, get_statistics: bool = False) -> List["System"]:
+        """Get all System objects for an installation.
+
+        Args:
+            inst_code: Installation code.
+            get_statistics: (Unused) Placeholder for future extension.
+
+        Returns:
+            List of System objects.
+        """
+        plant_data = System.get_all_data(inst_code, get_statistics)
+        return [System(x) for x in plant_data if isinstance(x, dict)]

{stidapi-1.4.0 → stidapi-1.4.2}/stidapi/tag.py

@@ -1,4 +1,4 @@
-from typing import List, Optional, Tuple, Union
+from typing import Any, Dict, List, Optional, Tuple, Union
 from urllib.parse import urljoin
 
 from stidapi import Doc
@@ -6,18 +6,38 @@ import stidapi.utils as u
 
 
 class Tag:
-    def __init__(self, inst_code: str, tag_no: str, data: Optional[dict] = None):
-        """
-        Object initializer for Tag
-        :param inst_code: STID installation code
-        :param tag_no: Tag number as found in STID
-        :param data: (Optional) dictionary of data as returned from Tag.get or Tag.search
+    """Represents an instrumentation tag in STID."""
+
+    def __init__(
+        self,
+        inst_code: str = "",
+        tag_no: str = "",
+        data: Optional[Dict[str, Any]] = None,
+    ) -> None:
+        """Initialize Tag object.
+
+        Args:
+            inst_code: (Optional) STID installation code.
+            tag_no: (Optional) Tag number as found in STID.
+            data: (Optional) Dictionary of data as returned from Tag.get() or Tag.search().
 
-        Initializes object and gets data from STID if available.
+        Raises:
+            ValueError: If neither data nor valid combination of inst_code and tag_no is provided.
         """
 
+        self._data: Dict[str, Any] = {}
+
         if not data:
-            self._data = Tag.get(inst_code=inst_code, tag_no=tag_no)
+            if not inst_code or not isinstance(inst_code, str):
+                raise ValueError("inst_code must be a non-empty string")
+            if not tag_no or not isinstance(tag_no, str):
+                raise ValueError("tag_no must be a non-empty string")
+
+            fetched_data = Tag.get(inst_code=inst_code, tag_no=tag_no)
+            if fetched_data:
+                self._data = fetched_data
+            else:
+                raise ValueError(f"No tag found for {inst_code}/{tag_no}")
         else:
             self._data = data
 
@@ -44,54 +64,65 @@ class Tag:
                 self.__setattr__(prop[1], self._data[prop[0]])
 
     @property
-    def data(self) -> dict:
+    def data(self) -> Dict[str, Any]:
+        """Get the tag data dictionary."""
         if hasattr(self, "_data"):
             return self._data
         return {}
 
     @property
     def tag_no(self) -> str:
+        """Get tag number."""
         return self.no
 
     @property
     def inst_code(self) -> str:
+        """Get installation code."""
         return str(self.data.get("instCode", ""))
 
     @property
-    def no(self):
+    def no(self) -> str:
+        """Get tag number."""
         return str(self.data.get("tagNo", ""))
 
     @property
     def description(self) -> str:
+        """Get tag description."""
         return str(self.data.get("description", ""))
 
     @property
-    def category(self):
+    def category(self) -> str:
+        """Get tag category."""
         return self.data.get("tagCategory", "")
 
     @property
     def category_description(self) -> str:
+        """Get tag category description."""
         return str(self.data.get("tagCategoryDescription", "")).upper()
 
     @property
-    def discipline_description(self):
+    def discipline_description(self) -> str:
+        """Get discipline code description."""
         return self.data.get("disciplineCodeDescription", "")
 
     @property
     def is_function(self) -> bool:
+        """Check if tag is a function block."""
         return bool(
             self.data.get("isFunction", self.category_description == "FUNCTION")
         )
 
     @property
     def is_signal(self) -> bool:
+        """Check if tag is a signal."""
         return bool(self.data.get("isSignal", self.category_description == "SIGNAL"))
 
     @property
-    def status(self):
+    def status(self) -> str:
+        """Get tag status."""
         return str(self.data.get("tagStatus", ""))
 
-    def get_addition_field(self, field: str = "") -> List[dict]:
+    def get_addition_field(self, field: str = "") -> List[Dict[str, Any]]:
         """Get list of additional fields. Optionally filter by type.
 
         Args:
@@ -102,7 +133,7 @@ class Tag:
         """
         return self.get_additional_field(field=field)
 
-    def get_additional_field(self, field: Optional[str] = "") -> List[dict]:
+    def get_additional_field(self, field: Optional[str] = "") -> List[Dict[str, Any]]:
         """Get list of additional fields. Optionally filter by type.
 
         Args:
@@ -112,12 +143,14 @@ class Tag:
             List[dict]: List of additional fields.
         """
         if field is None or len(field) == 0:
-            return self._data["additionalFields"]
+            return self._data.get("additionalFields", [])
 
-        return [x for x in self._data["additionalFields"] if x["type"] == field]
+        return [
+            x for x in self._data.get("additionalFields", []) if x.get("type") == field
+        ]
 
     def get_additional_field_value(self, field: str) -> List[Tuple[str, str]]:
-        """Get list of tuples of value and description for additional field of a given type
+        """Get list of tuples of value and description for additional field of a given type.
 
         Args:
             field (str): Name of additional field to get
@@ -127,21 +160,32 @@ class Tag:
         """
         f = self.get_additional_field(field=field)
         if len(f) > 0:
-            return [(x["value"], x["description"]) for x in f]
+            return [(x.get("value", ""), x.get("description", "")) for x in f]
 
         return []
 
-    def get_doc(self) -> List["Doc"]:
+    def get_ims(self) -> dict[str, str]:
+        """Get IMS tags related to tag if available.
+
+        Returns:
+            str: IMS code or empty string if not available.
+        """
+        fields = self.get_additional_field_value(field="IMS")
+        d = {}
+        [d.update({v: k}) for k, v in fields if k is not None and v is not None]
+
+        return d
+
+    def get_doc(self) -> List[Doc]:
         """Get list of documents that tag refers to.
 
         Returns:
             List[Doc]: List of referred Documents
         """
+        return [Doc.from_data(x) for x in self.get_doc_references()]
 
-        return [Doc(x["instCode"], x["docNo"]) for x in self.get_doc_references()]
-
-    def get_doc_references(self) -> List[dict]:
-        """Get doc references of tag from stidapi as dicts.
+    def get_doc_references(self) -> List[Dict[str, Any]]:
+        """Get doc references of tag from STID API as dictionaries.
 
         Returns:
             List[dict]: List of dicts describing document references.
@@ -150,8 +194,8 @@ class Tag:
             u.get_api_url(),
             f"{str(self.inst_code)}/tag/document-refs?tagNo={str(self.tag_no)}&noContentAs200=true",
         )
-        json = u.get_json(url)
-        return json
+        json_data = u.get_json(url)
+        return json_data if isinstance(json_data, list) else []
 
     def get_functional_location(self) -> str:
         """Get functional location of Tagged item or empty string if it does not have a functional location.
@@ -159,32 +203,26 @@ 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}",
         )
-        json = u.get_json(url)
+        json_data = u.get_json(url)
 
-        if isinstance(json, dict) and "functionalLocation" in json.keys():
-            return json["functionalLocation"]
+        if isinstance(json_data, dict) and "functionalLocation" in json_data:
+            return json_data.get("functionalLocation", "")
         else:
             return ""
 
-    def __str__(self):
-        """
-        Overload string representation of object.
-        :return: Pretty-print string describing Tag object
-        """
+    def __str__(self) -> str:
+        """Get string representation of Tag object."""
         if isinstance(self._data, dict) and len(self._data) > 0:
             return str(self.tag_no) + "@" + str(self.inst_code) + " with data"
         else:
             return str(self.tag_no) + "@" + str(self.inst_code) + " with no data"
 
-    def prune_empty_data(self):
-        """
-        Remove all empty, i.e., containing None, entries in data dictionary.
-        """
+    def prune_empty_data(self) -> None:
+        """Remove all empty (None) entries from data dictionary."""
         if isinstance(self._data, dict) and len(self._data) > 0:
             self._data = {k: v for k, v in self._data.items() if v is not None}
 
@@ -196,6 +234,8 @@ class Tag:
         :param tag_no: STID tag number
         :return: Dictionary of data from STID for tag.
         """
+        if not inst_code or not tag_no:
+            return {}
 
         url = urljoin(u.get_api_url(), str(inst_code) + "/tag?tagNo=" + str(tag_no))
         data = u.get_json(url)
@@ -206,7 +246,7 @@ class Tag:
         if isinstance(data, dict):
             return data
 
-        raise ValueError("Did not receive a dictionary from server.")
+        return {}
 
     @staticmethod
     def search(
@@ -239,8 +279,7 @@ class Tag:
             List[Tag]: List of Tag objects with a bit less data than when getting
         """
 
-        # string subSystem, string mainSystem, string projectCode, string poNo,
-        # string contrCode, string locationCode, string plantId,
+        # Build query parameters
         if len(tag_no) > 0:
             tag_no = "tagNo=" + tag_no + "&"
 
@@ -283,7 +322,10 @@ class Tag:
             + str(take_string),
         )
 
-        return [Tag(x["instCode"], x["tagNo"], x) for x in u.get_json(url)]
+        result = u.get_json(url)
+        if isinstance(result, list):
+            return [Tag(data=x) for x in result]
+        return []
 
     @staticmethod
     def search_additional_field(
@@ -306,7 +348,8 @@ class Tag:
         res = u.get_json(url)
 
         if isinstance(res, list):
-            return [Tag(inst_code=inst_code, tag_no=x["tagNo"]) for x in res]
+            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}")
 

{stidapi-1.4.0 → stidapi-1.4.2}/stidapi/utils.py

@@ -4,7 +4,6 @@ from typing import List, Optional, Union
 from eq_api_connector import APIConnector
 from types import SimpleNamespace
 
-
 logger = logging.getLogger(__name__)
 
 _client = None
@@ -29,7 +28,7 @@ class STIDApiClient(APIConnector):
             user_name=user_name,
             user_assertion=user_assertion,
         )
-        self.set_url_prod("https://stidapi.equinor.com/")
+        self.url_prod = "https://stidapi.equinor.com/"
         # todo: set dev url
 
 
@@ -49,7 +48,7 @@ def set_api_client(client: STIDApiClient):
 
 
 def get_api_url():
-    return get_api_client().get_url()
+    return get_api_client().url
 
 
 def get_object_from_json(text: str):
@@ -62,6 +61,6 @@ def get_object_from_json(text: str):
 
 def get_json(url: str, raise_for_status=False):
     c = get_api_client()
-    c.set_raise_for_status(raise_for_status=raise_for_status)
+    c.raise_for_status = raise_for_status
 
     return c.get_json(url=url)

stidapi-1.4.0/stidapi/doc.py

@@ -1,152 +0,0 @@
-from typing import List
-from urllib.parse import urljoin
-import stidapi.utils as u
-
-
-class File:
-    """Class for internal use. Copy of File as returned by document endpoint."""
-
-    # "id": 0,
-    # "instCode": "string",
-    # "fileName": "string",
-    # "objectType": "string",
-    # "description": "string",
-    # "fileOrder": 0,
-    # "prodViewCode": "string",
-    # "insertedDate": "2024-04-09T11:46:07.501Z",
-    # "thumbnail": "string",
-    # "fileSize": 0,
-    # "blobId": "string"
-
-    def __init__(self, data: dict):
-        for prop in data.keys():
-            self.__setattr__(prop, data[prop])
-
-    def __str__(self):
-        return f"InstCode: {self.instCode}, FileName: {self.fileName}, Description: {self.description}, ObjectType: {self.objectType}"
-
-
-class Revision:
-    """Class for internal use. Copy of Revision as returned by document endpoint."""
-
-    # "revNo": "string",
-    # "revStatus": "string",
-    # "revStatusDescription": "string",
-    # "revDate": "2024-04-09T11:46:07.501Z",
-    # "isCurrent": true,
-    # "projectCode": "string",
-    # "projectCodeDescription": "string",
-    # "reasonForIssue": "string",
-    # "acceptanceCode": 0,
-    # "acceptanceCodeDescription": "string",
-    # "files": [File objects]
-
-    def __init__(self, data: dict):
-        self._data = data
-        for prop in data.keys():
-            if prop == "files":
-                continue
-            self.__setattr__(prop, data[prop])
-
-    def get_files(self):
-        return [File(x) for x in self._data["files"]]
-
-    def __str__(self):
-        return (
-            f"RevNo: {self.revNo}, RevStatus: {self.revStatus}, RevDate: {self.revDate}"
-        )
-
-
-class Doc:
-    def __init__(self, inst_code: str, doc_no: str):
-        """
-        Object initializer for Doc
-        :param inst_code: STID installation code
-        :param doc_no: Doc number as found in STID
-
-        Initializes object and gets data from STID if available.
-        """
-        self.inst_code = ""
-        self.no = ""
-        self.title = ""
-
-        self.category = ""
-        self.discipline = ""
-        self.type = ""
-
-        self._data = Doc.get(inst_code=inst_code, doc_no=doc_no)
-
-        common_prop = [
-            ("instCode", "inst_code"),
-            ("docNo", "no"),
-            ("docTitle", "title"),
-            ("docCategoryDescription", "category"),
-            ("disciplineCodeDescription", "discipline"),
-            ("docTypeDescription", "type"),
-        ]
-        for prop in common_prop:
-            if prop[0] in self._data:
-                self.__setattr__(prop[1], self._data[prop[0]])
-            else:
-                self.__setattr__(prop[1], "")
-
-        self.docNo = self.no
-        self.description = self.title
-
-        optional_prop = []
-        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]])
-
-    def get_current_revision(self) -> Revision:
-        return Revision(self._data["currentRevision"])
-
-    def get_files(self) -> List[File]:
-        return self.get_current_revision().get_files()
-
-    def __str__(self):
-        return f"InstCode: {self.inst_code}, No: {self.no}, Title: {self.title}"
-
-    # "instCode": "string", "instCodeDescription": "string",
-    # "docNo": "string", "docTitle": "string",
-    # "docCategory": "string", "docCategoryDescription": "string",
-    # "docType": "string", "docTypeDescription": "string",
-    # "projectCode": "string", "projectCodeDescription": "string",
-    # "contrCode": "string", "contrCodeDescription": "string",
-    # "disciplineCode": "string","disciplineCodeDescription": "string",
-    # "locationCode": "string","locationCodeDescription": "string",
-    # "docClass": "string","docClassName": "string",        "docClassDescription": "string",
-    # "poNo": "string","poNoDescription": "string",
-    # "system": "string","systemDescription": "string",
-    # "remark": "string",
-    # "supplDocNo": "string",
-    # "companyCode": "string",
-    # "source": "string",
-    # "size": "string",
-    # "priority": "string",        "priorityDescription": "string",
-    # "weightBearing": "string",
-    # "productCode": "string",
-    # "insulationClass": "string",        "insulationClassDescription": "string",
-    # "tagRefCount": 0,        "docRefCount": 0,
-    # "currentRevision": { Revision object },
-    # "projectRevisions": [ { Revision object }],
-    # "additionalFields": [{"type": "string","typeDescription": "string","value": "string","description": "string"}],
-    # "projects": [{"instCode": "string","projectCode": "string","description": "string","stidDeliveryCode": "string",
-    #        "insertedDate": "2024-04-09T11:46:07.501Z","isPrimary": true,"isValid": true,}],
-    # "purchaseOrders": [
-    #    {"instCode": "string","poNo": "string","description": "string","insertedDate": "2024-04-09T11:46:07.501Z","isPrimary": true,"isValid": true}],
-    # "apiResponseTime": "string",
-
-    @staticmethod
-    def get(inst_code: str, doc_no: str):
-        """
-        Get data from STID for a single doc.
-        :param inst_code: STID installation code
-        :param doc_no: STID doc number
-        :return: Dictionary of data from STID for doc.
-        """
-
-        url = urljoin(
-            u.get_api_url(), str(inst_code) + "/document?docNo=" + str(doc_no)
-        )
-        return u.get_json(url)

stidapi-1.4.0/stidapi/system.py

@@ -1,40 +0,0 @@
-from urllib.parse import urljoin
-
-import stidapi.utils as u
-
-
-class System:
-    def __init__(self, inst_code: str = "", data=None):
-        if isinstance(inst_code, str) and len(inst_code) > 0:
-            self.inst_code = inst_code
-
-        self._data = {}
-        self.no = ""
-        self.description = ""
-        self.inst_code = ""
-        self.valid = None
-
-        if isinstance(data, dict) and len(data) > 0:
-            self._data = data
-            self.inst_code = data["instCode"]
-            self.no = data["system"]
-            self.description = data["description"]
-            self.valid = data["validFlg"]
-
-    @staticmethod
-    def get_all_data(inst_code, is_valid: bool = False):
-        """
-
-        :param get_statistics:
-        :return:
-        """
-
-        url = urljoin(u.get_api_url(), f"{inst_code}/system?isValid={is_valid}")
-        parsed_json = u.get_json(url)
-
-        return parsed_json
-
-    @staticmethod
-    def get_system(inst_code: str, get_statistics: bool = False):
-        plant_data = System.get_all_data(inst_code, get_statistics)
-        return [System(inst_code, x) for x in plant_data]