EasyWidgets Module Reference

class ew.widget.ExprTemplate(template)

class ew.widget.Widget(**kw)

display(**kw)

expand(template)

classmethod get_params()

prepare_context(context)

resources()

class ew.resource.CSSLink(url, squash=True, compress=True, **attrs)

class ew.resource.CSSScript(text)

class ew.resource.GoogleAnalytics(account)

class ew.resource.JSLink(url, location='body_js', squash=True, compress=True)

class ew.resource.JSScript(text, location='body_js_tail', squash=True, compress=True)

class ew.resource.Resource(location, squash=True, compress=True)

classmethod compressed(manager, resources)

display()

class ew.resource.ResourceHolder(*resources)

Simple widget that does nothing but hold resources

resources()

class ew.resource.ResourceLink(url, location, squash, compress)

classmethod compressed(manager, resources)

url()

class ew.resource.ResourceManager(script_name='/_ew_resources/', compress=False, url_base=None, cache_max_age=31536000, use_cache=True, use_jsmin=False, use_cssmin=False)

classmethod configure(**kw)

emit(location)

get_filename(res_path)

Translate a resource path to a filename

register(resource)

Registers the required resources for the given resource/widget

classmethod register_all_resources()

classmethod register_directory(url_path, directory)

register_widgets(context)

Registers all the widget/resource-type objects that exist as attrs on context

serve_slim(file_type, href)

Serve a ‘slim’ version of a file (concat+minify, if possible)

url_base

class ew.resource.ResourceScript(text, location, squash, compress)

classmethod compressed(manager, resources)

class ew.middleware.WidgetMiddleware(app, compress=False, script_name='/_ew_resources/', url_base=None, cache_max_age=31536000, register_resources=True, use_jsmin=False, use_cssmin=False, **extra_config)

serve_resource(mgr, res_path, environ, start_response)

serve_slim_css(mgr, res_path, environ, start_response)

serve_slim_js(mgr, res_path, environ, start_response)

class ew.fields.Checkbox(**kw)

Messages

classmethod from_python(value, state)

class ew.fields.CompoundField(**kw)

Messages

context_for(field)

classmethod from_python(value, state=None)

prepare_context(context)

resources()

classmethod to_python(*a, **kw)

class ew.fields.DateField(**kw)

Messages

class ew.fields.EmailField(**kw)

Messages

class ew.fields.FieldSet(**kw)

Messages

class ew.fields.FieldWidget(**kw)

Widget that also functions as a validator. Base class for all Form Field

widgets.

Messages

classmethod from_python(value, state)

prepare_context(context)

classmethod to_python(*a, **kw)

validate(*a, **kw)

class ew.fields.HTMLField(**kw)

class ew.fields.HiddenField(**kw)

Messages

class ew.fields.InputField(**kw)

Messages

if_missing

class ew.fields.IntField(**kw)

Messages

class ew.fields.LinkField(**kw)

class ew.fields.NumberField(**kw)

Messages

class ew.fields.RepeatedField(**kw)

Messages

context_for(repetition)

classmethod from_python(value, state=None)

name

prepare_context(context)

resources()

classmethod to_python(*a, **kw)

class ew.fields.RowField(**kw)

Messages

class ew.fields.SubmitButton(**kw)

Messages

class ew.fields.TableField(**kw)

Messages

class RowField(**kw)

Messages

class ew.fields.TextArea(**kw)

Messages

class ew.fields.TextField(**kw)

Messages

class ew.fields.TimeField(**kw)

Messages

class ew.select.CheckboxSet(**kwargs)

Messages

class ew.select.MultiSelectField(**kwargs)

Messages

class ew.select.Option(**kw)

class ew.select.SelectField(**kwargs)

Messages

classmethod from_python(value, state=None)

prepare_context(context)

classmethod to_python(*a, **kw)

class ew.select.SingleSelectField(**kwargs)

Messages

class ew.forms.SimpleForm(**kw)

Messages

class SubmitButton(**kw)

Messages

SimpleForm.prepare_context(context)

Implementation of core ew widgets in terms of kajiki-html4 templates

class ew.kajiki_ew.CSSLink(url, squash=True, compress=True, **attrs)

class WidgetClass(**kw)

class ew.kajiki_ew.CSSScript(text)

class WidgetClass(**kw)

class ew.kajiki_ew.Checkbox(**kw)

Messages

class ew.kajiki_ew.CheckboxSet(**kwargs)

Messages

class ew.kajiki_ew.CompoundField(**kw)

Messages

class ew.kajiki_ew.DateField(**kw)

Messages

class ew.kajiki_ew.EmailField(**kw)

Messages

class ew.kajiki_ew.FieldSet(**kw)

Messages

class ew.kajiki_ew.GoogleAnalytics(account)

class WidgetClass(**kw)

class ew.kajiki_ew.HTMLField(**kw)

class ew.kajiki_ew.HiddenField(**kw)

Messages

class ew.kajiki_ew.InputField(**kw)

Messages

class ew.kajiki_ew.IntField(**kw)

Messages

class ew.kajiki_ew.JSLink(url, location='body_js', squash=True, compress=True)

class WidgetClass(**kw)

class ew.kajiki_ew.JSScript(text, location='body_js_tail', squash=True, compress=True)

class WidgetClass(**kw)

class ew.kajiki_ew.LinkField(**kw)

class ew.kajiki_ew.MultiSelectField(**kwargs)

Messages

class ew.kajiki_ew.NumberField(**kw)

Messages

class ew.kajiki_ew.Option(**kw)

class ew.kajiki_ew.RepeatedField(**kw)

Messages

class ew.kajiki_ew.RowField(**kw)

Messages

class ew.kajiki_ew.SelectField(**kwargs)

Messages

class ew.kajiki_ew.SimpleForm(**kw)

Messages

class SubmitButton(**kw)

Messages

class ew.kajiki_ew.SingleSelectField(**kwargs)

Messages

class ew.kajiki_ew.SubmitButton(**kw)

Messages

class ew.kajiki_ew.TableField(**kw)

Messages

class RowField(**kw)

Messages

class ew.kajiki_ew.TextArea(**kw)

Messages

class ew.kajiki_ew.TextField(**kw)

Messages

class ew.kajiki_ew.TimeField(**kw)

Messages

Implementation of core ew widgets in terms of Jinja2 templates

class ew.jinja2_ew.CSSLink(url, squash=True, compress=True, **attrs)

class WidgetClass(**kw)

Messages

class ew.jinja2_ew.CSSScript(text)

class WidgetClass(**kw)

Messages

class ew.jinja2_ew.Checkbox(**kw)

Messages

class ew.jinja2_ew.CheckboxSet(**kwargs)

Messages

class ew.jinja2_ew.CompoundField(**kw)

Messages

class ew.jinja2_ew.DateField(**kw)

Messages

class ew.jinja2_ew.EmailField(**kw)

Messages

class ew.jinja2_ew.FieldSet(**kw)

Messages

class ew.jinja2_ew.GoogleAnalytics(account)

class WidgetClass(**kw)

Messages

class ew.jinja2_ew.HTMLField(**kw)

Messages

class ew.jinja2_ew.HiddenField(**kw)

Messages

class ew.jinja2_ew.InputField(**kw)

Messages

class ew.jinja2_ew.IntField(**kw)

Messages

class ew.jinja2_ew.JSLink(url, location='body_js', squash=True, compress=True)

class WidgetClass(**kw)

Messages

class ew.jinja2_ew.JSScript(text, location='body_js_tail', squash=True, compress=True)

class WidgetClass(**kw)

Messages

class ew.jinja2_ew.LinkField(**kw)

Messages

class ew.jinja2_ew.MultiSelectField(**kwargs)

Messages

class ew.jinja2_ew.NumberField(**kw)

Messages

class ew.jinja2_ew.Option(**kw)

Messages

class ew.jinja2_ew.RepeatedField(**kw)

Messages

class ew.jinja2_ew.RowField(**kw)

Messages

class ew.jinja2_ew.SelectField(**kwargs)

Messages

class ew.jinja2_ew.SimpleForm(**kw)

Messages

class SubmitButton(**kw)

Messages

class ew.jinja2_ew.SingleSelectField(**kwargs)

Messages

class ew.jinja2_ew.SubmitButton(**kw)

Messages

class ew.jinja2_ew.TableField(**kw)

Messages

class RowField(**kw)

Messages

class ew.jinja2_ew.TextArea(**kw)

Messages

class ew.jinja2_ew.TextField(**kw)

Messages

class ew.jinja2_ew.TimeField(**kw)

Messages

exception ew.errors.EasyWidgetsError

exception ew.errors.EngineNotFound

exception ew.errors.TemplateNotFound

class ew.utils.Bunch

ew.utils.LazyProperty

class ew.utils.NameList(iterator=None, index=None)

Simple class to let you create a list of widgets declaratively

append(item)

class ew.utils.NameListItem

An item that ‘remembers’ its order of instantiation within a thread

class ew.utils.NoDefault

ew.utils.push_context(*args, **kwds)

Temporarily add attributes to ‘obj’, restoring ‘obj’ to its original state on __exit__

ew.utils.safe_getitem(dct, key, item)

Return either dct[key][item], dct[key].item, or None, whichever is appropriate

class ew.render.CoreEngine(entry_point, config)

Simple extension of string.Template allowing for expressions in ${...}

class ExprDict

get(k, *args)

class CoreEngine.ExprTemplate(template)

CoreEngine.load(template_name)

CoreEngine.parse(template_text, filepath=None)

CoreEngine.render(template, context)

class ew.render.File(text='', engine=None)

class ew.render.GenshiEngine(entry_point, config)

load(template_name)

parse(template_text, filepath=None)

render(template, context)

class ew.render.Jinja2Engine(entry_point, config)

get_source(template_name)

load(template_name)

parse(template_text, filepath=None)

render(template, context)

class ew.render.JsonEngine(entry_point, config)

load(template_name)

parse(template_text, filepath=None)

render(template, context)

class ew.render.KajikiEngine(entry_point, config)

load(template_name)

parse(template_text, filepath=None)

render(template, context)

class ew.render.KajikiHTML4Engine(entry_point, config)

class ew.render.KajikiHTML5Engine(entry_point, config)

class ew.render.KajikiTextEngine(entry_point, config)

parse(template_text, filepath=None)

class ew.render.KajikiXMLEngine(entry_point, config)

class ew.render.Snippet(text='', engine=None)

class ew.render.TemplateEngine(entry_point, config)

context(user_context)

classmethod get_engine(name)

classmethod initialize(config)

load(template_name)

parse(template_text)

classmethod register_variable_provider(provider)

Plugin point to allow functions to manipulate the context passed to all templates for all widgets.

def provider(context): ...

TemplateEngine.register_variable_provider(provider)

render(template, context)

class ew.validators.Currency(*args, **kw)

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

number:

Please enter a number

tooHigh:

Please enter a number that is %(max)s or smaller

tooLow:

Please enter a number that is %(min)s or greater

classmethod from_python(value, state)

class ew.validators.DateConverter(*args, **kw)

Messages

badFormat:

Please enter the date in the form %(format)s

badType:

The input must be a string (not a %(type)s: %(value)r)

dayRange:

That month only has %(days)i days

empty:

Please enter a value

fourDigitYear:

Please enter a four-digit year after 1899

invalidDate:

That is not a valid day (%(exception)s)

invalidDay:

Please enter a valid day

invalidYear:

Please enter a number for the year

monthRange:

Please enter a month from 1 to 12

noneType:

The input must be a string (not None)

unknownMonthName:

Unknown month name: %(month)s

wrongFormat:

Please enter the date in the form %(format)s

classmethod to_python(value, state)

class ew.validators.OneOf(options)

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

invalid:

Invalid Value

noneType:

The input must be a string (not None)

notIn:

Value must be one of: %(items)s (not %(value)r)

validate_python(value, state)

class ew.validators.TimeConverter(*args, **kw)

Messages

badHour:

You must enter an hour in the range %(range)s

badMinute:

You must enter a minute in the range 0-59

badNumber:

The %(part)s value you gave is not a number: %(number)r

badSecond:

You must enter a second in the range 0-59

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

minutesRequired:

You must enter minutes (after a :)

noAMPM:

You must indicate AM or PM

noSeconds:

You may not enter seconds

noneType:

The input must be a string (not None)

secondsRequired:

You must enter seconds

tooManyColon:

There are too many :’s

class ew.validators.UnicodeString(**kw)

Messages

badEncoding:

Invalid data or incorrect encoding

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

tooLong:

Enter a value less than %(max)i characters long

tooShort:

Enter a value %(min)i characters long or more

classmethod from_python(value, state)