Validator

The base class of most validators. See IValidator for more, and FancyValidator for the more common (and more featureful) class.

The Validator class is accessible via the formencode.api module.

Messages

Attributes

a gettextargs

{}

a use_builtins_gettext

True

a __singletonmethods__

('to_python', 'from_python', 'message', 'all_messages', 'subvalidators')

a declarative_count

1

a __unpackargs__

()

a compound

False

a __mutableattributes__

()

a repeating

False

Methods

f __initargs__(self, new_attrs) ...

f __call__(self, *args, **kw) ...

f __classinit__(cls, new_attrs) ...

f __init__(self, *args, **kw) ...

f __sourcerepr__(self, source, binding=None) ...

f to_python(self, value, state=None) ...

f from_python(self, value, state=None) ...

f message(self, msgName, state, **kw) ...

f __classsourcerepr__(cls, source, binding=None) ...

f all_messages(self) ...

Return a dictionary of all the messages of this validator, and any subvalidators if present. Keys are message names, values may be a message or list of messages. This is really just intended for documentation purposes, to show someone all the messages that a validator or compound validator (like Schemas) can produce.

@@: Should this produce a more structured set of messages, so that messages could be unpacked into a rendered form to see the placement of all the messages? Well, probably so.

f subvalidators(self) ...

Return any validators that this validator contains. This is not useful for functional, except to inspect what values are available. Specifically the .all_messages() method uses this to accumulate all possible messages.

See the source for more information.