[Subversion] / WebHaiku / README.txt  

Diff of /WebHaiku/README.txt

Parent Directory | Revision Log

version 2276, Tue Jan 23 03:26:51 2007 UTC version 2277, Wed Jan 24 01:45:35 2007 UTC
Line 10 
Line 10 
 TurboGears/Buffet template engine plugins.  (In which case, setuptools and the  TurboGears/Buffet template engine plugins.  (In which case, setuptools and the
 appropriate plugin(s) are also required.)  appropriate plugin(s) are also required.)
   
   
   Pages and HTTP Methods
   ======================
   
 WebHaiku uses classes to represent web-accessible objects::  WebHaiku uses classes to represent web-accessible objects::
   
     >>> from web_haiku import Page, test, HTML      >>> from web_haiku import Page, test, HTML
Line 40 
Line 44 
     <BLANKLINE>      <BLANKLINE>
     <BLANKLINE>      <BLANKLINE>
   
 But ``POST`` requests are not (because we didn't define any form handlers)::  But ``POST`` requests are not (because we didn't define any form handlers; see
   the `Form Handling`_ section, below)::
   
     >>> test(HelloPage, form={"a":"b"})      >>> test(HelloPage, form={"a":"b"})
     HTTP/1.0 405 Method not allowed      HTTP/1.0 405 Method not allowed
Line 53 
Line 58 
     "I cannot comply."      "I cannot comply."
   
 Notice that the response contains an automatically-generated ``Allow:`` header,  Notice that the response contains an automatically-generated ``Allow:`` header,
 listing the request methods implemented.  You can add to the allowed methods by  listing the HTTP methods implemented.  You can add to these allowed methods by
 defining ``HTTP`` methods::  defining ``HTTP`` methods::
   
     >>> from web_haiku import HTTP      >>> from web_haiku import HTTP
Line 83 
Line 88 
     Alas, my response must be:      Alas, my response must be:
     "I cannot comply."      "I cannot comply."
   
   
   Child URLs
   ==========
   
 By default, pages have no child URLs, and any attempt to access such URLs  By default, pages have no child URLs, and any attempt to access such URLs
 results in a 404 response::  results in a 404 response::
   
Line 96 
Line 105 
     Than this web haiku!      Than this web haiku!
     ...      ...
   
 But you can create subpages using either template objects, or embedded  But you can create subpages using template objects, embedded ``Page`` classes,
 classes::  or ``@expose`` methods (or `Dynamic Children`_ as described later below)::
   
       >>> from web_haiku import expose
   
     >>> class Container(Page):      >>> class Container(Page):
     ...     x = HTML.page("This is page X")      ...     x = HTML.page("This is page X")
       ...
     ...     class y(Page):      ...     class y(Page):
     ...         body = HTML("This is page Y")      ...         body = HTML("This is page Y")
       ...
       ...     @expose
       ...     def z(self):
       ...         self.start_response(
       ...             "200 Yeah!", [('Content-type','text/plain')]
       ...         )
       ...         return ['I be da Z!']
   
     >>> test(Container, PATH_INFO="/x")      >>> test(Container, PATH_INFO="/x")
     HTTP/1.0 200 OK      HTTP/1.0 200 OK
Line 114 
Line 133 
     ...      ...
     This is page Y      This is page Y
   
 Also note that even if a page has children, it must still have a ``body`` of      >>> test(Container, PATH_INFO="/z")
       HTTP/1.0 200 Yeah!
       ...
       I be da Z!
   
   
   
   Dynamic Children
   ----------------
   
   You can implement dynamic child URLs by overriding the ``handle_child()``
   method of your pages...  XXX
   
   
   
   
   Special URL Handling for Container Pages and Leaf Pages
   -------------------------------------------------------
   
   Note that even if a page has children, it must still have a ``body`` of
 its own to support ``GET`` operations::  its own to support ``GET`` operations::
   
     >>> test(Container)      >>> test(Container)
Line 158 
Line 196 
     ...<meta http-equiv="refresh" content="0;url=http://127.0.0.1/x?y" />...      ...<meta http-equiv="refresh" content="0;url=http://127.0.0.1/x?y" />...
   
   
 .handle_child(), .body(), .redirect(),  Redirection
   ===========
   
       >>> class InlineRedirect(Page):
       ...     def body(self):
       ...         return self.redirect('http://example.com/123')
   
       >>> test(InlineRedirect)
       HTTP/1.0 302 Found
       Date: ...
       Content-Type: text/html
       Location: http://example.com/123
       ...
       ...<meta http-equiv="refresh" content="0;url=http://example.com/123" />...
   
       >>> from web_haiku import Redirector
       >>> class TemplateRedirect(Page):
       ...     body = Redirector('http://example.com/$(?environ["REQUEST_METHOD"]?)')
   
       >>> test(TemplateRedirect)
       HTTP/1.0 302 Found
       Date: ...
       Content-Type: text/html
       Location: http://example.com/GET
       ...
       ...<meta http-equiv="refresh" content="0;url=http://example.com/GET" />...
   
   
   XXX REDIRECT_TO
   
   
 Forms  Form Handling
 =====  =============
   
     >>> from web_haiku import Text, form_handler      >>> from web_haiku import Text, form_handler
     >>> class TestForm(Page):      >>> class TestForm(Page):

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

Powered by ViewCVS 1.0-dev

ViewCVS and CVS Help