Filipe Ximenes

Boas práticas de Django

Filipe Ximenes

•Fundador da Vinta;

•Desenvolvedor Web;

•Apaixonado por aprender;

•Fã de comunidades de Sofware Livre;

•Curioso de empreendedorismo.

Boas práticasde Django

Boas práticasBoas práticas de programação são um

conjunto de regras informais que a comunidade de desenvolvimento de

software tem aprendido ao longo do tempo para melhorar a qualidade das aplicações e

simplificar sua manutenção.

Boas práticas

deDjango

Django

Django é o framework web para perfeccionistas com prazos.

• Não é mágica;

• Não é difícil;

• Não requer mais do que conhecer Django.

• Requer vontade;

• Requer prática;

• Os resultados são sensíveis.

1. Mantenha seu ambiente de trabalho limpo e isolado de outros projetos

Virtualenv

pip install virtualenvvirtualenv .venvsource .venv/bin/activate

http://www.virtualenv.org/

Virtualenvwrapperpip install virtualenvwrapperexport WORKON_HOME=~/.virtualenvsmkdir -p $WORKON_HOMEecho "source /usr/local/bin/virtualenvwrapper.sh" \ >> ~/.bash_profilemkvirtualenv my_project

workon my_project deactivate

http://virtualenvwrapper.readthedocs.org/

2. Deixe claro o que é configuração de desenvolvimento e o que é configuração de produção

Settings

my_project/ setting.py local_settings.py.example

Como a muitos fazem:

Assim fica mais claro:

my_project/ settings/ base.py local.py production.py

settings/local.py & settings/production.py

from .base import *

Guardar settings em variável de ambiente?

• Não deixa explicito as configurações que estão sendo usadas;

• Só o criador do projeto vai saber configurar os ambientes de desenvolvimento e produção;

• Novos desenvolvedores devem ser capazes de rodar o projeto pela primeira vez sem dificuldades.

3. Facilite a sua vida e a de quem está iniciando no projeto

manage.py & wsgi.py

os.environ.setdefault( "DJANGO_SETTINGS_MODULE", "my_project.settings.local")

Em produção

export \ DJANGO_SETTINGS_MODULE= \ “my_project.settings.production”

Nem sempre tudo pode ficar explicito, pelo menos grite quando houver algo

errado

def get_env_variable(var_name): try: return os.environ.get(var_name) except: error_msg = "Defina a variável de ambiente %s" \ % var_name raise ImproperlyConfigured(error_msg)

VARIAVEL = get_env_variable('VARIAVEL')

settings/production.py

Makefileclean: find . -name "*.pyc" -delete

deps: pip install -r requirements/local.txt

setup: clean deps rm -rf my_db_name.db python manage.py syncdb --noinput python manage.py migrate python manage.py createsuperuser \ --email "test@myproject.com"

run: python manage.py runserver

README.md

#Meu ProjetoEste é um projeto exemplo para falar sobreboas práticas de Django

##InstalaçãoPara rodar o projeto localmente vocêprecisa apenas executar o comando:```make setup```

4. Sempre que puder, crie novos apps

Apps

• Não é fácil separar de separar depois que estão em produção juntos;

• Quando grandes são complicados de manter;

• Tente isolar o máximo possível, e reduzir dependências.

Onde colocar código que não pertence a nenhum app

específico?

• Crie um app 'core' na sua aplicação para comportar esta situação.

Correto

Errado

5. Não ignore o User do Django

User do Django

• Facilidade;

• Compatibilidade:

• Com o Django;

• Com apps de terceiros.

AbstractUser

AbstractBaseUser

•Adicione novos campos:

•Adicione e remova campos:

https://docs.djangoproject.com/en/dev/topics/auth/customizing/#extending-django-s-default-user

http://catherinetenajeros.blogspot.com.br/2013/03/django-15-subclass-abstractbaseuser.html

6. Use signals [com cautela]

models.py

class MyUser(...): ...

from .signals import *

signals.pyfrom django.db.models.signals import \pre_savefrom django.dispatch import receiverfrom django.core.mail import send_mail

from .models import MyUser

@receiver(pre_save, sender=MyUser)def send_email(sender, instance, **kwargs): if not instance.pk: send_mail(...)

Todo superuser é staff

class MyUser(...): ... is_staff = models.BooleanField(…) is_supperuser = models.BooleanField(…) ...

def save(self, *args, **kwargs): if self.is_supperuser: self.is_staff = True super(MyUser, self).save(*args,\ **kwargs)

Quando usar?

• Enviar email é uma ação secundária, não impacta no comportamento do model;

• Exigir que todo superuser seja staff impacta no comportamento do model.

7. Sobrescreva o ModelManager

É onde devem ficar as suas queries

from django.db import models

class ManagerUtil(models.Manager):

def get_or_none(self, **kwargs): try: return self.get(**kwargs) except ObjectDoesNotExist: return None

managers.py

8. Não repita-se (don't repeat yourself)

Templates

<htlm> <head> <title>Home</title> ... <head> <header> ... </header> <div> ... </div> <footer> ... </footer></html>

home.html

Templates

<htlm> <head> <title>Contato</title> ... <head> <header> ... </header> <div> ... </div> <footer> ... </footer></html>

contato.html

Templates Blocks

<htlm> <head> <title> {% block title %}My Project{% endblock %} </title> ... <head> <header> ... </header> <div> {% block content %} {% endblock %} </div> <footer> ... </footer></html>

base.html

Templates Blocks

{% extends 'base.html' %}

{% block title %}Home{% endblock %}

{% block content %} ...{% endblock %}

home.html

{% extends 'base.html' %}

{% block title %}Contato{% endblock %}

{% block content %} ...{% endblock %}

contato.html

Mixinsclass MeuUser(...): ... is_deleted = models.BooleanField(default=False) ...

def delete(self): self.is_deleted = True self.save()

class OutroModel(...): ... is_deleted = models.BooleanField(default=False) ...

def delete(self): self.is_deleted = True self.save()

Mixins

class SoftDeleteMixin(models.Model): class Meta: abstract = True

is_deleted = models.BooleanField( \ default=False)

def delete(self): self.is_deleted = True self.save()

Mixins

class MeuUser(SoftDeleteMixin): ...

class OutroModel(SoftDeleteMixin): ...

9. Teste TUDO

Um arquivo de teste para cada arquivo do app

app/ tests/ test_models.py test_managers.py test_views.py

https://github.com/jezdez/django-discover-runner

Model Mommy

# para instalarpip install model_mommy

# No seu arquivo de testeskid = mommy.make('family.Kid')

https://github.com/vandersonmota/model_mommy

1. Mantenha seu ambiente de trabalho limpo e isolado de outros projetos;

2. Deixe claro o que é configuração de desenvolvimento e o que é configuração de produção;

3. Facilite a sua vida e a de quem está iniciando no projeto;

4. Sempre que puder, crie novos apps;

5. Não ignore o User do Django.

6. Use signals [com cautela];

7. Sobrescreva o ModelManager;

8. Não repita-se (don't repeat yourself);

9. Teste TUDO.

?github.com/filipeximenes

bitbucket.org/filipeximenesfilipeximenes@gmail.com

twitter.com/xima