Skip to content

Adds optional location_prefix kwarg in to_legacy_urlsafe #4635

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
dhermes merged 5 commits into from
Dec 20, 2017
Merged

Adds optional location_prefix kwarg in to_legacy_urlsafe #4635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1184f19
Adds optional location_prefix kwarg in to_legacy_urlsafe
egalpin Dec 20, 2017
dd5275b
Adds explicit None-check, typo doc fixes
Dec 20, 2017
aac35ad
Adds unit test for location_prefix in to_legacy_key
Dec 20, 2017
05f9cec
Moves and renames location_prefix unit test
Dec 20, 2017
55808e6
Slight re-organization of tests.
dhermes Dec 20, 2017
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
19 changes: 16 additions & 3 deletions datastore/google/cloud/datastore/key.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ def to_protobuf(self):

return key

def to_legacy_urlsafe(self):
def to_legacy_urlsafe(self, location_prefix=None):
"""Convert to a base64 encode urlsafe string for App Engine.

This is intended to work with the "legacy" representation of a
Expand All @@ -310,13 +310,26 @@ def to_legacy_urlsafe(self):
.. note::

The string returned by ``to_legacy_urlsafe`` is equivalent, but
not identical, to the string returned by ``ndb``.
not identical, to the string returned by ``ndb``. The location
prefix may need to be specified to obtain identical urlsafe
keys.

:type location_prefix: str
:param location_prefix: The location prefix of an App Engine project
ID. Often this value is 's~', but may also be
'e~', or other location prefixes currently
unknown.

:rtype: bytes
:returns: A bytestring containing the key encoded as URL-safe base64.
"""
if location_prefix is None:
project_id = self.project
else:
project_id = location_prefix + self.project

reference = _app_engine_key_pb2.Reference(
app=self.project,
app=project_id,
path=_to_legacy_path(self._path), # Avoid the copy.
name_space=self.namespace,
)
Expand Down
19 changes: 19 additions & 0 deletions datastore/tests/unit/test_key.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ class TestKey(unittest.TestCase):
_URLSAFE_EXAMPLE2 = b'agZzfmZpcmVyDwsSBEtpbmQiBVRoaW5nDA'
_URLSAFE_APP2 = 's~fire'
_URLSAFE_FLAT_PATH2 = ('Kind', 'Thing')
_URLSAFE_EXAMPLE3 = b'ahhzfnNhbXBsZS1hcHAtbm8tbG9jYXRpb25yCgsSBFpvcnAYWAw'
_URLSAFE_APP3 = 'sample-app-no-location'
_URLSAFE_FLAT_PATH3 = ('Zorp', 88)

@staticmethod
def _get_target_class():
Expand Down Expand Up @@ -408,6 +411,13 @@ def test_to_legacy_urlsafe_strip_padding(self):
# Make sure it started with base64 padding.
self.assertNotEqual(len(self._URLSAFE_EXAMPLE2) % 4, 0)

def test_to_legacy_urlsafe_with_location_prefix(self):
key = self._make_one(
*self._URLSAFE_FLAT_PATH3,
project=self._URLSAFE_APP3)
urlsafe = key.to_legacy_urlsafe(location_prefix='s~')
self.assertEqual(urlsafe, self._URLSAFE_EXAMPLE3)

def test_from_legacy_urlsafe(self):
klass = self._get_target_class()
key = klass.from_legacy_urlsafe(self._URLSAFE_EXAMPLE1)
Expand All @@ -430,6 +440,15 @@ def test_from_legacy_urlsafe_needs_padding(self):
self.assertIsNone(key.namespace)
self.assertEqual(key.flat_path, self._URLSAFE_FLAT_PATH2)

def test_from_legacy_urlsafe_with_location_prefix(self):

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

klass = self._get_target_class()
# Make sure it will have base64 padding added.
key = klass.from_legacy_urlsafe(self._URLSAFE_EXAMPLE3)

self.assertEqual(key.project, self._URLSAFE_APP3)
self.assertIsNone(key.namespace)
self.assertEqual(key.flat_path, self._URLSAFE_FLAT_PATH3)

def test_is_partial_no_name_or_id(self):
key = self._make_one('KIND', project=self._DEFAULT_PROJECT)
self.assertTrue(key.is_partial)
Expand Down