[Subversion] / WebHaiku / web_haiku.py  

Diff of /WebHaiku/web_haiku.py

Parent Directory | Revision Log

version 2261, Sun Jan 14 06:00:18 2007 UTC version 2269, Thu Jan 18 03:14:19 2007 UTC
Line 4 
Line 4 
 from wsgiref.util import shift_path_info, application_uri  from wsgiref.util import shift_path_info, application_uri
   
 __all__ = [  __all__ = [
     "HTTP", "validator", "Template", "HTML", "Text", "Page", "Container",      "Page", "form_handler", "HTML", "Text", "Template", "HTTP",
     "Form", "EvalTemplate", "EvalMap", "Method",      "EvalTemplate", "EvalMap", "Method",
 ]  ]
   
 class HTTP(object):  class Method(object):
     cls_registry = "http_methods"      """Turn any object into a method"""
     def __init__(self, func):      def __init__(self, func):
         self.func = func          self.call = func
   
     def __get__(self, ob, typ=None):      def __get__(self, ob, typ=None):
         if ob is None: return self          if ob is None: return self
         return self.func.__get__(ob,typ)          return new.instancemethod(self.call, ob, typ)
   
 def validator(func):  class HTTP(Method):
     func.cls_registry = "registered_validators"      """Wrapper/decorator that marks an object as an HTTP method"""
   
       cls_registry = "http_methods"
   
   def form_handler(arg):
       """Decorator that marks an object as a registered validator"""
       def decorator(func):
           func.cls_registry = "form_handlers"
           func.priority = priority, func.__name__
     return func      return func
       if isinstance(arg, type(form_handler)):
           priority = 0
           return decorator(arg)
       return decorator
   
 text_plain = ('Content-Type', 'text/plain')  text_plain = ('Content-Type', 'text/plain')
 text_html  = ('Content-Type', 'text/html')  text_html  = ('Content-Type', 'text/html')
   
 def get_module():  def get_module():
     return sys._getframe(2).f_globals.get('__name__')      return sys._getframe(2).f_globals.get('__name__', __name__)
   
   
   
   
   
   
   
   
   
   
   
   
   
   
 sentinel = object()  sentinel = object()
   
 class EvalMap(object):  class EvalMap(object):
     """Object that translates from getitem->getattr"""      """Object that translates from getitem->getattr"""
   
     def __init__(self, ob, extra={}):      def __init__(self, page, extra={}, module=__name__):
         self.ob = ob          self.page = page
         self.extra = dict(extra)    # always copy, to allow mod by listcomps          self.extra = dict(extra)    # always copy, to allow mod by listcomps
           self.module = module
   
     def __setitem__(self, key, value):  # needed for listcomp exprs!      def __setitem__(self, key, value):  # needed for listcomp exprs!
         self.extra[key] = value          self.extra[key] = value
Line 56 
Line 57 
   
     def __getitem__(self, key):      def __getitem__(self, key):
         if key.startswith('(?'):          if key.startswith('(?'):
             return eval(key[2:].rstrip('?)').strip(), globals(), self)              return eval(
                   key[2:].rstrip(')').rstrip('?').strip(),
                   sys.modules[self.module].__dict__, self
               )
         elif key in self.extra:          elif key in self.extra:
             return self.extra[key]              return self.extra[key]
         else:          else:
             ob = getattr(self.ob, key, sentinel)              ob = getattr(self.page, key, sentinel)
             if ob is not sentinel:              if ob is not sentinel:
                 return ob                  return ob
               g = sys.modules[self.module].__dict__
               if key in g:
                   return g[key]
         if key=='self':          if key=='self':
             return self              return self
         raise KeyError          raise KeyError(key)
   
 class EvalTemplate(string.Template):  class EvalTemplate(string.Template):
     idpattern = r'[_a-z][_a-z0-9]*|\(\?[^?]*\?\)'      idpattern = r'[_a-z][_a-z0-9]*|\(\?[^?]*\?\)'
   
   
 class Method(object):  
     def __init__(self, func):  
         self.call = func  
   
     def __get__(self, ob, typ=None):  
         if ob is None: return self  
         return new.instancemethod(self.call, ob, typ)  
   
   
 class Text(Method):  class Text(Method):
     """Text template w/string substitution that can be used as a method      """Text template w/string substitution that can be used as a method
   
     Note: templates cannot be directly invoked from the web unless wrapped in      Note: templates cannot be directly invoked from the web unless they
     HTTP() as a request method like GET or POST.      are created with Text.page() or Text.http_method(), or used as a Page's
       ``body`` attribute.
     """      """
   
       cls_registry = None
     factory = EvalTemplate      factory = EvalTemplate
     status  = '200 OK'      status  = '200 OK'
     headers = text_plain,      headers = text_plain,
Line 115 
Line 118 
              body = resource_string(self.caller, self.resource)               body = resource_string(self.caller, self.resource)
              self.template = self.factory(body, **self.options)               self.template = self.factory(body, **self.options)
              self.resource = None               self.resource = None
         return self.template.substitute(EvalMap(page, kw))          return self.template.substitute(EvalMap(page, kw, self.caller))
   
   
     @classmethod      @classmethod
     def fragment(cls, *args, **kw):      def fragment(cls, *args, **kw):
           """Template property that returns its rendered body"""
         return property(cls(caller = get_module(), *args, **kw).render)          return property(cls(caller = get_module(), *args, **kw).render)
   
     @classmethod      @classmethod
     def function(cls, *args, **kw):      def http_method(cls, *args, **kw):
           """Template that can be used as an HTTP method (GET, POST, PUT, etc.)"""
           return cls(
               caller=get_module(), cls_registry='http_methods', *args, **kw
           )
   
       @classmethod
       def method(cls, *args, **kw):
           """Template method that can be called with keyword arguments"""
         return Method(cls(caller = get_module(), *args, **kw).render)          return Method(cls(caller = get_module(), *args, **kw).render)
   
       @classmethod
       def page(cls, *args, **kw):
           """Template sub-page (returns a Page subclass w/template as its body)
   
           If you supply a `type` keyword argument, that type is used as the base
           class for the page.  The other arguments are used to create the
           template to be used as the returned class' ``body`` attribute.
           """
           caller = get_module()
           class _Page(kw.get('type',Page)):
               body = cls(caller=caller, *args, **kw)
           return _Page
   
   
   
   
   
   
   
   
   
   
   
   
 class HTML(Text):  class HTML(Text):
     """HTML template w/string substitution that can be used as a method      """HTML template w/string substitution that can be used as a method
   
     Note: templates cannot be directly invoked from the web unless wrapped in      Note: templates cannot be directly invoked from the web unless they
     HTTP() as a request method like GET or POST.      are created with HTML.page() or HTML.http_method(), or used as a Page's
       ``body`` attribute.
     """      """
     headers = text_html,      headers = text_html,
   
Line 137 
Line 175 
 class Template(HTML):  class Template(HTML):
     """TurboGears/Buffet template that can be used as a method      """TurboGears/Buffet template that can be used as a method
   
     Note: templates cannot be directly invoked from the web unless wrapped in      Note: templates cannot be directly invoked from the web unless they
     HTTP() as a request method like GET or POST.      are created with Template.page() or Template.http_method(), or used as a
       Page's ``body`` attribute.
     """      """
   
     engine = None      engine = None
Line 155 
Line 194 
         return name          return name
   
     def render(self, page, kw={}):      def render(self, page, kw={}):
         return self.engine.render(EvalMap(page,kw), template=self.template)          return self.engine.render(
               EvalMap(page,kw,self.caller), template=self.template
           )
   
   
   
   
   
   
 class Page:  class Page(object):
     """A page with no children"""      """A generic web location"""
   
     cls_registry = "pages"      cls_registry = "sub_pages"
     http_methods = []      http_methods = []
       sub_pages = []
       body = None
   
     class __metaclass__(type):      class __metaclass__(type):
         def __init__(cls, name, bases, cdict):          def __init__(cls, name, bases, cdict):
Line 182 
Line 225 
             self = type.__call__(cls, *args, **kw)              self = type.__call__(cls, *args, **kw)
             return self.go()              return self.go()
   
     def __init__(self, environ, start_response):      def __init__(self, environ, start_response, **kw):
         self.environ = environ          self.environ = environ
         self.start_response = start_response          self.start_response = start_response
         self.errors = []          cls = type(self)
           for k, v in kw.items():
     def go(self):              getattr(cls,k)  # AttributeError here means bad keyword arg
         rm = self.environ['REQUEST_METHOD']              setattr(self,k,v)
         if rm in self.http_methods:          self.setup()    # perform any dynamic initialization
             return getattr(self, rm)()  
   
         return self._method_not_allowed(  
             [('Allow', ', '.join(self.http_methods))]  
         )  
   
     @HTTP  
     def HEAD(self):      def HEAD(self):
         resp = iter(self.GET())     # this will fail if no GET!          environ['REQUEST_METHOD'] = 'GET'
           resp = iter(self.invoke_method())   # forward to 'GET'
         list(resp)      # questionable hack to exhaust the response          list(resp)      # questionable hack to exhaust the response
         return resp     # ensure that .close() gets called, if any          return resp     # ensure that .close() gets called, if any
   
   
     _method_not_allowed = Text(  
         "405 Method not allowed", status="405 Method not allowed",  
     )  
   
     _redirect = HTML(  
         '<html><head>'  
         '<meta http-equiv="refresh" content="0;url=$url" />'  
         '</head><body><a href="$url">Click here</a></body></html>',  
         status='302 Found',  
     )  
   
     def redirect(self, url, ):  
         return self._redirect([('Location', url)], url=url)  
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
       def go(self):
           self.URL = application_uri(self.environ)
           name = shift_path_info(self.environ)
           if name:
               return self.handle_child(name)
   
           url = self.URL.rstrip('/')
           leaf = not self.sub_pages and type(self).handle_child == Page.handle_child
   
           if name=='':    # trailing /
               if not leaf or self.environ.get('SCRIPT_NAME')=='/':
                   return self.invoke_method()
           elif name is None:    # no trailing /
               if leaf:
                   return self.invoke_method()
               url += '/'  # add the trailing /
           return self.redirect(url)
   
       def handle_child(self, name):
           if name in self.sub_pages:
               return getattr(self, name)(
                   self.environ, self.start_response, parent=self
               )
           return self.NOT_FOUND()
   
       def redirect(self, url):
           return self.REDIRECT_TO([('Location', url)], url=url)
   
       def setup(self):
           self.errors = []
           self.db = getattr(self.parent, 'db', None)
   
       parent = None
   
   
   
   
   
   
 class Container(Page):  
     """A page that may have children, and delegates to them"""  
   
     def go(self):  
         name = shift_path_info(self.environ)  
         if name=='':  
             # it's us, not our contents, handle normally  
             return super(Container, self).go()  
   
         if name is None:  
             # They left off the trailing / - redirect so relative URLs will  
             # be correct...  
             url = application_uri(self.environ)  
             if not url.endswith('/'):  
                 url += '/'  
             return self.redirect(url)  
   
         sub_app = self[name]      def invoke_method(self):
         if sub_app is not None:          rm = self.environ['REQUEST_METHOD']
             return sub_app(self.environ, self.start_response)          if rm=='HEAD' or rm in self.http_methods:
               return getattr(self, rm)()
           elif rm=='GET' and self.body is not None:
               return self.body()
           elif rm=='POST' and self.form_handlers:
               return self.POST()
   
           methods = set(self.http_methods)    # Compute available methods
           if self.body is not None:
               methods.add('GET')
           if 'GET' in methods:
               methods.add('HEAD')
           if self.form_handlers:
               methods.add('POST')
   
           return self.METHOD_NOT_ALLOWED([('Allow', ', '.join(methods))])
   
       METHOD_NOT_ALLOWED = Text(
           "Excellent method!\n"
           "Alas, my response must be:\n"
           '"I cannot comply."',
           status="405 Method not allowed",
       )
   
         return self.not_found()      REDIRECT_TO = HTML(
           '<html><head>'
           '<meta http-equiv="refresh" content="0;url=$url" />'
           '</head><body><a href="$url">Click here</a></body></html>',
           status='302 Found',
       )
   
     not_found = Text(      NOT_FOUND = Text(
         "404 not found\n"          "404 not found\n"
         "You deserve a kinder note\n"          "You deserve a kinder note\n"
         "Than this web haiku!\n",          "Than this web haiku!\n",
         status  = '404 Not Found',          status  = '404 Not Found',
     )      )
   
     def __getitem__(self, key):  
         if key in self.pages:  
             return getattr(self, key)  
   
   
   
   
   
   
       form_handlers = []
       form_parsed = False
       form_data = ()
       form_defaults = {}
       escape = cgi.escape
   
       def get_handlers(self):
           handlers = [getattr(self,k) for k in self.form_handlers]
           handlers.sort(key=lambda h: h.priority)
           return handlers
   
       def __getattr__(self, name):
           """Dynamic attributes from form_data and defaults"""
           if name in self.form_defaults:  # form vars must be explicitly listed
               if name in self.form_data:
                   return self.form_data[name].value
               return self.form_defaults[name]
           raise AttributeError(name)
   
 class Form(Page):      def parse_form(self):
     """A page with POST processing, form parsing, validation, etc."""          """Ensure that self.form_data contains a FieldStorage, and return it"""
     registered_validators = []          if not self.form_parsed:
     data = {}              self.form_data = cgi.FieldStorage(
     defaults = {}                  self.environ['wsgi.input'], environ=self.environ
     def get_validators(self):              )
         return self.registered_validators              self.form_parsed = True
           return self.form_data
   
     def validate(self):      def POST(self):
         for k in self.get_validators():          self.parse_form()
             response = getattr(self,k)()          for handler in self.get_handlers():
               response = handler()
             if response:              if response:
                 return response                  return response
   
     def __getattr__(self, name):          if self.errors:
         if not name.startswith('__'):              return self.form_failure()
             try:          else:
                 return self.data[name].value              return self.form_success()
             except KeyError:  
                 if name in self.defaults:  
                     return self.defaults[name]  
         raise AttributeError(name)  
   
     succeed = Text("Oops.  Someone forgot to create a form or method here.")  
   
     GET = HTTP(succeed) # you should replace this with the form's template  
   
     def parse(self):      # A miserably inadequate attempt at a decent UI...
         self.data = cgi.FieldStorage(  
             self.environ['wsgi.input'], environ=self.environ  
         )  
   
     errors_found = HTML.fragment(      errors_found = HTML.fragment(
         '<ul class="form_errors"><li class="form_error">'          '<ul class="form_errors"><li class="form_error">'
Line 325 
Line 377 
   
     show_errors = property(lambda self: self.errors and self.errors_found or '')      show_errors = property(lambda self: self.errors and self.errors_found or '')
   
       form_failure = HTML(
     @HTTP  
     def POST(self):  
         self.parse()  
         response = self.validate()  
         if response:  
             return response  
         elif self.errors:  
             return self.fail()  
         else:  
             return self.succeed()  
   
     # A miserably inadequate attempt at a decent UI...  
     fail = HTML(  
         "<html><head>"          "<html><head>"
         "<title>Sorry, we couldn't process your request</title></head>\n<body>"          "<title>Sorry, we couldn't process your request</title></head>\n<body>"
         "<h2>Sorry, we couldn't process your request</h2>\n"          "<h2>Sorry, we couldn't process your request</h2>\n"
Line 350 
Line 389 
     )      )
   
   
       form_success = Text(
           "Oops.  Someone forgot to create a template or method here."
       )
   
   
   
   
Line 365 
Line 408 
   
   
   
       db = None   # DBAPI database connection object
   
       def db_connect(self):
           """Override this in a subclass to return a DBAPI connection object"""
           raise NotImplementedError
   
       def cursor(self, *args, **kw):
           """Create and return a cursor (after optionally running a query on it)
   
           If positional arguments are supplied, they're passed to the cursor's
           ``execute()`` method.  If keyword arguments are supplied, they are
           used to set cursor attributes prior to the ``execute()`` (if
           applicable).
           """
           db = self.db
           if db is None:
               db = self.db = self.db_connect()
   
 class TestForm(Form):          cursor = db.cursor()
           for k, v in kw.items():
               setattr(cursor, k, v)
   
           if args:
               cursor.execute(*args)
   
           return cursor
   
       def query(self, *args, **kw):
           csr = self.cursor(*args, **kw)
           return (Row(csr,r) for rows in iter(csr.fetchmany,[]) for r in rows)
   
   
   class Row(object):
       """Easy-access dict/object wrapper for DBAPI row tuples"""
   
       def __init__(self, cursor, row):
           self.__dict__ = dict(zip([d[0]for d in cursor.description], row))
   
   
   
   
   class TestForm(Page):
     """A stupid example to test the framework"""      """A stupid example to test the framework"""
   
     defaults = dict(name='Joey', animal='Dog', email='joe@dog.com')      form_defaults = dict(name='Joey', animal='Dog', email='joe@dog.com')
   
     fail = HTML("""<?xml version="1.0" encoding="iso-8859-1"?>      body = form_failure = HTML("""<?xml version="1.0" encoding="iso-8859-1"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">  <html xmlns="http://www.w3.org/1999/xhtml">
Line 382 
Line 464 
  <form method="post">   <form method="post">
   <table>    <table>
    <tr><td>What is your name ?</td>     <tr><td>What is your name ?</td>
        <td><input type="text" name="name" value="$name"/></td></tr>         <td><input type="text" name="name" value="$(?escape(name)?)"/></td></tr>
    <tr><td>What is your favorite animal ?</td>     <tr><td>What is your favorite animal ?</td>
        <td><input type="text" name="animal" value="$animal"/></td></tr>         <td><input type="text" name="animal" value="$(?escape(animal)?)"/></td></tr>
    <tr><td>What is your email address ?</td>     <tr><td>What is your email address ?</td>
        <td><input type="text" name="email" value="$email"/></td></tr>         <td><input type="text" name="email" value="$(?escape(email)?)"/></td></tr>
    <tr><td colspan="2"><input type="submit" /></td></tr>     <tr><td colspan="2"><input type="submit" /></td></tr>
   </table>    </table>
  </form>   </form>
 </body>  </body>
 </html>  </html>
 """)  """)
     succeed = Text("Hey Joe!")      form_success = Text("Hey Joe!")
     GET = HTTP(fail)  
   
     @validator      @form_handler
     def check_joe(self):      def check_joe(self):
         if self.name!='Joe': self.errors.append("Hey, you're not Joe!")          if self.name!='Joe': self.errors.append("Hey, you're not Joe!")
   
Line 408 
Line 489 
     )      )
   
   
 class TestContainer(Container):  
   
     GET = HTTP(HTML("""<?xml version="1.0" encoding="iso-8859-1"?>  class TestContainer(Page):
   
       body = HTML("""<?xml version="1.0" encoding="iso-8859-1"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">  <html xmlns="http://www.w3.org/1999/xhtml">
Line 419 
Line 501 
     <ul><li><a href="a">Hello world</a></li><li><a href="b">Hello Joe</a></li>      <ul><li><a href="a">Hello world</a></li><li><a href="b">Hello Joe</a></li>
     <li><a href="c">Subcontainer</a></li>      <li><a href="c">Subcontainer</a></li>
     </ul>      </ul>
 </body></html>"""))  </body></html>""")
   
     class a(Page):  
         GET = HTTP(Text("Hello world!"))  
   
       a = Text.page("Hello world!")
     b = TestForm      b = TestForm
       c = Page   # placeholder
     c = Container   # placeholder  
   
 TestContainer.c = TestContainer     # allow some depth to the test...  TestContainer.c = TestContainer     # allow some depth to the test...
   
Line 449 
Line 528 
   
   
   
   
   
   

Generate output suitable for use with a patch program
Legend:
Removed from v.2261  
changed lines
  Added in v.2269
cvs-admin@eby-sarna.com

Powered by ViewCVS 1.0-dev

ViewCVS and CVS Help