tagreader 6.0.1__tar.gz → 6.0.2__tar.gz

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

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: tagreader
-Version: 6.0.1
+Version: 6.0.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
 Keywords: Aspen InfoPlus.21,OSIsoft PI
 Author: Einar S. Idsø
@@ -22,20 +21,22 @@ 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: 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,<2025.0.0)
 Requires-Dist: diskcache (>=5.6.1,<6.0.0)
-Requires-Dist: matplotlib (>=3.7.0,<4.0.0) ; extra == "notebooks"
+Requires-Dist: matplotlib (>=3.7.5,<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: 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
 
@@ -54,7 +55,7 @@ as possible to the backend historians.
 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.
 
-```shell"
+```shell
 pip install tagreader
 ```
 
@@ -67,7 +68,7 @@ The following are required and will be installed:
 * 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.2}/README.md

@@ -13,7 +13,7 @@ as possible to the backend historians.
 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.
 
-```shell"
+```shell
 pip install tagreader
 ```
 
@@ -26,7 +26,7 @@ The following are required and will be installed:
 * 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.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tagreader"
-version = "6.0.1"
+version = "6.0.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,12 +30,12 @@ classifiers=[
 [tool.poetry.dependencies]
 python = "^3.8"
 pandas = ">=1"
-certifi = "^2024.7.4"
+certifi = "^2024.12.14"
 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 }
+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"

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

@@ -442,15 +442,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 +463,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(

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

@@ -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)
@@ -503,7 +496,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 +519,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 +555,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,6 +660,11 @@ 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
@@ -703,13 +704,26 @@ 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 = []
+            for i in parsed_dict["cols"]:
+                cols.append(i["n"])
+
+            rows = []
+
+            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):
@@ -777,6 +791,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 +803,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 +915,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 +971,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)