:mod:`msgpack`
==============

.. py:module:: msgpack

.. autoapi-nested-parse::

   Pack object in msgpack format

   The msgpack format is similar to json, except that the encoded data is binary.
   See https://msgpack.org for details. The module implements a subset of the cpython
   module msgpack-python.

   Not implemented: 64-bit int, uint, float.

   Example 1::

      import msgpack
      from io import BytesIO

      b = BytesIO()
      msgpack.pack({'list': [True, False, None, 1, 3.14], 'str': 'blah'}, b)
      b.seek(0)
      print(msgpack.unpack(b))

   Example 2: handling objects::

      from msgpack import pack, unpack, ExtType
      from io import BytesIO

      class MyClass:
          def __init__(self, val):
              self.value = val
          def __str__(self):
              return str(self.value)

      data = MyClass(b'my_value')

      def encoder(obj):
          if isinstance(obj, MyClass):
              return ExtType(1, obj.value)
          return f"no encoder for {obj}"

      def decoder(code, data):
          if code == 1:
              return MyClass(data)
          return f"no decoder for type {code}"

      buffer = BytesIO()
      pack(data, buffer, default=encoder)
      buffer.seek(0)
      decoded = unpack(buffer, ext_hook=decoder)
      print(f"{data} -> {buffer.getvalue()} -> {decoded}")



.. raw:: html

    <p>
    <details>
    <summary>Available on these boards</summary>
    <ul>
    <li> AITHinker ESP32-C3S_Kit
    <li> ARAMCON Badge 2019
    <li> ARAMCON2 Badge
    <li> ATMegaZero ESP32-S2
    <li> Adafruit CLUE nRF52840 Express
    <li> Adafruit Circuit Playground Bluefruit
    <li> Adafruit EdgeBadge
    <li> Adafruit Feather Bluefruit Sense
    <li> Adafruit Feather ESP32-S2 TFT
    <li> Adafruit Feather ESP32S2
    <li> Adafruit Feather M4 CAN
    <li> Adafruit Feather M4 Express
    <li> Adafruit Feather MIMXRT1011
    <li> Adafruit Feather RP2040
    <li> Adafruit Feather STM32F405 Express
    <li> Adafruit Feather nRF52840 Express
    <li> Adafruit FunHouse
    <li> Adafruit Grand Central M4 Express
    <li> Adafruit Hallowing M4 Express
    <li> Adafruit ItsyBitsy M4 Express
    <li> Adafruit ItsyBitsy RP2040
    <li> Adafruit ItsyBitsy nRF52840 Express
    <li> Adafruit KB2040
    <li> Adafruit LED Glasses Driver nRF52840
    <li> Adafruit Macropad RP2040
    <li> Adafruit MagTag
    <li> Adafruit Matrix Portal M4
    <li> Adafruit Metro ESP32S2
    <li> Adafruit Metro M4 Airlift Lite
    <li> Adafruit Metro M4 Express
    <li> Adafruit Metro nRF52840 Express
    <li> Adafruit Monster M4SK
    <li> Adafruit PyGamer
    <li> Adafruit PyPortal
    <li> Adafruit PyPortal Pynt
    <li> Adafruit PyPortal Titano
    <li> Adafruit Pybadge
    <li> Adafruit QT Py ESP32S2
    <li> Adafruit QT Py RP2040
    <li> Adafruit QT2040 Trinkey
    <li> Adafruit Trellis M4 Express
    <li> AloriumTech Evo M51
    <li> Arduino Nano 33 BLE
    <li> Arduino Nano RP2040 Connect
    <li> Artisense Reference Design RD00
    <li> AtelierDuMaker nRF52840 Breakout
    <li> BDMICRO VINA-D51
    <li> BLE-SS dev board Multi Sensor
    <li> BastBLE
    <li> BastWiFi
    <li> BlueMicro840
    <li> CP32-M4
    <li> Capable Robot Programmable USB Hub
    <li> Challenger NB RP2040 WiFi
    <li> Challenger RP2040 LTE
    <li> Challenger RP2040 WiFi
    <li> CircuitBrains Deluxe
    <li> CrumpS2
    <li> Cytron Maker Nano RP2040
    <li> Cytron Maker Pi RP2040
    <li> DynOSSAT-EDU-OBC
    <li> ESP 12k NodeMCU
    <li> Electronut Labs Blip
    <li> Electronut Labs Papyr
    <li> EncoderPad RP2040
    <li> Espruino Wifi
    <li> Feather ESP32S2 without PSRAM
    <li> Feather MIMXRT1011
    <li> Feather MIMXRT1062
    <li> FeatherS2
    <li> FeatherS2 Neo
    <li> FeatherS2 PreRelease
    <li> Fomu
    <li> Franzininho WIFI w/Wroom
    <li> Franzininho WIFI w/Wrover
    <li> Gravitech Cucumber M
    <li> Gravitech Cucumber MS
    <li> Gravitech Cucumber R
    <li> Gravitech Cucumber RS
    <li> HMI-DevKit-1.1
    <li> HiiBot BlueFi
    <li> IMXRT1010-EVK
    <li> IkigaiSense Vita nRF52840
    <li> Kaluga 1
    <li> LILYGO TTGO T8 ESP32-S2 w/Display
    <li> MDBT50Q-DB-40
    <li> MDBT50Q-RX Dongle
    <li> MEOWBIT
    <li> MORPHEANS MorphESP-240
    <li> MakerDiary nRF52840 MDK
    <li> MakerDiary nRF52840 MDK USB Dongle
    <li> Makerdiary M60 Keyboard
    <li> Makerdiary Pitaya Go
    <li> Makerdiary nRF52840 M.2 Developer Kit
    <li> Melopero Shake RP2040
    <li> Metro MIMXRT1011
    <li> MicroDev microC3
    <li> MicroDev microS2
    <li> Mini SAM M4
    <li> NUCLEO STM32F746
    <li> NUCLEO STM32F767
    <li> NUCLEO STM32H743
    <li> OPENMV-H7 R1
    <li> Oak Dev Tech BREAD2040
    <li> Oak Dev Tech PixelWing ESP32S2
    <li> Open Hardware Summit 2020 Badge
    <li> PCA10056 nRF52840-DK
    <li> PCA10059 nRF52840 Dongle
    <li> Particle Argon
    <li> Particle Boron
    <li> Particle Xenon
    <li> Pimoroni Interstate 75
    <li> Pimoroni Keybow 2040
    <li> Pimoroni PGA2040
    <li> Pimoroni Pico LiPo (16MB)
    <li> Pimoroni Pico LiPo (4MB)
    <li> Pimoroni PicoSystem
    <li> Pimoroni Plasma 2040
    <li> Pimoroni Tiny 2040
    <li> PyCubedv04
    <li> PyCubedv04-MRAM
    <li> PyCubedv05
    <li> PyCubedv05-MRAM
    <li> PyKey60
    <li> PyboardV1_1
    <li> RP2040 Stamp
    <li> Raspberry Pi Pico
    <li> Robo HAT MM1 M4
    <li> S2Mini
    <li> S2Pico
    <li> SAM E54 Xplained Pro
    <li> SAM32v26
    <li> ST STM32F746G Discovery
    <li> STM32F412G_DISCO
    <li> STM32F4_DISCO
    <li> Saola 1 w/Wroom
    <li> Saola 1 w/Wrover
    <li> Seeeduino Wio Terminal
    <li> Silicognition LLC M4-Shim
    <li> SparkFun MicroMod RP2040 Processor
    <li> SparkFun MicroMod SAMD51 Processor
    <li> SparkFun MicroMod nRF52840 Processor
    <li> SparkFun Pro Micro RP2040
    <li> SparkFun Pro nRF52840 Mini
    <li> SparkFun STM32 MicroMod Processor
    <li> SparkFun Thing Plus - RP2040
    <li> SparkFun Thing Plus - SAMD51
    <li> Swan R5
    <li> TG-Boards' Datalore IP M4
    <li> TG-Watch
    <li> THUNDERPACK_v11
    <li> THUNDERPACK_v12
    <li> Targett Module Clip w/Wroom
    <li> Targett Module Clip w/Wrover
    <li> Teensy 4.0
    <li> Teensy 4.1
    <li> Teknikio Bluebird
    <li> The Open Book Feather
    <li> Thingz - Galaxia
    <li> TinkeringTech ScoutMakes Azul
    <li> TinyS2
    <li> UARTLogger II
    <li> WarmBit BluePixel nRF52840
    <li> Winterbloom Sol
    <li> iMX RT 1020 EVK
    <li> iMX RT 1060 EVK
    <li> nanoESP32-S2  w/Wrover
    <li> nanoESP32-S2 w/Wroom
    <li> nice!nano
    <li> stm32f411ce-blackpill
    <li> stm32f411ce-blackpill-with-flash
    </ul>
    </details>
    </p>




.. py:function:: pack(obj: object, buffer: _typing.WriteableBuffer, *, default: Union[Callable[[object], None], None] = None) -> None

   Ouput object to buffer in msgpack format.

   :param object obj: Object to convert to msgpack format.
   :param ~_typing.WriteableBuffer buffer: buffer to write into
   :param Optional[~_typing.Callable[[object], None]] default:
         function called for python objects that do not have
         a representation in msgpack format.


.. py:function:: unpack(buffer: _typing.ReadableBuffer, *, ext_hook: Union[Callable[[int, bytes], object], None] = None, use_list: bool = True) -> object

   Unpack and return one object from buffer.

   :param ~_typing.ReadableBuffer buffer: buffer to read from
   :param Optional[~_typing.Callable[[int, bytes], object]] ext_hook: function called for objects in
          msgpack ext format.
   :param Optional[bool] use_list: return array as list or tuple (use_list=False).

   :return object: object read from buffer.


.. py:class:: ExtType(code: int, data: bytes)

   ExtType represents ext type in msgpack.

   Constructor
   :param int code: type code in range 0~127.
   :param bytes data: representation.

   .. py:attribute:: code
      :annotation: :int

      The type code, in range 0~127.


   .. py:attribute:: data
      :annotation: :bytes

      Data.