Skip to content

hololinked.td.base.Schema

Bases: BaseModel

Base pydantic model for all WoT schema components (as in, parts within the schema). Call model_dump or json method to get the JSON representation of the schema.

Source code in hololinked/hololinked/td/base.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
class Schema(BaseModel):
    """
    Base pydantic model for all WoT schema components (as in, parts within the schema).
    Call `model_dump` or `json` method to get the JSON representation of the schema.
    """

    skip_keys: ClassVar = []  # override this to skip some dataclass attributes in the schema

    def model_dump(self, **kwargs) -> dict[str, Any]:
        """Return the JSON representation of the schema"""
        # we need to override this to work with our JSON serializer
        kwargs["mode"] = "json"
        kwargs["by_alias"] = True
        kwargs["exclude_unset"] = True
        kwargs["exclude"] = [
            "instance",
            "skip_keys",
            "skip_properties",
            "skip_actions",
            "skip_events",
            "ignore_errors",
            "allow_loose_schema",
        ]
        return super().model_dump(**kwargs)

    def json(self) -> dict[str, Any]:
        """same as model_dump"""
        return self.model_dump()

    @classmethod
    def format_doc(cls, doc: str):
        """strip tabs, newlines, whitespaces etc. to format the docstring nicely"""
        doc = inspect.cleandoc(doc)
        # Remove everything after "Parameters\n-----" if present (when using numpydoc)
        marker = "Parameters\n-----"
        idx = doc.find(marker)
        if idx != -1:
            doc = doc[:idx]
        doc = doc.replace("\n", "").replace("\t", " ").lstrip().rstrip()
        return doc

Functions

format_doc classmethod 

format_doc(doc: str)

strip tabs, newlines, whitespaces etc. to format the docstring nicely

Source code in hololinked/hololinked/td/base.py 
37
38
39
40
41
42
43
44
45
46
47
@classmethod
def format_doc(cls, doc: str):
    """strip tabs, newlines, whitespaces etc. to format the docstring nicely"""
    doc = inspect.cleandoc(doc)
    # Remove everything after "Parameters\n-----" if present (when using numpydoc)
    marker = "Parameters\n-----"
    idx = doc.find(marker)
    if idx != -1:
        doc = doc[:idx]
    doc = doc.replace("\n", "").replace("\t", " ").lstrip().rstrip()
    return doc

json 

json() -> dict[str, Any]

same as model_dump

Source code in hololinked/hololinked/td/base.py 
33
34
35
def json(self) -> dict[str, Any]:
    """same as model_dump"""
    return self.model_dump()

model_dump 

model_dump(**kwargs) -> dict[str, Any]

Return the JSON representation of the schema

Source code in hololinked/hololinked/td/base.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
def model_dump(self, **kwargs) -> dict[str, Any]:
    """Return the JSON representation of the schema"""
    # we need to override this to work with our JSON serializer
    kwargs["mode"] = "json"
    kwargs["by_alias"] = True
    kwargs["exclude_unset"] = True
    kwargs["exclude"] = [
        "instance",
        "skip_keys",
        "skip_properties",
        "skip_actions",
        "skip_events",
        "ignore_errors",
        "allow_loose_schema",
    ]
    return super().model_dump(**kwargs)