# 11.4. `shelve` — Objet Python persistant

Code source : Lib/shelve.py

Un shelf est un objet persistant, dictionnaire-compatible. La différence avec les bases de données dbm est que les valeurs (pas les clés !) dans un shelf 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)

  Open a persistent dictionary. The filename specified is the base filename for the underlying database. As a side-effect, an extension may be added to the filename and more than one file may be created. By default, the underlying database file is opened for reading and writing. The optional flag parameter has the same interpretation as the flag parameter of `anydbm.open()`.

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

  Modifié dans la version 2.3: The protocol parameter was added.

  À cause de la sémantique Python, un shelf ne peut pas savoir lorsqu’une entrée modifiable de dictionnaire persistant est modifiée. Par défaut les objets modifiés sont écrits seulement lorsqu’ils sont assignés à une shelf (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).

  Like file objects, shelve objects should be closed explicitly to ensure that the persistent data is flushed to disk.

Avertissement

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

Shelf objects support most of the methods supported by dictionaries. This eases the transition from dictionary based scripts to those requiring persistent storage.

Note, the Python 3 transition methods (`viewkeys()`, `viewvalues()`, and `viewitems()`) are not supported.

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

`Shelf.``sync`()

  Réécrit toutes les entrées dans le cache si le shelf a été ouvert avec writeback passé à `True`. Vide le cache et synchronise le dictionnaire persistant sur le disque, si faisable. Elle est appelée automatiquement quand le shelf est fermé avec `close()`.

`Shelf.``close`()

  Synchronise et ferme l’objet dict persistant. Les opérations sur un shelf fermé é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.

## 11.4.1. Limites

- The choice of which database package will be used (such as `dbm`, `gdbm` or `bsddb`) depends on which interface is available. Therefore it is not safe to open the database directly using `dbm`. The database is also (unfortunately) subject to the limitations of `dbm`, if it is used — this means that (the pickled representation of) the objects stored in the database should be fairly small, and in rare cases key collisions may cause the database to refuse updates.

- 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 un shelf ouvert en écriture, aucun autre programme ne doit l’avoir ouvert en écriture ou lecture. Le verrouillage des fichier 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.

class `shelve.``Shelf`(dict, protocol=None, writeback=False)

  A subclass of `UserDict.DictMixin` which stores pickled values in the dict object.

  By default, version 0 pickles 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.

  Modifié dans la version 2.3: The protocol parameter was added.

  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 modifiables, mais peut consommer beaucoup plus de mémoire et rendre les temps de synchronisation et de fermeture très longs.

class `shelve.``BsdDbShelf`(dict, protocol=None, writeback=False)

  A subclass of `Shelf` which exposes `first()`, `next()`, `previous()`, `last()` and `set_location()` which are available in the `bsddb` module 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 and writeback parameters have the same interpretation as for the `Shelf` class.

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

  A subclass of `Shelf` which accepts a filename instead of a dict-like object. The underlying file will be opened using `anydbm.open()`. By default, the file will be created and opened for both read and write. The optional flag parameter has the same interpretation as for the `open()` function. The optional protocol and writeback parameters have the same interpretation as for the `Shelf` class.

## 11.4.2. 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 = d.has_key(key)   # true if the key exists
    klist = d.keys() # a list of all existing keys (slow!)

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

    # 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 `anydbm`

  Generic interface to `dbm`-style databases.

Module `bsddb`

  BSD `db` database interface.

Module `dbhash`

  Thin layer around the `bsddb` which provides an `open()` function like the other database modules.

Module `dbm`

  Standard Unix database interface.

Module `dumbdbm`

  Portable implementation of the `dbm` interface.

Module `gdbm`

  GNU database interface, based on the `dbm` interface.

Module `pickle`

  Sérialisation d’objet utilisé par `shelve`.

Module `cPickle`

  High-performance version of `pickle`.