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

commonlib_reader-1.1.3/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.3
+Name: commonlib-reader
+Version: 1.1.3
+Summary: Reader for Equinor commonlib api.
+Author: Åsmund Våge Fannemel
+Author-email: Åsmund Våge Fannemel <asmf@equinor.com>
+License: MIT
+Requires-Dist: pandas>=2.1.4
+Requires-Dist: requests>=2.32.4
+Requires-Dist: urllib3>=2.5.0
+Requires-Dist: eq-api-connector>=1.0.0,<2.0.0
+Requires-Python: >=3.10, <4.0.0
+Project-URL: Repository, https://github.com/equinor/commonlib-reader.git
+Description-Content-Type: text/markdown
+
+# commonlib-reader
+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.
+
+
+## Use
+Try it out by running the [demo](examples/demo.py).
+
+## Installing
+
+Install package from pypi using `pip install commonlib_reader`
+
+
+## Developing / testing
+
+uv is preferred for developers. Clone and install with required packages for testing and coverage:
+`uv sync`
+
+For testing with coverage run:
+`uv run pytest --cov --cov-report=html`

{commonlib_reader-1.1.1 → commonlib_reader-1.1.3}/README.md

@@ -1,4 +1,4 @@
-# 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)
+# commonlib-reader
 Connector package for Equinor [Commonlib](https://commonlib.equinor.com/) [api](https://commonlibapi.equinor.com/swagger/index.html). 
 
 Current features:
@@ -19,8 +19,8 @@ Install package from pypi using `pip install commonlib_reader`
 
 ## Developing / testing
 
-Poetry is preferred for developers. Clone and install with required packages for testing and coverage:  
-`poetry install`
+uv is preferred for developers. Clone and install with required packages for testing and coverage:
+`uv sync`
 
-For testing with coverage run:  
-`poetry run pytest --cov --cov-report=html`
+For testing with coverage run:
+`uv run pytest --cov --cov-report=html`

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

@@ -1,6 +1,6 @@
 [project]
 name = "commonlib-reader"
-version = "1.1.1"
+version = "1.1.3"
 description = "Reader for Equinor commonlib api."
 authors = [
 	{ name = "Åsmund Våge Fannemel", email = "asmf@equinor.com" }
@@ -16,13 +16,13 @@ dependencies = [
 	"eq-api-connector (>=1.0.0,<2.0.0)"
 ]
 
-[tool.poetry.group.test.dependencies]
-pytest = "^7.4.4"
-pytest-cov = "^6.0.0"
-
-[tool.poetry.group.dev.dependencies]
-black = "^24.1.1"
+[dependency-groups]
+dev = [
+	"pytest>=7.4.4,<8.0.0",
+	"pytest-cov>=7.0.0,<8.0.0",
+	"black>=24.1.1,<27.0.0"
+]
 
 [build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+requires = ["uv_build>=0.11.16,<0.12"]
+build-backend = "uv_build"

{commonlib_reader-1.1.1 → commonlib_reader-1.1.3/src}/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.1 → commonlib_reader-1.1.3/src}/commonlib_reader/connector.py

@@ -1,6 +1,6 @@
 from eq_api_connector import APIConnector
 
-_connector = None
+_connector: APIConnector | None = None
 
 
 def get_connector() -> APIConnector:
@@ -13,17 +13,23 @@ def get_connector() -> APIConnector:
     if _connector is None:
         clientID = "728cfddd-b8e9-4ed7-b9a3-8f2fd5b8e79a"
         scopes = ["37d598fc-da0f-46bd-949f-7107918d47a5/user_impersonation"]
-        _connector = APIConnector(client_id=clientID, scope=scopes)
-        _connector.set_url_prod("https://commonlibapi.equinor.com/")
+        connector = APIConnector(client_id=clientID, scope=scopes)
+        connector.set_url_prod("https://commonlibapi.equinor.com/")
+        _connector = connector
 
     return _connector
 
 
-def set_connector(connector: APIConnector):
+def set_connector(connector: APIConnector) -> None:
     """Set the singleton instance of the APIConnector.
 
     Args:
         connector (APIConnector): An instance of the APIConnector class.
     """
     global _connector
+
+    if not isinstance(connector, APIConnector):
+        raise TypeError(
+            f"Connector must be an instance of APIConnector, got {type(connector).__name__}."
+        )
     _connector = connector

commonlib_reader-1.1.3/src/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.3/src}/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.3/src}/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.3/src}/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/PKG-INFO

@@ -1,49 +0,0 @@
-Metadata-Version: 2.4
-Name: commonlib-reader
-Version: 1.1.1
-Summary: Reader for Equinor commonlib api.
-License: MIT
-Author: Åsmund Våge Fannemel
-Author-email: asmf@equinor.com
-Requires-Python: >=3.10,<4.0.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-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.0,<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](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.
-
-
-## Use
-Try it out by running the [demo](examples/demo.py).
-
-## Installing
-
-Install package from pypi using `pip install commonlib_reader`
-
-
-## Developing / testing
-
-Poetry is preferred for developers. Clone and install with required packages for testing and coverage:  
-`poetry install`
-
-For testing with coverage run:  
-`poetry run pytest --cov --cov-report=html`
-