# `marshal` — Internal Python object serialization

This module contains functions that can read and write Python values in a binary format. The format is specific to Python, but independent of machine architecture issues (e.g., you can write a Python value to a file on a PC, transport the file to a Mac, and read it back there). Details of the format are undocumented on purpose; it may change between Python versions (although it rarely does). [1]

This is not a general «persistence» module. For general persistence and transfer of Python objects through RPC calls, see the modules `pickle` and `shelve`. The `marshal` module exists mainly to support reading and writing the «pseudo-compiled» code for Python modules of `.pyc` files. Therefore, the Python maintainers reserve the right to modify the marshal format in backward incompatible ways should the need arise. The format of code objects is not compatible between Python versions, even if the version of the format is the same. De-serializing a code object in the incorrect Python version has undefined behavior. If you’re serializing and de-serializing Python objects, use the `pickle` module instead – the performance is comparable, version independence is guaranteed, and pickle supports a substantially wider range of objects than marshal.

Попередження

Модуль `marshal` не призначений для захисту від помилкових або зловмисно створених даних. Ніколи не скасовуйте дані, отримані з ненадійного або неавтентифікованого джерела.

Існують функції, які читають/записують файли, а також функції, що працюють з байтоподібними об’єктами.

Not all Python object types are supported; in general, only objects whose value is independent from a particular invocation of Python can be written and read by this module. The following types are supported:

- Numeric types: `int`, `bool`, `float`, `complex`.

- Strings (`str`) and `bytes`. Bytes-like objects like `bytearray` are marshalled as `bytes`.

- Containers: `tuple`, `list`, `set`, `frozenset`, and (since `version` 5), `slice`. It should be understood that these are supported only if the values contained therein are themselves supported. Recursive containers are supported since `version` 3.

- The singletons `None`, `Ellipsis` and `StopIteration`.

- `code` objects, if allow_code is true. See note above about version dependence.

Змінено в версії 3.4:

- Added format version 3, which supports marshalling recursive lists, sets and dictionaries.

- Added format version 4, which supports efficient representations of short strings.

Змінено в версії 3.14: Added format version 5, which allows marshalling slices.

Модуль визначає такі функції:

marshal.dump(value, file, version=version, /, *, allow_code=True)

  Запишіть значення у відкритий файл. Значення має бути підтримуваного типу. Файл має бути записуваним binary file.

  If the value has (or contains an object that has) an unsupported type, a `ValueError` exception is raised — but garbage data will also be written to the file. The object will not be properly read back by `load()`. Code objects are only supported if allow_code is true.

  Аргумент version вказує на формат даних, який має використовувати `damp` (див. нижче).

  Викликає подію аудиту `marshal.dumps` з аргументами `значення`, `версія`.

  Змінено в версії 3.13: Added the allow_code parameter.

marshal.load(file, /, *, allow_code=True)

  Read one value from the open file and return it. If no valid value is read (e.g. because the data has a different Python version’s incompatible marshal format), raise `EOFError`, `ValueError` or `TypeError`. Code objects are only supported if allow_code is true. The file must be a readable binary file.

  Викликає подію аудиту `marshal.load` без аргументів.

  Примітка

  Якщо об’єкт, що містить непідтримуваний тип, був маршалований за допомогою `dump()`, `load()` замінить `None` для типу, який не можна маршалювати.

  Змінено в версії 3.10: Цей виклик використовувався для виклику події аудиту `code.__new__` для кожного об’єкта коду. Тепер він викликає одну подію `marshal.load` для всієї операції завантаження.

  Змінено в версії 3.13: Added the allow_code parameter.

marshal.dumps(value, version=version, /, *, allow_code=True)

  Return the bytes object that would be written to a file by `dump(value, file)`. The value must be a supported type. Raise a `ValueError` exception if value has (or contains an object that has) an unsupported type. Code objects are only supported if allow_code is true.

  Аргумент version вказує формат даних, який мають використовувати `дампи` (див. нижче).

  Викликає подію аудиту `marshal.dumps` з аргументами `значення`, `версія`.

  Змінено в версії 3.13: Added the allow_code parameter.

marshal.loads(bytes, /, *, allow_code=True)

  Convert the bytes-like object to a value. If no valid value is found, raise `EOFError`, `ValueError` or `TypeError`. Code objects are only supported if allow_code is true. Extra bytes in the input are ignored.

  Викликає подію аудиту `marshal.loads` з аргументом `bytes`.

  Змінено в версії 3.10: Цей виклик використовувався для виклику події аудиту `code.__new__` для кожного об’єкта коду. Тепер він викликає одну подію `marshal.loads` для всієї операції завантаження.

  Змінено в версії 3.13: Added the allow_code parameter.

Крім того, визначено такі константи:

marshal.version

  Indicates the format that the module uses. Version 0 is the historical first version; subsequent versions add new features. Generally, a new version becomes the default when it is introduced.

  Version | Available since | New features
  --- | --- | ---
  1 | Python 2.4 | Sharing interned strings
  2 | Python 2.5 | Binary representation of floats
  3 | Python 3.4 | Support for object instancing and recursion
  4 | Python 3.4 | Efficient representation of short strings
  5 | Python 3.14 | Support for `slice` objects

Виноски

[1]

Назва цього модуля походить від певної термінології, яка використовується розробниками Modula-3 (серед інших), які використовують термін «маршалінг» для доставки даних у автономній формі. Строго кажучи, «маршалінг» означає перетворення деяких даних із внутрішньої форми у зовнішню (наприклад, у буфері RPC) і «демаршалінг» для зворотного процесу.