Skip to content

gds_software.c4.elements

C4 model element declarations -- frozen Pydantic models for user-facing declarations.

Bases: BaseModel

A person that interacts with the system.

Maps to: GDS BoundaryAction (exogenous input).

Source code in packages/gds-software/gds_software/c4/elements.py 
 9
10
11
12
13
14
15
16
class Person(BaseModel, frozen=True):
    """A person that interacts with the system.

    Maps to: GDS BoundaryAction (exogenous input).
    """

    name: str
    description: str = ""

Bases: BaseModel

An external system that the system interacts with.

Maps to: GDS BoundaryAction (exogenous input).

Source code in packages/gds-software/gds_software/c4/elements.py 
19
20
21
22
23
24
25
26
class ExternalSystem(BaseModel, frozen=True):
    """An external system that the system interacts with.

    Maps to: GDS BoundaryAction (exogenous input).
    """

    name: str
    description: str = ""

Bases: BaseModel

A deployable unit (API, database, web app, etc).

Maps to: GDS Policy (if stateless) or Mechanism (if stateful/database).

Source code in packages/gds-software/gds_software/c4/elements.py 
29
30
31
32
33
34
35
36
37
38
class Container(BaseModel, frozen=True):
    """A deployable unit (API, database, web app, etc).

    Maps to: GDS Policy (if stateless) or Mechanism (if stateful/database).
    """

    name: str
    technology: str = ""
    stateful: bool = False
    description: str = ""

Bases: BaseModel

A component within a container.

Maps to: GDS Policy or Mechanism based on stateful flag.

Source code in packages/gds-software/gds_software/c4/elements.py 
41
42
43
44
45
46
47
48
49
50
51
class C4Component(BaseModel, frozen=True):
    """A component within a container.

    Maps to: GDS Policy or Mechanism based on stateful flag.
    """

    name: str
    container: str = Field(description="Parent container name")
    technology: str = ""
    stateful: bool = False
    description: str = ""

Bases: BaseModel

A directed relationship between C4 elements.

Maps to: GDS Wiring.

Source code in packages/gds-software/gds_software/c4/elements.py 
54
55
56
57
58
59
60
61
62
63
64
class C4Relationship(BaseModel, frozen=True):
    """A directed relationship between C4 elements.

    Maps to: GDS Wiring.
    """

    name: str
    source: str
    target: str
    technology: str = ""
    description: str = ""