commonlib-reader 1.0.4__tar.gz → 1.0.6__tar.gz

{commonlib_reader-1.0.4 → commonlib_reader-1.0.6}/PKG-INFO

@@ -1,26 +1,34 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: commonlib-reader
-Version: 1.0.4
-Summary: Reader for Equinor commonlibapi.
-Home-page: https://github.com/equinor/commonlib-reader.git
+Version: 1.0.6
+Summary: Reader for Equinor commonlib api.
+License: MIT
 Author: Åsmund Våge Fannemel
 Author-email: asmf@equinor.com
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.9.2,<4.0.0
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: msal_bearer (>=1.1.4,<2.0.0)
-Requires-Dist: pandas (>=2.1.4,<3.0.0)
-Requires-Dist: requests (>=2.31.0,<3.0.0)
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: msal_bearer (>=1.3.3,<2.0.0)
+Requires-Dist: pandas (>=2.1.4)
+Requires-Dist: requests (>=2.32.4)
+Requires-Dist: urllib3 (>=2.5.0)
 Project-URL: Repository, https://github.com/equinor/commonlib-reader.git
 Description-Content-Type: text/markdown
 
 # commonlib-reader [![SNYK dependency check](https://github.com/equinor/commonlib-reader/actions/workflows/snyk.yml/badge.svg)](https://github.com/equinor/commonlib-reader/actions/workflows/snyk.yml)
-Connector package for Equinor Commonlib api. Used for getting code tables.
+Connector package for Equinor [Commonlib](https://commonlib.equinor.com/) [api](https://commonlibapi.equinor.com/swagger/index.html). 
+
+Current features:
+- Reading code tables
+- Getting facility data using the [Facility](commonlib_reader/facility.py) class
+- [IMS source ](commonlib_reader/ims.py) lookup tables for facilities
+- Getting Tag category, Tag type, Tag format, and Tag format element data. See [tag.py](commonlib_reader/tag.py)
+- Getting [units of measure](commonlib_reader/ims.py) definitions.
 
-Some additional functionality for asset specific Tag categories and tag types is also included.
 
 ## Use
 Try it out by running the [demo](examples/demo.py).

{commonlib_reader-1.0.4 → commonlib_reader-1.0.6}/README.md

@@ -1,7 +1,13 @@
 # commonlib-reader [![SNYK dependency check](https://github.com/equinor/commonlib-reader/actions/workflows/snyk.yml/badge.svg)](https://github.com/equinor/commonlib-reader/actions/workflows/snyk.yml)
-Connector package for Equinor Commonlib api. Used for getting code tables.
+Connector package for Equinor [Commonlib](https://commonlib.equinor.com/) [api](https://commonlibapi.equinor.com/swagger/index.html). 
+
+Current features:
+- Reading code tables
+- Getting facility data using the [Facility](commonlib_reader/facility.py) class
+- [IMS source ](commonlib_reader/ims.py) lookup tables for facilities
+- Getting Tag category, Tag type, Tag format, and Tag format element data. See [tag.py](commonlib_reader/tag.py)
+- Getting [units of measure](commonlib_reader/ims.py) definitions.
 
-Some additional functionality for asset specific Tag categories and tag types is also included.
 
 ## Use
 Try it out by running the [demo](examples/demo.py).

{commonlib_reader-1.0.4 → commonlib_reader-1.0.6}/commonlib_reader/facility.py

@@ -29,6 +29,7 @@ class Facility:
 
         Parameters:
             code (str): The code used to retrieve facility data from the data source.
+            STID plant code is preferred, but SAP codes and governmental facility names can also be used.
 
         Raises:
             ValueError: If no data is found for the provided code.

{commonlib_reader-1.0.4 → commonlib_reader-1.0.6}/commonlib_reader/tag.py

@@ -1,4 +1,4 @@
-from typing import List, Union
+from typing import List, Optional, Union
 from commonlib_reader.utils import get_code, get_code_param, query_sql
 import re
 
@@ -110,6 +110,13 @@ class TagFormat:
         return f"{self.description} - {self.tag_category}"
 
     def is_valid(self, tagNo: str):
+        """Check if input tag number matches this tag format.
+        Args:
+            tagNo (str): Tag number to check.
+        Returns:
+            bool: True if tag number matches this tag format, else False.
+        """
+
         return re.fullmatch(self.regex, tagNo)
 
     def get_id(self) -> int:
@@ -149,10 +156,28 @@ class TagFormat:
         return regex_group_named
 
     def split_tag(self, tagNo: str) -> dict:
+        """Split input tag number into its elements based on this tag format.
+        Args:
+            tagNo (str): Tag number to split.
+        Returns:
+            dict: Dictionary where keys are tag format element descriptions and values are the corresponding parts of the tag number.
+        Raises:
+            ValueError: If the tag number does not match the tag format.
+        """
+
+        # if not self.is_valid(tagNo):
+        #     raise ValueError(
+        #         f"Tag number '{tagNo}' does not match format '{self}'"
+        #     )
+
         # Change naming pattern for groups in commonlib-regex to match python re format
         py_pattern = re.sub(r"\(\?<(\w+)>", r"(?P<\1>", self.regex_grouped)
         matches = re.match(py_pattern, tagNo)
 
+        if matches is None:
+            raise ValueError(
+                f"Tag number '{tagNo}' does not match format '{self.regex_grouped}'"
+            )
         # Tag format element descriptions may contain space and can not be used as group name in regex. Instead create dict where description is key.
         d = {}
         for e in self.get_tagformat_elements():
@@ -178,7 +203,15 @@ class TagFormat:
             TagFormat: The requested tag format object.
         """
         t = TagCategory.get_category(inst_code=inst_code, name=tag_category)
-        return t[0].get_format(description)
+        if len(t) == 0:
+            raise ValueError(f"TagCategory {tag_category} not found")
+
+        tf = t[0].get_format(description)
+        if tf is None:
+            raise ValueError(
+                f"TagFormat {description} not found in TagCategory {tag_category} for installation {inst_code}"
+            )
+        return tf
 
 
 class TagType:
@@ -234,12 +267,14 @@ class TagType:
             TagType: The TagType object matching the criteria.
         """
         t = TagCategory.get_category(inst_code=inst_code, name=tag_category)
+        if len(t) == 0:
+            raise ValueError(f"TagCategory {tag_category} not found")
         return t[0].get_type(name)
 
     @staticmethod
     def get_tagtype_no_cache(
         name: str, inst_code: str, tag_category: str = ""
-    ) -> "TagType":
+    ) -> List["TagType"]:
         """
         Retrieve tag types for the given name and installation code without using the cache. Optionally filter by tag category.
 
@@ -268,8 +303,10 @@ class TagType:
 
     @staticmethod
     def get_master_tagtype(
-        name: str, tag_category: str = "", technology: str = "Oil&Gas"
-    ) -> "TagType":
+        name: str,
+        tag_category: Optional[str] = "",
+        technology: Optional[str] = "Oil&Gas",
+    ) -> List["TagType"]:
         """
         Retrieve master tag types based on name, category, and technology. If name is empty,
         sorts by name and returns all. If name is provided, filters by name.
@@ -319,7 +356,7 @@ class TagType:
     @staticmethod
     def get_master_tagtype_mappings(
         name: str, tag_category: str = "", technology: str = "Oil&Gas"
-    ):
+    ) -> List["TagType"]:
         """
         Retrieve mappings of the master tag types based on name, category,
         and technology. Raises a ValueError if no relevant mappings are found
@@ -421,7 +458,7 @@ class TagCategory:
 
         return self._formats
 
-    def get_format(self, description: str) -> TagFormat:
+    def get_format(self, description: str) -> Union[TagFormat, None]:
         """Get single tag format for this specific tag category.
 
         Args:
@@ -451,7 +488,7 @@ class TagCategory:
 
         return self._types
 
-    def get_type(self, type: str) -> Union[TagType, None]:
+    def get_type(self, type: str) -> TagType:
         """Get single type from this specific tag category.
 
         Args:
@@ -464,13 +501,25 @@ class TagCategory:
             if curr_type.name == type:
                 return curr_type
 
-        return None
+        raise ValueError(
+            f"TagType {type} not found in TagCategory {self.name} for installation {self.inst_code}"
+        )
 
     def __str__(self):
         return f"{self.TagCategoryId}:{self.name} - {self.description}"
 
     @staticmethod
     def get_category(inst_code: str, name="") -> List["TagCategory"]:
+        """
+        Retrieve tag categories for a given installation code. If name is provided, filters by name.
+
+        Parameters:
+            inst_code (str): Installation code for which to retrieve tag categories.
+            name (str, optional): Name of the tag category to filter by. Defaults to an empty string.
+        Returns:
+            List[TagCategory]: A list of TagCategory objects.
+        """
+
         categories = _get_category_data(inst_code=inst_code)
         tc = [TagCategory(x, inst_code=inst_code) for x in categories]
         tc.sort(key=lambda x: x.TagCategoryId)

{commonlib_reader-1.0.4 → commonlib_reader-1.0.6}/commonlib_reader/utils.py

@@ -1,5 +1,5 @@
 import json
-from typing import Dict, List
+from typing import Dict, List, Optional
 from urllib.parse import urljoin
 
 import requests
@@ -17,7 +17,7 @@ def get_disciplines():
     return get_code("Discipline")
 
 
-def get_code(code: str, scope: str = None, name: str = None):
+def get_code(code: str, scope: Optional[str] = None, name: Optional[str] = None):
     params = {}
     if scope is not None:
         params["scope"] = scope

commonlib_reader-1.0.6/pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "commonlib-reader"
+version = "1.0.6"
+description = "Reader for Equinor commonlib api."
+authors = [
+	{ name = "Åsmund Våge Fannemel", email = "asmf@equinor.com" }
+]
+readme = "README.md"
+license = { text = "MIT" }
+urls = {"Repository" = "https://github.com/equinor/commonlib-reader.git"}
+requires-python = ">=3.9.2,<4.0.0"
+dependencies = [
+	"msal_bearer>=1.3.3,<2.0.0",
+	"pandas>=2.1.4",
+	"requests>=2.32.4",
+	"urllib3>=2.5.0" # Pinned to avoid security issues in some older versions
+]
+
+[tool.poetry.group.test.dependencies]
+pytest = "^7.4.4"
+pytest-cov = "^6.0.0"
+
+[tool.poetry.group.dev.dependencies]
+black = "^24.1.1"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

commonlib_reader-1.0.4/pyproject.toml

@@ -1,25 +0,0 @@
-[tool.poetry]
-name = "commonlib-reader"
-version = "1.0.4"
-description = "Reader for Equinor commonlibapi."
-authors = ["Åsmund Våge Fannemel <asmf@equinor.com>"]
-readme = "README.md"
-packages = [{ include = "commonlib_reader" }]
-repository = "https://github.com/equinor/commonlib-reader.git"
-
-[tool.poetry.dependencies]
-python = "^3.9"
-msal_bearer = ">=1.1.4,<2.0.0"
-pandas = "^2.1.4"
-requests = "^2.31.0"
-
-[tool.poetry.group.test.dependencies]
-pytest = "^7.4.4"
-pytest-cov = "^6.0.0"
-
-[tool.poetry.group.dev.dependencies]
-black = "^24.1.1"
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"