2687 lines
134 KiB
HTML
2687 lines
134 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="generator" content="Asciidoctor 2.0.10">
|
||
<meta name="author" content="Cédric Declerfayt, Fred Pauchet">
|
||
<title>Minor swing with Django</title>
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
|
||
<style>
|
||
/* Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
|
||
/* Uncomment @import statement to use as custom stylesheet */
|
||
/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
|
||
article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}
|
||
audio,video{display:inline-block}
|
||
audio:not([controls]){display:none;height:0}
|
||
html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
|
||
a{background:none}
|
||
a:focus{outline:thin dotted}
|
||
a:active,a:hover{outline:0}
|
||
h1{font-size:2em;margin:.67em 0}
|
||
abbr[title]{border-bottom:1px dotted}
|
||
b,strong{font-weight:bold}
|
||
dfn{font-style:italic}
|
||
hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
|
||
mark{background:#ff0;color:#000}
|
||
code,kbd,pre,samp{font-family:monospace;font-size:1em}
|
||
pre{white-space:pre-wrap}
|
||
q{quotes:"\201C" "\201D" "\2018" "\2019"}
|
||
small{font-size:80%}
|
||
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
|
||
sup{top:-.5em}
|
||
sub{bottom:-.25em}
|
||
img{border:0}
|
||
svg:not(:root){overflow:hidden}
|
||
figure{margin:0}
|
||
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
|
||
legend{border:0;padding:0}
|
||
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
|
||
button,input{line-height:normal}
|
||
button,select{text-transform:none}
|
||
button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
|
||
button[disabled],html input[disabled]{cursor:default}
|
||
input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
|
||
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
|
||
textarea{overflow:auto;vertical-align:top}
|
||
table{border-collapse:collapse;border-spacing:0}
|
||
*,*::before,*::after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
|
||
html,body{font-size:100%}
|
||
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
|
||
a:hover{cursor:pointer}
|
||
img,object,embed{max-width:100%;height:auto}
|
||
object,embed{height:100%}
|
||
img{-ms-interpolation-mode:bicubic}
|
||
.left{float:left!important}
|
||
.right{float:right!important}
|
||
.text-left{text-align:left!important}
|
||
.text-right{text-align:right!important}
|
||
.text-center{text-align:center!important}
|
||
.text-justify{text-align:justify!important}
|
||
.hide{display:none}
|
||
img,object,svg{display:inline-block;vertical-align:middle}
|
||
textarea{height:auto;min-height:50px}
|
||
select{width:100%}
|
||
.center{margin-left:auto;margin-right:auto}
|
||
.stretch{width:100%}
|
||
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
|
||
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
|
||
a{color:#2156a5;text-decoration:underline;line-height:inherit}
|
||
a:hover,a:focus{color:#1d4b8f}
|
||
a img{border:0}
|
||
p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
|
||
p aside{font-size:.875em;line-height:1.35;font-style:italic}
|
||
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
|
||
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
|
||
h1{font-size:2.125em}
|
||
h2{font-size:1.6875em}
|
||
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
|
||
h4,h5{font-size:1.125em}
|
||
h6{font-size:1em}
|
||
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
|
||
em,i{font-style:italic;line-height:inherit}
|
||
strong,b{font-weight:bold;line-height:inherit}
|
||
small{font-size:60%;line-height:inherit}
|
||
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
|
||
ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
|
||
ul,ol{margin-left:1.5em}
|
||
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
|
||
ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
|
||
ul.square{list-style-type:square}
|
||
ul.circle{list-style-type:circle}
|
||
ul.disc{list-style-type:disc}
|
||
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
|
||
dl dt{margin-bottom:.3125em;font-weight:bold}
|
||
dl dd{margin-bottom:1.25em}
|
||
abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
|
||
abbr{text-transform:none}
|
||
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
|
||
blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
|
||
blockquote cite::before{content:"\2014 \0020"}
|
||
blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
|
||
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
|
||
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
|
||
h1{font-size:2.75em}
|
||
h2{font-size:2.3125em}
|
||
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
|
||
h4{font-size:1.4375em}}
|
||
table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
|
||
table thead,table tfoot{background:#f7f8f7}
|
||
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
|
||
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
|
||
table tr.even,table tr.alt{background:#f8f8f7}
|
||
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
|
||
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
|
||
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
|
||
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
|
||
.clearfix::after,.float-group::after{clear:both}
|
||
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
|
||
:not(pre)>code.nobreak{word-wrap:normal}
|
||
:not(pre)>code.nowrap{white-space:nowrap}
|
||
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
|
||
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
|
||
pre>code{display:block}
|
||
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
|
||
em em{font-style:normal}
|
||
strong strong{font-weight:400}
|
||
.keyseq{color:rgba(51,51,51,.8)}
|
||
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
|
||
.keyseq kbd:first-child{margin-left:0}
|
||
.keyseq kbd:last-child{margin-right:0}
|
||
.menuseq,.menuref{color:#000}
|
||
.menuseq b:not(.caret),.menuref{font-weight:inherit}
|
||
.menuseq{word-spacing:-.02em}
|
||
.menuseq b.caret{font-size:1.25em;line-height:.8}
|
||
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
|
||
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
|
||
b.button::before{content:"[";padding:0 3px 0 2px}
|
||
b.button::after{content:"]";padding:0 2px 0 3px}
|
||
p a>code:hover{color:rgba(0,0,0,.9)}
|
||
#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
|
||
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
|
||
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
|
||
#content{margin-top:1.25em}
|
||
#content::before{content:none}
|
||
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
|
||
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
|
||
#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
|
||
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
|
||
#header .details span:first-child{margin-left:-.125em}
|
||
#header .details span.email a{color:rgba(0,0,0,.85)}
|
||
#header .details br{display:none}
|
||
#header .details br+span::before{content:"\00a0\2013\00a0"}
|
||
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
|
||
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
|
||
#header #revnumber{text-transform:capitalize}
|
||
#header #revnumber::after{content:"\00a0"}
|
||
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
|
||
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
|
||
#toc>ul{margin-left:.125em}
|
||
#toc ul.sectlevel0>li>a{font-style:italic}
|
||
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
|
||
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
|
||
#toc li{line-height:1.3334;margin-top:.3334em}
|
||
#toc a{text-decoration:none}
|
||
#toc a:active{text-decoration:underline}
|
||
#toctitle{color:#7a2518;font-size:1.2em}
|
||
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
|
||
body.toc2{padding-left:15em;padding-right:0}
|
||
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
|
||
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
|
||
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
|
||
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
|
||
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
|
||
body.toc2.toc-right{padding-left:0;padding-right:15em}
|
||
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
|
||
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
|
||
#toc.toc2{width:20em}
|
||
#toc.toc2 #toctitle{font-size:1.375em}
|
||
#toc.toc2>ul{font-size:.95em}
|
||
#toc.toc2 ul ul{padding-left:1.25em}
|
||
body.toc2.toc-right{padding-left:0;padding-right:20em}}
|
||
#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
|
||
#content #toc>:first-child{margin-top:0}
|
||
#content #toc>:last-child{margin-bottom:0}
|
||
#footer{max-width:100%;background:rgba(0,0,0,.8);padding:1.25em}
|
||
#footer-text{color:rgba(255,255,255,.8);line-height:1.44}
|
||
#content{margin-bottom:.625em}
|
||
.sect1{padding-bottom:.625em}
|
||
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
|
||
.sect1{padding-bottom:1.25em}}
|
||
.sect1:last-child{padding-bottom:0}
|
||
.sect1+.sect1{border-top:1px solid #e7e7e9}
|
||
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
|
||
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
|
||
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
|
||
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
|
||
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
|
||
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
|
||
details>summary:first-of-type{cursor:pointer;display:list-item;outline:none;margin-bottom:.75em}
|
||
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
|
||
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
|
||
.paragraph.lead>p,#preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
|
||
table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:inherit}
|
||
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
|
||
.admonitionblock>table td.icon{text-align:center;width:80px}
|
||
.admonitionblock>table td.icon img{max-width:none}
|
||
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
|
||
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6)}
|
||
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
|
||
.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
|
||
.exampleblock>.content>:first-child{margin-top:0}
|
||
.exampleblock>.content>:last-child{margin-bottom:0}
|
||
.sidebarblock{border-style:solid;border-width:1px;border-color:#dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;-webkit-border-radius:4px;border-radius:4px}
|
||
.sidebarblock>:first-child{margin-top:0}
|
||
.sidebarblock>:last-child{margin-bottom:0}
|
||
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
|
||
.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
|
||
.literalblock pre,.listingblock>.content>pre{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;overflow-x:auto;padding:1em;font-size:.8125em}
|
||
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
|
||
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
|
||
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class="highlight"],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
|
||
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
|
||
.listingblock>.content{position:relative}
|
||
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
|
||
.listingblock:hover code[data-lang]::before{display:block}
|
||
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
|
||
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
|
||
.listingblock pre.highlightjs{padding:0}
|
||
.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
|
||
.listingblock pre.prettyprint{border-width:0}
|
||
.prettyprint{background:#f7f7f8}
|
||
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
|
||
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
|
||
pre.prettyprint li code[data-lang]::before{opacity:1}
|
||
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
|
||
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
|
||
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
|
||
table.linenotable td.code{padding-left:.75em}
|
||
table.linenotable td.linenos{border-right:1px solid currentColor;opacity:.35;padding-right:.5em}
|
||
pre.pygments .lineno{border-right:1px solid currentColor;opacity:.35;display:inline-block;margin-right:.75em}
|
||
pre.pygments .lineno::before{content:"";margin-right:-.125em}
|
||
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
|
||
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
|
||
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
|
||
.quoteblock blockquote{margin:0;padding:0;border:0}
|
||
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
|
||
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
|
||
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
|
||
.verseblock{margin:0 1em 1.25em}
|
||
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
|
||
.verseblock pre strong{font-weight:400}
|
||
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
|
||
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
|
||
.quoteblock .attribution br,.verseblock .attribution br{display:none}
|
||
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
|
||
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
|
||
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
|
||
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
|
||
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
|
||
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
|
||
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
|
||
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
|
||
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;text-align:left;margin-right:0}
|
||
table.tableblock{max-width:100%;border-collapse:separate}
|
||
p.tableblock:last-child{margin-bottom:0}
|
||
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
|
||
td.tableblock>.content>:last-child.sidebarblock{margin-bottom:0}
|
||
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
|
||
table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0}
|
||
table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0}
|
||
table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0}
|
||
table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px}
|
||
table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0}
|
||
table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0}
|
||
table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0}
|
||
table.frame-all{border-width:1px}
|
||
table.frame-sides{border-width:0 1px}
|
||
table.frame-topbot,table.frame-ends{border-width:1px 0}
|
||
table.stripes-all tr,table.stripes-odd tr:nth-of-type(odd),table.stripes-even tr:nth-of-type(even),table.stripes-hover tr:hover{background:#f8f8f7}
|
||
th.halign-left,td.halign-left{text-align:left}
|
||
th.halign-right,td.halign-right{text-align:right}
|
||
th.halign-center,td.halign-center{text-align:center}
|
||
th.valign-top,td.valign-top{vertical-align:top}
|
||
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
|
||
th.valign-middle,td.valign-middle{vertical-align:middle}
|
||
table thead th,table tfoot th{font-weight:bold}
|
||
tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
|
||
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
|
||
p.tableblock>code:only-child{background:none;padding:0}
|
||
p.tableblock{font-size:1em}
|
||
ol{margin-left:1.75em}
|
||
ul li ol{margin-left:1.5em}
|
||
dl dd{margin-left:1.125em}
|
||
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
|
||
ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
|
||
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
|
||
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
|
||
ul.unstyled,ol.unstyled{margin-left:0}
|
||
ul.checklist{margin-left:.625em}
|
||
ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
|
||
ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
|
||
ul.inline{display:-ms-flexbox;display:-webkit-box;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
|
||
ul.inline>li{margin-left:1.25em}
|
||
.unstyled dl dt{font-weight:400;font-style:normal}
|
||
ol.arabic{list-style-type:decimal}
|
||
ol.decimal{list-style-type:decimal-leading-zero}
|
||
ol.loweralpha{list-style-type:lower-alpha}
|
||
ol.upperalpha{list-style-type:upper-alpha}
|
||
ol.lowerroman{list-style-type:lower-roman}
|
||
ol.upperroman{list-style-type:upper-roman}
|
||
ol.lowergreek{list-style-type:lower-greek}
|
||
.hdlist>table,.colist>table{border:0;background:none}
|
||
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
|
||
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
|
||
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
|
||
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
|
||
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
|
||
.colist td:not([class]):first-child img{max-width:none}
|
||
.colist td:not([class]):last-child{padding:.25em 0}
|
||
.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
|
||
.imageblock.left{margin:.25em .625em 1.25em 0}
|
||
.imageblock.right{margin:.25em 0 1.25em .625em}
|
||
.imageblock>.title{margin-bottom:0}
|
||
.imageblock.thumb,.imageblock.th{border-width:6px}
|
||
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
|
||
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
|
||
.image.left{margin-right:.625em}
|
||
.image.right{margin-left:.625em}
|
||
a.image{text-decoration:none;display:inline-block}
|
||
a.image object{pointer-events:none}
|
||
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
|
||
sup.footnote a,sup.footnoteref a{text-decoration:none}
|
||
sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
|
||
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
|
||
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
|
||
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
|
||
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
|
||
#footnotes .footnote:last-of-type{margin-bottom:0}
|
||
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
|
||
.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
|
||
.gist .file-data>table td.line-data{width:99%}
|
||
div.unbreakable{page-break-inside:avoid}
|
||
.big{font-size:larger}
|
||
.small{font-size:smaller}
|
||
.underline{text-decoration:underline}
|
||
.overline{text-decoration:overline}
|
||
.line-through{text-decoration:line-through}
|
||
.aqua{color:#00bfbf}
|
||
.aqua-background{background:#00fafa}
|
||
.black{color:#000}
|
||
.black-background{background:#000}
|
||
.blue{color:#0000bf}
|
||
.blue-background{background:#0000fa}
|
||
.fuchsia{color:#bf00bf}
|
||
.fuchsia-background{background:#fa00fa}
|
||
.gray{color:#606060}
|
||
.gray-background{background:#7d7d7d}
|
||
.green{color:#006000}
|
||
.green-background{background:#007d00}
|
||
.lime{color:#00bf00}
|
||
.lime-background{background:#00fa00}
|
||
.maroon{color:#600000}
|
||
.maroon-background{background:#7d0000}
|
||
.navy{color:#000060}
|
||
.navy-background{background:#00007d}
|
||
.olive{color:#606000}
|
||
.olive-background{background:#7d7d00}
|
||
.purple{color:#600060}
|
||
.purple-background{background:#7d007d}
|
||
.red{color:#bf0000}
|
||
.red-background{background:#fa0000}
|
||
.silver{color:#909090}
|
||
.silver-background{background:#bcbcbc}
|
||
.teal{color:#006060}
|
||
.teal-background{background:#007d7d}
|
||
.white{color:#bfbfbf}
|
||
.white-background{background:#fafafa}
|
||
.yellow{color:#bfbf00}
|
||
.yellow-background{background:#fafa00}
|
||
span.icon>.fa{cursor:default}
|
||
a span.icon>.fa{cursor:inherit}
|
||
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
|
||
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
|
||
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
|
||
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
|
||
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
|
||
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
|
||
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
|
||
.conum[data-value] *{color:#fff!important}
|
||
.conum[data-value]+b{display:none}
|
||
.conum[data-value]::after{content:attr(data-value)}
|
||
pre .conum[data-value]{position:relative;top:-.125em}
|
||
b.conum *{color:inherit!important}
|
||
.conum:not([data-value]):empty{display:none}
|
||
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
|
||
h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
|
||
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
|
||
p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
|
||
p{margin-bottom:1.25rem}
|
||
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
|
||
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
|
||
.print-only{display:none!important}
|
||
@page{margin:1.25cm .75cm}
|
||
@media print{*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
|
||
html{font-size:80%}
|
||
a{color:inherit!important;text-decoration:underline!important}
|
||
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
|
||
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
|
||
abbr[title]::after{content:" (" attr(title) ")"}
|
||
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
|
||
thead{display:table-header-group}
|
||
svg{max-width:100%}
|
||
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
|
||
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
|
||
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
|
||
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
|
||
body.book #header{text-align:center}
|
||
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
|
||
body.book #header .details{border:0!important;display:block;padding:0!important}
|
||
body.book #header .details span:first-child{margin-left:0!important}
|
||
body.book #header .details br{display:block}
|
||
body.book #header .details br+span::before{content:none!important}
|
||
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
|
||
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
|
||
.listingblock code[data-lang]::before{display:block}
|
||
#footer{padding:0 .9375em}
|
||
.hide-on-print{display:none!important}
|
||
.print-only{display:block!important}
|
||
.hide-for-print{display:none!important}
|
||
.show-for-print{display:inherit!important}}
|
||
@media print,amzn-kf8{#header>h1:first-child{margin-top:1.25rem}
|
||
.sect1{padding:0!important}
|
||
.sect1+.sect1{border:0}
|
||
#footer{background:none}
|
||
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
|
||
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
|
||
</style>
|
||
</head>
|
||
<body class="book">
|
||
<div id="header">
|
||
<h1>Minor swing with Django</h1>
|
||
<div class="details">
|
||
<span id="author" class="author">Cédric Declerfayt</span><br>
|
||
<span id="email" class="email"><a href="mailto:jaguarondi27@gmail.com">jaguarondi27@gmail.com</a></span><br>
|
||
<span id="author2" class="author">Fred Pauchet</span><br>
|
||
<span id="email2" class="email"><a href="mailto:fred@grimbox.be">fred@grimbox.be</a></span><br>
|
||
</div>
|
||
<div id="toc" class="toc">
|
||
<div id="toctitle">Table of Contents</div>
|
||
<ul class="sectlevel0">
|
||
<li><a href="#_environnement_de_travail">Environnement de travail</a>
|
||
<ul class="sectlevel1">
|
||
<li><a href="#_méthodologie_de_travail">1. Méthodologie de travail</a></li>
|
||
<li><a href="#_environnements_virtuels">2. Environnements virtuels</a>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_création_de_lenvironnement_virtuel">2.1. Création de l’environnement virtuel</a></li>
|
||
<li><a href="#_installation_de_django_et_création_du_répertoire_de_travail">2.2. Installation de Django et création du répertoire de travail</a></li>
|
||
<li><a href="#_gestion_des_dépendances">2.3. Gestion des dépendances</a></li>
|
||
<li><a href="#_structure_finale_de_lenvironnement">2.4. Structure finale de l’environnement</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#_django">3. Django</a>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_gestion">3.1. Gestion</a></li>
|
||
<li><a href="#_structure_dune_application">3.2. Structure d’une application</a></li>
|
||
<li><a href="#_tests_unitaires">3.3. Tests unitaires</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#_construire_des_applications_maintenables">4. Construire des applications maintenables</a>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_au_niveau_des_méthodes_et_fonctions">4.1. Au niveau des méthodes et fonctions</a></li>
|
||
<li><a href="#_au_niveau_des_classes">4.2. Au niveau des classes</a></li>
|
||
<li><a href="#_au_niveau_des_composants">4.3. Au niveau des composants</a></li>
|
||
<li><a href="#_de_manière_plus_générale">4.4. De manière plus générale</a></li>
|
||
<li><a href="#_en_pratique">4.5. En pratique</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#_chaîne_doutils">5. Chaîne d’outils</a>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_pep8">5.1. PEP8</a></li>
|
||
<li><a href="#_pep8_flake8_pylint">5.2. pep8, flake8, pylint</a></li>
|
||
<li><a href="#_black">5.3. Black</a></li>
|
||
<li><a href="#_pytest">5.4. pytest</a></li>
|
||
<li><a href="#_mypy">5.5. mypy</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#_git">6. Git</a></li>
|
||
<li><a href="#_graphviz">7. graphviz</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#_déploiement">Déploiement</a>
|
||
<ul class="sectlevel1">
|
||
<li><a href="#_un_peu_de_théorie_les_principales_étapes">8. Un peu de théorie…​ Les principales étapes</a>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_définition_de_linfrastructure">8.1. Définition de l’infrastructure</a></li>
|
||
<li><a href="#_configuration_et_sécurisation_de_la_machine_hôte">8.2. Configuration et sécurisation de la machine hôte</a></li>
|
||
<li><a href="#_mise_à_jour">8.3. Mise à jour</a></li>
|
||
<li><a href="#_supervision">8.4. Supervision</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#_déploiement_sur_centos">9. Déploiement sur CentOS</a>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_installation_des_dépendances_systèmes">9.1. Installation des dépendances systèmes</a></li>
|
||
<li><a href="#_préparation_de_lenvironnement_utilisateur">9.2. Préparation de l’environnement utilisateur</a></li>
|
||
<li><a href="#_configuration_de_lapplication">9.3. Configuration de l’application</a></li>
|
||
<li><a href="#_création_des_répertoires_de_logs">9.4. Création des répertoires de logs</a></li>
|
||
<li><a href="#_création_du_répertoire_pour_le_socket">9.5. Création du répertoire pour le socket</a></li>
|
||
<li><a href="#_gunicorn">9.6. Gunicorn</a></li>
|
||
<li><a href="#_supervision_2">9.7. Supervision</a></li>
|
||
<li><a href="#_ouverture_des_ports">9.8. Ouverture des ports</a></li>
|
||
<li><a href="#_installation_dnginx">9.9. Installation d’Nginx</a></li>
|
||
<li><a href="#_configuration_des_sauvegardes">9.10. Configuration des sauvegardes</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#_modélisation">Modélisation</a>
|
||
<ul class="sectlevel1">
|
||
<li><a href="#_modélisation_2">10. Modélisation</a></li>
|
||
<li><a href="#_queryset_managers">11. Queryset & managers</a></li>
|
||
<li><a href="#_forms">12. Forms</a>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_dépendance_avec_le_modèle">12.1. Dépendance avec le modèle</a></li>
|
||
<li><a href="#_rendu_et_affichage">12.2. Rendu et affichage</a></li>
|
||
<li><a href="#_squelette_par_défaut">12.3. Squelette par défaut</a></li>
|
||
<li><a href="#_crispy_forms">12.4. Crispy-forms</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#_validation_des_données">13. Validation des données</a></li>
|
||
<li><a href="#_en_conclusion">14. En conclusion</a></li>
|
||
<li><a href="#_migrations">15. Migrations</a></li>
|
||
<li><a href="#_administration">16. Administration</a>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_quelques_conseils">16.1. Quelques conseils</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#_go_live">Go Live !</a>
|
||
<ul class="sectlevel1">
|
||
<li><a href="#_supervision_des_logs">17. Supervision des logs</a></li>
|
||
<li><a href="#_feedbacks_utilisateurs">18. feedbacks utilisateurs</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#_en_bonus">En bonus</a>
|
||
<ul class="sectlevel1">
|
||
<li><a href="#_snippets_utiles_et_forcément_dispensables">19. Snippets utiles (et forcément dispensables)</a>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_récupération_du_dernier_tag_git_en_python">19.1. Récupération du dernier tag Git en Python</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div id="content">
|
||
<div id="preamble">
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>On ne va pas se mentir: il existe enormément de tutoriaux très bien réalisés sur "Comment réaliser une application Django" et autres "Déployer votre code en 2 minutes". On se disait juste que ces tutoriaux restaient relativement haut-niveau et se limitaient à un contexte donné.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>L’idée du texte ci-dessous est de jeter les bases d’un bon développement, en survolant l’ensemble des outils permettant de suivre des lignes directrices reconnues, de maintenir une bonne qualité de code au travers des différentes étapes (du développement au déploiement) et de s’assurer du maintient correct de la base de code, en permettant à n’importe qui de reprendre le développement.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Ces idées ne s’appliquent pas uniquement à Django et à son cadre de travail, ni même au langage Python. Juste que ces deux bidules sont de bons candidats et que le cadre de travail est bien défini et suffisamment flexible.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Django se présente comme un `Framework Web pour perfectionnistes ayant des deadlines <<a href="https://www.djangoproject.com/>`_" class="bare">https://www.djangoproject.com/>`_</a>.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Django suit quelques principes <<a href="https://docs.djangoproject.com/en/dev/misc/design-philosophies/>" class="bare">https://docs.djangoproject.com/en/dev/misc/design-philosophies/></a>:</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p>Faible couplage et forte cohésion, pour que chaque composant ait son indépendance.</p>
|
||
</li>
|
||
<li>
|
||
<p>Moins de code, plus de fonctionnalités.</p>
|
||
</li>
|
||
<li>
|
||
<p>`Don’t repeat yourself <<a href="https://fr.wikipedia.org/wiki/Sec>`_" class="bare">https://fr.wikipedia.org/wiki/Sec>`_</a>: ne pas se répéter!</p>
|
||
</li>
|
||
<li>
|
||
<p>Rapidité du développement (après une courbe d’apprentissage relativement ardue, malgré tout)</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Mis côté à côté, l’application de ces principes permet une meilleure stabilité du projet. Dans la suite de ce chapitre, on verra comment configurer l’environnement, comment installer Django de manière isolée et comment démarrer un nouveau projet. On verra comment gérer correctement les dépendances, les versions et comment applique un score sur note code.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Finalement, on verra aussique la configuration proposée par défaut par le framework n’est pas idéale pour la majorité des cas.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Pour cela, on présentera différents outils (mypy, flake8, black, …​), la rédaction de tests unitaires et d’intégration pour limiter les régressions, les règles de nomenclature et de contrôle du contenu, ainsi que les bonnes étapes à suivre pour arriver à un déploiement rapide et fonctionnel avec peu d’efforts.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Et tout ça à un seul et même endroit. Oui. :-)</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Bonne lecture.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="_environnement_de_travail" class="sect0">Environnement de travail</h1>
|
||
<div class="openblock partintro">
|
||
<div class="content">
|
||
<div class="paragraph">
|
||
<p>Avant de démarrer le développement, il est nécessaire de passer un peu de temps sur la configuration de l’environnement.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Les morceaux de code seront développés pour Python3.4+ et Django 1.8+. Ils nécessiteront peut-être quelques adaptations pour fonctionner sur une version antérieure.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p><strong>Remarque</strong> : les commandes qui seront exécutés dans ce livre le seront depuis un shell sous GNU/Linux. Certaines devront donc être adaptées si vous êtes dans un autre environnemnet.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_méthodologie_de_travail">1. Méthodologie de travail</h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>Pour la méthode de travail et de développement, on va se baser sur les <a href="https://12factor.net/fr/">The Twelve-factor App</a> - ou plus simplement les <strong>12 facteurs</strong>.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>L’idée derrière cette méthode consiste à pousser les concepts suivants (repris grossièrement de la <a href="https://12factor.net/fr/">page d’introduction</a> :</p>
|
||
</div>
|
||
<div class="olist arabic">
|
||
<ol class="arabic">
|
||
<li>
|
||
<p>Faciliter la mise en place de phases d’automatisation; plus simplement, faciliter les mises à jour applicatives, simplifier la gestion de l’hôte, diminuer la divergence entre les différents environnements d’exécution et offrir la possibilité d’intégrer le projet dans un processus d’<a href="https://en.wikipedia.org/wiki/Continuous_integration">intégration continue</a>/<a href="https://en.wikipedia.org/wiki/Continuous_deployment">déploiement continu</a></p>
|
||
</li>
|
||
<li>
|
||
<p>Faciliter la mise à pied de nouveaux développeurs ou de personnes souhaitant rejoindre le projet.</p>
|
||
</li>
|
||
<li>
|
||
<p>Faciliter</p>
|
||
</li>
|
||
<li>
|
||
<p>Augmenter l’agilité générale du projet, en permettant une meilleure évolutivité architecturale et une meilleure mise à l’échelle - <em>Vous avez 5000 utilisateurs en plus? Ajoutez un serveur et on n’en parle plus ;-)</em>.</p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>En pratique, les idées planquées derrière les quelques phrases ci-dessus permettront de monter facilement un nouvel environnement - qu’il soit sur la machine du petit nouveau ou sur un serveur Azure, Heroku, Digital Ocean ou votre nouveau Raspberry Pi Zéro caché à la cave.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Pour reprendre de manière très brute les différentes idées derrière cette méthode, on a:</p>
|
||
</div>
|
||
<div class="admonitionblock note">
|
||
<table>
|
||
<tr>
|
||
<td class="icon">
|
||
<div class="title">Note</div>
|
||
</td>
|
||
<td class="content">
|
||
pensez à retravailler la partie ci-dessous; la version anglophone semble plus compréhensible…​ :-/
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="olist arabic">
|
||
<ol class="arabic">
|
||
<li>
|
||
<p>Une base de code suivie avec un système de contrôle de version, plusieurs déploiements</p>
|
||
</li>
|
||
<li>
|
||
<p>Déclarez explicitement et isolez les dépendances</p>
|
||
</li>
|
||
<li>
|
||
<p>Stockez la configuration dans l’environnement</p>
|
||
</li>
|
||
<li>
|
||
<p>Traitez les services externes comme des ressources attachées</p>
|
||
</li>
|
||
<li>
|
||
<p>Séparez strictement les étapes d’assemblage et d’exécution</p>
|
||
</li>
|
||
<li>
|
||
<p>Exécutez l’application comme un ou plusieurs processus sans état</p>
|
||
</li>
|
||
<li>
|
||
<p>Exportez les services via des associations de ports</p>
|
||
</li>
|
||
<li>
|
||
<p>Grossissez à l’aide du modèle de processus</p>
|
||
</li>
|
||
<li>
|
||
<p>Maximisez la robustesse avec des démarrages rapides et des arrêts gracieux</p>
|
||
</li>
|
||
<li>
|
||
<p>Gardez le développement, la validation et la production aussi proches que possible</p>
|
||
</li>
|
||
<li>
|
||
<p>Traitez les logs comme des flux d’évènements</p>
|
||
</li>
|
||
<li>
|
||
<p>Lancez les processus d’administration et de maintenance comme des one-off-processes</p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<table class="tableblock frame-all grid-all stretch">
|
||
<caption class="title">Table 1. Concrètement</caption>
|
||
<colgroup>
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 33.3334%;">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Concept</p></td>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Outil</p></td>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Base de code suivie avec un système de contrôle de version</p></td>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Git, Mercurial, SVN, …​</p></td>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Chaque déploiement démarre à partir d’une base de code unique. Il n’y pas de dépôt "Prod", "Staging" ou "Dev". Il n’y en a qu’un et un seul.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Déclaration explicite et isolation des dépendances</p></td>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Pyenv, environnements virtuels, RVM, …​</p></td>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Afin de ne pas perturber les dépendances systèmes, chaque application doit disposer d’un environnement sain par défaut.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration dans l’environnement</p></td>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Fichiers .ENV</p></td>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Toute clé de configuration (nom du serveur de base de données, adresse d’un service Web externe, clé d’API pour l’interrogation d’une ressource, …​) sera définie directement au niveau de l’hôte - à aucun moment, on ne doit trouver un mot de passe en clair dans le dépôt source ou une valeur susceptible d’évoluer, écrite en dur dans le code.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Services externes = ressources locales</p></td>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Fichiers .ENV</p></td>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Chaque ressource doit pouvoir être interchangeable avec une autre, sans modification du code source. La solution consiste à passer toutes ces informations (nom du serveur et type de base de données, clé d’authentification, …​) directement via des variables d’environnement.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Bien séparer les étapes de construction des étapes de mise à disposition</p></td>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">Capistrano, Gitea, un serveur d’artefacts, …​</p></td>
|
||
<td class="tableblock halign-left valign-top"><p class="tableblock">L’idée est de pouvoir récupérer une version spécifique du code, sans que celle-ci ne puisse avoir été modifiée. Git permet bien de gérer des versions (au travers des tags), mais ces éléments peuvent sans doute être modifiés directement au travers de l’historique.</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_environnements_virtuels">2. Environnements virtuels</h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>On va commencer avec la partie la moins funky, mais la plus utile, dans la vie d’un développeur: la gestion et l’isolation des dépendances.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Il est tout à fait possible de s’en passer complètement dans le cadre de "petits" projets ou d’applications déployées sur des machines dédiées, et de fonctionner à grand renforts de "sudo" et d’installation globale des dépendances. Cette pratique est cependant fortement déconseillée pour plusieurs raisons:</p>
|
||
</div>
|
||
<div class="olist arabic">
|
||
<ol class="arabic">
|
||
<li>
|
||
<p>Pour la reproductibilité d’un environnement spécifique. Cela évite notamment les réponses type "Ca juste marche chez moi", puisqu’on a la possibilité de construire un environnement sain et appliquer des dépendances identiques, quelle que soit la machine hôte.</p>
|
||
</li>
|
||
<li>
|
||
<p>Il est tout à fait envisagable que deux applications soient déployées sur un même hôte, et nécessitent chacune deux versions différentes d’une même dépendance.</p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="quoteblock">
|
||
<blockquote>
|
||
<div class="paragraph">
|
||
<p>But it works on my machine! Then, we’ll ship your machine.</p>
|
||
</div>
|
||
</blockquote>
|
||
<div class="attribution">
|
||
— A famous meme<br>
|
||
<cite>And this is how Docker was born.</cite>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Nous allons utiliser le module <code>venv</code> afin de créer un `environnement virtuel <<a href="http://sametmax.com/les-environnement-virtuels-python-virtualenv-et-virtualenvwrapper/>`_" class="bare">http://sametmax.com/les-environnement-virtuels-python-virtualenv-et-virtualenvwrapper/>`_</a> pour python.</p>
|
||
</div>
|
||
<div class="admonitionblock note">
|
||
<table>
|
||
<tr>
|
||
<td class="icon">
|
||
<div class="title">Note</div>
|
||
</td>
|
||
<td class="content">
|
||
auparavant, on utilisait <code>virtualenvwrapper</code>. mais cela fait plusieurs années que je ne l’utilise plus. On l’intègre quand même ?
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_création_de_lenvironnement_virtuel">2.1. Création de l’environnement virtuel</h3>
|
||
<div class="paragraph">
|
||
<p>Commencons par créer un environnement virtuel, afin d’y stocker les dépendances. Lancez <code>python3 -m venv gwift-env</code>.</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash"><span class="nt">---</span>
|
||
Intégrer les résultats de la création de l<span class="s1">'environnement
|
||
---</span></code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Ceci créera l’arborescence de fichiers suivante, qui peut à nouveau être un peu différente en fonction du système d’exploitation:</p>
|
||
</div>
|
||
<div class="olist loweralpha">
|
||
<ol class="loweralpha" type="a">
|
||
<li>
|
||
<p>code-block:: shell</p>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>$ ls .virtualenvs/gwift-env
|
||
bin include lib</pre>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Nous pouvons ensuite l’activer grâce à la commande <code>source gwift-env</code>.</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash"><span class="nt">---</span>
|
||
Intégrer les résultats de l<span class="s1">'accès de l'</span>environnement
|
||
<span class="nt">---</span></code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Le <strong>shell</strong> signale que nous sommes bien dans l’environnement <code>gwift-env</code> en l’affichant avant le <code>$</code>. Par la suite, nous considérerons que l’environnement virtuel est toujours activé, même si <code>gwift-env</code> n’est pas présent devant chaque <code>$</code>.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>A présent, tous les binaires de cet environnement prendront le pas sur les binaires du système. De la même manière, une variable <code>PATH</code> propre est définie et utilisée, afin que les librairies Python y soient stockées. C’est donc dans cet environnement virtuel que nous retrouverons le code source de Django, ainsi que des librairies externes pour Python une fois que nous les aurons installées.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Pour désactiver l’environnement virtuel, il suffira d’utiliser la commande <code>deactivate</code></p>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_installation_de_django_et_création_du_répertoire_de_travail">2.2. Installation de Django et création du répertoire de travail</h3>
|
||
<div class="paragraph">
|
||
<p>Comme l’environnement est activé, on peut à présent y installer Django. La librairie restera indépendante du reste du système, et ne polluera pas les autres projets.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>C’est parti: <code>pip install django</code>!</p>
|
||
</div>
|
||
<div class="olist loweralpha">
|
||
<ol class="loweralpha" type="a">
|
||
<li>
|
||
<p>code-block:: shell</p>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>$ pip install django
|
||
Collecting django
|
||
Downloading Django-X.Y.Z
|
||
100% |################################|
|
||
Installing collected packages: django
|
||
Successfully installed django-X.Y.Z</pre>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Les commandes de création d’un nouveau site sont à présent disponibles, la principale étant <code>django-admin startproject</code>. Par la suite, nous utiliserons <code>manage.py</code>, qui constitue un <strong>wrapper</strong> autour de <code>django-admin</code>.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Pour démarrer notre projet, nous lançons donc <code>django-admin startproject gwift</code>.</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash"><span class="nv">$ </span>django-admin startproject gwift</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Cette action a pour effet de créer un nouveau dossier <code>gwift</code>, dans lequel on trouve la structure suivante:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash"><span class="nv">$ </span>tree gwift
|
||
gwift
|
||
├── gwift
|
||
│ ├── __init__.py
|
||
│ ├── settings.py
|
||
│ ├── urls.py
|
||
│ └── wsgi.py
|
||
└── manage.py</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>C’est sans ce répertoire que vont vivre tous les fichiers liés au projet. Le but est de faire en sorte que toutes les opérations (maintenance, déploiement, écriture, tests, …​) puissent se faire à partir d’un seul point d’entrée. Tant qu’on y est, nous pouvons rajouter les répertoires utiles à la gestion de notre projet, à savoir la documentation, les dépendances et le README:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash"><span class="nv">$ </span><span class="nb">mkdir </span>docs requirements
|
||
<span class="nv">$ </span><span class="nb">touch </span>docs/README.md</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash"><span class="nv">$ </span>tree gwift
|
||
gwift
|
||
├── gwift
|
||
│ ├── __init__.py
|
||
│ ├── settings.py
|
||
│ ├── urls.py
|
||
│ └── wsgi.py
|
||
└── manage.py
|
||
|-- docs/
|
||
|-- requirements/
|
||
|-- README</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Chacun de ces fichiers sert à:</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>settings.py</code> contient tous les paramètres globaux à notre projet.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>urls.py</code> contient les variables de routes, les adresses utilisées et les fonctions vers lesquelles elles pointent.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>manage.py</code>, pour toutes les commandes de gestion.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>wsgi.py</code> contient la définition de l’interface `WSGI <<a href="https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface>`_" class="bare">https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface>`_</a>, qui permettra à votre serveur Web (Nginx, Apache, …​) de faire un pont vers votre projet.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="admonitionblock note">
|
||
<table>
|
||
<tr>
|
||
<td class="icon">
|
||
<div class="title">Note</div>
|
||
</td>
|
||
<td class="content">
|
||
déplacer la configuration dans un répertoire <code>config</code> à part.
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_gestion_des_dépendances">2.3. Gestion des dépendances</h3>
|
||
<div class="paragraph">
|
||
<p>Comme nous venons d’ajouter une dépendance à notre projet, nous allons créer un fichier reprenant tous les dépendances de notre projet. Celles-ci sont normalement placées dans un fichier <code>requirements.txt</code>. Dans un premier temps, ce fichier peut être placé directement à la racine du projet, mais on préférera rapidement le déplacer dans un sous-répertoire spécifique (<code>requirements</code>), afin de grouper les dépendances en fonction de leur utilité:</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>base.txt</code></p>
|
||
</li>
|
||
<li>
|
||
<p><code>dev.txt</code></p>
|
||
</li>
|
||
<li>
|
||
<p><code>staging.txt</code></p>
|
||
</li>
|
||
<li>
|
||
<p><code>production.txt</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Au début de chaque fichier, il suffira d’ajouter la ligne <code>-r base.txt</code>, puis de lancer l’installation grâce à un <code>pip install -r <nom du fichier></code>. De cette manière, il est tout à fait acceptable de n’installer <code>flake8</code> et <code>django-debug-toolbar</code> qu’en développement par exemple. Dans l’immédiat, ajoutez simplement <code>django</code> dans le fichier <code>requirements/base.txt</code>.</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash"><span class="nv">$ </span><span class="nb">echo </span>django <span class="o">>></span> requirements/base.txt</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Par la suite, il vous faudra <strong>absolument</strong> spécifier les versions à utiliser: les librairies que vous utilisez comme dépendances évoluent, de la même manière que vos projets. Des fonctions sont cassées, certaines signatures sont modifiées, des comportements sont altérés, etc. Si vous voulez être sûr et certain que le code que vous avez écrit continue à fonctionner, spécifiez la version de chaque librairie de dépendances. Avec les mécanismes d’intégration continue et de tests unitaires, on verra plus loin comment se prémunir d’un changement inattendu.</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_structure_finale_de_lenvironnement">2.4. Structure finale de l’environnement</h3>
|
||
<div class="paragraph">
|
||
<p>Nous avons donc la strucutre finale pour notre environnement de travail:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash"><span class="nv">$ </span>tree ~/gwift-project
|
||
gwift
|
||
├── docs
|
||
│ └── README.md
|
||
├── gwift
|
||
│ ├── __init__.py
|
||
│ ├── settings.py
|
||
│ ├── urls.py
|
||
│ └── wsgi.py
|
||
│ manage.py
|
||
└── requirements
|
||
└── base.txt</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_django">3. Django</h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>Comme on l’a vu ci-dessus, <code>django-admin</code> permet de créer un nouveau projet. On fait ici une distinction entre un <strong>projet</strong> et une <strong>application</strong>:</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><strong>Projet</strong>: ensemble des applications, paramètres, pages HTML, middlwares, dépendances, etc., qui font que votre code fait ce qu’il est sensé faire.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Application</strong>: <strong>contexte</strong> éventuellement indépendant, permettant d’effectuer une partie isolée de ce que l’on veut faire.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Pour <code>gwift</code>, on va notamment avoir une application pour la gestion des listes de souhaits et des éléments, une deuxième application pour la gestion des utilisateurs, voire une troisième application qui gérera les partages entre utilisateurs et listes.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>On voit bien ici le principe de <strong>contexte</strong>: l’application viendra avec son modèle, ses tests, ses vues et son paramétrage. Elle pourra éventuellement être réutilisée dans un autre projet. C’est en ça que consistent les `paquets Django <<a href="https://www.djangopackages.com/>`_" class="bare">https://www.djangopackages.com/>`_</a> déjà disponibles: ce sont simplement de petites applications empaquetées pour être réutilisées (eg. `Django-Rest-Framework <<a href="https://github.com/tomchristie/django-rest-framework>`" class="bare">https://github.com/tomchristie/django-rest-framework>`</a><em>, `Django-Debug-Toolbar <<a href="https://github.com/django-debug-toolbar/django-debug-toolbar>`" class="bare">https://github.com/django-debug-toolbar/django-debug-toolbar>`</a></em>, …​).</p>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_gestion">3.1. Gestion</h3>
|
||
<div class="paragraph">
|
||
<p>Comme expliqué un peu plus haut, le fichier <code>manage.py</code> est un <strong>wrapper</strong> sur les commandes <code>django-admin</code>. A partir de maintenant, nous n’utiliserons plus que celui-là pour tout ce qui touchera à la gestion de notre projet:</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>manage.py check</code> pour vérifier (en surface…​) que votre projet ne rencontre aucune erreur</p>
|
||
</li>
|
||
<li>
|
||
<p><code>manage.py runserver</code> pour lancer un serveur de développement</p>
|
||
</li>
|
||
<li>
|
||
<p><code>manage.py test</code> pour découvrir les tests unitaires disponibles et les lancer.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>La liste complète peut être affichée avec <code>manage.py help</code>. Vous remarquerez que ces commandes sont groupées selon différentes catégories:</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><strong>auth</strong>: création d’un nouveau super-utilisateur, changer le mot de passe pour un utilisateur existant.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>django</strong>: vérifier la <strong>compliance</strong> du projet, lancer un <strong>shell</strong>, <strong>dumper</strong> les données de la base, effectuer une migration du schéma, …​</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>sessions</strong>: suppressions des sessions en cours</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>staticfiles</strong>: gestion des fichiers statiques et lancement du serveur de développement.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Nous verrons plus tard comment ajouter de nouvelles commandes.</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_structure_dune_application">3.2. Structure d’une application</h3>
|
||
<div class="paragraph">
|
||
<p>Maintenant que l’on a vu à quoi servait <code>manage.py</code>, on peut créer notre nouvelle application grâce à la commande <code>manage.py startapp <label></code>.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Cette application servira à structurer les listes de souhaits, les éléments qui les composent et les parties que chaque utilisateur pourra offrir. Essayez de trouver un nom éloquent, court et qui résume bien ce que fait l’application. Pour nous, ce sera donc <code>wish</code>. C’est parti pour <code>manage.py startapp wish</code>!</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash"><span class="nv">$ </span>python manage.py startapp wish</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Résultat? Django nous a créé un répertoire <code>wish</code>, dans lequel on trouve les fichiers suivants:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash"><span class="nv">$ </span><span class="nb">ls</span> <span class="nt">-l</span> wish
|
||
admin.py __init__.py migrations models.py tests.py views.py</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>En résumé, chaque fichier a la fonction suivante:</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>admin.py</code> servira à structurer l’administration de notre application. Chaque information peut en effet être administrée facilement au travers d’une interface générée à la volée par le framework. On y reviendra par la suite.</p>
|
||
</li>
|
||
<li>
|
||
<p><code><em>init</em>.py</code> pour que notre répertoire <code>wish</code> soit converti en package Python.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>migrations/</code>, dossier dans lequel seront stockées toutes les différentes migrations de notre application.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>models.py</code> pour représenter et structurer nos données.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>tests.py</code> pour les tests unitaires.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_tests_unitaires">3.3. Tests unitaires</h3>
|
||
<div class="paragraph">
|
||
<p>Plein de trucs à compléter ici ;-) Est-ce qu’on passe par pytest ou par le framework intégré ? Quels sont les avantages de l’un % à l’autre ?
|
||
* <code>views.py</code> pour définir ce que nous pouvons faire avec nos données.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_construire_des_applications_maintenables">4. Construire des applications maintenables</h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>Pour cette section, je me base d’un résumé de l’ebook <strong>Building Maintenable Software</strong> disponible chez `O’Reilly <<a href="http://shop.oreilly.com/product/0636920049555.do`_" class="bare">http://shop.oreilly.com/product/0636920049555.do`_</a> qui vaut clairement le détour pour poser les bases d’un projet.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Ce livre répartit un ensemble de conseils parmi quatre niveaux de composants:</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p>Les méthodes et fonctions</p>
|
||
</li>
|
||
<li>
|
||
<p>Les classes</p>
|
||
</li>
|
||
<li>
|
||
<p>Les composants</p>
|
||
</li>
|
||
<li>
|
||
<p>Et de manière plus générale.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_au_niveau_des_méthodes_et_fonctions">4.1. Au niveau des méthodes et fonctions</h3>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p>Gardez vos méthodes/fonctions courtes. Pas plus de 15 lignes, en comptant les commentaires. Des exceptions sont possibles, mais dans une certaine mesure uniquement (pas plus de 6.9% de plus de 60 lignes; pas plus de 22.3% de plus de 30 lignes, au plus 43.7% de plus de 15 lignes et au moins 56.3% en dessous de 15 lignes). Oui, c’est dur à tenir, mais faisable.</p>
|
||
</li>
|
||
<li>
|
||
<p>Conserver une complexité de McCabe en dessous de 5, c’est-à-dire avec quatre branches au maximum. A nouveau, si on a une méthode avec une complexité cyclomatique de 15, la séparer en 3 fonctions avec une complexité de 5 conservera globalement le nombre 15, mais rendra le code de chacune de ces méthodes plus lisible, plus maintenable.</p>
|
||
</li>
|
||
<li>
|
||
<p>N’écrivez votre code qu’une seule fois: évitez les duplications, copie, etc., c’est juste mal: imaginez qu’un bug soit découvert dans une fonction; il devra alors être corrigé dans toutes les fonctions qui auront été copiées/collées. C’est aussi une forme de régression.</p>
|
||
</li>
|
||
<li>
|
||
<p>Conservez de petites interfaces. Quatre paramètres, pas plus. Au besoin, refactorisez certains paramètres dans une classe, plus facile à tester.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_au_niveau_des_classes">4.2. Au niveau des classes</h3>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p>Privilégiez un couplage faible entre vos classes. Ceci n’est pas toujours possible, mais dans la mesure du possible, éclatez vos classes en fonction de leur domaine de compétences. L’implémentation du service <code>UserNotificationsService</code> ne doit pas forcément se trouver embarqué dans une classe <code>UserService</code>. De même, pensez à passer par une interface (commune à plusieurs classes), afin d’ajouter une couche d’abstraction. La classe appellante n’aura alors que les méthodes offertes par l’interface comme points d’entrée.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_au_niveau_des_composants">4.3. Au niveau des composants</h3>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p>Tout comme pour les classes, il faut conserver un couplage faible au niveau des composants également. Une manière d’arriver à ce résultat est de conserver un nombre de points d’entrée restreint, et d’éviter qu’on ne puisse contacter trop facilement des couches séparées de l’architecture. Pour une architecture n-tiers par exemple, la couche d’abstraction à la base de données ne peut être connue que des services; sans cela, au bout de quelques semaines, n’importe quelle couche de présentation risque de contacter directement la base de données, "juste parce qu’elle en a la possibilité". Vous pourrez également passer par des interfaces, afin de réduire le nombre de points d’entrée connus par un composant externe (qui ne connaîtra par exemple que <code>IFileTransfer</code> avec ses méthodes <code>put</code> et <code>get</code>, et non pas les détails d’implémentation complet d’une classe <code>FtpFileTransfer</code> ou <code>SshFileTransfer</code>).</p>
|
||
</li>
|
||
<li>
|
||
<p>Conserver un bon balancement au niveau des composants: évitez qu’un composant <strong>A</strong> ne soit un énorme mastodonte, alors que le composant juste à côté n’est capable que d’une action. De cette manière, les nouvelles fonctionnalités seront mieux réparties parmi les différents systèmes, et les responsabilités plus faciles à gérer. Un conseil est d’avoir un nombre de composants compris entre 6 et 12 (idéalement, 12), et que ces composants soit approximativement de même taille.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_de_manière_plus_générale">4.4. De manière plus générale</h3>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p>Conserver une densité de code faible: il n’est évidemment pas possible d’implémenter n’importe quelle nouvelle fonctionnalité en moins de 20 lignes de code; l’idée ici est que la réécriture du projet ne prenne pas plus de 20 hommes/mois. Pour cela, il faut (activement) passer du temps à réduire la taille du code existant: soit en faisant du refactoring (intensif?), soit en utilisant des librairies existantes, soit en explosant un système existant en plusieurs sous-systèmes communiquant entre eux. Mais surtout en évitant de copier/coller bêtement du code existant.</p>
|
||
</li>
|
||
<li>
|
||
<p>Automatiser les tests, ajouter un environnement d’intégration continue dès le début du projet et vérifier par des outils les points ci-dessus.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_en_pratique">4.5. En pratique</h3>
|
||
<div class="paragraph">
|
||
<p>Par rapport aux points repris ci-dessus, l’environnement Python et le framework Django proposent un ensemble d’outils intégrés qui permettent de répondre à chaque point. Avant d’aller plus loin, donc, un petit point sur les conventions, les tests (unitaires, orientés comportement, basés sur la documentation, …​), la gestion de version du code et sur la documentation. Plus que dans tout langage compilé, ceux-ci sont pratiquement obligatoires. Vous pourrez les voir comme une perte de temps dans un premier temps, mais nous vous promettons qu’ils vous en feront gagner par la suite.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_chaîne_doutils">5. Chaîne d’outils</h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>Le langage Python fonctionne avec un système d’améliorations basées sur des propositions: les PEP, ou “Python Enhancement Proposal”.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Celle qui va nous intéresser pour cette section est la <a href="https://www.python.org/dev/peps/pep-0008/">PEP 8 — Style Guide for Python Code</a>. Elle spécifie comment du code Python doit être organisé ou formaté, quelles sont les conventions pour l’indentation, le nommage des variables et des classes, … En bref, elle décrit comment écrire du code proprement pour que d’autres développeurs puissent le reprendre facilement, ou simplement que votre base de code ne dérive lentement vers un seuil de non-maintenabilité.</p>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_pep8">5.1. PEP8</h3>
|
||
<div class="paragraph">
|
||
<p>Le langage Python fonctionne avec un système d’améliorations basées sur des propositions: les PEP, ou "<strong>Python Enhancement Proposal</strong>". Chacune d’entre elles doit être approuvée par le `Benevolent Dictator For Life <<a href="http://fr.wikipedia.org/wiki/Benevolent_Dictator_for_Life>`_" class="bare">http://fr.wikipedia.org/wiki/Benevolent_Dictator_for_Life>`_</a>.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>La PEP qui nous intéresse plus particulièrement pour la suite est la `PEP-8 <<a href="https://www.python.org/dev/peps/pep-0008/>`_" class="bare">https://www.python.org/dev/peps/pep-0008/>`_</a>, ou "Style Guide for Python Code". Elle spécifie des conventions d’organisation et de formatage de code Python, quelles sont les conventions pour l’indentation, le nommage des variables et des classes, etc. En bref, elle décrit comment écrire du code proprement pour que d’autres développeurs puissent le reprendre facilement, ou simplement que votre base de code ne dérive lentement vers un seuil de non-maintenabilité.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Sur cette base, un outil existe et listera l’ensemble des conventions qui ne sont pas correctement suivies dans votre projet: pep8. Pour l’installer, passez par pip. Lancez ensuite la commande pep8 suivie du chemin à analyser (<code>.</code>, le nom d’un répertoire, le nom d’un fichier <code>.py</code>, …​). Si vous souhaitez uniquement avoir le nombre d’erreur de chaque type, saisissez les options <code>--statistics -qq</code>.</p>
|
||
</div>
|
||
<div class="olist loweralpha">
|
||
<ol class="loweralpha" type="a">
|
||
<li>
|
||
<p>code-block:: shell</p>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>$ pep8 . --statistics -qq</pre>
|
||
</div>
|
||
</div>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>7 E101 indentation contains mixed spaces and tabs
|
||
6 E122 continuation line missing indentation or outdented
|
||
8 E127 continuation line over-indented for visual indent
|
||
23 E128 continuation line under-indented for visual indent
|
||
3 E131 continuation line unaligned for hanging indent
|
||
12 E201 whitespace after '{'
|
||
13 E202 whitespace before '}'
|
||
86 E203 whitespace before ':'</pre>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Si vous ne voulez pas être dérangé sur votre manière de coder, et que vous voulez juste avoir un retour sur une analyse de votre code, essayez <code>pyflakes</code>: il analysera vos sources à la recherche de sources d’erreurs possibles (imports inutilisés, méthodes inconnues, etc.).</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Finalement, la solution qui couvre ces deux domaines existe et s’intitule `flake8 <<a href="https://github.com/PyCQA/flake8>`_" class="bare">https://github.com/PyCQA/flake8>`_</a>. Sur base la même interface que <code>pep8</code>, vous aurez en plus tous les avantages liés à <code>pyflakes</code> concernant votre code source.</p>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_pep257">5.1.1. PEP257</h4>
|
||
<div class="olist loweralpha">
|
||
<ol class="loweralpha" type="a">
|
||
<li>
|
||
<p>todo:: à remplir avec <code>pydocstyle</code>.</p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_tests">5.1.2. Tests</h4>
|
||
<div class="paragraph">
|
||
<p>Comme tout bon <strong>framework</strong> qui se respecte, Django embarque tout un environnement facilitant le lancement de tests; chaque application est créée par défaut avec un fichier <strong>tests.py</strong>, qui inclut la classe <code>TestCase</code> depuis le package <code>django.test</code>:</p>
|
||
</div>
|
||
<div class="olist loweralpha">
|
||
<ol class="loweralpha" type="a">
|
||
<li>
|
||
<p>code-block:: python</p>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>from django.test import TestCase</pre>
|
||
</div>
|
||
</div>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>class TestModel(TestCase):
|
||
def test_str(self):
|
||
raise NotImplementedError('Not implemented yet')</pre>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Idéalement, chaque fonction ou méthode doit être testée afin de bien en valider le fonctionnement, indépendamment du reste des composants. Cela permet d’isoler chaque bloc de manière unitaire, et permet de ne pas rencontrer de régression lors de l’ajout d’une nouvelle fonctionnalité ou de la modification d’une existante. Il existe plusieurs types de tests (intégration, comportement, …​); on ne parlera ici que des tests unitaires.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Avoir des tests, c’est bien. S’assurer que tout est testé, c’est mieux. C’est là qu’il est utile d’avoir le pourcentage de code couvert par les différents tests, pour savoir ce qui peut être amélioré.</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_couverture_de_code">5.1.3. Couverture de code</h4>
|
||
<div class="paragraph">
|
||
<p>La couverture de code est une analyse qui donne un pourcentage lié à la quantité de code couvert par les tests. Attention qu’il ne s’agit pas de vérifier que le code est <strong>bien</strong> testé, mais juste de vérifier <strong>quelle partie</strong> du code est testée. En Python, il existe le paquet `coverage <<a href="https://pypi.python.org/pypi/coverage/>`_" class="bare">https://pypi.python.org/pypi/coverage/>`_</a>, qui se charge d’évaluer le pourcentage de code couvert par les tests. Ajoutez-le dans le fichier <code>requirements/base.txt</code>, et lancez une couverture de code grâce à la commande <code>coverage</code>. La configuration peut se faire dans un fichier <code>.coveragerc</code> que vous placerez à la racine de votre projet, et qui sera lu lors de l’exécution.</p>
|
||
</div>
|
||
<div class="olist loweralpha">
|
||
<ol class="loweralpha" type="a">
|
||
<li>
|
||
<p>code-block:: shell</p>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre># requirements/base.text
|
||
[...]
|
||
coverage
|
||
django_coverage_plugin</pre>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
<li>
|
||
<p>code-block:: shell</p>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre># .coveragerc to control coverage.py
|
||
[run]
|
||
branch = True
|
||
omit = ../*migrations*
|
||
plugins =
|
||
django_coverage_plugin</pre>
|
||
</div>
|
||
</div>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>[report]
|
||
ignore_errors = True</pre>
|
||
</div>
|
||
</div>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>[html]
|
||
directory = coverage_html_report</pre>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
<li>
|
||
<p>todo:: le bloc ci-dessous est à revoir pour isoler la configuration.</p>
|
||
</li>
|
||
<li>
|
||
<p>code-block:: shell</p>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>$ coverage run --source "." manage.py test
|
||
$ coverage report</pre>
|
||
</div>
|
||
</div>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>Name Stmts Miss Cover
|
||
---------------------------------------------
|
||
gwift\gwift\__init__.py 0 0 100%
|
||
gwift\gwift\settings.py 17 0 100%
|
||
gwift\gwift\urls.py 5 5 0%
|
||
gwift\gwift\wsgi.py 4 4 0%
|
||
gwift\manage.py 6 0 100%
|
||
gwift\wish\__init__.py 0 0 100%
|
||
gwift\wish\admin.py 1 0 100%
|
||
gwift\wish\models.py 49 16 67%
|
||
gwift\wish\tests.py 1 1 0%
|
||
gwift\wish\views.py 6 6 0%
|
||
---------------------------------------------
|
||
TOTAL 89 32 64%</pre>
|
||
</div>
|
||
</div>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>$ coverage html</pre>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Ceci vous affichera non seulement la couverture de code estimée, et générera également vos fichiers sources avec les branches non couvertes. Pour gagner un peu de temps, n’hésitez pas à créer un fichier <code>Makefile</code> que vous placerez à la racine du projet. L’exemple ci-dessous permettra, grâce à la commande <code>make coverage</code>, d’arriver au même résultat que ci-dessus:</p>
|
||
</div>
|
||
<div class="olist loweralpha">
|
||
<ol class="loweralpha" type="a">
|
||
<li>
|
||
<p>code-block:: shell</p>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre># Makefile for gwift
|
||
#</pre>
|
||
</div>
|
||
</div>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre># User-friendly check for coverage
|
||
ifeq ($(shell which coverage >/dev/null 2>&1; echo $$?), 1)
|
||
$(error The 'coverage' command was not found. Make sure you have coverage installed)
|
||
endif</pre>
|
||
</div>
|
||
</div>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>.PHONY: help coverage</pre>
|
||
</div>
|
||
</div>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>help:
|
||
@echo " coverage to run coverage check of the source files."</pre>
|
||
</div>
|
||
</div>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>coverage:
|
||
coverage run --source='.' manage.py test; coverage report; coverage html;
|
||
@echo "Testing of coverage in the sources finished."</pre>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_complexité_de_mccabe">5.1.4. Complexité de McCabe</h4>
|
||
<div class="paragraph">
|
||
<p>La `complexité cyclomatique <<a href="https://fr.wikipedia.org/wiki/Nombre_cyclomatique>`_" class="bare">https://fr.wikipedia.org/wiki/Nombre_cyclomatique>`_</a> (ou complexité de McCabe) peut s’apparenter à mesure de difficulté de compréhension du code, en fonction du nombre d’embranchements trouvés dans une même section. Quand le cycle d’exécution du code rencontre une condition, il peut soit rentrer dedans, soit passer directement à la suite. Par exemple:</p>
|
||
</div>
|
||
<div class="olist loweralpha">
|
||
<ol class="loweralpha" type="a">
|
||
<li>
|
||
<p>code-block:: python</p>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>if True == True:
|
||
pass # never happens</pre>
|
||
</div>
|
||
</div>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre># continue ...</pre>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>La condition existe, mais on ne passera jamais dedans. A l’inverse, le code suivant aura une complexité pourrie à cause du nombre de conditions imbriquées:</p>
|
||
</div>
|
||
<div class="olist loweralpha">
|
||
<ol class="loweralpha" type="a">
|
||
<li>
|
||
<p>code-block:: python</p>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>def compare(a, b, c, d, e):
|
||
if a == b:
|
||
if b == c:
|
||
if c == d:
|
||
if d == e:
|
||
print('Yeah!')
|
||
return 1</pre>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Potentiellement, les tests unitaires qui seront nécessaires à couvrir tous les cas de figure seront au nombre de quatre: le cas par défaut (a est différent de b, rien ne se passe), puis les autres cas, jusqu’à arriver à l’impression à l’écran et à la valeur de retour. La complexité cyclomatique d’un bloc est évaluée sur base du nombre d’embranchements possibles; par défaut, sa valeur est de 1. Si on rencontre une condition, elle passera à 2, etc.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Pour l’exemple ci-dessous, on va en fait devoir vérifier au moins chacun des cas pour s’assurer que la couverture est complète. On devrait donc trouver:</p>
|
||
</div>
|
||
<div class="olist arabic">
|
||
<ol class="arabic">
|
||
<li>
|
||
<p>Un test pour entrer (ou non) dans la condition <code>a == b</code></p>
|
||
</li>
|
||
<li>
|
||
<p>Un test pour entrer (ou non) dans la condition <code>b == c</code></p>
|
||
</li>
|
||
<li>
|
||
<p>Un test pour entrer (ou non) dans la condition <code>c == d</code></p>
|
||
</li>
|
||
<li>
|
||
<p>Un test pour entrer (ou non) dans la condition <code>d == e</code></p>
|
||
</li>
|
||
<li>
|
||
<p>Et s’assurer que n’importe quel autre cas retournera la valeur <code>None</code>.</p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>On a donc bien besoin de minimum cinq tests pour couvrir l’entièreté des cas présentés.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Le nombre de tests unitaires nécessaires à la couverture d’un bloc est au minimum égal à la complexité cyclomatique de ce bloc. Une possibilité pour améliorer la maintenance du code est de faire baisser ce nombre, et de le conserver sous un certain seuil. Certains recommandent de le garder sous une complexité de 10; d’autres de 5.</p>
|
||
</div>
|
||
<div class="olist loweralpha">
|
||
<ol class="loweralpha" type="a">
|
||
<li>
|
||
<p>note::</p>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>Evidemment, si on refactorise un bloc pour en extraire une méthode, cela n'améliorera pas sa complexité cyclomatique globale</pre>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>A nouveau, un greffon pour <code>flake8</code> existe et donnera une estimation de la complexité de McCabe pour les fonctions trop complexes. Installez-le avec <code>pip install mccabe</code>, et activez-le avec le paramètre <code>--max-complexity</code>. Toute fonction dans la complexité est supérieure à cette valeur sera considérée comme trop complexe.</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_documentation">5.1.5. Documentation</h4>
|
||
<div class="paragraph">
|
||
<p>Il existe plusieurs manières de générer la documentation d’un projet. Les plus connues sont `Sphinx <<a href="http://sphinx-doc.org/>`_" class="bare">http://sphinx-doc.org/>`_</a> et `MkDocs <<a href="http://www.mkdocs.org/>`" class="bare">http://www.mkdocs.org/>`</a><em>. Le premier a l’avantage d’être plus reconnu dans la communauté Python que l’autre, de pouvoir <strong>parser</strong> le code pour en extraire la documentation et de pouvoir lancer des `tests orientés documentation <<a href="https://duckduckgo.com/?q=documentation+driven+development&t=ffsb>`" class="bare">https://duckduckgo.com/?q=documentation+driven+development&t=ffsb>`</a></em>. A contrario, votre syntaxe devra respecter `ReStructuredText <<a href="https://en.wikipedia.org/wiki/ReStructuredText>`_" class="bare">https://en.wikipedia.org/wiki/ReStructuredText>`_</a>. Le second a l’avantage d’avoir une syntaxe plus simple à apprendre et à comprendre, mais est plus limité dans son résultat.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Dans l’immédiat, nous nous contenterons d’avoir des modules documentés (quelle que soit la méthode Sphinx/MkDocs/…​). Dans la continuié de <code>Flake8</code>, il existe un greffon qui vérifie la présence de commentaires au niveau des méthodes et modules développés.</p>
|
||
</div>
|
||
<div class="olist loweralpha">
|
||
<ol class="loweralpha" type="a">
|
||
<li>
|
||
<p>note::</p>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>voir si il ne faudrait pas mieux passer par pydocstyle.</pre>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
<li>
|
||
<p>code-block:: shell</p>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>$ pip install flake8_docstrings</pre>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Lancez ensuite <code>flake8</code> avec la commande <code>flake8 . --exclude="migrations"</code>. Sur notre projet (presque) vide, le résultat sera le suivant:</p>
|
||
</div>
|
||
<div class="olist loweralpha">
|
||
<ol class="loweralpha" type="a">
|
||
<li>
|
||
<p>code-block:: shell</p>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>$ flake8 . --exclude="migrations"
|
||
.\src\manage.py:1:1: D100 Missing docstring in public module
|
||
.\src\gwift\__init__.py:1:1: D100 Missing docstring in public module
|
||
.\src\gwift\urls.py:1:1: D400 First line should end with a period (not 'n')
|
||
.\src\wish\__init__.py:1:1: D100 Missing docstring in public module
|
||
.\src\wish\admin.py:1:1: D100 Missing docstring in public module
|
||
.\src\wish\admin.py:1:1: F401 'admin' imported but unused
|
||
.\src\wish\models.py:1:1: D100 Missing docstring in public module
|
||
.\src\wish\models.py:1:1: F401 'models' imported but unused
|
||
.\src\wish\tests.py:1:1: D100 Missing docstring in public module
|
||
.\src\wish\tests.py:1:1: F401 'TestCase' imported but unused
|
||
.\src\wish\views.py:1:1: D100 Missing docstring in public module
|
||
.\src\wish\views.py:1:1: F401 'render' imported but unused</pre>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Bref, on le voit: nous n’avons que très peu de modules, et aucun d’eux n’est commenté.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>En plus de cette méthode, Django permet également de rendre la documentation accessible depuis son interface d’administration.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_pep8_flake8_pylint">5.2. pep8, flake8, pylint</h3>
|
||
<div class="paragraph">
|
||
<p>Un outil existe et listera l’ensemble des conventions qui ne sont pas correctement suivies dans votre projet: pep8. Pour l’installer, passez par pip. Lancez ensuite la commande pep8 suivie du chemin à analyser (., le nom d’un répertoire, le nom d’un fichier .py, …​).</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Si vous ne voulez pas être dérangé sur votre manière de coder, et que vous voulez juste avoir un retour sur une analyse de votre code, essayez pyflakes: il analaysera vos sources à la recherche d’erreurs (imports inutilsés, méthodes inconnues, etc.).</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Et finalement, si vous voulez grouper les deux, il existe flake8. Sur base la même interface que pep8, vous aurez en plus des avertissements concernant le code source.</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="python"><span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span>
|
||
|
||
<span class="s">"""On stocke la date du jour dans la variable ToD4y"""</span>
|
||
|
||
<span class="n">ToD4y</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">today</span><span class="p">()</span>
|
||
|
||
<span class="k">def</span> <span class="nf">print_today</span><span class="p">(</span><span class="n">ToD4y</span><span class="p">):</span>
|
||
<span class="n">today</span> <span class="o">=</span> <span class="n">ToD4y</span>
|
||
<span class="k">print</span><span class="p">(</span><span class="n">ToD4y</span><span class="p">)</span>
|
||
|
||
<span class="k">def</span> <span class="nf">GetToday</span><span class="p">():</span>
|
||
<span class="k">return</span> <span class="n">ToD4y</span>
|
||
|
||
|
||
<span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">"__main__"</span><span class="p">:</span>
|
||
<span class="n">t</span> <span class="o">=</span> <span class="n">Get_Today</span><span class="p">()</span>
|
||
<span class="k">print</span><span class="p">(</span><span class="n">t</span><span class="p">)</span></code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>L’exécution de la commande flake8 . retourne ceci:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash">test.py:7:1: E302 expected 2 blank lines, found 1
|
||
test.py:8:5: F841 <span class="nb">local </span>variable <span class="s1">'today'</span> is assigned to but never used
|
||
test.py:11:1: E302 expected 2 blank lines, found 1
|
||
test.py:16:8: E222 multiple spaces after operator
|
||
test.py:16:11: F821 undefined name <span class="s1">'Get_Today'</span>
|
||
test.py:18:1: W391 blank line at end of file</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>On trouve des erreurs:</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p>de <strong>conventions</strong>: le nombre de lignes qui séparent deux fonctions, le nombre d’espace après un opérateur, une ligne vide à la fin du fichier, …​ Ces <em>erreurs</em> n’en sont pas vraiment, elles indiquent juste de potentiels problèmes de communication si le code devait être lu ou compris par une autre personne.</p>
|
||
</li>
|
||
<li>
|
||
<p>de <strong>définition</strong>: une variable assignée mais pas utilisée ou une lexème non trouvé. Cette dernière information indique clairement un bug potentiel.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>L’étape d’après consiste à invoquer pylint. Lui, il est directement moins conciliant:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="text">$ pylint test.py
|
||
************* Module test
|
||
test.py:16:6: C0326: Exactly one space required after assignment
|
||
t = Get_Today()
|
||
^ (bad-whitespace)
|
||
test.py:18:0: C0305: Trailing newlines (trailing-newlines)
|
||
test.py:1:0: C0114: Missing module docstring (missing-module-docstring)
|
||
test.py:3:0: W0105: String statement has no effect (pointless-string-statement)
|
||
test.py:5:0: C0103: Constant name "ToD4y" doesn't conform to UPPER_CASE naming style (invalid-name)
|
||
test.py:7:16: W0621: Redefining name 'ToD4y' from outer scope (line 5) (redefined-outer-name)
|
||
test.py:7:0: C0103: Argument name "ToD4y" doesn't conform to snake_case naming style (invalid-name)
|
||
test.py:7:0: C0116: Missing function or method docstring (missing-function-docstring)
|
||
test.py:8:4: W0612: Unused variable 'today' (unused-variable)
|
||
test.py:11:0: C0103: Function name "GetToday" doesn't conform to snake_case naming style (invalid-name)
|
||
test.py:11:0: C0116: Missing function or method docstring (missing-function-docstring)
|
||
test.py:16:4: C0103: Constant name "t" doesn't conform to UPPER_CASE naming style (invalid-name)
|
||
test.py:16:10: E0602: Undefined variable 'Get_Today' (undefined-variable)
|
||
|
||
--------------------------------------------------------------------
|
||
Your code has been rated at -5.45/10</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>En gros, j’ai programmé comme une grosse bouse anémique (et oui, le score d’évaluation du code permet bien d’aller en négatif). En vrac, on trouve des problèmes liés:</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p>au nommage (C0103) et à la mise en forme (C0305, C0326, W0105)</p>
|
||
</li>
|
||
<li>
|
||
<p>à des variables non définies (E0602)</p>
|
||
</li>
|
||
<li>
|
||
<p>de la documentation manquante (C0114, C0116)</p>
|
||
</li>
|
||
<li>
|
||
<p>de la redéfinition de variables (W0621).</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Pour reprendre la <a href="http://pylint.pycqa.org/en/latest/user_guide/message-control.html">documentation</a>, chaque code possède sa signification (ouf!):</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p>C convention related checks</p>
|
||
</li>
|
||
<li>
|
||
<p>R refactoring related checks</p>
|
||
</li>
|
||
<li>
|
||
<p>W various warnings</p>
|
||
</li>
|
||
<li>
|
||
<p>E errors, for probable bugs in the code</p>
|
||
</li>
|
||
<li>
|
||
<p>F fatal, if an error occurred which prevented pylint from doing further* processing.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>PyLint est la version <strong>++</strong>, pour ceux qui veulent un code propre et sans bavure.</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_black">5.3. Black</h3>
|
||
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_pytest">5.4. pytest</h3>
|
||
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_mypy">5.5. mypy</h3>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_git">6. Git</h2>
|
||
<div class="sectionbody">
|
||
<div class="admonitionblock note">
|
||
<table>
|
||
<tr>
|
||
<td class="icon">
|
||
<div class="title">Note</div>
|
||
</td>
|
||
<td class="content">
|
||
insérer ici une description de Gitflow + quelques exemples types création, ajout, suppression, historique, branches, …​ et quelques schémas qui-vont-bien.
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Il existe plusiseurs outils permettant de gérer les versions du code, dont les plus connus sont `git <<a href="https://git-scm.com/>`_" class="bare">https://git-scm.com/>`_</a> et `mercurial <<a href="https://www.mercurial-scm.org/>`_" class="bare">https://www.mercurial-scm.org/>`_</a>.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Dans notre cas, nous utilisons git et hebergons le code et le livre directement sur le gitlab de `framasoft <<a href="https://git.framasoft.org/>`_" class="bare">https://git.framasoft.org/>`_</a></p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_graphviz">7. graphviz</h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>En utilisant django_extensions (! bien suivre les étapes d’installation !).</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="text"> C:\app\graphviz\bin\dot.exe graph.dot -Tpng -o graph.png</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="_déploiement" class="sect0">Déploiement</h1>
|
||
<div class="openblock partintro">
|
||
<div class="content">
|
||
Et sécurisation du serveur.
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_un_peu_de_théorie_les_principales_étapes">8. Un peu de théorie…​ Les principales étapes</h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>On va déjà parler de déploiement. Si vous avez suivi les étapes jusqu’ici, vous devriez à peine disposer d’un espace de travail proprement configuré, d’un modèle relativement basique et d’une configuration avec une base de données simpliste. En bref, vous avez quelque chose qui fonctionne, mais qui ressemble de très loin à ce que vous souhaitez au final.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Il y a une raison très simple à aborder le déploiement dès maintenant: à trop attendre et à peaufiner son développement en local, on en oublie que sa finalité sera de se retrouver exposé sur un serveur. On risque d’avoir oublié une partie des désidérata, d’avoir zappé une fonctionnalité essentielle ou simplement de passer énormément de temps à adapter les sources pour qu’elles fonctionnent sur un environnement en particulier.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Aborder le déploiement maintenant permet également de rédiger dès le début les procédures d’installation, de mise à jour et de sauvegardes. Déploier une nouvelle version sera aussi simple que de récupérer la dernière archive depuis le dépôt, la placer dans le bon répertoire, appliquer des actions spécifiques (et souvent identiques entre deux versions), puis redémarrer les services adéquats.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Dans cette partie, on abordera les points suivants:</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p>La définition de l’infrastructure nécessaire à notre application</p>
|
||
</li>
|
||
<li>
|
||
<p>La configuration de l’hôte, qui hébergera l’application: dans une machine physique, virtuelle ou dans un container. On abordera aussi rapidement les déploiements via Ansible, Chef, Puppet ou Salt.</p>
|
||
</li>
|
||
<li>
|
||
<p>Les différentes méthodes de supervision de l’application: comment analyser les fichiers de logs et comment intercepter correctement une erreur si elle se présente et comment remonter l’information.</p>
|
||
</li>
|
||
<li>
|
||
<p>Une partie sur la sécurité et la sécurisation de l’hôte.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_définition_de_linfrastructure">8.1. Définition de l’infrastructure</h3>
|
||
<div class="paragraph">
|
||
<p>Comme on l’a vu dans la première partie, Django est un framework complet, intégrant tous les mécanismes nécessaires à la bonne évolution d’une application. On peut ainsi commencer petit, et suivre l’évolution des besoins en fonction de la charge estimée ou ressentie, ajouter un mécanisme de mise en cache, des logiciels de suivi, …​</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_configuration_et_sécurisation_de_la_machine_hôte">8.2. Configuration et sécurisation de la machine hôte</h3>
|
||
<div class="paragraph">
|
||
<p>Supervisor, nginx, gunicorn, utilisateurs, groupes, …​</p>
|
||
</div>
|
||
<div class="openblock plantuml">
|
||
<div class="content">
|
||
<div class="paragraph">
|
||
<p>entity Nginx
|
||
entity "Gunicorn (sockets/HTTP)" as gunicorn
|
||
database PGSQL</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Aussi : Docker, Heroku, Digital Ocean, Scaleway, OVH, …​ Bref, sur Debian et CentOS pour avoir un panel assez large. On oublie Windows.</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_mise_à_jour">8.3. Mise à jour</h3>
|
||
<div class="paragraph">
|
||
<p>Script de mise à jour.</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_supervision">8.4. Supervision</h3>
|
||
<div class="paragraph">
|
||
<p>Qu’est-ce qu’on fait des logs après ? :-)</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_déploiement_sur_centos">9. Déploiement sur CentOS</h2>
|
||
<div class="sectionbody">
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash">yum update
|
||
groupadd <span class="nt">--system</span> webapps
|
||
groupadd <span class="nt">--system</span> gunicorn_sockets
|
||
useradd <span class="nt">--system</span> <span class="nt">--gid</span> webapps <span class="nt">--shell</span> /bin/bash <span class="nt">--home</span> /home/medplan medplan
|
||
<span class="nb">mkdir</span> <span class="nt">-p</span> /home/medplan
|
||
<span class="nb">chown </span>medplan:webapps /home/medplan</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_installation_des_dépendances_systèmes">9.1. Installation des dépendances systèmes</h3>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash">yum <span class="nb">install </span>python36 git tree <span class="nt">-y</span>
|
||
|
||
<span class="c"># CentOS 7 ne dispose que de la version 3.7 d'SQLite. On a besoin d'une version 3.8 au minimum:</span>
|
||
wget https://kojipkgs.fedoraproject.org//packages/sqlite/3.8.11/1.fc21/x86_64/sqlite-devel-3.8.11-1.fc21.x86_64.rpm
|
||
wget https://kojipkgs.fedoraproject.org//packages/sqlite/3.8.11/1.fc21/x86_64/sqlite-3.8.11-1.fc21.x86_64.rpm
|
||
<span class="nb">sudo </span>yum <span class="nb">install </span>sqlite-3.8.11-1.fc21.x86_64.rpm sqlite-devel-3.8.11-1.fc21.x86_64.rpm <span class="nt">-y</span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_préparation_de_lenvironnement_utilisateur">9.2. Préparation de l’environnement utilisateur</h3>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash">su - medplan
|
||
<span class="nb">cp</span> /etc/skel/.bashrc <span class="nb">.</span>
|
||
<span class="nb">cp</span> /etc/skel/.bash_profile <span class="nb">.</span>
|
||
ssh-keygen
|
||
<span class="nb">mkdir </span>bin
|
||
<span class="nb">mkdir</span> .venvs
|
||
<span class="nb">mkdir </span>webapps
|
||
python3.6 <span class="nt">-m</span> venv .venvs/medplan
|
||
<span class="nb">source</span> .venvs/medplan/bin/activate
|
||
<span class="nb">cd</span> /home/medplan/webapps
|
||
git clone git@vmwmedtools:institutionnel/medplan.git</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>La clé SSH doit ensuite être renseignée au niveau du dépôt, afin de pouvoir y accéder.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>A ce stade, on devrait déjà avoir quelque chose de fonctionnel en démarrant les commandes suivantes:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash"><span class="c"># en tant qu'utilisateur 'medplan'</span>
|
||
|
||
<span class="nb">source</span> .venvs/medplan/bin/activate
|
||
pip <span class="nb">install</span> <span class="nt">-U</span> pip
|
||
pip <span class="nb">install</span> <span class="nt">-r</span> requirements/base.txt
|
||
pip <span class="nb">install </span>gunicorn
|
||
<span class="nb">cd </span>webapps/medplan
|
||
gunicorn config.wsgi:application <span class="nt">--bind</span> localhost:3000 <span class="nt">--settings</span><span class="o">=</span>config.settings_production</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_configuration_de_lapplication">9.3. Configuration de l’application</h3>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash"><span class="nv">SECRET_KEY</span><span class="o">=</span><<span class="nb">set </span>your secret key here>
|
||
<span class="nv">ALLOWED_HOSTS</span><span class="o">=</span><span class="k">*</span>
|
||
<span class="nv">STATIC_ROOT</span><span class="o">=</span>/var/www/medplan/static</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_création_des_répertoires_de_logs">9.4. Création des répertoires de logs</h3>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="text">mkdir -p /var/www/medplan/static</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_création_du_répertoire_pour_le_socket">9.5. Création du répertoire pour le socket</h3>
|
||
<div class="paragraph">
|
||
<p>Dans le fichier <code>/etc/tmpfiles.d/medplan.conf</code>:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="text">D /var/run/webapps 0775 medplan gunicorn_sockets -</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Suivi de la création par systemd :</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="text">systemd-tmpfiles --create</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_gunicorn">9.6. Gunicorn</h3>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash"><span class="c">#!/bin/bash</span>
|
||
|
||
<span class="c"># defines settings for gunicorn</span>
|
||
<span class="nv">NAME</span><span class="o">=</span><span class="s2">"Medplan"</span>
|
||
<span class="nv">DJANGODIR</span><span class="o">=</span>/home/medplan/webapps/medplan
|
||
<span class="nv">SOCKFILE</span><span class="o">=</span>/var/run/webapps/gunicorn_medplan.sock
|
||
<span class="nv">USER</span><span class="o">=</span>medplan
|
||
<span class="nv">GROUP</span><span class="o">=</span>gunicorn_sockets
|
||
<span class="nv">NUM_WORKERS</span><span class="o">=</span>5
|
||
<span class="nv">DJANGO_SETTINGS_MODULE</span><span class="o">=</span>config.settings_production
|
||
<span class="nv">DJANGO_WSGI_MODULE</span><span class="o">=</span>config.wsgi
|
||
|
||
<span class="nb">echo</span> <span class="s2">"Starting </span><span class="nv">$NAME</span><span class="s2"> as </span><span class="sb">`</span><span class="nb">whoami</span><span class="sb">`</span><span class="s2">"</span>
|
||
|
||
<span class="nb">source</span> /home/medplan/.venvs/medplan/bin/activate
|
||
<span class="nb">cd</span> <span class="nv">$DJANGODIR</span>
|
||
<span class="nb">export </span><span class="nv">DJANGO_SETTINGS_MODULE</span><span class="o">=</span><span class="nv">$DJANGO_SETTINGS_MODULE</span>
|
||
<span class="nb">export </span><span class="nv">PYTHONPATH</span><span class="o">=</span><span class="nv">$DJANGODIR</span>:<span class="nv">$PYTHONPATH</span>
|
||
|
||
<span class="nb">exec </span>gunicorn <span class="k">${</span><span class="nv">DJANGO_WSGI_MODULE</span><span class="k">}</span>:application <span class="se">\</span>
|
||
<span class="nt">--name</span> <span class="nv">$NAME</span> <span class="se">\</span>
|
||
<span class="nt">--workers</span> <span class="nv">$NUM_WORKERS</span> <span class="se">\</span>
|
||
<span class="nt">--user</span> <span class="nv">$USER</span> <span class="se">\</span>
|
||
<span class="nt">--bind</span><span class="o">=</span>unix:<span class="nv">$SOCKFILE</span> <span class="se">\</span>
|
||
<span class="nt">--log-level</span><span class="o">=</span>debug <span class="se">\</span>
|
||
<span class="nt">--log-file</span><span class="o">=</span>-</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_supervision_2">9.7. Supervision</h3>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash">yum <span class="nb">install </span>supervisor <span class="nt">-y</span></code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>On crée ensuite le fichier <code>/etc/supervisord.d/medplan.ini</code>:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash"><span class="o">[</span>program:medplan]
|
||
<span class="nb">command</span><span class="o">=</span>/home/medplan/bin/start_gunicorn.sh
|
||
<span class="nv">user</span><span class="o">=</span>medplan
|
||
<span class="nv">stdout_logfile</span><span class="o">=</span>/var/log/medplan/medplan.log
|
||
<span class="nv">autostart</span><span class="o">=</span><span class="nb">true
|
||
</span><span class="nv">autorestart</span><span class="o">=</span>unexpected
|
||
<span class="nv">redirect_stdout</span><span class="o">=</span><span class="nb">true
|
||
</span><span class="nv">redirect_stderr</span><span class="o">=</span><span class="nb">true</span></code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Et on crée les répertoires de logs, on démarre supervisord et on vérifie qu’il tourne correctement:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="bash"><span class="nb">mkdir</span> /var/log/medplan
|
||
<span class="nb">chown </span>medplan:nagios /var/log/medplan
|
||
|
||
systemctl <span class="nb">enable </span>supervisord
|
||
systemctl start supervisord.service
|
||
systemctl status supervisord.service
|
||
● supervisord.service - Process Monitoring and Control Daemon
|
||
Loaded: loaded <span class="o">(</span>/usr/lib/systemd/system/supervisord.service<span class="p">;</span> enabled<span class="p">;</span> vendor preset: disabled<span class="o">)</span>
|
||
Active: active <span class="o">(</span>running<span class="o">)</span> since Tue 2019-12-24 10:08:09 CET<span class="p">;</span> 10s ago
|
||
Process: 2304 <span class="nv">ExecStart</span><span class="o">=</span>/usr/bin/supervisord <span class="nt">-c</span> /etc/supervisord.conf <span class="o">(</span><span class="nv">code</span><span class="o">=</span>exited, <span class="nv">status</span><span class="o">=</span>0/SUCCESS<span class="o">)</span>
|
||
Main PID: 2310 <span class="o">(</span>supervisord<span class="o">)</span>
|
||
CGroup: /system.slice/supervisord.service
|
||
├─2310 /usr/bin/python /usr/bin/supervisord <span class="nt">-c</span> /etc/supervisord.conf
|
||
├─2313 /home/medplan/.venvs/medplan/bin/python3 /home/medplan/.venvs/medplan/bin/gunicorn config.wsgi:...
|
||
├─2317 /home/medplan/.venvs/medplan/bin/python3 /home/medplan/.venvs/medplan/bin/gunicorn config.wsgi:...
|
||
├─2318 /home/medplan/.venvs/medplan/bin/python3 /home/medplan/.venvs/medplan/bin/gunicorn config.wsgi:...
|
||
├─2321 /home/medplan/.venvs/medplan/bin/python3 /home/medplan/.venvs/medplan/bin/gunicorn config.wsgi:...
|
||
├─2322 /home/medplan/.venvs/medplan/bin/python3 /home/medplan/.venvs/medplan/bin/gunicorn config.wsgi:...
|
||
└─2323 /home/medplan/.venvs/medplan/bin/python3 /home/medplan/.venvs/medplan/bin/gunicorn config.wsgi:...
|
||
<span class="nb">ls</span> /var/run/webapps/</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_ouverture_des_ports">9.8. Ouverture des ports</h3>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="text">firewall-cmd --permanent --zone=public --add-service=http
|
||
firewall-cmd --permanent --zone=public --add-service=https
|
||
firewall-cmd --reload</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_installation_dnginx">9.9. Installation d’Nginx</h3>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code>yum install nginx -y
|
||
usermod -a -G gunicorn_sockets nginx</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>On configure ensuite le fichier <code>/etc/nginx/conf.d/medplan.conf</code>:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>upstream medplan_app {
|
||
server unix:/var/run/webapps/gunicorn_medplan.sock fail_timeout=0;
|
||
}
|
||
|
||
server {
|
||
listen 80;
|
||
server_name <server_name>;
|
||
root /var/www/medplan;
|
||
error_log /var/log/nginx/medplan_error.log;
|
||
access_log /var/log/nginx/medplan_access.log;
|
||
|
||
client_max_body_size 4G;
|
||
keepalive_timeout 5;
|
||
|
||
gzip on;
|
||
gzip_comp_level 7;
|
||
gzip_proxied any;
|
||
gzip_types gzip_types text/plain text/css text/xml text/javascript application/x-javascript application/xml;
|
||
|
||
|
||
location /static/ {
|
||
access_log off;
|
||
expires 30d;
|
||
add_header Pragma public;
|
||
add_header Cache-Control "public";
|
||
add_header Vary "Accept-Encoding";
|
||
try_files $uri $uri/ =404;
|
||
}
|
||
|
||
location / {
|
||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||
proxy_set_header Host $http_host;
|
||
proxy_redirect off;
|
||
|
||
proxy_pass http://medplan_app;
|
||
}
|
||
}</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_configuration_des_sauvegardes">9.10. Configuration des sauvegardes</h3>
|
||
<div class="paragraph">
|
||
<p>Les sauvegardes ont été configurées avec borg: <code>yum install borgbackup</code>.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>C’est l’utilisateur medplan qui s’en occupe.</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>mkdir -p /home/medplan/borg-backups/
|
||
cd /home/medplan/borg-backups/
|
||
borg init medplan.borg -e=none
|
||
borg create medplan.borg::{now} ~/bin ~/webapps</pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Et dans le fichier crontab :</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>0 23 * * * /home/medplan/bin/backup.sh</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="_modélisation" class="sect0">Modélisation</h1>
|
||
<div class="openblock partintro">
|
||
<div class="content">
|
||
Dans ce chapitre, on va parler de plusieurs concepts utiles au développement rapide d’une application. On parlera de modélisation, de migrations, d’administration auto-générée.
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_modélisation_2">10. Modélisation</h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>On va aborder la modélisation des objets en elle-même, qui s’apparente à la conception de la base de données.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Django utilise un modèle <a href="https://fr.wikipedia.org/wiki/Mapping_objet-relationnel">ORM</a> - c’est-à-dire que chaque objet peut s’apparenter à une table SQL, mais en ajoutant une couche propre au paradigme orienté objet. Il sera ainsi possible de définir facilement des notions d’héritage (tout en restant dans une forme d’héritage simple), la possibilité d’utiliser des propriétés spécifiques, des classes intermédiaires, …​</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>L’avantage de tout ceci est que tout reste au niveau du code. Si l’on revient sur la méthodologie des douze facteurs, ce point concerne principalement la minimisation de la divergence entre les environnements d’exécution. Déployer une nouvelle instance de l’application pourra être réalisé directement à partir d’une seule et même commande, dans la mesure où <strong>tout est embarqué au niveau du code</strong>.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Assez de blabla, on démarre !</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_queryset_managers">11. Queryset & managers</h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>L’ORM de Django propose par défaut deux objets hyper importants:</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p>Les managers, qui consistent en un point d’entrée pour accéder aux objets persistants</p>
|
||
</li>
|
||
<li>
|
||
<p>Les querysets, qui permettent de filtrer des ensembles ou sous-ensemble d’objets. Les querysets peuvent s’imbriquer, pour ajouter
|
||
d’autres filtres à des filtres existants.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>En plus de cela, il faut bien tenir compte des propriétés <code>Meta</code> de la classe: si elle contient déjà un ordre par défaut, celui-ci
|
||
sera pris en compte pour l’ensemble des requêtes effectuées sur cette classe.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_forms">12. Forms</h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>Ou comment valider proprement des données entrantes.</p>
|
||
</div>
|
||
<div class="admonitionblock note">
|
||
<table>
|
||
<tr>
|
||
<td class="icon">
|
||
<div class="title">Note</div>
|
||
</td>
|
||
<td class="content">
|
||
intégrer le dessin XKCD avec Little Bobby Table sur l’assainissement des données en entrée :-p
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Quand on parle de <code>forms</code>, on ne parle pas uniquement de formulaires Web. On pourrait considérer qu’il s’agit de leur objectif principal, mais on peut également voir un peu plus loin: on peut en fait voir les <code>forms</code> comme le point d’entrée pour chaque donnée arrivant dans notre application: il s’agit en quelque sorte d’un ensemble de règles complémentaires à celles déjà présentes au niveau du modèle.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>L’exemple le plus simple est un fichier <code>.csv</code>: la lecture de ce fichier pourrait se faire de manière très simple, en récupérant les valeurs de chaque colonne et en l’introduisant dans une instance du modèle.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Mauvaise idée.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Les données fournies par un utilisateur <strong>doivent</strong> <strong>toujours</strong> être validées avant introduction dans la base de données. Notre base de données étant accessible ici par l’ORM, la solution consiste à introduire une couche supplémentaire de validation.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Le flux à suivre est le suivant:</p>
|
||
</div>
|
||
<div class="olist arabic">
|
||
<ol class="arabic">
|
||
<li>
|
||
<p>Création d’une instance grâce à un dictionnaire</p>
|
||
</li>
|
||
<li>
|
||
<p>Validation des données et des informations reçues</p>
|
||
</li>
|
||
<li>
|
||
<p>Traitement, si la validation a réussi.</p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Ils jouent également plusieurs rôles:</p>
|
||
</div>
|
||
<div class="olist arabic">
|
||
<ol class="arabic">
|
||
<li>
|
||
<p>Validation des données, en plus de celles déjà définies au niveau du modèle</p>
|
||
</li>
|
||
<li>
|
||
<p>Contrôle sur le rendu à appliquer aux champs</p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Ils agissent come une glue entre l’utilisateur et la modélisation de vos structures de données.</p>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_dépendance_avec_le_modèle">12.1. Dépendance avec le modèle</h3>
|
||
<div class="paragraph">
|
||
<p>Un <strong>form</strong> peut dépendre d’une autre classe Django. Pour cela, il suffit de fixer l’attribut <code>model</code> au niveau de la <code>class Meta</code> dans la définition.</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="python"><span class="kn">from</span> <span class="nn">django</span> <span class="kn">import</span> <span class="n">forms</span>
|
||
|
||
<span class="kn">from</span> <span class="nn">wish.models</span> <span class="kn">import</span> <span class="n">Wishlist</span>
|
||
|
||
<span class="k">class</span> <span class="nc">WishlistCreateForm</span><span class="p">(</span><span class="n">forms</span><span class="o">.</span><span class="n">ModelForm</span><span class="p">):</span>
|
||
<span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
|
||
<span class="n">model</span> <span class="o">=</span> <span class="n">Wishlist</span>
|
||
<span class="n">fields</span> <span class="o">=</span> <span class="p">(</span><span class="s">'name'</span><span class="p">,</span> <span class="s">'description'</span><span class="p">)</span></code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>De cette manière, notre form dépendra automatiquement des champs déjà déclarés dans la classe <code>Wishlist</code>. Cela suit le principe de <code>DRY <don’t repeat yourself>`_, et évite qu’une modification ne pourrisse le code: en testant les deux champs présent dans l’attribut `fields</code>, nous pourrons nous assurer de faire évoluer le formulaire en fonction du modèle sur lequel il se base.</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_rendu_et_affichage">12.2. Rendu et affichage</h3>
|
||
<div class="paragraph">
|
||
<p>Le formulaire permet également de contrôler le rendu qui sera appliqué lors de la génération de la page. Si les champs dépendent du modèle sur lequel se base le formulaire, ces widgets doivent être initialisés dans l’attribut <code>Meta</code>. Sinon, ils peuvent l’être directement au niveau du champ.</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="python"><span class="kn">from</span> <span class="nn">django</span> <span class="kn">import</span> <span class="n">forms</span>
|
||
<span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">date</span>
|
||
<span class="kn">from</span> <span class="nn">.models</span> <span class="kn">import</span> <span class="n">Accident</span>
|
||
|
||
<span class="k">class</span> <span class="nc">AccidentForm</span><span class="p">(</span><span class="n">forms</span><span class="o">.</span><span class="n">ModelForm</span><span class="p">):</span>
|
||
<span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
|
||
<span class="n">model</span> <span class="o">=</span> <span class="n">Accident</span>
|
||
<span class="n">fields</span> <span class="o">=</span> <span class="p">(</span><span class="s">'gymnast'</span><span class="p">,</span> <span class="s">'educative'</span><span class="p">,</span> <span class="s">'date'</span><span class="p">,</span> <span class="s">'information'</span><span class="p">)</span>
|
||
<span class="n">widgets</span> <span class="o">=</span> <span class="p">{</span>
|
||
<span class="s">'date'</span> <span class="p">:</span> <span class="n">forms</span><span class="o">.</span><span class="n">TextInput</span><span class="p">(</span>
|
||
<span class="n">attrs</span><span class="o">=</span><span class="p">{</span>
|
||
<span class="s">'class'</span> <span class="p">:</span> <span class="s">'form-control'</span><span class="p">,</span>
|
||
<span class="s">'data-provide'</span> <span class="p">:</span> <span class="s">'datepicker'</span><span class="p">,</span>
|
||
<span class="s">'data-date-format'</span> <span class="p">:</span> <span class="s">'dd/mm/yyyy'</span><span class="p">,</span>
|
||
<span class="s">'placeholder'</span> <span class="p">:</span> <span class="n">date</span><span class="o">.</span><span class="n">today</span><span class="p">()</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s">"</span><span class="si">%</span><span class="s">d/</span><span class="si">%</span><span class="s">m/</span><span class="si">%</span><span class="s">Y"</span><span class="p">)</span>
|
||
<span class="p">}),</span>
|
||
<span class="s">'information'</span> <span class="p">:</span> <span class="n">forms</span><span class="o">.</span><span class="n">Textarea</span><span class="p">(</span>
|
||
<span class="n">attrs</span><span class="o">=</span><span class="p">{</span>
|
||
<span class="s">'class'</span> <span class="p">:</span> <span class="s">'form-control'</span><span class="p">,</span>
|
||
<span class="s">'placeholder'</span> <span class="p">:</span> <span class="s">'Context (why, where, ...)'</span>
|
||
<span class="p">})</span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_squelette_par_défaut">12.3. Squelette par défaut</h3>
|
||
<div class="paragraph">
|
||
<p>On a d’un côté le {{ form.as_p }} ou {{ form.as_table }}, mais il y a beaucoup mieux que ça ;-) Voir les templates de Vitor.</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_crispy_forms">12.4. Crispy-forms</h3>
|
||
<div class="paragraph">
|
||
<p>Comme on l’a vu à l’instant, les forms, en Django, c’est le bien. Cela permet de valider des données reçues en entrée et d’afficher (très) facilement des formulaires à compléter par l’utilisateur.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Par contre, c’est lourd. Dès qu’on souhaite peaufiner un peu l’affichage, contrôler parfaitement ce que l’utilisateur doit remplir, modifier les types de contrôleurs, les placer au pixel près, …​ Tout ça demande énormément de temps. Et c’est là qu’intervient `Django-Crispy-Forms <<a href="http://django-crispy-forms.readthedocs.io/en/latest/>`_" class="bare">http://django-crispy-forms.readthedocs.io/en/latest/>`_</a>. Cette librairie intègre plusieurs frameworks CSS (Bootstrap, Foundation et uni-form) et permet de contrôler entièrement le <strong>layout</strong> et la présentation.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>(c/c depuis le lien ci-dessous)</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Pour chaque champ, crispy-forms va :</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p>utiliser le <code>verbose_name</code> comme label.</p>
|
||
</li>
|
||
<li>
|
||
<p>vérifier les paramètres <code>blank</code> et <code>null</code> pour savoir si le champ est obligatoire.</p>
|
||
</li>
|
||
<li>
|
||
<p>utiliser le type de champ pour définir le type de la balise <code><input></code>.</p>
|
||
</li>
|
||
<li>
|
||
<p>récupérer les valeurs du paramètre <code>choices</code> (si présent) pour la balise <code><select></code>.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p><a href="http://dotmobo.github.io/django-crispy-forms.html" class="bare">http://dotmobo.github.io/django-crispy-forms.html</a></p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_validation_des_données">13. Validation des données</h2>
|
||
<div class="sectionbody">
|
||
<div class="admonitionblock note">
|
||
<table>
|
||
<tr>
|
||
<td class="icon">
|
||
<div class="title">Note</div>
|
||
</td>
|
||
<td class="content">
|
||
parler ici des méthodes <code>clean</code>.
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_en_conclusion">14. En conclusion</h2>
|
||
<div class="sectionbody">
|
||
<div class="olist arabic">
|
||
<ol class="arabic">
|
||
<li>
|
||
<p>Toute donnée entrée par l’utilisateur <strong>doit</strong> passer par une instance de <code>form</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p>euh ?</p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_migrations">15. Migrations</h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>Les migrations (comprendre les "migrations du schéma de base de données") sont intimement liées à la représentation d’un contexte fonctionnel. L’ajout d’une nouvelle information, d’un nouveau champ ou d’une nouvelle fonction peut s’accompagner de tables de données à mettre à jour ou de champs à étendre.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Toujours dans une optique de centralisation, les migrations sont directement embarquées au niveau du code. Le développeur s’occupe de créer les migrations en fonction des actions à entreprendre; ces migrations peuvent être retravaillées, <em>squashées</em>, …​ et feront partie intégrante du processus de mise à jour de l’application.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_administration">16. Administration</h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>Woké. On va commencer par la <strong>partie à ne <em>surtout</em> (<em>surtout</em> !!) pas faire en premier dans un projet Django</strong>. Mais on va la faire quand même. La raison principale est que cette partie est tellement puissante et performante, qu’elle pourrait laisser penser qu’il est possible de réaliser une application complète rien qu’en configurant l’administration.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>C’est faux.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>L’administration est une sorte de tour de contrôle évoluée; elle se base sur le modèle de données programmé et construit dynamiquement les formulaires qui lui est associé. Elle joue avec les clés primaires, étrangères, les champs et types de champs par <a href="https://fr.wikipedia.org/wiki/Introspection">introspection</a>.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Son problème est qu’elle présente une courbe d’apprentissage asymptotique. Il est <strong>très</strong> facile d’arriver rapidement à un bon résultat, au travers d’un périmètre de configuration relativement restreint. Mais quoi que vous fassiez, il y a un moment où la courbe de paramétrage sera tellement ardue que vous aurez plus facile à développer ce que vous souhaitez ajouter en utilisant les autres concepts de Django.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Elle doit rester dans les mains d’administrateurs ou de gestionnaires, et dans leurs mains à eux uniquement: il n’est pas question de donner des droits aux utilisateurs finaux (même si c’est extrêment tentant durant les premiers tours de roues). Indépendamment de la manière dont vous allez l’utiliser et la configurer, vous finirez par devoir développer une "vraie" application, destinée aux utilisateurs classiques, et répondant à leurs besoins uniquement.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Une bonne idée consiste à développer l’administration dans un premier temps, en <strong>gardant en tête qu’il sera nécessaire de développer des concepts spécifiques</strong>. Dans cet objectif, l’administration est un outil exceptionel, qui permet de valider un modèle, de créer des objets rapidement et de valider les liens qui existent entre eux. C’est un excellent outil de prototypage et de preuve de concept.</p>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_quelques_conseils">16.1. Quelques conseils</h3>
|
||
<div class="olist arabic">
|
||
<ol class="arabic">
|
||
<li>
|
||
<p>Surchargez la méthode <code><em>str</em>(self)</code> pour chaque classe que vous aurez définie dans le modèle. Cela permettra de construire une représentation textuelle qui représentera l’instance de votre classe. Cette information sera utilisée un peu partout dans le code, et donnera une meilleure idée de ce que l’on manipule. En plus, cette méthode est également appelée lorsque l’administration historisera une action (et comme cette étape sera inaltérable, autant qu’elle soit fixée dans le début).</p>
|
||
</li>
|
||
<li>
|
||
<p>La méthode <code>get_absolute_url(self)</code> retourne l’URL à laquelle on peut accéder pour obtenir les détails d’une instance. Par exemple:</p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="python"><span class="k">def</span> <span class="nf">get_absolute_url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||
<span class="k">return</span> <span class="n">reverse</span><span class="p">(</span><span class="s">'myapp.views.details'</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="nb">id</span><span class="p">])</span></code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="olist arabic">
|
||
<ol class="arabic">
|
||
<li>
|
||
<p>Les attributs <code>Meta</code>:</p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="python"><span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
|
||
<span class="n">ordering</span> <span class="o">=</span> <span class="p">[</span><span class="s">'-field1'</span><span class="p">,</span> <span class="s">'field2'</span><span class="p">]</span>
|
||
<span class="n">verbose_name</span> <span class="o">=</span> <span class="s">'my class in singular'</span>
|
||
<span class="n">verbose_name_plural</span> <span class="o">=</span> <span class="s">'my class when is in a list!'</span></code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="olist arabic">
|
||
<ol class="arabic">
|
||
<li>
|
||
<p>Le titre:</p>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p>Soit en modifiant le template de l’administration</p>
|
||
</li>
|
||
<li>
|
||
<p>Soit en ajoutant l’assignation suivante dans le fichier <code>urls.py</code>: <code>admin.site.site_header = "SuperBook Secret Area</code>.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</li>
|
||
<li>
|
||
<p>Prefetch</p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p><a href="https://hackernoon.com/all-you-need-to-know-about-prefetching-in-django-f9068ebe1e60?gi=7da7b9d3ad64" class="bare">https://hackernoon.com/all-you-need-to-know-about-prefetching-in-django-f9068ebe1e60?gi=7da7b9d3ad64</a></p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p><a href="https://medium.com/@hakibenita/things-you-must-know-about-django-admin-as-your-app-gets-bigger-6be0b0ee9614" class="bare">https://medium.com/@hakibenita/things-you-must-know-about-django-admin-as-your-app-gets-bigger-6be0b0ee9614</a></p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>En gros, le problème de l’admin est que si on fait des requêtes imbriquées, on va flinguer l’application et le chargement de la page.
|
||
La solution consiste à utiliser la propriété <code>list_select_related</code> de la classe d’Admin, afin d’appliquer une jointure par défaut et
|
||
et gagner en performances.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="_go_live" class="sect0">Go Live !</h1>
|
||
<div class="sect1">
|
||
<h2 id="_supervision_des_logs">17. Supervision des logs</h2>
|
||
<div class="sectionbody">
|
||
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_feedbacks_utilisateurs">18. feedbacks utilisateurs</h2>
|
||
<div class="sectionbody">
|
||
|
||
</div>
|
||
</div>
|
||
<h1 id="_en_bonus" class="sect0">En bonus</h1>
|
||
<div class="sect1">
|
||
<h2 id="_snippets_utiles_et_forcément_dispensables">19. Snippets utiles (et forcément dispensables)</h2>
|
||
<div class="sectionbody">
|
||
<div class="sect2">
|
||
<h3 id="_récupération_du_dernier_tag_git_en_python">19.1. Récupération du dernier tag Git en Python</h3>
|
||
<div class="paragraph">
|
||
<p>L’idée ici est simplement de pouvoir afficher le numéro de version ou le hash d’exécution du code, sans avoir à se connecter au dépôt. Cela apporte une certaine transparence, <strong>sous réserve que le code soit géré par Git</strong>. Si vous suivez scrupuleusement les 12 facteurs, la version de l’application déployée n’est plus sensée conserver un lien avec votre dépôt d’origine…​ Si vous déployez votre code en utilisant un <code>git fetch</code> puis un <code>git checkout <tag_name></code>, le morceau de code ci-dessous pourra vous intéresser :-)</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="rouge highlight"><code data-lang="python"></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="footer">
|
||
<div id="footer-text">
|
||
Last updated 2020-02-14 21:13:40 +0100
|
||
</div>
|
||
</div>
|
||
<style>
|
||
pre.rouge table td { padding: 5px; }
|
||
pre.rouge table pre { margin: 0; }
|
||
pre.rouge .c, pre.rouge .ch, pre.rouge .cd, pre.rouge .cpf {
|
||
color: #75715e;
|
||
font-style: italic;
|
||
}
|
||
pre.rouge .cm {
|
||
color: #75715e;
|
||
font-style: italic;
|
||
}
|
||
pre.rouge .c1 {
|
||
color: #75715e;
|
||
font-style: italic;
|
||
}
|
||
pre.rouge .cp {
|
||
color: #75715e;
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .cs {
|
||
color: #75715e;
|
||
font-weight: bold;
|
||
font-style: italic;
|
||
}
|
||
pre.rouge .err {
|
||
color: #960050;
|
||
background-color: #1e0010;
|
||
}
|
||
pre.rouge .gi {
|
||
color: #ffffff;
|
||
background-color: #324932;
|
||
}
|
||
pre.rouge .gd {
|
||
color: #ffffff;
|
||
background-color: #493131;
|
||
}
|
||
pre.rouge .ge {
|
||
color: #000000;
|
||
font-style: italic;
|
||
}
|
||
pre.rouge .gr {
|
||
color: #aa0000;
|
||
}
|
||
pre.rouge .gt {
|
||
color: #aa0000;
|
||
}
|
||
pre.rouge .gh {
|
||
color: #999999;
|
||
}
|
||
pre.rouge .go {
|
||
color: #888888;
|
||
}
|
||
pre.rouge .gp {
|
||
color: #555555;
|
||
}
|
||
pre.rouge .gs {
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .gu {
|
||
color: #aaaaaa;
|
||
}
|
||
pre.rouge .k, pre.rouge .kv {
|
||
color: #66d9ef;
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .kc {
|
||
color: #66d9ef;
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .kd {
|
||
color: #66d9ef;
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .kp {
|
||
color: #66d9ef;
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .kr {
|
||
color: #66d9ef;
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .kt {
|
||
color: #66d9ef;
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .kn {
|
||
color: #f92672;
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .ow {
|
||
color: #f92672;
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .o {
|
||
color: #f92672;
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .mf {
|
||
color: #ae81ff;
|
||
}
|
||
pre.rouge .mh {
|
||
color: #ae81ff;
|
||
}
|
||
pre.rouge .il {
|
||
color: #ae81ff;
|
||
}
|
||
pre.rouge .mi {
|
||
color: #ae81ff;
|
||
}
|
||
pre.rouge .mo {
|
||
color: #ae81ff;
|
||
}
|
||
pre.rouge .m, pre.rouge .mb, pre.rouge .mx {
|
||
color: #ae81ff;
|
||
}
|
||
pre.rouge .se {
|
||
color: #ae81ff;
|
||
}
|
||
pre.rouge .sb {
|
||
color: #e6db74;
|
||
}
|
||
pre.rouge .sc {
|
||
color: #e6db74;
|
||
}
|
||
pre.rouge .sd {
|
||
color: #e6db74;
|
||
}
|
||
pre.rouge .s2 {
|
||
color: #e6db74;
|
||
}
|
||
pre.rouge .sh {
|
||
color: #e6db74;
|
||
}
|
||
pre.rouge .si {
|
||
color: #e6db74;
|
||
}
|
||
pre.rouge .sx {
|
||
color: #e6db74;
|
||
}
|
||
pre.rouge .sr {
|
||
color: #e6db74;
|
||
}
|
||
pre.rouge .s1 {
|
||
color: #e6db74;
|
||
}
|
||
pre.rouge .ss {
|
||
color: #e6db74;
|
||
}
|
||
pre.rouge .s, pre.rouge .sa, pre.rouge .dl {
|
||
color: #e6db74;
|
||
}
|
||
pre.rouge .na {
|
||
color: #a6e22e;
|
||
}
|
||
pre.rouge .nc {
|
||
color: #a6e22e;
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .nd {
|
||
color: #a6e22e;
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .ne {
|
||
color: #a6e22e;
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .nf, pre.rouge .fm {
|
||
color: #a6e22e;
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .no {
|
||
color: #66d9ef;
|
||
}
|
||
pre.rouge .bp {
|
||
color: #f8f8f2;
|
||
}
|
||
pre.rouge .nb {
|
||
color: #f8f8f2;
|
||
}
|
||
pre.rouge .ni {
|
||
color: #f8f8f2;
|
||
}
|
||
pre.rouge .nn {
|
||
color: #f8f8f2;
|
||
}
|
||
pre.rouge .vc {
|
||
color: #f8f8f2;
|
||
}
|
||
pre.rouge .vg {
|
||
color: #f8f8f2;
|
||
}
|
||
pre.rouge .vi {
|
||
color: #f8f8f2;
|
||
}
|
||
pre.rouge .nv, pre.rouge .vm {
|
||
color: #f8f8f2;
|
||
}
|
||
pre.rouge .w {
|
||
color: #f8f8f2;
|
||
}
|
||
pre.rouge .nl {
|
||
color: #f8f8f2;
|
||
font-weight: bold;
|
||
}
|
||
pre.rouge .nt {
|
||
color: #f92672;
|
||
}
|
||
pre.rouge {
|
||
color: #f8f8f2;
|
||
background-color: #49483e;
|
||
}
|
||
</style>
|
||
</body>
|
||
</html> |