Skip to content
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.

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

allow put and get to work with compressed blob properties #175

Merged
merged 1 commit into from
Aug 27, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 5 additions & 3 deletions google/cloud/ndb/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,7 @@ class Person(Model):
import inspect
import json
import pickle
import six
import zlib

from google.cloud.datastore import entity as ds_entity_module
Expand Down Expand Up @@ -2188,15 +2189,13 @@ def _validate(self, value):
return float(value)


class _CompressedValue:
class _CompressedValue(six.binary_type):
"""A marker object wrapping compressed values.

Args:
z_val (bytes): A return value of ``zlib.compress``.
"""

__slots__ = ("z_val",)

def __init__(self, z_val):
self.z_val = z_val

Expand Down Expand Up @@ -2355,6 +2354,9 @@ def _from_base_type(self, value):
indicate that the value didn't need to be unwrapped and
decompressed.
"""
if self._compressed and not isinstance(value, _CompressedValue):
value = _CompressedValue(value)

if isinstance(value, _CompressedValue):
return zlib.decompress(value.z_val)

Expand Down
30 changes: 30 additions & 0 deletions tests/system/test_crud.py
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,36 @@ class SomeKind(ndb.Model):
dispose_of(key._key)


@pytest.mark.usefixtures("client_context")
def test_compressed_json_property(dispose_of, ds_client):
class SomeKind(ndb.Model):
foo = ndb.JsonProperty(compressed=True)

foo = {str(i): i for i in range(500)}
entity = SomeKind(foo=foo)
key = entity.put()

retrieved = key.get()
assert retrieved.foo == foo

dispose_of(key._key)


@pytest.mark.usefixtures("client_context")
def test_compressed_blob_property(dispose_of, ds_client):
class SomeKind(ndb.Model):
foo = ndb.BlobProperty(compressed=True)

foo = b"abc" * 100
entity = SomeKind(foo=foo)
key = entity.put()

retrieved = key.get()
assert retrieved.foo == foo

dispose_of(key._key)


@pytest.mark.usefixtures("client_context")
def test_large_pickle_property(dispose_of, ds_client):
class SomeKind(ndb.Model):
Expand Down
10 changes: 10 additions & 0 deletions tests/unit/test_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -1677,6 +1677,16 @@ def test__from_base_type():

assert converted == original

@staticmethod
def test__from_base_type_no_compressed_value():
prop = model.BlobProperty(name="blob")
original = b"abc" * 10
value = zlib.compress(original)
prop._compressed = True
converted = prop._from_base_type(value)

assert converted == original

@staticmethod
def test__from_base_type_no_convert():
prop = model.BlobProperty(name="blob")
Expand Down