refactor: migrate lint tool from isort+black to ruff (#1963)

Author: waketzheng

Makefile

@@ -14,38 +14,39 @@ help:
 	@echo  "Targets:"
 	@echo  "    up      Updates dev/test dependencies"
 	@echo  "    deps    Ensure dev/test dependencies are installed"
-	@echo  "    check	Checks that build is sane"
-	@echo  "    test	Runs all tests"
-	@echo  "    docs 	Builds the documentation"
+	@echo  "    check   Checks that build is sane"
+	@echo  "    test    Runs all tests"
+	@echo  "    docs    Builds the documentation"
 	@echo  "    style   Auto-formats the code"
+	@echo  "    lint    Auto-formats the code and check type hints"
 
 up:
 	@poetry update
 
 deps:
-	@poetry install -E asyncpg -E aiomysql -E accel -E psycopg -E asyncodbc
+	@poetry install --all-groups -E asyncpg -E accel -E psycopg -E asyncodbc -E aiomysql
 
 deps_with_asyncmy:
-	@poetry install -E asyncpg -E asyncmy -E accel -E psycopg -E asyncodbc
+	@poetry install --all-groups -E asyncpg -E accel -E psycopg -E asyncodbc -E asyncmy
 
-check: deps build _check
+check: build _check
 _check:
-ifneq ($(shell which black),)
-	black --check $(checkfiles) || (echo "Please run 'make style' to auto-fix style issues" && false)
-endif
+	ruff format --check $(checkfiles) || (echo "Please run 'make style' to auto-fix style issues" && false)
 	ruff check $(checkfiles)
 	mypy $(checkfiles)
 	#pylint -d C,W,R $(checkfiles)
 	#bandit -r $(checkfiles)make
 	twine check dist/*
 
-lint: deps build
-ifneq ($(shell which black),)
-	black $(checkfiles)
-endif
+style: deps _style
+_style:
+	ruff format $(checkfiles)
 	ruff check --fix $(checkfiles)
+
+lint: build _lint
+_lint:
+	$(MAKE) _style
 	mypy $(checkfiles)
-	#pylint $(checkfiles)
 	bandit -c pyproject.toml -r $(checkfiles)
 	twine check dist/*
 
@@ -94,11 +95,6 @@ docs: deps
 	rm -fR ./build
 	sphinx-build -M html docs build
 
-style: deps _style
-_style:
-	isort -src $(checkfiles)
-	black $(checkfiles)
-
 build: deps
 	rm -fR dist/
 	poetry build

docs/CONTRIBUTING.rst

@@ -36,10 +36,10 @@ We have a ``Makefile`` that has the common operations listed, to get started jus
         up          Updates dev/test dependencies
         deps        Ensure dev/test dependencies are installed
         check       Checks that build is sane
-        lint        Reports all linter violations
         test        Runs all tests
         docs        Builds the documentation
         style       Auto-formats the code
+        lint        Auto-formats the code and check type hints
 
 So to run the tests you just need to run ``make test``, etc…
 
@@ -59,7 +59,7 @@ The code is structured in the following directories:
     Common DB Backend code
 ``tortoise/contrib/``:
     Anything that helps people use the project, such as Testing framework and linter plugins
-``tortoise/tests/``:
+``tests/``:
     The Tortoise test code
 
 

docs/conf.py

@@ -17,7 +17,10 @@
 import sys
 from datetime import datetime
 
-import importlib_metadata
+try:
+    import importlib.metadata as importlib_metadata
+except ImportError:
+    import importlib_metadata
 
 sys.path.insert(0, os.path.abspath("."))
 sys.path.insert(0, os.path.abspath(".."))

poetry.lock

@@ -11,7 +11,7 @@ include = ["CHANGELOG.rst", "LICENSE", "README.rst"]
 dynamic = [ "classifiers" ]
 requires-python = ">=3.9"
 dependencies = [
-    "pypika-tortoise (>=0.6.1,<1.0.0); python_version < '4.0'",
+    "pypika-tortoise (>=0.6.1,<1.0.0)",
     "iso8601 (>=2.1.0,<3.0.0); python_version < '4.0'",
     "aiosqlite (>=0.16.0,<1.0.0)",
     "pytz",
@@ -67,16 +67,15 @@ ruff = "*"
 darglint = "*"
 pylint = "*"
 bandit = "*"
-black = "*"
 codespell = "*"
-# Test tools
-coveralls = "*"
-pytest = "*"
-pytest-xdist = "*"
-pytest-cov = "*"
-pytest-codspeed = "*"
 # Pypi
 twine = "*"
+# mypy
+types-PyYAML = "*"
+types-pytz = "*"
+types-PyMySQL = "*"
+
+[tool.poetry.group.contrib.dependencies]
 # Sample integration - Quart
 quart = "*"
 # Sample integration - Sanic
@@ -95,10 +94,15 @@ aiohttp = "*"
 # BlackSheep support
 blacksheep = "^2.0.8"
 pytest-asyncio = ">=0.24.0"
-# mypy
-types-PyYAML = "*"
-types-pytz = "*"
-types-PyMySQL = "*"
+
+[tool.poetry.group.test.dependencies]
+# Test tools
+pytest = "*"
+pytest-xdist = "*"
+pytest-cov = "*"
+pytest-codspeed = "*"
+
+[tool.poetry.group.docs.dependencies]
 # Documentation tools
 sphinx-immaterial = "*"
 sphinx-copybutton = "*"
@@ -109,13 +113,6 @@ docutils = "*"
 requires = ["poetry-core>=2.0.0"]
 build-backend = "poetry.core.masonry.api"
 
-[tool.isort]
-profile = "black"
-
-[tool.black]
-line-length = 100
-target-version = ["py39", "py310", "py311", "py312", "py313"]
-
 [tool.mypy]
 pretty = true
 exclude = ["docs"]

pyproject.toml

@@ -88,9 +88,9 @@ async def test_ssl_custom(self):
             pass
 
     async def test_application_name(self):
-        self.db_config["connections"]["models"]["credentials"][
-            "application_name"
-        ] = "mytest_application"
+        self.db_config["connections"]["models"]["credentials"]["application_name"] = (
+            "mytest_application"
+        )
         await Tortoise.init(self.db_config, _create_db=True)
 
         conn = connections.get("models")

tests/backends/test_postgres.py

@@ -172,7 +172,7 @@ def init_fk_o2o_field(model: type[Model], field: str, is_o2o=False) -> None:
                 fk_object.to_field = related_model._meta.pk_attr
                 related_field = related_model._meta.pk
             key_fk_object = deepcopy(related_field)
-            fk_object.to_field_instance = related_field  # type:ignore[arg-type,call-overload]
+            fk_object.to_field_instance = related_field
             fk_object.field_type = fk_object.to_field_instance.field_type
 
             key_field = f"{field}_id"
@@ -215,7 +215,7 @@ def init_fk_o2o_field(model: type[Model], field: str, is_o2o=False) -> None:
                         description=fk_object.description,
                     )
                 )
-                fk_relation.to_field_instance = fk_object.to_field_instance  # type:ignore
+                fk_relation.to_field_instance = fk_object.to_field_instance
                 related_model._meta.add_field(backward_relation_name, fk_relation)
             if is_o2o and fk_object.pk:
                 model._meta.pk_attr = key_field
@@ -481,8 +481,8 @@ async def init(
             if not modules:
                 raise ConfigurationError('You must specify "db_url" and "modules" together')
             config = generate_config(db_url, modules)
-        else:
-            assert config is not None  # To improve type hints
+        elif config is None:
+            raise ConfigurationError('You must specify "config" or "config_file" or "db_url"')
 
         try:
             connections_config = config["connections"]

tortoise/__init__.py

@@ -531,9 +531,7 @@ def _make_prefetch_queries(self) -> None:
                 relation_field = self.model._meta.fields_map[field_name]
                 related_model: type[Model] = relation_field.related_model  # type: ignore
                 related_query = related_model.all().using_db(self.db)
-                related_query.query = copy(
-                    related_query.model._meta.basequery
-                )  # type:ignore[assignment]
+                related_query.query = copy(related_query.model._meta.basequery)  # type:ignore[assignment]
             if forwarded_prefetches:
                 related_query = related_query.prefetch_related(*forwarded_prefetches)
             self._prefetch_queries.setdefault(field_name, []).append((to_attr, related_query))

tortoise/backends/base/executor.py

@@ -98,9 +98,7 @@ def _create_json_criterion(
         operator.lt,
         operator.le,
         between_and,
-    ] or type(
-        value
-    ) in (int, float, Decimal):
+    ] or type(value) in (int, float, Decimal):
         criteria = Cast(criteria[0], "numeric"), criteria[1]
 
     return operator_(*criteria)

tortoise/contrib/postgres/json_functions.py

@@ -81,9 +81,7 @@ def register_tortoise(
 
     async def tortoise_init() -> None:
         await Tortoise.init(config=config, config_file=config_file, db_url=db_url, modules=modules)
-        logger.info(
-            "Tortoise-ORM started, %s, %s", connections._get_storage(), Tortoise.apps
-        )  # pylint: disable=W0212
+        logger.info("Tortoise-ORM started, %s, %s", connections._get_storage(), Tortoise.apps)  # pylint: disable=W0212
 
     if generate_schemas: