feat: add pre commit config and fix issues

Author: waketzheng

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+ci:
+  autoupdate_schedule: monthly
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+    -   id: check-added-large-files
+    -   id: check-toml
+    -   id: check-yaml
+        args:
+        -   --unsafe
+    -   id: end-of-file-fixer
+        files: tortoise/
+    -   id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.15.9'
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix, --show-fixes, tortoise/, examples/, tests/, conftest.py]
+        pass_filenames: false
+      - id: ruff-format
+        args: [tortoise/, examples/, tests/, conftest.py]
+        pass_filenames: false
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.2
+    hooks:
+      - id: codespell  # See pyproject.toml for args
+        additional_dependencies:
+          - tomli

CHANGELOG.rst

@@ -1049,7 +1049,7 @@ Removals:
 
 0.15.15
 -------
-- Add ability to suppply a ``to_field=`` parameter for FK/O2O to a non-PK but still uniquely indexed remote field. (#287)
+- Add ability to supply a ``to_field=`` parameter for FK/O2O to a non-PK but still uniquely indexed remote field. (#287)
 
 0.15.14
 -------
@@ -1600,7 +1600,7 @@ Docs/examples:
 
 0.10.9
 ------
-- Uses macros on SQLite driver to minimise syncronisation. ``aiosqlite>=0.7.0``
+- Uses macros on SQLite driver to minimise synchronisation. ``aiosqlite>=0.7.0``
 - Uses prepared statements for insert, large insert performance increase.
 - Pre-generate base pypika query object per model, providing general purpose speedup.
 
@@ -1720,7 +1720,7 @@ Docs/examples:
 
 - Fixed ``DatetimeField`` and ``DateField`` to work as expected on SQLite.
 - Added ``PyLint`` plugin.
-- Added test class to mange DB state for testing isolation.
+- Added test class to manage DB state for testing isolation.
 
 0.8.0
 -----

docs/query.rst

@@ -122,7 +122,7 @@ You could do it using ``.prefetch_related()``:
     # This will fetch tournament with their events and teams for each event
     tournament_list = await Tournament.all().prefetch_related('events__participants')
 
-    # Fetched result for m2m and backward fk relations are stored in list-like containe#r
+    # Fetched result for m2m and backward fk relations are stored in list-like container
     for tournament in tournament_list:
         print([e.name for e in tournament.events])
 

examples/comprehensive_migrations_project/README.rst

@@ -3,7 +3,7 @@ Comprehensive Migrations Project
 ===================================
 
 This example demonstrates Tortoise ORM's complete migration system through a realistic ERP schema that evolves
-through 14 migrations. It covers all field types, migration operations (CreateModel, AddField, AlterField, 
+through 14 migrations. It covers all field types, migration operations (CreateModel, AddField, AlterField,
 RemoveField, RenameField, RunPython, RunSQL, indexes, constraints), and fully reversible migrations.
 
 Usage

pyproject.toml

@@ -236,3 +236,6 @@ exclude_dirs = [
     "examples/postgres_full_text_search.py",
     "examples/postgres.py",
 ]
+
+[tool.codespell]
+ignore-words-list = "notin,NotIn,brin,BRIN,astroid"

tests/fields/type_checks.py

@@ -92,7 +92,7 @@ class TypeTestModel(Model):
     char_enum_field_non_null = CharEnumField(enum_type=Color, max_length=10, null=False)
     char_enum_field_nullable = CharEnumField(enum_type=Color, max_length=10, null=True)
 
-    # inhereted fields
+    # inherited fields
     inhereted_int_field_non_null = InheretedFromIntField(null=False)
     inhereted_int_field_nullable = InheretedFromIntField(null=True)
 

tests/test_model_methods.py

@@ -266,7 +266,7 @@ async def test_update_or_create_with_defaults(tournament_model):
     assert created is False
     assert defaults["desc"] == updated_mdl.desc
     assert mdl.desc != updated_mdl.desc
-    # Hint query: use defauts to update without checking conflict
+    # Hint query: use defaults to update without checking conflict
     mdl2, created = await Tournament.update_or_create(
         id=oldid, desc=desc, defaults=dict(mdl_dict, desc="new desc")
     )

tortoise/models.py

@@ -873,7 +873,7 @@ def __iter__(self) -> Iterable[tuple]:
             yield field, getattr(self, field)
 
     def __eq__(self, other: object) -> bool:
-        return type(other) is type(self) and self.pk == other.pk  # type: ignore
+        return type(other) is type(self) and self.pk == other.pk
 
     def _get_pk_val(self) -> Any:
         return getattr(self, self._meta.pk_attr, None)

tortoise/queryset.py

@@ -1111,7 +1111,7 @@ def _resolve_only(self, only_lookup_expressions: tuple[str, ...]) -> None:
         fetch_to_fields = defaultdict(list)
         # the order is important here, we need to process the shallowest fields first
         # because we want to populate _select_related_idx with actual items that need to be
-        # selected, not "filler" items tha just tell the executor that an empty instance has
+        # selected, not "filler" items than just tell the executor that an empty instance has
         # to be created
         for expression in sorted(only_lookup_expressions, key=lambda x: x.count("__")):
             fetch_fields_lookup, __, field_name = expression.rpartition("__")