Skip to content

Commit

Permalink
update readme (#605)
Browse files Browse the repository at this point in the history
  • Loading branch information
methane authored May 5, 2024
1 parent 72e65fe commit 3da5818
Showing 1 changed file with 4 additions and 11 deletions.
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,7 @@ msgpack provides `dumps` and `loads` as an alias for compatibility with
[1, 2, 3]
```

`unpack` unpacks msgpack's array to Python's list, but can also unpack to tuple:

```pycon
>>> msgpack.unpackb(b'\x93\x01\x02\x03', use_list=False)
(1, 2, 3)
```

You should always specify the `use_list` keyword argument for backward compatibility.
See performance issues relating to `use_list option`_ below.

Read the docstring for other options.
Read the docstring for options.


### Streaming unpacking
Expand Down Expand Up @@ -116,6 +106,9 @@ this_dict_again = msgpack.unpackb(packed_dict, object_hook=decode_datetime)
`object_pairs_hook` callback may instead be used to receive a list of
key-value pairs.

NOTE: msgpack can encode datetime with tzinfo into standard ext type for now.
See `datetime` option in `Packer` docstring.


### Extended types

Expand Down

0 comments on commit 3da5818

Please sign in to comment.