Alembic --自动生成空迁移

Question

我是第一次尝试使用Alembic，并且希望使用描述为here的--autogenerate功能

我的项目结构看起来像这样

project/
       configuration/
                    __init__.py
                    dev.py
                    test.py
       core/
           app/
              models/
                    __init__.py
                    user.py
       db/
          alembic/
                  versions/
                  env.py
          alembic.ini

我使用的是Flask和SQLAlchemy以及它们的Flask-SQLAlchemy扩展。我的模型User看起来像

class User(UserMixin, db.Model):
    __tablename__ = 'users'
    # noinspection PyShadowingBuiltins
    uuid = Column('uuid', GUID(), default=uuid.uuid4, primary_key=True,
                  unique=True)
    email = Column('email', String, nullable=False, unique=True)
    _password = Column('password', String, nullable=False)
    created_on = Column('created_on', sa.types.DateTime(timezone=True),
                        default=datetime.utcnow())
    last_login = Column('last_login', sa.types.DateTime(timezone=True),
                        onupdate=datetime.utcnow())

正如here所描述的，我修改了env.py，使其看起来像

from configuration import app

alembic_config = config.get_section(config.config_ini_section)
alembic_config['sqlalchemy.url'] = app.config['SQLALCHEMY_DATABASE_URI']
engine = engine_from_config(
    alembic_config,
            prefix='sqlalchemy.',
            poolclass=pool.NullPool)

和

from configuration import db


target_metadata = db.metadata

configuration.__init__py看起来像什么

from flask import Flask
from flask.ext.sqlalchemy import SQLAlchemy
import dev


app = Flask(__name__)
app.config.from_envvar('SETTINGS_PT')
db = SQLAlchemy(app)

现在，当我运行迁移时

$alembic revision --autogenerate -m "Added user table"
INFO  [alembic.migration] Context impl PostgresqlImpl.
INFO  [alembic.migration] Will assume transactional DDL.
  Generating /Users/me/IdeaProjects/project/db/alembic/versions/55a9d5
  35d8ae_added_user_table.py...done

但是文件alembic/versions/55a9d5有空的upgrade()和downgrade()方法

"""Added user table

Revision ID: 1b62a62eef0d
Revises: None
Create Date: 2013-03-27 06:37:08.314177

"""

# revision identifiers, used by Alembic.
revision = '1b62a62eef0d'
down_revision = None

from alembic import op
import sqlalchemy as sa


def upgrade():
    ### commands auto generated by Alembic - please adjust! ###
    pass
    ### end Alembic commands ###


def downgrade():
    ### commands auto generated by Alembic - please adjust! ###
    pass
    ### end Alembic commands ###

为什么它不能理解有一个新的User模型？请帮帮忙

Answer 1

根据@zzzeek的说法，在我的env.py中包含了以下内容之后，我就能够使用--autogenerate选项了

在run_migrations_online()下的env.py中

from configuration import app
from core.expense.models import user # added my model here

alembic_config = config.get_section(config.config_ini_section)
alembic_config['sqlalchemy.url'] = app.config['SQLALCHEMY_DATABASE_URI']
engine = engine_from_config(
    alembic_config,
    prefix='sqlalchemy.',
    poolclass=pool.NullPool)

然后我运行alembic revision --autogenerate -m "Added initial table"并得到

def upgrade():
    ### commands auto generated by Alembic - please adjust! ###
    op.create_table('users',
    sa.Column('uuid', sa.GUID(), nullable=False),
    sa.Column('email', sa.String(), nullable=False),
    sa.Column('password', sa.String(), nullable=False),
    sa.Column('created_on', sa.DateTime(timezone=True), nullable=True),
    sa.Column('last_login', sa.DateTime(timezone=True), nullable=True),
    sa.PrimaryKeyConstraint('uuid'),
    sa.UniqueConstraint('email'),
    sa.UniqueConstraint('uuid')
    )
    ### end Alembic commands ###

谢谢你，Michael，你的帮助！

Answer 2

我认为值得一提的是，我在当前版本(0.8.4)中遇到了同样的问题，但是设置元数据的方法似乎变得更加明确:除了导入模型之外，还需要设置target_metadata (它存在于env.py中，但缺省为None)。

documentation建议导入他们称为Base的东西，但不清楚具体是什么；导入我的模型继承的DeclarativeBase实例对我没有任何帮助(结果与OP相同)。

然而，代码中的实际注释建议使用实际模型(ModelNameHere.metadata)设置target_metadata，这对我确实有效(使用一个模型的元数据会导致所有元数据都被检测到)。

Answer 3

如果您不希望您的模型抛出未使用的导入错误，那么您还可以将记录添加到您的flake8文件中的__all__。

在users.py的末尾

__all__ = Users

有关更多信息，请访问：https://docs.python.org/3/tutorial/modules.html#importing-from-a-package