Django Migrations ↔ RunPython: Can Reverse Migrations Be Auto‑Generated?

Answer to the Core Question

Does Django currently auto‑generate reverse code for RunPython? No. Django’s migration framework generates reverse SQL for schema changes, but RunPython requires explicit reverse_code logic. If reverse_code=None, the migration is treated as irreversible.

How to Declare a Migration Reversible

When you add a RunPython operation you should:

• Provide a reverse_code callable that undoes the forward transformation, e.g. reverse_code=undo_migration.
• If the operation cannot be reversed (e.g., data deletion), set reverse_code=None and add a comment explaining why.
• Use the reversible() context manager only for schema operations; it does not affect RunPython.

Practical Steps for This Migration

1. Write Forward & Reverse Functions
   Define two functions in migrations/000X_auto.py:

   def forwards(apps, schema_editor):
       # data transformation logic
   
   def backwards(apps, schema_editor):
       # inverse of forwards
   

2. Add the RunPython Operation
   

   operations = [
       migrations.RunPython(forwards, reverse_code=backwards),
   ]
   

3. Verify Reversibility Locally
   Run a plan and apply the migration forward and backward:

   python manage.py migrate myapp 000X --plan
   python manage.py migrate myapp 000X
   python manage.py migrate myapp 000X --reverse
   

   If the reverse completes without errors, the migration is truly reversible.
4. Document Intent
   Add a comment above the operation explaining the reasoning for the reverse logic or why it is irreversible.
5. Add Tests
   Write a test that applies the migration forward, checks data integrity, then applies it backward and verifies the original state.

Effect of the Irreversible Flag on Deployment

When a migration is marked irreversible, Django will refuse to downgrade it during a migrate --reverse or when running makemigrations with a target state. In production pipelines this means:

• Automatic rollback scripts are disabled; manual steps or database snapshots are required.
• CI pipelines should flag such migrations as “destructive” and enforce a manual approval gate.
• Version control history should include a clear comment on why the migration cannot be reversed.

Uncertainty & Future Directions

Current Django releases (up to 4.2) have no built‑in reverse generation for RunPython. The community has discussed adding heuristics for simple data transformations, but no official feature has been merged. Keep an eye on the Django release notes for any changes.

Ask for Missing Diagnostic Detail

To tailor the best reverse strategy, please share what type of data change the RunPython operation performs (e.g., value transformation, record deletion, field addition). This will help decide whether a full reverse function is necessary or if marking the migration irreversible is safer.