Source

django avancé présentation du 5 Novembre / presentation.org

Full commit
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
#+STARTUP: beamer
#+LaTeX_CLASS: beamercustom
#+MACRO: BEAMERTHEME custom
#+LaTeX_CLASS_OPTIONS: [presentation]
#+BEAMER_FRAME_LEVEL: 2
#+OPTIONS:   H:3 num:t toc:nil \n:nil @:t ::t |:t ^:t -:t f:t *:t <:t
#+OPTIONS:   TeX:t LaTeX:t skip:nil d:nil todo:t pri:nil tags:not-in-toc
#+LaTeX_HEADER: \titlegraphic{\includegraphics[height=3cm]{presentation_img/livre.jpg}}
#+DATE:
#+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
#+LANG:fr
#+TITLE: Django Avancé
#+AUTHOR: Yohann Gabory
* Présentation de l'auteur
** Yohann Gabory
- Webdevelopper Outscale
#+LaTeX:\centering\includegraphics[height= 10mm]{presentation_img/outscale.jpg}

- Auteur chez Eyrolles
#+LaTeX:\includegraphics[height= 10mm]{presentation_img/eyrolles.jpg}

- Djangonaute depuis la version 0.95
#+LaTeX:\begin{center}\includegraphics[height= 30mm]{presentation_img/django.jpg}\end{center}
** Collaboration
- Préface de Nicolas Ferrari, co-fondateur d'alwaysdata (https://www.alwaysdata.com/)
- Relecture de Thomas Petillon, consultant senior IT et expert
  python/django
- Éditions Eyrolles
* Pourquoi un livre en français ?
** Aider les nouveaux arrivants
*** Le _premier contact_ est plus facile en français
*** Le succès d'un outil tient à sa _documentation_
*** La documentation française n'est plus à jour depuis _looooongtemps_
** Proposer de nouvelles choses
*** Le framework a _beaucoup évolué_ depuis les parutions anglophones
*** C'est un framework de plus en plus _largement utilisé_
*** Il est temps d'aller plus loin
- Les CBV
- Les "Reusable Apps"
- Les besoins ont changé API, Oauth etc...

** "Apprendre la programmation web avec Python et Django"
*** Un livre didactique pour les débutants
*** Les base de la programmation web
*** Les notions essentielles
*** Mise en application avec Django
* Un avant-goût du contenu du livre
** Des tutoriels
*** Un Bug Tracker
**** Parce que les bonnes pratiques se prennent dès le départ
*** Un Agenda Partagé
**** Tremble Google Agenda, les poneys arrivent!
*** Des exemples de "la vraie vie"
**** Parce c'est au pied du mur...
*** Une volonté d'aller au fond des choses
** Des bonnes pratiques
*** Comment structurer ses modèles
- quels type d'héritage utiliser
- où mettre la logique de votre application
*** Le principe du DRY : partout
- Dans les urls, les modèles, les vues, les templates.
- Un seul endroit oui mais clairement identifiable: surtout!
*** Découplez!
- Identifiez les usages
- Une application == une fonctionalité
- Écrivez "plug'n play"
*** Les bonnes façons de résoudre les problèmes
** Des exemples avancés
*** une API Oauth2 avec Tastypie et Slumber
- un serveur d'API
- un client.
- une revue des verbes HTTP:
GET, POST, PUT, DELETE, HEAD, PATCH...
*** une application de prototypage sans modèle
- un bon exemple d'application réutilisable (sans modèle)
- utilisant les capacités d'héritage des modèles Django.
*** Des hacks!
* Les bonnes pratiques dans un projet pro
** La documentation d'un projet python/django
*** reStructuredText par l'exemple
- les bonnes pratiques de la documentation
- documentation des modules, des classes, des méthodes et fonctions
- les principaux mots clés de reStructuredText
*** Sphinx
- présentation de l'outil
- comment ça marche
- comment l'utiliser dans un projet django
*** Le module "admindoc"
- Principe de fonctionnement
- cas d'utilisation
** Comment hériter correctement les templates
*** Par application
**** un dossier template
**** un fichier base.html
**** un dossier template/includes
*** Par Projet
**** Un dossier template
**** des dossiers par application sur-classées
**** penser "réutilisable"
* Les patterns utiles
** L'héritage dans les modèles
*** Abstract
**** Des applications facilement surclassables
*** Multi-table
**** Moins de code/Plus de clarté
*** Proxy
**** Le plus oublié des héritages... Et pourtant!
*** Profitez de la souplesse de Python
**** Héritage de classes
**** Création de classes ou d'objet à la volée
**** Monkey patching: quand le besoin est impérieux
* Exemple: Un blog ultra rapide.
** Un blog très rapidement : L'idée
*** Revoir en quelques lignes les grands concepts
*** Profiter de ce qu'une installation de base peut offrir
*** Le concept "Livré avec des piles" par l'exemple
*** un tour rapide sur les "contrib" que l'on oublie bien souvent
** Initialisation
#+BEGIN_LaTeX
\begin{lstlisting}

$ django-admin.py startproject blogging
$ cd blogging
$ python manage.py startapp blog

\end{lstlisting}
#+END_LaTeX
** Configuration: base de données
#+BEGIN_LaTeX
\begin{lstlisting}

#blogging/blogging/settings.py (django >= 1.4)
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': 'devel.db',
    }
}

\end{lstlisting}
#+END_LaTeX
** Configuration: applications

#+BEGIN_LaTeX
\begin{lstlisting}
#blogging/blogging/settings.py (django >= 1.4)
INSTALLED_APPS = (
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.sites',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'django.contrib.admin',
    'django.contrib.admindocs',
    'django.contrib.comments',
    'django.contrib.sitemaps',
    'django.contrib.syndication',
    'blog'
)
\end{lstlisting}
#+END_LaTeX

** Configuration: urls
*** pattern de base
#+BEGIN_LaTeX
\begin{lstlisting}
from django.conf.urls import patterns, include, url
from django.contrib import admin
admin.autodiscover()
urlpatterns = patterns('',<ici, les urls>)
\end{lstlisting}
#+END_LaTeX
*** L'application principale
#+BEGIN_LaTeX
\begin{lstlisting}
    url(r'^blog/', include('blog.urls')),
\end{lstlisting}
#+END_LaTeX
*** La documentation Django
#+BEGIN_LaTeX
\begin{lstlisting}
    url(r'^admin/doc/',
        include('django.contrib.admindocs.urls')),
\end{lstlisting}
#+END_LaTeX
*** L'admin
#+BEGIN_LaTeX
\begin{lstlisting}
    url(r'^admin/', include(admin.site.urls)),
\end{lstlisting}
#+END_LaTeX
*** Les commentaires
#+BEGIN_LaTeX
\begin{lstlisting}
url(r'^comments/',
    include('django.contrib.comments.urls')),
\end{lstlisting}
#+END_LaTeX
** Les modèles : Catégorie
#+BEGIN_LaTeX
\begin{lstlisting}
#blogging/blog/models.py

from django.db import models
from django.contrib.auth.models import User


class Categorie(models.Model):
    name = models.CharField(max_length=250)
    slug = models.SlugField(max_length=250)

    def __unicode__(self):
        return self.name

\end{lstlisting}
#+END_LaTeX
** Les models : les articles
#+BEGIN_LaTeX
\begin{lstlisting}
#blogging/blog/models.py

class Article(models.Model):
    title = models.CharField(max_length=250)
    slug = models.SlugField(max_length=500)
    author = models.ForeignKey(User)
    categorie = models.ForeignKey(Categorie)
    published_date = models.DateField(auto_now_add=True)
    content = models.TextField()

    def __unicode__(self):
        return self.title

    def get_absolute_url(self):
        return "/blog/article/%s" % self.slug

\end{lstlisting}
#+END_LaTeX

** Les urls: liste des derniers articles
*** Répondre à un besoin courant: lister les derniers objets
- un model
- un champ date.
#+BEGIN_LaTeX
\begin{lstlisting}
#blogging/blog/urls.py
urlpatterns = patterns('',
    url(r'^$', ArchiveIndexView.as_view(
                 model=Article,
                 date_field="published_date"),
        name='home'),
)
\end{lstlisting}
#+END_LaTeX
- et comme toujours on nomme les urls pour les utiliser dans les templates
** Les urls: Vue en liste
*** Les Articles
- un seul argument: le modèle. Dans la "vraie vie", on pagine.
#+BEGIN_LaTeX
\begin{lstlisting}
    url(r'^articles/$',
           ListView.as_view(model=Article),
        name='articles'),
\end{lstlisting}
#+END_LaTeX
*** Les Catégories
#+BEGIN_LaTeX
\begin{lstlisting}
    url(r'^categories/$',
           ListView.as_view(model=Categorie),
        name='categories'),
\end{lstlisting}
#+END_LaTeX
** Les urls: détails des objets
*** Les Articles
- on utilise le slug pour construire les urls parce que les "pk"
  c'est pas beau.
#+BEGIN_LaTeX
\begin{lstlisting}
    url(r'article/(?P<slug>[\w-]+)/$',
          DetailView.as_view(model=Article),
        name='article'),
\end{lstlisting}
#+END_LaTeX
*** Les Catégories
#+BEGIN_LaTeX
\begin{lstlisting}
    url(r'categorie/(?P<slug>[\w-]+)/$',
          DetailView.as_view(model=Categorie),
        name='categorie'),
\end{lstlisting}
#+END_LaTeX
** L'admin
*** Une configuration très simple.
- prepopulated\_fields permet d'autogénérer le "slug" à partir du titre.
#+BEGIN_LaTeX
\begin{lstlisting}
from django.contrib import admin
from blog.models import Categorie, Article


class ArticleAdmin(admin.ModelAdmin):
    prepopulated_fields = {"slug": ("title",)}


class CategorieAdmin(admin.ModelAdmin):
    prepopulated_fields = {"slug": ("name",)}


admin.site.register(Categorie, CategorieAdmin)
admin.site.register(Article, ArticleAdmin)

\end{lstlisting}
#+END_LaTeX
** Les templates : un menu
- En utilisant "include", le menu sera sur toutes les pages
- Le menu est à un seul endroit clairement identifiable : DRY
- les urls nommées sont utiles.
#+BEGIN_LaTeX
\begin{lstlisting}[language=html]
#blog/templates/includes/menu.html
<ul>
  <li><a href="{%url home %}">Accueil</a></li>
  <li><a href="{%url categories %}">Catégories</a></li>
  <li><a href="{%url articles %}">Tous les articles</a></li>  
</ul>
\end{lstlisting}
#+END_LaTeX
** Les templates : un article
- la présentation d'un article se fait à un seul endroit.
- les urls nommées acceptent des arguments
#+BEGIN_LaTeX
\begin{lstlisting}
#blog/templates/includes/prototype.html
par <i>{{elem.author}}</i> dans la catégorie
<a href="{% url categorie elem.categorie.slug %}">
  {{elem.categorie}}
</a>
<p>{{elem.content}}</p>
\end{lstlisting}
#+END_LaTeX
** Les templates : un fichier "base.html" minimal
- tout ce qui doit être présenté sur toute les pages
#+BEGIN_LaTeX
\begin{lstlisting}
#blog/templates/base.html
{% include "includes/menu.html" %}
{% block content %}
{% endblock content %}
\end{lstlisting}
#+END_LaTeX
- on peut créer autant de "placeholder" que l'on veut pour structurer
  la page.
  - headers custom
  - footer
  - etc...
** Les templates: vue "archive"
1) convention over configuration
2) nom du template : <nom du modèle>\_archive.html
#+BEGIN_LaTeX
\begin{lstlisting}
{% extends "base.html" %}
{% block content %}
  {% for elem in latest %}
    <h2>
      <a href='{% url article elem.slug %}'>
        {{elem.title}}
      </a>
    </h2>
    {% include "includes/prototype.html" %}
  {% endfor %}
{% endblock content %}
\end{lstlisting}
#+END_LaTeX
** Les templates: vue ArticleS
*** Une itération simple
#+BEGIN_LaTeX
\begin{lstlisting}
{% extends "base.html" %}
{% block content %}
  {% for elem in object_list %}
    <h2>
      <a href='{% url article elem.slug %}'>
        {{elem.title}}
      </a>
    </h2>
    {% include "includes/prototype.html" %}
  {% endfor %}
{% endblock content %}
\end{lstlisting}
#+END_LaTeX
** Les templates: CatégorieS
*** Itérations imbriquées.
#+BEGIN_LaTeX
\begin{lstlisting}

{% extends "base.html" %}
{% block content %}

{% for elem in object_list %}
  <h2>{{elem.name}}({{elem.article_set.count}})</h2>
  {% for article in elem.article_set.all %}
    <h3>
      <a href='{% url article article.slug %}'>
        {{article.title}}
      </a>
    </h3>
  {% endfor %}
{% endfor %}

{% endblock content %}


\end{lstlisting}
#+END_LaTeX

** Les templates: Article
*** load\_comment charge les templatetags des commentaires
*** render\_comment\_list = liste des commentaires.
*** render\_comment\_form = formulaire de commentaire
**** CSRF\_TOKEN, honeypot etc...
#+BEGIN_LaTeX
\begin{lstlisting}[language=html]
{% extends "base.html" %}
{% load comments %}
{% block content %}
{% with object as elem %}
{% include "includes/prototype.html" %}
{% endwith %}
<h3>Commentaires</h3>
{% render_comment_list for object %}
<h3>Laisser un commentaire</h3>
{% render_comment_form for object %}
<a href = "{% url articles %}">
  Retour à la liste des articles
</a>
{% endblock content %}

\end{lstlisting}
#+END_LaTeX

** Les templates: Catégorie
#+BEGIN_LaTeX
\begin{lstlisting}[language=html]

{% extends "base.html" %}
{% block content %}
<h2>{{object.name}}({{object.article_set.count}})</h2>
  {% for article in object.article_set.all %}
    <h3>
      <a href='{% url article article.slug %}'>
        {{article.title}}
      </a>
    </h3>
  {% endfor %}
<a href="{% url categories %}">
  Retour à la liste des catégories
</a>
{% endblock content %}

\end{lstlisting}
#+END_LaTeX

** Le Sitemap
#+BEGIN_LaTeX
\begin{lstlisting}

from django.contrib.sitemaps import GenericSitemap

info_dict = {
    'queryset': Article.objects.all(),
    'date_field': 'published_date',
}

sitemaps = {
    'blog': GenericSitemap(info_dict, priority=0.6),
}


url(r'^sitemap\.xml$', 'django.contrib.sitemaps.views.sitemap',
    {'sitemaps': sitemaps}),

\end{lstlisting}
#+END_LaTeX

** Les flux rss
#+BEGIN_LaTeX
\begin{lstlisting}[language=html]
from django.contrib.syndication.views import Feed
class LatestBlogArticle(Feed):
    title = "Un super Blog"
    link = "/blog/"

    def items(self):
        return Article.objects.order_by(
                      '-published_date')[:5]

    def item_title(self, item):
        return item.title

    def item_description(self, item):
        return item.content

\end{lstlisting}
#+END_LaTeX

* Conclusion
** Questions
   Des questions ?
** Contacts
yohann@gabory.fr
//
http://www.gabory.fr
//
@boblefrag

** Licence
*** Présentation réalisée sous org-mode
*** Theme Beamer sous licence GPLV3
*** Présentation disponible sous Creative Commons Attribution - Partage dans les Mêmes Conditions 3.0 non transposé
https://bitbucket.org/boblefrag/django-avanc-pr-sentation-du-5-novembre/