Plugin structure for menus, JSON responses or similar.
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’.
You may optionally use a directive of the config object. You need to include betahaus.viewcomponent in that case.
#Code in your package def logo_tag(context, request, va): return '<img src="img.png" />' def includeme(config): config.add_view_action(logo_tag, 'stuff', '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')
Advanced example - a pluggable json renderer
Usecase: You pull JSON from a database. Some information is sensitive and should only be visible to some users. Other plugins want to be able to attach or change information to the JSON response.
Our context will be a mock user object where the email field is to be treated as sensitive information.
class User(object): userid = "" email = "" #etc...
First, add two view actions for userid and email. The email one will have the permission Show secret.
from betahaus.viewcomponent import view_action @view_action('json', 'userid') def get_userid(context, request, va, **kw): return getattr(context, 'userid', '') @view_action('json', 'email', permission = 'Show secret') def get_email(context, request, va, **kw): return getattr(context, 'email', '')
Second, lets register a regular view, that will return the view group json.
from betahaus.viewcomponent import render_view_group from pyramid.view import view_config @view_config(context = 'User', renderer = 'json', name = 'user.json') def user_view(context, request): """ Render json.""" return render_view_group(context, request, 'json', as_type='dict', empty_val = '')
Email will now only be included if the user/thing requesting the view has the Show secret permission. The as_type argument will render the view results as a dict where the keys will be the view actions name. (user and email in this case) empty_val specifies that any None or empty strings returned should be replaced by this value. So even if userid returns ‘’, that value will still be included.
Spacer will be added when the view action output is joined as a string, the default behaviour. It’s the same thing as doing spacer.join([view1, view2, etc])
The priority argument sets the order when a view action is added. Priority is sorted acending, so 10 is called before 20.
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.
- Robin Harms Oredsson / robinharms (Initial author)
- Parnell Springmeyer / ixmatus
- Paul Bonser / pib
- Added: Option to return dict, generator or list instead of just joined strings.
- Added: Spacer option for the join statement.
- Added: A config directive ‘’add_view_action’’ to att view actions without scanning.
- Fixed instance when replacing a ViewAction caused the new action to be displayed twice.
- Bugfix: When replacing, the order should be preserved unless priority is set.
- Removed debug panel since the code was outdated and didn’t work with the newer version of pyramid_debugtoolbar
- Unicode wasn’t an allowed string-type… (Brown paperbag for me) [robinharms]
- View groups don’t catch exceptions any longer. This was a cause of a lot of odd error messages on Python 2.
- Ordering with bad keys don’t cause exceptions - they’re logged as warnings instead.
- New argument priority for view actions. [ixmatus]
- 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]
- Initial version