Sync monorepo state at "Update Python SDK with new methods for Transformer" (#119)

Syncing from
userclouds/userclouds@8fdf4f1deeea7d0d10f5f80e674fdaee08d9344f

Author: uc-build-user

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.10.0 - TBD
+
+- Add version to Transformer model, add client methods GetTransformer and UpdateTransformer, and fix a bug in GetAccessPolicy and GetAccessPolicyTemplate
+
 ## 1.9.2 - 06-05-2024
 
 - Fix missing parameter in \_post_async for AsyncClient

requirements.txt

@@ -1,7 +1,7 @@
 certifi==2024.7.4
 cffi==1.15.1
 charset-normalizer==2.1.1
-cryptography==42.0.4
+cryptography==43.0.1
 idna==3.7
 iso8601==1.1.0
 pycparser==2.21

src/usercloudssdk/asyncclient.py

@@ -587,16 +587,21 @@ async def ListAccessPolicyTemplatesAsync(
         return templates
 
     async def GetAccessPolicyTemplateAsync(self, rid: ResourceID):
-        if rid.id is not None:
+        if hasattr(rid, "id"):
             resp_json = await self._get_async(
                 f"/tokenizer/policies/accesstemplate/{rid.id}"
             )
-        elif rid.name is not None:
+            return AccessPolicyTemplate.from_json(resp_json)
+        elif hasattr(rid, "name"):
             resp_json = await self._get_async(
-                f"/tokenizer/policies/accesstemplate?name={rid.name}"
+                f"/tokenizer/policies/accesstemplate?template_name={rid.name}"
             )
-
-        return AccessPolicyTemplate.from_json(resp_json)
+            if len(resp_json["data"]) == 1:
+                return AccessPolicyTemplate.from_json(resp_json["data"][0])
+            raise UserCloudsSDKError(
+                f"Access Policy Template with name {rid.name} not found", 404
+            )
+        raise UserCloudsSDKError("Invalid ResourceID", 400)
 
     async def UpdateAccessPolicyTemplateAsync(
         self, access_policy_template: AccessPolicyTemplate
@@ -659,14 +664,19 @@ async def ListAccessPoliciesAsync(
         return policies
 
     async def GetAccessPolicyAsync(self, rid: ResourceID):
-        if rid.id is not None:
+        if hasattr(rid, "id"):
             resp_json = await self._get_async(f"/tokenizer/policies/access/{rid.id}")
-        elif rid.name is not None:
+            return AccessPolicy.from_json(resp_json)
+        elif hasattr(rid, "name"):
             resp_json = await self._get_async(
-                f"/tokenizer/policies/access?name={rid.name}"
+                f"/tokenizer/policies/access?policy_name={rid.name}"
             )
-
-        return AccessPolicy.from_json(resp_json)
+            if len(resp_json["data"]) == 1:
+                return AccessPolicy.from_json(resp_json["data"][0])
+            raise UserCloudsSDKError(
+                f"Access Policy with name {rid.name} not found", 404
+            )
+        raise UserCloudsSDKError("Invalid ResourceID", 400)
 
     async def UpdateAccessPolicyAsync(self, access_policy: AccessPolicy):
         resp_json = await self._put_async(
@@ -698,6 +708,21 @@ async def CreateTransformerAsync(
                 return transformer
             raise err
 
+    async def GetTransformerAsync(self, rid: ResourceID):
+        if hasattr(rid, "id"):
+            resp_json = await self._get_async(
+                f"/tokenizer/policies/transformation/{rid.id}"
+            )
+            return Transformer.from_json(resp_json)
+        elif hasattr(rid, "name"):
+            resp_json = await self._get_async(
+                f"/tokenizer/policies/transformation?transformer_name={rid.name}"
+            )
+            if len(resp_json["data"]) == 1:
+                return Transformer.from_json(resp_json["data"][0])
+            raise UserCloudsSDKError(f"Transformer with name {rid.name} not found", 404)
+        raise UserCloudsSDKError("Invalid ResourceID", 400)
+
     async def ListTransformersAsync(
         self,
         limit: int = 0,
@@ -727,7 +752,12 @@ async def ListTransformersAsync(
         transformers = [Transformer.from_json(tf) for tf in resp_json["data"]]
         return transformers
 
-    # Note: Transformers are immutable, so no Update method is provided.
+    async def UpdateTransformerAsync(self, transformer: Transformer):
+        resp_json = await self._put_async(
+            f"/tokenizer/policies/transformation/{transformer.id}",
+            json_data={"transformer": transformer.__dict__},
+        )
+        return Transformer.from_json(resp_json)
 
     async def DeleteTransformerAsync(self, id: uuid.UUID):
         return await self._delete_async(f"/tokenizer/policies/transformation/{id}")

src/usercloudssdk/client.py

@@ -572,12 +572,19 @@ def ListAccessPolicyTemplates(
         return templates
 
     def GetAccessPolicyTemplate(self, rid: ResourceID):
-        if rid.id is not None:
+        if hasattr(rid, "id"):
             resp_json = self._get(f"/tokenizer/policies/accesstemplate/{rid.id}")
-        elif rid.name is not None:
-            resp_json = self._get(f"/tokenizer/policies/accesstemplate?name={rid.name}")
-
-        return AccessPolicyTemplate.from_json(resp_json)
+            return AccessPolicyTemplate.from_json(resp_json)
+        elif hasattr(rid, "name"):
+            resp_json = self._get(
+                f"/tokenizer/policies/accesstemplate?template_name={rid.name}"
+            )
+            if len(resp_json["data"]) == 1:
+                return AccessPolicyTemplate.from_json(resp_json["data"][0])
+            raise UserCloudsSDKError(
+                f"Access Policy Template with name {rid.name} not found", 404
+            )
+        raise UserCloudsSDKError("Invalid ResourceID", 400)
 
     def UpdateAccessPolicyTemplate(self, access_policy_template: AccessPolicyTemplate):
         resp_json = self._put(
@@ -638,12 +645,17 @@ def ListAccessPolicies(
         return policies
 
     def GetAccessPolicy(self, rid: ResourceID):
-        if rid.id is not None:
+        if hasattr(rid, "id"):
             resp_json = self._get(f"/tokenizer/policies/access/{rid.id}")
-        elif rid.name is not None:
-            resp_json = self._get(f"/tokenizer/policies/access?name={rid.name}")
-
-        return AccessPolicy.from_json(resp_json)
+            return AccessPolicy.from_json(resp_json)
+        elif hasattr(rid, "name"):
+            resp_json = self._get(f"/tokenizer/policies/access?policy_name={rid.name}")
+            if len(resp_json["data"]) == 1:
+                return AccessPolicy.from_json(resp_json["data"][0])
+            raise UserCloudsSDKError(
+                f"Access Policy with name {rid.name} not found", 404
+            )
+        raise UserCloudsSDKError("Invalid ResourceID", 400)
 
     def UpdateAccessPolicy(self, access_policy: AccessPolicy):
         resp_json = self._put(
@@ -673,6 +685,19 @@ def CreateTransformer(self, transformer: Transformer, if_not_exists: bool = Fals
                 return transformer
             raise err
 
+    def GetTransformer(self, rid: ResourceID):
+        if hasattr(rid, "id"):
+            resp_json = self._get(f"/tokenizer/policies/transformation/{rid.id}")
+            return Transformer.from_json(resp_json)
+        elif hasattr(rid, "name"):
+            resp_json = self._get(
+                f"/tokenizer/policies/transformation?transformer_name={rid.name}"
+            )
+            if len(resp_json["data"]) == 1:
+                return Transformer.from_json(resp_json["data"][0])
+            raise UserCloudsSDKError(f"Transformer with name {rid.name} not found", 404)
+        raise UserCloudsSDKError("Invalid ResourceID", 400)
+
     def ListTransformers(
         self,
         limit: int = 0,
@@ -700,7 +725,12 @@ def ListTransformers(
         transformers = [Transformer.from_json(tf) for tf in resp_json["data"]]
         return transformers
 
-    # Note: Transformers are immutable, so no Update method is provided.
+    def UpdateTransformer(self, transformer: Transformer):
+        resp_json = self._put(
+            f"/tokenizer/policies/transformation/{transformer.id}",
+            json_data={"transformer": transformer.__dict__},
+        )
+        return Transformer.from_json(resp_json)
 
     def DeleteTransformer(self, id: uuid.UUID):
         return self._delete(f"/tokenizer/policies/transformation/{id}")

src/usercloudssdk/models.py

@@ -106,9 +106,9 @@ def from_json(cls, json_data: dict) -> UserSelectorConfig:
 
 class ResourceID:
     def __init__(self, id="", name="") -> None:
-        if id != "":
+        if id:
             setattr(self, "id", id)
-        if name != "":
+        if name:
             setattr(self, "name", name)
 
     def __repr__(self) -> str:
@@ -841,6 +841,7 @@ class Transformer:
     transform_type: TransformType
     function: str
     parameters: str
+    version: int
 
     def __init__(
         self,
@@ -856,6 +857,7 @@ def __init__(
         parameters: str = "",
         input_type_constraints: ColumnConstraints | None = None,
         output_type_constraints: ColumnConstraints | None = None,
+        version: int = 0,
     ) -> None:
         self.id = id
         self.name = name
@@ -887,9 +889,10 @@ def __init__(
             )
         else:
             self.output_type_constraints = output_type_constraints
+        self.version = version
 
     def __repr__(self) -> str:
-        return f"Transformer(id={self.id}, name={self.name}))"
+        return f"Transformer(id={self.id}, name={self.name}, input_data_type={self.input_data_type}, input_type={self.input_type}, input_type_constraints={self.input_type_constraints}, output_data_type={self.output_data_type}, output_type={self.output_type}, output_type_constraints={self.output_type_constraints}, reuse_existing_token={self.reuse_existing_token}, transform_type={self.transform_type}, function={self.function}, parameters={self.parameters}, version={self.version})"
 
     def __str__(self) -> str:
         return f"Transformer {self.name} - {self.id}"
@@ -909,6 +912,7 @@ def to_json(self) -> str:
                 "transform_type": self.transform_type.value,
                 "function": self.function,
                 "parameters": self.parameters,
+                "version": self.version,
             },
         )
 
@@ -935,6 +939,7 @@ def from_json(cls, json_data: dict) -> Transformer:
             transform_type=TransformType(json_data["transform_type"]),
             function=json_data["function"],
             parameters=json_data["parameters"],
+            version=json_data["version"],
         )