App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | Public Attributes | List of all members
google.appengine.tools.handler.OverlappedHandler Class Reference
Inheritance diagram for google.appengine.tools.handler.OverlappedHandler:
google.appengine.tools.handler.Handler

Public Member Functions

def __init__
 
def GetProperty
 
def __eq__
 
def AddMatchingHandler
 
- Public Member Functions inherited from google.appengine.tools.handler.Handler
def __init__
 
def regex
 
def Regexify
 
def MatchesString
 
def MatchesAll
 
def HasMoreSpecificPatternThan
 
def __eq__
 
def IsFullyHandledBy
 

Public Attributes

 matchers
 
 pattern
 
- Public Attributes inherited from google.appengine.tools.handler.Handler
 is_literal
 

Additional Inherited Members

- Static Public Attributes inherited from google.appengine.tools.handler.Handler
list ALL_PROPERTIES
 
- Properties inherited from google.appengine.tools.handler.Handler
 pattern = property(_GetPattern, _SetPattern)
 

Detailed Description

Subclass of Handler which allows for the combination of SimpleHandlers.

An intuitive way to think about globbed patterns is as sets - for example, the
pattern "admin/*" is the set of all paths that are in the admin/ directory,
and the pattern "*.txt" is the set of all paths to text files. An
OverlappedHandler is designed to describe the intersection of the sets
of paths - ie the set of paths that is matched by EVERY one its
handler patterns.

In the Xml files, paths are specified in different places - in servlet
patterns, in static files includes, in security constraint specifications,
etc. There is often some overlap between the paths that are specified by
these patterns. Since App.Yaml does not have separate places to specify how
different paths are handled, but rather just lists paths along with a bunch
of ways that the paths is handled, we need to make sure that these properties
for various paths are being combined at some point in the translation process.

Thus an OverlappedHandler holds a list of "matchers" - ie. handlers with more
general patterns, to choose properties from. OverlappedHandlers do not
explicitly specify properties but rather choose the value from the most
specific "matcher" with the value of that property specified. The matchers
are SimpleHandlers.

Attributes:
  pattern: inherited from Handler.
  matchers: A list of SimpleHandlers. Matchers are handlers which happen to
    match OverlappedHandler's pattern and whose properties are thus necessary
    to track in order to make sure that OverlappedHandler's pattern is handled
    correctly.

Member Function Documentation

def google.appengine.tools.handler.OverlappedHandler.AddMatchingHandler (   self,
  matcher 
)
Flattens the handler if it is overlapped and adds to matchers.
def google.appengine.tools.handler.OverlappedHandler.GetProperty (   self,
  prop,
  default = None 
)
Returns the property value of matcher with most specific pattern.

The documentation for this class was generated from the following file: