class documentation

Undocumented

Method add_arguments Entry point for subclassed commands to add custom arguments.
Method build_potfiles Build pot files and apply msguniq to them.
Method copy_plural_forms Copy plural forms header contents from a Django catalog of locale to the msgs string, inserting it at the right place. msgs should be the contents of a newly created .po file.
Method find_files Get all files in the given root. Also check that there is a matching locale dir for each file.
Method handle The actual logic of the command. Subclasses must implement this method.
Method process_files Group translatable files by locale directory and run pot file build process for each group.
Method process_locale_dir Extract translatable literals from the specified files, creating or updating the POT file for a given locale directory.
Method remove_potfiles Undocumented
Method write_po_file Create or update the PO file for self.domain and `locale`. Use contents of the existing `potfile`.
Class Variable help Undocumented
Class Variable requires_system_checks Undocumented
Instance Variable default_locale_path Undocumented
Instance Variable domain Undocumented
Instance Variable extensions Undocumented
Instance Variable ignore_patterns Undocumented
Instance Variable invoked_for_django Undocumented
Instance Variable keep_pot Undocumented
Instance Variable locale_paths Undocumented
Instance Variable msgattrib_options Undocumented
Instance Variable msgmerge_options Undocumented
Instance Variable msguniq_options Undocumented
Instance Variable no_obsolete Undocumented
Instance Variable symlinks Undocumented
Instance Variable verbosity Undocumented
Instance Variable xgettext_options Undocumented
Property gettext_version Undocumented
Property settings_available Undocumented

Inherited from BaseCommand:

Method __init__ Undocumented
Method add_base_argument Call the parser's add_argument() method, suppressing the help text according to BaseCommand.suppressed_base_arguments.
Method check Use the system check framework to validate entire Django project. Raise CommandError for any serious message (error or critical errors). If there are only light messages (like warnings), print them to stderr and don't raise an exception.
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 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_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 Set up any environment changes requested (e.g., Python path and Django settings), then run this command. If the command raises a ``CommandError``, intercept it and print it sensibly to stderr. If the ``--traceback`` option is present or the raised ``Exception`` is not ``CommandError``, raise it.
Class Variable base_stealth_options Undocumented
Class Variable output_transaction Undocumented
Class Variable requires_migrations_checks Undocumented
Class Variable stealth_options Undocumented
Class Variable suppressed_base_arguments Undocumented
Instance Variable stderr Undocumented
Instance Variable stdout Undocumented
Instance Variable style Undocumented
Instance Variable _called_from_command_line Undocumented
def add_arguments(self, parser): (source)

Entry point for subclassed commands to add custom arguments.

def build_potfiles(self): (source)

Build pot files and apply msguniq to them.

def copy_plural_forms(self, msgs, locale): (source)

Copy plural forms header contents from a Django catalog of locale to the msgs string, inserting it at the right place. msgs should be the contents of a newly created .po file.

def find_files(self, root): (source)

Get all files in the given root. Also check that there is a matching locale dir for each file.

def handle(self, *args, **options): (source)

The actual logic of the command. Subclasses must implement this method.

def process_files(self, file_list): (source)

Group translatable files by locale directory and run pot file build process for each group.

def process_locale_dir(self, locale_dir, files): (source)

Extract translatable literals from the specified files, creating or updating the POT file for a given locale directory. Use the xgettext GNU gettext utility.

def remove_potfiles(self): (source)

Undocumented

def write_po_file(self, potfile, locale): (source)

Create or update the PO file for self.domain and `locale`. Use contents of the existing `potfile`. Use msgmerge and msgattrib GNU gettext utilities.

default_locale_path = (source)

Undocumented

Undocumented

extensions = (source)

Undocumented

ignore_patterns = (source)

Undocumented

invoked_for_django: bool = (source)

Undocumented

keep_pot = (source)

Undocumented

locale_paths = (source)

Undocumented

msgattrib_options = (source)

Undocumented

msgmerge_options = (source)

Undocumented

msguniq_options = (source)

Undocumented

no_obsolete = (source)

Undocumented

symlinks = (source)

Undocumented

verbosity = (source)

Undocumented

xgettext_options = (source)

Undocumented

Undocumented

@cached_property
settings_available = (source)

Undocumented