Diferència entre revisions de la pàgina «Django»
Línia 137: | Línia 137: | ||
== Frontend == | == Frontend == | ||
+ | |||
+ | Pots practicar alguns [https://bytes.cat/doku.php/django_frontend elements previs al tutorial de frontend en aquest mini tutorial]. | ||
+ | |||
Tutorials: | Tutorials: | ||
* https://www.tutorialspoint.com/django/index.htm | * https://www.tutorialspoint.com/django/index.htm |
Revisió del 18:47, 11 nov 2019
Django és un framework web basat en Python molt popular. Està orientat a la rapidesa de desenvolupament.
Django or "The web framework for perfectionists with deadlines".
#FpInfor #DawMp07 #DawMp07Uf2 #DawMp07Uf02 #DawMpDual
Contingut
Introducció
Pàgina oficial:
https://www.djangoproject.com/
Articles relacionats:
Es basa en un paradigma MTV o Model-Template-View. És similar al arxiconegut MVC o Model-View-Controller, però la terminologia pot induir a confusions. En el cas de MVC, la view és la part visual o GUI, mentre que en el MTV, la view és el codi amb la lògica de negoci (equivaldria al controller del MVC).
ULL doncs amb els noms!
Model - View - Controller Model - Template - View
Django està molt implantat a tot el món web, disposa de gran prestigi i té un creixement ràpid de desenvolupadors i ofertes de feina relacionades.
Plug-ins interessants:
- django-admin-sortable2: per poder fer llistes ordenables per JS
- Oauth2
- RIchTextField
- Easy Select2 : per incrustar cercadors amb autocmpletar en els camps de FK o ManyToMany
Preparatius i instal·lació
Per desenvolupar amb Django ens serà molt útil (per no dir imprescindible) utilitzar Virtualenv.
Abans de començar, configura el teu entorn com s'explica en aquest article.
Exemple: botiga
Podeu agafar aquest projecte d'exemple per clarificar les funcions bàsiques de Django:
https://github.com/emieza/django-botiga
Backend
El backend de Django o panell d'administració.
Per treballar el backend podem fer ús del TUTORIAL oficial de Django, que està molt ben documentat:
https://www.djangoproject.com/start/
Per poder dominar mínimament les possibilitats del backend segueix al menys aquestes parts del tutorial:
- Part 1: creació de projecte i primera view
- Part 2: model, BD, admin backend
- Part 7: customize admin i inlines
- Investiga la propietat list_editable del ModelAdmin. Per a què serveix?
A partir d'aquí podrem plantejar un projecte que implementi tot el CRUD en el backend.
- Planteja el projecte al professor. Que et doni el vist-i-plau abans de començar. El projecte hauria d'incloure usuaris i permisos diversos.
- Implementa el model amb Django. Imprescindible posar adequadament les FK (Foreign Keys).
- Mira si pots incloure inlines en alguna de les entitats del model (Ref. tutorial 7)
- Planteja't si la interfície que tens ara mateix et serveix com a backend o si necessita alguna restricció.
- Per restringir i personalitzar les dades visualitzades en el backend pots personalitzar-ho a admin.py seguint la doc oficial de Django Admin Site.
- Si vols filtrar per FKs mira't aquest post o bé la doc oficial del Queryset.
- Mira si algun dels camps dels formularis de detall convé posar-los en read-only.
- Planteja la lògica de negoci.
- Implementa restriccions del backend perquè s'adapti a la lògica de negoci.
Django Auth i User model
Per utilitzar el model User de Django dins del teu projecte (per exemple, per fer una Foreign Key) només cal importar-lo i utilitzar ForeignKey.
Per Django 1.x:
from django.contrib.auth import User class MyModel(models.Model): ... usuari = models.ForeignKey(User) ...
Per referenciar el User en Django 2.x:
from django.conf import settings from django.db import models class Article(models.Model): author = models.ForeignKey( settings.AUTH_USER_MODEL, on_delete=models.CASCADE, )
Per ampliar el mòdul de Auth de Django i afegir camps al User, es pot fer de diverses maneres. Aquest article n'explica molt bé 4 d'elles:
https://simpleisbetterthancomplex.com/tutorial/2016/07/22/how-to-extend-django-user-model.html#onetoone
Bases de dades
Migracions
Hauràs vist que en el moment de fer "migration" Django crea la base de dades. Si canviem el nostre model (a models.py), per exemple afegint camps nous, està clar que el contingut de la BD hauria de canviar també. A aquest procés en diem migració, tot i que el context de migració està més associat a traslladar les dades d'un SGBD a un altre.
En versions anteriors de Django teniem el problema que si canviàvem el model havíem de refer tota la base de dades de nou. La eina "South" va permetre migrar les dades, i finalment s'ha integrat dins de Django.
Un cop fet un canvi en el model, caldrà executar:
$ python manage makemigrations <opcional:nom_app> $ python manage migrate
SQLite vs MySQL
Per defecte Django utilitza SQLite ja que és més senzilla de configurar i guarda les dades en un arxiu db.sqlite a l'arrel del projecte.
Per diversos motius ens pot interessar canviar el motor de la BD a un de més sofisticat, com pot ser MySQL. Alguns d'aquests motius son:
- Eficiència
- Multithreading
- Ús de tipus de dades més sofisticats com la Geolocalització
Per canviar a MySQL hem de fer les següents passes:
Instal·lar els següents paquets del sistema:
$ sudo apt-get install libmysqlclient-dev python-dev python-gdal python-mysql.connector python-mysqldb python-mysqldb
Instal·lar els següents paquets del Virtualenv:
- Per python 2.x:
(env) $ pip install mysql-python
- Per python 3.x:
(env) $ pip install mysql-connector-python mysqlclient
Canviar el backend de BD de settings.py:
DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', #'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), 'PASSWORD': 'lalalaxxx', 'HOST': 'localhost', 'PORT': '3306', 'NAME': 'twitter', 'USER': 'projectex', } }
Frontend
Pots practicar alguns elements previs al tutorial de frontend en aquest mini tutorial.
Tutorials:
- https://www.tutorialspoint.com/django/index.htm
- Oficials de Django:
Documentació rellevant:
- Class-based views i generic views:
Plug-ins:
- django-money
- django-richtextfield
- django-oauth-toolkit
Autenticació en el frontend
Per fer la autenticació en el front-end podriem fer-nos la nostra pròpia view seguint les indicacions de la doc oficial:
https://docs.djangoproject.com/en/1.11/topics/auth/default/
...però és més pràctic utiltizar un seguit de views predefinides que son típiques i ens serviran prou bé:
https://docs.djangoproject.com/en/1.11/topics/auth/default/#using-the-views
Un cop fet el sistema de login/logout, serà fàcil consultar en tot moment quin user tenim logat mitjançant la request:
def view_tal(request): usuari = request.user
Per augmentar les possibilitats d'autorització, és interessant tenir en compte els següents plugins i hacks:
- Canviar el username per l'email
- Gestionar accessos a les views amb Decorators:
- @permission_required
- @login_required
- LoginRequiredMixin
- ...
Ampliar el model del User
Sovint ens fa falta ampliar els atributs o comportament del User de Django. Hi ha diverses de fer-ho. Aquest article ens dona diverses opcions i ens explica quan utiltizar-les:
https://simpleisbetterthancomplex.com/tutorial/2016/07/22/how-to-extend-django-user-model.html
Resumint:
- Utilitzant un Proxy Model
- Creant un Profile relacionat amb el User amb un One-to-One relationship
- Derivant un CustomUser de AbstractBaseUser
- Derivant un CustomUser de AbstractUser
OAuth
OAuth es mereix comentaris a part, ja que és molt útil per les xarxes socials i cada dia esdevé més important:
- Primer, una mica d'explicacions sobre OAuth : imprescindible lectura!!
- Tutorial per utilitzar social-auth-app-django : el típic plugin per poder logar-nos a la nostra app via Facebook o Google.
- Si et dona algun error quan et loguis, pensa a activar Google+ a les apis de Google.
- Django-OAuth-Toolkit: per fer nosaltres de servidor OAuth (cas poc habitual)
- Un cop t'hagis familiaritzat amb aquestes llibreries, pots ampliar com treballar amb Oauth2 per accedir als recursos de Google API com contactes, calendaris, etc. És complexe, però pots començar pel Google APIs Quickstart
Projecte amb Django
Seguidament proposem una guia per realitzar un projecte amb Django, un cop hagis finalitzat els tutorials anteriorment esmentats.
Comentarem les diferents passes amb aquest projecte d'exemple, es tracta d'una llista de karaoke per demanar torn, penjar el vídeo i votar els temes:
https://github.com/emieza/karaokelist
Guia:
- Preparació:
- Clarificar la funcionalitat del projecte.
- Crear entorn Virtualenv
$ virtualenv env
- Activar entorn
$ source env/bin/activate
- Instal·lar Django
(env) $ pip3 install django
- Activar entorn
- Crear projecte Django
(env) $ django-admin startproject
- Crear app dintre del projecte
(env) $ python manage startapp
- Crear app dintre del projecte
- Crear repositori de GIT per gestionar l'equip de treball .
- Model i backend:
- Clarificar els objectes i taules de la BD, en particular les FK. Les implementarem al models.py , com podem veure a l'exemple:
- Items: temes a cantar (nom del cantant, URL del vídeo, etc.)
- Vots: (likes) vots emesos per al tema seleccionat. Es limita a un vot per IP emissora i tema (item).
- Afegir la app de Django a la variable INSTALLED_APPS de
settings.py
(si no ho fem, no s'inclouran els seus models a les migracions). - Crear migració del model:
(env) $ python manage.py makemigrations
- Crear DB:
(env) $ python manage.py migrate
- Registrar models i personalitzar interfície d'administrador a admin.py.
- Crear superuser (admin):
(env) $ python manage.py createsuperuser
- Arrencar app:
(env) $ python manage.py runserver
- Testejar el backend a través de la URL
http://localhost:8000/admin/
- Clarificar els objectes i taules de la BD, en particular les FK. Les implementarem al models.py , com podem veure a l'exemple:
- Ampliació del backend:
- Personalitzar els mètodes __str__ de cada model, per mostrar-los de forma més amigable.
- Personalitzar la visualització dels models en
admin.py
: list_display , list_editable, list_filter - Afegir models relacionats amb inlines
- Frontend:
- Clarificar les rutes necessàries.
- Implementar les rutes decidides a urls.py.
- Crea les views (controladors) pertinents a views.py.
- Crea les plantilles pertinents a la carpeta templates.
- Recorda crear una plantilla base i estendre les altres plantilles (per exemple aquesta de crear_item) utilitzant les sentències {% block %} i {% extends %}
Desplegament
Desplegament:
- En servidor web mitjançant WSGI en Apache i Nginx
- En servidor d'aplicacions: Heroku, Openshift
Podeu llegir l'article Django en producció per veure diverses opcions.
Possibles ampliacions
- Investiga com utilitzar els Users de Django i com ampliar els camps dels què disposa.
- Amplia els coneixements del backend:
- Funcionalitat dels usuaris i grups de Django, i permisos.
- Filtrar els resultats de l'admin segons l'usuari registrat. Per exemple, en una botiga, els usuaris podrien veure només les seves comandes. El superadmin podria veure-les, en canvi, totes.
- Cerca com recuperar contrasenya en el admin de Django.
- Cerca com enviar emails amb Django.
- Investiga les capacitats multillenguatge de les plantilles de Django.
- Cerca com ampliar les comandes de manage.py, per exemple per importar usuaris d'un arxiu .CSV
- Cerca com canviar les plantilles per defecte de l'admin de Django.