[appengine-afterburner] r12 committed - updated documentation

0 views

Skip to first unread message

appengine-...@googlecode.com

unread,

Nov 15, 2010, 7:54:22 AM11/15/10

to appengine-after...@googlegroups.com

Revision: 12
Author: mike.a...@gmail.com
Date: Mon Nov 15 04:53:40 2010
Log: updated documentation
http://code.google.com/p/appengine-afterburner/source/detail?r=12

Added:
/doc/python/html/_modules
/doc/python/html/_modules/afterburner
/doc/python/html/_modules/afterburner/experimental
/doc/python/html/_modules/afterburner/experimental/db
/doc/python/html/_modules/afterburner/experimental/db/triggers.html
/doc/python/html/_modules/afterburner/experimental/memoize.html
/doc/python/html/_modules/afterburner/experimental/quota.html
/doc/python/html/_modules/index.html
/doc/python/html/py-modindex.html
/trunk/python/doc
/trunk/python/doc/Makefile
/trunk/python/doc/conf.py
Deleted:
/trunk/python/Makefile
/trunk/python/src/conf.py
Modified:
/doc/python/doctrees/afterburner/experimental/db/triggers.doctree
/doc/python/doctrees/afterburner/experimental/memoize.doctree
/doc/python/doctrees/afterburner/experimental/quota.doctree
/doc/python/doctrees/environment.pickle
/doc/python/doctrees/index.doctree
/doc/python/html/afterburner/experimental/db/triggers.html
/doc/python/html/afterburner/experimental/memoize.html
/doc/python/html/afterburner/experimental/quota.html
/doc/python/html/genindex.html
/doc/python/html/index.html
/doc/python/html/objects.inv
/doc/python/html/search.html
/doc/python/html/searchindex.js
/trunk/python/build.sh

=======================================
--- /dev/null
+++ /doc/python/html/_modules/afterburner/experimental/db/triggers.html Mon
Nov 15 04:53:40 2010
@@ -0,0 +1,408 @@
+
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>afterburner.experimental.db.triggers —
Appengine-Afterburner v0.0.1 documentation</title>
+ <link rel="stylesheet" href="../../../../_static/default.css"
type="text/css" />
+ <link rel="stylesheet" href="../../../../_static/pygments.css"
type="text/css" />
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../../',
+ VERSION: '0.0.1',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript"
src="../../../../_static/jquery.js"></script>
+ <script type="text/javascript"
src="../../../../_static/underscore.js"></script>
+ <script type="text/javascript"
src="../../../../_static/doctools.js"></script>
+ <link rel="top" title="Appengine-Afterburner v0.0.1 documentation"
href="../../../../index.html" />
+ <link rel="up" title="Module code" href="../../../index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../../../../py-modindex.html" title="Python Module
Index"
+ >modules</a> |</li>
+ <li><a href="../../../../index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
+ <li><a href="../../../index.html" accesskey="U">Module code</a>
»</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <h1>Source code for afterburner.experimental.db.triggers</h1><div
class="highlight"><pre>
+#!/usr/bin/env python
+#
+# Copyright 2010 Google Inc.
+#
+# 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.
+
+
+"""This module contains datastore trigger
system implementation.
+
+Overview
+========
+
+The system is designed to execute user's code every
time an entity of specific
+kind is changed by application. Right now the only
execution model is delayed
+execution (via taskqueue), which makes it useful only in
eventually-consistent
+scenarios.
+
+It is important to remember that:
+
+* Triggers won't be fired if you change your data not
from the app itself (e.g.
+ admin console).
+* There might be a delay (sometimes even minute) between
actual data change and
+ trigger execution.
+* Trigger executions for a single entity are batched.
I.e. if you change entity
+ quickly multiple times you'll most likely get your
trigger function called
+ only once.
+
+Current Limitations:
+
+* Right now only cron-based updates processing is
implemented. This means that
+ the delay between event and trigger processing might be
about 1 minute in
+ worst case.
+* Due to limitations of current datastore api batch
deletes are executed
+ by triggers module as separate transactions. This may
decrease performance
+ of deleting code quite a lot.
+* It is estimated that with this design you won't be
able to process more than
+ 60 changes per second. See the implementation details
and planned improvements
+ sections for more details.
+
+
+Usage
+=====
+
+To use triggers:
+
+* Add the following code to your app.yaml::
+
+ includes:
+ - afterburner/experimental/db/triggers.yaml
+
+* Add following lines to your cron.yaml::
+
+ cron:
+ - description: triggers processing
+ url: /_ab/triggers/process
+ schedule: every 1 minutes
+
+* Create appengine_config.py in application root
directory and import your
+ modules with all trigger definitions from it.
+* Define triggers as following::
+
+ from afterburner.experimental.db import
triggers
+ @triggers.trigger(kind=Order.kind())
+ def order_trigger(key):
+ logging.debug("Order was changed: %s",
key)
+
+ Trigger function only argument is changed entity key.
Because trigger execution
+ is decoupled in time from actual db operation, the
information about operation
+ is not provided.
+* Make sure that you're using run_wsgi_app() function
to run your app and not
+ older approach. For details check appengine
documentation:
+
http://code.google.com/appengine/docs/python/tools/webapp/running.html
+
+
+Implementation Details
+======================
+
+To implement transactionally-safe triggers for every
entity change we detect,
+we create a child "Update" entity, which is
later processed by updater
+cron job. Updater cron job deletes Update entities and
queues tasks for executing
+triggers for particular entities.
+
+Adding child entities to puts doesn't change runtime
behavior of the system
+at all, because datastore internally groups all entities
in batch puts into
+entity groups and performs their write together in one
transaction automatically.
+
+Unfortunately it's currently not possible to use the
same approach to batch
+deletes. We disassemble batch delete and delete each
entity individually in
+its own transaction together with creating an update
entity.
+Ideally datastore should provide an api where you can
batch all kinds of
+operations together.
+
+
+Alternative Approaches
+======================
+
+This section outlines alternative approaches to triggers
system designs. Some
+of these approaches can augment already existing ones to
improve performance
+and other characteristics.
+
+Transactional Tasks
+-------------------
+
+Instead of creating update tasks it's possible to use
transactional tasks
+to queue triggers processing for each entity. This works
perfectly for
+writes in transaction, but doesn't work good in case
of batch operations
+across multiple entity groups: you have to disassemble
both puts and gets
+the same way we disassemble deletes right now.
+
+The benefit of this approach is that by eliminating
Update entity and
+update processor, trigger latency can be made quite
low.
+
+Another caveat with this approach is task's 10K
payload size limit and limit
+of 5 transactional tasks per transaction. If there are
lots of entities in a
+single transaction, it might be difficult to store keys
for all of them
+in 5 tasks. However, it looks like this limitation is not
a problem for most
+apps.
+
+Immediate Triggers Execution
+----------------------------
+
+It was a specific goal for this library to implement
delayed triggers execution.
+Immediate trigger execution can be significant utility
for certain use cases.
+
+
+Future Improvements
+===================
+
+Following improvements to the library are
considered:
+
+* Use transactional tasks for triggers enqueing in
situtations where it's
+ possible (non-batched puts/deletes, small
transactions)
+* Optional unbatched trigger execution
+* Augment current cron execution with chained tasks. This
will allow bringing
+ trigger latency down.
+
+One of these can be an excellent project for beginning
contributors.
+"""
+
+
+import logging
+import urllib
+
+from afterburner import util
+from google.appengine.api
import apiproxy_stub_map
+from google.appengine.api
import datastore
+from google.appengine.api
import urlfetch
+from google.appengine.api.labs import
taskqueue
+from google.appengine.ext
import db
+from google.appengine.ext
import webapp
+from google.appengine.ext.webapp import template
+
+
+PROCESS_URL = "/_ab/triggers/process"
+UPDATE_URL = "/_ab/triggers/update"
+
+
+class Update(db.Model):
+ @classmethod
+ def kind(cls):
+ return "_ab_triggers_Update"
+
+
+class TriggerManager(object):
+ # entity kind => [trigger functions]
+ triggers = {}
+ ignore_deletes = False
+ initialized = False
+
+ @classmethod
+ def pre_hook(cls, service, call, request, response):
+ if call == "Put":
+ extra_entities = []
+ for entity in request.entity_list():
+ key = entity.mutable_key()
+ path = key.mutable_path()
+ last_path_element =
path.element_list()[-1]
+ if (last_path_element.type() ==
Update.kind()
+ or last_path_element.type() not
in cls.triggers):
+ # no triggers for this entity kind.
+ continue
+ if not last_path_element.id() and
not last_path_element.has_name():
+ # assign id to the entity
+ last_path_element.set_id(-1)
+ db_key = db.Key._FromPb(key)
+ allocated_id =
db.allocate_ids(db_key, 1)[0]
+ last_path_element.set_id(allocated_id)
+
+ # Populate entity group, because datastore stub
is stupid.
+ # Actual datastore doesn't need it, but it
won't hurt anyway.
+ group = entity.mutable_entity_group()
+ root = entity.key().path().element(0)
+ group.add_element().CopyFrom(root)
+ update_entity =
Update(
+ key_name=str(db.Key._FromPb(key)),
+ parent=db.Key._FromPb(key))._populate_entity()
+ extra_entities.append(update_entity._ToPb())
+ request.entity_list().extend(extra_entities)
+ elif call == "Delete" and not cls.ignore_deletes:
+ cls.ignore_deletes = True
+ try:
+ if request.has_transaction():
+ for key in request.key_list():
+ update = Update(
+ key_name=str(db.Key._FromPb(key)),
+ parent=db.Key._FromPb(key))
+ db.put(update)
+ else:
+ keys = request.key_list()
+ request.clear_key()
+ for key in keys:
+ # TODO: group keys by entity groups
+ def tx():
+ db_key = db.Key._FromPb(key)
+ update = Update(key_name=str(db_key), parent=db_key)
+ db.put(update)
+ db.delete(db_key)
+ db.run_in_transaction(tx)
+ finally:
+ cls.ignore_deletes = False
+
+ @classmethod
+ def post_hook(cls, service, call, request, response):
+ if call == "Put" and not cls.ignore_deletes:
+ keys = response.key_list()
+ response.clear_key()
+ keys = ([key for
key in keys
+ if key.path().element_list()[-1].type() != Update.kind()])
+ response.key_list().extend(keys)
+
+ @classmethod
+ def init(cls):
+ apiproxy_stub_map.apiproxy.GetPreCallHooks().Append(
+ 'trigger_manager', cls.pre_hook, 'datastore_v3')
+ apiproxy_stub_map.apiproxy.GetPostCallHooks().Append(
+ 'trigger_manager', cls.post_hook, 'datastore_v3')
+
+ @classmethod
+ def init_if_needed(cls):
+ if not cls.initialized:
+ cls.initialized = True
+ cls.init()
+
+ @classmethod
+ def register_trigger(cls, entity_kind, function_name):
+ cls.init_if_needed()
+ # TODO: double registration
+ logging.error("register_trigger: %s, %s", entity_kind, function_name)
+ cls.triggers[entity_kind] = (
+ cls.triggers.get(entity_kind, []) + [function_name])
+
+ @classmethod
+ def get_triggers(cls, entity_kind):
+ return cls.triggers.get(entity_kind)
+
+ @classmethod
+ def process_updates(cls):
+ cls.ignore_deletes = True
+ try:
+ while True:
+ # TODO time limits are needed here
+ updates = Update.all().fetch(limit=50)
+ if not updates:
+ return
+ for update in updates:
+ def tx():
+ db.delete(update.key())
+ taskqueue.add(url=UPDATE_URL,
params={'key': update.key().name()},
+ transactional=True)
+ db.run_in_transaction(tx)
+ finally:
+ cls.ignore_deletes = False
+
+
+class ProcessUpdatesHandler(webapp.RequestHandler):
+ def get(self):
+ TriggerManager.process_updates()
+
+
+class UpdateEntityHandler(webapp.RequestHandler):
+ def post(self):
+ key = db.Key(self.request.get("key"))
+ triggers = TriggerManager.get_triggers(key.kind())
+ if not triggers:
+ return
+ for trigger in triggers:
+ util.for_name(trigger)(key)
+
+
+<div class="viewcode-block" id="trigger"><a class="viewcode-back"
href="../../../../afterburner/experimental/db/triggers.html#afterburner.experimental.db.triggers.trigger">[docs]</a>def trigger(kind):
+ """Trigger registering decorator.
+
+ Args:
+ kind: entity kind to attach defined trigger to.
+ """
+ TriggerManager.init_if_needed()
+ def decorator(f):
+ trigger_name = util.fq_name(f)
+ TriggerManager.register_trigger(kind, trigger_name)
+ return f
+ return decorator
+
+</div>
+application = webapp.WSGIApplication([
+ (PROCESS_URL, ProcessUpdatesHandler),
+ (UPDATE_URL, UpdateEntityHandler),
+ ], debug=True)
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../../search.html" method="get">
+ <input type="text" name="q" size="18" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ 
+ Enter search terms or a module, class or function name.
+ 
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../../../../py-modindex.html" title="Python Module
Index"
+ >modules</a> |</li>
+ <li><a href="../../../../index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
+ <li><a href="../../../index.html" >Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2010, Mike Aizatsky.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
+ </div>
+ </body>
+</html>
=======================================
--- /dev/null
+++ /doc/python/html/_modules/afterburner/experimental/memoize.html Mon Nov
15 04:53:40 2010
@@ -0,0 +1,143 @@
+
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>afterburner.experimental.memoize — Appengine-Afterburner
v0.0.1 documentation</title>
+ <link rel="stylesheet" href="../../../_static/default.css"
type="text/css" />
+ <link rel="stylesheet" href="../../../_static/pygments.css"
type="text/css" />
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '0.0.1',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript"
src="../../../_static/jquery.js"></script>
+ <script type="text/javascript"
src="../../../_static/underscore.js"></script>
+ <script type="text/javascript"
src="../../../_static/doctools.js"></script>
+ <link rel="top" title="Appengine-Afterburner v0.0.1 documentation"
href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
+ <li><a href="../../index.html" accesskey="U">Module code</a>
»</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <h1>Source code for afterburner.experimental.memoize</h1><div
class="highlight"><pre>
+#!/usr/bin/env python
+#
+# Copyright 2010 Google Inc.
+#
+# 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.
+
+"""Containes memoization decorator to
cache function result in memcache.
+
+Usage::
+
+ @memoize('account:name=%s')
+ def get_account_by_name(name):
+ return Account.all().filter('name =',
name).get()
+"""
+
+from google.appengine.api
import memcache
+
+
+DEBUG = False
+
+
+try:
+ # try to obtain debug settings from Django
+ # TODO: introduce debug module which will do this
+ import settings
+ DEBUG = settings.DEBUG
+except:
+ pass
+
+<div class="viewcode-block" id="memoize"><a class="viewcode-back"
href="../../../afterburner/experimental/memoize.html#afterburner.experimental.memoize.memoize">[docs]</a>def memoize(keyformat,
time=60):
+ """Decorator to memoize functions using
memcache."""
+ def decorator(f):
+ def wrapper(*args, **kwargs):
+ key = keyformat % args[0:keyformat.count('%')]
+ data = memcache.get(key)
+ if data is not None:
+ return data
+ data = f(*args, **kwargs)
+ memcache.set(key, data,
time)
+ return data
+ return wrapper
+ return decorator if not DEBUG else f</div>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../search.html" method="get">
+ <input type="text" name="q" size="18" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ 
+ Enter search terms or a module, class or function name.
+ 
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
+ <li><a href="../../index.html" >Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2010, Mike Aizatsky.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
+ </div>
+ </body>
+</html>
=======================================
--- /dev/null
+++ /doc/python/html/_modules/afterburner/experimental/quota.html Mon Nov
15 04:53:40 2010
@@ -0,0 +1,276 @@
+
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>afterburner.experimental.quota — Appengine-Afterburner
v0.0.1 documentation</title>
+ <link rel="stylesheet" href="../../../_static/default.css"
type="text/css" />
+ <link rel="stylesheet" href="../../../_static/pygments.css"
type="text/css" />
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '0.0.1',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript"
src="../../../_static/jquery.js"></script>
+ <script type="text/javascript"
src="../../../_static/underscore.js"></script>
+ <script type="text/javascript"
src="../../../_static/doctools.js"></script>
+ <link rel="top" title="Appengine-Afterburner v0.0.1 documentation"
href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
+ <li><a href="../../index.html" accesskey="U">Module code</a>
»</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <h1>Source code for afterburner.experimental.quota</h1><div
class="highlight"><pre>
+#!/usr/bin/env python
+#
+# Copyright 2010 Google Inc.
+#
+# 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.
+
+"""Contains simple quota system for
rate-limiting arbitrary operations."""
+
+
+from google.appengine.api
import memcache
+
+
+# Memcache namespace to use.
+_QUOTA_NAMESPACE = "ab__quota__"
+
+# Offset all quota values by this amount since memcache
incr/decr
+# operate only with unsigned values.
+_OFFSET = 2**32
+
+<div class="viewcode-block" id="QuotaManager"><a class="viewcode-back"
href="../../../afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaManager">[docs]</a>class QuotaManager(object):
+ """Simple quota system manager, backed
by memcache storage.
+
+ Since memcache storage is not reliable, this quota
system is not reliable and
+ best effort only.
+
+ Quota is managed by buckets. Each bucket contains a
32-bit int value of
+ available quota. Buckets should be refilled manually
with 'put' method.
+
+ It is safe to use a single bucket from multiple clients
simultaneously.
+ """
+
+ def __init__(self,
memcache_client=memcache.Client()):
+ """Initialize new instance.
+
+ Args:
+ memcache_client: an instance of memcache client to
use.
+ """
+ self.memcache_client = memcache_client
+
+<div class="viewcode-block" id="QuotaManager.put"><a class="viewcode-back"
href="../../../afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaManager.put">[docs]</a>
def put(self,
bucket, amount):
+ """Put amount into quota bucket.
+
+ Args:
+ bucket: quota bucket as string.
+ amount: amount to bit put into quota as int.
+ """
+ self.memcache_client.incr(bucket, delta=amount,
+ initial_value=_OFFSET,
namespace=_QUOTA_NAMESPACE)
+</div>
+<div class="viewcode-block" id="QuotaManager.consume"><a
class="viewcode-back"
href="../../../afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaManager.consume">[docs]</a>
def consume(self,
bucket, amount, consume_some=False):
+ """Consume amount from quota
bucket.
+
+ Args:
+ bucket: quota bucket as string.
+ amount: amount to consume.
+ consume_some: specifies behavior in case of not
enough quota. If False,
+ the method will leave quota intact and return 0.
If True, will try to
+ consume as much as possible.
+
+ Returns:
+ Amount of quota consumed.
+ """
+ new_quota = self.memcache_client.decr(
+ bucket, delta=amount, initial_value=_OFFSET, namespace=_QUOTA_NAMESPACE)
+
+ if new_quota >= _OFFSET:
+ return amount
+
+ if consume_some and _OFFSET - new_quota < amount:
+ # we still can consume some
+ self.put(bucket, _OFFSET - new_quota)
+ return amount - (_OFFSET
- new_quota)
+ else:
+ self.put(bucket, amount)
+ return 0
+</div>
+<div class="viewcode-block" id="QuotaManager.get"><a class="viewcode-back"
href="../../../afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaManager.get">[docs]</a>
def get(self,
bucket):
+ """Get current bucket amount.
+
+ Args:
+ bucket: quota bucket as string.
+
+ Returns:
+ current bucket amount as int.
+ """
+ amount = self.memcache_client.get(bucket, namespace=_QUOTA_NAMESPACE)
+ if amount:
+ return int(amount)
- _OFFSET
+ else:
+ return 0
+</div>
+<div class="viewcode-block" id="QuotaManager.set"><a class="viewcode-back"
href="../../../afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaManager.set">[docs]</a>
def set(self,
bucket, amount):
+ """Set bucket amount.
+
+ Args:
+ bucket: quota bucket as string.
+ amount: new bucket amount as int.
+ """
+ self.memcache_client.set(bucket, amount + _OFFSET,
+ namespace=_QUOTA_NAMESPACE)
+
+</div></div>
+<div class="viewcode-block" id="QuotaConsumer"><a class="viewcode-back"
href="../../../afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaConsumer">[docs]</a>class QuotaConsumer(object):
+ """Quota consumer wrapper for efficient
quota consuming/reclaiming.
+
+ Quota is consumed in batches and put back in dispose()
method.
+
+ WARNING: Always call the dispose() method if you need
to keep quota
+ consistent.
+ """
+
+ def __init__(self,
quota_manager, bucket, batch_size):
+ """Initialize new instance.
+
+ Args:
+ quota_manager: quota manager to use for quota
operations as QuotaManager.
+ bucket: quota bucket name as string.
+ batch_size: batch size for quota consuming as
int.
+ """
+ self.quota_manager = quota_manager
+ self.batch_size = batch_size
+ self.bucket = bucket
+ self.quota = 0
+
+<div class="viewcode-block" id="QuotaConsumer.consume"><a
class="viewcode-back"
href="../../../afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaConsumer.consume">[docs]</a>
def consume(self,
amount=1):
+ """Consume quota.
+
+ Args:
+ amount: amount of quota to be consumed as
int.
+
+ Returns:
+ True if quota was successfully consumed, False if
there's not enough
+ quota.
+ """
+ while self.quota <
amount:
+ delta = self.quota_manager.consume(self.bucket, self.batch_size,
+ consume_some=True)
+ if not delta:
+ return False
+ self.quota += delta
+
+ self.quota -= amount
+ return True
+</div>
+<div class="viewcode-block" id="QuotaConsumer.put"><a
class="viewcode-back"
href="../../../afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaConsumer.put">[docs]</a>
def put(self,
amount=1):
+ """Put quota back.
+
+ Args:
+ amount: amount of quota as int.
+ """
+ self.quota += amount
+</div>
+<div class="viewcode-block" id="QuotaConsumer.check"><a
class="viewcode-back"
href="../../../afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaConsumer.check">[docs]</a>
def check(self,
amount=1):
+ """Check that we have enough quota
right now.
+
+ This doesn't lock or consume the quota. Following
consume might in fact
+ fail/succeeded.
+
+ Args:
+ amount: amount of quota to check.
+
+ Returns:
+ True if we have enough quota to consume specified
amount right now. False
+ otherwise.
+ """
+ if self.quota >=
amount:
+ return True
+ return self.quota +
self.quota_manager.get(self.bucket) >= amount
+</div>
+<div class="viewcode-block" id="QuotaConsumer.dispose"><a
class="viewcode-back"
href="../../../afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaConsumer.dispose">[docs]</a>
def dispose(self):
+ """Dispose QuotaConsumer and put all
actually unconsumed quota back.
+
+ This method has to be called for quota
consistency!
+ """
+ self.quota_manager.put(self.bucket, self.quota)</div></div>
+</pre></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../search.html" method="get">
+ <input type="text" name="q" size="18" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ 
+ Enter search terms or a module, class or function name.
+ 
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
+ <li><a href="../../index.html" >Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2010, Mike Aizatsky.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
+ </div>
+ </body>
+</html>
=======================================
--- /dev/null
+++ /doc/python/html/_modules/index.html Mon Nov 15 04:53:40 2010
@@ -0,0 +1,91 @@
+
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Overview: module code — Appengine-Afterburner v0.0.1
documentation</title>
+ <link rel="stylesheet" href="../_static/default.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css"
/>
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '0.0.1',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="top" title="Appengine-Afterburner v0.0.1 documentation"
href="../index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <h1>All modules for which code is available</h1>
+<ul><li><a
href="afterburner/experimental/db/triggers.html">afterburner.experimental.db.triggers</a></li>
+<li><a
href="afterburner/experimental/memoize.html">afterburner.experimental.memoize</a></li>
+<li><a
href="afterburner/experimental/quota.html">afterburner.experimental.quota</a></li>
+</ul>
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" size="18" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ 
+ Enter search terms or a module, class or function name.
+ 
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2010, Mike Aizatsky.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
+ </div>
+ </body>
+</html>
=======================================
--- /dev/null
+++ /doc/python/html/py-modindex.html Mon Nov 15 04:53:40 2010
@@ -0,0 +1,123 @@
+
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Python Module Index — Appengine-Afterburner v0.0.1
documentation</title>
+ <link rel="stylesheet" href="_static/default.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '',
+ VERSION: '0.0.1',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <link rel="top" title="Appengine-Afterburner v0.0.1 documentation"
href="index.html" />
+
+
+
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="#" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+
+ <h1>Python Module Index</h1>
+
+ <div class="modindex-jumpbox">
+ <a href="#cap-a">a</a>
+ </div>
+
+ <table class="indextable modindextable" cellspacing="0" cellpadding="2">
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap"><td></td><td><a name="cap-a">
+ a</a></td><td></td></tr>
+ <tr>
+ <td><img src="_static/minus.png" id="toggle-1"
+ class="toggler" style="display: none" alt="-" /></td>
+ <td>
+ <tt class="xref">afterburner</tt></td><td>
+ </td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a
href="afterburner/experimental/db/triggers.html#module-afterburner.experimental.db.triggers"><tt
class="xref">afterburner.experimental.db.triggers</tt></a></td><td>
+ </td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a
href="afterburner/experimental/memoize.html#module-afterburner.experimental.memoize"><tt
class="xref">afterburner.experimental.memoize</tt></a></td><td>
+ </td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a
href="afterburner/experimental/quota.html#module-afterburner.experimental.quota"><tt
class="xref">afterburner.experimental.quota</tt></a></td><td>
+ </td></tr>
+ </table>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" size="18" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ 
+ Enter search terms or a module, class or function name.
+ 
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="#" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2010, Mike Aizatsky.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
+ </div>
+ </body>
+</html>
=======================================
--- /dev/null
+++ /trunk/python/doc/Makefile Mon Nov 15 04:53:40 2010
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS = -c .
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = ../../../doc/python
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER))
$(SPHINXOPTS) ../src
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp
devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or
PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " changes to make an overview of all changed/added/deprecated
items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if
enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator
$(BUILDDIR)/qthelp/Appengine-Afterburner.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile
$(BUILDDIR)/qthelp/Appengine-Afterburner.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/Appengine-Afterburner"
+ @echo "# ln -s $(BUILDDIR)/devhelp
$$HOME/.local/share/devhelp/Appengine-Afterburner"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ make -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
=======================================
--- /dev/null
+++ /trunk/python/doc/conf.py Mon Nov 15 04:53:40 2010
@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# Appengine-Afterburner documentation build configuration file, created by
+# sphinx-quickstart on Thu Oct 21 14:10:12 2010.
+#
+# This file is execfile()d with the current directory set to its
containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another
directory,
+# add these directories to sys.path here. If the directory is relative to
the
+# documentation root, use os.path.abspath to make it absolute, like shown
here.
+sys.path.insert(0, os.path.abspath('./../src'))
+
+# -- General configuration
-----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions =
['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Appengine-Afterburner'
+copyright = u'2010, Mike Aizatsky'
+
+# The version info for the project you're documenting, acts as replacement
for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to
some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output
---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a
theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this
directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as
html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the
top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of
the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or
32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets)
here,
+# relative to this directory. They are copied after the builtin static
files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page
bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is
True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is
True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages
will
+# contain a <link> tag referring to it. The value of this option must be
the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Appengine-Afterburnerdoc'
+
+
+# -- Options for LaTeX output
--------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
[howto/manual]).
+latex_documents = [
+ ('index', 'Appengine-Afterburner.tex', u'Appengine-Afterburner
Documentation',
+ u'Mike Aizatsky', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the
top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are
parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output
--------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'appengine-afterburner', u'Appengine-Afterburner
Documentation',
+ [u'Mike Aizatsky'], 1)
+]
=======================================
--- /trunk/python/Makefile Fri Nov 5 21:29:00 2010
+++ /dev/null
@@ -1,130 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-BUILDDIR = ../../doc/python
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER))
$(SPHINXOPTS) src
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp
devhelp epub latex latexpdf text man changes linkcheck doctest
-
-help:
- @echo "Please use \`make <target>' where <target> is one of"
- @echo " html to make standalone HTML files"
- @echo " dirhtml to make HTML files named index.html in directories"
- @echo " singlehtml to make a single large HTML file"
- @echo " pickle to make pickle files"
- @echo " json to make JSON files"
- @echo " htmlhelp to make HTML files and a HTML help project"
- @echo " qthelp to make HTML files and a qthelp project"
- @echo " devhelp to make HTML files and a Devhelp project"
- @echo " epub to make an epub"
- @echo " latex to make LaTeX files, you can set PAPER=a4 or
PAPER=letter"
- @echo " latexpdf to make LaTeX files and run them through pdflatex"
- @echo " text to make text files"
- @echo " man to make manual pages"
- @echo " changes to make an overview of all changed/added/deprecated
items"
- @echo " linkcheck to check all external links for integrity"
- @echo " doctest to run all doctests embedded in the documentation (if
enabled)"
-
-clean:
- -rm -rf $(BUILDDIR)/*
-
-html:
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-dirhtml:
- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-singlehtml:
- $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
- @echo
- @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-
-pickle:
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
- @echo
- @echo "Build finished; now you can process the pickle files."
-
-json:
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
- @echo
- @echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
- @echo
- @echo "Build finished; now you can run HTML Help Workshop with the" \
- ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
- $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
- @echo
- @echo "Build finished; now you can run "qcollectiongenerator" with the" \
- ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
- @echo "# qcollectiongenerator
$(BUILDDIR)/qthelp/Appengine-Afterburner.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile
$(BUILDDIR)/qthelp/Appengine-Afterburner.qhc"
-
-devhelp:
- $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
- @echo
- @echo "Build finished."
- @echo "To view the help file:"
- @echo "# mkdir -p $$HOME/.local/share/devhelp/Appengine-Afterburner"
- @echo "# ln -s $(BUILDDIR)/devhelp
$$HOME/.local/share/devhelp/Appengine-Afterburner"
- @echo "# devhelp"
-
-epub:
- $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
- @echo
- @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-
-latex:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo
- @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
- @echo "Run \`make' in that directory to run these through (pdf)latex" \
- "(use \`make latexpdf' here to do that automatically)."
-
-latexpdf:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo "Running LaTeX files through pdflatex..."
- make -C $(BUILDDIR)/latex all-pdf
- @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-text:
- $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
- @echo
- @echo "Build finished. The text files are in $(BUILDDIR)/text."
-
-man:
- $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
- @echo
- @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
-
-changes:
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
- @echo
- @echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
- @echo
- @echo "Link check complete; look for any errors in the above output " \
- "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
- @echo "Testing of doctests in the sources finished, look at the " \
- "results in $(BUILDDIR)/doctest/output.txt."
=======================================
--- /trunk/python/src/conf.py Fri Nov 5 21:29:00 2010
+++ /dev/null
@@ -1,216 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Appengine-Afterburner documentation build configuration file, created by
-# sphinx-quickstart on Thu Oct 21 14:10:12 2010.
-#
-# This file is execfile()d with the current directory set to its
containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys, os
-
-# If extensions (or modules to document with autodoc) are in another
directory,
-# add these directories to sys.path here. If the directory is relative to
the
-# documentation root, use os.path.abspath to make it absolute, like shown
here.
-sys.path.insert(0, os.path.abspath('./../src'))
-
-# -- General configuration
-----------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be
extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions =
['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'Appengine-Afterburner'
-copyright = u'2010, Mike Aizatsky'
-
-# The version info for the project you're documenting, acts as replacement
for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '0.0.1'
-# The full version, including alpha/beta/rc tags.
-release = '0.0.1'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to
some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = []
-
-# The reST default role (used for this markup: `text`) to use for all
documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-
-# -- Options for HTML output
---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-html_theme = 'default'
-
-# Theme options are theme-specific and customize the look and feel of a
theme
-# further. For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this
directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar. Default is the same as
html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the
top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of
the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or
32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets)
here,
-# relative to this directory. They are copied after the builtin static
files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page
bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is
True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is
True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages
will
-# contain a <link> tag referring to it. The value of this option must be
the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'Appengine-Afterburnerdoc'
-
-
-# -- Options for LaTeX output
--------------------------------------------------
-
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
-
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass
[howto/manual]).
-latex_documents = [
- ('index', 'Appengine-Afterburner.tex', u'Appengine-Afterburner
Documentation',
- u'Mike Aizatsky', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the
top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are
parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output
--------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- ('index', 'appengine-afterburner', u'Appengine-Afterburner
Documentation',
- [u'Mike Aizatsky'], 1)
-]
=======================================
--- /doc/python/doctrees/afterburner/experimental/db/triggers.doctree Fri
Nov 5 21:31:46 2010
+++ /doc/python/doctrees/afterburner/experimental/db/triggers.doctree Mon
Nov 15 04:53:40 2010
Binary file, no diff available.
=======================================
--- /doc/python/doctrees/afterburner/experimental/memoize.doctree Fri Nov
5 21:31:46 2010
+++ /doc/python/doctrees/afterburner/experimental/memoize.doctree Mon Nov
15 04:53:40 2010
Binary file, no diff available.
=======================================
--- /doc/python/doctrees/afterburner/experimental/quota.doctree Fri Nov 5
21:31:46 2010
+++ /doc/python/doctrees/afterburner/experimental/quota.doctree Mon Nov 15
04:53:40 2010
Binary file, no diff available.
=======================================
--- /doc/python/doctrees/environment.pickle Fri Nov 5 21:31:46 2010
+++ /doc/python/doctrees/environment.pickle Mon Nov 15 04:53:40 2010
Binary file, no diff available.
=======================================
--- /doc/python/doctrees/index.doctree Fri Nov 5 21:31:46 2010
+++ /doc/python/doctrees/index.doctree Mon Nov 15 04:53:40 2010
Binary file, no diff available.
=======================================
--- /doc/python/html/afterburner/experimental/db/triggers.html Fri Nov 5
21:31:46 2010
+++ /doc/python/html/afterburner/experimental/db/triggers.html Mon Nov 15
04:53:40 2010
@@ -31,6 +31,9 @@
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
<li><a href="../../../index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
</ul>
</div>
@@ -40,9 +43,138 @@
<div class="bodywrapper">
<div class="body">

- <div class="section" id="triggers-module">
-<h1>Triggers Module<a class="headerlink" href="#triggers-module"
title="Permalink to this headline">¶</a></h1>
+ <div class="section" id="module-afterburner.experimental.db.triggers">
+<h1>Triggers Module<a class="headerlink"
href="#module-afterburner.experimental.db.triggers" title="Permalink to
this headline">¶</a></h1>
+This module contains datastore trigger system implementation.
+<div class="section" id="overview">
+<h2>Overview<a class="headerlink" href="#overview" title="Permalink to
this headline">¶</a></h2>
+The system is designed to execute user’s code every time an
entity of specific
+kind is changed by application. Right now the only execution model is
delayed
+execution (via taskqueue), which makes it useful only in
eventually-consistent
+scenarios.
+It is important to remember that:
+<ul class="simple">
+<li>Triggers won’t be fired if you change your data not from the app
itself (e.g.
+admin console).</li>
+<li>There might be a delay (sometimes even minute) between actual data
change and
+trigger execution.</li>
+<li>Trigger executions for a single entity are batched. I.e. if you change
entity
+quickly multiple times you’ll most likely get your trigger function
called
+only once.</li>
+</ul>
+Current Limitations:
+<ul class="simple">
+<li>Right now only cron-based updates processing is implemented. This
means that
+the delay between event and trigger processing might be about 1 minute in
+worst case.</li>
+<li>Due to limitations of current datastore api batch deletes are executed
+by triggers module as separate transactions. This may decrease performance
+of deleting code quite a lot.</li>
+<li>It is estimated that with this design you won’t be able to
process more than
+60 changes per second. See the implementation details and planned
improvements
+sections for more details.</li>
+</ul>
</div>
+<div class="section" id="usage">
+<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this
headline">¶</a></h2>
+To use triggers:
+<ul>
+<li>Add the following code to your app.yaml:
+<div class="highlight-python"><pre>includes:
+- afterburner/experimental/db/triggers.yaml</pre>
+</div>
+</li>
+<li>Add following lines to your cron.yaml:
+<div class="highlight-python"><pre>cron:
+- description: triggers processing
+ url: /_ab/triggers/process
+ schedule: every 1 minutes</pre>
+</div>
+</li>
+<li>Create appengine_config.py in application root
directory and import your
+modules with all trigger definitions from it.
+</li>
+<li>Define triggers as following:
+<div class="highlight-python"><div class="highlight"><pre>from afterburner.experimental.db
import triggers
+@triggers.trigger(kind=Order.kind())
+def order_trigger(key):
+ logging.debug("Order
was changed: %s", key)
+</pre></div>
+</div>
+Trigger function only argument is changed entity key. Because trigger
execution
+is decoupled in time from actual db operation, the information about
operation
+is not provided.
+</li>
+<li>Make sure that you’re using run_wsgi_app()
function to run your app and not
+older approach. For details check appengine documentation:
+<a class="reference external"
href="http://code.google.com/appengine/docs/python/tools/webapp/running.html">http://code.google.com/appengine/docs/python/tools/webapp/running.html</a>
+</li>
+</ul>
+</div>
+<div class="section" id="implementation-details">
+<h2>Implementation Details<a class="headerlink"
href="#implementation-details" title="Permalink to this headline">¶</a></h2>
+To implement transactionally-safe triggers for every entity change we
detect,
+we create a child “Update” entity, which is later processed by
updater
+cron job. Updater cron job deletes Update entities and queues tasks for
executing
+triggers for particular entities.
+Adding child entities to puts doesn’t change runtime behavior of
the system
+at all, because datastore internally groups all entities in batch puts into
+entity groups and performs their write together in one transaction
automatically.
+Unfortunately it’s currently not possible to use the same
approach to batch
+deletes. We disassemble batch delete and delete each entity individually in
+its own transaction together with creating an update entity.
+Ideally datastore should provide an api where you can batch all kinds of
+operations together.
+</div>
+<div class="section" id="alternative-approaches">
+<h2>Alternative Approaches<a class="headerlink"
href="#alternative-approaches" title="Permalink to this headline">¶</a></h2>
+This section outlines alternative approaches to triggers system
designs. Some
+of these approaches can augment already existing ones to improve
performance
+and other characteristics.
+<div class="section" id="transactional-tasks">
+<h3>Transactional Tasks<a class="headerlink" href="#transactional-tasks"
title="Permalink to this headline">¶</a></h3>
+Instead of creating update tasks it’s possible to use
transactional tasks
+to queue triggers processing for each entity. This works perfectly for
+writes in transaction, but doesn’t work good in case of batch
operations
+across multiple entity groups: you have to disassemble both puts and gets
+the same way we disassemble deletes right now.
+The benefit of this approach is that by eliminating Update entity and
+update processor, trigger latency can be made quite low.
+Another caveat with this approach is task’s 10K payload size
limit and limit
+of 5 transactional tasks per transaction. If there are lots of entities in
a
+single transaction, it might be difficult to store keys for all of them
+in 5 tasks. However, it looks like this limitation is not a problem for
most
+apps.
+</div>
+<div class="section" id="immediate-triggers-execution">
+<h3>Immediate Triggers Execution<a class="headerlink"
href="#immediate-triggers-execution" title="Permalink to this
headline">¶</a></h3>
+It was a specific goal for this library to implement delayed triggers
execution.
+Immediate trigger execution can be significant utility for certain use
cases.
+</div>
+</div>
+<div class="section" id="future-improvements">
+<h2>Future Improvements<a class="headerlink" href="#future-improvements"
title="Permalink to this headline">¶</a></h2>
+Following improvements to the library are considered:
+<ul class="simple">
+<li>Use transactional tasks for triggers enqueing in situtations where
it’s
+possible (non-batched puts/deletes, small transactions)</li>
+<li>Optional unbatched trigger execution</li>
+<li>Augment current cron execution with chained tasks. This will allow
bringing
+trigger latency down.</li>
+</ul>
+One of these can be an excellent project for beginning contributors.
+<dl class="function">
+<dt id="afterburner.experimental.db.triggers.trigger">
+<tt class="descclassname">afterburner.experimental.db.triggers.</tt><tt
class="descname">trigger</tt><big>(</big>kind<big>)</big><a
class="reference internal"
href="../../../_modules/afterburner/experimental/db/triggers.html#trigger">[source]</a><a class="headerlink"
href="#afterburner.experimental.db.triggers.trigger" title="Permalink to
this definition">¶</a></dt>
+<dd>Trigger registering decorator.
+<dl class="docutils">
+<dt>Args:</dt>
+<dd>kind: entity kind to attach defined trigger to.</dd>
+</dl>
+</dd></dl>
+
+</div>
+</div>

</div>
@@ -50,6 +182,22 @@
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
+ <h3><a href="../../../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Triggers Module</a><ul>
+<li><a class="reference internal" href="#overview">Overview</a></li>
+<li><a class="reference internal" href="#usage">Usage</a></li>
+<li><a class="reference internal"
href="#implementation-details">Implementation Details</a></li>
+<li><a class="reference internal"
href="#alternative-approaches">Alternative Approaches</a><ul>
+<li><a class="reference internal"
href="#transactional-tasks">Transactional Tasks</a></li>
+<li><a class="reference internal"
href="#immediate-triggers-execution">Immediate Triggers Execution</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#future-improvements">Future
Improvements</a></li>
+</ul>
+</li>
+</ul>
+
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a
href="../../../_sources/afterburner/experimental/db/triggers.txt"
@@ -78,6 +226,9 @@
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
>index</a></li>
+ <li class="right" >
+ <a href="../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
<li><a href="../../../index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
</ul>
</div>
=======================================
--- /doc/python/html/afterburner/experimental/memoize.html Fri Nov 5
21:31:46 2010
+++ /doc/python/html/afterburner/experimental/memoize.html Mon Nov 15
04:53:40 2010
@@ -31,6 +31,9 @@
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
<li><a href="../../index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
</ul>
</div>
@@ -40,9 +43,22 @@
<div class="bodywrapper">
<div class="body">

- <div class="section" id="memoize-module">
-<h1>Memoize Module<a class="headerlink" href="#memoize-module"
title="Permalink to this headline">¶</a></h1>
+ <div class="section" id="module-afterburner.experimental.memoize">
+<h1>Memoize Module<a class="headerlink"
href="#module-afterburner.experimental.memoize" title="Permalink to this
headline">¶</a></h1>
+Containes memoization decorator to cache function result in
memcache.
+Usage:
+<div class="highlight-python"><div class="highlight"><pre>@memoize('account:name=%s')
+def get_account_by_name(name):
+ return Account.all().filter('name =', name).get()
+</pre></div>
</div>
+<dl class="function">
+<dt id="afterburner.experimental.memoize.memoize">
+<tt class="descclassname">afterburner.experimental.memoize.</tt><tt
class="descname">memoize</tt><big>(</big>keyformat,
time=60<big>)</big><a class="reference internal"
href="../../_modules/afterburner/experimental/memoize.html#memoize">[source]</a><a class="headerlink"
href="#afterburner.experimental.memoize.memoize" title="Permalink to this
definition">¶</a></dt>
+<dd>Decorator to memoize functions using memcache.
+</dd></dl>
+
+</div>

</div>
@@ -78,6 +94,9 @@
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
+ <li class="right" >
+ <a href="../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
<li><a href="../../index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
</ul>
</div>
=======================================
--- /doc/python/html/afterburner/experimental/quota.html Fri Nov 5
21:31:46 2010
+++ /doc/python/html/afterburner/experimental/quota.html Mon Nov 15
04:53:40 2010
@@ -31,6 +31,9 @@
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
<li><a href="../../index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
</ul>
</div>
@@ -40,8 +43,126 @@
<div class="bodywrapper">
<div class="body">

- <div class="section" id="quota-module">
-<h1>Quota Module<a class="headerlink" href="#quota-module"
title="Permalink to this headline">¶</a></h1>
+ <div class="section" id="module-afterburner.experimental.quota">
+<h1>Quota Module<a class="headerlink"
href="#module-afterburner.experimental.quota" title="Permalink to this
headline">¶</a></h1>
+Contains simple quota system for rate-limiting arbitrary operations.
+<dl class="class">
+<dt id="afterburner.experimental.quota.QuotaConsumer">
+class <tt
class="descclassname">afterburner.experimental.quota.</tt><tt
class="descname">QuotaConsumer</tt><big>(</big>quota_manager,
bucket, batch_size<big>)</big><a class="reference
internal"
href="../../_modules/afterburner/experimental/quota.html#QuotaConsumer">[source]</a><a class="headerlink"
href="#afterburner.experimental.quota.QuotaConsumer" title="Permalink to
this definition">¶</a></dt>
+<dd>Quota consumer wrapper for efficient quota consuming/reclaiming.
+Quota is consumed in batches and put back in dispose() method.
+WARNING: Always call the dispose() method if you need to keep quota
+consistent.
+<dl class="method">
+<dt id="afterburner.experimental.quota.QuotaConsumer.check">
+<tt class="descname">check</tt><big>(</big>amount=1<big>)</big><a
class="reference internal"
href="../../_modules/afterburner/experimental/quota.html#QuotaConsumer.check">[source]</a><a class="headerlink"
href="#afterburner.experimental.quota.QuotaConsumer.check" title="Permalink
to this definition">¶</a></dt>
+<dd>Check that we have enough quota right now.
+This doesn’t lock or consume the quota. Following consume might
in fact
+fail/succeeded.
+<dl class="docutils">
+<dt>Args:</dt>
+<dd>amount: amount of quota to check.</dd>
+<dt>Returns:</dt>
+<dd>True if we have enough quota to consume specified amount right now.
False
+otherwise.</dd>
+</dl>
+</dd></dl>
+
+<dl class="method">
+<dt id="afterburner.experimental.quota.QuotaConsumer.consume">
+<tt
class="descname">consume</tt><big>(</big>amount=1<big>)</big><a
class="reference internal"
href="../../_modules/afterburner/experimental/quota.html#QuotaConsumer.consume">[source]</a><a class="headerlink"
href="#afterburner.experimental.quota.QuotaConsumer.consume"
title="Permalink to this definition">¶</a></dt>
+<dd>Consume quota.
+<dl class="docutils">
+<dt>Args:</dt>
+<dd>amount: amount of quota to be consumed as int.</dd>
+<dt>Returns:</dt>
+<dd>True if quota was successfully consumed, False if there’s not
enough
+quota.</dd>
+</dl>
+</dd></dl>
+
+<dl class="method">
+<dt id="afterburner.experimental.quota.QuotaConsumer.dispose">
+<tt class="descname">dispose</tt><big>(</big><big>)</big><a
class="reference internal"
href="../../_modules/afterburner/experimental/quota.html#QuotaConsumer.dispose">[source]</a><a class="headerlink"
href="#afterburner.experimental.quota.QuotaConsumer.dispose"
title="Permalink to this definition">¶</a></dt>
+<dd>Dispose QuotaConsumer and put all actually unconsumed quota
back.
+This method has to be called for quota consistency!
+</dd></dl>
+
+<dl class="method">
+<dt id="afterburner.experimental.quota.QuotaConsumer.put">
+<tt class="descname">put</tt><big>(</big>amount=1<big>)</big><a
class="reference internal"
href="../../_modules/afterburner/experimental/quota.html#QuotaConsumer.put">[source]</a><a class="headerlink"
href="#afterburner.experimental.quota.QuotaConsumer.put" title="Permalink
to this definition">¶</a></dt>
+<dd>Put quota back.
+<dl class="docutils">
+<dt>Args:</dt>
+<dd>amount: amount of quota as int.</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="afterburner.experimental.quota.QuotaManager">
+class <tt
class="descclassname">afterburner.experimental.quota.</tt><tt
class="descname">QuotaManager</tt><big>(</big>memcache_client=<google.appengine.api.memcache.Client
object at 0x18eab70><big>)</big><a class="reference internal"
href="../../_modules/afterburner/experimental/quota.html#QuotaManager">[source]</a><a class="headerlink"
href="#afterburner.experimental.quota.QuotaManager" title="Permalink to
this definition">¶</a></dt>
+<dd>Simple quota system manager, backed by memcache storage.
+Since memcache storage is not reliable, this quota system is not
reliable and
+best effort only.
+Quota is managed by buckets. Each bucket contains a 32-bit int value of
+available quota. Buckets should be refilled manually with
‘put’ method.
+It is safe to use a single bucket from multiple clients
simultaneously.
+<dl class="method">
+<dt id="afterburner.experimental.quota.QuotaManager.consume">
+<tt class="descname">consume</tt><big>(</big>bucket,
amount, consume_some=False<big>)</big><a class="reference
internal"
href="../../_modules/afterburner/experimental/quota.html#QuotaManager.consume">[source]</a><a class="headerlink"
href="#afterburner.experimental.quota.QuotaManager.consume"
title="Permalink to this definition">¶</a></dt>
+<dd>Consume amount from quota bucket.
+<dl class="docutils">
+<dt>Args:</dt>
+<dd>bucket: quota bucket as string.
+amount: amount to consume.
+consume_some: specifies behavior in case of not enough quota. If False,
+<blockquote class="last">
+the method will leave quota intact and return 0. If True, will try to
+consume as much as possible.</blockquote>
+</dd>
+<dt>Returns:</dt>
+<dd>Amount of quota consumed.</dd>
+</dl>
+</dd></dl>
+
+<dl class="method">
+<dt id="afterburner.experimental.quota.QuotaManager.get">
+<tt class="descname">get</tt><big>(</big>bucket<big>)</big><a
class="reference internal"
href="../../_modules/afterburner/experimental/quota.html#QuotaManager.get">[source]</a><a class="headerlink"
href="#afterburner.experimental.quota.QuotaManager.get" title="Permalink to
this definition">¶</a></dt>
+<dd>Get current bucket amount.
+<dl class="docutils">
+<dt>Args:</dt>
+<dd>bucket: quota bucket as string.</dd>
+<dt>Returns:</dt>
+<dd>current bucket amount as int.</dd>
+</dl>
+</dd></dl>
+
+<dl class="method">
+<dt id="afterburner.experimental.quota.QuotaManager.put">
+<tt class="descname">put</tt><big>(</big>bucket,
amount<big>)</big><a class="reference internal"
href="../../_modules/afterburner/experimental/quota.html#QuotaManager.put">[source]</a><a class="headerlink"
href="#afterburner.experimental.quota.QuotaManager.put" title="Permalink to
this definition">¶</a></dt>
+<dd>Put amount into quota bucket.
+<dl class="docutils">
+<dt>Args:</dt>
+<dd>bucket: quota bucket as string.
+amount: amount to bit put into quota as int.</dd>
+</dl>
+</dd></dl>
+
+<dl class="method">
+<dt id="afterburner.experimental.quota.QuotaManager.set">
+<tt class="descname">set</tt><big>(</big>bucket,
amount<big>)</big><a class="reference internal"
href="../../_modules/afterburner/experimental/quota.html#QuotaManager.set">[source]</a><a class="headerlink"
href="#afterburner.experimental.quota.QuotaManager.set" title="Permalink to
this definition">¶</a></dt>
+<dd>Set bucket amount.
+<dl class="docutils">
+<dt>Args:</dt>
+<dd>bucket: quota bucket as string.
+amount: new bucket amount as int.</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
</div>

@@ -78,6 +199,9 @@
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
+ <li class="right" >
+ <a href="../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
<li><a href="../../index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
</ul>
</div>
=======================================
--- /doc/python/html/genindex.html Fri Nov 5 21:31:46 2010
+++ /doc/python/html/genindex.html Mon Nov 15 04:53:40 2010
@@ -31,6 +31,9 @@
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
<li><a href="index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
</ul>
</div>
@@ -44,8 +47,87 @@
<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
-
+ <a href="#A">A</a> | <a
href="#C">C</a> | <a href="#D">D</a> | <a
href="#G">G</a> | <a href="#M">M</a> | <a
href="#P">P</a> | <a href="#Q">Q</a> | <a
href="#S">S</a> | <a href="#T">T</a>
</div>
+<h2 id="A">A</h2>
+<table width="100%" class="indextable genindextable"><tr>
+ <td width="33%" valign="top"><dl>
+ <dt><a
href="afterburner/experimental/db/triggers.html#module-afterburner.experimental.db.triggers">afterburner.experimental.db.triggers
(module)</a></dt>
+ <dt><a
href="afterburner/experimental/memoize.html#module-afterburner.experimental.memoize">afterburner.experimental.memoize
(module)</a></dt>
+</dl></td>
+ <td width="33%" valign="top"><dl>
+ <dt><a
href="afterburner/experimental/quota.html#module-afterburner.experimental.quota">afterburner.experimental.quota
(module)</a></dt>
+</dl></td>
+</tr></table>
+
+<h2 id="C">C</h2>
+<table width="100%" class="indextable genindextable"><tr>
+ <td width="33%" valign="top"><dl>
+ <dt><a
href="afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaConsumer.check">check()
(afterburner.experimental.quota.QuotaConsumer method)</a></dt>
+</dl></td>
+ <td width="33%" valign="top"><dl>
+ <dt><a
href="afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaConsumer.consume">consume()
(afterburner.experimental.quota.QuotaConsumer method)</a></dt>
+ <dd><dl>
+ <dt><a
href="afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaManager.consume">(afterburner.experimental.quota.QuotaManager
method)</a></dt>
+ </dl></dd>
+</dl></td>
+</tr></table>
+
+<h2 id="D">D</h2>
+<table width="100%" class="indextable genindextable"><tr>
+ <td width="33%" valign="top"><dl>
+ <dt><a
href="afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaConsumer.dispose">dispose()
(afterburner.experimental.quota.QuotaConsumer method)</a></dt>
+</dl></td>
+</tr></table>
+
+<h2 id="G">G</h2>
+<table width="100%" class="indextable genindextable"><tr>
+ <td width="33%" valign="top"><dl>
+ <dt><a
href="afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaManager.get">get()
(afterburner.experimental.quota.QuotaManager method)</a></dt>
+</dl></td>
+</tr></table>
+
+<h2 id="M">M</h2>
+<table width="100%" class="indextable genindextable"><tr>
+ <td width="33%" valign="top"><dl>
+ <dt><a
href="afterburner/experimental/memoize.html#afterburner.experimental.memoize.memoize">memoize()
(in module afterburner.experimental.memoize)</a></dt>
+</dl></td>
+</tr></table>
+
+<h2 id="P">P</h2>
+<table width="100%" class="indextable genindextable"><tr>
+ <td width="33%" valign="top"><dl>
+ <dt><a
href="afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaConsumer.put">put()
(afterburner.experimental.quota.QuotaConsumer method)</a></dt>
+ <dd><dl>
+ <dt><a
href="afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaManager.put">(afterburner.experimental.quota.QuotaManager
method)</a></dt>
+ </dl></dd>
+</dl></td>
+</tr></table>
+
+<h2 id="Q">Q</h2>
+<table width="100%" class="indextable genindextable"><tr>
+ <td width="33%" valign="top"><dl>
+ <dt><a
href="afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaConsumer">QuotaConsumer
(class in afterburner.experimental.quota)</a></dt>
+</dl></td>
+ <td width="33%" valign="top"><dl>
+ <dt><a
href="afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaManager">QuotaManager
(class in afterburner.experimental.quota)</a></dt>
+</dl></td>
+</tr></table>
+
+<h2 id="S">S</h2>
+<table width="100%" class="indextable genindextable"><tr>
+ <td width="33%" valign="top"><dl>
+ <dt><a
href="afterburner/experimental/quota.html#afterburner.experimental.quota.QuotaManager.set">set()
(afterburner.experimental.quota.QuotaManager method)</a></dt>
+</dl></td>
+</tr></table>
+
+<h2 id="T">T</h2>
+<table width="100%" class="indextable genindextable"><tr>
+ <td width="33%" valign="top"><dl>
+ <dt><a
href="afterburner/experimental/db/triggers.html#afterburner.experimental.db.triggers.trigger">trigger()
(in module afterburner.experimental.db.triggers)</a></dt>
+</dl></td>
+</tr></table>
+

</div>
@@ -79,6 +161,9 @@
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
<li><a href="index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
</ul>
</div>
=======================================
--- /doc/python/html/index.html Fri Nov 5 21:31:46 2010
+++ /doc/python/html/index.html Mon Nov 15 04:53:40 2010
@@ -31,6 +31,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
<li><a href="#">Appengine-Afterburner v0.0.1 documentation</a>
»</li>
</ul>
</div>
@@ -53,11 +56,11 @@
<div class="section" id="experimental-modules">
<h2>Experimental Modules<a class="headerlink" href="#experimental-modules"
title="Permalink to this headline">¶</a></h2>
<ul class="simple">
-<li><tt class="xref py py-mod docutils literal">afterburner.experimental.quota</tt> - simple
memcache-based quota
+<li><a class="reference internal"
href="afterburner/experimental/quota.html#module-afterburner.experimental.quota"
title="afterburner.experimental.quota"><tt class="xref py py-mod docutils
literal">afterburner.experimental.quota</tt></a> -
simple memcache-based quota
system for rate-limiting operations.</li>
-<li><tt class="xref py py-mod docutils literal">afterburner.experimental.memoize</tt> - function
decorator to cache
+<li><a class="reference internal"
href="afterburner/experimental/memoize.html#module-afterburner.experimental.memoize"
title="afterburner.experimental.memoize"><tt class="xref py py-mod docutils
literal">afterburner.experimental.memoize</tt></a>
- function decorator to cache
function value in memcache.</li>
-<li><tt class="xref py py-mod docutils literal">afterburner.experimental.db.triggers</tt> - datastore
triggers system.</li>
+<li><a class="reference internal"
href="afterburner/experimental/db/triggers.html#module-afterburner.experimental.db.triggers"
title="afterburner.experimental.db.triggers"><tt class="xref py py-mod
docutils literal">afterburner.experimental.db.triggers</tt></a> -
datastore triggers system.</li>
</ul>
</div>
<div class="section" id="indices-and-tables">
@@ -114,6 +117,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
<li><a href="#">Appengine-Afterburner v0.0.1 documentation</a>
»</li>
</ul>
</div>
=======================================
--- /doc/python/html/objects.inv Fri Nov 5 21:31:46 2010
+++ /doc/python/html/objects.inv Mon Nov 15 04:53:40 2010
@@ -2,5 +2,16 @@
# Project: Appengine-Afterburner
# Version: 0.0.1
# The remainder of this file is compressed using zlib.
-xÚËÍOÉÌKIP(.I±ÊILJÍQÐ5T(¨ÔÍ
-Jèe”äæ(+øæ§”æ¤*x‚„¸ÒSó°h‚‰Bu@” §& %g *„ˆA• C $¦§r ßæ1
+xÚ½TËNÃ0 ¼÷+,Á5 ¹öÊ‰C% _àØ[ÇÂ Ô ©ðõ$u,¹PÀ
+˜Kdmfgf ¶2Lh Gä<ÛJÒƒDM‡Æ×F-?ðà•¼A;Ã‚ ô0‡6
+ô
+¤ ]2"Ô ±t8 ÆØ {Ž€GÂaCö
+l ¬ ‹á8‚
+´' ‚ñdrµUÑÆ
+Ê m mOÐÈ
+ÁÍ-j¾ff=öVp Ö•ñ³¾M å*
+” oP¦°€ËÙ?v§+êN‰áÜø>hê
+ÑßÑŸYÿÙ3~š¿;¢§á[< * ü`Ø Ed ÷F» &
+€¾¬+óy¸µ:ä ^‡’ _[ãò
+ë®¸aW ™ 7 ÿ°MñP{(3?•Ä¹JuÔâO;U¥MÙ^¥Cé3õ÷
+ûí[õ ¶’ÈÀ
=======================================
--- /doc/python/html/search.html Fri Nov 5 21:31:46 2010
+++ /doc/python/html/search.html Mon Nov 15 04:53:40 2010
@@ -37,6 +37,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
<li><a href="index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
</ul>
</div>
@@ -85,6 +88,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
<li><a href="index.html">Appengine-Afterburner v0.0.1
documentation</a> »</li>
</ul>
</div>
=======================================
--- /doc/python/html/searchindex.js Fri Nov 5 21:31:46 2010
+++ /doc/python/html/searchindex.js Mon Nov 15 04:53:40 2010
@@ -1,1 +1,1 @@
-Search.setIndex({objects:{},terms:{oper:0,code:0,modul:[0,1,2,3],appengin:0,system:0,rate:0,tabl:0,stabl:0,speed:0,librari:0,index:0,decor:0,develop:0,trigger:[0,2],detail:0,current:0,experiment:0,memoiz:[0,1],lot:0,simpl:0,"function":0,applic:0,contribut:0,relat:0,quota:[0,3],base:0,indic:0,java:0,datastor:0,memcach:0,cach:0,valu:0,reusabl:0,search:0,see:0,structur:0,project:0,limit:0,contain:0,afterburn:0,about:0,page:0},objtypes:{},titles:["Appengine-Afterburner","Memoize
Module","Triggers
Module","Quota
Module"],objnames:{},filenames:["index","afterburner/experimental/memoize","afterburner/experimental/db/triggers","afterburner/experimental/quota"]})
+Search.setIndex({objects:{},terms:{oper:0,code:0,modul:0,appengin:0,detail:0,rate:0,tabl:0,stabl:0,speed:0,librari:0,index:0,decor:0,develop:0,trigger:0,system:0,current:0,experiment:0,memoiz:0,lot:0,simpl:0,"function":0,applic:0,contribut:0,see:0,relat:0,quota:0,base:0,indic:0,java:0,datastor:0,cach:0,valu:0,reusabl:0,search:0,memcach:0,structur:0,project:0,limit:0,contain:0,afterburn:0,about:0,page:0},objtypes:{},titles:["Appengine-Afterburner"],objnames:{},filenames:["index"]})
=======================================
--- /trunk/python/build.sh Fri Nov 5 21:22:06 2010
+++ /trunk/python/build.sh Mon Nov 15 04:53:40 2010
@@ -14,7 +14,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

-dir=$(dirname $(readlink -f $0) )
+dir=$(dirname $0)

if [ -z $APPENGINE_SDK ]; then
echo "APPENGINE_SDK environment variable shoud be defined and should
point to appengine sdk folder"
@@ -56,6 +56,7 @@

doc () {
cd $dir/doc
+ echo `pwd`
make html
}

Reply all

Reply to author

Forward

0 new messages