Merge pull request #532 from pyinat/ruff

Use ruff for code formatting

.pre-commit-config.yaml

@@ -7,31 +7,20 @@ repos:
       - id: end-of-file-fixer
       - id: mixed-line-ending
       - id: trailing-whitespace
-  - repo: https://github.com/psf/black
-    rev: 23.10.1
-    hooks:
-      - id: black
-  - repo: https://github.com/asottile/blacken-docs
-    rev: 1.16.0
-    hooks:
-      - id: blacken-docs
-        args: [--skip-errors, --skip-string-normalization]
-  - repo: https://github.com/timothycrosley/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.1.4
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.7
     hooks:
       - id: ruff
-  - repo: https://github.com/yunojuno/pre-commit-xenon
-    rev: v0.1
-    hooks:
-      - id: xenon
-        args: [--max-average=A, --max-modules=C, --max-absolute=C]
+        args: [ --fix ]
+      - id: ruff-format
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.6.1
     hooks:
       - id: mypy
         additional_dependencies: [attrs, types-python-dateutil, types-requests, types-ujson]
         exclude: ^examples/
+  - repo: https://github.com/yunojuno/pre-commit-xenon
+    rev: v0.1
+    hooks:
+      - id: xenon
+        args: [--max-average=A, --max-modules=C, --max-absolute=C]

CONTRIBUTING.md

@@ -74,11 +74,10 @@ This isn't needed for internal changes (tests, other docs, refactoring, etc.).
 All parameters and return values should have type annotations, which will be checked by `mypy` and
 will show up in the documentation.
 
-### Formatting, Linting, Type Checking, Etc.
+### Linting & Formatting
 Code checking and formatting tools used include:
-* [black](https://github.com/psf/black)
-* [isort](https://pycqa.github.io/isort/)
-* [flake8](https://flake8.pycqa.org/en/latest/)
+* [ruff (linter)](https://docs.astral.sh/ruff/linter)
+* [ruff (formatter)](https://docs.astral.sh/ruff/formatter)
 * [mypy](https://mypy.readthedocs.io/en/stable/getting_started.html)
 
 All of these will be run by GitHub Actions on pull requests. You can also run them locally with:

pyinaturalist/controllers/place_controller.py

@@ -68,7 +68,7 @@ def nearby(
         swlat: float,
         swlng: float,
         name: Optional[str] = None,
-        **params
+        **params,
     ) -> Paginator[Place]:
         """Search for places near a given location
 

pyinaturalist/controllers/project_controller.py

@@ -88,7 +88,7 @@ def add_observations(
                 project_id=project_id,
                 observation_id=observation_id,
                 auth=True,
-                **params
+                **params,
             )
             responses.append(response)
         return responses

pyinaturalist/docs/model_docs.py

@@ -44,7 +44,7 @@ def get_model_doc(cls: Type, config: Config) -> List[Tuple[str, str, str]]:
     options in the description.
     """
     # Used internally by sphinx-autodoc-typehints
-    config._annotation_globals = getattr(cls, "__globals__", {})
+    config._annotation_globals = getattr(cls, '__globals__', {})
 
     doc_rows = [
         _get_field_doc(field, config)
@@ -58,7 +58,7 @@ def get_model_doc(cls: Type, config: Config) -> List[Tuple[str, str, str]]:
         _get_lazy_property_doc(prop, config) for _, prop in get_lazy_properties(cls).items()
     ]
 
-    delattr(config, "_annotation_globals")
+    delattr(config, '_annotation_globals')
     return doc_rows