signoffs.core.renderers.signoffs#

Objects that know how to render other Signoffs / Signets into HTML

Module Contents#

Classes#

SignoffInstanceRenderer

Renderer for a Signoff instance

SignoffRenderer

A descriptor class that “injects” a SignoffInstanceRenderer instance into a Signoff instance.

API#

class signoffs.core.renderers.signoffs.SignoffInstanceRenderer(signoff_instance, signet_template=None, signet_context=None, signoff_form_template=None, form_context=None)[source]#

Renderer for a Signoff instance

Initialization

A renderer instance for given signoff_type, optionally override class templates

signet_template#

‘signoffs/signets/signet.html’

signoff_form_template#

‘signoffs/signets/signoff_form.html’

signet_context#

None

form_context#

None

pass_thru_context#

(‘request’, ‘csrf_token’, ‘request_user’)

__call__(request_user=None, context=None, **kwargs)[source]#

Return a string containing a rendered version of this signoff, optionally tailored for requesting user.

signet(request_user=None, context=None, **kwargs)[source]#

Return a string containing the rendered Signet for given user, if it is signed, empty string otherwise

form(request_user=None, context=None, **kwargs)[source]#

Return a string containing the rendered Signet Form, if it can be signed, empty string otherwise

resolve_form_context(overrides, **kwargs)[source]#

return single context dictionary suitable for rendering signet form

class signoffs.core.renderers.signoffs.SignoffRenderer[source]#

Bases: utils.service(SignoffInstanceRenderer)

A descriptor class that “injects” a SignoffInstanceRenderer instance into a Signoff instance.

To inject custom rendering services:

  • provide a custom service_class: render=SignoffRenderer(service_class=MyInstanceRenderer)

  • OR specialize class attributes: MyRenderer = utils.service(SignoffInstanceRenderer, signet_template='my.tmpl.html')

  • OR both… MyRenderer = utils.service(MyInstanceRenderer)