Tiles for use in pyramid framework
This package provides rendering snippets of markup organized as tiles for the pyramid framework.
A tile is a piece of web application, i.e. a form, a navigation, etc.
Splitting your application in such small and logic application parts makes it easy to re-use this application, simplifies application AJAXification and the use of same application parts in different manners.
A tile is registered similar to a pyramid view. Registration is done with the
>>> from cone.tile import registerTile >>> registerTile('a_tile', ... 'package:browser/templates/a_tile.pt', ... permission='view')
cone.tile.tile decorator on classes:
>>> from cone.tile import tile, Tile >>> @tile('b_tile', 'package:browser/templates/b_tile.pt', ... permission='view', strict=False) ... class BTile(Tile): ... pass
Both, decorator and register function accept following arguments:
- Identifier of the tile (for later lookup).
- Either relative path to the template or absolute path or path prefixed
by the absolute package name delimeted by ':'. If
- Attribute on the given _class to be used to render the tile. Defaults to
- Interface or class of the pyramid model the tile is registered for.
- Class to be used to render the tile. usally
cone.tile.Tileor a subclass of. Promises to implement
cone.tile.ITile. When the
tiledecorator is used, the decorated class is expected as tile implementation.
- Enables security checking for this tile. Defaults to
view. If set to
Nonesecurity checks are disabled.
- Wether to raise
Forbiddenor not if rendering is not permitted. Defaults to
True. If set to
Falsethe exception is consumed and an empty unicode string is returned.
Tiles can be overwritten later while application initialization by just registering it again. This is useful for application theming and customization.
Tile rendering with the
>>> from cone.tile import render_tile >>> rendered = render_tile(model, request, name)
Inside templates which are bound to the tile, more tiles can be rendered on
current model and request via
>>> <tal:sometile replace="structure tile('tilename')"
A tile is similar to what's known in the zope world as content provider.
Before rendering of the tile is done, the
prepare function is called which
can be used to load data or whatever.
show flag is considered (which might have been set in the
prepare function) and rendering is skipped if it evaluates to
More on rendering
There are helper functions for rendering which pass the tile renderer to templates for invoking child tiles and consider redirections.
The tile class provides a redirect function, which expects either a string
containing a URL or a
webob.exc.HTTPFound instance. This causes rendering
of remaining tiles to be skipped and
request.environ['redirect'] to be set.
- Render template. Passes tile renderer to template. Considers redirection. Returns empty string if redirection found.
- Render template to response. Passes tile renderer to template. Considers redirection. Returns HTTPFound instance if redirection found, otherwise rendered response.
- Renders some result to the response considering redirection. Returns HTTPFound instance if redirection found, otherwise rendered response.
Summary of the test coverage report:
lines cov% module 1 100% cone.tile.__init__ 193 100% cone.tile._api 12 100% cone.tile.tests
- Robert Niederreiter <rnix [at] squarewave [dot] at>
- Jens Klein <jens [at] bluedynamics [dot] com>
- Attila Olah