Escrevendo seu primeiro app Django, parte 1¶
Vamos aprender por um exemplo.
Através deste tutorial, nós vamos caminhar através da criação de uma aplicação básica de enquetes.
Ela irá consistir de duas partes:
Uma página pública que permitirá que pessoas vejam as enquetes e votem nelas.
Um site de administração que permite adicionar, alterar e deletar enquetes.
Assumiremos que você já tem o Django instalado. Você pode verificar se o Django está instalado e em qual versão rodando o seguinte comando em um prompt shell (indicado pelo prefixo $):
$ python -m django --version
...\> py -m django --version
Se o Django estiver instalado, você verá a versão de sua instalação. Se não estiver, você receberá uma mensagem de erro dizendo “No module named django”.
This tutorial is written for Django 5.1, which supports Python 3.10 and later. If the Django version doesn’t match, you can refer to the tutorial for your version of Django by using the version switcher at the bottom right corner of this page, or update Django to the newest version. If you’re using an older version of Python, check Qual versão do Python eu posso usar com Django? to find a compatible version of Django.
Onde obter ajuda:
Se tiver problemas enquanto caminha por este tutorial, por favor consulte a seção Obtendo ajuda da FAQ.
Criando um projeto¶
Se esta é a primeira vez em que você está utilizando o Django, você terá que preocupar-se com algumas configurações iniciais. Isto é, você precisará auto-gerar um código para iniciar um projeto Django – uma coleção de configurações para uma instância do Django, incluindo configuração do banco de dados, opções específicas do Django e configurações específicas da aplicação.
From the command line, cd into a directory where you’d like to store your
code and create a new directory named djangotutorial. (This directory name
doesn’t matter to Django; you can rename it to anything you like.)
$ mkdir djangotutorial
...\> mkdir djangotutorial
Then, run the following command to bootstrap a new Django project:
$ django-admin startproject mysite djangotutorial
...\> django-admin startproject mysite djangotutorial
This will create a project called mysite inside the djangotutorial
directory. If it didn’t work, see Problemas ao rodar o django-admin.
Nota
Você precisará evitar dar nomes a projetos que remetam a componentes internos do Python ou do Django. Particularmente, isso significa que você deve evitar usar nomes como django (que irá conflitar com o próprio Django) ou test (que irá conflitar com um pacote interno do Python).
Veja a estrutura de diretório criada com o comando startproject:
djangotutorial/
manage.py
mysite/
__init__.py
settings.py
urls.py
asgi.py
wsgi.py
Esses arquivos são:
manage.py: um utilitário de linha de comando que permite a você interagir com esse projeto Django de várias maneiras. Você pode ler todos os detalhes sobre omanage.pyem django-admin and manage.py.mysite/: A directory that is the actual Python package for your project. Its name is the Python package name you’ll need to use to import anything inside it (e.g.mysite.urls).mysite/__init__.py: um arquivo vazio que diz ao Python que este diretório deve ser considerado um pacote Python. Se você é um iniciante Python, leia mais sobre pacotes na documentação oficial do Python.mysite/settings.py: configurações para este projeto Django. Configurações do Django irá revelar para você tudo sobre o funcionamento dosettings.mysite/urls.py: as declarações de URLs para este projeto Django; um “índice” de seu site movido a Django. Você pode ler mais sobre URLs em Despachante de URL.mysite/asgi.py: um ponto de integração para servidores web compatíveis com ASGI usado para servir seu projeto. Veja Como fazer o deploy com ASGI para mais detalhes.mysite/wsgi.py: um ponto de integração para servidores web compatíveis com WSGI usado para servir seu projeto. Veja Como implementar com WSGI para mais detalhes.
O servidor de desenvolvimento¶
Let’s verify your Django project works. Change into the djangotutorial
directory, if you haven’t already, and run the following commands:
$ python manage.py runserver
...\> py manage.py runserver
Você verá a seguinte saída na sua linha de comando:
Performing system checks... System check identified no issues (0 silenced). You have unapplied migrations; your app may not work properly until they are applied. Run 'python manage.py migrate' to apply them. dezembro 17, 2024 - 15:50:53 Django version 5.1, using settings 'mysite.settings' Starting development server at http://127.0.0.1:8000/ Quit the server with CONTROL-C.
Nota
Por hora, ignore os avisos sobre as migrações do banco de dados não aplicadas; lidaremos com o banco de dados brevemente.
Agora que o servidor está funcionando, visite http://127.0.0.1:8000/ no seu navegador web. Você verá uma página de “Congratulations!”, com um foguete decolando. Funcionou!
Você iniciou o servidor de desenvolvimento do Django, um servidor web leve escrito exclusivamente em Python. Incluímos isso no Django para que você possa desenvolver coisas rapidamente, sem ter que lidar com a configuração de um servidor de produção – como o Apache – até que esteja pronto para a produção.
Agora, uma boa recomendação: não use esse servidor em ambiente de produção. Porque ele foi planejado apenas para desenvolvimento. (Nosso objetivo é criar um framework web e não um servidor web).
(To serve the site on a different port, see the runserver reference.)
Recarregamento automático do runserver
O servidor de desenvolvimento recarrega o código Python para cada solicitação, conforme necessário. Você não precisa reiniciar o servidor para que alterações de código tenham efeito. No entanto, algumas ações como a adição de arquivos não disparam uma reinicialização, então você terá que reiniciar o servidor nestes casos.
Criando a aplicação de enquetes: Polls¶
Agora que seu ambiente – um “projeto” – está configurado, você está pronto para começar o trabalho.
Cada aplicação que você escreve no Django consiste de um pacote Python que segue uma certa convenção. O Django vem com um utilitário que gera automaticamente a estrutura básica de diretório de uma aplicação, então você pode se concentrar apenas em escrever código em vez de ficar criando diretórios.
Projetos versus aplicações
Qual a diferença entre um projeto e um app? Um app é uma aplicação web que executa algo, por exemplo: um sistema de blog, uma base de dados de registros públicos ou uma pequena aplicação de enquete. Um projeto é uma coleção de configurações e apps para um website específico. Um projeto pode conter múltiplos apps. Um app pode estar em múltiplos projetos.
Your apps can live anywhere in your Python path. In
this tutorial, we’ll create our poll app inside the djangotutorial folder.
Para criar sua aplicação, certifique-se de que esteja no mesmo diretório que manage.py e digite o seguinte comando:
$ python manage.py startapp polls
...\> py manage.py startapp polls
Isto criará um diretório polls, com a seguinte estrutura:
polls/
__init__.py
admin.py
apps.py
migrations/
__init__.py
models.py
tests.py
views.py
Esta estrutura de diretório irá abrigar a aplicação de enquete.
Escreva sua primeira view¶
Hora de criar a primeira view. Abra o arquivo polls/views.py e ponha o seguinte código em Python dentro dele:
polls/views.py¶from django.http import HttpResponse
def index(request):
return HttpResponse("Hello, world. You're at the polls index.")
This is the most basic view possible in Django. To access it in a browser, we
need to map it to a URL - and for this we need to define a URL configuration,
or “URLconf” for short. These URL configurations are defined inside each
Django app, and they are Python files named urls.py.
To define a URLconf for the polls app, create a file polls/urls.py
with the following content:
polls/urls.py¶from django.urls import path
from . import views
urlpatterns = [
path("", views.index, name="index"),
]
Your app directory should now look like:
polls/
__init__.py
admin.py
apps.py
migrations/
__init__.py
models.py
tests.py
urls.py
views.py
The next step is to configure the global URLconf in the mysite project to
include the URLconf defined in polls.urls. To do this, add an import for
django.urls.include in mysite/urls.py and insert an
include() in the urlpatterns list, so you have:
mysite/urls.py¶from django.contrib import admin
from django.urls import include, path
urlpatterns = [
path("polls/", include("polls.urls")),
path("admin/", admin.site.urls),
]
The path() function expects at least two arguments:
route and view.
The include() function allows referencing other URLconfs.
Whenever Django encounters include(), it chops off whatever
part of the URL matched up to that point and sends the remaining string to the
included URLconf for further processing.
A idéia por trás do include() é facilitar plugar URLs. Uma vez que polls está em sua própria URLconf (polls/urls.py), ele pode ser colocado depois de “/polls/”, ou depois de “/fun_polls/”, u depois de “/content/polls/”, ou qualquer outro início de caminho, e a aplicação ainda irá funcionar
Quando usar include()
You should always use include() when you include other URL patterns.
The only exception is admin.site.urls, which is a pre-built URLconf
provided by Django for the default admin site.
Agora você amarrou uma view index no seu URLconf. Verique se funciona com o seguinte comando:
$ python manage.py runserver
...\> py manage.py runserver
Acesse http://localhost:8000/polls/ no seu navegador, e deverá ver o texto “Hello, world. You’re at the polls index.”, o qual foi definido na view “index”.
Página não encontrada?
Se retornar uma página de erro, verifique se está acessando http://localhost:8000/polls/ e não http://localhost:8000/.
Quando estiver confortável com o básico da sequência de requisição e resposta, leia a parte 2 desse tutorial para começar a trabalhar com banco de dados.
