Ravenports generated: 20 Apr 2020 15: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.0
5 KEYWORDS=               python
6 VARIANTS=               py38 py37
7 SDESC[py37]=            MessagePack (de)serializer (PY37)
8 SDESC[py38]=            MessagePack (de)serializer (PY38)
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.0.tar.gz:main
15 DF_INDEX=               1
16 SPKGS[py37]=            single
17 SPKGS[py38]=            single
18
19 OPTIONS_AVAILABLE=      PY38 PY37
20 OPTIONS_STANDARD=       none
21 VOPTS[py37]=            PY38=OFF PY37=ON
22 VOPTS[py38]=            PY38=ON PY37=OFF
23
24 DISTNAME=               msgpack-1.0.0
25
26 GENERATED=              yes
27
28 [PY37].USES_ON=                         python:py37
29
30 [PY38].USES_ON=                         python:py38
31
32 [FILE:3053:descriptions/desc.single]
33 # MessagePack for Python
34
35 [![Build Status]](https://travis-ci.org/msgpack/msgpack-python)
36 [![Documentation
37 Status]](https://msgpack-python.readthedocs.io/en/latest/?badge=latest)
38
39 ## What's this
40
41 [MessagePack] is an efficient binary serialization format.
42 It lets you exchange data among multiple languages like JSON.
43 But it's faster and smaller.
44 This package provides CPython bindings for reading and writing MessagePack
45 data.
46
47 ## Very important notes for existing users
48
49 ### PyPI package name
50
51 TL;DR: When upgrading from msgpack-0.4 or earlier, don't do `pip install -U
52 msgpack-python`.
53 Do `pip uninstall msgpack-python; pip install msgpack` instead.
54
55 Package name on PyPI was changed to msgpack from 0.5.
56 I upload transitional package (msgpack-python 0.5 which depending on
57 msgpack)
58 for smooth transition from msgpack-python to msgpack.
59
60 Sadly, this doesn't work for upgrade install.  After `pip install -U
61 msgpack-python`,
62 msgpack is removed, and `import msgpack` fail.
63
64 ### Compatibility with the old format
65
66 You can use `use_bin_type=False` option to pack `bytes`
67 object into raw type in the old msgpack spec, instead of bin type in new
68 msgpack spec.
69
70 You can unpack old msgpack format using `raw=True` option.
71 It unpacks str (raw) type in msgpack into Python bytes.
72
73 See note below for detail.
74
75 ### Major breaking changes in msgpack 1.0
76
77 * Python 2
78
79   * The extension module does not support Python 2 anymore.
80     The pure Python implementation (`msgpack.fallback`) is used for Python
81 2.
82
83 * Packer
84
85   * `use_bin_type=True` by default.  bytes are encoded in bin type in
86 msgpack.
87     **If you are still sing Python 2, you must use unicode for all string
88 types.**
89     You can use `use_bin_type=False` to encode into old msgpack format.
90   * `encoding` option is removed.  UTF-8 is used always.
91
92 * Unpacker
93
94   * `raw=False` by default.  It assumes str types are valid UTF-8 string
95     and decode them to Python str (unicode) object.
96   * `encoding` option is removed.  You can use `raw=True` to support old
97 format.
98   * Default value of `max_buffer_size` is changed from 0 to 100 MiB.
99   * Default value of `strict_map_key` is changed to True to avoid hashdos.
100     You need to pass `strict_map_key=False` if you have data which contain
101 map keys
102     which type is not bytes or str.
103
104 ## Install
105
106    $ pip install msgpack
107
108 ### Pure Python implementation
109
110 The extension module in msgpack (`msgpack._cmsgpack`) does not support
111 Python 2 and PyPy.
112
113 But msgpack provides a pure Python implementation (`msgpack.fallback`)
114 for PyPy and Python 2.
115
116 Since the [pip] uses the pure Python implementation,
117 Python 2 support will not be dropped in the foreseeable future.
118
119 ### Windows
120
121 When you can't use a binary distribution, you need to install Visual Studio
122 or Windows SDK on Windows.
123 Without extension, using pure Python implementation on CPython runs slowly.
124
125 ## How to use
126
127 NOTE: In examples below, I use `raw=False` and `use_bin_type=True` for
128 users
129 using msgpack < 1.0. These options are default from msgpack 1.0 so you can
130 omit them.
131
132 ### One-shot pack & unpack
133
134
135 [FILE:99:distinfo]
136 9534d5cc480d4aff720233411a1f765be90885750b07df772380b34c10ecb5c0       232331 msgpack-1.0.0.tar.gz
137