class documentation

class Command(BaseCommand):

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method ​_get​_input​_message Undocumented
Method ​_validate​_username Validate username. If invalid, return a string error message.
Method add​_arguments Entry point for subclassed commands to add custom arguments.
Method execute Try to execute this command, performing system checks if needed (as controlled by the requires_system_checks attribute, except if force-skipped).
Method get​_input​_data Override this method if you want to customize data inputs or validation exceptions.
Method handle The actual logic of the command. Subclasses must implement this method.
Class Variable help Undocumented
Class Variable requires​_migrations​_checks Undocumented
Class Variable stealth​_options Undocumented
Instance Variable stdin Undocumented
Instance Variable ​User​Model Undocumented
Instance Variable username​_field Undocumented

Inherited from BaseCommand:

Method add​_base​_argument Call the parser's add_argument() method, suppressing the help text according to BaseCommand.suppressed_base_arguments.
Method check No summary
Method check​_migrations Print a warning if the set of migrations on disk don't match the migrations in the database.
Method create​_parser Create and return the ArgumentParser which will be used to parse the arguments to this command.
Method get​_version Return the Django version, which should be correct for all built-in Django commands. User-supplied commands can override this method to return their own version.
Method print​_help Print the help message for this command, derived from self.usage().
Method run​_from​_argv No summary
Class Variable base​_stealth​_options Undocumented
Class Variable output​_transaction Undocumented
Class Variable suppressed​_base​_arguments Undocumented
Instance Variable ​_called​_from​_command​_line Undocumented
Instance Variable requires​_system​_checks Undocumented
Instance Variable stderr Undocumented
Instance Variable stdout Undocumented
Instance Variable style Undocumented
def __init__(self, *args, **kwargs):
def _get_input_message(self, field, default=None):

Undocumented

def _validate_username(self, username, verbose_field_name, database):
Validate username. If invalid, return a string error message.
def add_arguments(self, parser):
Entry point for subclassed commands to add custom arguments.
def execute(self, *args, **options):
Try to execute this command, performing system checks if needed (as controlled by the requires_system_checks attribute, except if force-skipped).
def get_input_data(self, field, message, default=None):
Override this method if you want to customize data inputs or validation exceptions.
def handle(self, *args, **options):
The actual logic of the command. Subclasses must implement this method.
help: str =
requires_migrations_checks: bool =
stealth_options: tuple[str, ...] =
stdin =

Undocumented

UserModel =

Undocumented

username_field =

Undocumented