linting

Author: alexluck-sift

python/lib/sift_client/_internal/low_level_wrappers/assets.py

@@ -4,7 +4,7 @@
 
 from sift.assets.v1.assets_pb2 import (
     ArchiveAssetRequest,
-ArchiveAssetResponse,
+    ArchiveAssetResponse,
     GetAssetRequest,
     GetAssetResponse,
     ListAssetsRequest,

python/lib/sift_client/_internal/low_level_wrappers/rules.py

@@ -338,7 +338,9 @@ async def batch_archive_rules(
         request = BatchArchiveRulesRequest(**request_kwargs)
         await self._grpc_client.get_stub(RuleServiceStub).BatchArchiveRules(request)
 
-    async def unarchive_rule(self, rule_id: str | None = None, client_key: str | None = None) -> Rule:
+    async def unarchive_rule(
+        self, rule_id: str | None = None, client_key: str | None = None
+    ) -> Rule:
         """Unarchive a rule.
 
         Args:

python/lib/sift_client/resources/assets.py

@@ -79,7 +79,8 @@ async def list_(
         modified_by: Any | str | None = None,
         # tags
         tags: list[Any] | list[str] | None = None,
-        _tag_ids: list[str] | None = None, # For compatibility until first class Tag support is added
+        _tag_ids: list[str]
+        | None = None,  # For compatibility until first class Tag support is added
         # metadata
         metadata: list[Any] | None = None,
         # common filters

python/lib/sift_client/resources/calculated_channels.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-from datetime import datetime
 from typing import TYPE_CHECKING, Any
 
 from sift_client._internal.low_level_wrappers.calculated_channels import (
@@ -18,6 +17,7 @@
 
 if TYPE_CHECKING:
     import re
+    from datetime import datetime
 
     from sift_client.client import SiftClient
 
@@ -256,9 +256,9 @@ async def archive(self, calculated_channel: str | CalculatedChannel) -> Calculat
         Returns:
             The archived CalculatedChannel.
         """
-        return await self.update(calculated_channel=calculated_channel, update=CalculatedChannelUpdate(
-            is_archived=True
-        ))
+        return await self.update(
+            calculated_channel=calculated_channel, update=CalculatedChannelUpdate(is_archived=True)
+        )
 
     async def unarchive(self, calculated_channel: str | CalculatedChannel) -> CalculatedChannel:
         """Unarchive a calculated channel.
@@ -269,9 +269,9 @@ async def unarchive(self, calculated_channel: str | CalculatedChannel) -> Calcul
         Returns:
             The unarchived CalculatedChannel.
         """
-        return await self.update(calculated_channel=calculated_channel, update=CalculatedChannelUpdate(
-            is_archived=False
-        ))
+        return await self.update(
+            calculated_channel=calculated_channel, update=CalculatedChannelUpdate(is_archived=False)
+        )
 
     async def list_versions(
         self,

python/lib/sift_client/resources/rules.py

@@ -37,29 +37,20 @@ async def get(
         *,
         rule_id: str | None = None,
         client_key: str | None = None,
-        rule_ids: list[str] | None = None,
-        client_keys: list[str] | None = None,
-    ) -> Rule | list[Rule]:
+    ) -> Rule:
         """Get a Rule.
 
         Args:
             rule_id: The ID of the rule.
             client_key: The client key of the rule.
-            rule_ids: List of rule IDs to get.
-            client_keys: List of client keys to get.
 
         Returns:
-            The Rule or Rules.
+            The Rule.
         """
-        if rule_id or client_key:
-            rule = await self._low_level_client.get_rule(rule_id=rule_id, client_key=client_key)
-            return self._apply_client_to_instance(rule)
-        else:
-            rules = await self._low_level_client.batch_get_rules(
-                rule_ids=rule_ids, client_keys=client_keys
-            )
-            return self._apply_client_to_instances(rules)
+        rule = await self._low_level_client.get_rule(rule_id=rule_id, client_key=client_key)
+        return self._apply_client_to_instance(rule)
 
+    # TODO: update this more
     async def list_(
         self,
         *,
@@ -156,13 +147,16 @@ async def update(
         Returns:
             The updated Rule.
         """
+        rule_obj: Rule
         if isinstance(rule, str):
-            rule = await self.get(rule_id=rule)
+            rule_obj = await self.get(rule_id=rule)
+        else:
+            rule_obj = rule
 
         if isinstance(update, dict):
             update = RuleUpdate.model_validate(update)
 
-        updated_rule = await self._low_level_client.update_rule(rule, update, version_notes)
+        updated_rule = await self._low_level_client.update_rule(rule=rule_obj, update=update, version_notes=version_notes)
         return self._apply_client_to_instance(updated_rule)
 
     async def archive(self, rule: str | Rule) -> Rule:
@@ -186,6 +180,3 @@ async def unarchive(self, rule: str | Rule) -> Rule:
             The unarchived Rule.
         """
         return await self.update(rule=rule, update=RuleUpdate(is_archived=False))
-
-
-

python/lib/sift_client/resources/runs.py

@@ -147,7 +147,7 @@ async def list_(
             filter_parts.append(cel.in_("client_key", client_keys))
         if assets:
             if all(isinstance(s, str) for s in assets):
-                ids = cast("list[str]", assets) # linting
+                ids = cast("list[str]", assets)  # linting
                 filter_parts.append(cel.in_("asset_ids", ids))
             else:
                 asset = cast("list[Asset]", assets)  # linting
@@ -239,8 +239,8 @@ async def archive(
         return await self.update(run, RunUpdate(is_archived=True))
 
     async def unarchive(
-            self,
-            run: str | Run,
+        self,
+        run: str | Run,
     ) -> Run:
         """Unarchive a run.
 
@@ -249,7 +249,6 @@ async def unarchive(
         """
         return await self.update(run, RunUpdate(is_archived=False))
 
-
     async def stop(
         self,
         run: str | Run,

python/lib/sift_client/resources/sync_stubs/__init__.pyi

@@ -16,8 +16,8 @@ from sift_client.sift_types.calculated_channel import (
     CalculatedChannelCreate,
     CalculatedChannelUpdate,
 )
-from sift_client.sift_types.channel import Channel, ChannelReference
-from sift_client.sift_types.rule import Rule, RuleAction, RuleUpdate
+from sift_client.sift_types.channel import Channel
+from sift_client.sift_types.rule import Rule, RuleCreate, RuleUpdate
 from sift_client.sift_types.run import Run, RunCreate, RunUpdate
 
 class AssetsAPI:
@@ -113,7 +113,6 @@ class AssetsAPI:
             created_by: Filter assets created by this User or user ID.
             modified_by: Filter assets last modified by this User or user ID.
             tags: Filter assets with any of these Tags or tag names.
-            _tag_ids: Filter assets with any of these Tag IDs.
             metadata: Filter assets by metadata criteria.
             description_contains: Partial description of the asset.
             include_archived: If True, include archived assets in results.
@@ -126,6 +125,17 @@ class AssetsAPI:
         """
         ...
 
+    def unarchive(self, asset: str | Asset) -> Asset:
+        """Unarchive an asset.
+
+        Args:
+             asset: The Asset or asset ID to unarchive.
+
+        Returns:
+             The unarchived Asset.
+        """
+        ...
+
     def update(self, asset: str | Asset, update: AssetUpdate | dict) -> Asset:
         """Update an Asset.
 
@@ -159,8 +169,15 @@ class CalculatedChannelsAPI:
         ...
 
     def _run(self, coro): ...
-    def archive(self, calculated_channel: str | CalculatedChannel) -> None:
-        """Archive a Calculated Channel."""
+    def archive(self, calculated_channel: str | CalculatedChannel) -> CalculatedChannel:
+        """Archive a calculated channel.
+
+        Args:
+            calculated_channel: The id or CalculatedChannel object of the calculated channel to archive.
+
+        Returns:
+            The archived CalculatedChannel.
+        """
         ...
 
     def create(self, create: CalculatedChannelCreate | dict) -> CalculatedChannel:
@@ -229,7 +246,7 @@ class CalculatedChannelsAPI:
         order_by: str | None = None,
         limit: int | None = None,
     ) -> list[CalculatedChannel]:
-        """List calculated channels with optional filtering.
+        """List calculated channels with optional filtering. This will return the latest version. To find all versions, use `list_versions`.
 
         Args:
             name: Exact name of the calculated channel.
@@ -308,6 +325,17 @@ class CalculatedChannelsAPI:
         """
         ...
 
+    def unarchive(self, calculated_channel: str | CalculatedChannel) -> CalculatedChannel:
+        """Unarchive a calculated channel.
+
+        Args:
+            calculated_channel: The id or CalculatedChannel object of the calculated channel to unarchive.
+
+        Returns:
+            The unarchived CalculatedChannel.
+        """
+        ...
+
     def update(
         self,
         calculated_channel: CalculatedChannel | str,
@@ -493,63 +521,26 @@ class RulesAPI:
         ...
 
     def _run(self, coro): ...
-    def archive(
-        self,
-        *,
-        rule: str | Rule | None = None,
-        rules: list[Rule] | None = None,
-        rule_ids: list[str] | None = None,
-        client_keys: list[str] | None = None,
-    ) -> None:
-        """Archive a rule or multiple.
+    def archive(self, rule: str | Rule) -> Rule:
+        """Archive a rule.
 
         Args:
-            rule: The Rule to archive.
-            rules: The Rules to archive.
-            rule_ids: The rule IDs to archive.
-            client_keys: The client keys to archive.
-        """
-        ...
-
-    def batch_get(
-        self, *, rule_ids: list[str] | None = None, client_keys: list[str] | None = None
-    ) -> list[Rule]:
-        """Get multiple rules by rule IDs or client keys.
-
-        Args:
-            rule_ids: List of rule IDs to get.
-            client_keys: List of client keys to get.
+            rule: The id or Rule object of the rule to archive.
 
         Returns:
-            List of Rules.
+            The archived Rule.
         """
         ...
 
-    def batch_restore(
-        self, *, rule_ids: list[str] | None = None, client_keys: list[str] | None = None
-    ) -> None:
-        """Batch restore rules.
+    def create(self, create: RuleCreate | dict) -> Rule:
+        """Create a new rule.
 
         Args:
-            rule_ids: List of rule IDs to restore.
-            client_keys: List of client keys to undelete.
-        """
-        ...
+            create: A RuleCreate object or dictionary with configuration for the new rule.
 
-    def create(
-        self,
-        name: str,
-        description: str,
-        expression: str,
-        channel_references: list[ChannelReference],
-        action: RuleAction,
-        organization_id: str | None = None,
-        client_key: str | None = None,
-        asset_ids: list[str] | None = None,
-        contextual_channels: list[str] | None = None,
-        is_external: bool = False,
-    ) -> Rule:
-        """Create a new rule."""
+        Returns:
+            The created Rule.
+        """
         ...
 
     def find(self, **kwargs) -> Rule | None:
@@ -601,23 +592,19 @@ class RulesAPI:
         """
         ...
 
-    def restore(
-        self, *, rule: str | Rule, rule_id: str | None = None, client_key: str | None = None
-    ) -> Rule:
-        """Restore a rule.
+    def unarchive(self, rule: str | Rule) -> Rule:
+        """Unarchive a rule.
 
         Args:
-            rule: The Rule or rule ID to restore.
-            rule_id: The rule ID to restore (alternative to rule parameter).
-            client_key: The client key to restore (alternative to rule parameter).
+            rule: The id or Rule object of the rule to unarchive.
 
         Returns:
-            The restored Rule.
+            The unarchived Rule.
         """
         ...
 
     def update(
-        self, rule: str | Rule, update: RuleUpdate | dict, version_notes: str | None = None
+        self, rule: Rule | str, update: RuleUpdate | dict, *, version_notes: str | None = None
     ) -> Rule:
         """Update a Rule.
 
@@ -652,7 +639,7 @@ class RunsAPI:
         ...
 
     def _run(self, coro): ...
-    def archive(self, run: str | Run) -> None:
+    def archive(self, run: str | Run) -> Run:
         """Archive a run.
 
         Args:
@@ -777,6 +764,14 @@ class RunsAPI:
         """
         ...
 
+    def unarchive(self, run: str | Run) -> Run:
+        """Unarchive a run.
+
+        Args:
+            run: The Run or run ID to unarchive.
+        """
+        ...
+
     def update(self, run: str | Run, update: RunUpdate | dict) -> Run:
         """Update a Run.
 

python/lib/sift_client/sift_types/_base.py

@@ -4,7 +4,7 @@
 from typing import TYPE_CHECKING, Any, Callable, ClassVar, Generic, TypeVar
 
 from google.protobuf import field_mask_pb2, message
-from pydantic import BaseModel, ConfigDict, PrivateAttr
+from pydantic import BaseModel, ConfigDict, Field, PrivateAttr
 
 if TYPE_CHECKING:
     from sift_client.client import SiftClient
@@ -18,7 +18,7 @@ class BaseType(BaseModel, Generic[ProtoT, SelfT], ABC):
     model_config = ConfigDict(frozen=True)
 
     id_: str | None = None
-    proto: ProtoT | None = None
+    proto: Any | None = Field(default=None, exclude=True) # For user reference only
     _client: SiftClient | None = None
 
     @property