Deprecate in verdi quicksetup the --db-engine option (#6906)

The `--db-engine` option only supports `postgresql_psycopg`. To avoid failure
due the deprecation of `postgresql_psycopg2` (note that unintuitively
`postgresql_psycopg` is the newer version) we add the support in the click
options and echo a deprecation warning that the option does not have any effect.
This change does not have any effect on the actual DB engine being used as it is
hardcoded.

Fixes renaming of `database` to `dbname` missed in #6362 that raised
deprecation warning.

Author: danielhollas

docs/source/reference/command_line.rst

@@ -430,8 +430,8 @@ Below is a list with all available subcommands.
       --first-name NONEMPTYSTRING     First name of the user.  [required]
       --last-name NONEMPTYSTRING      Last name of the user.  [required]
       --institution NONEMPTYSTRING    Institution of the user.  [required]
-      --db-engine [postgresql_psycopg]
-                                      Engine to use to connect to the database.  [required]
+      --db-engine [postgresql_psycopg|postgresql_psycopg2]
+                                      Engine to use to connect to the database. (deprecated)
       --db-backend [core.psql_dos]    Database backend to use.  [required]
       --db-host HOSTNAME              Database server host. Leave empty for "peer"
                                       authentication.  [required]
@@ -537,8 +537,8 @@ Below is a list with all available subcommands.
       --first-name NONEMPTYSTRING     First name of the user.  [required]
       --last-name NONEMPTYSTRING      Last name of the user.  [required]
       --institution NONEMPTYSTRING    Institution of the user.  [required]
-      --db-engine [postgresql_psycopg]
-                                      Engine to use to connect to the database.  [required]
+      --db-engine [postgresql_psycopg|postgresql_psycopg2]
+                                      Engine to use to connect to the database. (deprecated)
       --db-backend [core.psql_dos]    Database backend to use.  [required]
       --db-host HOSTNAME              Database server host. Leave empty for "peer"
                                       authentication.  [required]

src/aiida/cmdline/commands/cmd_setup.py

@@ -81,6 +81,9 @@ def setup(
     if profile_uuid is not None:
         profile.uuid = profile_uuid
 
+    if non_interactive and db_engine != 'postgresql_psycopg':
+        echo.echo_deprecated('The `--db-engine` option is deprecated and has no effect.')
+
     profile.set_storage(
         db_backend,
         {
@@ -205,12 +208,15 @@ def quicksetup(
     # store default user settings so user does not have to re-enter them
     _store_default_user_settings(ctx.obj.config, email, first_name, last_name, institution)
 
+    if non_interactive and db_engine != 'postgresql_psycopg':
+        echo.echo_deprecated('The `--db-engine` option is deprecated and has no effect.')
+
     dbinfo_su = {
         'host': db_host,
         'port': db_port,
         'user': su_db_username,
         'password': su_db_password,
-        'database': su_db_name,
+        'dbname': su_db_name,
     }
     postgres = Postgres(interactive=not non_interactive, quiet=False, dbinfo=dbinfo_su)
 

src/aiida/cmdline/params/options/main.py

@@ -397,10 +397,10 @@ def set_log_level(ctx, _param, value):
 
 DB_ENGINE = OverridableOption(
     '--db-engine',
-    required=True,
-    help='Engine to use to connect to the database.',
+    required=False,
+    help='Engine to use to connect to the database. (deprecated)',
     default='postgresql_psycopg',
-    type=click.Choice(['postgresql_psycopg']),
+    type=click.Choice(['postgresql_psycopg', 'postgresql_psycopg2']),
 )
 
 DB_BACKEND = OverridableOption(