Skip to content

gds_software.c4.model

C4Model -- declarative container for C4 architecture models.

Bases: BaseModel

A complete C4 architecture model declaration.

Validates at construction: 1. No duplicate element names 2. Relationship source/target reference declared elements 3. Component containers reference declared containers

Source code in packages/gds-software/gds_software/c4/model.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
 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
120
121
122
123
124
125
126
127
128
129
class C4Model(BaseModel):
    """A complete C4 architecture model declaration.

    Validates at construction:
    1. No duplicate element names
    2. Relationship source/target reference declared elements
    3. Component containers reference declared containers
    """

    name: str
    persons: list[Person] = Field(default_factory=list)
    external_systems: list[ExternalSystem] = Field(default_factory=list)
    containers: list[Container] = Field(default_factory=list)
    components: list[C4Component] = Field(default_factory=list)
    relationships: list[C4Relationship] = Field(default_factory=list)
    description: str = ""

    @model_validator(mode="after")
    def _validate_structure(self) -> Self:
        errors: list[str] = []

        # 1. No duplicate names
        all_names: list[str] = []
        for p in self.persons:
            all_names.append(p.name)
        for e in self.external_systems:
            all_names.append(e.name)
        for c in self.containers:
            all_names.append(c.name)
        for c in self.components:
            all_names.append(c.name)

        seen: set[str] = set()
        for n in all_names:
            if n in seen:
                errors.append(f"Duplicate element name: {n!r}")
            seen.add(n)

        all_element_names = set(all_names)
        container_names = {c.name for c in self.containers}

        # 2. Relationship source/target reference declared elements
        for rel in self.relationships:
            if rel.source not in all_element_names:
                errors.append(
                    f"Relationship {rel.name!r} source {rel.source!r} "
                    f"is not a declared element"
                )
            if rel.target not in all_element_names:
                errors.append(
                    f"Relationship {rel.name!r} target {rel.target!r} "
                    f"is not a declared element"
                )

        # 3. Component containers reference declared containers
        for comp in self.components:
            if comp.container not in container_names:
                errors.append(
                    f"Component {comp.name!r} container {comp.container!r} "
                    f"is not a declared container"
                )

        if errors:
            raise SWValidationError(
                f"C4Model {self.name!r} validation failed:\n"
                + "\n".join(f"  - {e}" for e in errors)
            )
        return self

    # ── Convenience properties ──────────────────────────────

    @property
    def element_names(self) -> set[str]:
        names: set[str] = set()
        for p in self.persons:
            names.add(p.name)
        for e in self.external_systems:
            names.add(e.name)
        for c in self.containers:
            names.add(c.name)
        for c in self.components:
            names.add(c.name)
        return names

    @property
    def person_names(self) -> set[str]:
        return {p.name for p in self.persons}

    @property
    def external_system_names(self) -> set[str]:
        return {e.name for e in self.external_systems}

    @property
    def container_names(self) -> set[str]:
        return {c.name for c in self.containers}

    # ── Compilation ─────────────────────────────────────────

    def compile(self) -> GDSSpec:
        from gds_software.c4.compile import compile_c4

        return compile_c4(self)

    def compile_system(self) -> SystemIR:
        from gds_software.c4.compile import compile_c4_to_system

        return compile_c4_to_system(self)