Ravenports generated: 21 Feb 2024 20:00
[ravenports.git] / bucket_D7 / python-msgpack
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-msgpack
4 VERSION=                1.0.7
5 KEYWORDS=               python
6 VARIANTS=               v11 v12
7 SDESC[v11]=             MessagePack serializer (3.11)
8 SDESC[v12]=             MessagePack serializer (3.12)
9 HOMEPAGE=               https://msgpack.org/
10 CONTACT=                Python_Automaton[python@ironwolf.systems]
11
12 DOWNLOAD_GROUPS=        main
13 SITES[main]=            PYPI/m/msgpack
14 DISTFILE[1]=            msgpack-1.0.7.tar.gz:main
15 DF_INDEX=               1
16 SPKGS[v11]=             single
17 SPKGS[v12]=             single
18
19 OPTIONS_AVAILABLE=      PY311 PY312
20 OPTIONS_STANDARD=       none
21 VOPTS[v11]=             PY311=ON PY312=OFF
22 VOPTS[v12]=             PY311=OFF PY312=ON
23
24 USES=                   c++:single
25
26 DISTNAME=               msgpack-1.0.7
27
28 GENERATED=              yes
29
30 [PY311].USES_ON=                        python:v11,sutools
31
32 [PY312].USES_ON=                        python:v12,sutools
33
34 [FILE:2787:descriptions/desc.single]
35 # MessagePack for Python
36
37 [Build Status]
38 [Documentation Status]
39
40 ## What's this
41
42 [MessagePack] is an efficient binary serialization format.
43 It lets you exchange data among multiple languages like JSON.
44 But it's faster and smaller.
45 This package provides CPython bindings for reading and writing MessagePack
46 data.
47
48 ## Very important notes for existing users
49
50 ### PyPI package name
51
52 Package name on PyPI was changed from `msgpack-python` to `msgpack` from
53 0.5.
54
55 When upgrading from msgpack-0.4 or earlier, do `pip uninstall
56 msgpack-python` before
57 `pip install -U msgpack`.
58
59 ### Compatibility with the old format
60
61 You can use `use_bin_type=False` option to pack `bytes`
62 object into raw type in the old msgpack spec, instead of bin type in new
63 msgpack spec.
64
65 You can unpack old msgpack format using `raw=True` option.
66 It unpacks str (raw) type in msgpack into Python bytes.
67
68 See note below for detail.
69
70 ### Major breaking changes in msgpack 1.0
71
72 * Python 2
73
74   * The extension module does not support Python 2 anymore.
75     The pure Python implementation (`msgpack.fallback`) is used for Python
76 2.
77
78 * Packer
79
80   * `use_bin_type=True` by default.  bytes are encoded in bin type in
81 msgpack.
82     **If you are still using Python 2, you must use unicode for all string
83 types.**
84     You can use `use_bin_type=False` to encode into old msgpack format.
85   * `encoding` option is removed.  UTF-8 is used always.
86
87 * Unpacker
88
89   * `raw=False` by default.  It assumes str types are valid UTF-8 string
90     and decode them to Python str (unicode) object.
91   * `encoding` option is removed.  You can use `raw=True` to support old
92 format.
93   * Default value of `max_buffer_size` is changed from 0 to 100 MiB.
94   * Default value of `strict_map_key` is changed to True to avoid hashdos.
95     You need to pass `strict_map_key=False` if you have data which contain
96 map keys
97     which type is not bytes or str.
98
99 ## Install
100
101 ```
102 $ pip install msgpack
103 ```
104
105 ### Pure Python implementation
106
107 The extension module in msgpack (`msgpack._cmsgpack`) does not support
108 Python 2 and PyPy.
109
110 But msgpack provides a pure Python implementation (`msgpack.fallback`)
111 for PyPy and Python 2.
112
113 ### Windows
114
115 When you can't use a binary distribution, you need to install Visual Studio
116 or Windows SDK on Windows.
117 Without extension, using pure Python implementation on CPython runs slowly.
118
119 ## How to use
120
121 NOTE: In examples below, I use `raw=False` and `use_bin_type=True` for
122 users
123 using msgpack < 1.0. These options are default from msgpack 1.0 so you can
124 omit them.
125
126 ### One-shot pack & unpack
127
128 Use `packb` for packing and `unpackb` for unpacking.
129 msgpack provides `dumps` and `loads` as an alias for compatibility with
130 `json` and `pickle`.
131
132 `pack` and `dump` packs to a file-like object.
133 `unpack` and `load` unpacks from a file-like object.
134
135
136
137 [FILE:99:distinfo]
138 572efc93db7a4d27e404501975ca6d2d9775705c2d922390d878fcf768d92c87       166311 msgpack-1.0.7.tar.gz
139