Opened 2 years ago

Last modified 2 years ago

#36016 closed Cleanup/optimization

Avoid traceback when quitting makemigrations with Ctrl-C — at Initial Version

Reported by: Adam Johnson Owned by:
Component: Migrations Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

Sometimes makemigration asks you questions with its “questioner”. If you realize that you missed something due to these questions, you might want to quit with Ctrl-C and edit your models file before rerunning.

Currently, such a quit triggers Python’s default traceback:

$ ./manage.py makemigrations example
It is impossible to add a non-nullable field 'title' to book without specifying a default. This is because the database needs something to populate existing rows.
Please select a fix:
 1) Provide a one-off default now (will be set on all existing rows with a null value for this column)
 2) Quit and manually define a default value in models.py.
Select an option:  ^CTraceback (most recent call last):
  File "/.../manage.py", line 21, in <module>
    main()
    ~~~~^^
  File "/.../django/db/migrations/questioner.py", line 169, in ask_not_null_addition
    choice = self._choice_input(
        f"It is impossible to add a non-nullable field '{field_name}' "
    ...<10 lines>...
        ],
    )
  File "/Users/chainz/tmp/django-makemigrations-ctrl-c/.venv/lib/python3.13/site-packages/django/db/migrations/questioner.py", line 114, in _choice_input
    result = input()
KeyboardInterrupt

This isn’t very user-friendly: it seems like maybe you broke Django, and it pushes the question up out of the terminal window.

Instead, we could quit with a nice message, perhaps something like:

Select an option:  ^C
Cancelled, no migration file for app 'example' written.

The message needs to be clear in the case that makemigrations generates some migration files but not others.

It should probably use ​the notice style.

Change History (0)

Note: See TracTickets for help on using tickets.
Back to Top