wizata-dsapi 2.2.0.dev16__tar.gz → 2.2.0.dev18__tar.gz

{wizata_dsapi-2.2.0.dev16 → wizata_dsapi-2.2.0.dev18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wizata_dsapi
-Version: 2.2.0.dev16
+Version: 2.2.0.dev18
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

{wizata_dsapi-2.2.0.dev16 → wizata_dsapi-2.2.0.dev18}/wizata_dsapi/__init__.py

@@ -60,7 +60,7 @@ from .notification import NotificationScope, DeviceToken, AlertRule, AlertActive
     MonitoredPipeline, NotificationPreference, RecipientList, Recipient, RecipientType
 from .edge_device import EdgeDevice, EdgeDeviceStatus, EdgeDeviceType, EdgeDeviceProvisioning
 from .edge_module import EdgeModule, EdgeModuleType, WIZATA_MODULES
-from .edge_config import EdgeConsumer, EdgeWriter, EdgeTrigger, EdgeFile, EdgeConfig
+from .edge_config import EdgeConsumer, EdgeWriter, EdgeTrigger, EdgeFile, EdgeConfig, EdgeCommand
 from .connection import Connection, ConnectionMapping, ConnectionDirection, TransformKind, \
     EdgeDeviceKey, EdgeDeviceKeyStatus
 from .connection_types import ConnectionType, CONNECTION_TYPES, TRANSFORM_SCHEMAS, get_connection_type, \

{wizata_dsapi-2.2.0.dev16 → wizata_dsapi-2.2.0.dev18}/wizata_dsapi/edge_config.py

@@ -97,24 +97,30 @@ class EdgeTrigger(Dto):
     """
     A pipeline trigger configured on an edge device.
 
-    :ivar str id: trigger identifier.
+    Also the stored entity for an edge's hand-made triggers (DEV-6095, ``"EdgeTrigger"``
+    table): a standalone trigger, or an overlay naming a ``deploymentId`` whose extra
+    keys (``exceptions``...) are merged into that deployment's rendered entry.
+
+    :ivar str id: trigger identifier (the stored key).
     :ivar int interval: execution interval in milliseconds.
     :ivar str pipeline_image_id: pipeline image reference (build tag + pipeline key).
     :ivar str twin: twin key this trigger targets.
     :ivar str template: template key this trigger targets.
     :ivar dict extras: all other fields from the JSON config.
+    :ivar str edge_device_id: the device it belongs to, when stored (not part of triggers.json).
     """
 
     _KNOWN_KEYS = {"id", "interval", "pipelineImageId", "twin", "template"}
 
     def __init__(self, id=None, interval=None, pipeline_image_id=None,
-                 twin=None, template=None, extras=None):
+                 twin=None, template=None, extras=None, edge_device_id=None):
         self.id = id
         self.interval = interval
         self.pipeline_image_id = pipeline_image_id
         self.twin = twin
         self.template = template
         self.extras = extras or {}
+        self.edge_device_id = edge_device_id
 
     @classmethod
     def from_dict(cls, data: dict) -> "EdgeTrigger":
@@ -206,3 +212,29 @@ class EdgeConfig(Dto):
 
     def to_dict(self) -> dict:
         return {"files": dict(self.files), "images": list(self.images), "etag": self.etag}
+
+
+class EdgeCommand(Dto):
+    """
+    A one-shot operator command for an edge (DEV-6095), served as ``command.json`` until
+    it expires. The edge's command handler runs it once and refuses it when older than
+    15 minutes, so the platform only stores what was asked, and when.
+
+    :ivar str id: command id (UUID); the edge remembers which ids it ran.
+    :ivar str edge_device_id: the device it is for.
+    :ivar str action: e.g. ``purge_queue``.
+    :ivar str queue: e.g. ``pipeline``.
+    :ivar str issued_at: ISO-8601 UTC, ``Z`` suffix.
+    """
+
+    def __init__(self, id=None, edge_device_id=None, action=None, queue=None, issued_at=None):
+        self.id = id
+        self.edge_device_id = edge_device_id
+        self.action = action
+        self.queue = queue
+        self.issued_at = issued_at
+
+    def to_dict(self) -> dict:
+        """The ``command.json`` shape the edge's command handler reads."""
+        return {"id": self.id, "action": self.action, "queue": self.queue,
+                "issuedAt": self.issued_at}

{wizata_dsapi-2.2.0.dev16 → wizata_dsapi-2.2.0.dev18}/wizata_dsapi/edge_device.py

@@ -9,6 +9,7 @@ class EdgeDeviceStatus(Enum):
     """
     WAITING_FOR_REGISTRATION = "WaitingForRegistration"
     REGISTERED = "Registered"
+    DEPLOYING = "Deploying"
     DEPLOYED = "Deployed"
     FAILED = "Failed"
     OFFLINE = "Offline"
@@ -35,25 +36,40 @@ class EdgeDevice(ApiDto):
     """
     Edge device registered on the platform.
 
-    :ivar uuid.UUID edge_device_id: technical id of the edge device.
-    :ivar str device_id: logical device identifier string.
+    The device id is its only identifier (DEV-6101): the name it runs as (its IoT Hub
+    device id), and what connections, keys and deployment targets refer to.
+
+    :ivar str device_id: the device identifier.
     :ivar str name: display name of the edge device.
     :ivar str twin_name: name of the associated twin.
     :ivar uuid.UUID twin_id: technical id of the associated twin.
     :ivar EdgeDeviceStatus status: current status of the device.
-    :ivar int status_code: numeric status code.
+    :ivar int status_code: last ``$edgeAgent`` ``lastDesiredStatus.code`` read (417, 200, 406...).
     :ivar EdgeDeviceType device_type: type of the edge device.
     :ivar EdgeDeviceProvisioning provisioning: how the device is installed.
     :ivar int created_at: creation time, epoch ms (the PostgreSQL registry, DEV-6015).
     :ivar int updated_at: last update time, epoch ms.
     :ivar str connection_state: IoT Hub connection state ('Connected' or 'Disconnected'), enriched from IoT Hub.
     :ivar str last_activity_time: last device activity timestamp from IoT Hub.
+    :ivar str applied_hash: digest of the manifest the platform last applied (DEV-6101).
+    :ivar int applied_version: ``$edgeAgent`` desired ``$version`` that apply produced.
+    :ivar int applied_at: when it was applied, epoch ms.
+    :ivar dict image_overrides: module -> image, winning over the release's images.
+    :ivar str runner_python_version: Python version of the edge's pipeline runner.
+    :ivar bool managed: the platform keeps this device's manifest ("deploy modules").
+    :ivar dict applied_modules: what was last applied: module -> {image, env names}.
+    :ivar str reconcile_error: why the last apply failed, until one succeeds.
     """
 
     @classmethod
     def route(cls):
         return "edgedevices"
 
+    @classmethod
+    def get_id_type(cls) -> type:
+        """The device id (a string) is the edge's only identifier (DEV-6101)."""
+        return str
+
     @classmethod
     def from_dict(cls, data):
         obj = EdgeDevice()
@@ -61,7 +77,6 @@ class EdgeDevice(ApiDto):
         return obj
 
     def __init__(self,
-                 edge_device_id: uuid.UUID = None,
                  device_id: str = None,
                  name: str = None,
                  twin_name: str = None,
@@ -73,11 +88,15 @@ class EdgeDevice(ApiDto):
                  last_activity_time: str = None,
                  provisioning: EdgeDeviceProvisioning = None,
                  created_at: int = None,
-                 updated_at: int = None):
-        if edge_device_id is None:
-            self.edge_device_id = uuid.uuid4()
-        else:
-            self.edge_device_id = edge_device_id
+                 updated_at: int = None,
+                 applied_hash: str = None,
+                 applied_version: int = None,
+                 applied_at: int = None,
+                 image_overrides: dict = None,
+                 runner_python_version: str = None,
+                 managed: bool = None,
+                 applied_modules: dict = None,
+                 reconcile_error: str = None):
         self.device_id = device_id
         self.name = name
         self.twin_name = twin_name
@@ -90,22 +109,28 @@ class EdgeDevice(ApiDto):
         self.provisioning = provisioning
         self.created_at = created_at
         self.updated_at = updated_at
+        self.applied_hash = applied_hash
+        self.applied_version = applied_version
+        self.applied_at = applied_at
+        self.image_overrides = image_overrides
+        self.runner_python_version = runner_python_version
+        self.managed = managed
+        self.applied_modules = applied_modules
+        self.reconcile_error = reconcile_error
 
     def api_id(self) -> str:
-        return str(self.edge_device_id).upper()
+        return self.device_id
 
     def api_key(self) -> str:
         return self.device_id
 
     def set_id(self, id_value):
-        self.edge_device_id = uuid.UUID(str(id_value))
+        self.device_id = str(id_value)
 
     def endpoint(self) -> str:
         return "EdgeDevices"
 
     def from_json(self, obj):
-        if "id" in obj and obj["id"] is not None:
-            self.edge_device_id = uuid.UUID(obj["id"])
         if "deviceId" in obj and obj["deviceId"] is not None:
             self.device_id = obj["deviceId"]
         if "name" in obj and obj["name"] is not None:
@@ -130,11 +155,27 @@ class EdgeDevice(ApiDto):
             self.created_at = int(obj["createdAt"])
         if "updatedAt" in obj and obj["updatedAt"] is not None:
             self.updated_at = int(obj["updatedAt"])
+        if "appliedHash" in obj and obj["appliedHash"] is not None:
+            self.applied_hash = obj["appliedHash"]
+        if "appliedVersion" in obj and obj["appliedVersion"] is not None:
+            self.applied_version = int(obj["appliedVersion"])
+        if "appliedAt" in obj and obj["appliedAt"] is not None:
+            self.applied_at = int(obj["appliedAt"])
+        if "imageOverrides" in obj and obj["imageOverrides"] is not None:
+            if not isinstance(obj["imageOverrides"], dict):
+                raise ValueError("imageOverrides must be an object: module -> image")
+            self.image_overrides = dict(obj["imageOverrides"])
+        if "runnerPythonVersion" in obj and obj["runnerPythonVersion"] is not None:
+            self.runner_python_version = str(obj["runnerPythonVersion"])
+        if "managed" in obj and obj["managed"] is not None:
+            self.managed = bool(obj["managed"])
+        if "appliedModules" in obj and obj["appliedModules"] is not None:
+            self.applied_modules = obj["appliedModules"]
+        if "reconcileError" in obj and obj["reconcileError"] is not None:
+            self.reconcile_error = obj["reconcileError"]
 
     def to_json(self, target: str = None):
-        obj = {
-            "id": str(self.edge_device_id)
-        }
+        obj = {}
         if self.device_id is not None:
             obj["deviceId"] = self.device_id
         if self.name is not None:
@@ -159,4 +200,19 @@ class EdgeDevice(ApiDto):
             obj["createdAt"] = self.created_at
         if self.updated_at is not None:
             obj["updatedAt"] = self.updated_at
-        return obj
+        if self.applied_hash is not None:
+            obj["appliedHash"] = self.applied_hash
+        if self.applied_version is not None:
+            obj["appliedVersion"] = self.applied_version
+        if self.applied_at is not None:
+            obj["appliedAt"] = self.applied_at
+        if self.image_overrides is not None:
+            obj["imageOverrides"] = self.image_overrides
+        if self.runner_python_version is not None:
+            obj["runnerPythonVersion"] = self.runner_python_version
+        obj["managed"] = bool(self.managed)
+        if self.applied_modules is not None:
+            obj["appliedModules"] = self.applied_modules
+        if self.reconcile_error is not None:
+            obj["reconcileError"] = self.reconcile_error
+        return obj

wizata_dsapi-2.2.0.dev18/wizata_dsapi/version.py

@@ -0,0 +1 @@
+__version__ = "2.2.0.dev18"

{wizata_dsapi-2.2.0.dev16 → wizata_dsapi-2.2.0.dev18}/wizata_dsapi/wizata_dsapi_client.py

@@ -446,7 +446,7 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
                 return self._query(request=obj)
             else:
                 dto_class = self._get_class(entity=type(obj), operation=operation)
-                if dto_class == PipelineImage:
+                if dto_class == PipelineImage or dto_class.get_id_type() == str:
                     id = obj.api_id()
                 else:
                     id = uuid.UUID(obj.api_id())
@@ -582,6 +582,8 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
             if dto_class.get_id_type() == int:
                 obj.set_id(response.json()["id"])
                 return response.json()["id"]
+            elif dto_class.get_id_type() == str:
+                return obj.api_id()
             else:
                 return uuid.UUID(obj.api_id())
 

{wizata_dsapi-2.2.0.dev16 → wizata_dsapi-2.2.0.dev18}/wizata_dsapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wizata_dsapi
-Version: 2.2.0.dev16
+Version: 2.2.0.dev18
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

wizata_dsapi-2.2.0.dev16/wizata_dsapi/version.py

@@ -1 +0,0 @@
-__version__ = "2.2.0.dev16"