betahaus.viewcomponent
Project description
Reusable components in web pages make them a lot more fun and rewarding to write. The goal of this package is to make them easy to add, remove and change. While it’s usable in a regular webapp, it’s probably more interesting to use in something that others will extend or change, like a framework.
It’s written to be flexible and easy to adapt, rather than being the perfect solution to everything.
Basic example - adding a logo
First, create a method that returns an html tag. We also need to decorate this method. The va positional argument is a ViewAction - we can ignore that in this example.
from betahaus.viewcomponent import view_action
@view_action('stuff', 'logo')
def logo_tag(context, request, va):
return '<img src="img.png" />'
When you run config.scan('your-apps-name') with this code present, it will create a ViewGroup with the name ‘stuff’, that has a ViewAction called ‘logo’.
The ViewGroup is an ordered dict-like Utility, that keeps track of ViewActions.
If you want to get the result of a ViewGroup, simply do this:
from betahaus.viewcomponent import render_view_group render_view_group(context, request, 'stuff')
Since there’s nothing else in this ViewGroup, only the logo tag will be returned.
To get the result of a single ViewAction only, you can call render_view_action:
from betahaus.viewcomponent import render_view_action render_view_action(context, request, 'stuff', 'logo')
Installing debug panel
To see which view components that are registered and active, this package comes with a debug panel, ment to be used with Pyramid Debug toolbar. Include that package before including this debug panel. Usually something like this in your paster.ini file:
pyramid.includes =
pyramid_debugtoolbar
betahaus.viewcomponent.debug_panel
The panel will now display realtime information on active components, and where you can find their modules.
Requirements
This package currently isn’t usable outside of Pyramid, but it could be changed to be more generic and only require the basic Zope Component Architechture . It also depends on venusian, which will be fetched by Pyramid.
Feedback and features
The source code of the package is really small, and it should be commented enough so it’s easy to pick up what to do with it. The package is still under development, but used on several production servers today.
If you have suggestions, criticism, feedback, ideas - please don’t hesitate to contact me or add an issue at GitHub.
Credits
Robin Harms Oredsson (Initial author)
A lot of good ideas were taken from Pyramid itself and from different repoze software. The code itself was written as part of the VoteIT project.
0.2b
Python3 support fixed by pib (Paul Bonser) - thanks a lot!
Fetch and execution of vas changed - empty result should be ignored, and yield isn’t used now. This should make error messages clearer. [robinharms]
Checks for containment, interface, permission etc moved to ViewAction object, since they weren’t performed if the object was called directly. [robinharms]
0.1b
Initial version
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for betahaus.viewcomponent-0.2b.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a9822af60799120c4b0b73fcf825fbbf87599d5514bbca28217384a1a4c4a268 |
|
| MD5 | 4c98a5838f631061596048a5b4758c60 |
|
| BLAKE2b-256 | fbad8e92632e786aca1053e9e6321ab0680e86aee412b93f9e3c74ff8a31dce3 |
