aries_cloudagent.messaging.decorators package¶
Subpackages¶
Submodules¶
aries_cloudagent.messaging.decorators.base module¶
Classes for managing a collection of decorators.
-
class
aries_cloudagent.messaging.decorators.base.
BaseDecoratorSet
(models: dict = None)[source]¶ Bases:
collections.OrderedDict
Collection of decorators.
-
add_model
(key: str, model: Type[aries_cloudagent.messaging.models.base.BaseModel])[source]¶ Add a registered decorator model.
-
copy
() → aries_cloudagent.messaging.decorators.base.BaseDecoratorSet[source]¶ Return a copy of the decorator set.
-
extract_decorators
(message: Mapping[KT, VT_co], schema: Type[<sphinx.ext.autodoc.importer._MockObject object at 0x7fd66222e898>] = None, serialized: bool = True, skip_attrs: Sequence[str] = None) → collections.OrderedDict[source]¶ Extract decorators and return the remaining properties.
-
field
(name: str) → aries_cloudagent.messaging.decorators.base.BaseDecoratorSet[source]¶ Access a named decorated field.
-
fields
¶ Acessor for the set of currently defined fields.
-
load_decorator
(key: str, value, serialized=False)[source]¶ Convert a decorator value to its loaded representation.
-
models
¶ Accessor for the models dictionary.
-
prefix
¶ Accessor for the decorator prefix.
-
-
exception
aries_cloudagent.messaging.decorators.base.
DecoratorError
(*args, error_code: str = None, **kwargs)[source]¶ Bases:
aries_cloudagent.error.BaseError
Base error for decorator issues.
aries_cloudagent.messaging.decorators.default module¶
Default decorator set implementation.
-
class
aries_cloudagent.messaging.decorators.default.
DecoratorSet
(models: dict = None)[source]¶ Bases:
aries_cloudagent.messaging.decorators.base.BaseDecoratorSet
Default decorator set implementation.
aries_cloudagent.messaging.decorators.localization_decorator module¶
The localization decorator (~l10n) for message localization information.
-
class
aries_cloudagent.messaging.decorators.localization_decorator.
LocalizationDecorator
(*, locale: str = None, localizable: Sequence[str] = None, catalogs: Sequence[str] = None)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Class representing the localization decorator.
-
class
aries_cloudagent.messaging.decorators.localization_decorator.
LocalizationDecoratorSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Localization decorator schema used in serialization/deserialization.
-
class
Meta
[source]¶ Bases:
object
LocalizationDecoratorSchema metadata.
-
model_class
¶ alias of
LocalizationDecorator
-
-
catalogs
¶ Used by autodoc_mock_imports.
-
locale
¶ Used by autodoc_mock_imports.
-
localizable
¶ Used by autodoc_mock_imports.
-
class
aries_cloudagent.messaging.decorators.signature_decorator module¶
Model and schema for working with field signatures within message bodies.
-
class
aries_cloudagent.messaging.decorators.signature_decorator.
SignatureDecorator
(*, signature_type: str = None, signature: str = None, sig_data: str = None, signer: str = None)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Class representing a field value signed by a known verkey.
-
class
Meta
[source]¶ Bases:
object
SignatureDecorator metadata.
-
schema_class
= 'SignatureDecoratorSchema'¶
-
-
TYPE_ED25519SHA512
= 'did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/signature/1.0/ed25519Sha512_single'¶
-
classmethod
create
(value, signer: str, wallet: aries_cloudagent.wallet.base.BaseWallet, timestamp=None) → aries_cloudagent.messaging.decorators.signature_decorator.SignatureDecorator[source]¶ Create a Signature.
Sign a field value and return a newly constructed SignatureDecorator representing the resulting signature.
Parameters: - value – Value to sign
- signer – Verkey of the signing party
- wallet – The wallet to use for the signature
Returns: The created SignatureDecorator object
-
class
-
class
aries_cloudagent.messaging.decorators.signature_decorator.
SignatureDecoratorSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
SignatureDecorator schema.
-
class
Meta
[source]¶ Bases:
object
SignatureDecoratorSchema metadata.
-
model_class
¶ alias of
SignatureDecorator
-
-
sig_data
¶ Used by autodoc_mock_imports.
-
signature
¶ Used by autodoc_mock_imports.
-
signature_type
¶ Used by autodoc_mock_imports.
-
signer
¶ Used by autodoc_mock_imports.
-
class
aries_cloudagent.messaging.decorators.thread_decorator module¶
A message decorator for threads.
A thread decorator identifies a message that may require additional context from previous messages.
-
class
aries_cloudagent.messaging.decorators.thread_decorator.
ThreadDecorator
(*, thid: str = None, pthid: str = None, sender_order: int = None, received_orders: Mapping[KT, VT_co] = None)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Class representing thread decorator.
-
pthid
¶ Accessor for parent thread identifier.
Returns: This thread’s pthid
-
received_orders
¶ Get received orders.
Returns: The highest sender_order value that the sender has seen from other sender(s) on the thread.
-
sender_order
¶ Get sender order.
Returns: A number that tells where this message fits in the sequence of all messages that the current sender has contributed to this thread
-
thid
¶ Accessor for thread identifier.
Returns: This thread’s thid
-
-
class
aries_cloudagent.messaging.decorators.thread_decorator.
ThreadDecoratorSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Thread decorator schema used in serialization/deserialization.
-
class
Meta
[source]¶ Bases:
object
ThreadDecoratorSchema metadata.
-
model_class
¶ alias of
ThreadDecorator
-
-
pthid
¶ Used by autodoc_mock_imports.
-
received_orders
¶ Used by autodoc_mock_imports.
-
sender_order
¶ Used by autodoc_mock_imports.
-
thid
¶ Used by autodoc_mock_imports.
-
class
aries_cloudagent.messaging.decorators.timing_decorator module¶
The timing decorator (~timing).
This decorator allows the timing of agent messages to be communicated and constrained.
-
class
aries_cloudagent.messaging.decorators.timing_decorator.
TimingDecorator
(*, in_time: Union[str, datetime.datetime] = None, out_time: Union[str, datetime.datetime] = None, stale_time: Union[str, datetime.datetime] = None, expires_time: Union[str, datetime.datetime] = None, delay_milli: int = None, wait_until_time: Union[str, datetime.datetime] = None)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Class representing the timing decorator.
-
class
aries_cloudagent.messaging.decorators.timing_decorator.
TimingDecoratorSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Timing decorator schema used in serialization/deserialization.
-
class
Meta
[source]¶ Bases:
object
TimingDecoratorSchema metadata.
-
model_class
¶ alias of
TimingDecorator
-
-
delay_milli
¶ Used by autodoc_mock_imports.
-
expires_time
¶ Used by autodoc_mock_imports.
-
in_time
¶ Used by autodoc_mock_imports.
-
out_time
¶ Used by autodoc_mock_imports.
-
stale_time
¶ Used by autodoc_mock_imports.
-
wait_until_time
¶ Used by autodoc_mock_imports.
-
class
aries_cloudagent.messaging.decorators.transport_decorator module¶
The transport decorator (~transport).
This decorator allows changes to agent response behaviour and queue status updates.
-
class
aries_cloudagent.messaging.decorators.transport_decorator.
TransportDecorator
(*, return_route: str = None, return_route_thread: str = None, queued_message_count: int = None)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Class representing the transport decorator.
-
class
aries_cloudagent.messaging.decorators.transport_decorator.
TransportDecoratorSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Transport decorator schema used in serialization/deserialization.
-
class
Meta
[source]¶ Bases:
object
TransportDecoratorSchema metadata.
-
model_class
¶ alias of
TransportDecorator
-
-
queued_message_count
¶ Used by autodoc_mock_imports.
-
return_route
¶ Used by autodoc_mock_imports.
-
return_route_thread
¶ Used by autodoc_mock_imports.
-
class