tagreader 5.1.0__tar.gz → 5.1.2__tar.gz

{tagreader-5.1.0 → tagreader-5.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tagreader
-Version: 5.1.0
+Version: 5.1.2
 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
@@ -21,18 +21,16 @@ 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: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Utilities
 Provides-Extra: notebooks
 Requires-Dist: certifi (>=2023.7.22,<2024.0.0)
-Requires-Dist: cryptography (>=41.0.3,<42.0.0)
 Requires-Dist: diskcache (>=5.6.1,<6.0.0)
 Requires-Dist: matplotlib (>=3,<4) ; extra == "notebooks"
 Requires-Dist: notebook (>=7.0.3,<8.0.0) ; extra == "notebooks"
 Requires-Dist: pandas (>=1)
-Requires-Dist: pillow (==10.0.1)
-Requires-Dist: pyodbc (>=4,<5)
 Requires-Dist: requests (>=2,<3)
 Requires-Dist: requests-kerberos (>=0,<1)
 Project-URL: Repository, https://github.com/equinor/tagreader-python
@@ -78,6 +76,8 @@ print(c.search("tag*"))
 df = c.read_tags(["tag1", "tag2"], "18.06.2020 08:00:00", "18.06.2020 09:00:00", 60)
 ```
 
+Note, you can add a timeout argument to the search method in order to avoid long-running search queries.
+
 ### Jupyter Notebook Quickstart
 Jupyter Notebook examples can be found in /examples. In order to run these examples, you need to install the
 optional dependencies.
@@ -90,10 +90,9 @@ The quickstart Jupyter Notebook can be found [here](https://github.com/equinor/t
 
 For more details, see the [Tagreader Docs](https://equinor.github.io/tagreader-python/).
 
-## Contribute
-As Tagreader is an open source project, all contributions are welcome. This includes code, bug reports, issues,
-feature requests, and documentation. The preferred way of submitting a contribution is to either create an issue on
-GitHub or to fork the project and make a pull request.
+## Documentation
+The full documentation can be found in [Tagreader Docs](https://equinor.github.io/tagreader-python/)
 
-For starting contributing, see the [contribute section](https://equinor.github.io/tagreader-python/docs/contribute/overview)
+## Contribute
+To starting contributing, please see [Tagreader Docs - Contribute](https://equinor.github.io/tagreader-python/docs/contribute/overview)
 

{tagreader-5.1.0 → tagreader-5.1.2}/README.md

@@ -38,6 +38,8 @@ print(c.search("tag*"))
 df = c.read_tags(["tag1", "tag2"], "18.06.2020 08:00:00", "18.06.2020 09:00:00", 60)
 ```
 
+Note, you can add a timeout argument to the search method in order to avoid long-running search queries.
+
 ### Jupyter Notebook Quickstart
 Jupyter Notebook examples can be found in /examples. In order to run these examples, you need to install the
 optional dependencies.
@@ -50,9 +52,8 @@ The quickstart Jupyter Notebook can be found [here](https://github.com/equinor/t
 
 For more details, see the [Tagreader Docs](https://equinor.github.io/tagreader-python/).
 
-## Contribute
-As Tagreader is an open source project, all contributions are welcome. This includes code, bug reports, issues,
-feature requests, and documentation. The preferred way of submitting a contribution is to either create an issue on
-GitHub or to fork the project and make a pull request.
+## Documentation
+The full documentation can be found in [Tagreader Docs](https://equinor.github.io/tagreader-python/)
 
-For starting contributing, see the [contribute section](https://equinor.github.io/tagreader-python/docs/contribute/overview)
+## Contribute
+To starting contributing, please see [Tagreader Docs - Contribute](https://equinor.github.io/tagreader-python/docs/contribute/overview)

{tagreader-5.1.0 → tagreader-5.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tagreader"
-version = "5.1.0"
+version = "5.1.2"
 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"
@@ -30,15 +30,12 @@ classifiers=[
 [tool.poetry.dependencies]
 python = "^3.8"
 pandas = ">=1"
-pyodbc = "^4"
-cryptography = "^41.0.3"
 certifi = "^2023.7.22"
 requests = "^2"
 requests-kerberos = "^0"
 notebook = { version = "^7.0.3", optional = true }
 matplotlib = { version = "^3", optional = true }
 diskcache = "^5.6.1"
-pillow = "10.0.1"  # Fix dependency to avoid vulnerability
 
 
 [tool.poetry.group.dev.dependencies]

{tagreader-5.1.0 → tagreader-5.1.2}/tagreader/clients.py

@@ -5,6 +5,7 @@ from operator import itemgetter
 from typing import Any, Dict, List, Optional, Tuple, Union
 from urllib.error import HTTPError
 
+import numpy as np
 import pandas as pd
 import pytz
 
@@ -199,6 +200,7 @@ def get_handler(
     options: Dict[str, Union[int, float, str]],
     verifySSL: Optional[bool],
     auth: Optional[Any],
+    cache: Optional[Union[SmartCache, BucketCache]] = None,
 ):
     if imstype is None:
         try:
@@ -224,6 +226,7 @@ def get_handler(
             options=options,
             verify_ssl=verifySSL,
             auth=auth,
+            cache=cache,
         )
 
     if imstype == IMSType.ASPENONE:
@@ -278,6 +281,7 @@ class IMSClient:
                 f"timezone argument 'tz' needs to be either a valid timezone string or a tzinfo-object. Given type was {type(tz)}"
             )
 
+        self.cache = cache
         self.handler = get_handler(
             imstype=imstype,
             datasource=datasource,
@@ -285,22 +289,28 @@ class IMSClient:
             options=handler_options,
             verifySSL=verifySSL,
             auth=auth,
+            cache=self.cache,
         )
-        self.cache = cache
 
     def connect(self) -> None:
         self.handler.connect()
 
     def search_tag(
-        self, tag: Optional[str] = None, desc: Optional[str] = None
+        self,
+        tag: Optional[str] = None,
+        desc: Optional[str] = None,
+        timeout: Optional[int] = None,
     ) -> List[Tuple[str, str]]:
         logger.warning("This function is deprecated. Please call 'search()' instead")
-        return self.search(tag=tag, desc=desc)
+        return self.search(tag=tag, desc=desc, timeout=timeout)
 
     def search(
-        self, tag: Optional[str] = None, desc: Optional[str] = None
+        self,
+        tag: Optional[str] = None,
+        desc: Optional[str] = None,
+        timeout: Optional[int] = None,
     ) -> List[Tuple[str, str]]:
-        return self.handler.search(tag=tag, desc=desc)
+        return self.handler.search(tag=tag, desc=desc, timeout=timeout)
 
     def _get_metadata(self, tag: str):
         return self.handler._get_tag_metadata(
@@ -487,7 +497,7 @@ class IMSClient:
         tags: Union[str, List[str]],
         start_time: Optional[Union[datetime, pd.Timestamp, str]] = None,
         end_time: Optional[Union[datetime, pd.Timestamp, str]] = None,
-        ts: Union[timedelta, pd.Timedelta, int] = timedelta(seconds=60),
+        ts: Optional[Union[timedelta, pd.Timedelta, int]] = timedelta(seconds=60),
         read_type: ReaderType = ReaderType.INT,
         get_status: bool = False,
     ) -> pd.DataFrame:
@@ -540,8 +550,26 @@ class IMSClient:
 
         if isinstance(ts, pd.Timedelta):
             ts = ts.to_pytimedelta()
-        elif isinstance(ts, (int, float)):
+        elif isinstance(
+            ts,
+            (
+                int,
+                float,
+                np.int32,
+                np.int64,
+                np.float32,
+                np.float64,
+                np.number,
+                np.integer,
+            ),
+        ):
             ts = timedelta(seconds=int(ts))
+        elif not ts and read_type not in [ReaderType.SNAPSHOT, ReaderType.RAW]:
+            raise ValueError(
+                "ts needs to be a timedelta or an integer (number of seconds)"
+                " unless you are reading raw or snapshot data."
+                f" Given type: {type(ts)}"
+            )
         elif not isinstance(ts, timedelta):
             raise ValueError(
                 "ts needs to be either a None, timedelta or and integer (number of seconds)."

{tagreader-5.1.0 → tagreader-5.1.2}/tagreader/utils.py

@@ -130,7 +130,7 @@ class ReaderType(enum.IntEnum):
 
 
 def add_statoil_root_certificate() -> bool:
-    return add_equinor_root_certificate(True) and add_equinor_root_certificate(False)
+    return add_equinor_root_certificate(True) or add_equinor_root_certificate(False)
 
 
 def add_equinor_root_certificate(get_equinor: bool = True) -> bool:

{tagreader-5.1.0 → tagreader-5.1.2}/tagreader/web_handlers.py

@@ -14,7 +14,7 @@ import requests
 import urllib3
 from requests_kerberos import OPTIONAL, HTTPKerberosAuth
 
-from tagreader.cache import BaseCache
+from tagreader.cache import BaseCache, BucketCache, SmartCache
 from tagreader.logger import logger
 from tagreader.utils import ReaderType, is_mac, is_windows, urljoin
 
@@ -115,8 +115,20 @@ class BaseHandlerWeb(ABC):
             urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
         self.session.verify = verify_ssl if verify_ssl is not None else get_verify_ssl()
 
-    def fetch(self, url, params: Optional[Union[str, Dict[str, str]]] = None) -> Dict:
-        res = self.session.get(url, params=params)
+    def fetch(
+        self,
+        url,
+        params: Optional[Union[str, Dict[str, str]]] = None,
+        timeout: Optional[int] = None,
+    ) -> Dict:
+        res = self.session.get(
+            url,
+            params=params,
+            timeout=(
+                None,
+                timeout,
+            ),
+        )  # Noqa. Read timeout, No connect timeout.
         res.raise_for_status()
 
         if len(res.text) == 0:
@@ -366,7 +378,9 @@ class AspenHandlerWeb(BaseHandlerWeb):
             if v:
                 return k
 
-    def search(self, tag: Optional[str], desc: Optional[str]) -> List[Tuple[str, str]]:
+    def search(
+        self, tag: Optional[str], desc: Optional[str], timeout: Optional[int] = None
+    ) -> List[Tuple[str, str]]:
         if tag is None:
             raise ValueError("Tag is a required argument")
 
@@ -386,7 +400,7 @@ class AspenHandlerWeb(BaseHandlerWeb):
         )
         url = urljoin(self.base_url, "Browse?")
         url += encoded_params
-        data = self.fetch(url)
+        data = self.fetch(url, timeout=timeout)
 
         if "tags" not in data["data"]:
             return []
@@ -602,6 +616,7 @@ class PIHandlerWeb(BaseHandlerWeb):
         auth: Optional[Any],
         verify_ssl: bool,
         options: Dict[str, Union[int, float, str]],
+        cache: Optional[Union[SmartCache, BucketCache]],
     ):
         self._max_rows = options.get("max_rows", 10000)
         if url is None:
@@ -615,7 +630,7 @@ class PIHandlerWeb(BaseHandlerWeb):
             verify_ssl=verify_ssl,
         )
         self._max_rows = options.get("max_rows", 10000)
-        self.web_id_cache = BaseCache(directory=Path(".") / ".cache" / datasource)
+        self.web_id_cache = cache
 
     @staticmethod
     def _time_to_UTC_string(time: datetime) -> str:
@@ -772,7 +787,10 @@ class PIHandlerWeb(BaseHandlerWeb):
         return False
 
     def search(
-        self, tag: Optional[str] = None, desc: Optional[str] = None
+        self,
+        tag: Optional[str] = None,
+        desc: Optional[str] = None,
+        timeout: Optional[int] = None,
     ) -> List[Tuple]:
         params = self.generate_search_query(
             tag=tag, desc=desc, datasource=self.datasource
@@ -781,7 +799,7 @@ class PIHandlerWeb(BaseHandlerWeb):
         done = False
         ret = []
         while not done:
-            data = self.fetch(url, params=params)
+            data = self.fetch(url, params=params, timeout=timeout)
 
             for item in data["Items"]:
                 description = item["Description"] if "Description" in item else ""
@@ -823,33 +841,37 @@ class PIHandlerWeb(BaseHandlerWeb):
         :return: WebId
         :rtype: str
         """
-        if tag not in self.web_id_cache:
-            params = self.generate_search_query(
-                tag=tag, datasource=self.datasource, desc=None
-            )
-            params["fields"] = "name;webid"
-            url = urljoin(self.base_url, "search", "query")
-            data = self.fetch(url, params=params)
-
-            if len(data["Errors"]) > 0:
-                msg = f"Received error from server when searching for WebId for {tag}: {data['Errors']}"
-                raise ValueError(msg)
-
-            if len(data["Items"]) > 1:
-                # Compare elements and if same, return the first
-                first = data["Items"][0]
-                for item in data["Items"][1:]:
-                    if item != first:
-                        raise AssertionError(
-                            f"Received {len(data['Items'])} results when trying to find unique WebId for {tag}."
-                        )
-            elif len(data["Items"]) == 0:
-                logger.warning(f"Tag {tag} not found")
-                return None
-
-            web_id = data["Items"][0]["WebId"]
+        if self.web_id_cache and tag in self.web_id_cache:
+            return self.web_id_cache[tag]
+
+        params = self.generate_search_query(
+            tag=tag, datasource=self.datasource, desc=None
+        )
+        params["fields"] = "name;webid"
+        url = urljoin(self.base_url, "search", "query")
+        data = self.fetch(url, params=params)
+
+        if len(data["Errors"]) > 0:
+            msg = f"Received error from server when searching for WebId for {tag}: {data['Errors']}"
+            raise ValueError(msg)
+
+        if len(data["Items"]) > 1:
+            # Compare elements and if same, return the first
+            first = data["Items"][0]
+            for item in data["Items"][1:]:
+                if item != first:
+                    raise AssertionError(
+                        f"Received {len(data['Items'])} results when trying to find unique WebId for {tag}."
+                    )
+        elif len(data["Items"]) == 0:
+            logger.warning(f"Tag {tag} not found")
+            return None
+
+        web_id = data["Items"][0]["WebId"]
+
+        if self.web_id_cache:
             self.web_id_cache[tag] = web_id
-        return self.web_id_cache[tag]
+        return web_id
 
     @staticmethod
     def _is_summary(read_type: ReaderType) -> bool: