Configuration

These are the available settings.

All attributes prefixed REMAKE_MIGRATIONS_* can be overridden from your Django project’s settings module by defining a setting with the same name.

class django_remake_migrations.conf.AppSettings

Proxy class to encapsulate all the app settings.

This instance should be accessed via the singleton django_remake_migrations.conf.app_settings.

You shouldn’t have to set any of these yourself, the class checks a Django settings with the same name and use these if defined, defaulting to the values documented here.

REMAKE_MIGRATIONS_EXTENSIONS: dict[str, list[str]]

The database extensions to enable for each app.

Keys are app labels and values are a list of the full import path of the extension classes:

REMAKE_MIGRATIONS_EXTENSIONS = {
    "app1": ["django.contrib.postgres.operations.TrigramExtension"],
}

REMAKE_MIGRATIONS_FIRST_APPS: Sequence[str] = ()

The apps for which to make migrations first.

REMAKE_MIGRATIONS_LAST_APPS: Sequence[str] = ()

The apps for which to make migrations last.

REMAKE_MIGRATIONS_POST_COMMANDS: Sequence[Sequence[str]] = ()

Django management commands to run after generating the new migration.

Each command and its arguments should be specified as a list or tuple. For example, to integrate with django-linear-migrations:

REMAKE_MIGRATIONS_POST_COMMANDS = [
    ["create_max_migration_files", "--recreate"],
]

REMAKE_MIGRATIONS_REPLACES_ALL: bool = False

Make all new migrations in an app replace all old migrations from the app.

The default behaviour is that each old migration is set in replaces exactly once, which works well if there are fewer remade migrations than the old ones. If that’s not the case (remade migrations actually create more migrations than were there before), the output is incorrect. Setting this option to True fixes the issue.

REMAKE_MIGRATIONS_REPLACE_OTHER_APP: dict[str, list[str]]

Mark remade migrations from an app as replacing all migrations from another app.

Can be used to fix cyclic dependency errors on remade migrations.

Requires REMAKE_MIGRATIONS_REPLACES_ALL to set to True.

REMAKE_MIGRATIONS_REPLACE_OTHER_APP = {
    "app1": ["app2"],
}

REMAKE_MIGRATIONS_RUN_BEFORE: dict[str, list[tuple[str, str]]]

Add run_before to the first migration of the specified apps. Read more about run_before in the Django docs.

REMAKE_MIGRATIONS_RUN_BEFORE = {
    "app1": [("oauth2_provider", "0001_initial")],
}