messages Package¶
messages
Package¶
allowed
Module¶
common
Module¶
-
class
yawf.messages.common.
BasicCancelMessage
(**attrs)[source]¶ Bases:
yawf.messages.spec.MessageSpec
-
id
= 'cancel'¶
-
rank
= 1000¶
-
verb
= <django.utils.functional.__proxy__ object>¶
-
-
class
yawf.messages.common.
BasicDeleteMessage
(**attrs)[source]¶ Bases:
yawf.messages.spec.MessageSpec
-
id
= 'delete'¶
-
rank
= 1001¶
-
verb
= <django.utils.functional.__proxy__ object>¶
-
-
class
yawf.messages.common.
BasicEditMessage
(**attrs)[source]¶ Bases:
yawf.messages.spec.MessageSpec
-
id
= 'edit'¶
-
rank
= 900¶
-
verb
= <django.utils.functional.__proxy__ object>¶
-
-
class
yawf.messages.common.
BasicStartMessage
(**attrs)[source]¶ Bases:
yawf.messages.spec.MessageSpec
-
id
= 'start_workflow'¶
-
verb
= <django.utils.functional.__proxy__ object>¶
-
spec
Module¶
-
class
yawf.messages.spec.
EmptyValidator
(*args, **kwargs)[source]¶ 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
¶
-
-
class
yawf.messages.spec.
MessageSpec
(**attrs)[source]¶ Bases:
object
Specifies a message that can be passed to workflow.
Basic class for one of main entities. Message spec knows:
-
dehydrate_params
(obj, message)[source]¶ Method, that returns dehydrated message params for serialization.
-
id
= None¶
-
id_grouper
= '__'¶
-
is_grouped
= False¶
-
params_wrapper
(params)[source]¶ 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¶
-