refactor: apply future type hints style (#416)

* refactor: apply future style type hints

* chore: put cryptography out of dev dependencies

Author: waketzheng

Makefile

@@ -1,5 +1,4 @@
 checkfiles = aerich/ tests/ conftest.py
-black_opts = -l 100 -t py38
 py_warn = PYTHONDEVMODE=1
 MYSQL_HOST ?= "127.0.0.1"
 MYSQL_PORT ?= 3306
@@ -15,12 +14,12 @@ deps:
 	@poetry install -E asyncpg -E asyncmy -E toml
 
 _style:
-	@isort -src $(checkfiles)
-	@black $(black_opts) $(checkfiles)
+	@ruff check --fix $(checkfiles)
+	@ruff format $(checkfiles)
 style: deps _style
 
 _check:
-	@black --check $(black_opts) $(checkfiles) || (echo "Please run 'make style' to auto-fix style issues" && false)
+	@ruff format --check $(checkfiles) || (echo "Please run 'make style' to auto-fix style issues" && false)
 	@ruff check $(checkfiles)
 	@mypy $(checkfiles)
 	@bandit -r aerich

aerich/__init__.py

@@ -1,6 +1,8 @@
+from __future__ import annotations
+
 import os
 from pathlib import Path
-from typing import TYPE_CHECKING, List, Optional, Type
+from typing import TYPE_CHECKING
 
 from tortoise import Tortoise, generate_schema_for_client
 from tortoise.exceptions import OperationalError
@@ -21,7 +23,7 @@
 )
 
 if TYPE_CHECKING:
-    from aerich.inspectdb import Inspect  # noqa:F401
+    from aerich.inspectdb import Inspect
 
 
 class Command:
@@ -51,7 +53,7 @@ async def _upgrade(self, conn, version_file, fake: bool = False) -> None:
             content=get_models_describe(self.app),
         )
 
-    async def upgrade(self, run_in_transaction: bool = True, fake: bool = False) -> List[str]:
+    async def upgrade(self, run_in_transaction: bool = True, fake: bool = False) -> list[str]:
         migrated = []
         for version_file in Migrate.get_all_version_files():
             try:
@@ -69,8 +71,8 @@ async def upgrade(self, run_in_transaction: bool = True, fake: bool = False) ->
                 migrated.append(version_file)
         return migrated
 
-    async def downgrade(self, version: int, delete: bool, fake: bool = False) -> List[str]:
-        ret: List[str] = []
+    async def downgrade(self, version: int, delete: bool, fake: bool = False) -> list[str]:
+        ret: list[str] = []
         if version == -1:
             specified_version = await Migrate.get_last_version()
         else:
@@ -102,23 +104,23 @@ async def downgrade(self, version: int, delete: bool, fake: bool = False) -> Lis
                 ret.append(file)
         return ret
 
-    async def heads(self) -> List[str]:
+    async def heads(self) -> list[str]:
         ret = []
         versions = Migrate.get_all_version_files()
         for version in versions:
             if not await Aerich.exists(version=version, app=self.app):
                 ret.append(version)
         return ret
 
-    async def history(self) -> List[str]:
+    async def history(self) -> list[str]:
         versions = Migrate.get_all_version_files()
         return [version for version in versions]
 
-    async def inspectdb(self, tables: Optional[List[str]] = None) -> str:
+    async def inspectdb(self, tables: list[str] | None = None) -> str:
         connection = get_app_connection(self.tortoise_config, self.app)
         dialect = connection.schema_generator.DIALECT
         if dialect == "mysql":
-            cls: Type["Inspect"] = InspectMySQL
+            cls: type[Inspect] = InspectMySQL
         elif dialect == "postgres":
             cls = InspectPostgres
         elif dialect == "sqlite":

aerich/cli.py

@@ -1,7 +1,9 @@
+from __future__ import annotations
+
 import os
 import sys
 from pathlib import Path
-from typing import Dict, List, cast
+from typing import cast
 
 import asyncclick as click
 from asyncclick import Context, UsageError
@@ -50,7 +52,7 @@ async def cli(ctx: Context, config, app) -> None:
         content = config_path.read_text("utf-8")
         doc: dict = tomllib.loads(content)
         try:
-            tool = cast(Dict[str, str], doc["tool"]["aerich"])
+            tool = cast("dict[str, str]", doc["tool"]["aerich"])
             location = tool["location"]
             tortoise_orm = tool["tortoise_orm"]
             src_folder = tool.get("src_folder", CONFIG_DEFAULT_VALUES["src_folder"])
@@ -274,7 +276,7 @@ async def init_db(ctx: Context, safe: bool) -> None:
     required=False,
 )
 @click.pass_context
-async def inspectdb(ctx: Context, table: List[str]) -> None:
+async def inspectdb(ctx: Context, table: list[str]) -> None:
     command = ctx.obj["command"]
     ret = await command.inspectdb(table)
     click.secho(ret)

aerich/coder.py

@@ -1,7 +1,9 @@
+from __future__ import annotations
+
 import base64
 import json
 import pickle  # nosec: B301,B403
-from typing import Any, Union
+from typing import Any
 
 from tortoise.indexes import Index
 
@@ -40,5 +42,5 @@ def encoder(obj: dict) -> str:
     return json.dumps(obj, cls=JsonEncoder)
 
 
-def decoder(obj: Union[str, bytes]) -> Any:
+def decoder(obj: str | bytes) -> Any:
     return json.loads(obj, object_hook=object_hook)

aerich/ddl/mysql/__init__.py

@@ -7,7 +7,7 @@
 from aerich.ddl import BaseDDL
 
 if TYPE_CHECKING:
-    from tortoise import Model  # noqa:F401
+    from tortoise import Model
 
 
 class MysqlDDL(BaseDDL):

aerich/ddl/sqlite/__init__.py

@@ -1,4 +1,4 @@
-from typing import Type
+from __future__ import annotations
 
 from tortoise import Model
 from tortoise.backends.sqlite.schema_generator import SqliteSchemaGenerator
@@ -13,14 +13,14 @@ class SqliteDDL(BaseDDL):
     _ADD_INDEX_TEMPLATE = 'CREATE {unique}INDEX "{index_name}" ON "{table_name}" ({column_names})'
     _DROP_INDEX_TEMPLATE = 'DROP INDEX IF EXISTS "{index_name}"'
 
-    def modify_column(self, model: "Type[Model]", field_object: dict, is_pk: bool = True):
+    def modify_column(self, model: type[Model], field_object: dict, is_pk: bool = True):
         raise NotSupportError("Modify column is unsupported in SQLite.")
 
-    def alter_column_default(self, model: "Type[Model]", field_describe: dict):
+    def alter_column_default(self, model: type[Model], field_describe: dict):
         raise NotSupportError("Alter column default is unsupported in SQLite.")
 
-    def alter_column_null(self, model: "Type[Model]", field_describe: dict):
+    def alter_column_null(self, model: type[Model], field_describe: dict):
         raise NotSupportError("Alter column null is unsupported in SQLite.")
 
-    def set_comment(self, model: "Type[Model]", field_describe: dict):
+    def set_comment(self, model: type[Model], field_describe: dict):
         raise NotSupportError("Alter column comment is unsupported in SQLite.")

aerich/inspectdb/__init__.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import contextlib
-from typing import Any, Callable, Dict, Optional, TypedDict
+from typing import Any, Callable, Dict, TypedDict
 
 from pydantic import BaseModel
 from tortoise import BaseDBAsyncClient
@@ -17,6 +17,7 @@ class ColumnInfoDict(TypedDict):
     comment: str
 
 
+# TODO: use dict to replace typing.Dict when dropping support for Python3.8
 FieldMapDict = Dict[str, Callable[..., str]]
 
 
@@ -25,14 +26,14 @@ class Column(BaseModel):
     data_type: str
     null: bool
     default: Any
-    comment: Optional[str] = None
+    comment: str | None = None
     pk: bool
     unique: bool
     index: bool
-    length: Optional[int] = None
-    extra: Optional[str] = None
-    decimal_places: Optional[int] = None
-    max_digits: Optional[int] = None
+    length: int | None = None
+    extra: str | None = None
+    decimal_places: int | None = None
+    max_digits: int | None = None
 
     def translate(self) -> ColumnInfoDict:
         comment = default = length = index = null = pk = ""

aerich/inspectdb/postgres.py

@@ -9,7 +9,7 @@
 
 
 class InspectPostgres(Inspect):
-    def __init__(self, conn: "BasePostgresClient", tables: list[str] | None = None) -> None:
+    def __init__(self, conn: BasePostgresClient, tables: list[str] | None = None) -> None:
         super().__init__(conn, tables)
         self.schema = conn.server_settings.get("schema") or "public"
 

aerich/migrate.py

@@ -2,9 +2,10 @@
 
 import importlib
 import os
+from collections.abc import Iterable
 from datetime import datetime
 from pathlib import Path
-from typing import Iterable, Optional, Union, cast
+from typing import cast
 
 import asyncclick as click
 import tortoise
@@ -49,11 +50,11 @@ class Migrate:
 
     ddl: BaseDDL
     ddl_class: type[BaseDDL]
-    _last_version_content: Optional[dict] = None
+    _last_version_content: dict | None = None
     app: str
     migrate_location: Path
     dialect: str
-    _db_version: Optional[str] = None
+    _db_version: str | None = None
 
     @staticmethod
     def get_field_by_name(name: str, fields: list[dict]) -> dict:
@@ -79,7 +80,7 @@ def _get_model(cls, model: str) -> type[Model]:
         return Tortoise.apps[cls.app].get(model)  # type: ignore
 
     @classmethod
-    async def get_last_version(cls) -> Optional[Aerich]:
+    async def get_last_version(cls) -> Aerich | None:
         try:
             return await Aerich.filter(app=cls.app).first()
         except OperationalError:
@@ -113,7 +114,7 @@ async def init(cls, config: dict, app: str, location: str) -> None:
         await cls._get_db_version(connection)
 
     @classmethod
-    async def _get_last_version_num(cls) -> Optional[int]:
+    async def _get_last_version_num(cls) -> int | None:
         last_version = await cls.get_last_version()
         if not last_version:
             return None
@@ -219,7 +220,7 @@ def _add_operator(cls, operator: str, upgrade: bool = True, fk_m2m_index: bool =
                 cls.downgrade_operators.append(operator)
 
     @classmethod
-    def _handle_indexes(cls, model: type[Model], indexes: list[Union[tuple[str], Index]]) -> list:
+    def _handle_indexes(cls, model: type[Model], indexes: list[tuple[str] | Index]) -> list:
         if tortoise.__version__ > "0.22.2":
             # The min version of tortoise is '0.11.0', so we can compare it by a `>`,
             # tortoise>0.22.2 have __eq__/__hash__ with Index class since 313ee76.
@@ -241,8 +242,8 @@ def _eq(self, other) -> bool:
         return indexes
 
     @classmethod
-    def _get_indexes(cls, model, model_describe: dict) -> set[Union[Index, tuple[str, ...]]]:
-        indexes: set[Union[Index, tuple[str, ...]]] = set()
+    def _get_indexes(cls, model, model_describe: dict) -> set[Index | tuple[str, ...]]:
+        indexes: set[Index | tuple[str, ...]] = set()
         for x in cls._handle_indexes(model, model_describe.get("indexes", [])):
             if isinstance(x, Index):
                 indexes.add(x)
@@ -686,7 +687,7 @@ def _resolve_fk_fields_name(cls, model: type[Model], fields_name: Iterable[str])
 
     @classmethod
     def _drop_index(
-        cls, model: type[Model], fields_name: Union[Iterable[str], Index], unique=False
+        cls, model: type[Model], fields_name: Iterable[str] | Index, unique=False
     ) -> str:
         if isinstance(fields_name, Index):
             if cls.dialect == "mysql":
@@ -707,7 +708,7 @@ def _drop_index(
 
     @classmethod
     def _add_index(
-        cls, model: type[Model], fields_name: Union[Iterable[str], Index], unique=False
+        cls, model: type[Model], fields_name: Iterable[str] | Index, unique=False
     ) -> str:
         if isinstance(fields_name, Index):
             if cls.dialect == "mysql":

aerich/utils.py

@@ -4,9 +4,9 @@
 import os
 import re
 import sys
+from collections.abc import Generator
 from pathlib import Path
 from types import ModuleType
-from typing import Generator, Optional, Union
 
 from asyncclick import BadOptionUsage, ClickException, Context
 from dictdiffer import diff
@@ -94,11 +94,11 @@ def get_models_describe(app: str) -> dict:
     return ret
 
 
-def is_default_function(string: str) -> Optional[re.Match]:
+def is_default_function(string: str) -> re.Match | None:
     return re.match(r"^<function.+>$", str(string or ""))
 
 
-def import_py_file(file: Union[str, Path]) -> ModuleType:
+def import_py_file(file: str | Path) -> ModuleType:
     module_name, file_ext = os.path.splitext(os.path.split(file)[-1])
     spec = importlib.util.spec_from_file_location(module_name, file)
     module = importlib.util.module_from_spec(spec)  # type:ignore[arg-type]

conftest.py

@@ -1,6 +1,8 @@
+from __future__ import annotations
+
 import asyncio
 import os
-from typing import Generator
+from collections.abc import Generator
 
 import pytest
 from tortoise import Tortoise, expand_db_url