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

Add snippets for ndb cache doc #282

Merged
merged 1 commit into from
Apr 26, 2016
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
11 changes: 11 additions & 0 deletions appengine/ndb/cache/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## App Engine Datastore NDB Cache Samples

This contains snippets used in the NDB cache documentation, demonstrating
various operation on ndb caches.

<!-- auto-doc-link -->
These samples are used on the following documentation page:

> https://cloud.google.com/appengine/docs/python/ndb/cache

<!-- end-auto-doc-link -->
45 changes: 45 additions & 0 deletions appengine/ndb/cache/snippets.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Copyright 2016 Google Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from google.appengine.ext import ndb


def set_in_process_cache_policy(func):
context = ndb.get_context()
context.set_cache_policy(func)


def set_memcache_policy(func):
context = ndb.get_context()
context.set_memcache_policy(func)


def bypass_in_process_cache_for_account_entities():
context = ndb.get_context()
context.set_cache_policy(lambda key: key.kind() != 'Account')


def set_datastore_policy(func):
context = ndb.get_context()
context.set_datastore_policy(func)


def set_memcache_timeout_policy(func):
context = ndb.get_context()
context.set_memcache_timeout_policy(func)


def clear_cache():
context = ndb.get_context()
context.clear_cache()
59 changes: 59 additions & 0 deletions appengine/ndb/cache/snippets_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Copyright 2016 Google Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from google.appengine.ext import ndb
import snippets


def test_set_in_process_cache_policy(testbed):
def policy(key):
return 1 == 1

snippets.set_in_process_cache_policy(policy)
assert policy == ndb.get_context().get_cache_policy()


def test_set_memcache_policy(testbed):
def policy(key):
return 1 == 2

snippets.set_memcache_policy(policy)
assert policy == ndb.get_context().get_memcache_policy()


def test_bypass_in_process_cache_for_account_entities(testbed):
context = ndb.get_context()
assert context.get_cache_policy() == context.default_cache_policy
snippets.bypass_in_process_cache_for_account_entities()
assert context.get_cache_policy() != context.default_cache_policy


def test_set_datastore_policy(testbed):
def policy(key):
return key is None

snippets.set_datastore_policy(policy)
assert ndb.get_context().get_datastore_policy() == policy


def test_set_memcache_timeout_policy(testbed):
def policy(key):
return 1

snippets.set_memcache_timeout_policy(policy)
assert ndb.get_context().get_memcache_timeout_policy() == policy


def test_clear_cache(testbed):
snippets.clear_cache()