Skip to content

stripping of padding characters from datastore's urlsafe key #3559

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

Closed
michaelenglo wants to merge 2 commits into from
Closed

stripping of padding characters from datastore's urlsafe key #3559

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7621590
strip/add back padding to/from datastore's urlsafe
Jun 19, 2017
b653265
Merge branch 'strip-padding-from-urlsafe'
Jun 26, 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
20 changes: 17 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 @@ -304,7 +304,9 @@ def to_legacy_urlsafe(self):
This is intended to work with the "legacy" representation of a
datastore "Key" used within Google App Engine (a so-called
"Reference"). The returned string can be used as the ``urlsafe``
argument to ``ndb.Key(urlsafe=...)``.
argument to ``ndb.Key(urlsafe=...)``. Notice that the datastore's
version of urlsafe encoding does not have padding characters, unlike
the out of the box urlsafe_b64encode's generated urlsafe.

This comment was marked as spam.

Sign in to view


:rtype: bytes
:returns: A bytestring containing the key encoded as URL-safe base64.
Expand All @@ -315,7 +317,7 @@ def to_legacy_urlsafe(self):
name_space=self.namespace,
)
raw_bytes = reference.SerializeToString()
return base64.urlsafe_b64encode(raw_bytes)
return base64.urlsafe_b64encode(raw_bytes).strip('=')

This comment was marked as spam.

Sign in to view


@classmethod
def from_legacy_urlsafe(cls, urlsafe):
Expand All @@ -324,7 +326,10 @@ def from_legacy_urlsafe(cls, urlsafe):
This is intended to work with the "legacy" representation of a
datastore "Key" used within Google App Engine (a so-called
"Reference"). This assumes that ``urlsafe`` was created within an App
Engine app via something like ``ndb.Key(...).urlsafe()``.
Engine app via something like ``ndb.Key(...).urlsafe()``.Notice that

This comment was marked as spam.

Sign in to view

the datastore's version of urlsafe encoding does not have padding
characters, unlike the out of the box urlsafe_b64encode's generated
urlsafe.

:type urlsafe: bytes or unicode
:param urlsafe: The base64 encoded (ASCII) string corresponding to a
Expand All @@ -333,6 +338,15 @@ def from_legacy_urlsafe(cls, urlsafe):
:rtype: :class:`~google.cloud.datastore.key.Key`.
:returns: The key corresponding to ``urlsafe``.
"""
if not isinstance(urlsafe, basestring):
raise TypeError('urlsafe must be a string; received %r' % urlsafe)
if isinstance(urlsafe, unicode):
urlsafe = urlsafe.encode('utf8')

This comment was marked as spam.

Sign in to view


mod = len(urlsafe) % 4
if mod:
urlsafe += '=' * (4 - mod)

This comment was marked as spam.

Sign in to view


urlsafe = _to_bytes(urlsafe, encoding='ascii')
raw_bytes = base64.urlsafe_b64decode(urlsafe)

Expand Down