21.23. "http.cookies" — gestion d'état pour HTTP
************************************************

**Code source :** Lib/http/cookies.py

======================================================================

Le module "http.cookies" définit des classes abstrayant le concept de
témoin web (cookie), un mécanisme de gestion d'état pour HTTP. Il
fournit une abstraction gérant des données textuelles et tout type de
données sérialisable comme valeur de témoin.

Auparavant, le module appliquait strictement les règles d'analyse
décrites dans les spécifications **RFC 2109** et **RFC 2068**. Entre
temps, il a été découvert que Internet Explorer 3.0 ne suit pas les
règles liées aux caractères précisées dans ces spécifications. De
plus, plusieurs navigateurs et serveurs dans leur versions récentes
ont assoupli les règles d'analyse quant à la gestion des témoins. En
conséquence, les règles d'analyse utilisées sont un peu moins strictes
que les spécifications initiales.

Les jeux de caractères "string.ascii_letters", "string.digits" et
"!#$%&'*+-.^_`|~:" définissent l'ensemble des caractères autorisés par
ce module pour le nom du témoin (comme "key").

Modifié dans la version 3.3: Ajouté « : » comme caractère autorisé
pour les noms de témoin.

Note:

  Quand un témoin invalide est rencontré, l'exception "CookieError"
  est levée. Si les données du témoin proviennent d'un navigateur il
  faut impérativement gérer les données invalides en attrapant
  "CookieError".

exception http.cookies.CookieError

   Exception levée pour cause d'incompatibilité avec la **RFC 2109**.
   Exemples : attributs incorrects, en-tête "Set-Cookie" incorrect,
   etc.

class http.cookies.BaseCookie([input])

   Cette classe définit un dictionnaire dont les clés sont des chaines
   de caractères et dont les valeurs sont des instances de "Morsel".
   Notez qu'à l'assignation d'une valeur à une clé, la valeur est
   transformée en "Morsel" contenant la clé et la valeur.

   Si l'argument *input* est donné, il est passé à la méthode
   "load()".

class http.cookies.SimpleCookie([input])

   This class derives from "BaseCookie" and overrides "value_decode()"
   and "value_encode()" to be the identity and "str()" respectively.

Voir aussi:

  Module "http.cookiejar"
     Gestion de témoins HTTP pour *clients* web.  Les modules
     "http.cookiejar" et "http.cookies" ne dépendent pas l'un de
     l'autre.

  **RFC 2109** - HTTP State Management Mechanism
     Spécification de gestion d'états implantée par ce module.


21.23.1. Objets *Cookie*
========================

BaseCookie.value_decode(val)

   Return a decoded value from a string representation. Return value
   can be any type. This method does nothing in "BaseCookie" --- it
   exists so it can be overridden.

BaseCookie.value_encode(val)

   Return an encoded value. *val* can be any type, but return value
   must be a string. This method does nothing in "BaseCookie" --- it
   exists so it can be overridden.

   Généralement, les méthodes "value_encode()" et "value_decode()"
   doivent être inverses l'une de l'autre, c'est-à-dire qu'en envoyant
   la sortie de l'un dans l'entrée de l'autre la valeur finale doit
   être égale à la valeur initiale.

BaseCookie.output(attrs=None, header='Set-Cookie:', sep='\r\n')

   Renvoie une représentation textuelle compatible avec les en-têtes
   HTTP. *attrs et *header* sont envoyés à la méthode "output()" de
   chaque classe "Morsel". *sep* est le séparateur à utiliser pour
   joindre les valeurs d'en-têtes. Sa valeur par défaut est "'\r\n'"
   (CRLF).

BaseCookie.js_output(attrs=None)

   Renvoie un extrait de code JavaScript qui, lorsque exécuté par un
   navigateur qui supporte le JavaScript, va fonctionner de la même
   manière que si les en-têtes HTTP avaient été envoyés.

   *attrs* a la même signification que dans la méthode "output()".

BaseCookie.load(rawdata)

   Si *rawdata* est une chaine de caractères, l'analyser comme étant
   un "HTTP_COOKIE" et ajouter les valeurs trouvées en tant que
   "Morsel"s. S'il s'agit d'un dictionnaire, cela est équivalent à :

      for k, v in rawdata.items():
          cookie[k] = v


21.23.2. Objets *Morsel*
========================

class http.cookies.Morsel

   Abstraction de paire clé / valeur, accompagnée d'attributs
   provenant de la spécification **RFC 2109**.

   Les objets *Morsel* sont des objets compatibles dictionnaire, dont
   l'ensemble des clés est fixe et égal aux attributs **RFC 2109**
   valides, qui sont

   * "expires"

   * "path"

   * "comment"

   * "domain"

   * "max-age"

   * "secure"

   * "version"

   * "httponly"

   L'attribut "httponly" spécifie que le témoin transféré dans les
   requêtes HTTP n'est pas accessible par le biais de JavaScript. Il
   s'agit d'une contremesure à certaines attaques de scripts inter-
   sites (*XSS*).

   Les clés ne sont pas sensibles à la casse, leur valeur par défaut
   est "''".

   Modifié dans la version 3.5: Dorénavant, "__eq__()" prend en compte
   "key" et "value".

Morsel.value

   La valeur du témoin.

   Obsolète depuis la version 3.5: assigning to "value"; use "set()"
   instead.

Morsel.coded_value

   La valeur codée du témoin. C'est celle qui doit être transférée.

   Obsolète depuis la version 3.5: assigning to "coded_value"; use
   "set()" instead.

Morsel.key

   Le nom du témoin.

   Obsolète depuis la version 3.5: assigning to "key"; use "set()"
   instead.

Morsel.set(key, value, coded_value)

   Assigne les attributs *key*, *value* et *coded_value*.

   Obsolète depuis la version 3.5: The undocumented *LegalChars*
   parameter is ignored and will be removed in a future version.

Morsel.isReservedKey(K)

   Renvoie si *K* est membre des clés d'un "Morsel".

Morsel.output(attrs=None, header='Set-Cookie:')

   Renvoie une représentation textuelle du *Morsel* compatible avec
   les en-têtes HTTP. Par défaut, tous les attributs sont inclus, à
   moins que *attrs* ne soit renseigné. Dans ce cas la valeur doit
   être une liste d'attributs à utiliser. Par défaut, *header* a la
   valeur ""Set-Cookie:"".

Morsel.js_output(attrs=None)

   Renvoie un extrait de code JavaScript qui, lorsque exécuté par un
   navigateur qui supporte le JavaScript, va fonctionner de la même
   manière que si les en-têtes HTTP avaient été envoyés.

   *attrs* a la même signification que dans la méthode "output()".

Morsel.OutputString(attrs=None)

   Renvoie une chaine de caractères représentant le *Morsel*, nettoyé
   de son contexte HTTP ou JavaScript.

   *attrs* a la même signification que dans la méthode "output()".

Morsel.update(values)

   Met à jour les valeurs du dictionnaire du *Morsel* avec les valeurs
   provenant du dictionnaire *values*.  Lève une erreur si une des
   clés n'est pas un attribut **RFC 2109** valide.

   Modifié dans la version 3.5: une erreur est levée pour les clés
   invalides.

Morsel.copy(value)

   Renvoie une copie superficielle de l'objet *Morsel*.

   Modifié dans la version 3.5: renvoie un objet *Morsel* au lieu d'un
   "dict".

Morsel.setdefault(key, value=None)

   Lève une erreur si la clé n'est pas un attribut **RFC 2109**
   valide, sinon fonctionne de la même manière que
   "dict.setdefault()".


21.23.3. Exemple
================

L'exemple suivant montre comment utiliser le module "http.cookies".

   >>> from http import cookies
   >>> C = cookies.SimpleCookie()
   >>> C["fig"] = "newton"
   >>> C["sugar"] = "wafer"
   >>> print(C) # generate HTTP headers
   Set-Cookie: fig=newton
   Set-Cookie: sugar=wafer
   >>> print(C.output()) # same thing
   Set-Cookie: fig=newton
   Set-Cookie: sugar=wafer
   >>> C = cookies.SimpleCookie()
   >>> C["rocky"] = "road"
   >>> C["rocky"]["path"] = "/cookie"
   >>> print(C.output(header="Cookie:"))
   Cookie: rocky=road; Path=/cookie
   >>> print(C.output(attrs=[], header="Cookie:"))
   Cookie: rocky=road
   >>> C = cookies.SimpleCookie()
   >>> C.load("chips=ahoy; vienna=finger") # load from a string (HTTP header)
   >>> print(C)
   Set-Cookie: chips=ahoy
   Set-Cookie: vienna=finger
   >>> C = cookies.SimpleCookie()
   >>> C.load('keebler="E=everybody; L=\\"Loves\\"; fudge=\\012;";')
   >>> print(C)
   Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=\012;"
   >>> C = cookies.SimpleCookie()
   >>> C["oreo"] = "doublestuff"
   >>> C["oreo"]["path"] = "/"
   >>> print(C)
   Set-Cookie: oreo=doublestuff; Path=/
   >>> C = cookies.SimpleCookie()
   >>> C["twix"] = "none for you"
   >>> C["twix"].value
   'none for you'
   >>> C = cookies.SimpleCookie()
   >>> C["number"] = 7 # equivalent to C["number"] = str(7)
   >>> C["string"] = "seven"
   >>> C["number"].value
   '7'
   >>> C["string"].value
   'seven'
   >>> print(C)
   Set-Cookie: number=7
   Set-Cookie: string=seven
