automizor 0.4.3__py3-none-any.whl → 0.4.5__py3-none-any.whl

automizor/__init__.py

@@ -1 +1 @@
-version = "0.4.3"
+version = "0.4.5"

automizor/datastore/__init__.py

@@ -0,0 +1,115 @@
+import sys
+import types
+from functools import lru_cache
+
+from ._datastore import JSON
+
+
+@lru_cache
+def _get_datastore():
+    from ._datastore import DataStore
+
+    return DataStore()
+
+
+class DataStoreProxy(types.ModuleType):
+    """
+    `DataStoreProxy` acts as a dynamic interface for interacting with various types of
+    data stores within the `Automizor Platform`. It provides a convenient way to access
+    and manipulate data stored in JSON and Key-Key-Value (KKV) formats.
+
+    This class leverages the `Automizor DataStore` module to fetch and update data,
+    utilizing a caching mechanism to enhance performance. The primary interaction is
+    through attribute access and assignment, making it simple to work with different
+    data structures.
+
+    The `DataStoreProxy` dynamically determines the type of data store being accessed
+    and adapts its behavior accordingly. For JSON data stores, it directly retrieves
+    values. For KKV stores, it provides a wrapper function that facilitates more complex
+    data retrieval operations based on primary and secondary keys.
+
+    Example usage:
+
+        .. code-block:: python
+
+            from automizor import datastore
+
+            # Initialize or update json store
+            datastore.countries = {
+                "US": {
+                    "name": "United States",
+                    "capital": "Washington, D.C.",
+                    "population": 331449281,
+                    "area": 9833520
+                },
+                "CA": {
+                    "name": "Canada",
+                    "capital": "Ottawa",
+                    "population": 38005238,
+                    "area": 9984670
+                }
+            }
+
+            # Get values from json store
+            countries = datastore.countries
+
+            # Initialize or update kkv store
+            datastore.movies = {
+                "US": {
+                    "action": {
+                        "Die Hard": 1988,
+                        "The Matrix": 1999
+                    }
+                }
+            }
+
+            # Get values from kkv store
+            movies = datastore.movies("US")
+            movies_action = datastore.movies("US", "action")
+
+            # Insert or update values
+            datastore.movies = {
+                "US": {
+                    "action": {
+                        "Die Hard": 1988,
+                        "The Matrix": 1999,
+                        "John Wick": 2014
+                    },
+                    "comedy": {
+                        "The Hangover": 2009,
+                        "Superbad": 2007
+                    }
+                }
+            }
+
+            # Delete secondary key
+            datastore.movies = {
+                "US": {
+                    "action": None
+                }
+            }
+
+            # Delete primary key
+            datastore.movies = {
+                "US": None
+            }
+
+    """
+
+    def __getattr__(self, name):
+        datastore = _get_datastore()
+        datastore_type = datastore.type(name)
+
+        def wrapper(primary_key=None, secondary_key=None):
+            return datastore.get_values(name, primary_key, secondary_key)
+
+        if datastore_type == "JSONDataStore":
+            return datastore.get_values(name)
+        return wrapper
+
+    def __setattr__(self, name, values: JSON):
+        datastore = _get_datastore()
+        datastore.set_values(name, values)
+
+
+sys.modules[__name__] = DataStoreProxy(__name__)

automizor/datastore/_datastore.py

@@ -0,0 +1,121 @@
+from typing import Dict, List, Union
+
+import requests
+
+from automizor.exceptions import AutomizorError
+from automizor.utils import get_api_config, get_headers
+
+JSON = Union[str, int, float, bool, None, Dict[str, "JSON"], List["JSON"]]
+
+
+class DataStore:
+    """
+    `DataStore` is a class designed to interface with the `Automizor Platform` to manage and
+    manipulate data stored in various formats. It supports operations to retrieve and update
+    data using a unified API.
+
+    The class initializes an HTTP session with the necessary headers for authentication, and
+    provides methods to get the type of data store, retrieve values, and set values in the store.
+
+    Attributes:
+        url (str): The base URL for the API endpoint.
+        token (str): The authentication token for API access.
+        session (requests.Session): The HTTP session used for making API requests.
+    """
+
+    def __init__(self):
+        self.url, self.token = get_api_config()
+        self.session = requests.Session()
+        self.session.headers.update(get_headers(self.token))
+
+    def type(self, name: str) -> str:
+        """
+        Gets the type of the specified data store.
+
+        Parameters:
+            name (str): The name of the data store.
+
+        Returns:
+            str: The type of the data store.
+        """
+
+        return self._get_type(name)
+
+    def get_values(
+        self,
+        name: str,
+        primary_key: str | None = None,
+        secondary_key: str | None = None,
+    ) -> JSON:
+        """
+        Retrieves values from the specified data store.
+
+        Parameters:
+            name (str): The name of the data store.
+            primary_key (str, optional): The primary key for the values. Defaults to None.
+            secondary_key (str, optional): The secondary key for the values. Defaults to None.
+
+        Returns:
+            JSON: The values from the data store.
+        """
+
+        return self._get_values(name, primary_key, secondary_key)
+
+    def set_values(self, name: str, values: JSON) -> None:
+        """
+        Sets values in the specified data store.
+
+        Parameters:
+            name (str): The name of the data store.
+            values (JSON): The values to set in the data store.
+        """
+
+        return self._set_values(name, values)
+
+    def _get_type(self, name: str) -> str:
+        url = f"https://{self.url}/api/v1/workflow/datastore/{name}/"
+        try:
+            response = self.session.get(url, timeout=10)
+            response.raise_for_status()
+            return response.json().get("datastore_type")
+        except requests.HTTPError as exc:
+            raise AutomizorError.from_response(
+                exc.response, "Failed to get datastore values"
+            ) from exc
+        except Exception as exc:
+            raise AutomizorError("Failed to get datastore values") from exc
+
+    def _get_values(
+        self,
+        name: str,
+        primary_key: str | None = None,
+        secondary_key: str | None = None,
+    ) -> dict:
+        params = (
+            {"primary_key": primary_key, "secondary_key": secondary_key}
+            if primary_key or secondary_key
+            else {}
+        )
+        url = f"https://{self.url}/api/v1/workflow/datastore/{name}/values/"
+        try:
+            response = self.session.get(url, timeout=10, params=params)
+            response.raise_for_status()
+            return response.json()
+        except requests.HTTPError as exc:
+            raise AutomizorError.from_response(
+                exc.response, "Failed to get datastore values"
+            ) from exc
+        except Exception as exc:
+            raise AutomizorError("Failed to get datastore values") from exc
+
+    def _set_values(self, name: str, values: JSON) -> None:
+        url = f"https://{self.url}/api/v1/workflow/datastore/{name}/values/"
+        try:
+            response = self.session.post(url, json=values, timeout=10)
+            response.raise_for_status()
+        except requests.HTTPError as exc:
+            raise AutomizorError.from_response(
+                exc.response, "Failed to set datastore values"
+            ) from exc
+        except Exception as exc:
+            raise AutomizorError("Failed to set datastore values") from exc

automizor/log/__init__.py

@@ -15,8 +15,8 @@ def debug(msg: VALUE):
     Writes a debug log message with a level of "DEBUG".
 
     Parameters:
-        msg (VALUE): The log message to write. This can be a boolean, string, bytes, integer,
-            or float value.
+        msg (VALUE): The log message to write. This can be a boolean, string, integer, float
+            or a JSON-serializable dictionary or list.
     """
 
     _get_log().write_log("DEBUG", msg)
@@ -27,8 +27,8 @@ def info(msg: VALUE):
     Writes an info log message with a level of "INFO".
 
     Parameters:
-        msg (VALUE): The log message to write. This can be a boolean, string, bytes, integer,
-            or float value.
+        msg (VALUE): The log message to write. This can be a boolean, string, integer, float
+            or a JSON-serializable dictionary or list.
     """
 
     _get_log().write_log("INFO", msg)
@@ -39,8 +39,8 @@ def warning(msg: VALUE):
     Writes a warning log message with a level of "WARNING".
 
     Parameters:
-        msg (VALUE): The log message to write. This can be a boolean, string, bytes, integer,
-            or float value.
+        msg (VALUE): The log message to write. This can be a boolean, string, integer, float
+            or a JSON-serializable dictionary or list.
     """
 
     _get_log().write_log("WARNING", msg)
@@ -51,8 +51,8 @@ def error(msg: VALUE):
     Writes an error log message with a level of "ERROR".
 
     Parameters:
-        msg (VALUE): The log message to write. This can be a boolean, string, bytes, integer,
-            or float value.
+        msg (VALUE): The log message to write. This can be a boolean, string, integer, float
+            or a JSON-serializable dictionary or list.
     """
 
     _get_log().write_log("ERROR", msg)
@@ -63,8 +63,8 @@ def critical(msg: VALUE):
     Writes a critical log message with a level of "CRITICAL".
 
     Parameters:
-        msg (VALUE): The log message to write. This can be a boolean, string, bytes, integer,
-            or float value.
+        msg (VALUE): The log message to write. This can be a boolean, string, integer, float
+            or a JSON-serializable dictionary or list.
     """
 
     _get_log().write_log("CRITICAL", msg)

automizor/log/_log.py

@@ -1,7 +1,7 @@
 import json
 import os
 from datetime import datetime, timezone
-from typing import Union
+from typing import Dict, List, Union
 
 LOG_LEVELS = {
     "DEBUG": 1,
@@ -11,7 +11,8 @@ LOG_LEVELS = {
     "CRITICAL": 5,
 }
 
-VALUE = Union[bool, str, bytes, int, float]
+JSON = Union[str, int, float, bool, None, Dict[str, "JSON"], List["JSON"]]
+VALUE = Union[str, int, float, bool, JSON]
 
 
 class Log:
@@ -64,8 +65,8 @@ class Log:
         Parameters:
             level (str): The log level of the message. Valid log levels are "DEBUG", "INFO",
                 "WARNING", "ERROR", and "CRITICAL".
-            msg (VALUE): The log message to write. This can be a boolean, string, bytes, integer,
-                or float value.
+            msg (VALUE): The log message to write. This can be a boolean, string, integer, float
+                or a JSON-serializable dictionary or list.
 
         Raises:
             ValueError: If an invalid log level is provided.
@@ -86,6 +87,9 @@ class Log:
         except json.JSONDecodeError:
             pass
 
+        if isinstance(msg, (dict, list)):
+            msg = json.dumps(msg, ensure_ascii=False)
+
         timestamp = datetime.now(timezone.utc).isoformat()
         data.append({"level": level, "msg": msg, "timestamp": timestamp})
 

{automizor-0.4.3.dist-info → automizor-0.4.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: automizor
-Version: 0.4.3
+Version: 0.4.5
 Summary: Python Automizor framework
 Home-page: https://github.com/automizor/automizor-python
 Author: Christian Fischer

{automizor-0.4.3.dist-info → automizor-0.4.5.dist-info}/RECORD

@@ -1,17 +1,19 @@
-automizor/__init__.py,sha256=qGkDKQTrLXZ0o-aafthub4OFvdwOI_7GN29zXzZj8zg,18
+automizor/__init__.py,sha256=GzDw9yI90LiIOYlw5gZBih8gPe3URgiM0vAFi2-I3ro,18
 automizor/exceptions.py,sha256=P5imySIOtG3ZIk2kh41Yod4RnlgTj7Vf0P3M-RuxQJs,1382
+automizor/datastore/__init__.py,sha256=yaT0WSMBZXVLQklMAujoKBLYLhvHKMzLVE6MBtzSYX4,3480
+automizor/datastore/_datastore.py,sha256=nhvedAngaRa7cQ9U8WJghfW26nQj8_lrsnQtQzOxgRs,4252
 automizor/job/__init__.py,sha256=DNRuT6cyPQBaPRG4vNalCmEvcJQl-73b5ZDFOfNOwIg,1019
 automizor/job/_job.py,sha256=_-ehqPwJdY89mWm3_VAuh7KRJdv-8iUu6iMAzwGLHM0,5235
-automizor/log/__init__.py,sha256=YPATqeIvTk2xuk-pj0T-RmBKTLH9dT-Xyj61G3dph38,1974
-automizor/log/_log.py,sha256=gZp_5Sti8fkVHYsQbXRVb6F38uWexoG-x6oP9M0E2wM,2739
+automizor/log/__init__.py,sha256=gEr2SuwN1FgX1NMnbphjg8_gfSic9L15H3WC868A-TQ,2104
+automizor/log/_log.py,sha256=P9jAFXVANs5bAGH6-S0pzuSbRKEcX8VlQ_3uu690awE,2948
 automizor/storage/__init__.py,sha256=bEY2R0Vk0cqscKYNnX-MM222XrxbLXOvOSBDgFmVPLo,3984
 automizor/storage/_storage.py,sha256=DXcARkFZ3edoDRrDiR02zkO7LmGkRtcKTHmgPsal0lc,10989
 automizor/utils/__init__.py,sha256=2trRoR5lljYKbYdxmioSlvzajjQM0Wnoq3bvF9lEZ6w,811
 automizor/vault/__init__.py,sha256=UjRiW3J0R9ABXc1gXIPyS3cqNCwMWxx0l-C0PsIg7R0,1699
 automizor/vault/_container.py,sha256=-2y7kASigoIVAebuQBk-0R_sI4gfmvjsMLuMg_tR1xA,1945
 automizor/vault/_vault.py,sha256=uRsjOjzsstZpYwJoHNg_cpv803Dzo4T2oF6hwiG3Eww,4688
-automizor-0.4.3.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-automizor-0.4.3.dist-info/METADATA,sha256=GA2unz9bHe21Z7RlzNiwcJEj1ILOn17IufrevjY-4x8,668
-automizor-0.4.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-automizor-0.4.3.dist-info/top_level.txt,sha256=gScDy4I3tP6BMYAsTAlBXrxVh3E00zV0UioxwXJOI3Y,10
-automizor-0.4.3.dist-info/RECORD,,
+automizor-0.4.5.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+automizor-0.4.5.dist-info/METADATA,sha256=hgQ4E-34KSHSi7K8QNTyGdIRwrSgEXFzFYowGTk_OgM,668
+automizor-0.4.5.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+automizor-0.4.5.dist-info/top_level.txt,sha256=gScDy4I3tP6BMYAsTAlBXrxVh3E00zV0UioxwXJOI3Y,10
+automizor-0.4.5.dist-info/RECORD,,