wizata-dsapi 2.1.0.dev9__tar.gz → 2.1.0.dev11__tar.gz

{wizata_dsapi-2.1.0.dev9 → wizata_dsapi-2.1.0.dev11}/PKG-INFO

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

{wizata_dsapi-2.1.0.dev9 → wizata_dsapi-2.1.0.dev11}/wizata_dsapi/__init__.py

@@ -14,7 +14,7 @@ from .template import Template, TemplateProperty
 from .solution_component import SolutionComponent, SolutionType
 from .business_label import BusinessLabel
 from .twinregistration import TwinRegistration, TwinRegistrationProperty
-from .trigger import Trigger
+from .trigger import Trigger, validate_trigger_branch
 from .group_system import GroupSystem
 from .bucket import Bucket
 

{wizata_dsapi-2.1.0.dev9 → wizata_dsapi-2.1.0.dev11}/wizata_dsapi/trigger.py

@@ -1,8 +1,45 @@
+import re
 import uuid
 import json
 from .api_dto import ApiDto
 
 
+# Mirrors BranchNamer._release_re in wizata_ds_gitstore/branches.py (the source of
+# truth for branch naming). Duplicated as a pure regex on purpose: importing
+# wizata_ds_gitstore pulls pygit2 through its package __init__, which this public
+# package must not depend on.
+RELEASE_BRANCH_RE = re.compile(r"^release/[A-Za-z0-9_\-\.]{1,64}$")
+
+
+def validate_trigger_branch(branch):
+    """
+    Check a value destined for `Trigger.branch` (DEV-5962 / DEV-5966).
+
+    A schedule must pin a version that cannot move under it: a `release/<name>`
+    branch is fast-forward-only and never rewound, whereas master changes every
+    time anyone publishes — a trigger on master would silently change what
+    production executes. Feature branches are ephemeral (deleted on publish), so
+    they are refused too. An image-based trigger carries no branch at all.
+
+    Call this on WRITE only (`TriggerClient.create` / `update`). It is deliberately
+    NOT called from `from_json`: validating on the read path is what made a single
+    bad row break `GET /dsapi/twins/` (DEV-5970).
+
+    :param branch: branch value or None (None is valid — image or legacy trigger).
+    :raise ValueError: when branch is set but is not a release branch.
+    """
+    if branch is None:
+        return None
+    branch = str(branch)
+    if RELEASE_BRANCH_RE.match(branch) is None:
+        raise ValueError(
+            f"a trigger can only run a release branch, got {branch!r} — "
+            f"publish and cut a release/<name> first (master moves, feature "
+            f"branches are deleted on publish)"
+        )
+    return branch
+
+
 class Trigger(ApiDto):
     """
     trigger defines how pipelines are automatically executed.
@@ -14,6 +51,12 @@ class Trigger(ApiDto):
     :ivar uuid.UUID template_id: set a template id to trigger.
     :ivar dict properties: set a dict of properties to pass when triggering the pipeline.
     :ivar list twin_ids: set a list of twin ids on which executed the pipelines (must be registered on the pipeline).
+    :ivar str branch: git release branch this schedule runs (`release/<name>`), None for an
+        image-based or non-git trigger.
+    :ivar str version: runner runtime this schedule executes on (e.g. `3.12`, `3.12-julia`)
+        — same meaning as `ExecutionLog.version`, hence the same attribute name here. The
+        backend calls it `pythonVersion` on the wire, and the front-end presents it as
+        "Environment".
     :ivar uuid.UUID createdById: unique identifier of creating user.
     :ivar int createdDate: timestamp of created date.
     :ivar uuid.UUID updatedById: unique identifier of updating user.
@@ -38,7 +81,9 @@ class Trigger(ApiDto):
                  pipeline_image_id: str = None,
                  template_id: uuid.UUID = None,
                  properties: dict = None,
-                 twin_ids: list = None):
+                 twin_ids: list = None,
+                 branch: str = None,
+                 version: str = None):
         if trigger_id is None:
             trigger_id = uuid.uuid4()
         self.trigger_id = trigger_id
@@ -49,6 +94,8 @@ class Trigger(ApiDto):
         self.template_id = template_id
         self.properties = properties
         self.twin_ids = twin_ids
+        self.branch = branch
+        self.version = version
         self.createdById = None
         self.createdDate = None
         self.updatedById = None
@@ -82,6 +129,15 @@ class Trigger(ApiDto):
             else:
                 self.properties = obj["jsonProperties"]
 
+        # DEV-5966: the version the schedule runs and the runtime it runs on. Both
+        # exist on the backend (`pythonVersion` has always been there and drives the
+        # runner queue; `branch` arrived with DEV-5962) but neither was mapped here,
+        # so they were silently dropped in both directions.
+        if "branch" in obj.keys() and obj["branch"] is not None:
+            self.branch = str(obj["branch"])
+        if "pythonVersion" in obj.keys() and obj["pythonVersion"] is not None:
+            self.version = str(obj["pythonVersion"])
+
         if "twinIds" in obj.keys() and isinstance(obj["twinIds"], list):
             self.twin_ids = []
             for twinId in obj["twinIds"]:
@@ -114,6 +170,11 @@ class Trigger(ApiDto):
         if self.pipeline_image_id is not None:
             obj["pipelineImageId"] = str(self.pipeline_image_id)
 
+        if self.branch is not None:
+            obj["branch"] = str(self.branch)
+        if self.version is not None:
+            obj["pythonVersion"] = str(self.version)
+
         if self.properties is not None:
             obj["jsonProperties"] = json.dumps(self.properties)
 

{wizata_dsapi-2.1.0.dev9 → wizata_dsapi-2.1.0.dev11}/wizata_dsapi/twin.py

@@ -14,6 +14,31 @@ def is_valid_hex_color(color):
         return True
 
 
+def parse_color(color):
+    """
+    Normalize a colour coming from a payload or a constructor (DEV-5970).
+
+    A BLANK value means "no colour", not an invalid one: the platform's own
+    .NET side stores `""` on twins it creates, and because this validation runs
+    on the READ path (`from_json`) a single such row used to raise and make
+    `GET /dsapi/twins/` fail for the WHOLE collection.
+
+    Anything else non-blank is still validated and still raises, because
+    `from_json` is also the write path (`POST` / `PUT /dsapi/twins/` validate
+    nowhere else) — a colour typed as `red` must remain a 400.
+
+    :param color: raw colour value or None.
+    :return: the colour string, or None when absent/blank.
+    """
+    if color is None:
+        return None
+    color = str(color)
+    if color.strip() == '':
+        return None
+    is_valid_hex_color(color)
+    return color
+
+
 class TwinType(ApiDto):
     """
     twin type
@@ -41,9 +66,7 @@ class TwinType(ApiDto):
             self.twin_type_id = twin_type_id
         self.name = name
         self.icon = icon
-        self.color = color
-        if color is not None:
-            is_valid_hex_color(color)
+        self.color = parse_color(color)
         self.description = description
         self.createdById = None
         self.createdDate = None
@@ -62,8 +85,7 @@ class TwinType(ApiDto):
         if "name" in obj.keys() and obj["name"] is not None:
             self.name = obj["name"]
         if "color" in obj.keys() and obj["color"] is not None:
-            is_valid_hex_color(str(obj["color"]))
-            self.color = str(obj["color"])
+            self.color = parse_color(obj["color"])
         if "icon" in obj.keys() and obj["icon"] is not None:
             self.icon = str(obj["icon"])
         if "description" in obj.keys() and obj["description"] is not None:
@@ -185,9 +207,7 @@ class Twin(ApiDto):
         self.longitude = longitude
         self.latitude_id = latitude_id
         self.longitude_id = longitude_id
-        if color is not None:
-            is_valid_hex_color(color)
-        self.color = color
+        self.color = parse_color(color)
         self.icon = icon
         self.extra_properties = extra_properties
         self.is_asset = is_asset
@@ -229,8 +249,7 @@ class Twin(ApiDto):
         if "longitudeSensorId" in obj.keys() and obj["longitudeSensorId"] is not None:
             self.longitude_id = uuid.UUID(obj["longitudeSensorId"])
         if "color" in obj.keys() and obj["color"] is not None:
-            is_valid_hex_color(str(obj["color"]))
-            self.color = str(obj["color"])
+            self.color = parse_color(obj["color"])
         if "icon" in obj.keys() and obj["icon"] is not None:
             self.icon = str(obj["icon"])
         if "description" in obj.keys() and obj["description"] is not None:

wizata_dsapi-2.1.0.dev11/wizata_dsapi/version.py

@@ -0,0 +1 @@
+__version__ = "2.1.0.dev11"

{wizata_dsapi-2.1.0.dev9 → wizata_dsapi-2.1.0.dev11}/wizata_dsapi.egg-info/PKG-INFO

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

wizata_dsapi-2.1.0.dev9/wizata_dsapi/version.py

@@ -1 +0,0 @@
-__version__ = "2.1.0.dev9"