Skip to content

Handle (new) buffer protocol conforming types in Pickle.decode #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jakirkham merged 6 commits into from
Nov 30, 2018
Merged

Handle (new) buffer protocol conforming types in Pickle.decode #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a2dca8e
Get bytes from buffer for Python 2's Pickle decode
jakirkham Nov 30, 2018
1c184f8
Ensure Pickle's decode gets a contiguous buffer
jakirkham Nov 30, 2018
d4be3dc
Test that Pickle can decode an `ndarray`
jakirkham Nov 30, 2018
8d1a4ba
Generalize decoding `ndarray` test
jakirkham Nov 30, 2018
f9eecdf
Include `Pickle.decode` fix in release notes
jakirkham Nov 30, 2018
f6e6d98
Add Python version coverage pragmas to branches
jakirkham Nov 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
Release notes
=============

.. _release_0.6.2:

0.6.2
-----

* Handle (new) buffer protocol conforming types in ``Pickle.decode``.
(by :user:`John Kirkham <jakirkham>`, :issue:`143`).


.. _release_0.6.1:

0.6.1
Expand Down
7 changes: 6 additions & 1 deletion numcodecs/pickles.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@


from .abc import Codec
from .compat import PY2
from .compat import PY2, ensure_bytes, ensure_contiguous_ndarray


if PY2: # pragma: py3 no cover
Expand Down Expand Up @@ -48,6 +48,11 @@ def encode(self, buf):
return pickle.dumps(buf, protocol=self.protocol)

def decode(self, buf, out=None):
if PY2: # pragma: py3 no cover
buf = ensure_bytes(buf)
else: # pragma: py2 no cover
buf = ensure_contiguous_ndarray(buf)

@jakirkham jakirkham Nov 30, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to provide context from the Python codebase, Python 2 requires bytes here and Python 3 uses the (new) buffer protocol to get a C-contiguous array.


dec = pickle.loads(buf)
if out is not None:
np.copyto(out, dec)
Expand Down
4 changes: 4 additions & 0 deletions numcodecs/tests/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,10 @@ def check_encode_decode_array(arr, codec):
codec.decode(enc, out=out)
assert_array_items_equal(arr, out)

enc = codec.encode(arr)
dec = codec.decode(ensure_ndarray(enc))
assert_array_items_equal(arr, dec)

@jakirkham jakirkham Nov 30, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems this worked for everything except Pickle on Python 2 as demonstrated by this CI failure. This is likely a consequence of the improved buffer handling under the hood, which MsgPack, JSON, etc. all use already. Pickle was the only one not using these functions, which this PR fixes. So testing this generally seems to be fine. All the other codecs already test decoding with ndarray.



def check_config(codec):
config = codec.get_config()
Expand Down