Welcome, guest | Sign In | My Account | Store | Cart

Notice! PyPM is being replaced with the ActiveState Platform, which enhances PyPM’s build and deploy capabilities. Create your free Platform account to download ActivePython or customize Python with the packages you require and get automatic updates.

pypm install pyramid-webforms

How to install pyramid_webforms

  1. Download and install ActivePython
  2. Open Command Prompt
  3. Type pypm install pyramid-webforms
 Python 2.7Python 3.2Python 3.3
Windows (32-bit)
Windows (64-bit)
Mac OS X (10.5+)
Linux (32-bit)
0.0.2 Available View build log
Linux (64-bit)
0.0.2 Failed View build log
Lastest release
version 0.0.2 on Aug 14th, 2013

Simple declarative web forms using FormEncode and WebHelpers

System Message: WARNING/2 (<string>, line 2)

Title underline too short.

Simple declarative web forms using FormEncode and WebHelpers

Status: Early Development, Unstable, Unpublished.

Python Version: 2.7 (please contribute to FormEncode Project in order to make it 3.x compatible).


System Message: ERROR/3 (<string>, line 11)

Unknown directive type "code-block".

.. code-block:: bash

   pip install pyramid_webforms


Consider the following pyramid project structure:

System Message: ERROR/3 (<string>, line 21)

Unknown directive type "code-block".

.. code-block:: plain


Let's define a sign-in form, its fields, and validators.

System Message: ERROR/3 (<string>, line 37)

Unknown directive type "code-block".

.. code-block:: python

    # my_pyramid_app/modules/signin/forms.py
    from pyramid_webforms import Form
    from my_pyramid_app.i18n import _
    from . import validators

    login_or_email = {
        'type': 'text',
        'title': _('Login or Email'),
        'tip': _('Please enter your login or email that was used during your registration.'),
        'size': 30,
        'maxlength': 50,
        'validator': validators.UserLoginOrEmail

    password = {
        'type': 'password',
        'title': _('Password'),
        'tip': _('A password can contain any character of any alphabet (minimum is 1, maximum is 64 characters). '
                 'For reliability we recommend using non-trivial and long passwords. Note that the case of '
                 'the letters matters.'),
        'size': 30,
        'maxlength': 64,
        'validator': validators.UserPassword,
        'value': '',

    remember_me = {
        'type': 'checkbox',
        'title': _('Remember me'),
        'tip': _('Set this checkbox if you want your current browser to keep '
                 'your session for further visits.'),
        'selected': False,
        'validator': validators.RememberUserSession

    class SignInForm(Form):
        # form attributes and metadata
        _id_ = 'signin-form'
        _submit_text_ = _('Sign in')
        _alternate_url_ = {'name': 'support.account_access'}
        _alternate_text_ = _("I cannot access my account")
        _fieldsets_ = [
            [['login_email', 'password', 'remember_me']]
        # form fields
        login_email = login_or_email
        password = password
        remember_me = remember_me

System Message: ERROR/3 (<string>, line 90)

Unknown directive type "code-block".

.. code-block:: python

    # my_pyramid_app/modules/signin/validators.py
    import re
    import formencode

    # logins are 3-16 characters long
    USERLOGINS = re.compile('[A-Za-z0-9][-A-Za-z0-9]{1,14}[A-Za-z0-9]', re.IGNORECASE)

    RememberUserSession = formencode.validators.Bool

    class UserLogin(formencode.validators.Regex):
        not_empty = True
        strip = True
        regex = USERLOGINS

    class UserEmail(formencode.validators.Email):
        not_empty = True
        strip = True
        max = 50
        def _to_python(self, email, state):
            email = super(UserEmail, self)._to_python(email, state)
            return email.lower()

    class UserLoginOrEmail(UserLogin):
        def _to_python(self, value, state):
            if '@' in value:
                validator = UserEmail
                validator = UserLogin
            value = validator.to_python(value, state)
            return value

        def validate_python(self, value, state):

    class UserPassword(formencode.validators.UnicodeString):
        not_empty = True
        max = 64

Now we can use our form in pyramid view callables.

System Message: ERROR/3 (<string>, line 134)

Unknown directive type "code-block".

.. code-block:: python

    # my_pyramid_app/modules/signin/views.py
    from pyramid.view import view_config
    from .forms import SignInForm

    class SignInView(object):

        @view_config(route_name='session.signin', renderer='templates/signin.mako')
        def signin_form(self):
            request = self.request
            if request.POST:
                    form = SignInForm.validate(request)
                except SignInForm.Invalid as error:
                    # redirect or error handling
                    # sign in user using form data

            return {'signin_form': forms.SignInForm()}

System Message: ERROR/3 (<string>, line 159)

Unknown directive type "code-block".

.. code-block:: mako

    ## my_pyramid_app/templates/signin.mako

Here are the key conceptual points:

  • form fields are defined with plain dictionaries;
  • the fields can be reused by any other module;
  • each field record contains an assigned FormEncode-based validator;
  • a form is defined with the simple declarative interface.
Configuration options
Key Type Default
pyramid_webforms.submit_tpl str pyramid_webforms:templates/submit_alternate.p_wf_mako
pyramid_webforms.submit_alternate_tpl str pyramid_webforms:templates/submit_alternate.p_wf_mako
pyramid_webforms.form_tpl str pyramid_webforms:templates/form.p_wf_mako
pyramid_webforms.fieldset_tpl str pyramid_webforms:templates/fieldset.p_wf_mako
pyramid_webforms.field_tpl str pyramid_webforms:templates/field.p_wf_mako
pyramid_webforms.tooltip_tpl str pyramid_webforms:templates/tooltip.p_wf_mako
pyramid_webforms.form_error_tpl str pyramid_webforms:templates/form_error.p_wf_mako
pyramid_webforms.field_error_tpl str pyramid_webforms:templates/field_error.p_wf_mako

Subscribe to package updates

Last updated Aug 14th, 2013

What does the lock icon mean?

Builds marked with a lock icon are only available via PyPM to users with a current ActivePython Business Edition subscription.

Need custom builds or support?

ActivePython Enterprise Edition guarantees priority access to technical support, indemnification, expert consulting and quality-assured language builds.

Plan on re-distributing ActivePython?

Get re-distribution rights and eliminate legal risks with ActivePython OEM Edition.