Skip to content

Address #293: document that app code should not pass 'dataset_id' to 'Key.__init__'. #297

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
tseaver merged 3 commits into from
Oct 28, 2014
Merged

Address #293: document that app code should not pass 'dataset_id' to 'Key.__init__'. #297

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
720fdc9
Document that app code should not pass 'dataset_id' to 'Key.__init__'.
tseaver Oct 27, 2014
1e7a7b6
Elaborate on restrictions for 'Key._dataset_id'.
tseaver Oct 27, 2014
a823baa
PEP8 ws.
tseaver Oct 27, 2014
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
10 changes: 9 additions & 1 deletion gcloud/datastore/key.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,15 @@ def __init__(self, path=None, namespace=None, dataset_id=None):

:type dataset_id: string
:param dataset: The dataset ID assigned by back-end for the key.
Leave as None for newly-created keys.

.. note::

The key's ``_dataset_id`` field must be None for keys created
by application code. The
:func:`gcloud.datastore.helpers.key_from_protobuf` factory
will be set the field to an appropriate value for keys returned
from the datastore backend. The application **must** treat any
value set by the back-end as opaque.
"""
self._path = path or [{'kind': ''}]
self._namespace = namespace
Expand Down