Skip to content

hololinked.td.forms.Form

Bases: Schema

Form hypermedia. schema - https://www.w3.org/TR/wot-thing-description11/#form

Source code in hololinked/hololinked/td/forms.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
class Form(Schema):
    """
    Form hypermedia.
    schema - https://www.w3.org/TR/wot-thing-description11/#form
    """

    href: str = None
    op: str = None
    htv_methodName: str = Field(default=None, alias="htv:methodName")
    mqv_topic: str = Field(default=None, alias="mqv:topic")
    contentType: Optional[str] = "application/json"
    additionalResponses: Optional[list[AdditionalExpectedResponse]] = None
    contentEncoding: Optional[str] = None
    security: Optional[str] = None
    scopes: Optional[str] = None
    response: Optional[ExpectedResponse] = None
    subprotocol: Optional[str] = None

    def __init__(self):
        super().__init__()

    @classmethod
    def from_TD(cls, form_json: dict[str, Any]) -> "Form":
        """
        Create a Form instance from a Thing Description JSON object.

        Parameters
        ----------
        form_json: dict[str, Any]
            The JSON representation of the form.

        Returns
        -------
        Form
            An instance of Form.
        """
        form = cls()
        for field in cls.model_fields:
            if field == "htv_methodName" and "htv:methodName" in form_json:
                setattr(form, field, form_json["htv:methodName"])
            elif field == "mqv_topic" and "mqv:topic" in form_json:
                setattr(form, field, form_json["mqv:topic"])
            elif field in form_json:
                setattr(form, field, form_json[field])
        return form

    def __str__(self) -> str:
        return f"Form(href={self.href}, op={self.op}, htv_methodName={self.htv_methodName}, contentType={self.contentType})"

Functions

from_TD classmethod 

from_TD(form_json: dict[str, Any]) -> Form

Create a Form instance from a Thing Description JSON object.

Parameters:

Name Type Description Default

form_json

dict[str, Any]

The JSON representation of the form.

 required

Returns:

Type Description
Form

An instance of Form.
Source code in hololinked/hololinked/td/forms.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
@classmethod
def from_TD(cls, form_json: dict[str, Any]) -> "Form":
    """
    Create a Form instance from a Thing Description JSON object.

    Parameters
    ----------
    form_json: dict[str, Any]
        The JSON representation of the form.

    Returns
    -------
    Form
        An instance of Form.
    """
    form = cls()
    for field in cls.model_fields:
        if field == "htv_methodName" and "htv:methodName" in form_json:
            setattr(form, field, form_json["htv:methodName"])
        elif field == "mqv_topic" and "mqv:topic" in form_json:
            setattr(form, field, form_json["mqv:topic"])
        elif field in form_json:
            setattr(form, field, form_json[field])
    return form