Changeset 105:6190de093e46 for JFP/slides.txt

Timestamp:

06/01/07 16:36:20 (18 months ago)

Author:

Tarek Ziad?? <tarek@…>

Message:

fin partie 1

Files:

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

JFP/slides.txt

@@ -1 @@
-=======
-RuPy'07
-=======
-
-Agile documentation in Python projects
+======
+JPF'07
+======
+
+Le Document-Driven Developpement (DDD)
 
 :Author: Tarek Ziadé <tarek@ziade.org>
@@ -11 +11 @@
 .. contents:
 
-How am I ?
-==========
-
-- Python developer since 2000
-- Core developer in Nuxeo CPS (Zope) for 3 years
-- Involved in Zope sprints
-- Author of
-
-  - a French book "Programmation Python" (Eyrolles, 2006)
-  - another one coming up this summer
-  - articles in magazines
-
-- Creator of AFPY (french speaking PUG)
-- CTO at Emencia, for a Python e-commerce framework
-
-What are the goals of this presentation ?
-=========================================
-
-The main goal is to understand how Agile documentation works in Python,
-through:
-
-- Understanding how Test-Driven Development works in Python
-
-- Discovering reStructuredText and doctests
-
-- Understanding how Document-Driven Developement works
-
-- Learning a few patterns
-
-What are the goals of this presentation ?
-=========================================
-
-My secret goal is to come to RuPy to see how Ruby works...
-
-The plan
+Qui suis-je ?
+=============
+
+- Développeur Python depuis 2000
+- Auteur d'articles et de livres sur Python
+- Président de l'AFPY
+- Passionné par les méthodologies **agiles**
+
+Pourquoi cette présentation?
+============================
+
+Objectifs:
+
+- Sensibiliser les développeurs aux tests
+- Expliquer comment les tests fonctionnent en Python
+- Sensibiliser les développeurs au **DDD**
+- Expliquer pourquoi le **reST** et les **doctests** c'est merveilleux
+
+|important| En un mot: comment développer `agile` en Python
+
+Pourquoi cette présentation?
+============================
+
+Objectifs secrets (ne pas montrer ce slide):
+
+- Ridiculiser Java
+- Déprimer les développeurs Ruby
+- Rendre les chefs de projet C# jaloux
+- Augmenter le nombre d'adhérents à l'association
+
+Le plan
+=======
+
+- **Quelques définitions** |smile|
+- `Partie 1: le TDD avec Python`
+- `Part 2: les doctests`
+- `Part 3: le DDD`
+
+Quelques définitions
+====================
+
+Que veux dire le mot **agile** ?
+
+Quelques définitions
+====================
+
+Tentative de définition appliqué au développement:
+
+**C'est une méthodologie de programmation qui permet de
+rester réactif aux fréquentes modifications d'une base
+de code**
+
+Viens de l'`Agile Manifesto` (http://agilemanifesto.org/ [#]_)
+
+- créé par le GoF (Beck, etc.) et co
+- XP est une méthode agile populaire
+
+.. [#] Le site ressemble à celui d'une secte, mais c'est une bonne secte |wink|
+
+Quelques définitions
+====================
+
+Les principes agiles peuvent s'appliquer à tout processus répétitif:
+
+- coder (-> TDD)
+- faire de la documentation (->DDD)
+- passer la tondeuse
+- etc.
+
+Le plan
+=======
+
+- `Quelques définitions`
+- **Partie 1: le TDD avec Python** |smile|
+- `Part 2: les doctests`
+- `Part 3: le DDD`
+
+Partie 1
 ========
 
-- **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`
-
-A few definitions
-=================
-
-What kind of documentation are we talking about ?
-
-A few definitions
-=================
-
-Technical documentation that helps to understand how a codebase
-works and how it can be used. This can be:
-
-- a document describing a package [1]_, a module [1]_ or a
-  serie of package
-- a glossary
-- a tutorial
-- a recipe
-
-.. [1] Python folders and files
-
-A few definitions
-=================
-
-What **Agile** means ?
-
-A few definitions
-=================
-
-**A lightweight process to stay reactive to frequent changes**
-
-- Comes from the Agile Manifesto
-
-  - http://agilemanifesto.org/ [#]_
-  - created by members of the GoF (Beck, etc.) and others
-  - XP is one popular agile method
-
-.. [#] The website looks a bit like some sect site but it's a good sect
-
-A few definitions
-=================
-
-Agile principles can be applied to any repeating process:
-
-- coding
-- documenting
-- lawn-mowing
-- etc.
-
-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 1
-======
-
-**Doing TDD in Python**
-
-This part is composed of:
-
-- **The TDD principles**
-- `How to write tests in Python`
-- `How to organise tests in a Python project`
-
-TDD Principles
-==============
-
-- Each function or method can have one or several sample use case
-- A sample use case == a test
-
-TDD Principles
-==============
-
-Example::
+**Le TDD avec Python**
+
+- **Les principes du TDD**
+- `Comment écrire des tests`
+
+Les principes du TDD
+====================
+
+- Chaque fonction == un ou plusieurs cas d'utilisation
+- Un cas d'utilisation == un test possible
+
+Les principes du TDD
+====================
+
+Exemple::
 
     >>> def division(a, b):
     ...     return a / b
 
-Let's test it !
+Essayons !
 ::
 
@@ -142 +117 @@
     ...         return 'OK'
     ...     else:
-    ...         return 'SHUT DOWN THE COMPUTER NOW !'
+    ...         return 'Le processeur est moisi'
     >>> test_division()
     'OK'
 
-TDD Principles
-==============
-
-Each use case tests one aspect of the code
-
-Let's try this one::
+Les principes du TDD
+====================
+
+Chaque test concerne un aspect du code.
+
+En voici un autre::
 
     >>> def test_division2():
@@ -157 +132 @@
     ...         return 'OK'
     ...     else:
-    ...         return 'I WANT ZERO'
+    ...         return "C'est discutable..."
     >>> test_division2()
     Traceback (most recent call last):
@@ -163 +138 @@
     ZeroDivisionError: integer division or modulo by zero
 
-TDD Principles
-==============
-
-The function fails, let's change it::
+Les principes du TDD
+====================
+
+Ca plante, changeons la fonction::
 
     >>> def division(a, b):
@@ -173 +148 @@
     ...     return a / b
 
-and rerun the test::
+relancons le test::
 
     >>> test_division2()
     'OK'
 
-TDD Principles
-==============
-
-- The tests now validate several use cases for the function
-- Running all those tests == test suite
-- The function is now tighted to its test suite
-
-TDD Principles
-==============
-
-Let's write the tests before the code::
+Les principes du TDD
+====================
+
+- Plusieurs cas testés pour la fonction
+- Lancer l'ensemble des tests == campagne de tests == `test suite`
+- La fonction est `mariée` à ses tests
+
+*Je change la fonction, je revalide les tests*
+
+Les principes du TDD
+====================
+
+Encore plus fort: le test est écrit `avant` le code::
 
     >>> def test_average():
@@ -200 +177 @@
     NameError: global name 'average' is not defined
 
-TDD Principles
-==============
-
-Now let's code `average`::
+Les principes du TDD
+====================
+
+Le code à présent::
 
     >>> def average(*args):
     ...     return sum(args) / len(args)
 
-And run the test again::
+Le test à nouveau::
 
     >>> test_average()
     'OK'
 
-- Tests should be written *before* the code
-- In the real world they are written at the same time |wink|
-
-TDD Principles
-==============
-
-TDD brings:
-
-- **Quality**
-
-  - the developers naturally review their code
-  - refactoring is made easier
-
-- **Non-regression**: all tests are run on every change
-- **A primer documentation**: reading tests helps understanding the code
-
-TDD Principles
-==============
-
-Jean-Charles says:
-
-    "Tests are a waste of time, just a toy for interpreted
-    languages"
-
-Bruce Eckel says:
-
-    "If it's not tested, it's broken"
-
-Bruce's the one who's right:
-
-- untested code does not last long
-- all metrics have proven you waste way more time
-  debugging untested code than writing tests
-
-Part 1
-======
-
-**Doing TDD in Python**
-
-- `The TDD principles`
-- **How to write tests in Python**
-- `How to organise tests in a Python project`
-
-How to write tests in Python
-============================
-
-Python is *battery included*. The standard library provides:
-
-- `unittest`: a JUnit-like test framework
-- `doctest`: a literate-programming-kind-of test tool
-
-|important| There are many other test framework projects  out there
-
-How to write tests in Python
-============================
-
-`unittest` provides helpers to write tests:
-
-- a `TestCase` class, that provides assertion methods and test fixture
-- a `TestSuite` class, to create a sequence of tests
-- a few functions to run a *test campaign*
-
-How to write tests in Python
-============================
-
-`TestCase` provides two things:
-
-- two methods to manage the `test fixture`
-
-  - setUp: runs when the test starts
-  - tearDown: runs when the tests stops
-
-- a serie of methods to make assertions:
+-> Les tests devraient être écrits *avant* le code
+
+-> Bien souvent ils le sont en même temps ou juste aprÚs
+
+
+Les principes du TDD
+====================
+
+Le TDD offre:
+
+- La **Qualité**
+
+  - les développeurs révisent naturellement leur code
+  - les refontes de code sont plus faciles
+
+- La **non-régression**: on relance les tests à chaque modification
+- **Une documentation de base**: lire les tests aide à comprendre le code
+
+Les principes du TDD
+====================
+
+Jean-Charles dit:
+
+    "Les tests. Quelle perte de temps. C'est juste un jouet
+    pour les langages interprétés"
+
+Bruce Eckel dit:
+
+    *"If it's not tested, it's broken"*
+
+Les principes du TDD
+====================
+
+Bruce a raison.
+
+- Le code non-testé est voué à mourir
+- Toutes les mesures ont prouvé que l'on passe
+  plus de temps à débugguer du code non-testé qu'à écrire
+  les tests.
+- Un compilateur valide la syntaxe, pas le fonctionnement.
+
+Partie 1
+========
+
+**Le TDD avec Python**
+
+- `Les principes du TDD`
+- **Comment écrire des tests**
+
+
+Comment écrire des tests
+========================
+
+Python est *batteries included*. On y trouve:
+
+- `unittest`: un framework de test à la **JUnit**
+- `doctest`: un outil de tests à la **literate-programming-un-peu**
+
+|important| Il existe plein d'autres outils tiers de tests
+
+Comment écrire des tests
+========================
+
+`unittest` fourni des outils pour l'écriture des tests:
+
+- une classe `TestCase`, pour les assertions et les `test fixture`;
+- une classe `TestSuite`, pour créér des séquences de tests;
+- quelques fonctions pour lancer des *test campaign*.
+
+Comment écrire des tests
+========================
+
+`TestCase` fourni:
+
+- deux méthodes pour les `test fixture`
+
+  - setUp: au début du test
+  - tearDown: aprÚs le test
+
+- des méhodes pour les assertions:
 
   - ``assert_``
@@ -292 +276 @@
   - etc..
 
-How to write tests in Python
-============================
-
-Writing a test case == deriving from `TestCase`::
+Comment écrire des tests
+========================
+
+Ecrire une suite de tests == dériver de `TestCase`::
 
     >>> import unittest
@@ -307 +291 @@
     ...
 
-Each test is a method with a `test` prefix.
-
-How to write tests in Python
-============================
-
-The test can be:
-
-- saved into a file (e.g. a module)
-- added to a `test suite` (e.g. a `TestSuite` class)
-- run with a default `runner` provided (e.g. the `main` function)
-
-How to write tests in Python
-============================
-
-Example of test module::
+Un test == une méthode préfixée de `test`
+
+Comment écrire des tests
+========================
+
+Les tests peuvent être:
+
+- sauvegardés dans des fichiers (e.g. un module)
+- ajoutés à un `test suite` (e.g. une classe `TestSuite`)
+- lancés par un `runner` fourni par défaut (e.g. la fonction `main`)
+
+Comment écrire des tests
+========================
+
+Exemple de module::
 
     import unittest
@@ -342 +326 @@
         unittest.main(defaultTest='test_suite')
 
-How to write tests in Python
-============================
-
-Running the tests with the Python interpreter::
-
+
+Comment écrire des tests
+========================
+
+Lancement des tests::
 
     dabox:~ tarek$ python test_division.py
@@ -355 +339 @@
     OK
 
-How to write tests in Python
-============================
-
-Running the tests with the Python interpreter, with a failure::
+Comment écrire des tests
+========================
+
+Lancement des tests, avec une erreur::
 
     dabox:~ tarek$ python test_division.py
@@ -375 +359 @@
     FAILED (failures=1)
 
-How to write tests in Python
-============================
-
+Comment écrire des tests
+========================
 
 .. figure:: media/magnum.jpg
@@ -387 +370 @@
    "Doing TDD with Python is so cool !" -- Magnum
 
-Part 1
-======
-
-**Doing TDD in Python**
-
-- `The TDD principles`
-- `How to write tests in Python`
-- **How to organise tests in a Python project**
+Partie 1
+========
+
+Pour aller plus loin:
+
+    -> Comment organiser les tests dans un projet Python
+
+
+La mi-temps
+===========
+
+XXX mettre un truc drole
+
+Le plan
+=======
+
+- `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
+==========
+
+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
@@ -447 +567 @@
 "I now TDD in Python now" -- Neo, The Matrix
 
-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
-==========
-
-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`
-
 
 .. |wink| image:: media/wink.png