> **Источник:** https://python-all.ru/3.0/library/shelve.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

# `shelve` – сохранение объектов Python

«Полка» (shelf) – это постоянный объект, похожий на словарь. Отличие от баз данных «dbm» в том, что значения (не ключи!) в полке могут быть практически произвольными объектами Python – всем, что поддерживает модуль [`pickle`](https://python-all.ru/3.0/library/pickle.html#module-pickle). Сюда входят большинство экземпляров классов, рекурсивные типы данных и объекты, содержащие множество общих подобъектов. Ключи – обычные строки.

#### `[shelve.open]shelve.open(filename[, flag='c'[, protocol=None[, writeback=False]]])`

Открывает постоянный словарь. Указанное имя файла является базовым именем для базового файла базы данных. Как побочный эффект, к имени файла может быть добавлено расширение и может быть создано более одного файла. По умолчанию базовый файл базы данных открывается для чтения и записи. Необязательный параметр *flag* имеет ту же интерпретацию, что и параметр *flag* в функции [`dbm.open()`](https://python-all.ru/3.0/library/dbm.html#dbm.open).

По умолчанию для сериализации значений используются pickle версии 3. Версию протокола pickle можно указать с помощью параметра *протокол*.

По умолчанию изменения изменяемых записей постоянного словаря не сохраняются автоматически. Если необязательный параметр *writeback* установлен в *True*, все записи, к которым обращались, кешируются в памяти и записываются обратно при закрытии; это может упростить изменение изменяемых записей в постоянном словаре, но если обращаться к большому количеству записей, это может потреблять огромные объёмы памяти для кеша, а также сделать операцию закрытия очень медленной, поскольку все записи, к которым обращались, записываются обратно (нет способа определить, какие из этих записей изменяемые и какие были действительно изменены).

Объекты Shelve поддерживают все методы, поддерживаемые словарями. Это облегчает переход от скриптов, основанных на словарях, к тем, что требуют постоянного хранения.

Поддерживается один дополнительный метод:

#### `[shelve.Shelf.sync]Shelf.sync()`

Записывает обратно все записи из кеша, если словарь был открыт с

*writeback*

, установленным в

*True*

. Также очищает кеш и синхронизирует постоянный словарь на диске, если это возможно. Этот метод вызывается автоматически при закрытии словаря с помощью

`close()`

.

## Ограничения

>

- Выбор того, какой пакет базы данных будет использоваться (например, [`dbm.ndbm`](https://python-all.ru/3.0/library/dbm.html#module-dbm.ndbm) или [`dbm.gnu`](https://python-all.ru/3.0/library/dbm.html#module-dbm.gnu)), зависит от того, какой интерфейс доступен. Поэтому небезопасно открывать базу данных напрямую с помощью [`dbm`](https://python-all.ru/3.0/library/dbm.html#module-dbm). Кроме того, база данных, к сожалению, подвержена ограничениям [`dbm`](https://python-all.ru/3.0/library/dbm.html#module-dbm), если она используется – это означает, что (сериализованное (pickle) представление) объектов, хранящихся в базе данных, должно быть достаточно маленьким, и в редких случаях коллизии ключей могут привести к тому, что база данных откажется обновляться.
- В зависимости от реализации закрытие постоянного словаря может быть или не быть необходимым для сброса изменений на диск. Метод [`__del__()`](https://python-all.ru/3.0/reference/datamodel.html#object.__del__) класса [`Shelf`](https://python-all.ru/3.0/library/shelve.html#shelve.Shelf) вызывает метод `close()`, поэтому программисту обычно не нужно делать это явно.
- Модуль `shelve` не поддерживает *параллельный* доступ на чтение и запись к сохранённым объектам. (Одновременный доступ нескольких программ только на чтение безопасен.) Когда программа открыла хранилище для записи, никакая другая программа не должна открывать его для чтения или записи. Для решения этой проблемы можно использовать файловую блокировку Unix, но она различается в разных версиях Unix и требует знания используемой реализации базы данных.

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

Подкласс `collections.MutableMapping`, который хранит сериализованные (pickled) значения в объекте *dict*.

По умолчанию для сериализации значений используется версия 0 pickle. Версию протокола pickle можно указать через параметр *protocol*. См. документацию [`pickle`](https://python-all.ru/3.0/library/pickle.html#module-pickle) для обсуждения протоколов pickle.

Если параметр *writeback* равен `True`, объект будет хранить кэш всех полученных записей и записывать их обратно в *dict* при синхронизации и закрытии. Это позволяет естественным образом работать с изменяемыми записями, но может потреблять гораздо больше памяти и замедлить синхронизацию и закрытие.

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

Подкласс

[`Shelf`](https://python-all.ru/3.0/library/shelve.html#shelve.Shelf)

, который предоставляет методы

`first()`

,

[`next()`](https://python-all.ru/3.0/library/functions.html#next)

,

`previous()`

,

`last()`

и

`set_location()`

, доступные в модуле

`bsddb`

, но не в других модулях баз данных. Объект

*dict*

, передаваемый конструктору, должен поддерживать эти методы. Обычно это достигается вызовом одной из функций

`bsddb.hashopen()`

,

`bsddb.btopen()`

или

`bsddb.rnopen()`

. Необязательные параметры

*протокол*

и

*writeback*

имеют ту же интерпретацию, что и для класса

[`Shelf`](https://python-all.ru/3.0/library/shelve.html#shelve.Shelf)

.

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

Подкласс

[`Shelf`](https://python-all.ru/3.0/library/shelve.html#shelve.Shelf)

, который принимает имя файла

*filename*

вместо объекта, похожего на словарь. Базовый файл будет открыт с помощью

[`dbm.open()`](https://python-all.ru/3.0/library/dbm.html#dbm.open)

. По умолчанию файл будет создан и открыт для чтения и записи. Необязательный параметр

*flag*

имеет ту же интерпретацию, что и для функции

[`open()`](https://python-all.ru/3.0/library/functions.html#open)

. Необязательные параметры

*protocol*

и

*writeback*

имеют ту же интерпретацию, что и для класса

[`Shelf`](https://python-all.ru/3.0/library/shelve.html#shelve.Shelf)

.

## Пример

Обобщая интерфейс (`key` – строка, `data` – произвольный объект):

```python
import shelve

d = shelve.open(filename) # open -- файл может получить суффикс, добавленный низкоуровневой
                          # библиотекой

d[key] = data   # сохраняет данные по ключу (перезаписывает старые данные, если
                # используется существующий ключ)
data = d[key]   # извлечь копию данных по ключу (вызывает KeyError, если такого ключа нет)
                # такого ключа)
del d[key]      # удалить данные, хранящиеся по ключу (вызывает KeyError
                # если такого ключа нет)
flag = key in d   # true, если ключ существует
klist = d.keys() # список всех существующих ключей (медленно!)

# так как d был открыт БЕЗ writeback=True, внимание:
d['xx'] = range(4)  # это работает как ожидается, но...
d['xx'].append(5)   # *это не работает!* -- d['xx'] по-прежнему range(4)!!!

# открыв d без writeback=True, нужно писать код аккуратно:
temp = d['xx']      # извлекает копию
temp.append(5)      # изменяет копию
d['xx'] = temp      # сохраняет изменённую копию обратно для сохранения

# или, d=shelve.open(filename,writeback=True) позволил бы просто написать
# d['xx'].append(5) и это бы работало как ожидается, НО это также бы
# потребляло больше памяти и замедляло операцию d.close().

d.close()       # закрыть его
```

> **См. также**
>
> **Модуль [`dbm`](https://python-all.ru/3.0/library/dbm.html#module-dbm)**
>
> Общий интерфейс для баз данных типа
>
> `dbm`
>
> .
>
> **Модуль [`pickle`](https://python-all.ru/3.0/library/pickle.html#module-pickle)**
>
> Сериализация объектов, используемая модулем
>
> `shelve`
>
> .
>
> **Модуль `cPickle`**
>
> Высокопроизводительная версия
>
> [`pickle`](https://python-all.ru/3.0/library/pickle.html#module-pickle)
>
> .