Skip to content

hololinked.td.base.Schema

Bases: BaseModel

Base dataclass for all WoT schema; Implements a custom asdict method which replaces dataclasses' asdict utility function

Source code in hololinked\td\base.py 
 6
 7
 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
class Schema(BaseModel):
    """
    Base dataclass for all WoT schema; Implements a custom asdict method which replaces dataclasses' asdict 
    utility function
    """

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

    def json(self, indent: Optional[int] = None) -> str:
        """Return the JSON representation of the schema"""
        return self.model_dump_json(by_alias=True, exclude_unset=True, indent=indent)

    @classmethod
    def format_doc(cls, doc : str):
        """strip tabs, newlines, whitespaces etc. to format the docstring nicely"""
        # doc_as_list = doc.split('\n')
        # final_doc = []
        # for index, line in enumerate(doc_as_list):
        #     line = line.lstrip('\n').rstrip('\n')
        #     line = line.lstrip('\t').rstrip('\t')
        #     line = line.lstrip('\n').rstrip('\n')
        #     line = line.lstrip().rstrip()   
        #     if index > 0:
        #         line = ' ' + line # add space to left in case of new line            
        #     final_doc.append(line)
        # final_doc = ''.join(final_doc)
        # final_doc = final_doc.lstrip().rstrip()
        return inspect.cleandoc(doc)

Functions

format_doc classmethod 

format_doc(doc: str)

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

Source code in hololinked\td\base.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
@classmethod
def format_doc(cls, doc : str):
    """strip tabs, newlines, whitespaces etc. to format the docstring nicely"""
    # doc_as_list = doc.split('\n')
    # final_doc = []
    # for index, line in enumerate(doc_as_list):
    #     line = line.lstrip('\n').rstrip('\n')
    #     line = line.lstrip('\t').rstrip('\t')
    #     line = line.lstrip('\n').rstrip('\n')
    #     line = line.lstrip().rstrip()   
    #     if index > 0:
    #         line = ' ' + line # add space to left in case of new line            
    #     final_doc.append(line)
    # final_doc = ''.join(final_doc)
    # final_doc = final_doc.lstrip().rstrip()
    return inspect.cleandoc(doc)

json 

json(indent: Optional[int] = None) -> str

Return the JSON representation of the schema

Source code in hololinked\td\base.py 
14
15
16
def json(self, indent: Optional[int] = None) -> str:
    """Return the JSON representation of the schema"""
    return self.model_dump_json(by_alias=True, exclude_unset=True, indent=indent)