tagreader 6.0.4__tar.gz → 6.2.0__tar.gz

{tagreader-6.0.4 → tagreader-6.2.0}/PKG-INFO

@@ -1,8 +1,9 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: tagreader
-Version: 6.0.4
+Version: 6.2.0
 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
@@ -15,28 +16,23 @@ Classifier: Natural Language :: English
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python :: 3
+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.12.14,<2026.0.0)
-Requires-Dist: diskcache (>=5.6.1,<6.0.0)
-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: diskcache (>=5.6.1)
+Requires-Dist: msal-bearer (>=1.3.3)
 Requires-Dist: pandas (>=1)
-Requires-Dist: platformdirs (>=4.3.7,<5.0.0)
-Requires-Dist: pycryptodome (>=3.20.0,<4.0.0)
-Requires-Dist: requests (>=2,<3)
-Requires-Dist: requests-kerberos (>=0,<1)
+Requires-Dist: platformdirs (>=4.3.7)
+Requires-Dist: pycryptodome (>=3.20.0)
+Requires-Dist: requests (>=2.32.5)
+Requires-Dist: requests-kerberos (>=0)
 Requires-Dist: requests-ntlm (>=1.1,<=2.0)
+Requires-Dist: urllib3 (>=2.5.0)
 Project-URL: Homepage, https://github.com/equinor/tagreader-python
 Project-URL: Repository, https://github.com/equinor/tagreader-python
 Description-Content-Type: text/markdown

{tagreader-6.0.4 → tagreader-6.2.0}/pyproject.toml

@@ -1,14 +1,15 @@
-[tool.poetry]
+[project]
 name = "tagreader"
-version = "6.0.4"
+version = "6.2.0"
 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"]
+authors = [
+    { name = "Einar S. Idsø", email = "eiids@equinor.com" },
+    { name = "Morten Dæhli Aslesen", email = "masl@equinor.com" }
+]
 license = "MIT"
 readme = "README.md"
-packages = [{include = "tagreader"}]
 keywords=["Aspen InfoPlus.21", "OSIsoft PI"]
-homepage = "https://github.com/equinor/tagreader-python"
-repository = "https://github.com/equinor/tagreader-python"
+requires-python = ">=3.9.2,<4.0.0"
 classifiers=[
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
@@ -18,36 +19,39 @@ classifiers=[
     "Operating System :: MacOS",
     "Operating System :: Microsoft :: Windows",
     "Operating System :: POSIX :: Linux",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator",
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Utilities",
 ]
+dependencies = [
+    "pandas>=1",
+    "certifi>=2024.12.14,<2026.0.0",
+    "requests>=2.32.5",
+    "requests-kerberos>=0",
+    "msal-bearer>=1.3.3",
+    "diskcache>=5.6.1",
+    "pycryptodome>=3.20.0",
+    "requests-ntlm>=1.1,<=2.0",
+    "platformdirs>=4.3.7",
+    "urllib3>=2.5.0" # To avoid security issue https://www.cve.org/CVERecord?id=CVE-2025-50182
+]
 
-[tool.poetry.dependencies]
-python = "^3.9.2"
-pandas = ">=1"
-certifi = ">=2024.12.14,<2026.0.0"
-requests = "^2"
-requests-kerberos = "^0"
-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"
-platformdirs = "^4.3.7"
+[tool.poetry.group.test.dependencies]
+pytest = ">=7,<9"
+# pytest-cov = ">=6.0.0"
 
 [tool.poetry.group.dev.dependencies]
-pre-commit = "^3"
-pytest = ">=7,<9"
+# "black>=24.1.1",
+pre-commit = ">=3.0"
 
-[tool.poetry.extras]
-notebooks = ["notebook", "matplotlib"]
+[project.urls]
+homepage = "https://github.com/equinor/tagreader-python"
+repository = "https://github.com/equinor/tagreader-python"
 
 [build-system]
-requires = ["poetry-core"]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
 build-backend = "poetry.core.masonry.api"

{tagreader-6.0.4 → tagreader-6.2.0}/tagreader/__init__.py

@@ -4,11 +4,18 @@ from tagreader.utils import (
     ReaderType,
     add_equinor_root_certificate,
     is_equinor,
-    is_mac,
-    is_windows,
 )
 
 if is_equinor():
     add_equinor_root_certificate()
 
 from tagreader.__version__ import version as __version__
+
+__all__ = [
+    "IMSClient",
+    "list_sources",
+    "IMSType",
+    "ReaderType",
+    "add_equinor_root_certificate",
+    "__version__",
+]

{tagreader-6.0.4 → tagreader-6.2.0}/tagreader/clients.py

@@ -32,7 +32,7 @@ def list_sources(
     imstype: Union[IMSType, str],
     url: Optional[str] = None,
     auth: Optional[Any] = None,
-    verifySSL: bool = True,
+    verify_ssl: Optional[Union[bool, str]] = True,
 ) -> List[str]:
     if isinstance(imstype, str):
         try:
@@ -47,11 +47,11 @@ def list_sources(
     if imstype == IMSType.PIWEBAPI:
         if auth is None:
             auth = get_auth_pi()
-        return list_piwebapi_sources(url=url, auth=auth, verify_ssl=verifySSL)
+        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=verifySSL)
+        return list_aspenone_sources(url=url, auth=auth, verify_ssl=verify_ssl)
     elif imstype in [IMSType.PI, IMSType.ASPEN, IMSType.IP21]:
         raise ValueError(
             f"ODBC clients are no longer supported. Given ims client type: {imstype}."
@@ -120,14 +120,14 @@ def get_handler(
     datasource: str,
     url: Optional[str],
     options: Dict[str, Union[int, float, str]],
-    verifySSL: Optional[bool],
+    verify_ssl: Optional[Union[bool, str]],
     auth: Optional[Any],
     cache: Optional[Union[SmartCache, BucketCache]] = None,
 ):
     if imstype is None:
         try:
             if datasource in list_aspenone_sources(
-                url=None, auth=None, verify_ssl=verifySSL
+                url=None, auth=None, verify_ssl=verify_ssl
             ):
                 imstype = IMSType.ASPENONE
         except HTTPError as e:
@@ -135,7 +135,7 @@ def get_handler(
     if imstype is None:
         try:
             if datasource in list_piwebapi_sources(
-                url=None, auth=None, verify_ssl=verifySSL
+                url=None, auth=None, verify_ssl=verify_ssl
             ):
                 imstype = IMSType.PIWEBAPI
         except HTTPError as e:
@@ -146,7 +146,7 @@ def get_handler(
             url=url,
             datasource=datasource,
             options=options,
-            verify_ssl=verifySSL,
+            verify_ssl=verify_ssl,
             auth=auth,
             cache=cache,
         )
@@ -156,7 +156,7 @@ def get_handler(
             datasource=datasource,
             url=url,
             options=options,
-            verify_ssl=verifySSL,
+            verify_ssl=verify_ssl,
             auth=auth,
         )
     elif imstype in [IMSType.PI, IMSType.ASPEN, IMSType.IP21]:
@@ -178,7 +178,7 @@ class IMSClient:
         tz: Union[tzinfo, str] = pytz.timezone("Europe/Oslo"),
         url: Optional[str] = None,
         handler_options: Dict[str, Union[int, float, str]] = {},  # noqa:
-        verifySSL: bool = True,
+        verify_ssl: Optional[Union[bool, str]] = True,
         auth: Optional[Any] = None,
         cache: Optional[Union[SmartCache, BucketCache]] = None,
     ):
@@ -209,7 +209,7 @@ class IMSClient:
             datasource=datasource,
             url=url,
             options=handler_options,
-            verifySSL=verifySSL,
+            verify_ssl=verify_ssl,
             auth=auth,
             cache=self.cache,
         )
@@ -412,7 +412,7 @@ class IMSClient:
     ):
         start = start_time
         end = stop_time
-        logger.warn(
+        logger.warning(
             (
                 "This function has been renamed to read() and is deprecated. "
                 "Please call 'read()' instead"

{tagreader-6.0.4 → tagreader-6.2.0}/tagreader/utils.py

@@ -1,7 +1,7 @@
 import enum
 import hashlib
-import logging
 import platform
+import socket
 import ssl
 from datetime import datetime, tzinfo
 from enum import Enum
@@ -33,7 +33,6 @@ if is_windows():
     import winreg
 
 if is_mac():
-    import socket
     import subprocess
 
 
@@ -118,7 +117,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(
@@ -145,6 +144,7 @@ def add_equinor_root_certificate() -> bool:
     with open(ca_file, "ab") as f:
         f.write(bytes(certificate, "ascii"))
     logger.debug("Equinor Root Certificate added to certifi store")
+    return True
 
 
 def find_local_equinor_root_certificate() -> str:
@@ -153,7 +153,7 @@ def find_local_equinor_root_certificate() -> str:
 
     if is_windows():
         logger.debug("Checking for Equinor Root CA in Windows certificate store")
-        for cert in ssl.enum_certificates("CA"):
+        for cert in ssl.enum_certificates("CA"):  # type: ignore
             found_cert = cert[0]
             # deepcode ignore InsecureHash: <Only hashes to compare with known hash>
             if hashlib.sha1(found_cert).hexdigest().upper() == equinor_root_pem_hash:
@@ -189,6 +189,9 @@ def get_macos_equinor_certificates():
     import ssl
     import tempfile
 
+    if not is_mac():
+        raise OSError("Function only works on MacOS")
+
     ca_search = "Equinor Root CA"
 
     ctx = ssl.create_default_context()
@@ -210,37 +213,84 @@ def is_equinor() -> bool:
     If Windows host:
     Finds host's domain in Windows Registry at
     HKLM\\SYSTEM\\ControlSet001\\Services\\Tcpip\\Parameters\\Domain
+    or check if hostname starts with eqdev or eqpc
     If mac os host:
-    Finds statoil.net as AD hostname in certificates
+    Finds statoil.net as AD hostname in certificates or
+    Finds statoil.net, client.statoil.net or equinor.com in dns search domains
     If Linux host:
-    Checks whether statoil.no is search domain
+    Checks whether statoil.no is dns search domains
 
     Returns:
         bool: True if Equinor
     """
-    if is_windows():
-        with winreg.OpenKey(
-            winreg.HKEY_LOCAL_MACHINE, r"SYSTEM\ControlSet001\Services\Tcpip\Parameters"
-        ) as key:
-            domain = winreg.QueryValueEx(key, "Domain")
-        if "statoil" in domain[0]:
-            return True
-    elif is_mac():
-        s = subprocess.run(
-            ["security", "find-certificate", "-a", "-c" "client.statoil.net"],
-            stdout=subprocess.PIPE,
-        ).stdout
 
-        host = socket.gethostname()
+    hostname = socket.gethostname()
 
-        # deepcode ignore IdenticalBranches: Not an error. First test is just more precise.
-        if host + ".client.statoil.net" in str(s):
-            return True
-        elif "client.statoil.net" in host and host in str(s):
+    if is_windows():
+        if hostname.lower().startswith("eqdev") or hostname.lower().startswith("eqpc"):
             return True
-    elif is_linux():
+        with winreg.OpenKey(  # 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]:
+                return True
+    elif is_linux() or is_mac():
         with open("/etc/resolv.conf", "r") as f:
-            if "statoil.no" in f.read():
+            if any(
+                domain in f.read()
+                for domain in ["client.statoil.net", "statoil.net", "equinor.com"]
+            ):
+                return True
+
+        if is_mac():
+
+            def get_mac_dns_search_list():
+                """
+                Retrieves the DNS search list configured on macOS.
+                """
+                try:
+                    # Execute the scutil command to get DNS configuration
+                    result = subprocess.run(
+                        ["scutil", "--dns"], capture_output=True, text=True, check=True
+                    )
+                    output = result.stdout
+
+                    search_list = []
+                    # Parse the output to find the search domains
+                    for line in output.splitlines():
+                        if "search domain" in line:
+                            # Extract the domain from the line
+                            parts = line.split(":")
+                            if len(parts) > 1:
+                                domain = parts[1].strip()
+                                # Remove any leading/trailing quotes if present
+                                domain = domain.strip('"')
+                                search_list.append(domain)
+                    return search_list
+                except subprocess.CalledProcessError as e:
+                    print(f"Error executing scutil: {e}")
+                    return []
+                except Exception as e:
+                    print(f"An unexpected error occurred: {e}")
+                    return []
+
+            if any(
+                domain in get_mac_dns_search_list()
+                for domain in ["client.statoil.net", "statoil.net", "equinor.com"]
+            ):
+                return True
+
+            s = subprocess.run(
+                ["security", "find-certificate", "-a", "-cclient.statoil.net"],
+                stdout=subprocess.PIPE,
+            ).stdout
+
+            # deepcode ignore IdenticalBranches: Not an error. First test is just more precise.
+            if hostname + ".client.statoil.net" in str(s):
+                return True
+            elif "client.statoil.net" in hostname and hostname in str(s):
                 return True
     else:
         raise OSError(

{tagreader-6.0.4 → tagreader-6.2.0}/tagreader/web_handlers.py

@@ -42,12 +42,7 @@ def patched_hashlib_new(name, data=b"", usedforsecurity=True):
     if name.lower() == "md4":
         return MD4(data)
     else:
-        # Try / Catch easier than detecting python version
-        try:
-            return hashlib_new_method(name, data=data, usedforsecurity=usedforsecurity)
-        except TypeError:
-            # Required for python 3.8
-            return hashlib_new_method(name, data=data)
+        return hashlib_new_method(name, data=data, usedforsecurity=usedforsecurity)
 
 
 # Monkey-patch md4 in hashlib.new due to missing support for md4 in later releases of Python:
@@ -95,7 +90,7 @@ def get_url_aspen(use_internal: bool = True) -> str:
 def list_aspenone_sources(
     url: Optional[str] = None,
     auth: Optional[Any] = None,
-    verify_ssl: Optional[bool] = True,
+    verify_ssl: Optional[Union[bool, str]] = True,
 ) -> List[str]:
     if url is None:
         url = get_url_aspen()
@@ -112,7 +107,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"]
@@ -124,7 +119,7 @@ def list_aspenone_sources(
 def list_piwebapi_sources(
     url: Optional[str] = None,
     auth: Optional[Any] = None,
-    verify_ssl: Optional[bool] = True,
+    verify_ssl: Optional[Union[bool, str]] = True,
 ) -> List[str]:
     if url is None:
         url = get_url_pi()
@@ -139,7 +134,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:
@@ -152,7 +147,7 @@ def list_piwebapi_sources(
 def get_piwebapi_source_to_webid_dict(
     url: Optional[str] = None,
     auth: Optional[Any] = None,
-    verify_ssl: Optional[bool] = True,
+    verify_ssl: Optional[Union[bool, str]] = True,
 ) -> List[str]:
     if url is None:
         url = get_url_pi()
@@ -167,7 +162,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:
@@ -182,7 +177,7 @@ class BaseHandlerWeb(ABC):
         datasource: Optional[str],
         url: Optional[str],
         auth: Optional[Any],
-        verify_ssl: Optional[bool],
+        verify_ssl: Optional[Union[bool, str]],
     ):
         self.datasource = datasource
         self.base_url = url
@@ -213,6 +208,10 @@ class BaseHandlerWeb(ABC):
             logger.warning(f"No data found for {url} {params}")
             return {}
 
+        if res.text.startswith("XML Error"):
+            logger.warning(f"Invalid data returned for {url} {params}")
+            return {}
+
         try:
             return res.json()
         except JSONDecodeError:
@@ -241,7 +240,7 @@ class AspenHandlerWeb(BaseHandlerWeb):
         datasource: Optional[str],
         url: Optional[str] = None,
         auth: Optional[Any] = None,
-        verify_ssl: Optional[bool] = True,
+        verify_ssl: Optional[Union[bool, str]] = True,
         options: Dict[str, Any] = dict(),
     ):
         if url is None:
@@ -317,12 +316,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>"
@@ -710,7 +709,7 @@ class PIHandlerWeb(BaseHandlerWeb):
         url: Optional[str],
         datasource: Optional[str],
         auth: Optional[Any],
-        verify_ssl: bool,
+        verify_ssl: Optional[Union[bool, str]],
         options: Dict[str, Union[int, float, str]],
         cache: Optional[Union[SmartCache, BucketCache]],
     ):
@@ -844,10 +843,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"