refactor: moved imports under TYPE_CHECKING

Author: vlakius

tortoise/fields/data.py

@@ -4,7 +4,6 @@
 import datetime
 import functools
 import json
-import sys
 import warnings
 from collections.abc import Callable
 from decimal import Decimal
@@ -45,13 +44,14 @@
     _PydanticModelMetaclass = None  # type: ignore[assignment,misc]
 
 if TYPE_CHECKING:  # pragma: nocoverage
-    from tortoise.models import Model
+    import sys
 
+    from tortoise.models import Model
 
-if sys.version_info >= (3, 11):
-    from typing import Unpack
-else:  # pragma: no cover
-    from typing_extensions import Unpack
+    if sys.version_info >= (3, 11):
+        from typing import Unpack
+    else:  # pragma: no cover
+        from typing_extensions import Unpack
 
 __all__ = (
     "BigIntField",
@@ -333,7 +333,9 @@ def __init__(
                 stacklevel=2,
             )
             if index or db_index:
-                raise ConfigurationError("TextField can't be indexed, consider CharField")
+                raise ConfigurationError(
+                    "TextField can't be indexed, consider CharField"
+                )
         elif db_index:
             raise ConfigurationError("TextField can't be indexed, consider CharField")
 
@@ -429,7 +431,9 @@ def __init__(self, max_digits: int, decimal_places: int, **kwargs: Any) -> None:
         super().__init__(**kwargs)
         self.max_digits = max_digits
         self.decimal_places = decimal_places
-        self.quant = Decimal("1" if decimal_places == 0 else f"1.{('0' * decimal_places)}")
+        self.quant = Decimal(
+            "1" if decimal_places == 0 else f"1.{('0' * decimal_places)}"
+        )
 
     def to_python_value(self, value: Any) -> Decimal | None:
         if value is not None:
@@ -454,7 +458,9 @@ def function_cast(self, term: Term) -> Term:
 DatetimeFieldQueryValueType = TypeVar(
     "DatetimeFieldQueryValueType", datetime.datetime, int, float, str
 )
-DateFieldQueryValueType = TypeVar("DateFieldQueryValueType", datetime.date, int, float, str)
+DateFieldQueryValueType = TypeVar(
+    "DateFieldQueryValueType", datetime.date, int, float, str
+)
 
 
 class DatetimeField(Field[T_DATETIME], datetime.datetime):
@@ -504,7 +510,9 @@ def __init__(
         **kwargs: Unpack[FieldKwargs],
     ) -> None: ...
 
-    def __init__(self, auto_now: bool = False, auto_now_add: bool = False, **kwargs: Any) -> None:
+    def __init__(
+        self, auto_now: bool = False, auto_now_add: bool = False, **kwargs: Any
+    ) -> None:
         if auto_now_add and auto_now:
             raise ConfigurationError("You can choose only 'auto_now' or 'auto_now_add'")
         super().__init__(**kwargs)
@@ -644,7 +652,9 @@ def __init__(
         **kwargs: Unpack[FieldKwargs],
     ) -> None: ...
 
-    def __init__(self, auto_now: bool = False, auto_now_add: bool = False, **kwargs: Any) -> None:
+    def __init__(
+        self, auto_now: bool = False, auto_now_add: bool = False, **kwargs: Any
+    ) -> None:
         if auto_now_add and auto_now:
             raise ConfigurationError("You can choose only 'auto_now' or 'auto_now_add'")
         super().__init__(**kwargs)
@@ -743,7 +753,9 @@ def to_db_value(
 
         if value is None:
             return None
-        return (value.days * 86400000000) + (value.seconds * 1000000) + value.microseconds
+        return (
+            (value.days * 86400000000) + (value.seconds * 1000000) + value.microseconds
+        )
 
 
 class FloatField(Field[T_FLOAT], float):
@@ -907,7 +919,9 @@ def __init__(
     ) -> None: ...
 
     def __init__(self, **kwargs: Any) -> None:
-        if (kwargs.get("primary_key") or kwargs.get("pk", False)) and "default" not in kwargs:
+        if (
+            kwargs.get("primary_key") or kwargs.get("pk", False)
+        ) and "default" not in kwargs:
             kwargs["default"] = uuid4
         super().__init__(**kwargs)
 
@@ -982,7 +996,9 @@ def __init__(
 
         # Automatic description for the field if not specified by the user
         if description is None:
-            description = "\n".join([f"{e.name}: {int(e.value)}" for e in enum_type])[:2048]
+            description = "\n".join([f"{e.name}: {int(e.value)}" for e in enum_type])[
+                :2048
+            ]
 
         super().__init__(description=description, **kwargs)
         self.enum_type = enum_type
@@ -991,7 +1007,9 @@ def to_python_value(self, value: int | None) -> IntEnum | None:
         value = self.enum_type(value) if value is not None else None
         return value
 
-    def to_db_value(self, value: IntEnum | None | int, instance: type[Model] | Model) -> int | None:
+    def to_db_value(
+        self, value: IntEnum | None | int, instance: type[Model] | Model
+    ) -> int | None:
         if isinstance(value, IntEnum):
             value = int(value.value)
         if isinstance(value, int):
@@ -1038,7 +1056,9 @@ def __init__(
     ) -> None:
         # Automatic description for the field if not specified by the user
         if description is None:
-            description = "\n".join([f"{e.name}: {str(e.value)}" for e in enum_type])[:2048]
+            description = "\n".join([f"{e.name}: {str(e.value)}" for e in enum_type])[
+                :2048
+            ]
 
         # Automatic CharField max_length
         if max_length == 0:
@@ -1053,7 +1073,9 @@ def __init__(
     def to_python_value(self, value: str | None) -> Enum | None:
         return self.enum_type(value) if value is not None else None
 
-    def to_db_value(self, value: Enum | None | str, instance: type[Model] | Model) -> str | None:
+    def to_db_value(
+        self, value: Enum | None | str, instance: type[Model] | Model
+    ) -> str | None:
         self.validate(value)
         if isinstance(value, Enum):
             return str(value.value)

tortoise/fields/relational.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import sys
 import warnings
 from collections.abc import AsyncGenerator, Generator, Iterator
 from typing import TYPE_CHECKING, Any, Generic, Literal, TypeVar, overload
@@ -17,16 +16,18 @@
     RelationalFieldKwargs,
 )
 
-if sys.version_info >= (3, 11):
-    from typing import Unpack
-else:  # pragma: no cover
-    from typing_extensions import Unpack
-
 if TYPE_CHECKING:  # pragma: nocoverage
+    import sys
+
     from tortoise.backends.base.client import BaseDBAsyncClient
     from tortoise.models import Model
     from tortoise.queryset import Q, QuerySet
 
+    if sys.version_info >= (3, 11):
+        from typing import Unpack
+    else:  # pragma: no cover
+        from typing_extensions import Unpack
+
 MODEL = TypeVar("MODEL", bound="Model")
 
 
@@ -132,7 +133,9 @@ def offset(self, offset: int) -> QuerySet[MODEL]:
         """
         return self._query.offset(offset)
 
-    async def create(self, using_db: BaseDBAsyncClient | None = None, **kwargs: Any) -> MODEL:
+    async def create(
+        self, using_db: BaseDBAsyncClient | None = None, **kwargs: Any
+    ) -> MODEL:
         """
         Create a related record in the DB and returns the object, automatically setting the
         foreign key relationship to the parent instance.
@@ -164,7 +167,9 @@ async def create(self, using_db: BaseDBAsyncClient | None = None, **kwargs: Any)
         # Call remote model's create method
         return await self.remote_model.create(using_db=using_db, **kwargs)
 
-    def _set_result_for_query(self, sequence: list[MODEL], attr: str | None = None) -> None:
+    def _set_result_for_query(
+        self, sequence: list[MODEL], attr: str | None = None
+    ) -> None:
         self._fetched = True
         self.related_objects = sequence
         if attr:
@@ -182,12 +187,18 @@ class ManyToManyRelation(ReverseRelation[MODEL]):
     Many-to-many relation container for :func:`.ManyToManyField`.
     """
 
-    def __init__(self, instance: Model, m2m_field: ManyToManyFieldInstance[MODEL]) -> None:
-        super().__init__(m2m_field.related_model, m2m_field.related_name, instance, "pk")
+    def __init__(
+        self, instance: Model, m2m_field: ManyToManyFieldInstance[MODEL]
+    ) -> None:
+        super().__init__(
+            m2m_field.related_model, m2m_field.related_name, instance, "pk"
+        )
         self.field = m2m_field
         self.instance = instance
 
-    async def add(self, *instances: MODEL, using_db: BaseDBAsyncClient | None = None) -> None:
+    async def add(
+        self, *instances: MODEL, using_db: BaseDBAsyncClient | None = None
+    ) -> None:
         """
         Adds one or more of ``instances`` to the relation.
 
@@ -206,16 +217,25 @@ async def add(self, *instances: MODEL, using_db: BaseDBAsyncClient | None = None
         pks_f: list = []
         for instance_to_add in instances:
             if not instance_to_add._saved_in_db:
-                raise OperationalError(f"You should first call .save() on {instance_to_add}")
+                raise OperationalError(
+                    f"You should first call .save() on {instance_to_add}"
+                )
             pk_f = related_pk_formatting_func(instance_to_add.pk, instance_to_add)
             pks_f.append(pk_f)
         through_table = Table(self.field.through, schema=self.field.through_schema)
         backward_key, forward_key = self.field.backward_key, self.field.forward_key
-        backward_field, forward_field = through_table[backward_key], through_table[forward_key]
+        backward_field, forward_field = (
+            through_table[backward_key],
+            through_table[forward_key],
+        )
         select_query = (
-            db.query_class.from_(through_table).where(backward_field == pk_b).select(forward_key)
+            db.query_class.from_(through_table)
+            .where(backward_field == pk_b)
+            .select(forward_key)
+        )
+        criterion = (
+            forward_field == pks_f[0] if len(pks_f) == 1 else forward_field.isin(pks_f)
         )
-        criterion = forward_field == pks_f[0] if len(pks_f) == 1 else forward_field.isin(pks_f)
         select_query = select_query.where(criterion)
 
         _, already_existing_relations_raw = await db.execute_query(
@@ -227,7 +247,9 @@ async def add(self, *instances: MODEL, using_db: BaseDBAsyncClient | None = None
         }
 
         if pks_f_to_insert := set(pks_f) - already_existing_forward_pks:
-            query = db.query_class.into(through_table).columns(forward_field, backward_field)
+            query = db.query_class.into(through_table).columns(
+                forward_field, backward_field
+            )
             for pk_f in pks_f_to_insert:
                 query = query.insert(pk_f, pk_b)
             await db.execute_query(*query.get_parameterized_sql())
@@ -238,7 +260,9 @@ async def clear(self, using_db: BaseDBAsyncClient | None = None) -> None:
         """
         await self._remove_or_clear(using_db=using_db)
 
-    async def remove(self, *instances: MODEL, using_db: BaseDBAsyncClient | None = None) -> None:
+    async def remove(
+        self, *instances: MODEL, using_db: BaseDBAsyncClient | None = None
+    ) -> None:
         """
         Removes one or more of ``instances`` from the relation.
 
@@ -263,9 +287,9 @@ async def _remove_or_clear(
         if instances:
             related_pk_formatting_func = type(instances[0])._meta.pk.to_db_value
             if len(instances) == 1:
-                condition &= through_table[self.field.forward_key] == related_pk_formatting_func(
-                    instances[0].pk, instances[0]
-                )
+                condition &= through_table[
+                    self.field.forward_key
+                ] == related_pk_formatting_func(instances[0].pk, instances[0])
             else:
                 condition &= through_table[self.field.forward_key].isin(
                     [related_pk_formatting_func(i.pk, i) for i in instances]
@@ -293,7 +317,9 @@ def __init__(
     if TYPE_CHECKING:
 
         @overload
-        def __get__(self, instance: None, owner: type[Model]) -> RelationalField[MODEL]: ...
+        def __get__(
+            self, instance: None, owner: type[Model]
+        ) -> RelationalField[MODEL]: ...
 
         @overload
         def __get__(self, instance: Model, owner: type[Model]) -> MODEL: ...
@@ -322,7 +348,9 @@ def validate_model_name(cls, model_name: str | type[Model]) -> None:
                 ) from None
         elif len(model_name.split(".")) != 2:
             field_type = cls.__name__.replace("Instance", "")
-            raise ConfigurationError(f'{field_type} accepts model name in format "app.Model"')
+            raise ConfigurationError(
+                f'{field_type} accepts model name in format "app.Model"'
+            )
 
 
 class ForeignKeyFieldInstance(RelationalField[MODEL]):
@@ -342,7 +370,9 @@ def __init__(
                 "on_delete can only be CASCADE, RESTRICT, SET_NULL, SET_DEFAULT or NO_ACTION"
             )
         if on_delete == SET_NULL and not bool(kwargs.get("null")):
-            raise ConfigurationError("If on_delete is SET_NULL, then field must have null=True set")
+            raise ConfigurationError(
+                "If on_delete is SET_NULL, then field must have null=True set"
+            )
         self.on_delete = on_delete
 
     def describe(self, serializable: bool) -> dict: