Merge pull request #113 from ulgens/enable-ruff-formatter-ci

Enable ruff formatter in CI

Author: kishorenc

.github/workflows/test-and-lint.yml

@@ -47,6 +47,7 @@ jobs:
     - name: Lint with Ruff
       run: |
         uv run ruff check src/typesense
+        uv run ruff format src/typesense
 
     - name: Check types with mypy
       run: |

README.md

@@ -37,6 +37,3 @@ Bug reports and pull requests are welcome on GitHub at [https://github.com/types
 ## License
 
 `typesense-python` is distributed under the Apache 2 license.
-
-
-

src/typesense/analytics_events.py

@@ -69,5 +69,3 @@ def status(self) -> AnalyticsStatus:
             entity_type=AnalyticsStatus,
         )
         return response
-
-

src/typesense/analytics_v1.py

@@ -47,5 +47,3 @@ def __init__(self, api_call: ApiCall) -> None:
     @property
     def rules(self) -> AnalyticsRulesV1:
         return self._rules
-
-

src/typesense/collections.py

@@ -72,7 +72,6 @@ def __contains__(self, collection_name: str) -> bool:
         """
         if collection_name in self.collections:
             try:  # noqa: WPS229, WPS529
-
                 self.collections[collection_name].retrieve()  # noqa: WPS529
                 return True
             except Exception:
@@ -100,7 +99,7 @@ def __getitem__(self, collection_name: str) -> Collection[TDoc]:
 
         Example:
             >>> collections = Collections(api_call)
-            >>> fruits_collection = collections['fruits']
+            >>> fruits_collection = collections["fruits"]
         """
         if not self.collections.get(collection_name):
             self.collections[collection_name] = Collection(
@@ -126,11 +125,11 @@ def create(self, schema: CollectionCreateSchema) -> CollectionSchema:
             >>> schema = {
             ...     "name": "companies",
             ...     "fields": [
-            ...         {"name": "company_name", "type": "string" },
-            ...         {"name": "num_employees", "type": "int32" },
-            ...         {"name": "country", "type": "string", "facet": True }
+            ...         {"name": "company_name", "type": "string"},
+            ...         {"name": "num_employees", "type": "int32"},
+            ...         {"name": "country", "type": "string", "facet": True},
             ...     ],
-            ...     "default_sorting_field": "num_employees"
+            ...     "default_sorting_field": "num_employees",
             ... }
             >>> created_schema = collections.create(schema)
         """
@@ -154,7 +153,7 @@ def retrieve(self) -> typing.List[CollectionSchema]:
             >>> collections = Collections(api_call)
             >>> all_collections = collections.retrieve()
             >>> for collection in all_collections:
-            ...     print(collection['name'])
+            ...     print(collection["name"])
         """
         call: typing.List[CollectionSchema] = self.api_call.get(
             endpoint=Collections.resource_path,

src/typesense/configuration.py

@@ -223,7 +223,9 @@ def __init__(
         )
         self.verify = config_dict.get("verify", True)
         self.additional_headers = config_dict.get("additional_headers", {})
-        self.suppress_deprecation_warnings = config_dict.get("suppress_deprecation_warnings", False)
+        self.suppress_deprecation_warnings = config_dict.get(
+            "suppress_deprecation_warnings", False
+        )
 
     def _handle_nearest_node(
         self,

src/typesense/overrides.py

@@ -63,15 +63,15 @@ class Overrides:
 
     resource_path: typing.Final[str] = "overrides"
 
-    @warn_deprecation( # type: ignore[misc]
+    @warn_deprecation(  # type: ignore[misc]
         "Overrides is deprecated on v30+. Use client.curation_sets instead.",
         flag_name="overrides_deprecation",
     )
     def __init__(
         self,
         api_call: ApiCall,
         collection_name: str,
-    ) -> None:  
+    ) -> None:
         """
         Initialize the Overrides object.
 

src/typesense/synonyms.py

@@ -61,12 +61,12 @@ class Synonyms:
 
     resource_path: typing.Final[str] = "synonyms"
 
-    @warn_deprecation( # type: ignore[misc]
+    @warn_deprecation(  # type: ignore[misc]
         "The synonyms API (collections/{collection}/synonyms) is deprecated is removed on v30+. "
         "Use synonym sets (synonym_sets) instead.",
         flag_name="synonyms_deprecation",
     )
-    def __init__(self, api_call: ApiCall, collection_name: str) -> None:  
+    def __init__(self, api_call: ApiCall, collection_name: str) -> None:
         """
         Initialize the Synonyms object.
 

src/typesense/types/analytics_rule_v1.py

@@ -201,5 +201,3 @@ class RulesRetrieveSchema(typing.TypedDict):
     """
 
     rules: typing.List[typing.Union[RuleSchemaForQueries, RuleSchemaForCounters]]
-
-

src/typesense/types/collection.py

@@ -236,4 +236,3 @@ class CollectionUpdateSchema(typing.TypedDict):
     ]
     synonym_sets: typing.NotRequired[typing.List[str]]
     curation_sets: typing.NotRequired[typing.List[str]]
-