messages Package

messages Package

allowed Module

class yawf.messages.allowed.AllowedWrapper(sender, obj, specs=None)

Bases: object

yawf.messages.allowed.annotate_with_allowed_messages(sender, objects)

yawf.messages.allowed.get_allowed_messages(sender, obj, cache=None)

yawf.messages.allowed.get_allowed_messages_for_many(sender, objects)

yawf.messages.allowed.get_message_specs(sender, obj)

yawf.messages.allowed.get_message_specs_for_many(sender, objects)

yawf.messages.allowed.is_valid_message(obj, message_id)

common Module

class yawf.messages.common.BasicCancelMessage(**attrs)

Bases: yawf.messages.spec.MessageSpec

id = 'cancel'

rank = 1000

verb = <django.utils.functional.__proxy__ object>

class yawf.messages.common.BasicDeleteMessage(**attrs)

Bases: yawf.messages.spec.MessageSpec

id = 'delete'

rank = 1001

verb = <django.utils.functional.__proxy__ object>

class yawf.messages.common.BasicEditMessage(**attrs)

Bases: yawf.messages.spec.MessageSpec

id = 'edit'

rank = 900

verb = <django.utils.functional.__proxy__ object>

class yawf.messages.common.BasicStartMessage(**attrs)

Bases: yawf.messages.spec.MessageSpec

id = 'start_workflow'

verb = <django.utils.functional.__proxy__ object>

yawf.messages.common.message_spec_fabric(id, verb=None, rank=0, base_spec=<class 'yawf.messages.spec.MessageSpec'>, **attrs)

spec Module

class yawf.messages.spec.EmptyValidator(*args, **kwargs)

Bases: object

Class with django-form behaviour that filters out all incoming data, always becomes valid and returns empty dict as cleaned data.

cleaned_data

is_valid()

class yawf.messages.spec.MessageSpec(**attrs)

Bases: object

Specifies a message that can be passed to workflow.

Basic class for one of main entities. Message spec knows:

• it’s unique ``id’‘;
• how to represent spec for humans (using ``verb’’ in __unicode__);
• how to validate parameters for this message (using ``validator_cls’‘);
• priority (``rank’’ attribute).

dehydrate_params(obj, message)

Method, that returns dehydrated message params for serialization.

id = None

id_grouper = '__'

is_grouped = False

params_wrapper(params)

Wrapper used to wrap cleaned_data returned by validator_cls before passing it to handler.

With wrapper one has additional layer to transform structure of cleaned_data dict to make it more convenient to use.

For example, see yawf.messages.common.BasicEditMessage class.

rank = 0

validator_cls

alias of EmptyValidator

verb = None

submessage Module

class yawf.messages.submessage.RecursiveSubmessage(message_id, sender, params=None, raw_params=None)

Bases: yawf.messages.submessage.Submessage

dispatch(parent_obj, parent_message)

class yawf.messages.submessage.Submessage(obj, message_id, sender, params=None, need_lock_object=True, raw_params=None)

Bases: object

as_message(parent)

dispatch(parent_obj, parent_message)

need_lock_object = True

transformation Module