summaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
authorDamien George <damien@micropython.org>2025-01-22 15:13:13 +1100
committerDamien George <damien@micropython.org>2025-02-11 16:59:11 +1100
commite40a3fdb81fc7184e945754c06d42e169a296ab8 (patch)
tree4f154a218f19a796a96fcb8aa63d8a15172f6d27 /docs
parentc3a18d74ebebe1c68955c3dce3c782af949aa4c7 (diff)
downloadmicropython-e40a3fdb81fc7184e945754c06d42e169a296ab8.tar.gz
micropython-e40a3fdb81fc7184e945754c06d42e169a296ab8.zip
docs/library/marshal: Document the marshal module.
Signed-off-by: Damien George <damien@micropython.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/library/index.rst1
-rw-r--r--docs/library/marshal.rst28
2 files changed, 29 insertions, 0 deletions
diff --git a/docs/library/index.rst b/docs/library/index.rst
index 4209a0781a..2919378ce1 100644
--- a/docs/library/index.rst
+++ b/docs/library/index.rst
@@ -69,6 +69,7 @@ library.
heapq.rst
io.rst
json.rst
+ marshal.rst
math.rst
os.rst
platform.rst
diff --git a/docs/library/marshal.rst b/docs/library/marshal.rst
new file mode 100644
index 0000000000..6d3213e0a6
--- /dev/null
+++ b/docs/library/marshal.rst
@@ -0,0 +1,28 @@
+:mod:`marshal` -- Python object serialization
+=============================================
+
+.. module:: marshal
+ :synopsis: Convert Python objects to and from a binary format
+
+|see_cpython_module| :mod:`python:marshal`.
+
+This module implements conversion between Python objects and a binary format.
+The format is specific to MicroPython but does not depend on the machine
+architecture, so the data can be transferred and used on a different MicroPython
+instance, as long as the version of the binary data matches (it's currently
+versioned as the mpy file version, see :ref:`mpy_files`).
+
+Functions
+---------
+
+.. function:: dumps(value, /)
+
+ Convert the given *value* to binary format and return a corresponding ``bytes``
+ object.
+
+ Currently, code objects are the only supported values that can be converted.
+
+.. function:: loads(data, /)
+
+ Convert the given bytes-like *data* to its corresponding Python object, and
+ return it.