root/rmll_workshops/zope3_interfaces/zope3_interfaces.txt

.. include:: <s5defs.txt>

====================================
L'architecture �omposants de Zope3
====================================

:Authors: Olivier Grisel <olivier@afpy.org>
:Date:    $Date: 2006-06-23$

.. class:: small

  Adaptation de `ce blog`_ de Jeff Shell

.. _`ce blog`: http://griddlenoise.blogspot.com/2005/12/zope-component-architecture-interfaces.html

.. class:: small

  * Interfaces et duck typing

  * Modularisation du code, l'approche composants

  * Branchements avec les adapteurs


.. container:: handout

    Ce tutorial pr�nte rapidement les concepts fondamentaux de
    l'architecture �ase de composant mise en place pour le d�loppement
    du serveur d'application Zope3

.. contents::
   :class: handout

.. |bullet| unicode:: U+02022
.. |mode| unicode:: U+00D8 .. capital o with stroke

.. footer:: Location |bullet| Date


Une histoire de canards
=======================

.. class:: incremental

  * Si ca fait coin comme un canard, alors c'est un canard

  * Et m� si c'est pas un vrai, ca m'est �l

  ::

    >>> from StringIO import StringIO
    >>> f = StringIO('data')
    >>> f.read()
    'data'

  * Contractualisation cette relation gr� �a notion d'interface

  * But formaliser les relations entre composants pour les rendre
    interchangeables


Les interfaces Zope3 (1/2)
==========================

.. class:: incremental

  * Histoire : Zope2 est bas�ur une architecture ancienne dans laquelle les
    objets sont rendus tr�puissants en (ab)usant de l'h�tage multiple

  * PBM : si on souhaite changer une classe parent, de grosse portion du code
    sont remises en question


Les interfaces Zope3 (2/2)
==========================

.. class:: incremental

  * R�ltat 1 : Zope2 a une architecture avec des couches s�mentaires qui rend
    le code rigide et difficilement refactorable

  * R�ltat 2 : Pour Zope3, besoin d'isoler les composants en les
    responsabilisant explicitement

  * Cons�ence : cr�ion du module ``zope.interface`` et de son associ�   ``zope.component``

  * Utilisables et utilis�en dehors de Zope3, par exemple:

    - twisted_

.. _twisted: http://twistedmatrix.com


Formalisons la canarditude (1/2)
================================

.. class:: incremental

  ::

    >>> from zope.interface import implements, providedBy, Interface
    >>> class IFaitCoinCoin(Interface):
    ...
    ...     def coin_coin():
    ...         """Retourne un son de coin coin"""
    ...

  ::

    >>> class Colvert(object):
    ...     implements(IFaitCoinCoin)
    ...
    ...     def coin_coin(self):
    ...         return 'En tant que colvert, je fais "coin ! coin !"'
    ...

Formalisons la canarditude (2/2)
================================

.. class:: incremental

  ::

     >>> bob = Colvert()
     >>> IFaitCoinCoin.providedBy(bob)
     True
     >>> print bob.coin_coin()
     En tant que colvert, je fais "coin ! coin !"


Les adapteurs
=============

.. class:: incremental

  * Impl�ntation du "design pattern" nomm�delegation"

  * Peut tr�souvent s'utiliser en lieu et place de l'h�tage

  * Adapte une (ou plusieurs) interface(s) source vers une interface cible

  * Sur un exemple, ca sera plus clair :)


La notion de chasseuritude
==========================

* Commencons par d�nir une seconde interface pour caract�ser le
  comportement d'un chasseur

.. class:: incremental

  ::

    >>> from zope.interface import Attribute
    >>> class IChasseur(Interface):
    ...
    ...     nom = Attribute("Le nom du chasseur")
    ...
    ...     def pan_pan(cible):
    ...       """Fait pan pan sur une cible"""


Le bien et le mal
=================

.. class:: handout

  Dans la vie, il y a deux types de chasseurs. Le mauvais est le plus simple
  �mpl�nter:

.. class:: incremental

  ::

    >>> class MauvaisChasseur(object):
    ...     implements(IChasseur)
    ...
    ...     def __init__(self, nom):
    ...         self.nom = nom
    ...
    ...     def pan_pan(self, cible):
    ...       print "pan ! pan !"
    ...       cible.coin_coin = lambda: "argl !"
    ...
    >>> tom = MauvaisChasseur('Tom')

  ::

    >>> IChasseur.providedBy(tom)
    True

  ::

    >>> IFaitCoinCoin.providedBy(tom)
    False


Et les adapteurs dans tout ca ?
===============================

.. class:: incremental

  * Le probl� du chasseur c'est qu'il voudrait se faire passer pour un canard

  * Premi� solution :

    .. class:: incremental

    - cr� une nouvelle classe ChasseurQuiFaitCoinCoin(MauvaisChasseur, Colvert)

    - c'est contre nature !

  * Deuxi� solution :

    .. class:: incremental

    - cr�ion d'un classe ``Appeau`` qui adapte ``IChasseur`` vers
      ``IFaitCoinCoin``


Adaptons
========

.. class:: incremental

  ::

    >>> from zope.component import adapts
    >>> class Appeau(object):
    ...     implements(IFaitCoinCoin)
    ...     adapts(IChasseur)
    ...
    ...     def __init__(self, chasseur):
    ...         self.chasseur = chasseur
    ...
    ...     def coin_coin(self):
    ...         return self.chasseur.nom + ' fait "coin ! coin!" avec son appeau'
    ...

  ::

    >>> from zope.component import provideAdapter
    >>> provideAdapter(Appeau)


Utilisation
===========

.. class:: incremental

  ::

     >>> IFaitCoinCoin(tom)
     <Appeau object at 0x...>

  ::

     >>> print IFaitCoinCoin(tom).coin_coin()
     Tom fait "coin ! coin!" avec son appeau


Exemple d'utilisation dans Zope3
================================

.. class:: incremental

  * Les vues sont des adapteurs sur des request et un context

  * Pour une requ� donn�et un objet publi�ans un certain context, on
    g�re un objet vue qui se charge du rendu HTML

  * Dans ce cas il s'agit d'un multi-adapter


Concr�ment, je dois installer quoi ?
======================================

.. class:: incremental

  * zope.interface

  * zope.component

  * Se trouvent ici : http://download.zope.org/distribution

  * Avec ``setuptools``, il est possible de r�udre cette d�ndance
    automatiquement:

  ::

    setup(
      ...
      install_requires=["zope.interface", "zope.component"],
      dependency_links=["http://download.zope.org/distribution"],
      )


Questions ?
===========