deprecate the use of --router, use --database instead

Author: trbs

django_extensions/management/commands/drop_test_database.py

@@ -1,13 +1,17 @@
 # -*- coding: utf-8 -*-
+import os
 import logging
+import warnings
 
 from django.conf import settings
 from django.core.management.base import BaseCommand, CommandError
+from django.db import DEFAULT_DB_ALIAS
 from django.db.backends.base.creation import TEST_DATABASE_PREFIX
 from six.moves import input
 
 from django_extensions.management.mysql import parse_mysql_cnf
 from django_extensions.management.utils import signalcommand
+from django_extensions.utils.deprecation import RemovedInNextVersionWarning
 
 
 class Command(BaseCommand):
@@ -32,17 +36,25 @@ def add_arguments(self, parser):
             help='Use another database name then defined in settings.py'
         )
         parser.add_argument(
-            '-R', '--router', action='store', dest='router', default='default',
+            '-R', '--router', action='store', dest='router', default=DEFAULT_DB_ALIAS,
             help='Use this router-database other then defined in settings.py'
         )
+        parser.add_argument(
+            '--database', default=DEFAULT_DB_ALIAS,
+            help='Nominates a database to run command for. Defaults to the "%s" database.' % DEFAULT_DB_ALIAS,
+        )
 
     @signalcommand
     def handle(self, *args, **options):
         """Drop test database for this project."""
-        router = options['router']
-        dbinfo = settings.DATABASES.get(router)
+        database = options['database']
+        if options['router'] != DEFAULT_DB_ALIAS:
+            warnings.warn("--router is deprecated. You should use --database.", RemovedInNextVersionWarning, stacklevel=2)
+            database = options['router']
+
+        dbinfo = settings.DATABASES.get(database)
         if dbinfo is None:
-            raise CommandError("Unknown database router %s" % router)
+            raise CommandError("Unknown database %s" % database)
 
         engine = dbinfo.get('ENGINE').split('.')[-1]
 
@@ -84,7 +96,6 @@ def handle(self, *args, **options):
             return
 
         if engine in ('sqlite3', 'spatialite'):
-            import os
             try:
                 logging.info("Unlinking %s database" % engine)
                 if os.path.isfile(database_name):

django_extensions/management/commands/reset_db.py

@@ -6,14 +6,17 @@
 """
 import os
 import logging
+import warnings
 
 from django.conf import settings
 from django.core.management.base import BaseCommand, CommandError
+from django.db import DEFAULT_DB_ALIAS
 from six.moves import input
 
 from django_extensions.settings import SQLITE_ENGINES, POSTGRESQL_ENGINES, MYSQL_ENGINES
 from django_extensions.management.mysql import parse_mysql_cnf
 from django_extensions.management.utils import signalcommand
+from django_extensions.utils.deprecation import RemovedInNextVersionWarning
 
 
 class Command(BaseCommand):
@@ -48,9 +51,13 @@ def add_arguments(self, parser):
             help='Use another database name than defined in settings.py'
         )
         parser.add_argument(
-            '-R', '--router', action='store', dest='router', default='default',
+            '-R', '--router', action='store', dest='router', default=DEFAULT_DB_ALIAS,
             help='Use this router-database other than defined in settings.py'
         )
+        parser.add_argument(
+            '--database', default=DEFAULT_DB_ALIAS,
+            help='Nominates a database to run command for. Defaults to the "%s" database.' % DEFAULT_DB_ALIAS,
+        )
         parser.add_argument(
             '-c', '--close-sessions', action='store_true', dest='close_sessions', default=False,
             help='Close database connections before dropping database (PostgreSQL only)'
@@ -64,10 +71,14 @@ def handle(self, *args, **options):
         Note: Transaction wrappers are in reverse as a work around for
         autocommit, anybody know how to do this the right way?
         """
-        router = options['router']
-        dbinfo = settings.DATABASES.get(router)
+        database = options['database']
+        if options['router'] != DEFAULT_DB_ALIAS:
+            warnings.warn("--router is deprecated. You should use --database.", RemovedInNextVersionWarning, stacklevel=2)
+            database = options['router']
+
+        dbinfo = settings.DATABASES.get(database)
         if dbinfo is None:
-            raise CommandError("Unknown database router %s" % router)
+            raise CommandError("Unknown database %s" % database)
 
         engine = dbinfo.get('ENGINE')
 

django_extensions/management/commands/reset_schema.py

@@ -5,11 +5,16 @@
 schema while there are active connections.
 """
 
+import warnings
+
 from django.core.management import BaseCommand, CommandError
+from django.db import DEFAULT_DB_ALIAS
 from django.db import connections
 from django.conf import settings
 from six.moves import input
 
+from django_extensions.utils.deprecation import RemovedInNextVersionWarning
+
 
 class Command(BaseCommand):
     """`reset_schema` command implementation."""
@@ -24,19 +29,27 @@ def add_arguments(self, parser):
             help='Tells Django to NOT prompt the user for input of any kind.'
         )
         parser.add_argument(
-            '-R', '--router', action='store', dest='router', default='default',
+            '-R', '--router', action='store', dest='router', default=DEFAULT_DB_ALIAS,
             help='Use this router-database instead of the one defined in settings.py'
         )
+        parser.add_argument(
+            '--database', default=DEFAULT_DB_ALIAS,
+            help='Nominates a database to run command for. Defaults to the "%s" database.' % DEFAULT_DB_ALIAS,
+        )
         parser.add_argument(
             '-S', '--schema', action='store', dest='schema', default='public',
             help='Drop this schema instead of "public"'
         )
 
     def handle(self, *args, **options):
-        router = options['router']
-        dbinfo = settings.DATABASES.get(router)
+        database = options['database']
+        if options['router'] != DEFAULT_DB_ALIAS:
+            warnings.warn("--router is deprecated. You should use --database.", RemovedInNextVersionWarning, stacklevel=2)
+            database = options['router']
+
+        dbinfo = settings.DATABASES.get(database)
         if dbinfo is None:
-            raise CommandError("Unknown database router %s" % router)
+            raise CommandError("Unknown database %s" % database)
 
         engine = dbinfo.get('ENGINE').split('.')[-1]
         if engine not in ('postgresql', 'postgresql_psycopg2', 'postgis'):
@@ -60,6 +73,6 @@ def handle(self, *args, **options):
         if confirm != 'yes':
             print("Reset cancelled.")
             return
-        with connections[router].cursor() as cursor:
+        with connections[database].cursor() as cursor:
             cursor.execute("DROP SCHEMA {} CASCADE".format(schema))
             cursor.execute("CREATE SCHEMA {}".format(schema))

django_extensions/management/commands/sqlcreate.py

@@ -1,40 +1,51 @@
 # -*- coding: utf-8 -*-
 import socket
 import sys
+import warnings
 
 from django.conf import settings
 from django.core.management.base import BaseCommand, CommandError
+from django.db import DEFAULT_DB_ALIAS
 
 from django_extensions.management.utils import signalcommand
+from django_extensions.utils.deprecation import RemovedInNextVersionWarning
 
 
 class Command(BaseCommand):
     help = """Generates the SQL to create your database for you, as specified in settings.py
 The envisioned use case is something like this:
 
-    ./manage.py sqlcreate [--router=<routername>] | mysql -u <db_administrator> -p
-    ./manage.py sqlcreate [--router=<routername>] | psql -U <db_administrator> -W"""
+    ./manage.py sqlcreate [--database=<databasename>] | mysql -u <db_administrator> -p
+    ./manage.py sqlcreate [--database=<databasname>] | psql -U <db_administrator> -W"""
 
     requires_system_checks = False
     can_import_settings = True
 
     def add_arguments(self, parser):
         super().add_arguments(parser)
         parser.add_argument(
-            '-R', '--router', action='store', dest='router', default='default',
+            '-R', '--router', action='store', dest='router', default=DEFAULT_DB_ALIAS,
             help='Use this router-database other then defined in settings.py'
         )
+        parser.add_argument(
+            '--database', default=DEFAULT_DB_ALIAS,
+            help='Nominates a database to run command for. Defaults to the "%s" database.' % DEFAULT_DB_ALIAS,
+        )
         parser.add_argument(
             '-D', '--drop', action='store_true', dest='drop', default=False,
             help='If given, includes commands to drop any existing user and database.'
         )
 
     @signalcommand
     def handle(self, *args, **options):
-        router = options['router']
-        dbinfo = settings.DATABASES.get(router)
+        database = options['database']
+        if options['router'] != DEFAULT_DB_ALIAS:
+            warnings.warn("--router is deprecated. You should use --database.", RemovedInNextVersionWarning, stacklevel=2)
+            database = options['router']
+
+        dbinfo = settings.DATABASES.get(database)
         if dbinfo is None:
-            raise CommandError("Unknown database router %s" % router)
+            raise CommandError("Unknown database %s" % database)
 
         engine = dbinfo.get('ENGINE').split('.')[-1]
         dbuser = dbinfo.get('USER')
@@ -56,7 +67,6 @@ def handle(self, *args, **options):
             print("GRANT ALL PRIVILEGES ON %s.* to '%s'@'%s' identified by '%s';" % (
                 dbname, dbuser, dbclient, dbpass
             ))
-
         elif engine in ('postgresql', 'postgresql_psycopg2', 'postgis'):
             if options['drop']:
                 print("DROP DATABASE IF EXISTS %s;" % (dbname,))
@@ -65,10 +75,8 @@ def handle(self, *args, **options):
             print("CREATE USER %s WITH ENCRYPTED PASSWORD '%s' CREATEDB;" % (dbuser, dbpass))
             print("CREATE DATABASE %s WITH ENCODING 'UTF-8' OWNER \"%s\";" % (dbname, dbuser))
             print("GRANT ALL PRIVILEGES ON DATABASE %s TO %s;" % (dbname, dbuser))
-
         elif engine == 'sqlite3':
             sys.stderr.write("-- manage.py syncdb will automatically create a sqlite3 database file.\n")
-
         else:
             # CREATE DATABASE is not SQL standard, but seems to be supported by most.
             sys.stderr.write("-- Don't know how to handle '%s' falling back to SQL.\n" % engine)

django_extensions/management/commands/sqldsn.py

@@ -6,25 +6,30 @@
 """
 
 import sys
+import warnings
+
 from django.conf import settings
 from django.core.management.base import BaseCommand, CommandError
 from django.core.management.color import color_style
+from django.db import DEFAULT_DB_ALIAS
+from django_extensions.utils.deprecation import RemovedInNextVersionWarning
 
 
 class Command(BaseCommand):
-    help = """Prints DSN on stdout, as specified in settings.py
-
-    ./manage.py sqldsn [--router=<routername>] [--style=pgpass]"""
-
+    help = "Prints DSN on stdout, as specified in settings.py"
     requires_system_checks = False
     can_import_settings = True
 
     def add_arguments(self, parser):
         super().add_arguments(parser)
         parser.add_argument(
             '-R', '--router', action='store',
-            dest='router', default='default',
-            help='Use this router-database other then default'
+            dest='router', default=DEFAULT_DB_ALIAS,
+            help='Use this router-database other then default (deprecated: use --database instead)'
+        )
+        parser.add_argument(
+            '--database', default=DEFAULT_DB_ALIAS,
+            help='Nominates a database to run command for. Defaults to the "%s" database.' % DEFAULT_DB_ALIAS,
         )
         parser.add_argument(
             '-s', '--style', action='store',
@@ -44,25 +49,28 @@ def add_arguments(self, parser):
 
     def handle(self, *args, **options):
         self.style = color_style()
-        all_routers = options['all']
+        all_databases = options['all']
 
-        if all_routers:
-            routers = settings.DATABASES.keys()
+        if all_databases:
+            databases = settings.DATABASES.keys()
         else:
-            routers = [options['router']]
+            databases = [options['database']]
+            if options['router'] != DEFAULT_DB_ALIAS:
+                warnings.warn("--router is deprecated. You should use --database.", RemovedInNextVersionWarning, stacklevel=2)
+                databases = [options['router']]
 
-        for i, router in enumerate(routers):
+        for i, database in enumerate(databases):
             if i != 0:
                 sys.stdout.write("\n")
-            self.show_dsn(router, options)
+            self.show_dsn(database, options)
 
-    def show_dsn(self, router, options):
-        dbinfo = settings.DATABASES.get(router)
+    def show_dsn(self, database, options):
+        dbinfo = settings.DATABASES.get(database)
         quiet = options['quiet']
         dsn_style = options['style']
 
         if dbinfo is None:
-            raise CommandError("Unknown database router %s" % router)
+            raise CommandError("Unknown database %s" % database)
 
         engine = engine = dbinfo.get('ENGINE')
         if 'psqlextra' not in engine:
@@ -86,7 +94,7 @@ def show_dsn(self, router, options):
             dsn.append(self.style.ERROR('Unknown database, can''t generate DSN'))
 
         if not quiet:
-            sys.stdout.write(self.style.SQL_TABLE("DSN for router '%s' with engine '%s':\n" % (router, engine)))
+            sys.stdout.write(self.style.SQL_TABLE("DSN for database '%s' with engine '%s':\n" % (database, engine)))
 
         for output in dsn:
             sys.stdout.write("{}\n".format(output))
@@ -112,32 +120,38 @@ def _postgresql(self, dbhost, dbport, dbname, dbuser, dbpass, dsn_style=None):
             if dbport is not None:
                 dsnstr += " port='{1}'"
 
-            dsn.append(dsnstr.format(dbhost,
-                                     dbport,
-                                     dbname,
-                                     dbuser,
-                                     dbpass,))
-
-        if dsn_style == 'all' or dsn_style == 'kwargs':
+            dsn.append(dsnstr.format(
+                dbhost,
+                dbport,
+                dbname,
+                dbuser,
+                dbpass,
+            ))
+
+        if dsn_style in ('all', 'kwargs'):
             dsnstr = "host='{0}', database='{2}', user='{3}', password='{4}'"
             if dbport is not None:
                 dsnstr += ", port='{1}'"
 
-            dsn.append(dsnstr.format(dbhost,
-                                     dbport,
-                                     dbname,
-                                     dbuser,
-                                     dbpass))
-
-        if dsn_style == 'all' or dsn_style == 'uri':
+            dsn.append(dsnstr.format(
+                dbhost,
+                dbport,
+                dbname,
+                dbuser,
+                dbpass,
+            ))
+
+        if dsn_style in ('all', 'uri'):
             dsnstr = "postgresql://{user}:{password}@{host}/{name}"
 
             dsn.append(dsnstr.format(
                 host="{host}:{port}".format(host=dbhost, port=dbport) if dbport else dbhost,  # noqa
-                name=dbname, user=dbuser, password=dbpass))
+                name=dbname,
+                user=dbuser,
+                password=dbpass,
+            ))
 
-        if dsn_style == 'all' or dsn_style == 'pgpass':
-            dsn.append(':'.join(map(str, filter(
-                None, [dbhost, dbport, dbname, dbuser, dbpass]))))
+        if dsn_style in ('all', 'pgpass'):
+            dsn.append(':'.join(map(str, filter(None, [dbhost, dbport, dbname, dbuser, dbpass]))))
 
         return dsn