app/README
author Sverre Rabbelier <srabbelier@gmail.com>
Sat, 06 Dec 2008 14:23:53 +0000
changeset 679 77a286ff6667
parent 153 79d52c2d50a2
child 1502 2fee94feef59
permissions -rw-r--r--
Introduce dynamic scope_path regexps Instead of relying on scope_path's being "one slash deep", we should instead allow for either: 1. scope_paths that have a pre-defined depth 2. scope_paths that can be arbitrarily deep We achieve 1 by setting an entities scope_logic to another logic module. We then recursively call getScopeDepth until we get to the topmost entity (that is, an unscoped entity). A little different is the solution to 2, since some entities can have an arbitrarily deep scope (such as Documents), we need to have some way of signaling this to getScopePattern. A clean solution is to return None, rather than a number. If None is returned, the SCOPE_PATH_ARG_PATTERN is returned as regexp instead, which will match an arbitrarily deeply nested scope. The solution for 2 requires that we return None somewhere in the scope_logic chain, the most straight forward method to do so is to override getScopeDepth anywhere such a scope is needed and make it return None. A more elegant solution however, is to set the scope_logic to that module in all entities that require it. Patch by: Sverre Rabbelier

trunk/app should contain only the files needed for the actual Google App
Engine application "image".  Support code that is not part of the application
image belongs elsewhere, such as in trunk/scripts, for example.

= THIRD PARTY CODE =

Third-party code that is *not* part of the application image (the Google App
Engine SDK in trunk/thirdparty/google_appengine, for example) belongs in
trunk/thirdparty (see also trunk/thirdparty/README).

Third-party code that is part of the application image is placed in a package
subdirectory in trunk/app, such as trunk/app/django, for example.

If the third-party package is a single Python source file, place the code in
trunk/app/<package>/__init__.py, so that it can simply be imported using,
for example:

import feedparser

(The trunk/app/feedparser package is a good example of this approach.)

== THIRD PARTY LICENSES ==

Third-party code must also include a license text file, named LICENSE or
COPYING, in the package subdirectory.  If the third-party package subdirectory
is maintained automatically with a tool such as svn_load_dirs.pl (which
removes files, such as license text files, that were added later to the
"target" directory), place the license text file in the trunk/app directory
and add the package name as a suffix (LICENSE.django is an example of this
case).