tagreader 6.0.1__tar.gz → 6.0.3__tar.gz

{tagreader-6.0.1 → tagreader-6.0.3}/PKG-INFO

@@ -1,13 +1,12 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: tagreader
-Version: 6.0.1
+Version: 6.0.3
 Summary: Tagreader is a Python package for reading trend data from the OSIsoft PI and Aspen Infoplus.21 IMS systems.
-Home-page: https://github.com/equinor/tagreader-python
 License: MIT
 Keywords: Aspen InfoPlus.21,OSIsoft PI
 Author: Einar S. Idsø
 Author-email: eiids@equinor.com
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9.2,<4.0.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
@@ -17,25 +16,27 @@ Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 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.8
+Classifier: Programming Language :: Python :: 3.9
 Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Utilities
 Provides-Extra: notebooks
-Requires-Dist: certifi (>=2024.7.4,<2025.0.0)
+Requires-Dist: certifi (>=2024.12.14,<2026.0.0)
 Requires-Dist: diskcache (>=5.6.1,<6.0.0)
-Requires-Dist: matplotlib (>=3.7.0,<4.0.0) ; extra == "notebooks"
-Requires-Dist: msal-bearer (>=0.2.1,<1.2.0)
-Requires-Dist: notebook (>=7.2.0,<8.0.0) ; extra == "notebooks"
+Requires-Dist: matplotlib (>=3.7.5,<4.0.0) ; extra == "notebooks"
+Requires-Dist: msal-bearer (>=1.3.0,<2.0.0)
+Requires-Dist: notebook (>=7.2.2,<8.0.0) ; extra == "notebooks"
 Requires-Dist: pandas (>=1)
 Requires-Dist: pycryptodome (>=3.20.0,<4.0.0)
 Requires-Dist: requests (>=2,<3)
 Requires-Dist: requests-kerberos (>=0,<1)
 Requires-Dist: requests-ntlm (>=1.1,<=2.0)
+Project-URL: Homepage, https://github.com/equinor/tagreader-python
 Project-URL: Repository, https://github.com/equinor/tagreader-python
 Description-Content-Type: text/markdown
 
@@ -47,27 +48,19 @@ Description-Content-Type: text/markdown
 [![Downloads](https://pepy.tech/badge/tagreader)](https://pepy.tech/project/tagreader)
 
 Tagreader is a Python package for reading timeseries data from the OSIsoft PI and Aspen Infoplus.21
-Information Manufacturing Systems (IMS) systems. It is intended to be easy to use, and present as similar interfaces
-as possible to the backend historians.
+Information Management Systems (IMS). It is intended to be easy to use, and present as similar interfaces
+as possible to the backend plant historians.
 
 ## Installation
 You can install tagreader directly into your project from pypi by using pip
-or another package manager. The only requirement is Python version 3.8 or above.
+or another package manager. Supports Python version 3.9.2 and above.
 
-```shell"
+```shell
 pip install tagreader
 ```
 
-The following are required and will be installed:
-
-* pandas
-* requests
-* requests-kerberos
-* certifi
-* diskcache
-
 ## Usage
-Tagreader easy to use for both Equinor internal IMS services, and non-internal usage. For non-internal usage
+Tagreader is easy to use for both Equinor internal IMS services, and non-internal usage. For non-internal usage
 you simply need to provide the corresponding IMS service URLs and IMSType.
 See [data source](https://equinor.github.io/tagreader-python/docs/about/usage/data-source) for details.
 

{tagreader-6.0.1 → tagreader-6.0.3}/README.md

@@ -6,27 +6,19 @@
 [![Downloads](https://pepy.tech/badge/tagreader)](https://pepy.tech/project/tagreader)
 
 Tagreader is a Python package for reading timeseries data from the OSIsoft PI and Aspen Infoplus.21
-Information Manufacturing Systems (IMS) systems. It is intended to be easy to use, and present as similar interfaces
-as possible to the backend historians.
+Information Management Systems (IMS). It is intended to be easy to use, and present as similar interfaces
+as possible to the backend plant historians.
 
 ## Installation
 You can install tagreader directly into your project from pypi by using pip
-or another package manager. The only requirement is Python version 3.8 or above.
+or another package manager. Supports Python version 3.9.2 and above.
 
-```shell"
+```shell
 pip install tagreader
 ```
 
-The following are required and will be installed:
-
-* pandas
-* requests
-* requests-kerberos
-* certifi
-* diskcache
-
 ## Usage
-Tagreader easy to use for both Equinor internal IMS services, and non-internal usage. For non-internal usage
+Tagreader is easy to use for both Equinor internal IMS services, and non-internal usage. For non-internal usage
 you simply need to provide the corresponding IMS service URLs and IMSType.
 See [data source](https://equinor.github.io/tagreader-python/docs/about/usage/data-source) for details.
 

{tagreader-6.0.1 → tagreader-6.0.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tagreader"
-version = "6.0.1"
+version = "6.0.3"
 description = "Tagreader is a Python package for reading trend data from the OSIsoft PI and Aspen Infoplus.21 IMS systems."
 authors = ["Einar S. Idsø <eiids@equinor.com>", "Morten Dæhli Aslesen <masl@equinor.com"]
 license = "MIT"
@@ -28,19 +28,18 @@ classifiers=[
 ]
 
 [tool.poetry.dependencies]
-python = "^3.8"
+python = "^3.9.2"
 pandas = ">=1"
-certifi = "^2024.7.4"
+certifi = ">=2024.12.14,<2026.0.0"
 requests = "^2"
 requests-kerberos = "^0"
-msal-bearer = ">=0.2.1,<1.2.0"
-notebook = { version = "^7.2.0", optional = true }
-matplotlib = { version = "^3.7.0", optional = true }
+msal-bearer = "^1.3.0"
+notebook = { version = "^7.2.2", optional = true }
+matplotlib = { version = "^3.7.5", optional = true }
 diskcache = "^5.6.1"
 pycryptodome = "^3.20.0"
 requests-ntlm = ">=1.1,<=2.0"
 
-
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^3"
 pytest = ">=7,<9"

{tagreader-6.0.1 → tagreader-6.0.3}/tagreader/clients.py

@@ -1,5 +1,5 @@
 import os
-from datetime import datetime, timedelta, tzinfo
+from datetime import datetime, timedelta, timezone, tzinfo
 from itertools import groupby
 from operator import itemgetter
 from typing import Any, Dict, List, Optional, Tuple, Union
@@ -128,6 +128,8 @@ def get_server_address_aspen(datasource: str) -> Optional[Tuple[str, int]]:
     host and port based on the path above and the UUID.
     """
 
+    # todo: is obsolete after removing ODBC
+
     if not is_windows():
         return None
     import winreg
@@ -168,6 +170,7 @@ def get_server_address_pi(datasource: str) -> Optional[Tuple[str, int]]:
     :return: host, port
     :type: tuple(string, int)
     """
+    # todo: is obsolete after removing ODBC
 
     if not is_windows():
         return None
@@ -442,15 +445,20 @@ class IMSClient:
             tags = [tags]
         units = {}
         for tag in tags:
-            if self.cache is not None:
-                r = self.cache.get_metadata(key=tag, properties="unit")
-                if r is not None and "unit" in r:
-                    units[tag] = r["unit"]
-            if tag not in units:
-                unit = self.handler._get_tag_unit(tag)
-                if self.cache is not None and unit is not None:
-                    self.cache.put_metadata(key=tag, value={"unit": unit})
-                units[tag] = unit
+            try:
+                if self.cache is not None:
+                    r = self.cache.get_metadata(key=tag, properties="unit")
+                    if r is not None and "unit" in r:
+                        units[tag] = r["unit"]
+                if tag not in units:
+                    unit = self.handler._get_tag_unit(tag)
+                    if self.cache is not None and unit is not None:
+                        self.cache.put_metadata(key=tag, value={"unit": unit})
+                    units[tag] = unit
+            except Exception:
+                if self.search(tag) == []:  # check for nonexisting string
+                    logger.warning(f"Tag not found: {tag}")
+                    continue
         return units
 
     def get_descriptions(self, tags: Union[str, List[str]]) -> Dict[str, str]:
@@ -458,15 +466,20 @@ class IMSClient:
             tags = [tags]
         descriptions = {}
         for tag in tags:
-            if self.cache is not None:
-                r = self.cache.get_metadata(key=tag, properties="description")
-                if r is not None and "description" in r:
-                    descriptions[tag] = r["description"]
-            if tag not in descriptions:
-                desc = self.handler._get_tag_description(tag)
-                if self.cache is not None and desc is not None:
-                    self.cache.put_metadata(key=tag, value={"description": desc})
-                descriptions[tag] = desc
+            try:
+                if self.cache is not None:
+                    r = self.cache.get_metadata(key=tag, properties="description")
+                    if r is not None and "description" in r:
+                        descriptions[tag] = r["description"]
+                if tag not in descriptions:
+                    desc = self.handler._get_tag_description(tag)
+                    if self.cache is not None and desc is not None:
+                        self.cache.put_metadata(key=tag, value={"description": desc})
+                    descriptions[tag] = desc
+            except Exception:
+                if self.search(tag) == []:  # check for nonexisting string
+                    logger.warning(f"Tag not found: {tag}")
+                    continue
         return descriptions
 
     def read_tags(
@@ -547,7 +560,7 @@ class IMSClient:
             except ValueError:
                 start = convert_to_pydatetime(start)
         if end is None:
-            end = datetime.utcnow()
+            end = datetime.now(timezone.utc)
         elif isinstance(end, (str, pd.Timestamp)):
             end = convert_to_pydatetime(end)
 

{tagreader-6.0.1 → tagreader-6.0.3}/tagreader/web_handlers.py

@@ -72,7 +72,7 @@ def get_auth_aspen(use_internal: bool = True):
     if use_internal:
         return HTTPKerberosAuth(mutual_authentication=OPTIONAL)
 
-    from msal_bearer.BearerAuth import BearerAuth
+    from msal_bearer import BearerAuth
 
     tenantID = "3aa4a235-b6e2-48d5-9195-7fcf05b459b0"
     clientID = "7adaaa99-897f-428c-8a5f-4053db565b32"
@@ -187,6 +187,7 @@ class BaseHandlerWeb(ABC):
         self.datasource = datasource
         self.base_url = url
         self.session = requests.Session()
+        self.auth = auth
         self.session.auth = auth if auth is not None else get_auth_aspen()
         if verify_ssl is False:
             urllib3.disable_warnings(InsecureRequestWarning)
@@ -222,14 +223,6 @@ class BaseHandlerWeb(ABC):
             txt = res.text.replace('"v":nan', '"v":NaN').replace('"v":-nan', '"v":NaN')
             return json.loads(txt)
 
-    def fetch_text(
-        self, url, params: Optional[Union[str, Dict[str, str]]] = None
-    ) -> str:
-        res = self.session.get(url, params=params)
-        res.raise_for_status()
-
-        return res.text
-
     def connect(self):
         try:
             self.verify_connection(self.datasource)
@@ -267,6 +260,7 @@ class AspenHandlerWeb(BaseHandlerWeb):
 
     @staticmethod
     def generate_connection_string(host, *_, **__):
+        # todo: is obsolete after removing ODBC
         raise NotImplementedError
 
     @staticmethod
@@ -503,7 +497,10 @@ class AspenHandlerWeb(BaseHandlerWeb):
             if not desc and not return_desc:
                 ret.append(tagname)
             else:
-                description = self._get_tag_description(tagname)
+                try:
+                    description = self._get_tag_description(tagname)
+                except KeyError:
+                    description = ""
                 ret.append((tagname, description))
 
         if not desc:
@@ -523,11 +520,11 @@ class AspenHandlerWeb(BaseHandlerWeb):
         query = self.generate_get_unit_query(tag)
         url = urljoin(self.base_url, "TagInfo")
         data = self.fetch(url, params=query)
-        try:
-            attr_data = data["data"]["tags"][0]["attrData"]
-        except KeyError as e:
-            logger.error(f"Error. I got this: {data}")
-            raise e
+        # try:
+        attr_data = data["data"]["tags"][0]["attrData"]
+        # except KeyError as e:
+        #     logger.error(f"Error. I got this: {data}")
+        #     raise e
         unit = ""
         for a in attr_data:
             if a["g"] == "Units":
@@ -559,8 +556,8 @@ class AspenHandlerWeb(BaseHandlerWeb):
         try:
             data = self.fetch(url, params=query)
             desc = data["data"]["tags"][0]["attrData"][0]["samples"][0]["v"]
-        except KeyError:
-            desc = ""
+        # except KeyError:
+        #     desc = ""
         except JSONDecodeError:
             desc = ""
         return desc
@@ -664,16 +661,23 @@ class AspenHandlerWeb(BaseHandlerWeb):
                 'dso="CHARINT=N;CHARFLOAT=N;CHARTIME=N;CONVERTERRORS=N" '
                 f'm="{max_rows}" to="30" s="1">'
             )
+        query = query.replace("\t", " ").replace(
+            "\n", " "
+        )  # Replace new lines and tabs that are typical in formatted SQL queries with spaces.
+
+        # Need a solution to LIKE comments. These have a % symbol in the query that does not seem to pass through the request
 
         connection_string += f"<![CDATA[{query}]]></SQL>"
         return connection_string
 
     def initialize_connection_string(
+        # todo: is obsolete after removing ODBC
         self,
         host: Optional[str] = None,
         port: int = 10014,
         connection_string: Optional[str] = None,
     ):
+        # todo: is obsolete after removing ODBC
         if connection_string:
             self._connection_string = connection_string
         else:
@@ -703,13 +707,27 @@ class AspenHandlerWeb(BaseHandlerWeb):
                 max_rows=self._max_rows,
                 datasource=None,
             )
-        res_text = self.fetch_text(url, params=params)
-        # For now just return result as text regardless of value of parse
+
+        res = self.session.get(url, params=params)
+        res.raise_for_status()
+
         if parse:
-            raise NotImplementedError(
-                "Use parse=False to receive and handle text result instead"
-            )
-        return res_text
+            parsed_dict = res.json()["data"][0]
+
+            cols = []
+            if "cols" in parsed_dict.keys():
+                for i in parsed_dict["cols"]:
+                    cols.append(i["n"])
+
+            rows = []
+            if "rows" in parsed_dict.keys():
+                for i in parsed_dict["rows"]:
+                    element = []
+                    for j in i["fld"]:
+                        element.append(j["v"])
+                    rows.append(element)
+            return pd.DataFrame(data=rows, columns=cols)
+        return res.text
 
 
 class PIHandlerWeb(BaseHandlerWeb):
@@ -742,6 +760,7 @@ class PIHandlerWeb(BaseHandlerWeb):
 
     @staticmethod
     def generate_connection_string(host, *_, **__):
+        # todo: is obsolete after removing ODBC
         raise NotImplementedError
 
     @staticmethod
@@ -777,6 +796,7 @@ class PIHandlerWeb(BaseHandlerWeb):
         tag: Optional[str],
         desc: Optional[str],
         datasource: Optional[str],
+        auth: Optional[Any] = None,
     ) -> Dict[str, str]:
         q = []
         if tag is not None:
@@ -788,7 +808,7 @@ class PIHandlerWeb(BaseHandlerWeb):
 
         if datasource is not None:
             params["dataserverwebid"] = (
-                f"{get_piwebapi_source_to_webid_dict()[datasource]}"
+                f"{get_piwebapi_source_to_webid_dict(auth=auth)[datasource]}"
             )
 
         return params
@@ -900,7 +920,7 @@ class PIHandlerWeb(BaseHandlerWeb):
         return_desc: bool = True,
     ) -> Union[List[Tuple[str, str]], List[str]]:
         params = self.generate_search_params(
-            tag=tag, desc=desc, datasource=self.datasource
+            tag=tag, desc=desc, datasource=self.datasource, auth=self.auth
         )
         url = urljoin(self.base_url, "points", "search")
         done = False
@@ -956,7 +976,7 @@ class PIHandlerWeb(BaseHandlerWeb):
             return self.web_id_cache[tag]
 
         params = self.generate_search_params(
-            tag=tag, datasource=self.datasource, desc=None
+            tag=tag, datasource=self.datasource, desc=None, auth=self.auth
         )
         url = urljoin(self.base_url, "points", "search")
         data = self.fetch(url, params=params)