commonlib-reader 1.0.0__tar.gz → 1.0.1__tar.gz

{commonlib_reader-1.0.0 → commonlib_reader-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: commonlib-reader
-Version: 1.0.0
+Version: 1.0.1
 Summary: Reader for Equinor commonlibapi.
 Home-page: https://github.com/equinor/commonlib-reader.git
 Author: Åsmund Våge Fannemel
@@ -11,13 +11,13 @@ 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 (>0.2.1)
+Requires-Dist: msal_bearer (>0.2.1,<2.0.0)
 Requires-Dist: pandas (>=2.1.4,<3.0.0)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
 Project-URL: Repository, https://github.com/equinor/commonlib-reader.git
 Description-Content-Type: text/markdown
 
-# commonlib-python
+# 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.
 
 Some additional functionality for asset specific Tag categories and tag types is also included.
@@ -37,3 +37,4 @@ Poetry is preferred for developers. Clone and install with required packages for
 
 For testing with coverage run:  
 `poetry run pytest --cov --cov-report=html`
+

{commonlib_reader-1.0.0 → commonlib_reader-1.0.1}/README.md

@@ -1,4 +1,4 @@
-# commonlib-python
+# 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.
 
 Some additional functionality for asset specific Tag categories and tag types is also included.
@@ -17,4 +17,4 @@ Poetry is preferred for developers. Clone and install with required packages for
 `poetry install`
 
 For testing with coverage run:  
-`poetry run pytest --cov --cov-report=html`
+`poetry run pytest --cov --cov-report=html`

{commonlib_reader-1.0.0 → commonlib_reader-1.0.1}/commonlib_reader/facility.py

@@ -33,7 +33,7 @@ class Facility:
         Raises:
             ValueError: If no data is found for the provided code.
         """
-        self._data = Facility._get_facility(code=code)
+        self._data = Facility._get_facility_data(code=code)
         self._attributes = attributes_list_to_dict(self._data["attributes"])
 
         self.identity = self._data["identity"]
@@ -69,11 +69,11 @@ class Facility:
         Returns:
             List[Facility]: A list of Facility instances.
         """
-        f = Facility._get_all_facilities()
+        f = Facility._get_all_facility_data()
         return [Facility(x["identity"]) for x in f]
 
     @classmethod
-    def _get_all_facilities(cls) -> List[dict]:
+    def _get_all_facility_data(cls) -> List[dict]:
         """
         Retrieves all facility data, using a class level cache.
 
@@ -86,7 +86,7 @@ class Facility:
         return cls._cache
 
     @classmethod
-    def _get_facility(cls, code) -> dict:
+    def _get_facility_data(cls, code) -> dict:
         """
         Retrieves the facility data for the given code.
 
@@ -99,7 +99,21 @@ class Facility:
         Raises:
             ValueError: If no data is found for the provided code.
         """
-        for f in cls._get_all_facilities():
-            if f["identity"] == code or f["name"] == code or f["description"] == code:
-                return f
+
+        if isinstance(code, str):
+            for f in cls._get_all_facility_data():
+                if (
+                    f["identity"] == code
+                    or f["name"] == code
+                    or f["description"] == code
+                ):
+                    return f
+
+        for f in cls._get_all_facility_data():
+            for a in f["attributes"]:
+                if a["definitionName"] == "SAPPlant":
+                    if a["displayValue"] == str(code):
+                        return f
+                    break
+
         raise ValueError(f"No data found for {code}")

{commonlib_reader-1.0.0 → commonlib_reader-1.0.1}/commonlib_reader/tag.py

@@ -1,5 +1,6 @@
 from typing import List, Union
 from commonlib_reader.utils import get_code, get_code_param, query_sql
+import re
 
 # from commonlib_reader.utils import attributes_list_to_dict
 
@@ -9,9 +10,59 @@ _cache["TagCategory"] = {}
 _cache["TagFormat"] = {}
 
 
+class TagFormatElement:
+    """A class representing the elements constructing a tag number.
+
+    Attributes:
+        description (str)
+        name (str)
+        IsValid (bool)
+        IsRequired (bool)
+        IsSelected (bool)
+
+    """
+
+    def __init__(self, data):
+        """
+        Initializes a TagFormatElement object.
+
+        Parameters:
+            data (dict): Data containing different properties of a tag format element.
+        """
+        self._data = data
+
+        self.description = data["Description"]
+        self.name = data["Name"]
+        self.IsValid = bool(data["IsValid"])
+        self.IsRequired = bool(data["Required"])
+        self.IsSelected = bool(data["SelectFlag"])
+
+    def get_TagFormat(self) -> "TagFormat":
+        tag_format_id = self._data["TagFormat_ID"]
+        res = query_sql(f"Select * from tagformat where Id = '{tag_format_id}'")
+        return TagFormat.get_tagformat(
+            res[0]["Description"], res[0]["Scope"], res[0]["TagCategory"]
+        )
+
+    @staticmethod
+    def get_TagFormatElements(
+        tag_format: Union["TagFormat", str]
+    ) -> List["TagFormatElement"]:
+        if isinstance(tag_format, TagFormat):
+            tag_format_id = tag_format.get_id()
+        else:
+            tag_format_id = tag_format
+
+        # q = f"SELECT * FROM [TagFormatElement] WHERE IsValid = 1 AND IsReleaseReady = 1 AND SelectFlag = 'true' AND TagFormat_ID = '{tag_format_id}'"
+
+        q = f"SELECT * FROM [TagFormatElement] WHERE IsValid = 1 AND IsReleaseReady = 1 AND TagFormat_ID = '{tag_format_id}'"
+        sql_result = query_sql(q)
+        return [TagFormatElement(x) for x in sql_result]
+
+
 class TagFormat:
     """
-    A class that represents the format of a tag within the context of a Facility.
+    A class that represents the format of a tag number within the context of a Facility. Each tag number shall belong to a Tag Type.
 
     Attributes:
         inst_code (str): Installation code.
@@ -31,6 +82,10 @@ class TagFormat:
             inst_code (str): Installation code for this tag format.
         """
         self._data = data
+
+        # Cache tagformatelements
+        self._tfe = None
+
         # self._attributes = attributes_list_to_dict(self._data["attributes"])
 
         self.inst_code = inst_code
@@ -54,6 +109,47 @@ class TagFormat:
     def __str__(self):
         return f"{self.description} - {self.tag_category}"
 
+    def is_valid(self, tagNo: str):
+        return re.fullmatch(self.regex, tagNo)
+
+    def get_id(self) -> int:
+        """Get tagformat identity.
+
+        Returns:
+            int: Numeric identity for TagFormat. Used to cross reference databases.
+        """
+        res = query_sql(
+            f"SELECT Id from [TagFormat] where [TagFormat].[Identity] = '{self._data['identity']}'"
+        )
+        return res[0]["Id"]
+
+    def get_tagformat_elements(self) -> List[TagFormatElement]:
+        """Get TagFormatElement objects for this TagFormat.
+
+        Returns:
+            List[TagFormatElement]: List of TagFormatElement objects.
+        """
+        if self._tfe is None:
+            self._tfe = TagFormatElement.get_TagFormatElements(self)
+
+        return self._tfe
+
+    def split_tag(self, tagNo: str) -> dict:
+        # Change naming pattern for groups to match python re format
+        py_pattern = re.sub(r"\(\?<(\w+)>", r"(?P<\1>", self.regex_grouped)
+
+        # Change group number with group description
+
+        matches = re.match(py_pattern, tagNo)
+
+        d = {}
+        for e in self.get_tagformat_elements():
+            group_name = f"e{e.name}"
+            if group_name in matches.groupdict().keys():
+                d[e.description] = matches.group(group_name)
+
+        return d
+
     @staticmethod
     def get_tagformat(
         description: str, inst_code: str, tag_category: str

{commonlib_reader-1.0.0 → commonlib_reader-1.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "commonlib-reader"
-version = "1.0.0"
+version = "1.0.1"
 description = "Reader for Equinor commonlibapi."
 authors = ["Åsmund Våge Fannemel <asmf@equinor.com>"]
 readme = "README.md"
@@ -9,13 +9,13 @@ repository = "https://github.com/equinor/commonlib-reader.git"
 
 [tool.poetry.dependencies]
 python = "^3.9"
-msal_bearer = ">0.2.1"
+msal_bearer = ">0.2.1,<2.0.0"
 pandas = "^2.1.4"
 requests = "^2.31.0"
 
 [tool.poetry.group.test.dependencies]
 pytest = "^7.4.4"
-pytest-cov = "^5.0.0"
+pytest-cov = "^6.0.0"
 
 [tool.poetry.group.dev.dependencies]
 black = "^24.1.1"