feat: add project section (#424)

* refactor: apply future style type hints

* chore: use project section

* ci: upgrade to poetry v2

* ci: explicit declare python version for poetry

* fix error for generate index name

* fix _generate_fk_name

* ci: verify aiomysql support

* tests: poetry add

* Add patch to fix tortoise 0.24.1

* docs: update changelog

Author: waketzheng

.github/workflows/ci.yml

@@ -43,10 +43,16 @@ jobs:
             ${{ runner.os }}-pip-
       - name: Install and configure Poetry
         run: |
-          pip install -U pip poetry
-          poetry config virtualenvs.create false
+          pip install -U pip
+          if [[ "${{ matrix.python-version }}" == "3.8" ]]; then
+            # poetry2.0+ does not support installed by python3.8, but can manage project using py38
+            python3.12 -m pip install "poetry>=2.0"
+          else
+            pip install "poetry>=2.0"
+          fi
+          poetry env use python${{ matrix.python-version }}
       - name: Install dependencies and check style
-        run: make check
+        run: poetry run make check
       - name: Install TortoiseORM v0.21
         if: matrix.tortoise-orm == 'tortoise021'
         run: poetry run pip install --upgrade "tortoise-orm>=0.21,<0.22"
@@ -81,4 +87,16 @@ jobs:
           POSTGRES_PASS: 123456
           POSTGRES_HOST: 127.0.0.1
           POSTGRES_PORT: 5432
-        run: make _testall
+        run: poetry run make _testall
+      - name: Verify aiomysql support
+        if: matrix.tortoise-orm == 'tortoise024'
+        run: |
+            poetry run pip uninstall -y asyncmy
+            poetry run pip install aiomysql
+            poetry run make test_mysql
+            poetry run pip uninstall -y aiomysql
+            poetry run pip install asyncmy
+        env:
+          MYSQL_PASS: root
+          MYSQL_HOST: 127.0.0.1
+          MYSQL_PORT: 3306

CHANGELOG.md

@@ -8,6 +8,7 @@
 - feat: support command `python -m aerich`. ([#417])
 - feat: add --fake to upgrade/downgrade. ([#398])
 - Support ignore table by settings `managed=False` in `Meta` class. ([#397])
+- Support run `poetry add aerich` in project that inited by poetry v2. ([#424])
 
 #### Fixed
 - fix: aerich migrate raises tortoise.exceptions.FieldError when `index.INDEX_TYPE` is not empty. ([#415])
@@ -25,6 +26,7 @@
 [#412]: https://github.com/tortoise/aerich/pull/412
 [#415]: https://github.com/tortoise/aerich/pull/415
 [#417]: https://github.com/tortoise/aerich/pull/417
+[#424]: https://github.com/tortoise/aerich/pull/424
 
 ### [0.8.1](../../releases/tag/v0.8.1) - 2024-12-27
 

Makefile

@@ -11,7 +11,7 @@ up:
 	@poetry update
 
 deps:
-	@poetry install -E asyncpg -E asyncmy -E toml
+	@poetry install --all-extras --all-groups
 
 _style:
 	@ruff check --fix $(checkfiles)

aerich/__init__.py

@@ -5,6 +5,7 @@
 from pathlib import Path
 from typing import TYPE_CHECKING
 
+import tortoise
 from tortoise import Tortoise, generate_schema_for_client
 from tortoise.exceptions import OperationalError
 from tortoise.transactions import in_transaction
@@ -24,6 +25,9 @@
 )
 
 if TYPE_CHECKING:
+    from tortoise import Model
+    from tortoise.fields.relational import ManyToManyFieldInstance  # NOQA:F401
+
     from aerich.inspectdb import Inspect
 
 
@@ -47,7 +51,89 @@ def _init_asyncio_patch():
                 set_event_loop_policy(WindowsSelectorEventLoopPolicy())
 
 
+def _init_tortoise_0_24_1_patch():
+    # this patch is for "tortoise-orm==0.24.1" to fix:
+    # https://github.com/tortoise/tortoise-orm/issues/1893
+    if tortoise.__version__ != "0.24.1":
+        return
+    from tortoise.backends.base.schema_generator import BaseSchemaGenerator, cast, re
+
+    def _get_m2m_tables(
+        self, model: type[Model], table_name: str, safe: bool, models_tables: list[str]
+    ) -> list[str]:
+        m2m_tables_for_create = []
+        db_table = table_name
+        for m2m_field in model._meta.m2m_fields:
+            field_object = cast("ManyToManyFieldInstance", model._meta.fields_map[m2m_field])
+            if field_object._generated or field_object.through in models_tables:
+                continue
+            backward_key, forward_key = field_object.backward_key, field_object.forward_key
+            if field_object.db_constraint:
+                backward_fk = self._create_fk_string(
+                    "",
+                    backward_key,
+                    db_table,
+                    model._meta.db_pk_column,
+                    field_object.on_delete,
+                    "",
+                )
+                forward_fk = self._create_fk_string(
+                    "",
+                    forward_key,
+                    field_object.related_model._meta.db_table,
+                    field_object.related_model._meta.db_pk_column,
+                    field_object.on_delete,
+                    "",
+                )
+            else:
+                backward_fk = forward_fk = ""
+            exists = "IF NOT EXISTS " if safe else ""
+            table_name = field_object.through
+            backward_type = self._get_pk_field_sql_type(model._meta.pk)
+            forward_type = self._get_pk_field_sql_type(field_object.related_model._meta.pk)
+            comment = ""
+            if desc := field_object.description:
+                comment = self._table_comment_generator(table=table_name, comment=desc)
+            m2m_create_string = self.M2M_TABLE_TEMPLATE.format(
+                exists=exists,
+                table_name=table_name,
+                backward_fk=backward_fk,
+                forward_fk=forward_fk,
+                backward_key=backward_key,
+                backward_type=backward_type,
+                forward_key=forward_key,
+                forward_type=forward_type,
+                extra=self._table_generate_extra(table=field_object.through),
+                comment=comment,
+            )
+            if not field_object.db_constraint:
+                m2m_create_string = m2m_create_string.replace(
+                    """,
+    ,
+    """,
+                    "",
+                )  # may have better way
+            m2m_create_string += self._post_table_hook()
+            if field_object.create_unique_index:
+                unique_index_create_sql = self._get_unique_index_sql(
+                    exists, table_name, [backward_key, forward_key]
+                )
+                if unique_index_create_sql.endswith(";"):
+                    m2m_create_string += "\n" + unique_index_create_sql
+                else:
+                    lines = m2m_create_string.splitlines()
+                    lines[-2] += ","
+                    indent = m.group() if (m := re.match(r"\s+", lines[-2])) else ""
+                    lines.insert(-1, indent + unique_index_create_sql)
+                    m2m_create_string = "\n".join(lines)
+            m2m_tables_for_create.append(m2m_create_string)
+        return m2m_tables_for_create
+
+    BaseSchemaGenerator._get_m2m_tables = _get_m2m_tables
+
+
 _init_asyncio_patch()
+_init_tortoise_0_24_1_patch()
 
 
 class Command:

aerich/ddl/__init__.py

@@ -182,7 +182,11 @@ def change_column(
         )
 
     def _index_name(self, unique: bool | None, model: type[Model], field_names: list[str]) -> str:
-        return self.schema_generator._generate_index_name(
+        func_name = "_get_index_name"
+        if not hasattr(self.schema_generator, func_name):
+            # For tortoise-orm<0.24.1
+            func_name = "_generate_index_name"
+        return getattr(self.schema_generator, func_name)(
             "idx" if not unique else "uid", model, field_names
         )
 
@@ -227,7 +231,11 @@ def _generate_fk_name(
         pk_field = cast(dict, reference_table_describe.get("pk_field"))
         to_field = cast(str, pk_field.get("db_column"))
         to_table = cast(str, reference_table_describe.get("table"))
-        return self.schema_generator._generate_fk_name(
+        func_name = "_get_fk_name"
+        if not hasattr(self.schema_generator, func_name):
+            # For tortoise-orm<0.24.1
+            func_name = "_generate_fk_name"
+        return getattr(self.schema_generator, func_name)(
             from_table=db_table,
             from_field=db_column,
             to_table=to_table,

aerich/ddl/mysql/__init__.py

@@ -43,16 +43,12 @@ class MysqlDDL(BaseDDL):
     _RENAME_TABLE_TEMPLATE = "ALTER TABLE `{old_table_name}` RENAME TO `{new_table_name}`"
 
     def _index_name(self, unique: bool | None, model: type[Model], field_names: list[str]) -> str:
-        if unique:
-            if len(field_names) == 1:
-                # Example: `email = CharField(max_length=50, unique=True)`
-                # Generate schema: `"email" VARCHAR(10) NOT NULL UNIQUE`
-                # Unique index key is the same as field name: `email`
-                return field_names[0]
-            index_prefix = "uid"
-        else:
-            index_prefix = "idx"
-        return self.schema_generator._generate_index_name(index_prefix, model, field_names)
+        if unique and len(field_names) == 1:
+            # Example: `email = CharField(max_length=50, unique=True)`
+            # Generate schema: `"email" VARCHAR(10) NOT NULL UNIQUE`
+            # Unique index key is the same as field name: `email`
+            return field_names[0]
+        return super()._index_name(unique, model, field_names)
 
     def alter_indexed_column_unique(
         self, model: type[Model], field_name: str, drop: bool = False