Use ruff for imports and formatting (#317)

Author: cbornet

.github/workflows/lint.yml

@@ -1,4 +1,4 @@
-name: ruff, isort, black and mypy checks
+name: ruff and mypy checks
 
 on:
   push:
@@ -27,27 +27,19 @@ jobs:
 
     - name: Ruff Linting AstraPy
       run: |
-        poetry run ruff astrapy
+        poetry run ruff check astrapy
 
     - name: Ruff Linting Tests
       run: |
-        poetry run ruff tests
+        poetry run ruff check tests
 
-    - name: Isort Linting AstraPy
+    - name: Ruff formatting astrapy
       run: |
-        poetry run isort --check astrapy --profile black
-
-    - name: Isort Linting Tests
-      run: |
-        poetry run isort --check tests --profile black
-  
-    - name: Black linting astrapy
-      run: |
-        poetry run black --check astrapy
+        poetry run ruff format --check astrapy
   
-    - name: Black linting tests
+    - name: Ruff formatting tests
       run: |
-        poetry run black --check tests
+        poetry run ruff format --check tests
 
     - name: Run MyPy AstraPy
       run: |

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
--   repo: https://github.com/psf/black
-    rev: 24.2.0  # Replace with your desired version or use 'stable'
-    hooks:
-    - id: black
-      args: ['--quiet']
-
+- repo: local
+  hooks:
+    - id: check
+      name: check
+      language: system
+      entry: make format-fix

Makefile

@@ -9,15 +9,13 @@ FMT_FLAGS ?= --check
 format: format-src format-tests
 
 format-tests:
-	poetry run ruff tests
-	poetry run isort tests $(FMT_FLAGS) --profile black
-	poetry run black tests $(FMT_FLAGS)
+	poetry run ruff check tests
+	poetry run ruff format tests $(FMT_FLAGS)
 	poetry run mypy tests
 
 format-src:
-	poetry run ruff astrapy
-	poetry run isort astrapy $(FMT_FLAGS) --profile black
-	poetry run black astrapy $(FMT_FLAGS)
+	poetry run ruff check astrapy
+	poetry run ruff format astrapy $(FMT_FLAGS)
 	poetry run mypy astrapy
 
 format-fix: format-fix-src format-fix-tests

README.md

@@ -242,7 +242,7 @@ Linter, style and typecheck should all pass for a PR:
 make format
 ```
 
-With `make format-fix` the style and imports are autofixed (by `black` and `isort` resp.)
+With `make format-fix` the style and imports are autofixed (by `ruff`)
 
 Features must be thoroughly covered in tests (see `tests/idiomatic/*` for
 naming convention and module structure).

astrapy/collection.py

@@ -937,7 +937,7 @@ def insert_many(
                 with ThreadPoolExecutor(max_workers=_concurrency) as executor:
 
                     def _chunk_insertor(
-                        document_chunk: List[Dict[str, Any]]
+                        document_chunk: List[Dict[str, Any]],
                     ) -> Dict[str, Any]:
                         im_payload = {
                             "insertMany": {
@@ -5397,7 +5397,6 @@ async def bulk_write(
             logger.info(f"finished a bulk write on '{self.name}'")
             return full_bw_result
         else:
-
             sem = asyncio.Semaphore(_concurrency)
 
             async def _concurrent_execute_as_either(

astrapy/core/utils.py

@@ -341,7 +341,7 @@ def is_list_of_floats(vector: Iterable[Any]) -> bool:
 
 
 def convert_to_ejson_date_object(
-    date_value: Union[datetime.date, datetime.datetime]
+    date_value: Union[datetime.date, datetime.datetime],
 ) -> Dict[str, int]:
     return {"$date": int(time.mktime(date_value.timetuple()) * 1000)}
 
@@ -355,7 +355,7 @@ def convert_to_ejson_objectid_object(objectid_value: ObjectId) -> Dict[str, str]
 
 
 def convert_ejson_date_object_to_datetime(
-    date_object: Dict[str, int]
+    date_object: Dict[str, int],
 ) -> datetime.datetime:
     return datetime.datetime.fromtimestamp(date_object["$date"] / 1000.0)
 
@@ -365,7 +365,7 @@ def convert_ejson_uuid_object_to_uuid(uuid_object: Dict[str, str]) -> UUID:
 
 
 def convert_ejson_objectid_object_to_objectid(
-    objectid_object: Dict[str, str]
+    objectid_object: Dict[str, str],
 ) -> ObjectId:
     return ObjectId(objectid_object["$objectId"])
 
@@ -402,7 +402,7 @@ def _normalize_payload_value(path: List[str], value: Any) -> Any:
 
 
 def normalize_for_api(
-    payload: Union[Dict[str, Any], None]
+    payload: Union[Dict[str, Any], None],
 ) -> Union[Dict[str, Any], None]:
     """
     Normalize a payload for API calls.

astrapy/cursors.py

@@ -73,7 +73,6 @@ def _maybe_valid_list_index(key_block: str) -> Optional[int]:
 def _create_document_key_extractor(
     key: str,
 ) -> Callable[[Dict[str, Any]], Iterable[Any]]:
-
     key_blocks0: List[IndexPairType] = [
         (kb_str, _maybe_valid_list_index(kb_str)) for kb_str in key.split(".")
     ]

astrapy/info.py

@@ -152,7 +152,7 @@ def as_dict(self) -> Dict[str, Any]:
 
     @staticmethod
     def from_dict(
-        raw_dict: Optional[Dict[str, Any]]
+        raw_dict: Optional[Dict[str, Any]],
     ) -> Optional[CollectionDefaultIDOptions]:
         """
         Create an instance of CollectionDefaultIDOptions from a dictionary
@@ -201,7 +201,7 @@ def as_dict(self) -> Dict[str, Any]:
 
     @staticmethod
     def from_dict(
-        raw_dict: Optional[Dict[str, Any]]
+        raw_dict: Optional[Dict[str, Any]],
     ) -> Optional[CollectionVectorServiceOptions]:
         """
         Create an instance of CollectionVectorServiceOptions from a dictionary
@@ -252,7 +252,7 @@ def as_dict(self) -> Dict[str, Any]:
 
     @staticmethod
     def from_dict(
-        raw_dict: Optional[Dict[str, Any]]
+        raw_dict: Optional[Dict[str, Any]],
     ) -> Optional[CollectionVectorOptions]:
         """
         Create an instance of CollectionVectorOptions from a dictionary

astrapy/transform_payload.py

@@ -46,7 +46,7 @@ def is_list_of_floats(vector: Iterable[Any]) -> bool:
 
 
 def convert_to_ejson_date_object(
-    date_value: Union[datetime.date, datetime.datetime]
+    date_value: Union[datetime.date, datetime.datetime],
 ) -> Dict[str, int]:
     return {"$date": int(time.mktime(date_value.timetuple()) * 1000)}
 
@@ -60,7 +60,7 @@ def convert_to_ejson_objectid_object(objectid_value: ObjectId) -> Dict[str, str]
 
 
 def convert_ejson_date_object_to_datetime(
-    date_object: Dict[str, int]
+    date_object: Dict[str, int],
 ) -> datetime.datetime:
     return datetime.datetime.fromtimestamp(date_object["$date"] / 1000.0)
 
@@ -70,7 +70,7 @@ def convert_ejson_uuid_object_to_uuid(uuid_object: Dict[str, str]) -> UUID:
 
 
 def convert_ejson_objectid_object_to_objectid(
-    objectid_object: Dict[str, str]
+    objectid_object: Dict[str, str],
 ) -> ObjectId:
     return ObjectId(objectid_object["$objectId"])
 
@@ -105,7 +105,7 @@ def normalize_payload_value(path: List[str], value: Any) -> Any:
 
 
 def normalize_for_api(
-    payload: Union[Dict[str, Any], None]
+    payload: Union[Dict[str, Any], None],
 ) -> Union[Dict[str, Any], None]:
     """
     Normalize a payload for API calls.

astrapy/user_agents.py

@@ -50,7 +50,7 @@ def compose_user_agent_string(
 
 
 def compose_full_user_agent(
-    callers: List[Tuple[Optional[str], Optional[str]]]
+    callers: List[Tuple[Optional[str], Optional[str]]],
 ) -> Optional[str]:
     user_agent_strings = [
         ua_string