pform 0.3

Form generation library for pyramid

pform

Simple form example

Form contains three different subsystems, basic form attributes, fields and actions.

import pform
from pyramid.httpexceptions import HTTPFound


class EditForm(pform.Form):

     label = 'Edit form'

     fields = pform.Fieldset(
         pform.TextField(
            'name', title='Name')
     )

     @pform.button('Save')
     def safe_handler(self):
         data, errors = self.extract()

         if errors:
             self.add_error_message(errors)

         self.context.name = data['name']

     @pform.button('Cancel')
     def cancel_handler(self):
         return HTTPFound(location='.')

This form renders one field name and two actions safe and cancel (submit buttons). Now we can render this form:

from pyramid.view import view_config

@view_config(route_name='....', renderer='myview.jinja2')
def my_view(request):
    form = EditForm(some_context, request)
    return form()

also it is possible to use form class as view:

@view_config(route_name='....')
class EditForm(pform.Form):

    fields = ...

To do additional custom form initialization just override update method, also if update method returns dictionary this values bypasses to form template:

class EditForm(pform.Form):

    def update(self):
        # custom form initialization
        return {some_data: some_value}

To get form values use extract method, this method return data and errors. data is a form result, errors is a list of errors:

class EditForm(pform.Form):

    @pform.button('Save')
    def save_handler(self):
        data, errors = self.extract()

        if errors:
            self.add_error_message(errors)

        # save data
        ...

Examples

There are several example. You can find them in the examples directory at github.

https://github.com/fafhrd91/pform/tree/master/examples

Requirements

• Python 2.6+ or Python 3.2+

• virtualenv

License

pform is offered under the BSD license.

CHANGES

0.3 (11-27-2012)

• Allow to add str as error in Form.validate method

• Better button handling

• Better tanslations for Invalid messages

• Changed arguments order for Invalid class contrustor

• Added sub errors support to Invalid class

• Added extract parameter to Button class, if extract is set then action extract values from form, adds errors to message and pass data to handler

• Added pform.button2 decorator, extract parameter is true

• Added max_size and allowed_types parameters to FileField

• Do not override widget’s custom tmpl_widget

0.2 (11-13-2012)

• Fixed submit button template

• Allow to return http response from form update or action handler

• Added support for player.layout()

0.1 (11-07-2012)

• Initial release