Add argparse choices to --database options

[Adam Johnson]

Many management commands take a --database option to select which database to operate on. Currently, this is unvalidated, causing crashes when a bad name is typed:

$ ./manage.py migrate --database deflaut
Traceback (most recent call last):
  ...
  File "/.../django/core/management/commands/migrate.py", line 100, in handle
    self.check(databases=[database])
  ...
  File "/.../django/db/models/fields/__init__.py", line 442, in _check_backend_specific_checks
    errors.extend(connections[alias].validation.check_field(self, **kwargs))
                  ~~~~~~~~~~~^^^^^^^
  File "/.../django/utils/connection.py", line 61, in __getitem__
    raise self.exception_class(f"The connection '{alias}' doesn't exist.")
django.utils.connection.ConnectionDoesNotExist: The connection 'deflaut' doesn't exist.

We can add ​argparse’s choices for validation:

--- django/core/management/commands/migrate.py
+++ django/core/management/commands/migrate.py
@@ -47,6 +47,7 @@ def add_arguments(self, parser):
         parser.add_argument(
             "--database",
             default=DEFAULT_DB_ALIAS,
+            choices=tuple(connections),
             help=(
                 'Nominates a database to synchronize. Defaults to the "default" '
                 "database."

The failure is then graceful, and lists the available options:

$ ./manage.py migrate --database deflaut
usage: manage.py migrate ...
manage.py migrate: error: argument --database: invalid choice: 'deflaut' (choose from 'default')

[Jae Hyuck Sa]

Replying to Adam Johnson:
As you told me, I applied them to the related database options.

[Mariusz Felisiak]

Replying to Adam Johnson:

We can add ​argparse’s choices for validation:

--- django/core/management/commands/migrate.py
+++ django/core/management/commands/migrate.py
@@ -47,6 +47,7 @@ def add_arguments(self, parser):
         parser.add_argument(
             "--database",
             default=DEFAULT_DB_ALIAS,
+            choices=tuple(connections),
             help=(
                 'Nominates a database to synchronize. Defaults to the "default" '
                 "database."

Can we? Do we really want to iterate over connections? As far as I'm aware, this will force initialization of all database connections. I don't think it's acceptable. IMO it's not worth doing.

[Simon Charette]

Do we really want to iterate over connections? As far as I'm aware, this will force initialization of all database connections

I know it's confusing (I had to check myself to make sure when accepting the ticket) but connections.__iter__ ​doesn't create any connections it simply iterates over settings.DATABASES.

[Sarah Boyce <42296566+sarahboyce@…>]

In 4a76ac0:

Fixed #35429 -- Added argparse choices to --database options.

[Rishav]

I'd like to work on this issue as part of my GSoC contributions.

[Adam Johnson]

Rishav: this issue is fixed and closed.