Вот что я узнал после подключения моего программного обеспечения к alembic:

Есть ли способ вызвать алембик из моего кода Python?

да. На момент написания этой статьи основной точкой входа для алембика является _2 _ >, поэтому вы можете импортировать его и назвать его самостоятельно, например:

import alembic.config
alembicArgs = [
    '--raiseerr',
    'upgrade', 'head',
]
alembic.config.main(argv=alembicArgs)

optional arguments:
 -x X                  Additional arguments consumed by custom env.py
                       scripts, e.g. -x setting1=somesetting -x
                       setting2=somesetting

def run_migrations_online():   
    # get the alembic section of the config file
    ini_section = config.get_section(config.config_ini_section)

    # if a database path was provided, override the one in alembic.ini
    db_path = context.get_x_argument(as_dictionary=True).get('dbPath')
    if db_path:
        ini_section['sqlalchemy.url'] = db_path

    # establish a connectable object as normal
    connectable = engine_from_config(
        ini_section,
        prefix='sqlalchemy.',
        poolclass=pool.NullPool)

    # etc

Я согласен с @davidism об использовании миграции против metadata.create_all() :)

Если вы посмотрите на страницу команд API из документации по алембике, вы увидите пример того, как запускать команды CLI непосредственно из приложения Python. Без прохождения кода командной строки.

У запуска alembic.config.main есть обратная сторона, заключающаяся в том, что выполняется env.py скрипт, что может быть не тем, что вам нужно. Например, он изменит вашу конфигурацию ведения журнала.

Другой, очень простой способ - использовать "командный API", указанный выше. Например, вот небольшая вспомогательная функция, которую я написал:

from alembic.config import Config
from alembic import command

def run_migrations(script_location: str, dsn: str) -> None:
    LOG.info('Running DB migrations in %r on %r', script_location, dsn)
    alembic_cfg = Config()
    alembic_cfg.set_main_option('script_location', script_location)
    alembic_cfg.set_main_option('sqlalchemy.url', dsn)
    command.upgrade(alembic_cfg, 'head')

Я использую здесь метод set_main_option, чтобы иметь возможность запускать миграции в другой БД, если это необходимо. Поэтому я могу просто назвать это следующим образом:

run_migrations('/path/to/migrations', 'postgresql:///my_database')

Откуда вы получите эти два значения (путь и DSN) - решать вам. Но, похоже, это очень близко к тому, чего вы хотите достичь. API команд также имеет штамп () методы, которые позволяют вам пометить данную БД как имеющую определенную версию. Приведенный выше пример можно легко адаптировать для этого.

Это очень широкий вопрос, и реализация вашей идеи будет зависеть от вас, но это возможно.

Вы можете вызывать Alembic из своего кода Python без использования команд, поскольку он также реализован на Python! Вам просто нужно воссоздать то, что команды делают за кулисами.

По общему признанию, документы не в очень хорошем состоянии, поскольку это все еще относительно ранние выпуски библиотеки, но, немного покопавшись, вы обнаружите следующее:

1. Создайте конфигурацию
2. Используйте конфигурацию для создания ScriptDirectory
3. Используйте Config и ScriptDirectory для создания EnvironmentContext
4. Используйте EnvironmentContext для создания MigrationContext
5. Большинство команд используют комбинацию методов из Config и MigrationContext.

Я написал расширение, чтобы предоставить этому программному Alembic доступ к базе данных Flask-SQLAlchemy. Реализация привязана к Flask и Flask-SQLAlchemy, но с нее должно быть хорошо начать. См. здесь Flask-Alembic.

Что касается вашего последнего замечания о том, как создавать новые базы данных, вы можете либо использовать Alembic для создания таблиц, либо вы можете использовать metadata.create_all(), затем alembic stamp head (или эквивалентный код Python). Я рекомендую всегда использовать путь миграции для создания таблиц и игнорировать необработанные metadata.create_all().

У меня нет опыта работы с cx_freeze, но все должно быть в порядке, если миграции включены в дистрибутив и путь к этому каталогу в коде правильный.

Вот чисто программный пример того, как программно конфигурировать и вызывать алембические команды.

Настройка каталога (для облегчения чтения кода)

.                         # root dir
|- alembic/               # directory with migrations
|- tests/diy_alembic.py   # example script
|- alembic.ini            # ini file

А вот и diy_alembic.py

import os
import argparse
from alembic.config import Config
from alembic import command
import inspect

def alembic_set_stamp_head(user_parameter):
    # set the paths values
    this_file_directory = os.path.dirname(os.path.abspath(inspect.stack()[0][1]))
    root_directory      = os.path.join(this_file_directory, '..')
    alembic_directory   = os.path.join(root_directory, 'alembic')
    ini_path            = os.path.join(root_directory, 'alembic.ini')

    # create Alembic config and feed it with paths
    config = Config(ini_path)
    config.set_main_option('script_location', alembic_directory)    
    config.cmd_opts = argparse.Namespace()   # arguments stub

    # If it is required to pass -x parameters to alembic
    x_arg = 'user_parameter=' + user_parameter
    if not hasattr(config.cmd_opts, 'x'):
        if x_arg is not None:
            setattr(config.cmd_opts, 'x', [])
            if isinstance(x_arg, list) or isinstance(x_arg, tuple):
                for x in x_arg:
                    config.cmd_opts.x.append(x)
            else:
                config.cmd_opts.x.append(x_arg)
        else:
            setattr(config.cmd_opts, 'x', None)

    #prepare and run the command
    revision = 'head'
    sql = False
    tag = None
    command.stamp(config, revision, sql=sql, tag=tag)

    #upgrade command
    command.upgrade(config, revision, sql=sql, tag=tag)

Код более или менее является частью этого файла Flask-Alembic < / а>. Это хорошее место, чтобы посмотреть на использование и детали других команд.

Для всех, кто пытается достичь результата в стиле пролетного пути с помощью SQLAlchemy, это сработало для меня:

Добавьте в проект migration.py:

from flask_alembic import Alembic

def migrate(app):
    alembic = Alembic()
    alembic.init_app(app)
    with app.app_context():
        alembic.upgrade()

Вызовите его при запуске приложения после инициализации вашей базы данных

application = Flask(__name__)
db = SQLAlchemy()
db.init_app(application)
migration.migrate(application)

Затем вам просто нужно проделать остальные стандартные шаги перегонного куба:

Инициализируйте свой проект как перегонный куб

alembic init alembic

Обновите env.py:

from models import MyModel
target_metadata = [MyModel.Base.metadata]

Обновите alembic.ini

sqlalchemy.url = postgresql://postgres:postgres@localhost:5432/my_db

Предполагая, что ваши модели SQLAlchemy уже определены, вы можете автоматически сгенерировать свои скрипты:

alembic revision --autogenerate -m "descriptive migration message"

Если вы получаете сообщение об отсутствии возможности импортировать вашу модель в env.py, вы можете запустить следующее в своем терминале fo fix

export PYTHONPATH=/path/to/your/project

Наконец, мои сценарии миграции создавались в каталоге alembic / versions, и мне пришлось скопировать их в каталог миграции, чтобы alembic мог их забрать.

├── alembic
│   ├── env.py
│   ├── README
│   ├── script.py.mako
│   └── versions
│       ├── a5402f383da8_01_init.py  # generated here...
│       └── __pycache__
├── alembic.ini
├── migrations
│   ├── a5402f383da8_01_init.py  # manually copied here
│   └── script.py.mako

У меня, наверное, что-то неправильно настроено, но сейчас оно работает.

Я не использую Flask, поэтому я не мог использовать уже рекомендованную библиотеку Flask-Alembic. Вместо этого, немного поработав, я закодировал следующую короткую функцию для запуска всех применимых миграций. Я храню все свои файлы, связанные с перегонкой, в подмодуле (папке), который называется миграциями. На самом деле я держу alembic.ini вместе с env.py, что, возможно, немного неортодоксально. Вот отрывок из моего alembic.ini файла, чтобы исправить это:

[alembic]
script_location = .

Затем я добавил в тот же каталог следующий файл и назвал его run.py. Но где бы вы ни хранили свои скрипты, все, что вам нужно было сделать, это изменить приведенный ниже код, чтобы он указывал на правильные пути:

from alembic.command import upgrade
from alembic.config import Config
import os


def run_sql_migrations():
    # retrieves the directory that *this* file is in
    migrations_dir = os.path.dirname(os.path.realpath(__file__))
    # this assumes the alembic.ini is also contained in this same directory
    config_file = os.path.join(migrations_dir, "alembic.ini")

    config = Config(file_=config_file)
    config.set_main_option("script_location", migrations_dir)

    # upgrade the database to the latest revision
    upgrade(config, "head")

Затем с этим файлом run.py он позволяет мне делать это в моем основном коде:

from mymodule.migrations.run import run_sql_migrations


run_sql_migrations()

См. Документацию по alembic.operations.base.Operations:

    from alembic.runtime.migration import MigrationContext
    from alembic.operations import Operations

    conn = myengine.connect()
    ctx = MigrationContext.configure(conn)
    op = Operations(ctx)

    op.alter_column("t", "c", nullable=True)

Не совсем ответ, но мне это было нелегко, поэтому я хотел поделиться:

Как программно передать x_argument с помощью alembic.command.upgrade:

class CmdOpts:
    x = {"data=true"}

здесь data = true - это то, что я передаю как x_argument в командной строке

    alembic_config = AlembicConfig(ini_location)
    setattr(alembic_config, "cmd_opts", CmdOpts())
    alembic_config.cmd_opts.x = {"data": True}

Alembic предоставляет все свои команды как импортируемые вызываемые объекты в alembic.command.

https://alembic.sqlalchemy.org/en/latest/api/commands.html

Я написал эту оболочку, чтобы я мог настроить собственное ведение журнала с помощью кода Python.

import logging

import alembic.command
import alembic.config

from somewhere import config_logging


def run():
    config_logging()

    log = logging.getLogger(__name__)

    if len(sys.argv) < 3:
        log.error("command must be specified")
        exit(1)

    else:
        command_name = sys.argv[2]

    try:
        command = getattr(alembic.command, name)

    except AttributeError:
        log.error(f"{name} is not a valid alembic command")
        exit(2)

    config = alembic.config.Config()
    config.set_main_option("script_location", "path/to/alembic")
    config.set_main_option("sqlalchemy.url", "postgres://...")

    command(config, *sys.argv[3:])