tagreader 6.1.0__tar.gz → 6.2.1__tar.gz

{tagreader-6.1.0 → tagreader-6.2.1}/PKG-INFO

@@ -1,8 +1,9 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: tagreader
-Version: 6.1.0
+Version: 6.2.1
 Summary: Tagreader is a Python package for reading trend data from the OSIsoft PI and Aspen Infoplus.21 IMS systems.
-License: MIT
+License-Expression: MIT
+License-File: LICENSE
 Keywords: Aspen InfoPlus.21,OSIsoft PI
 Author: Einar S. Idsø
 Author-email: eiids@equinor.com
@@ -36,6 +37,10 @@ Project-URL: Homepage, https://github.com/equinor/tagreader-python
 Project-URL: Repository, https://github.com/equinor/tagreader-python
 Description-Content-Type: text/markdown
 
+⚠️ **Important:** **We are phasing out TagReader, and the code will no longer be maintained.**
+
+  For employees in Equinor we recommend using Omnia Timeseries
+
 # tagreader-python <!-- omit in toc -->
 
 ![GitHub Build Status](https://github.com/equinor/tagreader-python/workflows/Test/badge.svg)
@@ -85,6 +90,3 @@ For more details, see the [Tagreader Docs](https://equinor.github.io/tagreader-p
 ## Documentation
 The full documentation can be found in [Tagreader Docs](https://equinor.github.io/tagreader-python/)
 
-## Contribute
-To starting contributing, please see [Tagreader Docs - Contribute](https://equinor.github.io/tagreader-python/docs/contribute/overview)
-

{tagreader-6.1.0 → tagreader-6.2.1}/README.md

@@ -1,3 +1,7 @@
+⚠️ **Important:** **We are phasing out TagReader, and the code will no longer be maintained.**
+
+  For employees in Equinor we recommend using Omnia Timeseries
+
 # tagreader-python <!-- omit in toc -->
 
 ![GitHub Build Status](https://github.com/equinor/tagreader-python/workflows/Test/badge.svg)
@@ -46,6 +50,3 @@ For more details, see the [Tagreader Docs](https://equinor.github.io/tagreader-p
 
 ## Documentation
 The full documentation can be found in [Tagreader Docs](https://equinor.github.io/tagreader-python/)
-
-## Contribute
-To starting contributing, please see [Tagreader Docs - Contribute](https://equinor.github.io/tagreader-python/docs/contribute/overview)

{tagreader-6.1.0 → tagreader-6.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "tagreader"
-version = "6.1.0"
+version = "6.2.1"
 description = "Tagreader is a Python package for reading trend data from the OSIsoft PI and Aspen Infoplus.21 IMS systems."
 authors = [
     { name = "Einar S. Idsø", email = "eiids@equinor.com" },

{tagreader-6.1.0 → tagreader-6.2.1}/tagreader/cache.py

@@ -1,9 +1,8 @@
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from pathlib import Path
 from typing import Dict, List, Optional, Tuple, Union, cast
 
 import pandas as pd
-import pytz
 from diskcache import Cache
 
 from tagreader.logger import logger
@@ -21,7 +20,7 @@ def safe_tagname(tagname: str) -> str:
 def timestamp_to_epoch(timestamp: datetime) -> int:
     origin = datetime(1970, 1, 1)
     if timestamp.tzinfo is not None:
-        timestamp = timestamp.astimezone(pytz.utc).replace(tzinfo=None)
+        timestamp = timestamp.astimezone(timezone.utc).replace(tzinfo=None)
     return (timestamp - origin) // timedelta(seconds=1)
 
 

{tagreader-6.1.0 → tagreader-6.2.1}/tagreader/clients.py

@@ -2,11 +2,11 @@ from datetime import datetime, timedelta, timezone, tzinfo
 from itertools import groupby
 from operator import itemgetter
 from typing import Any, Dict, List, Optional, Tuple, Union
-from urllib.error import HTTPError
+from zoneinfo import ZoneInfo, ZoneInfoNotFoundError
 
 import numpy as np
 import pandas as pd
-import pytz
+import requests
 
 from tagreader.cache import BucketCache, SmartCache
 from tagreader.logger import logger
@@ -21,11 +21,12 @@ from tagreader.web_handlers import (
     PIHandlerWeb,
     get_auth_aspen,
     get_auth_pi,
+    get_url_aspen,
     list_aspenone_sources,
     list_piwebapi_sources,
 )
 
-NONE_START_TIME = datetime(1970, 1, 1, tzinfo=pytz.UTC)
+NONE_START_TIME = datetime(1970, 1, 1, tzinfo=timezone.utc)
 
 
 def list_sources(
@@ -49,8 +50,6 @@ def list_sources(
             auth = get_auth_pi()
         return list_piwebapi_sources(url=url, auth=auth, verify_ssl=verify_ssl)
     elif imstype == IMSType.ASPENONE:
-        if auth is None:
-            auth = get_auth_aspen()
         return list_aspenone_sources(url=url, auth=auth, verify_ssl=verify_ssl)
     elif imstype in [IMSType.PI, IMSType.ASPEN, IMSType.IP21]:
         raise ValueError(
@@ -121,24 +120,41 @@ def get_handler(
     url: Optional[str],
     options: Dict[str, Union[int, float, str]],
     verify_ssl: Optional[Union[bool, str]],
-    auth: Optional[Any],
+    auth: Optional[Any] = None,
     cache: Optional[Union[SmartCache, BucketCache]] = None,
 ):
     if imstype is None:
+        orig_auth = auth
+        orig_url = url
         try:
-            if datasource in list_aspenone_sources(
+            aspen_source = list_aspenone_sources(
                 url=None, auth=None, verify_ssl=verify_ssl
-            ):
-                imstype = IMSType.ASPENONE
-        except HTTPError as e:
-            logger.debug(f"Could not list Aspenone sources: {e}")
+            )
+        except (requests.exceptions.HTTPError, requests.exceptions.ConnectionError):
+            # Try again using app registration auth
+            try:
+                auth = get_auth_aspen(False)
+                url = get_url_aspen(False)
+                aspen_source = list_aspenone_sources(
+                    auth=auth, url=url, verify_ssl=verify_ssl
+                )
+            except requests.exceptions.HTTPError as e:
+                logger.debug(f"Could not list Aspenone sources: {e}")
+                aspen_source = []
+
+        if datasource in aspen_source:
+            imstype = IMSType.ASPENONE
+        else:
+            auth = orig_auth
+            url = orig_url
+
     if imstype is None:
         try:
             if datasource in list_piwebapi_sources(
                 url=None, auth=None, verify_ssl=verify_ssl
             ):
                 imstype = IMSType.PIWEBAPI
-        except HTTPError as e:
+        except requests.exceptions.HTTPError as e:
             logger.debug(f"Could not list PI sources: {e}")
 
     if imstype == IMSType.PIWEBAPI:
@@ -175,7 +191,7 @@ class IMSClient:
         self,
         datasource: str,
         imstype: Optional[Union[str, IMSType]] = None,
-        tz: Union[tzinfo, str] = pytz.timezone("Europe/Oslo"),
+        tz: Optional[Union[tzinfo, str]] = None,
         url: Optional[str] = None,
         handler_options: Dict[str, Union[int, float, str]] = {},  # noqa:
         verify_ssl: Optional[Union[bool, str]] = True,
@@ -191,11 +207,15 @@ class IMSClient:
                     f" We suggest to use the tagreader.IMSType enumerator when initiating a client."
                 )
 
+        if tz is None or tz == "":
+            tz = ZoneInfo("Europe/Oslo")
         if isinstance(tz, str):
-            if tz in pytz.all_timezones:
-                self.tz = pytz.timezone(tz)
-            else:
-                raise ValueError(f"Invalid timezone string  Given type was {type(tz)}")
+            try:
+                self.tz = ZoneInfo(tz)
+            except ZoneInfoNotFoundError:
+                raise ValueError(
+                    f"Invalid timezone string. Given tz was {tz}"
+                ) from None
         elif isinstance(tz, tzinfo):
             self.tz = tz
         else:

{tagreader-6.1.0 → tagreader-6.2.1}/tagreader/utils.py

@@ -3,14 +3,14 @@ import hashlib
 import platform
 import socket
 import ssl
-from datetime import datetime, tzinfo
+from datetime import datetime, timezone, tzinfo
 from enum import Enum
 from pathlib import Path
-from typing import Union
+from typing import Optional, Union
+from zoneinfo import ZoneInfo, ZoneInfoNotFoundError
 
 import certifi
 import pandas as pd
-import pytz
 import requests
 from platformdirs import user_data_dir
 
@@ -50,12 +50,24 @@ def convert_to_pydatetime(date_stamp: Union[datetime, str, pd.Timestamp]) -> dat
 
 def ensure_datetime_with_tz(
     date_stamp: Union[datetime, str, pd.Timestamp],
-    tz: tzinfo = pytz.timezone("Europe/Oslo"),
+    tz: Optional[tzinfo] = None,
 ) -> datetime:
+    if tz is None:
+        try:
+            tz = ZoneInfo("Europe/Oslo")
+        except ZoneInfoNotFoundError:
+            logger.warning(
+                "Unable to load timezone 'Europe/Oslo'. Falling back to UTC."
+            )
+            tz = timezone.utc
     date_stamp = convert_to_pydatetime(date_stamp)
 
     if not date_stamp.tzinfo:
-        date_stamp = tz.localize(date_stamp)
+        localize = getattr(tz, "localize", None)
+        if callable(localize):
+            date_stamp = localize(date_stamp)
+        else:
+            date_stamp = date_stamp.replace(tzinfo=tz)
 
     return date_stamp
 
@@ -117,7 +129,7 @@ def add_equinor_root_certificate() -> bool:
         logger.debug(
             "Unable to locate Equinor Root CA certificate on this host. Downloading from Equinor server."
         )
-        response = requests.get("http://pki.equinor.com/aia/ecpr.crt")
+        response = requests.get("http://pki.equinor.com/aia/ecpr.crt", timeout=20)
 
         if response.status_code != 200:
             logger.error(
@@ -230,7 +242,8 @@ def is_equinor() -> bool:
         if hostname.lower().startswith("eqdev") or hostname.lower().startswith("eqpc"):
             return True
         with winreg.OpenKey(  # type: ignore
-            winreg.HKEY_LOCAL_MACHINE, r"SYSTEM\ControlSet001\Services\Tcpip\Parameters"  # type: ignore
+            winreg.HKEY_LOCAL_MACHINE,
+            r"SYSTEM\ControlSet001\Services\Tcpip\Parameters",  # type: ignore
         ) as key:
             domain = winreg.QueryValueEx(key, "Domain")  # type: ignore
             if "statoil" in domain[0] or "equinor" in domain[0]:
@@ -282,7 +295,7 @@ def is_equinor() -> bool:
                 return True
 
             s = subprocess.run(
-                ["security", "find-certificate", "-a", "-c" "client.statoil.net"],
+                ["security", "find-certificate", "-a", "-cclient.statoil.net"],
                 stdout=subprocess.PIPE,
             ).stdout
 

{tagreader-6.1.0 → tagreader-6.2.1}/tagreader/web_handlers.py

@@ -3,14 +3,13 @@ import json
 import re
 import urllib.parse
 from abc import ABC, abstractmethod
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from hashlib import new as hashlib_new_method
 from json.decoder import JSONDecodeError
 from typing import Any, Dict, List, Optional, Tuple, Union
 
 import numpy as np
 import pandas as pd
-import pytz
 import requests
 import urllib3
 from Crypto.Hash import MD4 as _MD4
@@ -107,7 +106,7 @@ def list_aspenone_sources(
     url_ = urljoin(url, "DataSources")
     params = {"service": "ProcessData", "allQuotes": 1}
 
-    res = requests.get(url_, params=params, auth=auth, verify=verify_ssl)
+    res = requests.get(url_, params=params, auth=auth, verify=verify_ssl, timeout=300)
     res.raise_for_status()
     try:
         source_list = [r["n"] for r in res.json()["data"] if r["t"] == "IP21"]
@@ -115,6 +114,8 @@ def list_aspenone_sources(
     except JSONDecodeError as e:
         logger.error(f"Could not decode JSON response: {e}")
 
+    return []
+
 
 def list_piwebapi_sources(
     url: Optional[str] = None,
@@ -134,7 +135,7 @@ def list_piwebapi_sources(
         urllib3.disable_warnings(InsecureRequestWarning)
 
     url_ = urljoin(url, "dataservers")
-    res = requests.get(url_, auth=auth, verify=verify_ssl)
+    res = requests.get(url_, auth=auth, verify=verify_ssl, timeout=300)
 
     res.raise_for_status()
     try:
@@ -143,6 +144,8 @@ def list_piwebapi_sources(
     except JSONDecodeError as e:
         logger.error(f"Could not decode JSON response: {e}")
 
+    return []
+
 
 def get_piwebapi_source_to_webid_dict(
     url: Optional[str] = None,
@@ -162,7 +165,7 @@ def get_piwebapi_source_to_webid_dict(
         urllib3.disable_warnings(InsecureRequestWarning)
 
     url_ = urljoin(url, "dataservers")
-    res = requests.get(url_, auth=auth, verify=verify_ssl)
+    res = requests.get(url_, auth=auth, verify=verify_ssl, timeout=300)
 
     res.raise_for_status()
     try:
@@ -170,6 +173,8 @@ def get_piwebapi_source_to_webid_dict(
     except JSONDecodeError as e:
         logger.error(f"Could not decode JSON response: {e}")
 
+    return []
+
 
 class BaseHandlerWeb(ABC):
     def __init__(
@@ -316,12 +321,12 @@ class AspenHandlerWeb(BaseHandlerWeb):
         else:
             query = '<Q f="d" allQuotes="1">'
 
-        query += "<Tag>" f"<N><![CDATA[{tagname}]]></N>"
+        query += f"<Tag><N><![CDATA[{tagname}]]></N>"
 
         if mapname:
             query += f"<M><![CDATA[{mapname}]]></M>"
 
-        query += f"<D><![CDATA[{self.datasource}]]></D>" "<F><![CDATA[VAL]]></F>"
+        query += f"<D><![CDATA[{self.datasource}]]></D><F><![CDATA[VAL]]></F>"
 
         if read_type == ReaderType.SNAPSHOT:
             query += "<VS>1</VS>"
@@ -437,7 +442,7 @@ class AspenHandlerWeb(BaseHandlerWeb):
         return ret
 
     def _get_default_mapname(self, tagname: str):
-        (tagname, _) = self.split_tagmap(tagname)
+        tagname, _ = self.split_tagmap(tagname)
         all_maps = self._get_maps(tagname)
         for k, v in all_maps.items():
             if v:
@@ -729,7 +734,7 @@ class PIHandlerWeb(BaseHandlerWeb):
 
     @staticmethod
     def _time_to_UTC_string(time: datetime) -> str:
-        return time.astimezone(pytz.UTC).strftime("%d-%b-%y %H:%M:%S")
+        return time.astimezone(timezone.utc).strftime("%d-%b-%y %H:%M:%S")
 
     @staticmethod
     def escape(s: str) -> str:
@@ -843,10 +848,10 @@ class PIHandlerWeb(BaseHandlerWeb):
         if self._is_summary(read_type):
             params["selectedFields"] = "Links;Items.Value.Timestamp;Items.Value.Value"
             if get_status:
-                params["selectedFields"] += (
-                    ";Items.Value.Good"
-                    ";Items.Value.Questionable"
-                    ";Items.Value.Substituted"
+                params[
+                    "selectedFields"
+                ] += (
+                    ";Items.Value.Good;Items.Value.Questionable;Items.Value.Substituted"
                 )
         elif read_type in [ReaderType.INT, ReaderType.RAW, ReaderType.SHAPEPRESERVING]:
             params["selectedFields"] = "Links;Items.Timestamp;Items.Value"
@@ -994,7 +999,7 @@ class PIHandlerWeb(BaseHandlerWeb):
         if not web_id:
             return pd.DataFrame()
 
-        (url, params) = self.generate_read_query(
+        url, params = self.generate_read_query(
             tag=web_id,
             start=start,
             end=end,