"""Represents a feature discovery disclosure message."""
from typing import Mapping, Sequence
from marshmallow import fields, Schema
from marshmallow.validate import OneOf
from ....messaging.agent_message import AgentMessage, AgentMessageSchema
from ..message_types import DISCLOSE, PROTOCOL_PACKAGE
HANDLER_CLASS = f"{PROTOCOL_PACKAGE}.handlers.disclose_handler.DiscloseHandler"
[docs]class Disclose(AgentMessage):
"""Represents a feature discovery disclosure, the response to a query message."""
def __init__(self, *, protocols: Sequence[Mapping[str, Mapping]] = None, **kwargs):
"""
Initialize disclose message object.
Args:
protocols: A mapping of protocol names to a dictionary of properties
"""
super(Disclose, self).__init__(**kwargs)
self.protocols = list(protocols) if protocols else []
[docs]class ProtocolDescriptorSchema(Schema):
"""Schema for an entry in the protocols list."""
pid = fields.Str(required=True)
roles = fields.List(
fields.Str(
description="Role: requester or responder",
example="requester",
validate=OneOf(["requester", "responder"]),
),
required=False,
allow_none=True,
description="List of roles",
)
[docs]class DiscloseSchema(AgentMessageSchema):
"""Disclose message schema used in serialization/deserialization."""
protocols = fields.List(
fields.Nested(ProtocolDescriptorSchema()),
required=True,
description="List of protocol descriptors",
)