django-admin commandsLink para este cabeçalho#As aplicações podem registrar suas próprias ações com manage.py. Por exemplo, você pode querer adicionar uma ação manage.py para uma aplicação Django que você está distribuindo. Neste documento, construiremos um comando customizado closepoll para a aplicação polls do tutorial.
To do this, add a management/commands directory to the application. Django\nwill register a manage.py command for each Python module in that directory\nwhose name doesn’t begin with an underscore. For example:
polls/\n __init__.py\n models.py\n management/\n __init__.py\n commands/\n __init__.py\n _private.py\n closepoll.py\n tests.py\n views.py\nNeste exemplo, o comando closepoll estará disponível a qualquer projeto que inclua a aplicação polls em INSTALLED_APPS.
O módulo _private.py não estará disponível como um comando de gerenciamento.
O módulo closepoll.py tem apenas uma exigência – deve definir uma classe Command que estende BaseCommand ou uma de suas subclasses.
Para implementar o comando, edite polls/management/commands/closepoll.py para que fique assim:
from django.core.management.base import BaseCommand, CommandError\nfrom polls.models import Question as Poll\n\nclass Command(BaseCommand):\n help = 'Closes the specified poll for voting'\n\n def add_arguments(self, parser):\n parser.add_argument('poll_ids', nargs='+', type=int)\n\n def handle(self, *args, **options):\n for poll_id in options['poll_ids']:\n try:\n poll = Poll.objects.get(pk=poll_id)\n except Poll.DoesNotExist:\n raise CommandError('Poll "%s" does not exist' % poll_id)\n\n poll.opened = False\n poll.save()\n\n self.stdout.write(self.style.SUCCESS('Successfully closed poll "%s"' % poll_id))\nO novo comando personalizado pode ser chamado usando python manage.py closepoll <poll_ids>.
O método handle() usa um ou mais poll_ids e altera o “poll.opened” para False para cada um. Se o usuário referenciar qualquer enquete inexistente, uma exceção será levantada CommandError. O atributo poll.opened não existe no tutorial e foi adicionado em polls.models.Question para este exemplo.
O mesmo closepoll poderia ser facilmente modificado para excluir uma determinada enquete, ao invés de fechá-la, aceitando as opções de linha de comando adicionais. Estas opções personalizadas podem ser adicionadas no método add_arguments() assim:
class Command(BaseCommand):\n def add_arguments(self, parser):\n # Positional arguments\n parser.add_argument('poll_ids', nargs='+', type=int)\n\n # Named (optional) arguments\n parser.add_argument(\n '--delete',\n action='store_true',\n help='Delete poll instead of closing it',\n )\n\n def handle(self, *args, **options):\n # ...\n if options['delete']:\n poll.delete()\n # ...\nA opção (delete no nosso exemplo) está disponível no parâmetro dict (options) do método handle. Veja argparse na documentação do Python para saber mais sobre o uso do add_argument.
Além de ser capaz de adicionar opções personalizadas de linha de comando, todos comandos de gereciamento aceitam algumas opções padrão, tais como :opção:`--verbosity` e :opção:`--traceback`.
\nPor padrão, comandos de gerenciamento são executados com a localidade corrente ativa.
\nSe, por alguma razão, seu comando de gerenciamento personalizado precise ser executado sem um local ativo (por exemplo, para evitar que o conteúdo traduzido seja inserido dentro do banco de dados), desative a tradução utilizado o decorator @no_translations no seu método handle():
from django.core.management.base import BaseCommand, no_translations\n\nclass Command(BaseCommand):\n ...\n\n @no_translations\n def handle(self, *args, **options):\n ...\nComo a desativação da tradução requer acesso as configurações definidas, os decorator’s não podem ser utilizados por comandos que trabalham sem configurações pré definidas.
\nInformações sobre como testar comandos de gerenciamento personalizados pode ser encontradas na documentação de teste.
\nDjango registra os comandos internos e depois procura os comandos em INSTALLED_APPS em orderm reversa. Durante a busca, se um comando duplica um comando já registrado, o novo comando encontrado substitui o primeiro.
Em outras palavras, para sobrescrever um comando, o novo comando precisa ter o mesmo nome e seu app precisa estar antes do comando da app a ser sobrescrito em : setting:INSTALLED_APPS.
\nComandos de gerenciamento de aplicações de terceiros que foram sobrescritos de maneira nao intencional podem se tornar disponíveis sob um novo nome através da criação de um novo comando em um dos apps do projeto (colocado antes da aplicação de terceiros em :setting:`INSTALLED_APPS) o qual importa o ‘Comando’ do comando sobrescrito.
\nA classe base a partir da qual todos os comandos de gestão, em última análise derivam.
\nUse esta classe se você quer acesso a todos os mecanismos que realizam o parse dos argumentos da linha de comando e verificar qual código chamar em resposta; se você não precisa mudar este comportamento, considere usar uma dessas subclasses.
\nSubclasssing a classe BaseCommand requer que você implemente o método handle().
Todos os atributos podem ser definidos em sua classe derivada e podem ser usados nas subclasses de BaseCommand
Uma breve descrição do comando, que será impresso na mensagem de ajuda quando o usuário executar o comando python manage.py help <command>.
Se o seu comando define argumentos posicionais obrigatórios, você pode personalizar a mensagem de erro devolvida em caso de falta de argumentos. O padrão é a saída por argparse (“poucos argumentos”).
Um booleano que indica como os comandos retornam SQL “statements”; Se True, a saída será automaticamente envolvido com BEGIN; e COMMIT;. O valor padrão é False.
Um booleano; Se True, o comando “printa” um alerta se o conjunto de migrações no disco não estiver de acordo com as migrações no banco de dados. Um alerta não previne o comando de ser executado. O valor padrão é False.
A list or tuple of tags, e.g. [Tags.staticfiles, Tags.models]. System\nchecks registered in the chosen tags\nwill be checked for errors prior to executing the command. The value\n'__all__' can be used to specify that all system checks should be\nperformed. Default value is '__all__'.
Um atributo de instância que ajuda a criar uma saída colorida quando se escreve no stdout ou stderr. Por exemplo:
self.stdout.write(self.style.SUCCESS('...'))\nVeja sintaxe-coloring para aprender como modificar a paleta de cores e ver os estilos disponíveis (use caixa-alta das versões das opções descritas nessa seção).
\nSe você passar a opção --no-color ao executar o seu comando, todas as chamadas self.style() retornarão a string original sem colorir.
The default command options to suppress in the help output. This should be\na set of option names (e.g. '--verbosity'). The default values for the\nsuppressed options are still passed.
BaseCommand tem alguns métodos que podem ser sobrescritos mas apenas o método handle() deve ser implementado.
Retorna uma instância de CommandParser, o qual é uma classe: argparse.ArgumentParser subclasse, com algumas personalizações para o Django.
Você pode customizar a instância por sobrecarga desse método, chamando super() com kwargs da classe:~argparse.ArgumentParser como parâmetro.
Ponto de entrada para passar um “parser” como argumento para lidar com os argumentos da linha de comando passados ao comando. Comandos personalizados devem sobrescrever este método para adicionar ambos argumentos posicionais e opicionais aceitos pelo comando. Não é necessário chamar o super() quando for uma subclasse de BaseCommand.
Retorna a versão do Django, que deve ser a correta para todos os comandos internos do Django. É possível sobrescrever este método para que comandos fornecidos pelo usuário possam retornar a sua própria versão.
\nTries to execute this command, performing system checks if needed (as\ncontrolled by the requires_system_checks attribute). If the command\nraises a CommandError, it’s intercepted and printed to stderr.
A lógica atual do comando. Subclasses devem implementar este método.
\nPode retornar uma string tal qual será impressa no “stdout” (acrescido por “BEGIN;” e “COMMIT;” se :attr:’output_transaction’ for “True”).
\nUses the system check framework to inspect the entire Django project for\npotential problems. Serious problems are raised as a CommandError;\nwarnings are output to stderr; minor notifications are output to\nstdout.
Se ambos app_configs e tags forem None, todas as verificações do sistema são realizadas. `` Tags`` pode ser uma lista tags de checagem, como compatibility ou models.
BaseCommandLink para este cabeçalho#Um comando de gerenciamento que recebe como argumento um ou mais “labels” de aplicação instaladas, e faz alguma coisa com cada um deles.
\nMelhor que implementar handle(), as subclasses devem implementar :meth:` ~AppCommand.handle_app_config`, o qual será chamado uma vez para cada aplicação.
Executar ações do comando para app_config, o qual será uma instância de AppConfig correspondente a um label do aplicativo informado na linha de comando.
Um comando de gestão que recebe um ou mais argumentos arbitrários (“labels”) na linha de comando, e faz alguma coisa com cada um deles.
\nEm vez de implementar handle(), subclasses devem implementar handle_label(), que será chamado uma vez para cada etiqueta.
Uma string que descreve os argumentos arbitrários passados para o comando. A string é usada no texto de uso e mensagens de erro do comando. Padrão para `` ‘label’``.
\nExecutar ações do comando para label, que será a string como informada na linha de comando.
A classe de exceção indica um problema ao executar um comando de gestão.
\nIf this exception is raised during the execution of a management command from a\ncommand line console, it will be caught and turned into a nicely-printed error\nmessage to the appropriate output stream (i.e., stderr); as a result,\nraising this exception (with a sensible description of the error) is the\npreferred way to indicate that something has gone wrong in the execution of a\ncommand. It accepts the optional returncode argument to customize the exit\nstatus for the management command to exit with, using sys.exit().
Se um comando de gestão é chamado do código através do call_command(), cabe a você capturar a exceção quando necessário.