googleapis / googleapis/google-cloud-python

Docs: cache policy callables get passed datastore API `Key`, not ndb `Key`

Open
#15,841 4 comments 1 reaction 1 assignee Claimed by @daniel-sanche View on GitHub
api: datastore priority: p3 type: bug
Dominant language
Python
Stars
5.4k
Forks
1.8k
Avg merge
3d 4h
Merged PRs (30d)
122

Description

This took me a bit to debug just now, due to an error in the ndb docs, so I figured I'd file this to hopefully prevent that for others in the future. [The docs currently say](https://googleapis.dev/python/python-ndb/latest/context.html#google.cloud.ndb.context.Context.set_cache_policy) that the context `global_cache_timeout_policy` and (I think?) `global_cache_policy` callables get passed a `google.cloud.ndb.key.Key`, but that's not true. Evidently they actually get passed a [`google.cloud.datastore.key.Key`](https://cloud.google.com/python/docs/reference/datastore/latest/keys) instead.

Interestingly `cache_policy` gets passed a `google.cloud.ndb.key.Key`, which is documented correctly, but only adds to the confusion.

Hope this helps!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.