fix(analytics): rename analytics rule type to schema to avoid mypy issues

Author: tharropoulos

src/typesense/analytics_rule.py

@@ -1,7 +1,7 @@
 """Per-rule client for Analytics rules operations."""
 
 from typesense.api_call import ApiCall
-from typesense.types.analytics import AnalyticsRule
+from typesense.types.analytics import AnalyticsRuleSchema
 
 
 class AnalyticsRule:
@@ -15,15 +15,15 @@ def _endpoint_path(self) -> str:
 
         return "/".join([AnalyticsRules.resource_path, self.rule_name])
 
-    def retrieve(self) -> AnalyticsRule:
+    def retrieve(self) -> AnalyticsRuleSchema:
         response: AnalyticsRule = self.api_call.get(
             self._endpoint_path,
             as_json=True,
             entity_type=AnalyticsRule,
         )
         return response
 
-    def delete(self) -> AnalyticsRule:
+    def delete(self) -> AnalyticsRuleSchema:
         response: AnalyticsRule = self.api_call.delete(
             self._endpoint_path,
             entity_type=AnalyticsRule,

src/typesense/analytics_rules.py

@@ -7,10 +7,11 @@
 else:
     import typing_extensions as typing
 
+from typesense.analytics_rule import AnalyticsRule
 from typesense.api_call import ApiCall
 from typesense.types.analytics import (
-    AnalyticsRule,
     AnalyticsRuleCreate,
+    AnalyticsRuleSchema,
     AnalyticsRuleUpdate,
 )
 
@@ -20,40 +21,42 @@ class AnalyticsRules(object):
 
     def __init__(self, api_call: ApiCall) -> None:
         self.api_call = api_call
-        self.rules: typing.Dict[str, "AnalyticsRule"] = {}
+        self.rules: typing.Dict[str, AnalyticsRuleSchema] = {}
 
-    def __getitem__(self, rule_name: str) -> "AnalyticsRule":
+    def __getitem__(self, rule_name: str) -> AnalyticsRuleSchema:
         if rule_name not in self.rules:
-            from typesense.analytics_rule import AnalyticsRule as PerRule
+            self.rules[rule_name] = AnalyticsRule(self.api_call, rule_name)
+        return self.rules[rule_name]
 
-            self.rules[rule_name] = PerRule(self.api_call, rule_name)
-        return typing.cast("AnalyticsRule", self.rules[rule_name])
-
-    def create(self, rule: AnalyticsRuleCreate) -> AnalyticsRule:
-        response: AnalyticsRule = self.api_call.post(
+    def create(self, rule: AnalyticsRuleCreate) -> AnalyticsRuleSchema:
+        response: AnalyticsRuleSchema = self.api_call.post(
             AnalyticsRules.resource_path,
             body=rule,
             as_json=True,
-            entity_type=AnalyticsRule,
+            entity_type=AnalyticsRuleSchema,
         )
         return response
 
-    def retrieve(self, *, rule_tag: typing.Union[str, None] = None) -> typing.List[AnalyticsRule]:
+    def retrieve(
+        self, *, rule_tag: typing.Union[str, None] = None
+    ) -> typing.List[AnalyticsRuleSchema]:
         params: typing.Dict[str, str] = {}
         if rule_tag:
             params["rule_tag"] = rule_tag
-        response: typing.List[AnalyticsRule] = self.api_call.get(
+        response: typing.List[AnalyticsRuleSchema] = self.api_call.get(
             AnalyticsRules.resource_path,
             params=params if params else None,
             as_json=True,
-            entity_type=typing.List[AnalyticsRule],
+            entity_type=typing.List[AnalyticsRuleSchema],
         )
         return response
 
-    def upsert(self, rule_name: str, update: AnalyticsRuleUpdate) -> AnalyticsRule:
-        response: AnalyticsRule = self.api_call.put(
+    def upsert(
+        self, rule_name: str, update: AnalyticsRuleUpdate
+    ) -> AnalyticsRuleSchema:
+        response: AnalyticsRuleSchema = self.api_call.put(
             "/".join([AnalyticsRules.resource_path, rule_name]),
             body=update,
-            entity_type=AnalyticsRule,
+            entity_type=AnalyticsRuleSchema,
         )
-        return response
+        return response

src/typesense/types/analytics.py

@@ -51,6 +51,7 @@ class AnalyticsStatus(typing.TypedDict, total=False):
 
 # Rules
 
+
 class AnalyticsRuleParams(typing.TypedDict, total=False):
     destination_collection: typing.NotRequired[str]
     limit: typing.NotRequired[int]
@@ -76,7 +77,5 @@ class AnalyticsRuleUpdate(typing.TypedDict, total=False):
     params: AnalyticsRuleParams
 
 
-class AnalyticsRule(AnalyticsRuleCreate, total=False):
+class AnalyticsRuleSchema(AnalyticsRuleCreate, total=False):
     pass
-
-