Escrevendo comandos personalizados do django-admin

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.

Pra tal, adicione um diretório management/commands a sua aplicação. O Django irá registrar um comando manage.py para cada módulo Python dentro deste diretório, cujo o nome não inicie com underscore. Por exemplo:

polls/
    __init__.py
    models.py
    management/
        __init__.py
        commands/
            __init__.py
            _private.py
            closepoll.py
    tests.py
    views.py

Em Python 2, tenha certeza de incluir arquivo __init__.py em ambos os diretórios management e management/commands como feito acima ou seus comandos não serão detectados.

Neste 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.

Scripts autônomos

Comandos de gerenciamento customizados, são especialmente úteis para a execução de scripts independentes ou para scripts que são periodicamente executados a partir do crontab do UNIX ou do painel de controle de tarefas agendadas do Windows.

Para implementar o comando, edite polls/management/command/closepoll.py para que fique assim:

from django.core.management.base import BaseCommand, CommandError
from polls.models import Question as Poll

class Command(BaseCommand):
    help = 'Closes the specified poll for voting'

    def add_arguments(self, parser):
        parser.add_argument('poll_id', nargs='+', type=int)

    def handle(self, *args, **options):
        for poll_id in options['poll_id']:
            try:
                poll = Poll.objects.get(pk=poll_id)
            except Poll.DoesNotExist:
                raise CommandError('Poll "%s" does not exist' % poll_id)

            poll.opened = False
            poll.save()

            self.stdout.write(self.style.SUCCESS('Successfully closed poll "%s"' % poll_id))

Nota

Quando estiver usando comandos de gerenciamento e desejar enviar a saída para console, deve se escrever para o self.stdout e self.stderr, ao invés de imprimir para o stdout e stderr diretamente. Ao usar esses proxies, torna-se muito mais fácil para testar o seu comando personalizado. Observe também que você não precisa terminar mensagens com um caractere de nova linha, este será adicionado automaticamente, a menos que você especifique o parâmetro ending:

self.stdout.write("Unterminated line", ending='')

O novo comando personalizado pode ser chamado usando python manage.py closepoll <poll_id>.

O método handle() recebe um ou mais poll_ids e definie poll.opened como False para cada um. Se o usuário referenciar uma enquete inexistente, uma CommandError é gerada. O atributo poll.opened não existe no tutorial e foi adicionado ao polls.models.Question para este exemplo.

Aceitando argumentos opcionais

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):
    def add_arguments(self, parser):
        # Positional arguments
        parser.add_argument('poll_id', nargs='+', type=int)

        # Named (optional) arguments
        parser.add_argument(
            '--delete',
            action='store_true',
            dest='delete',
            default=False,
            help='Delete poll instead of closing it',
        )

    def handle(self, *args, **options):
        # ...
        if options['delete']:
            poll.delete()
        # ...

A 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`.

Comandos de gerenciamento e localidades

Por padrão, o método BaseCommand.execute() desativa traduções porque alguns comandos internos do Django executam várias tarefas (por exemplo, renderização de conteúdo voltado ao usuário e popular o banco de dados) que exigem uma língua neutra no projeto.

Se por algum motivo, o seu comando personalizado de gerenciamento precisar usar uma localidade fixa, você deve ativar e desativar manualmente no método handle() usando as funções fornecidas pelo código de apoio I18N:

from django.core.management.base import BaseCommand, CommandError
from django.utils import translation

class Command(BaseCommand):
    ...

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

        # Activate a fixed locale, e.g. Russian
        translation.activate('ru')

        # Or you can activate the LANGUAGE_CODE # chosen in the settings:
        from django.conf import settings
        translation.activate(settings.LANGUAGE_CODE)

        # Your command logic here
        ...

        translation.deactivate()

Outra necessidade pode ser que o seu comando simplesmente deva utilizar a definição de localidade definida no settings e o Django deve ser impedido de desativá-lo. Você pode fazer isso usando a opção BaseCommand.leave_locale_alone.

Porém, ao trabalhar nos cenários descritos acima, leve em consideração que comandos de gerenciamento de sistemas tipicamente tem que ser muito cuidadosos sobre o funcionamento em locais não-uniformes, de modo que você pode precisar:

• Verificar se o USE_I18N é sempre True ao executar o comando (este é um bom exemplo dos potenciais problemas decorrentes de um ambiente de execução dinâmico que comandos do Django evitam desativando traduções).
• Rever o código do seu comando e o código que este chama para diferenças de comportamento quando as localidades são alteradas e avaliar o seu impacto sobre o comportamento previsível de seu comando.

Testando

Informações sobre como testar comandos de gerenciamento personalizados pode ser encontradas na documentação de teste.

Sobrescrevendo comandos.

Django registra os comandos internos e depois procura os comandos em INSTALLED_APPS. Durante a busca, se for encontrado um comando que já tiver sido registrado, o comando encontrado substitui o primeiro.

In other words, to override a command, the new command must have the same name and its app must be before the overridden command’s app in INSTALLED_APPS.

Management commands from third-party apps that have been unintentionally overridden can be made available under a new name by creating a new command in one of your project’s apps (ordered before the third-party app in INSTALLED_APPS) which imports the Command of the overridden command.

Objetos Command

class BaseCommand[código fonte]

A classe base a partir da qual todos os comandos de gestão, em última análise derivam.

Use 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.

Subclasssing a classe BaseCommand requer que você implemente o método handle().

Atributos

Todos os atributos podem ser definidos em sua classe derivada e podem ser usados nas subclasses de BaseCommand

BaseCommand.help

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>.

BaseCommand.missing_args_message

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”).

BaseCommand.output_transaction

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.

BaseCommand.requires_migrations_checks

New in Django 1.10.

Um booleano; Se True, o comando “printa” um alerta se a definição das 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.

BaseCommand.requires_system_checks

Um booleano; Se True, todo o projeto Django será verificado sobre potenciais problemas antes de executar o comando. O valor padrão é True.

BaseCommand.leave_locale_alone

Um booleano que indica se o local definido nas configurações devem se preservado durante a execução do comando em vez de ser forçosamente definido como ‘en-us’.

O valor padrão é False.

Certifique-se de que sabe o que está fazendo, se decidir alterar o valor desta opção no seu comando personalizado se criar um conteúdo de base de dados que seja sensível à localização e esse conteúdo não contenha traduções (como acontece por exemplo com: mod: Django.contrib.auth permissões) como fazer a localização diferente do padrão ‘en-us’ pode causar efeitos indesejados. Consulte a seção Comandos de gerenciamento e locais acima para obter mais detalhes.

BaseCommand.style

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('...'))

Veja 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).

Se você passar a opção --no-color ao executar o seu comando, todas as chamadas self.style() retornarão a string original sem colorir.

Métodos

BaseCommand tem alguns métodos que podem ser sobrescritos mas apenas o método handle() deve ser implementado.

Implementando um construtor em uma subclasse

Se você implementar __init__ em sua subclasse de BaseCommand, você deve chamar: o __init__ do class:` BaseCommand`:

class Command(BaseCommand):
    def __init__(self, *args, **kwargs):
        super(Command, self).__init__(*args, **kwargs)
        # ...

BaseCommand.add_arguments(parser)[código fonte]

Ponto de entrada que recebe argumentos do “parser” para manipular comandos passados pela linha de comando. Comandos personalizados devem sobrescrever este método para adicionar ambos argumentos posicionais ou opicionais que sejam aceitos pelo comando. Não é necessário chamar o super() quando for uma subclasse de BaseCommand.

BaseCommand.get_version()[código fonte]

Retorna a versão do Django, que deve estar correto 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.

BaseCommand.execute(*args, **options)[código fonte]

Tenta executar este comando, realizando verificações de sistemas se necessário (como controlado pelo atributo requires_system_checks). Se o comando gerar um CommandError, este é interceptado e impresso no stderr.

Chamando um comando de gestão dentro do seu código

execute() não deve ser chamado diretamente do seu código para executar um comando. Ao invés disso, use call_command() .

BaseCommand.handle(*args, **options)[código fonte]

A lógica atual do comando. Subclasses devem implementar este método.

Ele pode retornar uma string Unicode que será impresso para stdout (envolvido por BEGIN; e `` COMMIT; `` se output_transaction for True).

BaseCommand.check(app_configs=None, tags=None, display_num_errors=False)[código fonte]

Usa a estrutura de verificação do sistema para inspecionar todo o projeto Django para os potenciais problemas. Graves problemas são levantados como CommandError; avisos são enviados para stderr; notificações menos importantes são enviados para stdout.

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.

Subclasses de BaseCommand

class AppCommand

Um comando de gestão que recebe como argumento um ou mais “labels” de aplicações instaladas, e faz alguma coisa com cada um deles.

Melhor que implementar handle(), as subclasses devem implementar :meth:` ~AppCommand.handle_app_config`, que será chamado uma vez para cada aplicação.

AppCommand.handle_app_config(app_config, **options)

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.

class LabelCommand

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.

Em vez de implementar handle(), subclasses devem implementar handle_label(), que será chamado uma vez para cada etiqueta.

LabelCommand.label

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’``.

LabelCommand.handle_label(label, **options)

Executar ações do comando para label, que será a string como informada na linha de comando.

Exceções de comando

exception CommandError[código fonte]

A classe de exceção indica um problema ao executar um comando de gestão.

Se esta exceção é gerada durante a execução de um comando de gerenciamento chamado do console da linha de comando, ele será capturado e transformado em uma mensagem de erro devidamente impresso para a saída apropriada (isto é, stderr); como resultado, gerar essa exceção (com uma descrição sensata do erro) é a maneira preferida para indicar que algo deu errado na execução de um comando.

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.