micropython/docs/library/struct.rst

:mod:`struct` -- pack and unpack primitive data types
=====================================================

.. module:: struct
   :synopsis: pack and unpack primitive data types

|see_cpython_module| :mod:`python:struct`.

Supported size/byte order prefixes: ``@``, ``<``, ``>``, ``!``.

Supported format codes: ``b``, ``B``, ``h``, ``H``, ``i``, ``I``, ``l``,
``L``, ``q``, ``Q``, ``s``, ``P``, ``f``, ``d`` (the latter 2 depending
on the floating-point support).

.. admonition:: Difference to CPython
   :class: attention

   Whitespace is not supported in format strings.

Functions
---------

.. function:: calcsize(fmt)

   Return the number of bytes needed to store the given *fmt*.

.. function:: pack(fmt, v1, v2, ...)

   Pack the values *v1*, *v2*, ... according to the format string *fmt*.
   The return value is a bytes object encoding the values.

.. function:: pack_into(fmt, buffer, offset, v1, v2, ...)

   Pack the values *v1*, *v2*, ... according to the format string *fmt*
   into a *buffer* starting at *offset*. *offset* may be negative to count
   from the end of *buffer*.

.. function:: unpack(fmt, data)

   Unpack from the *data* according to the format string *fmt*.
   The return value is a tuple of the unpacked values.

.. function:: unpack_from(fmt, data, offset=0, /)

   Unpack from the *data* starting at *offset* according to the format string
   *fmt*. *offset* may be negative to count from the end of *buffer*. The return
   value is a tuple of the unpacked values.
docs: Replace ufoo with foo in all docs. Anywhere a module is mentioned, use its "non-u" name for consistency. The "import module" vs "import umodule" is something of a FAQ, and this commit intends to help clear that up. As a first approximation MicroPython is Python, and so imports should work the same as Python and use the same name, to a first approximation. The u-version of a module is a detail that can be learned later on, when the user wants to understand more and have finer control over importing. Existing Python code should just work, as much as it is possible to do that within the constraints of embedded systems, and the MicroPython documentation should match the idiomatic way to write Python code. With universal weak links for modules (via MICROPY_MODULE_WEAK_LINKS) users can consistently use "import foo" across all ports (with the exception of the minimal ports). And the ability to override/extend via "foo.py" continues to work well. Signed-off-by: Jim Mussared <jim.mussared@gmail.com> 2021-08-12 04:59:29 +01:00			:mod:`struct` -- pack and unpack primitive data types
			`=====================================================`
docs: Make custom index page; add more docs. 2014-11-02 23:37:02 +00:00
docs: Replace ufoo with foo in all docs. Anywhere a module is mentioned, use its "non-u" name for consistency. The "import module" vs "import umodule" is something of a FAQ, and this commit intends to help clear that up. As a first approximation MicroPython is Python, and so imports should work the same as Python and use the same name, to a first approximation. The u-version of a module is a detail that can be learned later on, when the user wants to understand more and have finer control over importing. Existing Python code should just work, as much as it is possible to do that within the constraints of embedded systems, and the MicroPython documentation should match the idiomatic way to write Python code. With universal weak links for modules (via MICROPY_MODULE_WEAK_LINKS) users can consistently use "import foo" across all ports (with the exception of the minimal ports). And the ability to override/extend via "foo.py" continues to work well. Signed-off-by: Jim Mussared <jim.mussared@gmail.com> 2021-08-12 04:59:29 +01:00			`.. module:: struct`
docs: Make custom index page; add more docs. 2014-11-02 23:37:02 +00:00			`:synopsis: pack and unpack primitive data types`

docs/library: Add CPython docs xref to each pertinent module. Cross-reference text/link is implemented as RST substitution, so easy to consistently. 2017-07-02 13:37:31 +01:00			\|see_cpython_module\| :mod:`python:struct`.
docs: Make custom index page; add more docs. 2014-11-02 23:37:02 +00:00
docs/ustruct: Describe supported type codes. 2016-05-14 18:48:43 +01:00			Supported size/byte order prefixes: ``@``, ``<``, ``>``, ``!``.

			Supported format codes: ``b``, ``B``, ``h``, ``H``, ``i``, ``I``, ``l``,
			``L``, ``q``, ``Q``, ``s``, ``P``, ``f``, ``d`` (the latter 2 depending
			`on the floating-point support).`

docs/library: Warn that ustruct doesn't handle spaces in format strings. And also add a test to capture the CPython difference. 2019-08-05 12:09:14 +01:00			`.. admonition:: Difference to CPython`
			`:class: attention`

			`Whitespace is not supported in format strings.`

docs: Make custom index page; add more docs. 2014-11-02 23:37:02 +00:00			`Functions`
			`---------`

			`.. function:: calcsize(fmt)`

docs/{uselect,ussl,ustruct}: Use markup adhering to latest docs conventions. 2017-06-29 22:34:52 +01:00			`Return the number of bytes needed to store the given fmt.`
docs: Make custom index page; add more docs. 2014-11-02 23:37:02 +00:00
			`.. function:: pack(fmt, v1, v2, ...)`

docs/{uselect,ussl,ustruct}: Use markup adhering to latest docs conventions. 2017-06-29 22:34:52 +01:00			`Pack the values v1, v2, ... according to the format string fmt.`
docs: Make custom index page; add more docs. 2014-11-02 23:37:02 +00:00			`The return value is a bytes object encoding the values.`

docs/ustruct: Document pack_into(), unpack_from(). 2016-05-01 11:17:07 +01:00			`.. function:: pack_into(fmt, buffer, offset, v1, v2, ...)`

docs/{uselect,ussl,ustruct}: Use markup adhering to latest docs conventions. 2017-06-29 22:34:52 +01:00			`Pack the values v1, v2, ... according to the format string fmt`
			`into a buffer starting at offset. offset may be negative to count`
			`from the end of buffer.`
docs/ustruct: Document pack_into(), unpack_from(). 2016-05-01 11:17:07 +01:00
docs: Make custom index page; add more docs. 2014-11-02 23:37:02 +00:00			`.. function:: unpack(fmt, data)`

docs/{uselect,ussl,ustruct}: Use markup adhering to latest docs conventions. 2017-06-29 22:34:52 +01:00			`Unpack from the data according to the format string fmt.`
docs: Make custom index page; add more docs. 2014-11-02 23:37:02 +00:00			`The return value is a tuple of the unpacked values.`
docs/ustruct: Document pack_into(), unpack_from(). 2016-05-01 11:17:07 +01:00
docs/library: Add / to indicate positional-only args in library docs. Removes the confusion of positional-only arguments which have defaults that look like keyword arguments. 2020-01-11 06:44:17 +00:00			`.. function:: unpack_from(fmt, data, offset=0, /)`
docs/ustruct: Document pack_into(), unpack_from(). 2016-05-01 11:17:07 +01:00
docs/{uselect,ussl,ustruct}: Use markup adhering to latest docs conventions. 2017-06-29 22:34:52 +01:00			`Unpack from the data starting at offset according to the format string`
			`fmt. offset may be negative to count from the end of buffer. The return`
docs/ustruct: Document pack_into(), unpack_from(). 2016-05-01 11:17:07 +01:00			`value is a tuple of the unpacked values.`