"shelve" — Persistance d’un objet Python
****************************************

**Code source :** Lib/shelve.py

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

Une étagère (*shelf* en anglais) est un objet persistant similaire à
un dictionnaire. La différence avec les bases de données *dbm* est que
les valeurs (pas les clés !) dans une étagère peuvent être des objets
Python arbitraires — n'importe quoi que le module "pickle" peut gérer.
Cela inclut la plupart des instances de classe, des types de données
récursives, et les objets contenant beaucoup de sous-objets partagés.
Les clés sont des chaînes de caractères ordinaires.

shelve.open(filename, flag='c', protocol=None, writeback=False)

   Ouvre un dictionnaire persistant. Le nom de fichier spécifié est le
   nom de fichier sans (son) extension pour la base de données sous-
   jacente. Comme effet de bord, une extension peut être ajoutée au
   nom de fichier et plus d'un fichier peut être créé. Par défaut, le
   fichier de base de données sous-jacente est ouvert en lecture et en
   écriture. Le paramètre optionnel *flag* possède la même
   interprétation que le paramètre *flag* de "dbm.open()".

   By default, pickles created with "pickle.DEFAULT_PROTOCOL" are used
   to serialize values.  The version of the pickle protocol can be
   specified with the *protocol* parameter.

   À cause de la sémantique de Python, une étagère ne peut pas savoir
   lorsqu'une entrée mutable de dictionnaire persistant est modifiée.
   Par défaut les objets modifiés sont écrits *seulement* lorsqu'ils
   sont assignés à une étagère (voir Exemple). Si le paramètre
   optionnel *writeback* est mis à "True", toutes les entrées déjà
   accédées sont aussi mises en cache en mémoire, et ré-écrites sur
   "sync()" et "close()" ; cela peut faciliter la modification des
   entrées modifiables dans le dictionnaire persistant, mais, si vous
   accédez à beaucoup d'entrées, cela peut consommer beaucoup de
   mémoire cache, et cela peut rendre l'opération de fermeture très
   lente puisque toutes les entrées déjà accédées sont ré-écrites (il
   n'y a aucun moyen de savoir quelles entrées déjà accédées sont
   mutables, ni lesquelles ont été vraiment modifiées).

   Modifié dans la version 3.10: "pickle.DEFAULT_PROTOCOL" is now used
   as the default pickle protocol.

   Modifié dans la version 3.11: Accepts *path-like object* for
   filename.

   Note:

     Ne pas se fier à la fermeture automatique de l’étagère ; appelez
     toujours "close()" explicitement quand vous n'en avez plus
     besoin, ou utilisez "shelve.open()" comme un gestionnaire de
     contexte :

        with shelve.open('spam') as db:
            db['eggs'] = 'eggs'

Avertissement:

  Puisque le module "shelve" utilise en arrière plan "pickle", il
  n'est pas sûr de charger une étagère depuis une source non fiable.
  Comme avec *pickle*, charger une étagère peut exécuter du code
  arbitraire.

Les objets d’étagère gèrent la plupart des méthodes et opérations des
dictionnaires (à l’exception de la copie, des constructeurs et des
opérateurs "|" et "|="). Cela facilite la transition depuis les
scripts utilisant des dictionnaires vers ceux nécessitant un stockage
persistant.

Deux méthodes supplémentaires sont autorisées :

Shelf.sync()

   Réécrit toutes les entrées dans le cache si l’étagère a été ouverte
   avec *writeback* passé à "True". Vide le cache et synchronise le
   dictionnaire persistant sur le disque, si faisable. Elle est
   appelée automatiquement quand l’étagère est fermée avec "close()".

Shelf.close()

   Synchronise et ferme l'objet *dict* persistant. Les opérations sur
   une étagère fermée échouent avec une "ValueError".

Voir aussi:

  Recette pour un dictionnaire persistant avec un large panel de
  formats de stockage et ayant la vitesse des dictionnaires natifs.


Limites
=======

* Le choix du paquet de base de données à utiliser (comme "dbm.ndbm"
  ou "dbm.gnu") dépend de l'interface disponible. Donc c'est risqué
  d'ouvrir la base de données directement en utilisant "dbm". La base
  de données est également (malheureusement) sujette à des limitations
  de "dbm", si c'est utilisé — cela signifie que (la représentation
  sérialisée de) l'objet stocké dans la base de données doit être
  assez petit et, dans de rares cas, des collisions de clés peuvent
  entraîner le refus de mises à jour de la base de données.

* Le module "shelve" ne gère pas l'accès *concurrent* en
  lecture/écriture sur les objets stockés (les accès simultanés en
  lecture sont sûrs). Lorsqu'un programme a une étagère ouverte en
  écriture, aucun autre programme ne doit l'avoir ouverte en écriture
  ou lecture. Le verrouillage des fichiers Unix peut être utilisé pour
  résoudre ce problème, mais cela dépend de la version Unix et
  nécessite des connaissances à propos de l'implémentation de la base
  de données utilisée.

* On macOS "dbm.ndbm" can silently corrupt the database file on
  updates, which can cause hard crashes when trying to read from the
  database.

class shelve.Shelf(dict, protocol=None, writeback=False, keyencoding='utf-8')

   Sous-classe de "collections.abc.MutableMapping" qui stocke les
   valeurs sérialisées dans l'objet *dict*.

   By default, pickles created with "pickle.DEFAULT_PROTOCOL" are used
   to serialize values.  The version of the pickle protocol can be
   specified with the *protocol* parameter.  See the "pickle"
   documentation for a discussion of the pickle protocols.

   Si le paramètre *writeback* est "True", l'objet garde en cache
   toutes les entrées accédées et les écrit dans le *dict* aux moments
   de synchronisation et de fermeture. Cela permet des opérations
   naturelles sur les entrées mutables, mais peut consommer beaucoup
   plus de mémoire et rendre les temps de synchronisation et de
   fermeture très longs.

   Le paramètre *keyencoding* est l'encodage utilisé pour encoder les
   clés avant qu'elles soient utilisées avec le dictionnaire sous-
   jacent.

   Un objet "Shelf" peut également être utilisé comme un gestionnaire
   de contexte ; il est automatiquement fermé lorsque le bloc "with"
   se termine.

   Modifié dans la version 3.2: Ajout du paramètre *keyencoding* ;
   précédemment, les clés étaient toujours encodées en UTF-8.

   Modifié dans la version 3.4: Ajout de la gestion des gestionnaires
   de contexte.

   Modifié dans la version 3.10: "pickle.DEFAULT_PROTOCOL" is now used
   as the default pickle protocol.

class shelve.BsdDbShelf(dict, protocol=None, writeback=False, keyencoding='utf-8')

   A subclass of "Shelf" which exposes "first()", "next()",
   "previous()", "last()" and "set_location()" methods. These are
   available in the third-party "bsddb" module from pybsddb but not in
   other database modules.  The *dict* object passed to the
   constructor must support those methods.  This is generally
   accomplished by calling one of "bsddb.hashopen()", "bsddb.btopen()"
   or "bsddb.rnopen()".  The optional *protocol*, *writeback*, and
   *keyencoding* parameters have the same interpretation as for the
   "Shelf" class.

class shelve.DbfilenameShelf(filename, flag='c', protocol=None, writeback=False)

   Sous-classe de "Shelf" qui accepte un *filename* au lieu d'un objet
   dictionnaire-compatible. Le fichier sous-jacent est ouvert avec
   "dbm.open()". Par défaut le fichier est créé en lecture et en
   écriture. Le paramètre optionnel *flag* peut être interprété de la
   même manière que pour la fonction "open()". Les paramètres
   optionnels *protocol* et *writeback* s'interprètent de la même
   manière que pour la classe "Shelf".


Exemple
=======

Pour résumer l'interface ("key" est une chaîne de caractère, "data"
est un objet arbitraire) :

   import shelve

   d = shelve.open(filename)  # open -- file may get suffix added by low-level
                              # library

   d[key] = data              # store data at key (overwrites old data if
                              # using an existing key)
   data = d[key]              # retrieve a COPY of data at key (raise KeyError
                              # if no such key)
   del d[key]                 # delete data stored at key (raises KeyError
                              # if no such key)

   flag = key in d            # true if the key exists
   klist = list(d.keys())     # a list of all existing keys (slow!)

   # as d was opened WITHOUT writeback=True, beware:
   d['xx'] = [0, 1, 2]        # this works as expected, but...
   d['xx'].append(3)          # *this doesn't!* -- d['xx'] is STILL [0, 1, 2]!

   # having opened d without writeback=True, you need to code carefully:
   temp = d['xx']             # extracts the copy
   temp.append(5)             # mutates the copy
   d['xx'] = temp             # stores the copy right back, to persist it

   # or, d=shelve.open(filename,writeback=True) would let you just code
   # d['xx'].append(5) and have it work as expected, BUT it would also
   # consume more memory and make the d.close() operation slower.

   d.close()                  # close it

Voir aussi:

  Module "dbm"
     Interface générique de base de données dans le style de "dbm".

  Module "pickle"
     Sérialisation d'objet utilisé par "shelve".
