Module management

Classes

• class ManagementUtility
  Encapsulate the logic of the django-admin and manage.py utilities.

Re-exported Classes

• class BaseCommand
  The base class from which all management commands ultimately derive.
  [django.core.management.base.BaseCommand]
• class CommandError
  Exception class indicating a problem while executing a management command.
  [django.core.management.base.CommandError]
• class CommandParser
  Customized ArgumentParser class to improve some error messages and prevent SystemExit in several occasions, as SystemExit is unacceptable when a command is called programmatically.
  [django.core.management.base.CommandParser]

Functions

• ▶ def call_command(command_name, *args, **options)

  Call the given command, with the given options and args/kwargs.

  source link

  This is the primary API you should use for calling specific commands.
  
  `command_name` may be a string or a command object. Using a string is
  preferred unless the command object is required for further processing or
  testing.
  
  Some examples:
      call_command('migrate')
      call_command('shell', plain=True)
      call_command('sqlmigrate', 'myapp')
  
      from django.core.management.commands import flush
      cmd = flush.Command()
      call_command(cmd, verbosity=0, interactive=False)
      # Do something with cmd ...

  Reexports

  • Imported in django.core.management.commands.testserver.
  • Imported in django.test.runner.
  • Imported in django.test.testcases.
• ▷ def execute_from_command_line(argv=None)

  Run a ManagementUtility.

  source link
• ▷ def find_commands(management_dir)

  Given a path to a management directory, return a list of all the command names that are available.

  source link
• ▶ def get_commands() @functools.lru_cache(maxsize=None)

  Return a dictionary mapping command names to their callback applications.

  @functools.lru_cache(maxsize=None)
  def get_commands()

  source link

  Look for a management.commands package in django.core, and in each
  installed application -- if a commands package exists, register all
  commands in that package.
  
  Core commands are always included. If a settings module has been
  specified, also include user-defined commands.
  
  The dictionary is in the format {command_name: app_name}. Key-value
  pairs from this dictionary can then be used in calls to
  load_command_class(app_name, command_name)
  
  If a specific version of a command must be loaded (e.g., with the
  startapp command), the instantiated module can be placed in the
  dictionary in place of the application name.
  
  The dictionary is cached on the first call and reused on subsequent
  calls.

• ▷ def load_command_class(app_name, name)

  Given a command name and an application name, return the Command class instance. Allow all errors raised by the import process (ImportError, AttributeError) to propagate.

  source link

Re-exported Functions

• def color_style(force_color=False)
  Return a Style object from the Django color scheme.
  [django.core.management.color.color_style]
• def handle_default_options(options)
  Include any default options that all commands should accept here so that ManagementUtility can handle them before searching for user commands.
  [django.core.management.base.handle_default_options]

Submodules

• Module django.core.management.base
  Base classes for writing management commands (named commands which can be executed through ``django-admin`` or ``manage.py``).
• Module django.core.management.color
  Sets up the terminal color scheme.
• Module django.core.management.commands
• Module django.core.management.sql
• Module django.core.management.templates
• Module django.core.management.utils

Generated by nedoc v0.9 at 2020-12-29 14:04