Primeiros passos
Instalação e criação do projeto
Instale o Django via pip. Um projeto guarda settings e URLs; um app é um módulo reutilizável com models e views.
pip install django
django-admin startproject myproject
cd myproject
python manage.py startapp myappRodando o servidor de desenvolvimento
Inicia o servidor de desenvolvimento embutido com auto-reload. Nunca use em produção.
python manage.py runserver
# Default: http://127.0.0.1:8000
python manage.py runserver 8080
python manage.py runserver 0.0.0.0:8000Migrações e superusuário
makemigrations gera arquivos de migração a partir de mudanças nos models. migrate aplica-os no DB. createsuperuser cria uma conta de administrador.
python manage.py makemigrations
python manage.py migrate
python manage.py createsuperuserEstrutura do projeto
manage.py é a ferramenta de CLI. O pacote interno guarda a configuração do projeto; o diretório do app guarda o código do app.
myproject/
manage.py # CLI utility
myproject/
settings.py # Configuration
urls.py # Root URL dispatcher
wsgi.py # WSGI entry point
asgi.py # ASGI entry point
myapp/
models.py # Database models
views.py # View functions
admin.py # Admin registrationBásico de settings
INSTALLED_APPS lista os apps ativos. Defina DEBUG=False e configure ALLOWED_HOSTS em produção.
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'myapp',
]
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': BASE_DIR / 'db.sqlite3',
}
}
DEBUG = True
ALLOWED_HOSTS = []Campos de model
Definindo um Model
Cada classe de model mapeia para uma tabela do DB. Cada campo mapeia para uma coluna. __str__ define o nome de exibição.
from django.db import models
class Article(models.Model):
title = models.CharField(max_length=200)
body = models.TextField()
published = models.DateTimeField(auto_now_add=True)
def __str__(self):
return self.titleTipos de campo comuns
CharField exige max_length. auto_now_add define na criação; auto_now atualiza a cada save. EmailField/URLField adicionam validação.
name = models.CharField(max_length=100)
description = models.TextField(blank=True)
price = models.DecimalField(max_digits=10, decimal_places=2)
quantity = models.IntegerField(default=0)
is_active = models.BooleanField(default=True)
created_at = models.DateTimeField(auto_now_add=True)
updated_at = models.DateTimeField(auto_now=True)
email = models.EmailField(unique=True)
url = models.URLField(blank=True)Opções de campo
null é no nível do DB; blank é no nível da validação. choices cria um dropdown em formulários e no admin.
title = models.CharField(
max_length=200,
null=True, # DB allows NULL
blank=True, # Form allows empty
default='',
choices=[('draft', 'Draft'), ('pub', 'Published')],
help_text='Article title',
verbose_name='Article Title',
)Opções de Meta
ordering define a ordem de classificação padrão. db_table sobrescreve o nome de tabela gerado automaticamente. constraints impõem regras no nível do DB.
class Meta:
ordering = ['-created_at']
db_table = 'articles'
verbose_name_plural = 'Articles'
constraints = [
models.UniqueConstraint(
fields=['title', 'author'],
name='unique_title_per_author',
)
]Funções e propriedades de model
Sobrescreva save() para lógica pré-salvamento. @property adiciona atributos computados. Sempre chame super().save().
class Article(models.Model):
title = models.CharField(max_length=200)
views = models.IntegerField(default=0)
def __str__(self):
return self.title
def save(self, *args, **kwargs):
self.title = self.title.strip()
super().save(*args, **kwargs)
@property
def is_popular(self):
return self.views > 1000Relacionamentos de model
ForeignKey (muitos-para-um)
ForeignKey cria um relacionamento muitos-para-um. related_name habilita consultas reversas: author.books.all().
class Author(models.Model):
name = models.CharField(max_length=100)
class Book(models.Model):
author = models.ForeignKey(
Author,
on_delete=models.CASCADE,
related_name='books',
)
title = models.CharField(max_length=200)OneToOneField
OneToOneField cria um vínculo um-para-um. Acesse via user.profile ou profile.user.
class Profile(models.Model):
user = models.OneToOneField(
User,
on_delete=models.CASCADE,
)
bio = models.TextField()ManyToManyField
ManyToManyField cria uma tabela de junção automaticamente. Para adicionar/remover: course.students.add(student).
class Student(models.Model):
name = models.CharField(max_length=100)
class Course(models.Model):
students = models.ManyToManyField(Student, blank=True)
title = models.CharField(max_length=200)Opções de on_delete
CASCADE exclui os filhos quando o pai é excluído. SET_NULL exige null=True. PROTECT lança ProtectedError.
# CASCADE - delete related objects
author = models.ForeignKey(Author, on_delete=models.CASCADE)
# SET_NULL - set to NULL (field must be nullable)
author = models.ForeignKey(Author, on_delete=models.SET_NULL, null=True)
# PROTECT - prevent deletion
author = models.ForeignKey(Author, on_delete=models.PROTECT)
# SET_DEFAULT - set to default value
author = models.ForeignKey(Author, on_delete=models.SET_DEFAULT, default=1)Consulta de objetos relacionados
O acesso direto usa o nome do campo. O acesso reverso usa related_name (ou modelname_set por padrão).
# Forward query
book.author.name
# Reverse query (uses related_name)
author.books.all()
author.books.filter(title__contains='Django')
# Add/remove in M2M
course.students.add(student1, student2)
course.students.remove(student1)
course.students.clear()
# Check membership
student in course.students.all()QuerySet do ORM
Criando e salvando objetos
create() salva imediatamente. get_or_create retorna (objeto, bool_created) — obtém ou cria atomicamente.
# Method 1: Create and save separately
article = Article(title='Hello', body='World')
article.save()
# Method 2: Create in one step
article = Article.objects.create(title='Hello', body='World')
# Method 3: get_or_create
obj, created = Article.objects.get_or_create(
title='Hello', defaults={'body': 'World'}
)Buscando um único objeto
get() lança DoesNotExist se não encontrar e MultipleObjectsReturned se encontrar vários. Use first() para obter um com segurança.
# Get by primary key
article = Article.objects.get(pk=1)
# Get by field
article = Article.objects.get(title='Hello')
# First/last (returns None if empty)
first = Article.objects.first()
last = Article.objects.last()
# Latest/earliest by field
latest = Article.objects.latest('created_at')Filter e exclude
filter() retorna um QuerySet (lazy). O encadeamento aplica lógica AND. QuerySets só são avaliados quando iterados.
# Filter
Article.objects.filter(title__contains='Django')
Article.objects.filter(published=True)
# Exclude
Article.objects.exclude(views__lt=100)
# Chain filters (AND)
Article.objects.filter(author=1).exclude(draft=True)Field lookups
Lookups usam a sintaxe de sublinhado duplo. Comuns: exact, contains, icontains, gt, gte, lt, lte, in, startswith, range.
Article.objects.filter(title__icontains='django') # case-insensitive
Article.objects.filter(views__gte=100) # >=
Article.objects.filter(views__in=[100, 200, 300]) # IN
Article.objects.filter(created_at__year=2024) # date lookup
Article.objects.filter(title__startswith='Hello') # LIKE 'Hello%'
Article.objects.filter(title__isnull=True) # IS NULLOrdenação e fatiamento
O fatiamento aplica LIMIT no nível do DB. Indexação negativa não é suportada em QuerySets.
# Order by
Article.objects.order_by('-created_at') # descending
Article.objects.order_by('author', '-views')
# Slice (LIMIT/OFFSET)
Article.objects.all()[:5] # first 5
Article.objects.all()[5:10] # offset 5, limit 5
Article.objects.order_by('-views')[:3] # top 3
# Distinct
Article.objects.values('author').distinct()Update e delete
update() é eficiente para mudanças em lote. save(update_fields=[...]) evita condições de corrida. delete() faz cascata por padrão.
# Bulk update
Article.objects.filter(draft=True).update(draft=False)
# Single update (only save this field)
article.title = 'New Title'
article.save(update_fields=['title'])
# Delete
article.delete() # returns (count, {model: count})
Article.objects.filter(views=0).delete() # bulk deleteORM avançado
Expressões F
F() referencia o valor de uma coluna do DB, habilitando atualizações atômicas sem carregar o objeto para o Python.
from django.db.models import F
# Atomic increment (no race condition)
Article.objects.filter(pk=1).update(views=F('views') + 1)
# Compare two fields
Article.objects.filter(views__gt=F('min_views'))
# Arithmetic on fields
Article.objects.annotate(ratio=F('views') / F('likes'))Objetos Q para consultas complexas
Objetos Q habilitam lógica OR (|), AND (&) e NOT (~). Sem Q, múltiplas chamadas filter() aplicam apenas AND.
from django.db.models import Q
# OR
Article.objects.filter(Q(title__contains='Django') | Q(title__contains='Flask'))
# AND with NOT
Article.objects.filter(Q(published=True) & ~Q(views=0))
# OR + AND
Article.objects.filter(
(Q(author=1) | Q(author=2)) & Q(published=True)
)Agregação
aggregate() retorna um dict de totais. annotate() adiciona valores computados por objeto.
from django.db.models import Count, Sum, Avg, Max, Min
# Single aggregate
total = Article.objects.aggregate(total=Count('id'))
avg_views = Article.objects.aggregate(Avg('views'))
# Per-group aggregate
Author.objects.annotate(
article_count=Count('article'),
total_views=Sum('article__views'),
)Annotate
annotate() adiciona campos computados por objeto. Você pode usar filter() e order_by() em campos anotados.
from django.db.models import Count, Avg
# Add computed field to each object
authors = Author.objects.annotate(article_count=Count('book'))
# Filter on annotated field
Author.objects.annotate(
avg_rating=Avg('book__rating')
).filter(avg_rating__gte=4.0)select_related e prefetch_related
select_related usa SQL JOIN (FK direta). prefetch_related usa uma segunda consulta (reversa/M2M). Ambos evitam consultas N+1.
# select_related (FK/OneToOne - single query with JOIN)
books = Book.objects.select_related('author').all()
# book.author.name -> no extra query
# prefetch_related (M2M/reverse - second query)
authors = Author.objects.prefetch_related('books').all()
# author.books.all() -> no extra query
# Deep prefetch
Author.objects.prefetch_related('books', 'books__reviews').all()Views baseadas em função
View de função básica
Uma view recebe um HttpRequest e retorna um HttpResponse. render() carrega um template e o preenche com o contexto.
from django.shortcuts import render
from django.http import HttpResponse
def hello(request):
return HttpResponse("Hello, World!")
def home(request):
context = {'title': 'Home', 'items': [1, 2, 3]}
return render(request, 'home.html', context)Objeto HttpRequest
request.GET/POST são QueryDict (use .get() por segurança). request.user é o usuário autenticado ou AnonymousUser.
def my_view(request):
method = request.method # 'GET' or 'POST'
get_data = request.GET.get('q') # query param
post_data = request.POST.get('name')
path = request.path # '/articles/1/'
user = request.user # current user
files = request.FILES # uploaded files
meta = request.META.get('HTTP_HOST')Tipos de HttpResponse
JsonResponse serializa para JSON. redirect() aceita um caminho de URL ou uma URL nomeada com argumentos.
from django.http import HttpResponse, JsonResponse
from django.shortcuts import redirect
def json_view(request):
return JsonResponse({'status': 'ok', 'count': 42})
def redirect_view(request):
return redirect('/home/')
return redirect('article_detail', pk=1)
def csv_view(request):
response = HttpResponse(content_type='text/csv')
response['Content-Disposition'] = 'attachment; filename="data.csv"'
return responseDecorators de view
login_required redireciona usuários não autenticados para LOGIN_URL. require_POST/GET restringem verbos HTTP.
from django.contrib.auth.decorators import login_required
from django.views.decorators.http import require_POST, require_GET
@login_required
def dashboard(request):
return render(request, 'dashboard.html')
@require_POST
def submit(request):
pass # Only accepts POST
@require_GET
def search(request):
pass # Only accepts GETView de upload de arquivo
request.FILES contém os arquivos enviados. Use .chunks() para arquivos grandes, para evitar carregar o arquivo inteiro na memória.
def upload_file(request):
if request.method == 'POST':
uploaded = request.FILES['file']
Document.objects.create(file=uploaded)
# Or save manually
with open(f'media/{uploaded.name}', 'wb') as f:
for chunk in uploaded.chunks():
f.write(chunk)
return redirect('success')
return render(request, 'upload.html')Views baseadas em classe
TemplateView
TemplateView renderiza um template estático. Sobrescreva get_context_data() para adicionar contexto extra.
from django.views.generic import TemplateView
class AboutView(TemplateView):
template_name = 'about.html'
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context['title'] = 'About Us'
return contextListView
ListView faz paginação automática e fornece object_list e page_obj no contexto. Sobrescreva get_queryset() para filtrar.
from django.views.generic import ListView
class ArticleListView(ListView):
model = Article
template_name = 'article_list.html'
context_object_name = 'articles'
paginate_by = 10
def get_queryset(self):
return Article.objects.filter(published=True)DetailView
DetailView busca um único objeto por pk ou slug da URL. Sobrescreva get_object() para busca personalizada.
from django.views.generic import DetailView
class ArticleDetailView(DetailView):
model = Article
template_name = 'article_detail.html'
context_object_name = 'article'
def get_object(self):
return Article.objects.get(
slug=self.kwargs['slug'], published=True
)CreateView e UpdateView
CreateView/UpdateView tratam exibição do formulário, validação e salvamento. Sobrescreva form_valid() para adicionar lógica antes de salvar.
from django.views.generic.edit import CreateView, UpdateView
class ArticleCreateView(CreateView):
model = Article
fields = ['title', 'body', 'author']
template_name = 'article_form.html'
success_url = '/articles/'
class ArticleUpdateView(UpdateView):
model = Article
fields = ['title', 'body']
template_name = 'article_form.html'Mixins
Mixins adicionam comportamento reutilizável às views baseadas em classe. O Django fornece LoginRequiredMixin, PermissionRequiredMixin.
from django.contrib.auth.mixins import LoginRequiredMixin
class OwnerRequiredMixin:
def get_queryset(self):
return super().get_queryset().filter(owner=self.request.user)
class ArticleListView(LoginRequiredMixin, OwnerRequiredMixin, ListView):
model = Article
paginate_by = 10Roteamento de URLs
Configuração de URL básica
path() mapeia um padrão de URL a uma view. name= habilita a busca reversa de URL. <int:pk> captura um inteiro.
from django.urls import path
from myapp import views
urlpatterns = [
path('', views.home, name='home'),
path('about/', views.about, name='about'),
path('article/<int:pk>/', views.article_detail, name='article_detail'),
]Incluindo URLs de apps
include() delega o casamento de URLs ao urls.py de um app. app_name cria um namespace para reversão de URLs.
# myproject/urls.py
from django.urls import path, include
urlpatterns = [
path('admin/', admin.site.urls),
path('blog/', include('blog.urls')),
path('api/', include('api.urls')),
]
# blog/urls.py
app_name = 'blog'
urlpatterns = [
path('', views.list, name='list'),
path('<int:pk>/', views.detail, name='detail'),
]Conversores de path
Conversores de path fazem cast automático de tipos nos segmentos da URL. Use re_path para padrões regex complexos.
path('article/<int:pk>/') # integer
path('article/<slug:slug>/') # slug string
path('article/<str:title>/') # non-slash string
path('user/<uuid:user_id>/') # UUID
path('file/<path:filepath>/') # any string including /
# Regex path (re_path)
from django.urls import re_path
re_path(r'^article/(?P<year>[0-9]{4})/$', views.year_archive)URLs nomeadas e reverse()
URLs nomeadas permitem referenciar rotas pelo nome em vez de fixar caminhos no código. reverse() gera URLs em Python.
# urls.py
path('article/<int:pk>/', views.detail, name='article_detail')
# In views.py
from django.urls import reverse
url = reverse('article_detail', kwargs={'pk': 42})
# Returns '/article/42/'
# In templates
<a href="{% url 'article_detail' pk=article.pk %}">Read</a>Namespaces de URL
Namespaces evitam colisões de nomes entre apps. O namespace deve corresponder ao app_name do app.
# myproject/urls.py
path('blog/', include(('blog.urls', 'blog'), namespace='blog'))
# blog/urls.py
app_name = 'blog'
urlpatterns = [
path('<int:pk>/', views.detail, name='detail'),
]
# Usage
reverse('blog:detail', kwargs={'pk': 1})
# Template: {% url 'blog:detail' pk=1 %}Templates (DTL)
Herança de template
extends herda de um template base. Blocos definem regiões sobrescritáveis. Um template pode estender apenas um pai.
{# base.html #}
<html>
<body>
{% block content %}{% endblock %}
{% block sidebar %}{% endblock %}
</body>
</html>
{# article.html #}
{% extends 'base.html' %}
{% block content %}
<h1>{{ article.title }}</h1>
{% endblock %}Variáveis e tags
{{ }} exibe variáveis. {% %} executa tags. forloop.counter começa em 1; forloop.counter0 em 0.
{# Variables #}
{{ article.title }}
{{ user.get_full_name }}
{{ article.tags.0 }}
{# Tags #}
{% if article.published %}
Published
{% elif article.draft %}
Draft
{% else %}
Archived
{% endif %}
{% for item in items %}
{{ forloop.counter }}: {{ item }}
{% empty %}
No items
{% endfor %}Filtros de template
Filtros modificam a saída de variáveis usando a sintaxe de pipe |. Alguns recebem argumentos após dois-pontos. Filtros podem ser encadeados.
{{ name|lower }}
{{ text|truncatewords:30 }}
{{ date|date:"Y-m-d" }}
{{ value|default:"N/A" }}
{{ list|length }}
{{ text|striptags }}
{{ price|floatformat:2 }}
{{ value|add:5 }}Tags de template embutidas
csrf_token é obrigatório nos formulários POST. include renderiza um sub-template. load importa bibliotecas de tags personalizadas.
{% url 'article_detail' pk=1 %}
{% csrf_token %}
{% load static %}
{% include 'header.html' %}
{% with total=items|length %}
{{ total }}
{% endwith %}
{% now "Y-m-d" %}
{% blocktrans %}Hello{% endblocktrans %}Tags de template personalizadas
Tags ficam no diretório app/templatetags/. @register.simple_tag para funções; @register.filter para modificadores de valor.
# templatetags/my_tags.py
from django import template
register = template.Library()
@register.simple_tag
def multiply(a, b):
return a * b
@register.filter
def cut(value, arg):
return value.replace(arg, '')
# In template:
{% load my_tags %}
{% multiply 3 4 %}
{{ "hello world"|cut:" " }}Formulários
Definindo um Form
forms.Form cria um formulário autônomo. Cada campo gera widgets HTML automaticamente. Tipos de campo fornecem validação.
from django import forms
class ContactForm(forms.Form):
name = forms.CharField(max_length=100)
email = forms.EmailField()
message = forms.CharField(widget=forms.Textarea)
subject = forms.ChoiceField(
choices=[('general', 'General'), ('bug', 'Bug Report')],
)ModelForm
ModelForm monta um formulário a partir de um model automaticamente. fields/exclude controlam quais campos aparecem. widgets personalizam o HTML.
class ArticleForm(forms.ModelForm):
class Meta:
model = Article
fields = ['title', 'body', 'author']
# Or: fields = '__all__'
# Or: exclude = ['created_at']
widgets = {
'body': forms.Textarea(attrs={'rows': 10}),
}
labels = {'title': 'Article Title'}Validação de formulário
clean_<campo>() valida um único campo. clean() valida o formulário inteiro. Lance ValidationError em caso de falha.
class SignupForm(forms.Form):
username = forms.CharField(max_length=50)
password = forms.CharField(widget=forms.PasswordInput)
def clean_username(self):
username = self.cleaned_data['username']
if User.objects.filter(username=username).exists():
raise forms.ValidationError("Username taken.")
return username
def clean(self):
cleaned = super().clean()
# Cross-field validation
return cleanedRenderizando o form no template
as_p/as_table/as_ul renderizam os campos automaticamente. Para layout personalizado, renderize os campos individualmente. csrf_token é obrigatório para POST.
<form method="post">
{% csrf_token %}
{{ form.as_p }}
{{ form.as_table }}
{{ form.as_ul }}
{# Manual rendering #}
{{ form.title.label_tag }}
{{ form.title }}
{{ form.title.errors }}
<button type="submit">Submit</button>
</form>Processando o form na view
Passe request.POST para vincular o formulário. is_valid() roda a validação. save(commit=False) retorna um objeto não salvo.
def article_create(request):
if request.method == 'POST':
form = ArticleForm(request.POST)
if form.is_valid():
article = form.save(commit=False)
article.author = request.user
article.save()
form.save_m2m()
return redirect('article_detail', pk=article.pk)
else:
form = ArticleForm()
return render(request, 'form.html', {'form': form})Widgets de formulário
Widgets controlam a renderização HTML. Passe um dict attrs para classes CSS, placeholders ou tipos de input HTML5.
class UploadForm(forms.Form):
title = forms.CharField(
widget=forms.TextInput(attrs={'class': 'form-control'})
)
file = forms.FileField(widget=forms.ClearableFileInput)
date = forms.DateField(widget=forms.DateInput(attrs={'type': 'date'}))
tags = forms.MultipleChoiceField(
choices=TAG_CHOICES,
widget=forms.CheckboxSelectMultiple,
)Admin site
Registrando model no admin
@admin.register é preferível a admin.site.register. Models precisam ser registrados para aparecer na interface de admin.
from django.contrib import admin
from .models import Article
# Simple registration
admin.site.register(Article)
# With custom ModelAdmin
@admin.register(Article)
class ArticleAdmin(admin.ModelAdmin):
list_display = ('title', 'author', 'published')Personalização de ModelAdmin
list_display mostra colunas na view de lista. list_filter adiciona filtros na barra lateral. search_fields habilita uma caixa de busca.
@admin.register(Article)
class ArticleAdmin(admin.ModelAdmin):
list_display = ('title', 'author', 'status')
list_filter = ('status', 'author', 'created_at')
search_fields = ('title', 'body')
ordering = ('-created_at',)
list_editable = ('status',)
list_per_page = 25
date_hierarchy = 'created_at'
readonly_fields = ('views', 'created_at')Admin com inlines
Inlines editam models relacionados na mesma página do pai. extra=1 mostra uma linha vazia por padrão.
class ReviewInline(admin.TabularInline):
model = Review
extra = 1
@admin.register(Article)
class ArticleAdmin(admin.ModelAdmin):
inlines = [ReviewInline]
# TabularInline: compact table format
# StackedInline: full form fields stackedAções de admin personalizadas
Ações aparecem no dropdown da página de lista. Recebem request e queryset. message_user exibe uma mensagem flash.
@admin.register(Article)
class ArticleAdmin(admin.ModelAdmin):
actions = ['publish_selected']
@admin.action(description='Publish selected')
def publish_selected(self, request, queryset):
updated = queryset.update(published=True)
self.message_user(request, f'{updated} articles published.')Configuração do admin site
Sobrescreva site_header/site_title para branding. Para múltiplos admin sites, crie instâncias personalizadas de AdminSite.
admin.site.site_header = 'My Site Admin'
admin.site.site_title = 'Admin Portal'
admin.site.index_title = 'Dashboard'
# Custom admin site
from django.contrib.admin import AdminSite
my_site = AdminSite(name='myadmin')
my_site.register(Article, ArticleAdmin)
# urls.py
path('myadmin/', my_site.urls)Autenticação
Model User embutido
O model User do Django tem username, password (com hash), email, first_name, last_name e flags de permissão.
from django.contrib.auth.models import User
user = User.objects.get(username='admin')
user.is_staff # can access admin
user.is_superuser # has all permissions
user.is_active # account enabled
user.set_password('newpass') # hash password
user.save()
user.check_password('secret') # returns True/FalseLogin e logout
authenticate() verifica credenciais (retorna User ou None). login() cria a sessão. logout() a limpa.
from django.contrib.auth import authenticate, login, logout
def login_view(request):
user = authenticate(request, username='admin', password='pass')
if user is not None:
login(request, user)
return redirect('dashboard')
return render(request, 'login.html')
def logout_view(request):
logout(request)
return redirect('home')Registro de usuário
UserCreationForm trata username, senha e confirmação de senha com validação embutida.
from django.contrib.auth.forms import UserCreationForm
def register(request):
if request.method == 'POST':
form = UserCreationForm(request.POST)
if form.is_valid():
user = form.save()
login(request, user) # auto-login after register
return redirect('home')
else:
form = UserCreationForm()
return render(request, 'register.html', {'form': form})Decorator login_required
login_required redireciona para LOGIN_URL (padrão /accounts/login/). Para CBVs, use LoginRequiredMixin.
from django.contrib.auth.decorators import login_required
@login_required
def profile(request):
return render(request, 'profile.html')
@login_required(login_url='/custom-login/')
def settings(request):
return render(request, 'settings.html')
# Class-based view mixin
from django.contrib.auth.mixins import LoginRequiredMixin
class DashboardView(LoginRequiredMixin, ListView):
login_url = '/login/'
model = ArticleGerenciamento de senhas
update_session_auth_hash evita logout após mudança de senha. Validadores de senha impõem regras no site inteiro.
from django.contrib.auth import update_session_auth_hash
# Change password
user.set_password('newpass123')
user.save()
update_session_auth_hash(request, user) # keep user logged in
# Using form
from django.contrib.auth.forms import PasswordChangeForm
form = PasswordChangeForm(user, request.POST)
if form.is_valid():
form.save()Model User personalizado
Herde de AbstractUser para adicionar campos. Defina AUTH_USER_MODEL cedo — mudar depois é difícil.
from django.contrib.auth.models import AbstractUser
class CustomUser(AbstractUser):
bio = models.TextField(blank=True)
avatar = models.ImageField(upload_to='avatars/', blank=True)
phone = models.CharField(max_length=20, blank=True)
# settings.py
AUTH_USER_MODEL = 'myapp.CustomUser'
# Admin
from django.contrib.auth.admin import UserAdmin
@admin.register(CustomUser)
class CustomUserAdmin(UserAdmin):
passMiddleware
Middleware embutido
A ordem importa! SecurityMiddleware primeiro, depois sessions, depois auth. Checagens CSRF rodam antes do processamento da view.
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]Middleware de função personalizado
Middleware de função usa o padrão factory de estilo novo. get_response chama o próximo middleware ou a view.
def simple_middleware(get_response):
def middleware(request):
# Code before view (request phase)
response = get_response(request)
# Code after view (response phase)
return response
return middleware
# Example: timing middleware
import time
def timing_middleware(get_response):
def middleware(request):
start = time.time()
response = get_response(request)
response['X-Duration'] = str(time.time() - start)
return response
return middlewareMiddleware baseado em classe
__init__ roda uma vez no startup. __call__ roda por requisição. process_view pode retornar uma resposta para burlar a view.
class MyMiddleware:
def __init__(self, get_response):
self.get_response = get_response
def __call__(self, request):
# Request phase (before view)
response = self.get_response(request)
# Response phase (after view)
return response
def process_view(self, request, view_func, args, kwargs):
return None # or HttpResponse to short-circuitOrdem e fluxo do middleware
Requisições atravessam o middleware de cima para baixo; respostas sobem de baixo para cima. Coloque o middleware de segurança primeiro.
# Request phase: top to bottom
# Response phase: bottom to top
MIDDLEWARE = [
'A', # req: 1st -> resp: last
'B', # req: 2nd -> resp: 2nd
'C', # req: 3rd -> resp: 1st
]
# Request flows: A -> B -> C -> view
# Response flows: view -> C -> B -> ACasos de uso de middleware
Middleware pode interromper o fluxo (retornar HttpResponse cedo) ou anexar dados ao request para uso nas views.
# IP restriction
class IPBlockMiddleware:
BLOCKED_IPS = ['192.168.1.100']
def __call__(self, request):
if request.META['REMOTE_ADDR'] in self.BLOCKED_IPS:
return HttpResponseForbidden('Blocked')
return self.get_response(request)
# Add context to request
class UserPrefMiddleware:
def __call__(self, request):
request.is_mobile = 'Mobile' in request.META.get('HTTP_USER_AGENT', '')
return self.get_response(request)Arquivos estáticos e de mídia
Configuração de arquivos estáticos
STATIC_URL é o prefixo de URL. STATICFILES_DIRS são as localizações de origem (dev). STATIC_ROOT é o destino da coleta em produção.
# settings.py
STATIC_URL = '/static/'
STATICFILES_DIRS = [BASE_DIR / 'static'] # dev location
STATIC_ROOT = BASE_DIR / 'staticfiles' # collectstatic output
# Project structure:
# static/
# css/style.css
# js/app.js
# img/logo.pngServindo estáticos no desenvolvimento
O Django só serve arquivos estáticos automaticamente quando DEBUG=True. Em produção, use um servidor web (nginx) ou WhiteNoise.
# urls.py (dev only)
from django.conf import settings
from django.conf.urls.static import static
urlpatterns = [
path('admin/', admin.site.urls),
] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)
# Only active when DEBUG=TrueUsando estáticos em templates
{% load static %} é obrigatório. {% static %} resolve para o nome de arquivo com hash em produção com ManifestStaticFilesStorage.
{% load static %}
<link rel="stylesheet" href="{% static 'css/style.css' %}">
<img src="{% static 'img/logo.png' %}" alt="Logo">
<script src="{% static 'js/app.js' %}"></script>
{# Dynamic static path #}
{% get_static_prefix as STATIC_URL %}
<img src="{{ STATIC_URL }}img/{{ theme }}.png">Configuração de arquivos de mídia
MEDIA_ROOT é o caminho no sistema de arquivos; MEDIA_URL é o prefixo de URL. upload_to pode ser uma string de caminho ou um callable.
# settings.py
MEDIA_URL = '/media/'
MEDIA_ROOT = BASE_DIR / 'media'
# urls.py (dev)
urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
# Model with file upload
class Document(models.Model):
file = models.FileField(upload_to='documents/')
image = models.ImageField(upload_to='images/')
# Access
doc.file.url # '/media/documents/file.pdf'
doc.file.path # '/full/path/to/file.pdf'Comando collectstatic
Rode collectstatic antes do deploy. WhiteNoise permite que o Django sirva arquivos estáticos em produção sem nginx.
# Collect all static files into STATIC_ROOT
python manage.py collectstatic
# With clearing
python manage.py collectstatic --clear
# Production with WhiteNoise
# pip install whitenoise
MIDDLEWARE = [..., 'whitenoise.middleware.WhiteNoiseMiddleware', ...]
STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'Signals
Signals embutidos
Signals permitem que apps desacoplados reajam a ações. post_save dispara após save() completar; pre_save dispara antes.
from django.db.models.signals import (
post_save, pre_save, post_delete, pre_delete,
m2m_changed,
)
from django.contrib.auth.signals import (
user_logged_in, user_logged_out,
)
# Common signals:
# pre_save / post_save - before/after model save
# pre_delete / post_delete - before/after model delete
# m2m_changed - M2M relationship changes
# user_logged_in / user_logged_outConectando receivers de signal
@receiver conecta a função ao signal. sender limita a um model específico. created é True apenas em objetos novos.
from django.db.models.signals import post_save
from django.dispatch import receiver
@receiver(post_save, sender=User)
def create_profile(sender, instance, created, **kwargs):
if created:
Profile.objects.create(user=instance)
@receiver(post_save, sender=User)
def save_profile(sender, instance, **kwargs):
instance.profile.save()Desconectando signals
disconnect() é útil em testes ou quando você precisa impedir ações em cascata. Sempre forneça tanto receiver quanto sender.
from django.db.models.signals import post_save
# Disconnect
post_save.disconnect(
receiver=create_profile,
sender=User,
)
# Temporarily disconnect in tests
post_save.disconnect(handler, sender=Article)
# ... do stuff without signal ...
post_save.connect(handler, sender=Article)Signals personalizados
Defina signals no nível do módulo. send() notifica os receivers. kwargs são passados aos receivers conectados.
from django.dispatch import Signal, receiver
# Define a custom signal
order_created = Signal()
# Send the signal
order_created.send(
sender=Order,
order=order_instance,
user=request.user,
)
# Receive
@receiver(order_created, sender=Order)
def send_notification(sender, order, user, **kwargs):
pass # Send email notificationCasos de uso e pegadinhas de signals
Importe os handlers de signal em AppConfig.ready() para garantir que se conectem no startup. Evite operações lentas — use Celery para trabalho assíncrono.
# Good: Profile auto-creation
@receiver(post_save, sender=User)
def ensure_profile(sender, instance, created, **kwargs):
if created:
Profile.objects.get_or_create(user=instance)
# Register in AppConfig.ready()
# apps.py
class MyAppConfig(AppConfig):
name = 'myapp'
def ready(self):
from . import signals # noqaCache
Configuração de cache
Redis é recomendado para produção. LocMemCache é local ao processo (sem compartilhamento entre workers).
# settings.py - Memcached
CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.memcached.PyMemcacheCache',
'LOCATION': '127.0.0.1:11211',
}
}
# Redis
CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.redis.RedisCache',
'LOCATION': 'redis://127.0.0.1:6379',
}
}
# Local memory (dev)
CACHES = {
'default': {'BACKEND': 'django.core.cache.backends.locmem.LocMemCache'}
}API de cache de baixo nível
cache.get() retorna None para chaves ausentes. Use get_or_set para atomicidade de definir-se-não-existente.
from django.core.cache import cache
# Set
cache.set('key', 'value', timeout=300) # 5 minutes
cache.set_many({'a': 1, 'b': 2}, timeout=60)
# Get
value = cache.get('key') # None if missing
value = cache.get('key', 'default') # with default
data = cache.get_many(['a', 'b']) # dict
# Delete
cache.delete('key')
cache.clear() # delete all
# get_or_set (atomic)
value = cache.get_or_set('key', 'value', 300)Cache de template
{% cache %} armazena fragmentos HTML renderizados. Adicione argumentos variáveis (ID de usuário, página) para evitar conteúdo em cache errado.
{% load cache %}
{# Cache block for 500 seconds #}
{% cache 500 sidebar %}
<div class="sidebar">
{{ expensive_data }}
</div>
{% endcache %}
{# Cache with varying key #}
{% cache 500 user_sidebar request.user.id %}
Welcome, {{ request.user.username }}
{% endcache %}Cache por view
cache_page cacheia a HttpResponse inteira. A chave de cache inclui a URL, então cada URL tem sua própria entrada de cache.
from django.views.decorators.cache import cache_page
@cache_page(60 * 15)
def article_list(request):
return render(request, 'list.html', {'articles': Article.objects.all()})
# With cache key prefix
@cache_page(60 * 15, key_prefix='articles')
def article_detail(request, pk):
...
# Class-based view
from django.utils.decorators import method_decorator
class ArticleListView(ListView):
@method_decorator(cache_page(60 * 15))
def dispatch(self, *args, **kwargs):
return super().dispatch(*args, **kwargs)Estratégias de cache
vary_on_headers cria entradas de cache separadas por valor de header. Para APIs, varie por Accept-Language ou Authorization.
# Per-view cache with Vary headers
from django.views.decorators.vary import vary_on_headers
@cache_page(60 * 15)
@vary_on_headers('User-Agent')
def api_data(request):
...
# Model-level caching
def get_articles():
articles = cache.get('all_articles')
if articles is None:
articles = list(Article.objects.all())
cache.set('all_articles', articles, 300)
return articlesTestes
Escrevendo testes
TestCase envolve os testes numa transação de DB (desfeita ao final). SimpleTestCase é para testes sem acesso ao DB (mais rápidos).
from django.test import TestCase, SimpleTestCase
from .models import Article
class ArticleModelTest(TestCase):
def setUp(self):
self.article = Article.objects.create(
title='Test', body='Content'
)
def test_str(self):
self.assertEqual(str(self.article), 'Test')
def test_field_default(self):
self.assertEqual(self.article.views, 0)
# SimpleTestCase: no DB access
class MathTest(SimpleTestCase):
def test_addition(self):
self.assertEqual(1 + 1, 2)Testando com o Test Client
self.client simula requisições HTTP sem iniciar um servidor. .login() autentica para requisições seguintes.
class ViewTest(TestCase):
def setUp(self):
self.user = User.objects.create_user('test', '[email protected]', 'pass')
def test_login(self):
response = self.client.post('/login/', {
'username': 'test', 'password': 'pass'
})
self.assertEqual(response.status_code, 302)
def test_protected_view(self):
self.client.login(username='test', password='pass')
response = self.client.get('/dashboard/')
self.assertEqual(response.status_code, 200)Testes de model e QuerySet
Os dados de teste são criados em setUp() e desfeitos após cada teste. Use .count() e indexação para verificar resultados.
class ArticleQuerySetTest(TestCase):
def setUp(self):
Article.objects.create(title='A', views=100, published=True)
Article.objects.create(title='B', views=50, published=False)
def test_published_filter(self):
published = Article.objects.filter(published=True)
self.assertEqual(published.count(), 1)
def test_ordering(self):
articles = Article.objects.order_by('-views')
self.assertEqual(articles[0].title, 'A')Testes de URL e formulário
reverse() constrói URLs a partir de nomes. resolve() verifica para qual view uma URL mapeia. Teste formulários passando um dict data=.
from django.urls import reverse, resolve
class URLTest(TestCase):
def test_article_list_url(self):
url = reverse('article_list')
response = self.client.get(url)
self.assertEqual(response.status_code, 200)
def test_resolve(self):
url = reverse('article_detail', kwargs={'pk': 1})
self.assertEqual(resolve(url).func, views.article_detail)
class FormTest(TestCase):
def test_valid_form(self):
form = ArticleForm(data={'title': 'Hi', 'body': '...'})
self.assertTrue(form.is_valid())Fixtures e comandos de teste
Fixtures carregam dados de teste de arquivos JSON. Rode testes específicos por app, classe ou caminho de função.
# Create fixture
python manage.py dumpdata myapp.Article --indent=2 > fixtures/articles.json
# Use in test
class FixtureTest(TestCase):
fixtures = ['articles.json']
def test_data_loaded(self):
self.assertEqual(Article.objects.count(), 10)
# Run tests
python manage.py test
python manage.py test myapp
python manage.py test myapp.tests.ArticleModelTestDjango REST Framework
Instalação e setup do DRF
Adicione rest_framework ao INSTALLED_APPS. Configure autenticação/permissões padrão no dict de settings REST_FRAMEWORK.
pip install djangorestframework
# settings.py
INSTALLED_APPS = [..., 'rest_framework', 'rest_framework.authtoken']
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': [
'rest_framework.authentication.TokenAuthentication',
'rest_framework.authentication.SessionAuthentication',
],
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.IsAuthenticated',
],
}Serializers
ModelSerializer gera campos a partir do model automaticamente. source= puxa de objetos relacionados. validate_<campo>() adiciona validação.
from rest_framework import serializers
class ArticleSerializer(serializers.ModelSerializer):
author_name = serializers.CharField(source='author.username', read_only=True)
class Meta:
model = Article
fields = ['id', 'title', 'body', 'author', 'author_name']
read_only_fields = ['id', 'author_name']
def validate_title(self, value):
if len(value) < 5:
raise serializers.ValidationError("Title too short.")
return valueViewSets
ModelViewSet fornece CRUD (list, create, retrieve, update, destroy). Sobrescreva get_queryset() para filtrar.
from rest_framework import viewsets, permissions
class ArticleViewSet(viewsets.ModelViewSet):
queryset = Article.objects.all()
serializer_class = ArticleSerializer
permission_classes = [permissions.IsAuthenticatedOrReadOnly]
def get_queryset(self):
qs = super().get_queryset()
author = self.request.query_params.get('author')
if author:
qs = qs.filter(author__username=author)
return qs
def perform_create(self, serializer):
serializer.save(author=self.request.user)Routers
DefaultRouter gera padrões de URL e uma view raiz de API automaticamente. basename é usado para nomear URLs se o queryset for dinâmico.
from rest_framework.routers import DefaultRouter
from .views import ArticleViewSet
router = DefaultRouter()
router.register(r'articles', ArticleViewSet, basename='article')
# router.register(r'users', UserViewSet)
# urls.py
urlpatterns = [
path('api/', include(router.urls)),
]
# Generates: /api/articles/, /api/articles/{id}/Autenticação
Token auth usa um token estático único. JWT emite tokens de acesso + refresh. SimpleJWT é a biblioteca JWT mais popular.
# Token Authentication
from rest_framework.authtoken.views import obtain_auth_token
urlpatterns = [
path('api/token/', obtain_auth_token),
]
# JWT Authentication (pip install djangorestframework-simplejwt)
from rest_framework_simplejwt.views import (
TokenObtainPairView, TokenRefreshView,
)
urlpatterns = [
path('api/token/', TokenObtainPairView.as_view()),
path('api/token/refresh/', TokenRefreshView.as_view()),
]Permissões
SAFE_METHODS são GET/HEAD/OPTIONS. has_object_permission verifica acesso por objeto. get_permissions() permite regras por ação.
from rest_framework import permissions
class IsOwnerOrReadOnly(permissions.BasePermission):
def has_object_permission(self, request, view, obj):
if request.method in permissions.SAFE_METHODS:
return True # GET, HEAD, OPTIONS
return obj.author == request.user
# Built-in: IsAuthenticated, IsAdminUser,
# IsAuthenticatedOrReadOnly, AllowAny
# Per-action
class ArticleViewSet(viewsets.ModelViewSet):
permission_classes = [IsOwnerOrReadOnly]
def get_permissions(self):
if self.action == 'create':
return [permissions.IsAuthenticated()]
return super().get_permissions()Deploy e segurança
Settings de produção
Nunca commite SECRET_KEY no controle de versão. Use variáveis de ambiente. DEBUG=False evita vazamento de informação nas páginas de erro.
# settings.py
DEBUG = False
ALLOWED_HOSTS = ['example.com', 'www.example.com']
SECRET_KEY = os.environ['SECRET_KEY']
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'NAME': 'mydb',
'USER': os.environ['DB_USER'],
'PASSWORD': os.environ['DB_PASS'],
'HOST': 'localhost',
'PORT': '5432',
}
}Arquivos estáticos em produção
collectstatic reúne os arquivos estáticos em STATIC_ROOT. WhiteNoise serve arquivos comprimidos com gzip e com hash, direto do Django.
# Collect static files
python manage.py collectstatic --noinput
# WhiteNoise for serving static
MIDDLEWARE = [..., 'whitenoise.middleware.WhiteNoiseMiddleware', ...]
STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'
# Or with nginx:
# location /static/ { alias /path/to/staticfiles/; }Settings de segurança
SSL_REDIRECT força HTTPS. HSTS diz aos navegadores para usar sempre HTTPS. X_FRAME_OPTIONS previne clickjacking.
# settings.py
SECURE_SSL_REDIRECT = True
SESSION_COOKIE_SECURE = True
CSRF_COOKIE_SECURE = True
SECURE_HSTS_SECONDS = 31536000
SECURE_HSTS_INCLUDE_SUBDOMAINS = True
SECURE_HSTS_PRELOAD = True
SECURE_CONTENT_TYPE_NOSNIFF = True
X_FRAME_OPTIONS = 'DENY'
CSRF_TRUSTED_ORIGINS = ['https://example.com']Deploy WSGI/ASGI
Gunicorn é síncrono (Django tradicional). Uvicorn suporta ASGI (views assíncronas, websockets). Use um gerenciador de processos.
# Gunicorn (WSGI)
# pip install gunicorn
gunicorn myproject.wsgi:application --bind 0.0.0.0:8000 --workers 3
# Uvicorn (ASGI, for async/websockets)
# pip install uvicorn
uvicorn myproject.asgi:application --host 0.0.0.0 --port 8000 --workers 4
# Supervisor config
[program:django]
command=gunicorn myproject.wsgi:application
directory=/app
autostart=true
autorestart=trueChecklist de produção
check --deploy roda o checklist de deploy do Django. Ele aponta settings de segurança ausentes e problemas de prontidão para produção.
# Run security check
python manage.py check --deploy
# Key items:
# - DEBUG = False
# - ALLOWED_HOSTS set
# - SECRET_KEY from env
# - HTTPS enabled (SECURE_SSL_REDIRECT)
# - HSTS configured
# - collectstatic run
# - Database (PostgreSQL/MySQL)
# - Caching (Redis/Memcached)
# - Error monitoring (Sentry)Snippets de Django relacionados
Copy-paste ready code for common tasks.
Model Definition
Define a Django model with field types and meta options.
ORM QuerySet
Filter, exclude, annotate and chain QuerySets.
Class-Based Views
Use generic class-based views for common CRUD flows.
URL Routing
Wire URLs to views with path converters and includes.
ModelForms
Build forms from models with validation and widgets.
Template Tags
Use built-in tags and filters in Django templates.
Admin Customization
Customize the Django admin with list_display and actions.
Authentication
Login, logout, and protect views with auth decorators.
Was this helpful?