summaryrefslogtreecommitdiff
path: root/msgpack/__init__.py
diff options
context:
space:
mode:
authorINADA Naoki <methane@users.noreply.github.com>2018-02-23 15:41:21 +0900
committerGitHub <noreply@github.com>2018-02-23 15:41:21 +0900
commitae3a6ba0b04487d7108360d1d504332aed079556 (patch)
tree16061fe26078d25e7743d672f2c36067397aea7a /msgpack/__init__.py
parentf38c1a3674b7623080cb774b56ede21383bde04a (diff)
downloadmsgpack-python-ae3a6ba0b04487d7108360d1d504332aed079556.tar.gz
Deprecate implementation module's unpack() (#290)
Diffstat (limited to 'msgpack/__init__.py')
-rw-r--r--msgpack/__init__.py18
1 files changed, 15 insertions, 3 deletions
diff --git a/msgpack/__init__.py b/msgpack/__init__.py
index 6c5ae53..3955a41 100644
--- a/msgpack/__init__.py
+++ b/msgpack/__init__.py
@@ -19,13 +19,13 @@ class ExtType(namedtuple('ExtType', 'code data')):
import os
if os.environ.get('MSGPACK_PUREPYTHON'):
- from msgpack.fallback import Packer, unpack, unpackb, Unpacker
+ from msgpack.fallback import Packer, unpackb, Unpacker
else:
try:
from msgpack._packer import Packer
- from msgpack._unpacker import unpack, unpackb, Unpacker
+ from msgpack._unpacker import unpackb, Unpacker
except ImportError:
- from msgpack.fallback import Packer, unpack, unpackb, Unpacker
+ from msgpack.fallback import Packer, unpackb, Unpacker
def pack(o, stream, **kwargs):
@@ -46,6 +46,18 @@ def packb(o, **kwargs):
"""
return Packer(**kwargs).pack(o)
+
+def unpack(stream, **kwargs):
+ """
+ Unpack an object from `stream`.
+
+ Raises `ExtraData` when `stream` contains extra bytes.
+ See :class:`Unpacker` for options.
+ """
+ data = stream.read()
+ return unpackb(data, **kwargs)
+
+
# alias for compatibility to simplejson/marshal/pickle.
load = unpack
loads = unpackb