Skip to content

Spec

FunctionParams

Bases: SpecParams

Function parameters model.

Source code in digitalhub_core/entities/function/spec.py 
12
13
14
15
class FunctionParams(SpecParams):
    """
    Function parameters model.
    """

FunctionSpec

Bases: Spec

Specification for a Function.

Source code in digitalhub_core/entities/function/spec.py 
6
7
8
9
class FunctionSpec(Spec):
    """
    Specification for a Function.
    """

SourceCodeStruct

Source code struct.

Source code in digitalhub_core/entities/function/spec.py 
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
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
class SourceCodeStruct:
    """
    Source code struct.
    """

    def __init__(
        self,
        source: str | None = None,
        handler: str | None = None,
        code: str | None = None,
        base64: str | None = None,
        init_function: str | None = None,
        lang: str | None = None,
    ) -> None:
        """
        Constructor.

        Parameters
        ----------
        source : str
            Source reference.
        handler : str
            Function entrypoint.
        code : str
            Source code (plain).
        base64 : str
            Source code (base64 encoded).
        init_function : str
            Init function for remote execution.
        lang : str
            Source code language (hint).
        """
        self.source = source
        self.handler = handler
        self.code = code
        self.base64 = base64
        self.init_function = init_function
        self.lang = lang

    def to_dict(self) -> dict:
        """
        Convert to dictionary.

        Returns
        -------
        dict
            Dictionary representation of the object.
        """
        dict_ = {}
        if self.source is not None:
            dict_["source"] = self.source
        if self.handler is not None:
            dict_["handler"] = self.handler
        if self.base64 is not None:
            dict_["base64"] = self.base64
        if self.init_function is not None:
            dict_["init_function"] = self.init_function
        if self.lang is not None:
            dict_["lang"] = self.lang

        return dict_

    def __repr__(self) -> str:
        return str(self.to_dict())

__init__(source=None, handler=None, code=None, base64=None, init_function=None, lang=None)

Constructor.

Parameters:

Name Type Description Default
source str

Source reference.

 None
handler str

Function entrypoint.

 None
code str

Source code (plain).

 None
base64 str

Source code (base64 encoded).

 None
init_function str

Init function for remote execution.

 None
lang str

Source code language (hint).

 None
Source code in digitalhub_core/entities/function/spec.py 
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
48
49
50
51
52
53
54
55
def __init__(
    self,
    source: str | None = None,
    handler: str | None = None,
    code: str | None = None,
    base64: str | None = None,
    init_function: str | None = None,
    lang: str | None = None,
) -> None:
    """
    Constructor.

    Parameters
    ----------
    source : str
        Source reference.
    handler : str
        Function entrypoint.
    code : str
        Source code (plain).
    base64 : str
        Source code (base64 encoded).
    init_function : str
        Init function for remote execution.
    lang : str
        Source code language (hint).
    """
    self.source = source
    self.handler = handler
    self.code = code
    self.base64 = base64
    self.init_function = init_function
    self.lang = lang

to_dict()

Convert to dictionary.

Returns:

Type Description
dict

Dictionary representation of the object.
Source code in digitalhub_core/entities/function/spec.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
def to_dict(self) -> dict:
    """
    Convert to dictionary.

    Returns
    -------
    dict
        Dictionary representation of the object.
    """
    dict_ = {}
    if self.source is not None:
        dict_["source"] = self.source
    if self.handler is not None:
        dict_["handler"] = self.handler
    if self.base64 is not None:
        dict_["base64"] = self.base64
    if self.init_function is not None:
        dict_["init_function"] = self.init_function
    if self.lang is not None:
        dict_["lang"] = self.lang

    return dict_