shell commandLink to this heading#The Django shell is an interactive Python environment that provides\naccess to models and settings, making it useful for testing code, experimenting\nwith queries, and interacting with application data.
Customizing the shell command allows adding extra functionality or\npre-loading specific modules. To do this, create a new management command that\nsubclasses django.core.management.commands.shell.Command and overrides the\nexisting shell management command. For more details, refer to the guide on\noverriding commands.
To customize the automatic import behavior of the shell management\ncommand, override the get_auto_imports() method. This method should return\na sequence of import paths for objects or modules available in the application.\nFor example:
polls/management/commands/shell.pyfrom django.core.management.commands import shell\n\n\nclass Command(shell.Command):\n def get_auto_imports(self):\n return super().get_auto_imports() + [\n "django.urls.reverse",\n "django.urls.resolve",\n ]\nThe customization above adds resolve() and\nreverse() to the default namespace, which already includes\nall models from the apps listed in INSTALLED_APPS. These objects\nwill be available in the shell without requiring a manual import.
Running this customized shell command with verbosity=2 would show:
8 objects imported automatically:\n\n from django.contrib.admin.models import LogEntry\n from django.contrib.auth.models import Group, Permission, User\n from django.contrib.contenttypes.models import ContentType\n from django.contrib.sessions.models import Session\n from django.urls import resolve, reverse\nIf an overridden shell command includes paths that cannot be imported,\nthese errors are shown when verbosity is set to 1 or higher. Duplicate\nimports are automatically handled.
Note that automatic imports can be disabled for a specific shell session\nusing the --no-imports flag. To permanently\ndisable automatic imports, override get_auto_imports() to return None:
class Command(shell.Command):\n def get_auto_imports(self):\n return None\n