Changeset 112:aa4492e1f366 for JFP/slides.txt

Timestamp:

06/08/07 11:04:36 (15 months ago)

Author:

Tarek Ziad?? <tarek@…>

Message:

fixed apis

Files:

• JFP/slides.txt (modified) (5 diffs)

JFP/slides.txt

@@ -27 +27 @@
 - Expliquer comment les tests fonctionnent en Python
 - Sensibiliser les développeurs au **DDD**
-- Expliquer pourquoi le **reST** et les **doctests** c'est merveilleux
+- Expliquer pourquoi les **doctests** c'est merveilleux
 
 |important| En un mot: comment développer `agile` en Python
@@ -76 +76 @@
 
 - coder (-> TDD)
-- faire de la documentation (->DDD)
+- faire de la documentation (-> DDD)
 - passer la tondeuse
 - etc.
+
+Quelques définitions
+====================
+
+TDD == Test-Driven Development == Développement Dirigé par les Tests
 
 Le plan
@@ -255 +260 @@
 `unittest` fourni des outils pour l'écriture des tests:
 
-- une classe `TestCase`, pour les assertions et les `test fixture`;
+- une classe `TestCase`, pour les assertions et les `test fixture`
+  (environnement pour le test);
 - une classe `TestSuite`, pour créér des séquences de tests;
 - quelques fonctions pour lancer des *test campaign*.
@@ -359 +365 @@
     FAILED (failures=1)
 
-Comment écrire des tests
-========================
-
-.. figure:: media/magnum.jpg
-   :alt: "TDD with Python rocks" -- Magnum
+Partie 1
+========
+
+Pour aller plus loin:
+
+    -> Comment organiser les tests dans un projet Python
+
+
+Partie 1
+========
+
+Sans les tests:
+
+.. figure:: media/sleeping.jpg
    :align: center
    :height: 300
-   :width: 400
-
-   "Doing TDD with Python is so cool !" -- Magnum
+   :width: 300
 
 Partie 1
 ========
 
-Pour aller plus loin:
-
-    -> Comment organiser les tests dans un projet Python
-
-
-La mi-temps
-===========
-
-XXX mettre un truc drole
+Avec les tests:
+
+.. figure:: media/happy_1.jpg
+   :align: center
+   :height: 300
+   :width: 300
+
+Partie 1
+========
+
+Avec les tests:
+
+.. figure:: media/happy_2.gif
+   :align: center
+   :height: 300
+   :width: 200
 
 Le plan
@@ -388 +408 @@
 - `Quelques définitions`
 - `Partie 1: le TDD avec Python`
-- **Part 2: les doctests** |smile|
-- `Part 3: le DDD`
-
-
-XXXXXXXXX
-
-The plan
-========
-
-- `A few definitions`
-- `Part 1: doing TDD in Python`
-- **Part 2: writing documents in reST**
-- `Part 3: writing doctests`
-- `Part 4: doing DDD in Python`
-
-Part 2
-======
-
-Writing documents in reST
-
-- **What is reST ?**
-- `reST syntax overview`
-- `reST tools`
-
-What is reST ?
-==============
-
-reSTructuredText (say reSt to be hype) is:
-
-- a plaintext markup syntax and parser system
-- easy to read as-is, yet powerful
-- the Pythonistas laTeX
-- see http://docutils.sf.net
-
-What is reST ?
-==============
-
-Example::
-
-    ==================
-    I am the reST file
-    ==================
-
-    I am the first section
-    ======================
-
-    I am the content of the first section.
-    I have things to say.
-
-    I am the second section
-    =======================
-
-    I am, what I am, what I aammmm...
-
-What is reST ?
-==============
-
-Several remarks:
-
-- the reST syntax doesn't obfuscate the text
-- punctuation signs are used to underline section titles
-
-Part 2
-======
-
-Writing documents in reST
-
-- `What is reST ?`
-- **reST syntax overview**
-- `reST tools`
-
-reST syntax overview
-====================
-
-- punctuation signs to underline sections
-- text enhancements
-
-  - ``*emphasis*``
-  - ``**strong emphasis**``
-  - ```interpreted text```
-  - ````inline literal text````
-
-reST syntax overview
-====================
-
-- bullet list: use +, * or -
-- enumerated list: use n. (1., 2., etc.) or #. (automatic)
-
-Part 2
-======
-
-Writing documents in reST
-
-- `What is reST ?`
-- `reST syntax overview`
-- **reST tools**
-
-reST tools
+- **Partie 2: les doctests** |smile|
+- `Partie 3: le DDD`
+
+Partie 2
+========
+
+Les `doctests`
+
+- basés sur le principe du `literate programming` (KNUTH)
+- utilise le prompt Python
+
+Les doctests
+============
+
+Exemple de doctest `inline`::
+
+    def somme(a, b):
+        """ calcul la somme
+
+        >>> somme(1, 3)
+        4
+        >>> somme(2, 2)
+        4
+        """
+        return a + b
+
+
+Les doctests
+============
+
+|smile| Les exemples sont directement disponibles
+
+|sad| Le code devient dur à lire
+
+Les doctests
+============
+
+Solution: séparer les doctests dans un fichier texte
+
+- chaque module de code peut avoir son module de doctest
+- un script `execute` ces modules de tests
+
+Les doctests
+============
+
+Exemple de doctest séparé. Fichier *calc.py*::
+
+    def somme(a, b):
+        """ calcul la somme
+        """
+        return a + b
+
+Fichier *calc.txt*::
+
+    >>> from calc import somme
+    >>> somme(1, 3)
+    4
+    >>> somme(2, 2)
+    4
+
+Les doctests
+============
+
+Un fichier doctest devient un test unitaire grâce au module `doctest`::
+
+    import doctest
+    import unittest
+
+    def test_suite():
+        suite.append(doctest.DocFileTest('calc.txt'))
+        return unittest.TestSuite(suite)
+
+    if __name__ == '__main__':
+        unittest.main(defaultTest='test_suite')
+
+Les doctests
+============
+
+doctests + tests classiques == campagne de test
+
+Le plan
+=======
+
+- `Quelques définitions`
+- `Partie 1: le TDD avec Python`
+- `Partie 2: les doctests`
+- **Partie 3: le DDD** |smile|
+
+Partie 3
+========
+
+Le Document-Driven Development
+
+Principe:
+
+    Les doctests séparés peuvent `aussi` être des documents
+
+Documentation
+=============
+
+Chaque doctest == alternance de code et d'explications::
+
+    Module calc
+
+    Le module calc contient une fonction pour faire des sommes:
+
+        >>> from calc import somme
+
+    Cette fonction prends deux paramÚtres:
+
+        >>> somme(1, 3)
+        4
+        >>> somme(2, 2)
+        4
+
+Documentation
+=============
+
+|smile| Promiscuité de la documentation
+
+|smile| La documentation évolue en même temps que le code
+
+|smile| Le développeur utilise la doc. pour concevoir les tests
+
+|smile| La documentation du projet est conçue en partie par ce biais
+
+Documentation
+=============
+
+|important| Un doctest doit rester un document: ne pas le noyer dans des
+`test fixtures` (mise en place pour les tests)
+
+|important| Les doctests montrent des exemples **publics** de code
+
+|important| Les tests unitaires classiques s'occupent du reste
+
+Documentation
+=============
+
+-> Demo: construction d'un module de calcul
+
+
+Documentation
+=============
+
+Pour aller plus loin:
+
+-> utilisation du reSTructuredText dans les documents
+
+
+Conclusion
 ==========
 
-XXX
-
-Part 2
-======
-
-Writing documents in reST
-
-- `What is reST ?`
-- `reST syntax overview`
--  `reST tools`
-
-reST can be:
-
-- used for all documentation needs
-- manipulated like code (versioning, etc.)
-- easily transformed into various shapes
-
-Python developers |love| reST
-
-The plan
-========
-
-- `A few definitions`
-- `Part 1: doing TDD in Python`
-- `Part 2: writing documents in reST`
-- **Part 3: writing doctests**
-- `Part 4: doing DDD in Python`
-
-How to organise tests in a Python project
-=========================================
-
-By the way, how Python code is organized ?
-
-- a package == a folder with files
-- a module == a file with classes, functions and variables
-
-Each package comes with
-
-- a `doc` subfolder
-- a `tests` subfolder <--- let's put our unit tests here |wink|
-
-Following the TDD principles:
-
-- one code module <==> one test module
-
-How to organise tests in a Python project
-=========================================
-
-Our division package will look like this::
-
-    division
-       |
-       |-- division.py
-       |
-       |-- tests
-       |     |
-       |     |-- test_division.py
-       |
-       |--  doc
-             |
-             |-- division.txt <-- some cool doc
-
-Part 1
-======
-
-`Doing TDD in Python`
-
-- `The TDD principles`
-- `How to write tests in Python`
-- `How to organise tests in a Python project`
-
-
-Part 1
-======
-
-Mettre une photo de matrix
-
-"I now TDD in Python now" -- Neo, The Matrix
+Questions ?
+
+Ressources
+==========
+
+- http://docs.python.org (doctest et unittest)
+- http://programmation-python.org
+
+Ressources
+==========
+
+Sortie le 16 aout:
+
+.. figure:: media/guide.png
+   :align: center
+   :height: 300
+   :width: 200