upgrade deps

.github/FUNDING.yml

@@ -1 +1 @@
-custom: ["https://sponsor.long2ice.cn"]
+custom: ["https://sponsor.long2ice.io"]

.github/workflows/ci.yml

@@ -26,9 +26,9 @@ jobs:
         with:
           python-version: '3.x'
       - name: Install and configure Poetry
-        uses: snok/install-poetry@v1.1.1
-        with:
-          virtualenvs-create: false
+        run: |
+          pip install -U pip poetry
+          poetry config virtualenvs.create false
       - name: CI
         env:
           MYSQL_PASS: root

.github/workflows/pypi.yml

@@ -12,9 +12,9 @@ jobs:
         with:
           python-version: '3.x'
       - name: Install and configure Poetry
-        uses: snok/install-poetry@v1.1.1
-        with:
-          virtualenvs-create: false
+        run: |
+          pip install -U pip poetry
+          poetry config virtualenvs.create false
       - name: Build dists
         run: make build
       - name: Pypi Publish

CHANGELOG.md

@@ -1,7 +1,35 @@
 # ChangeLog
 
+## 0.6
+
+### 0.6.2
+
+- Support migration for specified index. (#203)
+
+### 0.6.1
+
+- Fix `pyproject.toml` not existing error. (#217)
+
+### 0.6.0
+
+- Change default config file from `aerich.ini` to `pyproject.toml`. (#197)
+
+  **Upgrade note:**
+    1. Run `aerich init -t config.TORTOISE_ORM`.
+    2. Remove `aerich.ini`.
+- Remove `pydantic` dependency. (#198)
+- `inspectdb` support `DATE`. (#215)
+
 ## 0.5
 
+### 0.5.8
+
+- Support `indexes` change. (#193)
+
+### 0.5.7
+
+- Fix no module found error. (#188) (#189)
+
 ### 0.5.6
 
 - Add `Command` class. (#148) (#141) (#123) (#106)

Makefile

@@ -12,7 +12,7 @@ up:
 	@poetry update
 
 deps:
-	@poetry install -E asyncpg -E asyncmy -E aiomysql
+	@poetry install -E asyncpg -E asyncmy
 
 style: deps
 	isort -src $(checkfiles)

README.md

@@ -7,7 +7,7 @@
 
 ## Introduction
 
-Aerich is a database migrations tool for Tortoise-ORM, which is like alembic for SQLAlchemy, or like Django ORM with
+Aerich is a database migrations tool for TortoiseORM, which is like alembic for SQLAlchemy, or like Django ORM with
 it\'s own migration solution.
 
 ## Install
@@ -15,7 +15,7 @@ it\'s own migration solution.
 Just install from pypi:
 
 ```shell
-> pip install aerich
+pip install aerich
 ```
 
 ## Quick Start
@@ -27,11 +27,8 @@ Usage: aerich [OPTIONS] COMMAND [ARGS]...
 
 Options:
   -V, --version      Show the version and exit.
-  -c, --config TEXT  Config file.  [default: aerich.ini]
+  -c, --config TEXT  Config file.  [default: pyproject.toml]
   --app TEXT         Tortoise-ORM app name.
-  -n, --name TEXT    Name of section in .ini file to use for aerich config.
-                     [default: aerich]
-
   -h, --help         Show this message and exit.
 
 Commands:
@@ -70,10 +67,9 @@ Usage: aerich init [OPTIONS]
 
   Init config file and generate root migrate location.
 
-OOptions:
+Options:
   -t, --tortoise-orm TEXT  Tortoise-ORM config module dict variable, like
                            settings.TORTOISE_ORM.  [required]
-
   --location TEXT          Migrate store location.  [default: ./migrations]
   -s, --src_folder TEXT    Folder of the source, relative to the project root.
   -h, --help               Show this message and exit.
@@ -85,7 +81,7 @@ Initialize the config file and migrations location:
 > aerich init -t tests.backends.mysql.TORTOISE_ORM
 
 Success create migrate location ./migrations
-Success generate config file aerich.ini
+Success write config to pyproject.toml
 ```
 
 ### Init db

aerich/__init__.py

@@ -1,5 +1,3 @@
-__version__ = "0.5.6"
-
 import os
 from pathlib import Path
 from typing import List
@@ -14,7 +12,6 @@ from aerich.inspectdb import InspectDb
 from aerich.migrate import Migrate
 from aerich.models import Aerich
 from aerich.utils import (
-    add_src_path,
     get_app_connection,
     get_app_connection_name,
     get_models_describe,
@@ -29,14 +26,11 @@ class Command:
         tortoise_config: dict,
         app: str = "models",
         location: str = "./migrations",
-        src_folder: str = ".",
     ):
         self.tortoise_config = tortoise_config
         self.app = app
         self.location = location
-        self.src_folder = src_folder
         Migrate.app = app
-        add_src_path(src_folder)
 
     async def init(self):
         await Migrate.init(self.tortoise_config, self.app, self.location)

aerich/cli.py

@@ -1,21 +1,20 @@
 import asyncio
 import os
-from configparser import ConfigParser
 from functools import wraps
 from pathlib import Path
 from typing import List
 
 import click
+import tomlkit
 from click import Context, UsageError
+from tomlkit.exceptions import NonExistentKey
 from tortoise import Tortoise
 
+from aerich import Command
+from aerich.enums import Color
 from aerich.exceptions import DowngradeError
 from aerich.utils import add_src_path, get_tortoise_config
-
-from . import Command, __version__
-from .enums import Color
-
-parser = ConfigParser()
+from aerich.version import __version__
 
 CONFIG_DEFAULT_VALUES = {
     "src_folder": ".",
@@ -42,39 +41,35 @@ def coro(f):
 @click.option(
     "-c",
     "--config",
-    default="aerich.ini",
+    default="pyproject.toml",
     show_default=True,
     help="Config file.",
 )
 @click.option("--app", required=False, help="Tortoise-ORM app name.")
-@click.option(
-    "-n",
-    "--name",
-    default="aerich",
-    show_default=True,
-    help="Name of section in .ini file to use for aerich config.",
-)
 @click.pass_context
 @coro
-async def cli(ctx: Context, config, app, name):
+async def cli(ctx: Context, config, app):
     ctx.ensure_object(dict)
     ctx.obj["config_file"] = config
-    ctx.obj["name"] = name
 
     invoked_subcommand = ctx.invoked_subcommand
     if invoked_subcommand != "init":
         if not Path(config).exists():
             raise UsageError("You must exec init first", ctx=ctx)
-        parser.read(config)
-
-        location = parser[name]["location"]
-        tortoise_orm = parser[name]["tortoise_orm"]
-        src_folder = parser[name].get("src_folder", CONFIG_DEFAULT_VALUES["src_folder"])
+        with open(config, "r") as f:
+            content = f.read()
+        doc = tomlkit.parse(content)
+        try:
+            tool = doc["tool"]["aerich"]
+            location = tool["location"]
+            tortoise_orm = tool["tortoise_orm"]
+            src_folder = tool.get("src_folder", CONFIG_DEFAULT_VALUES["src_folder"])
+        except NonExistentKey:
+            raise UsageError("You need run aerich init again when upgrade to 0.6.0+")
+        add_src_path(src_folder)
         tortoise_config = get_tortoise_config(ctx, tortoise_orm)
         app = app or list(tortoise_config.get("apps").keys())[0]
-        command = Command(
-            tortoise_config=tortoise_config, app=app, location=location, src_folder=src_folder
-        )
+        command = Command(tortoise_config=tortoise_config, app=app, location=location)
         ctx.obj["command"] = command
         if invoked_subcommand != "init-db":
             if not Path(location, app).exists():
@@ -187,9 +182,6 @@ async def history(ctx: Context):
 @coro
 async def init(ctx: Context, tortoise_orm, location, src_folder):
     config_file = ctx.obj["config_file"]
-    name = ctx.obj["name"]
-    if Path(config_file).exists():
-        return click.secho("Configuration file already created", fg=Color.yellow)
 
     if os.path.isabs(src_folder):
         src_folder = os.path.relpath(os.getcwd(), src_folder)
@@ -200,19 +192,25 @@ async def init(ctx: Context, tortoise_orm, location, src_folder):
     # check that we can find the configuration, if not we can fail before the config file gets created
     add_src_path(src_folder)
     get_tortoise_config(ctx, tortoise_orm)
+    if Path(config_file).exists():
+        with open(config_file, "r") as f:
+            content = f.read()
+        doc = tomlkit.parse(content)
+    else:
+        doc = tomlkit.parse("[tool.aerich]")
+    table = tomlkit.table()
+    table["tortoise_orm"] = tortoise_orm
+    table["location"] = location
+    table["src_folder"] = src_folder
+    doc["tool"]["aerich"] = table
 
-    parser.add_section(name)
-    parser.set(name, "tortoise_orm", tortoise_orm)
-    parser.set(name, "location", location)
-    parser.set(name, "src_folder", src_folder)
-
-    with open(config_file, "w", encoding="utf-8") as f:
-        parser.write(f)
+    with open(config_file, "w") as f:
+        f.write(tomlkit.dumps(doc))
 
     Path(location).mkdir(parents=True, exist_ok=True)
 
     click.secho(f"Success create migrate location {location}", fg=Color.green)
-    click.secho(f"Success generate config file {config_file}", fg=Color.green)
+    click.secho(f"Success write config to {config_file}", fg=Color.green)
 
 
 @cli.command(help="Generate schema and generate app migrate location.")

aerich/coder.py

@@ -0,0 +1,31 @@
+import base64
+import json
+import pickle  # nosec: B301
+
+from tortoise.indexes import Index
+
+
+class JsonEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, Index):
+            return {
+                "type": "index",
+                "val": base64.b64encode(pickle.dumps(obj)).decode(),
+            }  # nosec: B301
+        else:
+            return super().default(obj)
+
+
+def object_hook(obj):
+    _type = obj.get("type")
+    if not _type:
+        return obj
+    return pickle.loads(base64.b64decode(obj["val"]))  # nosec: B301
+
+
+def encoder(obj: dict):
+    return json.dumps(obj, cls=JsonEncoder)
+
+
+def decoder(obj: str):
+    return json.loads(obj, object_hook=object_hook)

aerich/ddl/__init__.py

@@ -195,6 +195,12 @@ class BaseDDL:
             table_name=model._meta.db_table,
         )
 
+    def drop_index_by_name(self, model: "Type[Model]", index_name: str):
+        return self._DROP_INDEX_TEMPLATE.format(
+            index_name=index_name,
+            table_name=model._meta.db_table,
+        )
+
     def add_fk(self, model: "Type[Model]", field_describe: dict, reference_table_describe: dict):
         db_table = model._meta.db_table
 

aerich/inspectdb.py

@@ -16,6 +16,7 @@ class InspectDb:
         "TEXT": "    {field} = fields.TextField({null}{default}{comment})",
         "DATETIME": "    {field} = fields.DatetimeField({null}{default}{comment})",
         "FLOAT": "    {field} = fields.FloatField({null}{default}{comment})",
+        "DATE": "    {field} = fields.DateField({null}{default}{comment})",
     }
 
     def __init__(self, conn: BaseDBAsyncClient, tables: Optional[List[str]] = None):

aerich/migrate.py

@@ -1,12 +1,14 @@
 import os
 from datetime import datetime
+from hashlib import md5
 from pathlib import Path
-from typing import Dict, List, Optional, Tuple, Type
+from typing import Dict, List, Optional, Tuple, Type, Union
 
 import click
 from dictdiffer import diff
 from tortoise import BaseDBAsyncClient, Model, Tortoise
 from tortoise.exceptions import OperationalError
+from tortoise.indexes import Index
 
 from aerich.ddl import BaseDDL
 from aerich.models import MAX_VERSION_LENGTH, Aerich
@@ -32,7 +34,7 @@ class Migrate:
     ddl: BaseDDL
     _last_version_content: Optional[dict] = None
     app: str
-    migrate_location: str
+    migrate_location: Path
     dialect: str
     _db_version: Optional[str] = None
 
@@ -138,25 +140,37 @@ class Migrate:
         return await cls._generate_diff_sql(name)
 
     @classmethod
-    def _add_operator(cls, operator: str, upgrade=True, fk_m2m=False):
+    def _add_operator(cls, operator: str, upgrade=True, fk_m2m_index=False):
         """
         add operator,differentiate fk because fk is order limit
         :param operator:
         :param upgrade:
-        :param fk_m2m:
+        :param fk_m2m_index:
         :return:
         """
         if upgrade:
-            if fk_m2m:
+            if fk_m2m_index:
                 cls._upgrade_fk_m2m_index_operators.append(operator)
             else:
                 cls.upgrade_operators.append(operator)
         else:
-            if fk_m2m:
+            if fk_m2m_index:
                 cls._downgrade_fk_m2m_index_operators.append(operator)
             else:
                 cls.downgrade_operators.append(operator)
 
+    @classmethod
+    def _handle_indexes(cls, model: Type[Model], indexes: List[Union[Tuple[str], Index]]):
+        ret = []
+        for index in indexes:
+            if isinstance(index, Index):
+                index.__hash__ = lambda self: md5(  # nosec: B303
+                    self.index_name(cls.ddl.schema_generator, model).encode()
+                    + self.__class__.__name__.encode()
+                ).hexdigest()
+            ret.append(index)
+        return ret
+
     @classmethod
     def diff_models(cls, old_models: Dict[str, dict], new_models: Dict[str, dict], upgrade=True):
         """
@@ -192,7 +206,18 @@ class Migrate:
                 new_unique_together = set(
                     map(lambda x: tuple(x), new_model_describe.get("unique_together"))
                 )
-
+                old_indexes = set(
+                    map(
+                        lambda x: x if isinstance(x, Index) else tuple(x),
+                        cls._handle_indexes(model, old_model_describe.get("indexes", [])),
+                    )
+                )
+                new_indexes = set(
+                    map(
+                        lambda x: x if isinstance(x, Index) else tuple(x),
+                        cls._handle_indexes(model, new_model_describe.get("indexes", [])),
+                    )
+                )
                 old_pk_field = old_model_describe.get("pk_field")
                 new_pk_field = new_model_describe.get("pk_field")
                 # pk field
@@ -224,7 +249,7 @@ class Migrate:
                                     new_models.get(change[0][1].get("model_name")),
                                 ),
                                 upgrade,
-                                fk_m2m=True,
+                                fk_m2m_index=True,
                             )
                     elif action == "remove":
                         add = False
@@ -235,14 +260,19 @@ class Migrate:
                             cls._downgrade_m2m.append(table)
                             add = True
                         if add:
-                            cls._add_operator(cls.drop_m2m(table), upgrade, fk_m2m=True)
+                            cls._add_operator(cls.drop_m2m(table), upgrade, True)
                 # add unique_together
                 for index in new_unique_together.difference(old_unique_together):
                     cls._add_operator(cls._add_index(model, index, True), upgrade, True)
                 # remove unique_together
                 for index in old_unique_together.difference(new_unique_together):
                     cls._add_operator(cls._drop_index(model, index, True), upgrade, True)
-
+                # add indexes
+                for index in new_indexes.difference(old_indexes):
+                    cls._add_operator(cls._add_index(model, index, False), upgrade, True)
+                # remove indexes
+                for index in old_indexes.difference(new_indexes):
+                    cls._add_operator(cls._drop_index(model, index, False), upgrade, True)
                 old_data_fields = old_model_describe.get("data_fields")
                 new_data_fields = new_model_describe.get("data_fields")
 
@@ -356,7 +386,7 @@ class Migrate:
                                 model, fk_field, new_models.get(fk_field.get("python_type"))
                             ),
                             upgrade,
-                            fk_m2m=True,
+                            fk_m2m_index=True,
                         )
                 # drop fk
                 for old_fk_field_name in set(old_fk_fields_name).difference(
@@ -371,7 +401,7 @@ class Migrate:
                                 model, old_fk_field, old_models.get(old_fk_field.get("python_type"))
                             ),
                             upgrade,
-                            fk_m2m=True,
+                            fk_m2m_index=True,
                         )
                 # change fields
                 for field_name in set(new_data_fields_name).intersection(set(old_data_fields_name)):
@@ -457,12 +487,18 @@ class Migrate:
         return ret
 
     @classmethod
-    def _drop_index(cls, model: Type[Model], fields_name: Tuple[str], unique=False):
+    def _drop_index(cls, model: Type[Model], fields_name: Union[Tuple[str], Index], unique=False):
+        if isinstance(fields_name, Index):
+            return cls.ddl.drop_index_by_name(
+                model, fields_name.index_name(cls.ddl.schema_generator, model)
+            )
         fields_name = cls._resolve_fk_fields_name(model, fields_name)
         return cls.ddl.drop_index(model, fields_name, unique)
 
     @classmethod
-    def _add_index(cls, model: Type[Model], fields_name: Tuple[str], unique=False):
+    def _add_index(cls, model: Type[Model], fields_name: Union[Tuple[str], Index], unique=False):
+        if isinstance(fields_name, Index):
+            return fields_name.get_sql(cls.ddl.schema_generator, model, False)
         fields_name = cls._resolve_fk_fields_name(model, fields_name)
         return cls.ddl.add_index(model, fields_name, unique)
 

aerich/models.py

@@ -1,12 +1,14 @@
 from tortoise import Model, fields
 
+from aerich.coder import decoder, encoder
+
 MAX_VERSION_LENGTH = 255
 
 
 class Aerich(Model):
     version = fields.CharField(max_length=MAX_VERSION_LENGTH)
     app = fields.CharField(max_length=20)
-    content = fields.JSONField()
+    content = fields.JSONField(encoder=encoder, decoder=decoder)
 
     class Meta:
         ordering = ["-id"]

aerich/version.py

@@ -0,0 +1 @@
+__version__ = "0.6.2"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "aerich"
-version = "0.5.6"
+version = "0.6.2"
 description = "A database migrations tool for Tortoise ORM."
 authors = ["long2ice <long2ice@gmail.com>"]
 license = "Apache-2.0"
@@ -18,11 +18,11 @@ include = ["CHANGELOG.md", "LICENSE", "README.md"]
 python = "^3.7"
 tortoise-orm = "*"
 click = "*"
-pydantic = "*"
-aiomysql = { version = "*", optional = true }
 asyncpg = { version = "*", optional = true }
+asyncmy = { version = "*", optional = true }
 ddlparse = "*"
 dictdiffer = "*"
+tomlkit = "*"
 
 [tool.poetry.dev-dependencies]
 flake8 = "*"
@@ -38,7 +38,6 @@ cryptography = "*"
 [tool.poetry.extras]
 asyncmy = ["asyncmy"]
 asyncpg = ["asyncpg"]
-aiomysql = ["aiomysql"]
 
 [build-system]
 requires = ["poetry>=0.12"]

tests/models.py

@@ -65,6 +65,7 @@ class Product(Model):
 
     class Meta:
         unique_together = (("name", "type"),)
+        indexes = (("name", "type"),)
 
 
 class Config(Model):

tests/test_migrate.py

@@ -17,6 +17,7 @@ old_models_describe = {
         "description": None,
         "docstring": None,
         "unique_together": [],
+        "indexes": [],
         "pk_field": {
             "name": "id",
             "field_type": "IntField",
@@ -151,6 +152,7 @@ old_models_describe = {
         "description": None,
         "docstring": None,
         "unique_together": [],
+        "indexes": [],
         "pk_field": {
             "name": "id",
             "field_type": "IntField",
@@ -242,6 +244,7 @@ old_models_describe = {
         "description": None,
         "docstring": None,
         "unique_together": [],
+        "indexes": [],
         "pk_field": {
             "name": "id",
             "field_type": "IntField",
@@ -334,6 +337,7 @@ old_models_describe = {
         "description": None,
         "docstring": None,
         "unique_together": [],
+        "indexes": [],
         "pk_field": {
             "name": "id",
             "field_type": "IntField",
@@ -512,6 +516,7 @@ old_models_describe = {
         "description": None,
         "docstring": None,
         "unique_together": [],
+        "indexes": [],
         "pk_field": {
             "name": "id",
             "field_type": "IntField",
@@ -681,6 +686,7 @@ old_models_describe = {
         "description": None,
         "docstring": None,
         "unique_together": [],
+        "indexes": [],
         "pk_field": {
             "name": "id",
             "field_type": "IntField",
@@ -793,6 +799,7 @@ def test_migrate(mocker: MockerFixture):
                 "ALTER TABLE `configs` RENAME TO `config`",
                 "ALTER TABLE `product` RENAME COLUMN `image` TO `pic`",
                 "ALTER TABLE `email` RENAME COLUMN `id` TO `email_id`",
+                "ALTER TABLE `product` ADD INDEX `idx_product_name_869427` (`name`, `type_db_alias`)",
                 "ALTER TABLE `email` ADD INDEX `idx_email_email_4a1a33` (`email`)",
                 "ALTER TABLE `product` ADD UNIQUE INDEX `uid_product_name_869427` (`name`, `type_db_alias`)",
                 "ALTER TABLE `product` ALTER COLUMN `view_num` SET DEFAULT 0",
@@ -816,6 +823,7 @@ def test_migrate(mocker: MockerFixture):
                 "ALTER TABLE `config` RENAME TO `configs`",
                 "ALTER TABLE `product` RENAME COLUMN `pic` TO `image`",
                 "ALTER TABLE `email` RENAME COLUMN `email_id` TO `id`",
+                "ALTER TABLE `product` DROP INDEX `idx_product_name_869427`",
                 "ALTER TABLE `email` DROP INDEX `idx_email_email_4a1a33`",
                 "ALTER TABLE `product` DROP INDEX `uid_product_name_869427`",
                 "ALTER TABLE `product` ALTER COLUMN `view_num` DROP DEFAULT",
@@ -843,6 +851,7 @@ def test_migrate(mocker: MockerFixture):
                 'ALTER TABLE "product" RENAME COLUMN "image" TO "pic"',
                 'ALTER TABLE "user" ALTER COLUMN "password" TYPE VARCHAR(100) USING "password"::VARCHAR(100)',
                 'ALTER TABLE "user" DROP COLUMN "avatar"',
+                'CREATE INDEX "idx_product_name_869427" ON "product" ("name", "type_db_alias")',
                 'CREATE INDEX "idx_email_email_4a1a33" ON "email" ("email")',
                 'CREATE TABLE "email_user" ("email_id" INT NOT NULL REFERENCES "email" ("email_id") ON DELETE CASCADE,"user_id" INT NOT NULL REFERENCES "user" ("id") ON DELETE CASCADE)',
                 'CREATE TABLE IF NOT EXISTS "newmodel" (\n    "id" SERIAL NOT NULL PRIMARY KEY,\n    "name" VARCHAR(50) NOT NULL\n);\nCOMMENT ON COLUMN "config"."user_id" IS \'User\';',
@@ -865,6 +874,7 @@ def test_migrate(mocker: MockerFixture):
                 'ALTER TABLE "product" RENAME COLUMN "pic" TO "image"',
                 'ALTER TABLE "user" ADD "avatar" VARCHAR(200) NOT NULL  DEFAULT \'\'',
                 'ALTER TABLE "user" ALTER COLUMN "password" TYPE VARCHAR(200) USING "password"::VARCHAR(200)',
+                'DROP INDEX "idx_product_name_869427"',
                 'DROP INDEX "idx_email_email_4a1a33"',
                 'DROP INDEX "idx_user_usernam_9987ab"',
                 'DROP INDEX "uid_product_name_869427"',