commonlib-reader 1.1.1__tar.gz → 1.1.2__tar.gz

{commonlib_reader-1.1.1 → commonlib_reader-1.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commonlib-reader
-Version: 1.1.1
+Version: 1.1.2
 Summary: Reader for Equinor commonlib api.
 License: MIT
 Author: Åsmund Våge Fannemel

{commonlib_reader-1.1.1 → commonlib_reader-1.1.2}/commonlib_reader/__init__.py

@@ -1,17 +1,18 @@
 from commonlib_reader.utils import (
     get_code,
     get_code_param,
-    get_disciplines,
     get_library_names,
 )
 
 
+from .discipline import Discipline
 from .tag import TagType, TagCategory, TagFormat
 from .ims import IMS
 from .facility import Facility
 from .unit import Unit
 
 __all__ = [
+    "Discipline",
     "Facility",
     "IMS",
     "TagType",
@@ -20,6 +21,5 @@ __all__ = [
     "Unit",
     "get_code",
     "get_code_param",
-    "get_disciplines",
     "get_library_names",
 ]

commonlib_reader-1.1.2/commonlib_reader/discipline.py

@@ -0,0 +1,64 @@
+from typing import List
+
+from commonlib_reader.utils import get_code
+
+
+class Discipline:
+    def __init__(self, data: dict):
+        if not isinstance(data, dict):
+            raise ValueError("Input data shall be dictionary.")
+
+        self._data = data
+
+    def __eq__(self, other):
+        if isinstance(other, Discipline):
+            return self._data == other._data
+
+        return False
+
+    def __str__(self):
+        return f"Discipline: {self.name}-{self.description}"
+
+    @property
+    def name(self) -> str:
+        return self._data.get("name", "")
+
+    @property
+    def description(self) -> str:
+        return self._data.get("description", "")
+
+    @property
+    def identity(self) -> str:
+        return self._data.get("identity", "")
+
+    @property
+    def is_valid(self) -> bool:
+        return self._data.get("isValid", False)
+
+    @classmethod
+    def get_all(cls, scope: str, only_valid: bool = True) -> List["Discipline"]:
+        """Get all disciplines for
+
+        Raises:
+            ValueError: _description_
+
+        Returns:
+            List["Discipline"]: List of discipline objects
+        """
+        dis_data = get_code("Discipline", scope=scope)
+
+        if not isinstance(dis_data, list) or not all(
+            isinstance(x, dict) for x in dis_data
+        ):
+            raise ValueError("Invalid discipline data from api")
+
+        if len(dis_data) == 0:
+            raise ValueError(
+                f"No discipline data found for scope {scope}. Verify that scope is correct."
+            )
+
+        dis = [Discipline(x) for x in dis_data]  # type: ignore
+        if only_valid:
+            dis = [x for x in dis if x.is_valid]
+
+        return sorted(dis, key=lambda d: d.identity)

{commonlib_reader-1.1.1 → commonlib_reader-1.1.2}/commonlib_reader/facility.py

@@ -227,12 +227,12 @@ class Facility:
     def get_sap_facilities(cls) -> List["Facility"]:
         fac = cls.get_all_facilities()
         return [f for f in fac if len(f.sap) > 0]
-    
+
     @classmethod
     def get_ioc_facilities(cls) -> List["Facility"]:
         fac = cls.get_all_facilities()
         return [f for f in fac if len(f.ioc_plant) > 0]
-    
+
     @classmethod
     def get_gov_facilities(cls) -> List["Facility"]:
         fac = cls.get_all_facilities()

{commonlib_reader-1.1.1 → commonlib_reader-1.1.2}/commonlib_reader/tag.py

@@ -140,7 +140,7 @@ class TagFormat:
     def __str__(self):
         return f"{self.description} - {self.tag_category}"
 
-    def is_valid(self, tagNo: str):
+    def is_valid(self, tagNo: str) -> bool:
         """Check if input tag number matches this tag format.
         Args:
             tagNo (str): Tag number to check.
@@ -148,7 +148,7 @@ class TagFormat:
             bool: True if tag number matches this tag format, else False.
         """
 
-        return re.fullmatch(self.regex, tagNo)
+        return bool(re.fullmatch(self.regex, tagNo))
 
     def get_id(self) -> int:
         """Get tagformat identity.

{commonlib_reader-1.1.1 → commonlib_reader-1.1.2}/commonlib_reader/utils.py

@@ -7,15 +7,15 @@ import requests
 from commonlib_reader.connector import get_connector
 
 
-def get_library_names():
+def get_library_names() -> list[str]:
     library_names = get_connector().get_json(url="/api/Library/NameList")
-    if isinstance(library_names, list):
-        library_names.sort()
-    return library_names
+    if isinstance(library_names, list) and all(
+        [isinstance(x, str) for x in library_names]
+    ):
+        library_names.sort()  # type: ignore
+        return library_names  # type: ignore
 
-
-def get_disciplines():
-    return get_code("Discipline")
+    raise ValueError("Wrong data from API when getting library names.")
 
 
 def get_code(code: str, scope: Optional[str] = None, name: Optional[str] = None):
@@ -29,6 +29,15 @@ def get_code(code: str, scope: Optional[str] = None, name: Optional[str] = None)
 
 
 def get_code_param(code, params=None):
+    """_summary_
+
+    Args:
+        code (_type_): _description_
+        params (_type_, optional): _description_. Defaults to None.
+
+    Returns:
+        _type_: _description_
+    """
     if params is None:
         params = {}
 

{commonlib_reader-1.1.1 → commonlib_reader-1.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "commonlib-reader"
-version = "1.1.1"
+version = "1.1.2"
 description = "Reader for Equinor commonlib api."
 authors = [
 	{ name = "Åsmund Våge Fannemel", email = "asmf@equinor.com" }