Mercurial > cgi-bin > hgweb.cgi > tincan
annotate doc/api_reference.rst @ 63:8867b3a5c4fa draft
Some minor fixes.
| author | David Barts <n5jrn@me.com> |
|---|---|
| date | Thu, 20 Jun 2019 21:52:30 -0700 |
| parents | fd8c558a89bb |
| children |
| rev | line source |
|---|---|
| 61 | 1 ************* |
| 2 API Reference | |
| 3 ************* | |
| 4 | |
| 5 =================== | |
| 6 The Launch Function | |
| 7 =================== | |
| 8 | |
| 9 .. function:: launch(fsroot=None, urlroot='/', multithread=True, logger=None, encoding='utf-8', static=False) | |
| 10 | |
| 11 Launch and return a TinCan webapp object. Returns a tuple containing two items: an instance of ``tincan.TinCan`` and an error count. This function *does not run or serve the webapp;* it is the caller's responsibility to perform one of the latter operations. This function accepts the following keyword arguments: | |
| 12 | |
| 13 *fsroot* | |
| 14 Path to the root directory of this webapp on the filesystem. If no path is specified, the current working directory will be used. | |
| 15 | |
| 16 *urlroot* | |
| 17 This defines a directory prefix that is added to all routes. It is mostly for use by the ``launch`` shell command; when running under WSGI this should almost always be left to default to ``/``. | |
| 18 | |
| 19 *multithread* | |
| 20 By default, TinCan assumes that multiple threads per process are being used. Setting this parameter to ``False`` will result in code that fails to multithread properly, but which runs more efficiently while not multithreading. It is recommended to set this to ``False`` if you are not going to be using multithreading. | |
| 21 | |
| 22 *logger* | |
| 23 If set, the name of the Python ``logging.Logger`` object to use for logging. If not set, no messages will be logged. | |
| 24 | |
| 25 *encoding* | |
| 26 Character set used by all text files in the webapp. Note that this is different from the character set that TinCan will use to serve responses; the latter is inevitably UTF-8. | |
| 27 | |
| 28 *static* | |
| 29 Whether or not to create routes to serve static content in the webapp. If you're using the built-in server, this should probably be ``True``. If you're running via WSGI, it should probably be ``False``. | |
| 30 | |
| 31 ================= | |
| 32 The TinCan Object | |
| 33 ================= | |
| 34 | |
| 35 This is a subclass of ``bottle.Bottle``. It is not intended for end users to create instances of this object themselves; use the ``launch`` function above to do that. | |
| 36 | |
| 37 This class contains one extra method above and beyond the methods ``bottle.Bottle`` objects have: | |
| 38 | |
| 39 .. method:: forward(target) | |
| 40 | |
|
62
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
41 Perform a programmatic, request-time, server-side redirect to the route specified by *target*, which may be either relative to the route issuing the redirect or an absolute route. This differs from the ``#forward`` header directive in that this method causes a server-side redirect to be set up the time a request is processed, not the when a route is created. That makes this method both more flexible and less efficient than ``#forward``. |
| 61 | 42 |
| 43 One may only forward from a normal page to another normal page; neither the source nor the target of a forward may be an error page. Attempts to create forward loops will also cause an error. | |
| 44 | |
| 45 TinCan Configuration Variables | |
| 46 ------------------------------ | |
| 47 | |
| 48 The ``config`` dictionary of a ``TinCan`` object contains ``tincan.fsroot``, ``tincan.urlroot``, ``tincan.logger``, and ``tincan.encoding`` keys (in addition to the standard ones defined by WSGI and Bottle); these contain the values of the corresponding parameters passed to the ``launch`` function that created this webapp. In general, any key starting with ``tincan.`` is reserved for use by TinCan. | |
| 49 | |
| 50 ============================= | |
| 51 Page, BasePage, and ErrorPage | |
| 52 ============================= | |
| 53 | |
| 54 These classes are typically subclassed in the code-behind for a page. Any page without code-behind will get a bare ``Page`` or ``ErrorPage`` object associated with it, as appropriate. | |
| 55 | |
| 56 .. class:: tincan.BasePage | |
| 57 | |
| 58 This is the parent class of all code-behind classes. All such classes contain two standard methods: | |
| 59 | |
| 60 .. method:: handle() | |
| 61 | |
| 62 The ``handle`` method is called by TinCan to handle a request. No arguments are passed to it (other than the implied ``self`` argument). By default, this is a no-op method. | |
| 63 | |
| 64 .. method:: export() | |
| 65 | |
|
62
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
66 This is called by TinCan to export template variables; it must return a ``dict`` or ``dict``-like object. |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
67 |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
68 The default implementation exports all non-hidden instance variables; moreover, it does not export attributes that define callable objects (e.g. methods). A "hidden" instance variable means any one whose name *does not* start with an underscore; the ``request`` and ``response`` instance variables of class ``tincan.Page`` are also considered hidden. Finally, ``self`` is exported as the ``page`` variable. |
| 61 | 69 |
| 70 Note that the exporting happens *after* header processing; thus, if there is a conflict between a template variable defined by the ``#load`` header directive and this exporting logic, the value exported by this method will always overwrite the earlier one. | |
| 71 | |
| 72 If the above exporting behavior is for some reason unsuitable, it is permitted to override this method. | |
| 73 | |
|
62
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
74 .. class:: tincan.Page |
| 61 | 75 |
|
62
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
76 The parent class of all normal (non-error) pages. |
| 61 | 77 |
|
62
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
78 .. class:: tincan.ErrorPage |
| 61 | 79 |
| 80 The parent class of all error pages. | |
| 81 | |
|
62
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
82 ========== |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
83 Exceptions |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
84 ========== |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
85 |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
86 .. class:: tincan.TinCanException |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
87 |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
88 The parent class of all exceptions TinCan raises. |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
89 |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
90 .. class:: tincan.TemplateHeaderError |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
91 |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
92 Raised upon encountering a syntax error in the template header directives. |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
93 |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
94 .. class:: tincan.LoadError |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
95 |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
96 Raised when we run into problems ``#load``'ing something, usually because it doesn't exist. |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
97 |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
98 .. class:: tincan.TinCanError |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
99 |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
100 General-purpose exception raised by TinCan when things go wrong, either when attempting to launch webapps, or attempting to service requests. Often caused by errors in user-created files. |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
101 |
| 61 | 102 ============================ |
| 103 Request and Response Objects | |
| 104 ============================ | |
| 105 | |
| 106 The ``request`` and ``response`` instance variables of ``tincan.Page`` are standard ``bottle.Request`` and ``bottle.Response`` objects. In the ``environ`` attribute of the ``request`` object, any key beginning with ``tincan.`` is reserved. | |
| 107 | |
|
62
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
108 .. _header-directives: |
|
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
109 |
| 61 | 110 ================= |
| 111 Header Directives | |
| 112 ================= | |
| 113 | |
| 114 A ``.pspx`` file is a standard Chameleon template, plus a set of optional *header directives* that may be present to override the default behavior of the created page or its associated route. | |
| 115 | |
| 116 ``#end`` | |
| 63 | 117 Marks the last line of the headers. This is not currently necessary, as headers are implicitly ended by the first line which does not start with a leading "#". This directive is mainly here to facilitate future support of alternate templating engines. |
| 61 | 118 |
| 119 ``#errors`` | |
| 120 This is an error page which handles the specified error codes; any code-behind associated with this page must be based on the ``tincan.ErrorPage`` class. | |
| 121 | |
| 122 ``#forward`` | |
| 123 Ignore everything else in this template (and any code-behind associated with it), using the specified route to serve it instead. The route specified with ``#forward`` may itself contain a ``#forward``, but attempts to create a ``#forward`` loop are not allowed and will cause a ``TinCanError`` to be raised at initialization time. | |
| 124 | |
| 125 ``#hidden`` | |
| 126 This is a hidden page; do not create a route for it. The page can only be displayed by a server-side forward. | |
| 127 | |
| 128 ``#load`` | |
|
62
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
129 Load the specified Chameleon template file and make the loaded template available as a template variable. Useful for importing and invoking macros. See :ref:`loading-templates` below for more information. |
| 61 | 130 |
| 131 ``#methods`` | |
| 132 A list of HTTP request methods, separated by whitespace, follows. The route will allow all specified methods. Not specifying this line is equivalent to specifying ``#methods GET``. | |
| 133 | |
| 134 ``#python`` | |
| 135 What follows is the name of the Python file containing the code-behind for this route; the file name must end in ``.py``. | |
| 136 | |
| 137 ``#template`` | |
|
62
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
138 Ignore the body of this file and instead use the template in the body of the specified file, which must end in ``.pspx``. Any headers in the referred template file are ignored. |
| 61 | 139 |
| 140 Error Pages | |
| 141 ----------- | |
| 142 | |
| 143 Error pages supersede the standard Bottle error handling, and are created by using the ``#errors`` page header. The ``#hidden`` and ``#method`` header directives are ignored in error pages (error pages are effectively hidden anyhow, by virtue of never having normal routes created for them). | |
| 144 | |
| 145 The ``#errors`` directive takes a list of numeric error codes (values from 400 to 599 are allowed), separated by spaces; the page is created to handle the specified errors. If no error codes are specified, the page will handle all errors. The behavior of specifying multiple error pages for the same error code is undefined; doing so is best avoided. | |
| 146 | |
| 147 Templates with No Explicit Code-Behind | |
| 148 -------------------------------------- | |
| 149 | |
| 63 | 150 Code-behind is optional for both normal and error page templates. If code-behind is not provided, TinCan will use the ``Page`` or ``ErrorPage`` class as appropriate. |
| 61 | 151 |
| 152 .. _loading-templates: | |
| 153 | |
| 154 Loading Templates | |
| 155 ----------------- | |
| 156 | |
| 157 The ``#load`` directive may be used to load additional templates, e.g. ones containing macro definitions. Note that the loaded files are standard Chameleon templates and *not* TinCan ``.pspx`` files (i.e. they cannot contain any header directives); as such, loaded files must have the standard ``.pt`` extension for Chameleon template files. | |
| 158 | |
|
62
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
159 In the normal case, ``#load foo.pt`` will load a file relative to the same directory as the page containing the ``#load`` directive itself. The loaded template object will be made available as a template variable matching the file name sans extension (e.g. ``foo``). One can change the name of the variable created by prefixing the file specification with a variable name followed by an equals sign, e.g. ``#load t=foo.pt``. If one places the specification inside angle brackets (e.g. ``#load <t=foo.pt>``), files to be loaded are searched for in ``WEB-INF/tlib`` instead. |
| 61 | 160 |
| 161 Finally, as is allowed for all arguments to header directives, one may enclose the argument to ``#load`` inside single or double quotes and use the normal Python string syntax. | |
| 162 | |
| 163 Using Loaded Macros | |
| 164 ------------------- | |
| 165 | |
|
62
fd8c558a89bb
Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
61
diff
changeset
|
166 Once a template has been loaded, it will be available as a sub-attribute of the ``macros`` attribute of the associated template object. E.g.:: |
| 61 | 167 |
| 168 #load foo.pt | |
| 169 <!DOCTYPE html> | |
| 170 <html> | |
| 171 <head> | |
| 172 <title>Macro Example</title> | |
| 173 </head><body> | |
| 174 <p metal:use-macro="foo.macros.bar"></p> | |
| 175 </body> | |
| 176 </html> | |
| 177 | |
| 178 =================== | |
| 179 Chameleon Templates | |
| 180 =================== | |
| 181 | |
| 182 TinCan templates are Chameleon templates, as documented `here <http://chameleon.readthedocs.io/en/latest/>`_. Note that the templates in ``.pspx`` files are processed as strings, so ``load:`` expressions will not work in them (hence the ``#load`` header directive). Templates loaded via ``#load`` are processed as files, so the ``load:`` expression *will* work from within them. | |
| 183 | |
| 184 TinCan provides ``chameleon_template`` and ``chameleon_view`` callables, which follow the standard Bottle conventions for templating. Thus, if it is desired to define routes the "Bottle way", the following ``import`` line will make Chameleon the default templating engine:: | |
| 185 | |
| 186 from tincan import chameleon_view as view, chameleon_template as template | |
| 187 |