refactor: apply future type hints style (#1884)

* refactor: apply future style type hints

* docs: update changelog

* Add RUF100 to ruff extend check rules

* Fix codacy issues

* refactor: change some function names from `_generate_xxx` to `_get_xxx`

* refactor: change function name

* refactor: more readable string format

* fix codacy issues

Author: waketzheng

Makefile

@@ -41,9 +41,9 @@ endif
 
 lint: deps build
 ifneq ($(shell which black),)
-	black --check $(checkfiles) || (echo "Please run 'make style' to auto-fix style issues" && false)
+	black $(checkfiles)
 endif
-	ruff check $(checkfiles)
+	ruff check --fix $(checkfiles)
 	mypy $(checkfiles)
 	#pylint $(checkfiles)
 	bandit -c pyproject.toml -r $(checkfiles)

examples/blacksheep/server.py

@@ -1,5 +1,6 @@
 # pylint: disable=E0401,E0611
-from typing import Union
+from __future__ import annotations
+
 from uuid import UUID
 
 from blacksheep import Response
@@ -25,7 +26,7 @@
 
 
 @app.router.get("/")
-async def users_list() -> Union[UserPydanticOut]:
+async def users_list() -> UserPydanticOut:
     return ok(await UserPydanticOut.from_queryset(Users.all()))
 
 

examples/fastapi/schemas.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import TYPE_CHECKING
 
 from models import Users

examples/signals.py

@@ -2,7 +2,7 @@
 This example demonstrates model signals usage
 """
 
-from typing import Optional
+from __future__ import annotations
 
 from tortoise import BaseDBAsyncClient, Tortoise, fields, run_async
 from tortoise.models import Model
@@ -21,33 +21,31 @@ def __str__(self):
 
 
 @pre_save(Signal)
-async def signal_pre_save(
-    sender: "type[Signal]", instance: Signal, using_db, update_fields
-) -> None:
+async def signal_pre_save(sender: type[Signal], instance: Signal, using_db, update_fields) -> None:
     print(sender, instance, using_db, update_fields)
 
 
 @post_save(Signal)
 async def signal_post_save(
-    sender: "type[Signal]",
+    sender: type[Signal],
     instance: Signal,
     created: bool,
-    using_db: "Optional[BaseDBAsyncClient]",
+    using_db: BaseDBAsyncClient | None,
     update_fields: list[str],
 ) -> None:
     print(sender, instance, using_db, created, update_fields)
 
 
 @pre_delete(Signal)
 async def signal_pre_delete(
-    sender: "type[Signal]", instance: Signal, using_db: "Optional[BaseDBAsyncClient]"
+    sender: type[Signal], instance: Signal, using_db: BaseDBAsyncClient | None
 ) -> None:
     print(sender, instance, using_db)
 
 
 @post_delete(Signal)
 async def signal_post_delete(
-    sender: "type[Signal]", instance: Signal, using_db: "Optional[BaseDBAsyncClient]"
+    sender: type[Signal], instance: Signal, using_db: BaseDBAsyncClient | None
 ) -> None:
     print(sender, instance, using_db)
 

pyproject.toml

@@ -198,6 +198,11 @@ show_missing = true
 line-length = 100
 [tool.ruff.lint]
 ignore = ["E501"]
+extend-select = [
+    "FA",     # https://docs.astral.sh/ruff/rules/#flake8-future-annotations-fa
+    "UP",     # https://docs.astral.sh/ruff/rules/#pyupgrade-up
+    "RUF100", # https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf
+]
 
 [tool.bandit]
 exclude_dirs = ["tests", 'examples/*/_tests.py', "conftest.py"]

tests/backends/test_capabilities.py

@@ -6,7 +6,7 @@ class TestCapabilities(test.TestCase):
     # pylint: disable=E1101
 
     async def asyncSetUp(self) -> None:
-        await super(TestCapabilities, self).asyncSetUp()
+        await super().asyncSetUp()
         self.db = connections.get("models")
         self.caps = self.db.capabilities
 

tests/benchmarks/test_bulk_create.py

@@ -9,7 +9,8 @@ def test_bulk_create_few_fields(benchmark):
 
     data = [
         BenchmarkFewFields(
-            level=random.choice([10, 20, 30, 40, 50]), text=f"Insert from C, item {i}"  # nosec
+            level=random.choice([10, 20, 30, 40, 50]),  # nosec
+            text=f"Insert from C, item {i}",
         )
         for i in range(100)
     ]

tests/contrib/test_pydantic.py

@@ -29,7 +29,7 @@
 
 class TestPydantic(test.TestCase):
     async def asyncSetUp(self) -> None:
-        await super(TestPydantic, self).asyncSetUp()
+        await super().asyncSetUp()
         self.Event_Pydantic = pydantic_model_creator(Event)
         self.Event_Pydantic_List = pydantic_queryset_creator(Event)
         self.Tournament_Pydantic = pydantic_model_creator(Tournament)
@@ -1392,7 +1392,7 @@ def test_exclude_readonly(self):
 
 class TestPydanticCycle(test.TestCase):
     async def asyncSetUp(self) -> None:
-        await super(TestPydanticCycle, self).asyncSetUp()
+        await super().asyncSetUp()
         self.Employee_Pydantic = pydantic_model_creator(Employee)
 
         self.root = await Employee.create(name="Root")
@@ -1599,7 +1599,7 @@ async def test_serialisation(self):
 
 class TestPydanticComputed(test.TestCase):
     async def asyncSetUp(self) -> None:
-        await super(TestPydanticComputed, self).asyncSetUp()
+        await super().asyncSetUp()
         self.Employee_Pydantic = pydantic_model_creator(Employee)
         self.employee = await Employee.create(name="Some Employee")
         self.maxDiff = None

tests/fields/subclass_fields.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from enum import Enum, IntEnum
 from typing import Any
 

tests/fields/test_db_index.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Any
 
 from pypika_tortoise.terms import Field
@@ -45,7 +47,7 @@ def test_index_repr(self):
         assert repr(Index(fields=("id",))) == "Index(fields=['id'])"
         assert repr(Index(fields=("id", "name"))) == "Index(fields=['id', 'name'])"
         assert repr(Index(fields=("id",), name="MyIndex")) == "Index(fields=['id'], name='MyIndex')"
-        assert repr(Index(Field("id"))) == f'Index({str(Field("id"))})'
+        assert repr(Index(Field("id"))) == f"Index({str(Field('id'))})"
         assert repr(Index(Field("a"), name="Id")) == f"Index({str(Field('a'))}, name='Id')"
         with self.assertRaises(ConfigurationError):
             Index(Field("id"), fields=("name",))