djangodocs

Django 2.2
Português (Brasil)
Documentation contents

Tutorial avançado: Como escrever aplicações reutilizáveis

Este tutorial avançado começa onde o Tutorial 7 terminou. Nós transformaremos nossa aplicação web em um pacote Python autônomo que você pode reutilizar em novos projetos e compartilhar com outras pessoas.

Caso não tenha completado recentemente os tutoriais 1-7, encorajamos revisá-los Dessa forma seu projeto de exemplo será compatível com o descrito abaixo.

Reutilização importa

É um grande trabalho projetar, contruir, testar e manter uma aplicação web. Muitos projetos Python e Django compartilham problemas em comum. Não seria ótimo se nós pudessemos economizar um pouco desse trabalho repetido?

Reusabilidade é um modo de vida no Python. The Python Package Index (PyPI) tem uma vasta gama de pacotes que você pode usar no seus próprios programas Python. Dê uma olhada em Django Packages para aplicações reutilizáveis existentes que você pode incorporrar no seu projeto. O próprio Django é ele um pacote Python. Isso significa que você pode pegar pacotes Python e aplicações Django e compor com seu projeto Web. Você só precisa escrever as partes que tornam seu projeto único.

Vamos dizer que você está iniciando um projeto que precisa de uma aplicação de enquetes como a que estivemos trabalhando. Como fazer essa aplicação reutilizável? Sua sorte é que é que você já está no caminho. Em Tutorial, vimos como podemos desacoplar a enquete do URLconf do projeto usando um include. Neste tutorial, iremos adiante para tornar a aplicação fácil de usar em novos projetos e pronta para publicar para outros instalarem e usarem.

Seu projeto e sua aplicação reutilizável

Depois dos tutoriais anteriores, nosso projeto deve ficar assim:

Code
mysite/
    manage.py
    mysite/
        __init__.py
        settings.py
        urls.py
        wsgi.py
    polls/
        __init__.py
        admin.py
        migrations/
            __init__.py
            0001_initial.py
        models.py
        static/
            polls/
                images/
                    background.gif
                style.css
        templates/
            polls/
                detail.html
                index.html
                results.html
        tests.py
        urls.py
        views.py
    templates/
        admin/
            base_site.html

Você criou mysite/templates em Tutorial 7, e polls/templates en Tutorial 3. Talvez agora fique caro porque escolhemos separar o diretório de templates do de projeto e aplicação: tudo que é parte da aplicação “polls” está em polls. Isso torna a aplicação auto-contida e facilita adicioná-la em um novo projeto.

O diretório polls poderia agora ser copiado em um novo projeto Django, e imediatamente reusada. Embora não esteja já pronta para ser publicada. Para isso, nós precisamos empacotar a aplicação para tornar fácil para outros instalarem.

Instalando alguns pré-requisitos

O estado atual do empacotamento Python é um pouco complicado com várias ferramentas. Para este tutorial, vamos estar usando setuptools para construir nosso pacote. É a ferramenta de empacotamento recomendada (mergeado com o fork do distribute). Estaremos usando também o pip para instalar e desinstalá-los. Você deve instalar esses dois pacotes agora. Se precisar de ajuda, você pode consultar o como instalar Django com pip. Você pode instalar o setuptools da mesma maneira.

Empacotando sua aplicação

Empacotamento Python refere-se a preparar sua aplicação num formato específico que possa ser facilmente instalado e usado. O próprio Django é empacotado de uma maneira muito parecida. Para aplicações pequenas, como a de enquetes, esse processo não é tão difícil.

  1. Primeiro, crie um diretório pai para polls, fora do seu projeto Django. Nomeie esse diretório de django-polls`.

  2. Mova o diretório polls para dentro do diretório django-polls.

  3. Crie um arquivo django-polls/README.rst com o seguinte conteúdo:

    django-polls/README.rst
    Rst
    =====
Polls
=====

Polls is a simple Django app to conduct Web-based polls. For each
question, visitors can choose between a fixed number of answers.

Detailed documentation is in the "docs" directory.

Quick start
-----------

1. Add "polls" to your INSTALLED_APPS setting like this::

    INSTALLED_APPS = [
        ...
        'polls',
    ]

2. Include the polls URLconf in your project urls.py like this::

    path('polls/', include('polls.urls')),

3. Run `python manage.py migrate` to create the polls models.

4. Start the development server and visit http://127.0.0.1:8000/admin/
   to create a poll (you'll need the Admin app enabled).

5. Visit http://127.0.0.1:8000/polls/ to participate in the poll.

  4. Crie um arquivo django-polls/LICENSE. Escolher uma licença está fora do escopo deste tutorial, mas é suficiente dizer que código distribuído publicamente sem uma licença é inútil. Djando e muitas aplicações compatíveis com o Django são distribuídas sob a licença BSD; no entanto, você é livre para escolher sua própria licença. Apenas esteja ciente que a escolha da sua licença afetará quem pode usar seu código.

  5. Next we’ll create setup.cfg and setup.py files which detail how to build and install the app. A full explanation of these files is beyond the scope of this tutorial, but the setuptools documentation has a good explanation. Create the files django-polls/setup.cfg and django-polls/setup.py with the following contents:

    django-polls/setup.cfg
    Ini
    [metadata]
name = django-polls
version = 0.1
description = A Django app to conduct Web-based polls.
long_description = file: README.rst
url = https://www.example.com/
author = Your Name
author_email = yourname@example.com
license = BSD-3-Clause  # Example license
classifiers =
    Environment :: Web Environment
    Framework :: Django
    Framework :: Django :: X.Y  # Replace "X.Y" as appropriate
    Intended Audience :: Developers
    License :: OSI Approved :: BSD License
    Operating System :: OS Independent
    Programming Language :: Python
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3 :: Only
    Programming Language :: Python :: 3.6
    Programming Language :: Python :: 3.7
    Programming Language :: Python :: 3.8
    Topic :: Internet :: WWW/HTTP
    Topic :: Internet :: WWW/HTTP :: Dynamic Content

[options]
include_package_data = true
packages = find:
    django-polls/setup.py
    Python
     from setuptools import setup

 setup()

  6. Por padrão, apenas módulos e pacotes Python são incluídos no pacote. Para incluir arquivos adicionais, precisaremos criar um arquivo MANIFEST.in. A documentação do setuptools citada no passo anterior, fala deste arquivo em mais detalhes. Para incluir o templates, o README.rst e nosso arquivo LICENSE, crie um arquivo django-polls/MANIFEST.in com o seguinte conteúdo:

    django-polls/MANIFEST.in
    Text
    include LICENSE
include README.rst
recursive-include polls/static *
recursive-include polls/templates *

  7. É opcional, mas recomendado, incluir uma documentação detalhada com sua aplicação. Crie um diretório django-polls/docs vazio, para futura documentação. Adicione uma linha a mais ao

    Code
    recursive-include docs *

    Note que o diretório docs não será incluido no seu pacote a menos que você adicione alguns arquivos para ele. Muitas aplicações Django fornecem sua documentação online através de sites como

  8. Tente criar seu pacote com python setup.py sdist (execute dentro do diretório django-polls). Esse comando cria um diretório chamado dist e cria seu novo pacote,

Para mais informações sobre empacotamente, veja o Tutorial sobre Empacotamento e Distribuição de Projetos.

Utilizando o seu próprio pacote

Uma vez que movemos o diretório polls para fora do projeto, ele não funciona mais. Vamos consertar isso agora ao instalar nosso novo pacote django-polls.

  1. Para instalar o pacote, use o pip (você já instalou isso, certo?):

    Code
    pip install --user django-polls/dist/django-polls-0.1.tar.gz

  2. Com sorte, seu projeto Django deverá agora funcionar corretamente de novo. Inicie o servidor novamente para confirmar.

  3. Para desinstalar o pacote, use o pip:

    Code
    pip uninstall django-polls

Publicando sua aplicação

Agora que nós empacotamos e testamos django-polls, ele está pronto para ser compartilhado com o mundo! Se isso não foi apenas um exemplo, você pode agora:

Instalando pacotes Python com virtualenv

Anteriormente, nós instalamos nosso app de votação como uma biblioteca de usuário. Isso tem algumas desvantagens:

  • Modificar as bibliotecas de usuário pode afetar outros softwares em Python do seu sistema.

  • Você não poderá rodar versões diferentes do seu pacote (ou outros pacotes com o mesmo nome).

Em geral, essas situações somente vêm a tona quando se mantém vários projetos Django. Neste caso, a melhor solução é usar o virtualenv. Esta ferramenta permite que você mantenha múltiplos ambientes Python isolados, cada um com sua própria cópia de bibliotecas e “namespaces” de pacotes.

View as Markdown Edit this page on GitHub Official version