tagreader 5.1.3__tar.gz → 5.2.0__tar.gz

{tagreader-5.1.3 → tagreader-5.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tagreader
-Version: 5.1.3
+Version: 5.2.0
 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
@@ -29,10 +29,13 @@ Provides-Extra: notebooks
 Requires-Dist: certifi (>=2023.7.22,<2024.0.0)
 Requires-Dist: diskcache (>=5.6.1,<6.0.0)
 Requires-Dist: matplotlib (>=3,<4) ; extra == "notebooks"
+Requires-Dist: msal-bearer (>=0.1.0,<0.2.0)
 Requires-Dist: notebook (>=7.0.3,<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.2.0,<2.0.0)
 Project-URL: Repository, https://github.com/equinor/tagreader-python
 Description-Content-Type: text/markdown
 

{tagreader-5.1.3 → tagreader-5.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tagreader"
-version = "5.1.3"
+version = "5.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"]
 license = "MIT"
@@ -33,9 +33,12 @@ pandas = ">=1"
 certifi = "^2023.7.22"
 requests = "^2"
 requests-kerberos = "^0"
+msal-bearer = "^0.1.0"
 notebook = { version = "^7.0.3", optional = true }
 matplotlib = { version = "^3", optional = true }
 diskcache = "^5.6.1"
+pycryptodome = "^3.20.0"
+requests-ntlm = "^1.2.0"
 
 
 [tool.poetry.group.dev.dependencies]

{tagreader-5.1.3 → tagreader-5.2.0}/tagreader/clients.py

@@ -300,7 +300,7 @@ class IMSClient:
         tag: Optional[str] = None,
         desc: Optional[str] = None,
         timeout: Optional[int] = None,
-    ) -> List[Tuple[str, str]]:
+    ) -> Union[List[Tuple[str, str]], List[str]]:
         logger.warning("This function is deprecated. Please call 'search()' instead")
         return self.search(tag=tag, desc=desc, timeout=timeout)
 
@@ -309,8 +309,11 @@ class IMSClient:
         tag: Optional[str] = None,
         desc: Optional[str] = None,
         timeout: Optional[int] = None,
-    ) -> List[Tuple[str, str]]:
-        return self.handler.search(tag=tag, desc=desc, timeout=timeout)
+        return_desc: bool = True,
+    ) -> Union[List[Tuple[str, str]], List[str]]:
+        return self.handler.search(
+            tag=tag, desc=desc, timeout=timeout, return_desc=return_desc
+        )
 
     def _get_metadata(self, tag: str):
         return self.handler._get_tag_metadata(

{tagreader-5.1.3 → tagreader-5.2.0}/tagreader/utils.py

@@ -171,13 +171,12 @@ def add_equinor_root_certificate(get_equinor: bool = True) -> bool:
         logger.debug("Scanning CA certificate in Windows cert store", end="")
         for cert in ssl.enum_certificates("CA"):
             der = cert[0]
+            # deepcode ignore InsecureHash: <Only hashes to compare with known hash>
             if hashlib.sha1(der).hexdigest().upper() == used_hash:
                 found = True
                 logger.debug("CA certificate found!")
                 break
     elif is_mac():
-        import subprocess
-
         macos_ca_certs = subprocess.run(
             ["security", "find-certificate", "-a", "-c", ca_search, "-Z"],
             stdout=subprocess.PIPE,
@@ -186,6 +185,7 @@ def add_equinor_root_certificate(get_equinor: bool = True) -> bool:
         if used_hash in str(macos_ca_certs).upper():
             c = get_macos_equinor_certificates()
             for cert in c:
+                # deepcode ignore InsecureHash: <Only hashes to compare with known hash>
                 if hashlib.sha1(cert).hexdigest().upper() == used_hash:
                     der = cert
                     found = True
@@ -260,6 +260,7 @@ def is_equinor() -> bool:
 
         host = 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):

{tagreader-5.1.3 → tagreader-5.2.0}/tagreader/web_handlers.py

@@ -1,10 +1,11 @@
+import hashlib
 import json
 import re
 import urllib.parse
 from abc import ABC, abstractmethod
 from datetime import datetime, timedelta
+from hashlib import new as hashlib_new_method
 from json.decoder import JSONDecodeError
-from pathlib import Path
 from typing import Any, Dict, List, Optional, Tuple, Union
 
 import numpy as np
@@ -12,13 +13,42 @@ import pandas as pd
 import pytz
 import requests
 import urllib3
+from Crypto.Hash import MD4 as _MD4
 from requests_kerberos import OPTIONAL, HTTPKerberosAuth
+from urllib3.exceptions import InsecureRequestWarning
 
-from tagreader.cache import BaseCache, BucketCache, SmartCache
+from tagreader.cache import BucketCache, SmartCache
 from tagreader.logger import logger
 from tagreader.utils import ReaderType, is_mac, is_windows, urljoin
 
 
+class MD4:
+    def __init__(self, data=None):
+        self._hash_obj = _MD4.new()
+        if data is not None:
+            self._hash_obj.update(data)
+
+    def update(self, data):
+        self._hash_obj.update(data)
+
+    def digest(self):
+        return self._hash_obj.digest()
+
+    def hexdigest(self):
+        return self._hash_obj.hexdigest()
+
+
+def patched_hashlib_new(name, data=b""):
+    if name.lower() == "md4":
+        return MD4(data)
+    else:
+        return hashlib_new_method(name, data)
+
+
+# Monkey-patch md4 in hashlib.new due to missing support for md4 in later releases of Python:
+hashlib.new = patched_hashlib_new
+
+
 def get_verify_ssl() -> Union[bool, str]:
     if is_windows() or is_mac():
         return True
@@ -33,13 +63,28 @@ def get_url_pi() -> str:
     return r"https://piwebapi.equinor.com/piwebapi"
 
 
-def get_auth_aspen() -> HTTPKerberosAuth:
-    return HTTPKerberosAuth(mutual_authentication=OPTIONAL)
+def get_auth_aspen(use_internal: bool = True):
+    if use_internal:
+        return HTTPKerberosAuth(mutual_authentication=OPTIONAL)
+
+    from msal_bearer.BearerAuth import BearerAuth
+
+    tenantID = "3aa4a235-b6e2-48d5-9195-7fcf05b459b0"
+    clientID = "7adaaa99-897f-428c-8a5f-4053db565b32"
+    scopes = [
+        "https://ewepwapa1pep04-statoilsrm.msappproxy.net/ProcessExplorer/ProcessData//user_impersonation"
+    ]
+    return BearerAuth.get_auth(
+        tenantID=tenantID, clientID=clientID, scopes=scopes, verbose=True
+    )
 
 
-def get_url_aspen() -> str:
-    # internal url (redirects to dll)
-    return r"https://aspenone.api.equinor.com"
+def get_url_aspen(use_internal: bool = False) -> str:
+    if use_internal:
+        # internal url (redirects to url including AtProcessDataREST.dll)
+        return r"https://aspenone.api.equinor.com"
+
+    return r"https://ewepwapa1pep04-statoilsrm.msappproxy.net/ProcessExplorer/ProcessData/AtProcessDataREST.dll"
 
 
 def list_aspenone_sources(
@@ -57,7 +102,7 @@ def list_aspenone_sources(
         verify_ssl = get_verify_ssl()
 
     if verify_ssl is False:
-        urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+        urllib3.disable_warnings(InsecureRequestWarning)
 
     url_ = urljoin(url, "DataSources")
     params = {"service": "ProcessData", "allQuotes": 1}
@@ -86,7 +131,7 @@ def list_piwebapi_sources(
         verify_ssl = get_verify_ssl()
 
     if verify_ssl is False:
-        urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+        urllib3.disable_warnings(InsecureRequestWarning)
 
     url_ = urljoin(url, "dataservers")
     res = requests.get(url_, auth=auth, verify=verify_ssl)
@@ -112,7 +157,7 @@ class BaseHandlerWeb(ABC):
         self.session = requests.Session()
         self.session.auth = auth if auth is not None else get_auth_aspen()
         if verify_ssl is False:
-            urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+            urllib3.disable_warnings(InsecureRequestWarning)
         self.session.verify = verify_ssl if verify_ssl is not None else get_verify_ssl()
 
     def fetch(
@@ -162,8 +207,7 @@ class BaseHandlerWeb(ABC):
             ) from None
 
     @abstractmethod
-    def verify_connection(self, datasource: str):
-        ...
+    def verify_connection(self, datasource: str): ...
 
 
 class AspenHandlerWeb(BaseHandlerWeb):
@@ -379,8 +423,24 @@ class AspenHandlerWeb(BaseHandlerWeb):
                 return k
 
     def search(
-        self, tag: Optional[str], desc: Optional[str], timeout: Optional[int] = None
-    ) -> List[Tuple[str, str]]:
+        self,
+        tag: Optional[str],
+        desc: Optional[str],
+        timeout: Optional[int] = None,
+        return_desc: bool = True,
+    ) -> Union[List[Tuple[str, str]], List[str]]:
+        ret = []
+
+        if tag is None and desc is None:
+            raise ValueError("Tag is a required argument")
+            # return ret
+        elif tag is None and len(desc) == 0:
+            raise ValueError("Tag is a required argument")
+            # return ret
+        elif desc is None and len(tag) == 0:
+            raise ValueError("Tag is a required argument")
+            # return ret
+
         if tag is None:
             raise ValueError("Tag is a required argument")
 
@@ -403,19 +463,24 @@ class AspenHandlerWeb(BaseHandlerWeb):
         data = self.fetch(url, timeout=timeout)
 
         if "tags" not in data["data"]:
-            return []
+            return ret
 
-        ret = []
         for item in data["data"]["tags"]:
             tagname = item["t"]
-            description = self._get_tag_description(tagname)
-            ret.append((tagname, description))
+            if not desc and not return_desc:
+                ret.append(tagname)
+            else:
+                description = self._get_tag_description(tagname)
+                ret.append((tagname, description))
 
         if not desc:
-            return ret
+            pass
+        else:
+            r = re.compile(desc)
+            ret = [x for x in ret if r.search(x[1])]
+            if not return_desc:
+                ret = [x[0] for x in ret]
 
-        r = re.compile(desc)
-        ret = [x for x in ret if r.search(x[1])]
         return ret
 
     def _get_tag_metadata(self, tag: str):
@@ -791,7 +856,8 @@ class PIHandlerWeb(BaseHandlerWeb):
         tag: Optional[str] = None,
         desc: Optional[str] = None,
         timeout: Optional[int] = None,
-    ) -> List[Tuple]:
+        return_desc: bool = True,
+    ) -> Union[List[Tuple[str, str]], List[str]]:
         params = self.generate_search_query(
             tag=tag, desc=desc, datasource=self.datasource
         )
@@ -809,6 +875,10 @@ class PIHandlerWeb(BaseHandlerWeb):
                 params["start"] = next_start  # noqa
             else:
                 done = True
+
+        if not return_desc:
+            ret = [x[0] for x in ret]
+
         return ret
 
     def _get_tag_metadata(self, tag: str) -> Dict[str, str]: