Skip to content

PrimaryBaseNode

PrimaryBaseNode

Bases: UUIDBaseNode, ABC

Abstract class that defines what it means to be a PrimaryNode, and other primary nodes can inherit from.

Source code in src/cript/nodes/primary_nodes/primary_base_node.py 
  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
 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
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
class PrimaryBaseNode(UUIDBaseNode, ABC):
    """
    Abstract class that defines what it means to be a PrimaryNode,
    and other primary nodes can inherit from.
    """

    @dataclass(frozen=True)
    class JsonAttributes(UUIDBaseNode.JsonAttributes):
        """
        All shared attributes between all Primary nodes and set to their default values
        """

        locked: bool = False
        model_version: str = ""
        public: bool = False
        name: str = ""
        notes: str = ""

    _json_attrs: JsonAttributes = JsonAttributes()

    @beartype
    def __init__(self, name: str, notes: str, **kwargs):
        # initialize Base class with node
        super().__init__(**kwargs)
        # replace name and notes within PrimaryBase
        self._json_attrs = replace(self._json_attrs, name=name, notes=notes)

    @beartype
    def __str__(self) -> str:
        """
        Return a string representation of a primary node dataclass attributes.
        Every node that inherits from this class should overwrite it to best fit
        their use case, but this provides a nice default value just in case

        Examples
        --------
        {
        'locked': False,
        'model_version': '',
        'public': False,
        'notes': ''
        }


        Returns
        -------
        str
            A string representation of the primary node common attributes.
        """
        return super().__str__()

    @property
    @beartype
    def locked(self):
        return self._json_attrs.locked

    @property
    @beartype
    def model_version(self):
        return self._json_attrs.model_version

    @property
    @beartype
    def updated_by(self):
        return self._json_attrs.updated_by

    @property
    @beartype
    def created_by(self):
        return self._json_attrs.created_by

    @property
    @beartype
    def public(self):
        return self._json_attrs.public

    @property
    @beartype
    def name(self):
        return self._json_attrs.name

    @name.setter
    @beartype
    def name(self, new_name: str) -> None:
        """
        set the PrimaryBaseNode name

        Parameters
        ----------
        new_name: str

        Returns
        -------
        None
        """
        new_attrs = replace(self._json_attrs, name=new_name)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def notes(self):
        return self._json_attrs.notes

    @notes.setter
    @beartype
    def notes(self, new_notes: str) -> None:
        """
        allow every node that inherits base attributes to set its notes
        """
        new_attrs = replace(self._json_attrs, notes=new_notes)
        self._update_json_attrs_if_valid(new_attrs)

JsonAttributes dataclass

Bases: JsonAttributes

All shared attributes between all Primary nodes and set to their default values

Source code in src/cript/nodes/primary_nodes/primary_base_node.py 
15
16
17
18
19
20
21
22
23
24
25
@dataclass(frozen=True)
class JsonAttributes(UUIDBaseNode.JsonAttributes):
    """
    All shared attributes between all Primary nodes and set to their default values
    """

    locked: bool = False
    model_version: str = ""
    public: bool = False
    name: str = ""
    notes: str = ""

__str__()

Return a string representation of a primary node dataclass attributes. Every node that inherits from this class should overwrite it to best fit their use case, but this provides a nice default value just in case

Examples:

{ 'locked': False, 'model_version': '', 'public': False, 'notes': '' }

Returns:

Type Description
str

A string representation of the primary node common attributes.
Source code in src/cript/nodes/primary_nodes/primary_base_node.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
@beartype
def __str__(self) -> str:
    """
    Return a string representation of a primary node dataclass attributes.
    Every node that inherits from this class should overwrite it to best fit
    their use case, but this provides a nice default value just in case

    Examples
    --------
    {
    'locked': False,
    'model_version': '',
    'public': False,
    'notes': ''
    }


    Returns
    -------
    str
        A string representation of the primary node common attributes.
    """
    return super().__str__()