Skip to content

Core

c4.diagrams.core.BaseDiagramElement

Base class for any object that belongs to a diagram.

Instances are registered in the current diagram context when created. Subclasses may limit the diagram types or renderers that can contain them.

Source code in c4/diagrams/core/components.py
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
class BaseDiagramElement:
    """
    Base class for any object that belongs to a diagram.

    Instances are registered in the current diagram context when created.
    Subclasses may limit the diagram types or renderers that can contain them.
    """

    allowed_diagram_types: tuple[DiagramType, ...] | None = None
    allowed_renderers: tuple[RendererEnum, ...] | None = None
    extensions: ElementExtensions | None = None

    _diagram: Diagram

    def __init__(self, **kwargs: Any) -> None:
        """
        Initialize the object and add it to the current diagram context.

        Args:
            **kwargs: Reserved for subclasses.
        """
        self._diagram = current_diagram()
        self._contribute_to_diagram()
        self.properties = DiagramElementProperties()

    def _check_diagram_type(self) -> None:
        """Validate that this object is allowed in the current diagram type."""
        if not self.allowed_diagram_types:
            return None

        if self._diagram.type not in self.allowed_diagram_types:
            element_name = self.__class__.__name__
            diagram_type = self._diagram.type.value
            allowed = ", ".join([dt.value for dt in self.allowed_diagram_types])

            raise ValueError(
                f"{element_name} is not allowed in {diagram_type}. "
                f"Allowed diagram types: {allowed}."
            )

        return None

    def _contribute_to_diagram(self) -> None:
        """Register this object in the current diagram declaration stream."""
        self._check_diagram_type()
        self._diagram.add_ordered_element(self)

    def set_property_header(self, *args: str) -> Self:
        """
        Sets the column headers for the element's property table.

        This must be called either before adding any property rows, or
        the header length must match the number of values.

        Args:
            *args: Column names to use as the property header.

        Returns:
            The updated diagram element.

        Raises:
            ValueError: If header length does not match the number of values.
        """
        self.properties.set_header(*args)

        return self

    def without_property_header(self) -> Self:
        """
        Disables the rendering of the header row in the property table.

        Returns:
            The updated diagram element.
        """
        self.properties.without_header()

        return self

    def with_properties(
        self,
        *properties: str | PropertyRow,
        header: Sequence[str] | None = None,
        show_header: bool = True,
    ) -> Self:
        """
        Adds one or more rows to the property table.

        For one row, pass values directly:

            element.with_properties("Role", "Operator")

        For multiple rows, pass row sequences:

            element.with_properties(
                ("Role", "Operator"),
                ("Shift", "Daytime"),
            )

        Args:
            *properties: Values for one row, or row sequences.
            header: Optional property table header override.
            show_header: Whether to render the property table header.

        Returns:
            The updated diagram element.
        """
        self.properties.with_rows(
            *properties,
            header=header,
            show_header=show_header,
        )

        return self

    def add_property(self, *args: str) -> Self:
        """
        Adds a row to the property table.

        The number of arguments must match the number of header columns.

        Args:
            *args: Values for each column in the property row.

        Returns:
            The updated diagram element.

        Raises:
            ValueError: If the number of values does not match the
                header length.
        """
        self.properties.add_row(*args)

        return self

    @property
    def diagram(self) -> Diagram:
        """Returns the current diagram context."""
        return self._diagram

set_property_header

set_property_header(*args: str) -> Self

Sets the column headers for the element's property table.

This must be called either before adding any property rows, or the header length must match the number of values.

Parameters:

Name Type Description Default
*args str

Column names to use as the property header.

()

Returns:

Type Description
Self

The updated diagram element.

Raises:

Type Description
ValueError

If header length does not match the number of values.

Source code in c4/diagrams/core/components.py
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
def set_property_header(self, *args: str) -> Self:
    """
    Sets the column headers for the element's property table.

    This must be called either before adding any property rows, or
    the header length must match the number of values.

    Args:
        *args: Column names to use as the property header.

    Returns:
        The updated diagram element.

    Raises:
        ValueError: If header length does not match the number of values.
    """
    self.properties.set_header(*args)

    return self

without_property_header

without_property_header() -> Self

Disables the rendering of the header row in the property table.

Returns:

Type Description
Self

The updated diagram element.

Source code in c4/diagrams/core/components.py
335
336
337
338
339
340
341
342
343
344
def without_property_header(self) -> Self:
    """
    Disables the rendering of the header row in the property table.

    Returns:
        The updated diagram element.
    """
    self.properties.without_header()

    return self

add_property

add_property(*args: str) -> Self

Adds a row to the property table.

The number of arguments must match the number of header columns.

Parameters:

Name Type Description Default
*args str

Values for each column in the property row.

()

Returns:

Type Description
Self

The updated diagram element.

Raises:

Type Description
ValueError

If the number of values does not match the header length.

Source code in c4/diagrams/core/components.py
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
def add_property(self, *args: str) -> Self:
    """
    Adds a row to the property table.

    The number of arguments must match the number of header columns.

    Args:
        *args: Values for each column in the property row.

    Returns:
        The updated diagram element.

    Raises:
        ValueError: If the number of values does not match the
            header length.
    """
    self.properties.add_row(*args)

    return self

with_properties

with_properties(
    *properties: str | PropertyRow,
    header: Sequence[str] | None = None,
    show_header: bool = True,
) -> Self

Adds one or more rows to the property table.

For one row, pass values directly:

element.with_properties("Role", "Operator")

For multiple rows, pass row sequences:

element.with_properties(
    ("Role", "Operator"),
    ("Shift", "Daytime"),
)

Parameters:

Name Type Description Default
*properties str | PropertyRow

Values for one row, or row sequences.

()
header Sequence[str] | None

Optional property table header override.

None
show_header bool

Whether to render the property table header.

True

Returns:

Type Description
Self

The updated diagram element.

Source code in c4/diagrams/core/components.py
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
def with_properties(
    self,
    *properties: str | PropertyRow,
    header: Sequence[str] | None = None,
    show_header: bool = True,
) -> Self:
    """
    Adds one or more rows to the property table.

    For one row, pass values directly:

        element.with_properties("Role", "Operator")

    For multiple rows, pass row sequences:

        element.with_properties(
            ("Role", "Operator"),
            ("Shift", "Daytime"),
        )

    Args:
        *properties: Values for one row, or row sequences.
        header: Optional property table header override.
        show_header: Whether to render the property table header.

    Returns:
        The updated diagram element.
    """
    self.properties.with_rows(
        *properties,
        header=header,
        show_header=show_header,
    )

    return self

c4.diagrams.core.with_properties

with_properties(
    element: TDiagramElement,
    *properties: str | PropertyRow,
    header: Sequence[str] | None = None,
    show_header: bool = True,
) -> TDiagramElement
with_properties(
    element: Callable[P, TDiagramElement],
    *properties: str | PropertyRow,
    header: Sequence[str] | None = None,
    show_header: bool = True,
) -> Callable[P, TDiagramElement]
with_properties(
    element: TDiagramElement
    | Callable[P, TDiagramElement],
    *properties: str | PropertyRow,
    header: Sequence[str] | None = None,
    show_header: bool = True,
) -> TDiagramElement | Callable[P, TDiagramElement]

Adds property rows to a diagram element or wraps an element factory.

For one row, pass values directly:

with_properties(Person("CRM Operator"), "Role", "Operator")

For multiple rows, pass row sequences:

with_properties(
    Person("CRM Operator"),
    ("Role", "Operator"),
    ("Shift", "Daytime"),
)

To pre-build a reusable element factory:

CRMOperator = with_properties(
    partial(Person, label="CRM Operator"),
    ("Role", "Operator"),
    ("Shift", "Daytime"),
)
Source code in c4/diagrams/core/components.py
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
def with_properties(
    element: TDiagramElement | Callable[P, TDiagramElement],
    *properties: str | PropertyRow,
    header: Sequence[str] | None = None,
    show_header: bool = True,
) -> TDiagramElement | Callable[P, TDiagramElement]:
    """
    Adds property rows to a diagram element or wraps an element factory.

    For one row, pass values directly:

        with_properties(Person("CRM Operator"), "Role", "Operator")

    For multiple rows, pass row sequences:

        with_properties(
            Person("CRM Operator"),
            ("Role", "Operator"),
            ("Shift", "Daytime"),
        )

    To pre-build a reusable element factory:

        CRMOperator = with_properties(
            partial(Person, label="CRM Operator"),
            ("Role", "Operator"),
            ("Shift", "Daytime"),
        )
    """
    if isinstance(element, BaseDiagramElement):
        element.properties.with_rows(
            *properties,
            header=header,
            show_header=show_header,
        )
        return element

    def wrapped(*args: P.args, **kwargs: P.kwargs) -> TDiagramElement:
        instance = element(*args, **kwargs)
        instance.properties.with_rows(
            *properties,
            header=header,
            show_header=show_header,
        )
        return instance

    return wrapped

c4.diagrams.core.Element

Bases: BaseDiagramElement, ABC

Base class for all C4 elements (e.g. Person, System, Container, Component).

Elements are automatically registered in the current diagram context.

Source code in c4/diagrams/core/components.py
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
class Element(BaseDiagramElement, abc.ABC):
    """
    Base class for all C4 elements (e.g. Person, System, Container, Component).

    Elements are automatically registered in the current diagram context.
    """

    allowed_diagram_types: tuple[DiagramType, ...] | None = None

    _diagram: Diagram

    alias: str
    label: str
    technology: str | None

    def __init__(
        self,
        label: Required[str] = REQUIRED,
        description: str | None = None,
        extensions: ElementExtensions | None = None,
        plantuml: Mapping[str, Any] | None = None,
        mermaid: Mapping[str, Any] | None = None,
        alias: Maybe[str] = MISSING,
    ) -> None:
        """
        Initialize a new diagram element. Automatically adds the element to the
        current diagram.

        Args:
            label: Display name for the element. Required.
            description: Optional description text.
            extensions: Backend-specific extension data.
            plantuml: PlantUML-specific extension data.
            mermaid: Mermaid-specific extension data.
            alias: Unique identifier for the element. If not provided, it is
                autogenerated from the label.

        Raises:
            ValueError: If `label` is not provided.
        """
        self.label = self._check_label(label)
        self.alias = self._check_alias(alias, self.label)
        self.description = description
        self.extensions = merge_extensions(
            extensions,
            plantuml=plantuml,
            mermaid=mermaid,
        )

        self.technology = None

        super().__init__()

    @overload
    def __rshift__(self, other: str) -> Relationship: ...  # pragma: no cover

    @overload
    def __rshift__(self, other: Element) -> _EdgeDraft: ...  # pragma: no cover

    def __rshift__(self, other: str | Element) -> Relationship | _EdgeDraft:
        """
        Start a fluent relationship declaration from this element.

        Args:
            other: A relationship label for `self >> "label" >> element`,
                or the destination element for `self >> element | "label"`.

        Returns:
            A partial relationship or edge draft to complete the declaration.
        """
        if isinstance(other, str):
            # self >> "label" >> element2
            return Relationship(label=other, from_element=self)

        if isinstance(other, Element):
            # Draft for: self >> element2 | "label"
            return _EdgeDraft(source=self, destination=other)

        return NotImplemented

    @overload
    def __lshift__(self, other: str) -> Relationship: ...  # pragma: no cover

    @overload
    def __lshift__(self, other: Element) -> _EdgeDraft: ...  # pragma: no cover

    def __lshift__(self, other: str | Element) -> Relationship | _EdgeDraft:
        """
        Start a fluent relationship declaration toward this element.

        Args:
            other: A relationship label for `element << "label" << self`,
                or the source element for `element << self | "label"`.

        Returns:
            A partial relationship or edge draft to complete the declaration.
        """
        if isinstance(other, str):
            # element1 << "label" << element2
            return Relationship(label=other, to_element=self)

        if isinstance(other, Element):
            # Draft for: element1 >> element2 | "label"
            return _EdgeDraft(source=other, destination=self)

        return NotImplemented

    def __rrshift__(self, other: list[Relationship]) -> list[Relationship]:
        """
        Complete relationships from their stored sources to this element.

        Args:
            other: Partial relationships with source elements already set.

        Returns:
            Completed relationships targeting this element.
        """
        if isinstance(other, list) and all(
            isinstance(r, Relationship) for r in other
        ):
            return [r._connect(r.from_element, destination=self) for r in other]

        return NotImplemented  # pragma: no cover

    def __rlshift__(self, other: list[Relationship]) -> list[Relationship]:
        """
        Complete relationships from this element to their stored destinations.

        Args:
            other: Partial relationships with destination elements already set.

        Returns:
            Completed relationships sourced from this element.
        """
        if isinstance(other, list) and all(
            isinstance(r, Relationship) for r in other
        ):
            return [
                r._connect(source=self, destination=r.to_element) for r in other
            ]

        return NotImplemented  # pragma: no cover

    def _check_label(self, label: str | Required) -> str:
        """Return a valid element label or raise if it is missing."""
        if label is REQUIRED:
            raise ValueError("The 'label' argument is required")

        return cast(str, label)

    def _check_alias(self, alias: Maybe[str], label: str) -> str:
        """Return the provided alias or generate one from the label."""
        if alias is MISSING:
            alias = self._generate_alias(label)

        return cast(str, alias)

    @override
    def _contribute_to_diagram(self) -> None:
        """Register this element in the current diagram or active boundary."""
        self._check_diagram_type()
        self._diagram.add(self)

    def uses(
        self,
        other: TElement,
        label: str,
        relationship_type: RelationshipType = RelationshipType.REL,
        **kwargs: Any,
    ) -> Relationship:
        """
        Declare that this element uses another.

        Args:
            other: The element being used.
            label: Description of the interaction.
            relationship_type: Type of arrow to use.
            kwargs: Optional relationship kwargs.

        Returns:
            The created relationship.
        """
        relationship_class = Relationship.get_relationship_by_type(
            relationship_type
        )
        return relationship_class(
            from_element=self,  # type: ignore[arg-type]
            to_element=other,  # type: ignore[arg-type]
            label=label,
            **kwargs,
        )

    def used_by(
        self,
        other: TElement,
        label: str,
        relationship_type: RelationshipType = RelationshipType.REL,
        **kwargs: Any,
    ) -> Relationship:
        """
        Declare that another element uses this element.

        Args:
            other: The element that uses this element.
            label: Description of the interaction.
            relationship_type: Type of arrow to use.
            kwargs: Optional relationship kwargs.

        Returns:
            The created relationship.
        """
        relationship_class = Relationship.get_relationship_by_type(
            relationship_type
        )
        return relationship_class(
            from_element=other,  # type: ignore[arg-type]
            to_element=self,  # type: ignore[arg-type]
            label=label,
            **kwargs,
        )

    def _generate_alias(self, label: str) -> str:
        """Generate an alias from the label in the current diagram context."""
        return current_diagram().generate_alias(
            label=label,
            fallback_prefix=self.__class__.__name__,
        )

    @override
    def __str__(self) -> str:
        """Returns the string representation of the element."""
        cls_name = self.__class__.__name__
        return f"{cls_name}(alias={self.alias!r}, label={self.label!r})"

    def __repr__(self) -> str:
        cls_name = self.__class__.__name__
        attrs = [
            f"{self.label!r}",
        ]

        if self.description:
            attrs.append(f"{self.description!r}")

        attrs.extend(_repr_extension_attrs(self.extensions))

        if self.technology:
            attrs.append(f"technology={self.technology!r}")

        attrs.append(f"alias={self.alias!r}")

        args = ", ".join(attrs)
        return f"{cls_name}({args})"

__init__

__init__(
    label: Required[str] = REQUIRED,
    description: str | None = None,
    extensions: ElementExtensions | None = None,
    plantuml: Mapping[str, Any] | None = None,
    mermaid: Mapping[str, Any] | None = None,
    alias: Maybe[str] = MISSING,
) -> None

Parameters:

Name Type Description Default
label Required[str]

Display name for the element. Required.

REQUIRED
description str | None

Optional description text.

None
extensions ElementExtensions | None

Backend-specific extension data.

None
plantuml Mapping[str, Any] | None

PlantUML-specific extension data.

None
mermaid Mapping[str, Any] | None

Mermaid-specific extension data.

None
alias Maybe[str]

Unique identifier for the element. If not provided, it is autogenerated from the label.

MISSING

Raises:

Type Description
ValueError

If label is not provided.

Source code in c4/diagrams/core/components.py
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
def __init__(
    self,
    label: Required[str] = REQUIRED,
    description: str | None = None,
    extensions: ElementExtensions | None = None,
    plantuml: Mapping[str, Any] | None = None,
    mermaid: Mapping[str, Any] | None = None,
    alias: Maybe[str] = MISSING,
) -> None:
    """
    Initialize a new diagram element. Automatically adds the element to the
    current diagram.

    Args:
        label: Display name for the element. Required.
        description: Optional description text.
        extensions: Backend-specific extension data.
        plantuml: PlantUML-specific extension data.
        mermaid: Mermaid-specific extension data.
        alias: Unique identifier for the element. If not provided, it is
            autogenerated from the label.

    Raises:
        ValueError: If `label` is not provided.
    """
    self.label = self._check_label(label)
    self.alias = self._check_alias(alias, self.label)
    self.description = description
    self.extensions = merge_extensions(
        extensions,
        plantuml=plantuml,
        mermaid=mermaid,
    )

    self.technology = None

    super().__init__()

uses

uses(
    other: TElement,
    label: str,
    relationship_type: RelationshipType = REL,
    **kwargs: Any,
) -> Relationship

Declare that this element uses another.

Parameters:

Name Type Description Default
other TElement

The element being used.

required
label str

Description of the interaction.

required
relationship_type RelationshipType

Type of arrow to use.

REL
kwargs Any

Optional relationship kwargs.

{}

Returns:

Type Description
Relationship

The created relationship.

Source code in c4/diagrams/core/components.py
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
def uses(
    self,
    other: TElement,
    label: str,
    relationship_type: RelationshipType = RelationshipType.REL,
    **kwargs: Any,
) -> Relationship:
    """
    Declare that this element uses another.

    Args:
        other: The element being used.
        label: Description of the interaction.
        relationship_type: Type of arrow to use.
        kwargs: Optional relationship kwargs.

    Returns:
        The created relationship.
    """
    relationship_class = Relationship.get_relationship_by_type(
        relationship_type
    )
    return relationship_class(
        from_element=self,  # type: ignore[arg-type]
        to_element=other,  # type: ignore[arg-type]
        label=label,
        **kwargs,
    )

used_by

used_by(
    other: TElement,
    label: str,
    relationship_type: RelationshipType = REL,
    **kwargs: Any,
) -> Relationship

Declare that another element uses this element.

Parameters:

Name Type Description Default
other TElement

The element that uses this element.

required
label str

Description of the interaction.

required
relationship_type RelationshipType

Type of arrow to use.

REL
kwargs Any

Optional relationship kwargs.

{}

Returns:

Type Description
Relationship

The created relationship.

Source code in c4/diagrams/core/components.py
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
def used_by(
    self,
    other: TElement,
    label: str,
    relationship_type: RelationshipType = RelationshipType.REL,
    **kwargs: Any,
) -> Relationship:
    """
    Declare that another element uses this element.

    Args:
        other: The element that uses this element.
        label: Description of the interaction.
        relationship_type: Type of arrow to use.
        kwargs: Optional relationship kwargs.

    Returns:
        The created relationship.
    """
    relationship_class = Relationship.get_relationship_by_type(
        relationship_type
    )
    return relationship_class(
        from_element=other,  # type: ignore[arg-type]
        to_element=self,  # type: ignore[arg-type]
        label=label,
        **kwargs,
    )

c4.diagrams.core.ElementWithTechnology

Bases: Element

Base class for elements that define a technology field.

Source code in c4/diagrams/core/components.py
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
class ElementWithTechnology(Element):
    """
    Base class for elements that define a `technology` field.
    """

    def __init__(
        self,
        label: Required[str] = REQUIRED,
        description: str | None = None,
        technology: str | None = None,
        extensions: ElementExtensions | None = None,
        plantuml: Mapping[str, Any] | None = None,
        mermaid: Mapping[str, Any] | None = None,
        alias: Maybe[str] = MISSING,
    ) -> None:
        """
        Initialize a new diagram element.

        Args:
            label: Display name for the element. Required.
            description: Optional description text.
            technology: Optional technology.
            extensions: Backend-specific extension data.
            plantuml: PlantUML-specific extension data.
            mermaid: Mermaid-specific extension data.
            alias: Unique identifier for the element. If not provided, it is
                autogenerated from the label.
        """
        super().__init__(
            alias=alias,
            label=label,
            description=description,
            extensions=extensions,
            plantuml=plantuml,
            mermaid=mermaid,
        )

        self.technology = technology

__init__

__init__(
    label: Required[str] = REQUIRED,
    description: str | None = None,
    technology: str | None = None,
    extensions: ElementExtensions | None = None,
    plantuml: Mapping[str, Any] | None = None,
    mermaid: Mapping[str, Any] | None = None,
    alias: Maybe[str] = MISSING,
) -> None

Parameters:

Name Type Description Default
label Required[str]

Display name for the element. Required.

REQUIRED
description str | None

Optional description text.

None
technology str | None

Optional technology.

None
extensions ElementExtensions | None

Backend-specific extension data.

None
plantuml Mapping[str, Any] | None

PlantUML-specific extension data.

None
mermaid Mapping[str, Any] | None

Mermaid-specific extension data.

None
alias Maybe[str]

Unique identifier for the element. If not provided, it is autogenerated from the label.

MISSING
Source code in c4/diagrams/core/components.py
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
def __init__(
    self,
    label: Required[str] = REQUIRED,
    description: str | None = None,
    technology: str | None = None,
    extensions: ElementExtensions | None = None,
    plantuml: Mapping[str, Any] | None = None,
    mermaid: Mapping[str, Any] | None = None,
    alias: Maybe[str] = MISSING,
) -> None:
    """
    Initialize a new diagram element.

    Args:
        label: Display name for the element. Required.
        description: Optional description text.
        technology: Optional technology.
        extensions: Backend-specific extension data.
        plantuml: PlantUML-specific extension data.
        mermaid: Mermaid-specific extension data.
        alias: Unique identifier for the element. If not provided, it is
            autogenerated from the label.
    """
    super().__init__(
        alias=alias,
        label=label,
        description=description,
        extensions=extensions,
        plantuml=plantuml,
        mermaid=mermaid,
    )

    self.technology = technology

c4.diagrams.core.Boundary

Bases: Element

Represents a boundary element that groups other elements.

Boundaries can be nested, and manage their own child elements.

Source code in c4/diagrams/core/components.py
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
class Boundary(Element):
    """
    Represents a boundary element that groups other elements.

    Boundaries can be nested, and manage their own child elements.
    """

    def __init__(
        self,
        label: Required[str] = REQUIRED,
        description: str | None = None,
        extensions: ElementExtensions | None = None,
        plantuml: Mapping[str, Any] | None = None,
        mermaid: Mapping[str, Any] | None = None,
        alias: Maybe[str] = MISSING,
    ) -> None:
        """
        Initialize a new boundary element.

        Args:
            label: Human-readable name for the boundary. Required.
            description: Optional description.
            extensions: Backend-specific extension data.
            plantuml: PlantUML-specific extension data.
            mermaid: Mermaid-specific extension data.
            alias: Unique identifier for the boundary.
                If not provided, one is autogenerated.

        Notes:
            - If the boundary is created within another boundary context, it is
              added as a nested boundary.
            - Otherwise, it is added directly to the current diagram.
        """
        self._parent = get_boundary()

        super().__init__(
            label=label,
            alias=alias,
            description=description,
            extensions=extensions,
            plantuml=plantuml,
            mermaid=mermaid,
        )

        self._elements: list[Element] = []
        self._relationships: list[Relationship] = []
        self._boundaries: list[Boundary] = []

        self.__ordered_elements: list[BaseDiagramElement] = []

    @override
    def _contribute_to_diagram(self) -> None:
        """Register this boundary in the current diagram or parent boundary."""
        self._check_diagram_type()
        self._diagram.add_boundary(self)

    @property
    def elements(self) -> list[Element]:
        """
        Returns the list of diagram elements added to this boundary.

        Returns:
            Child elements grouped under this boundary.
        """
        return self._elements

    @property
    def boundaries(self) -> list[Boundary]:
        """
        Returns the list of nested boundaries inside this boundary.

        Returns:
            Child boundaries nested within this boundary.
        """
        return self._boundaries

    @property
    def ordered_elements(self) -> list[BaseDiagramElement]:
        """
        Return boundary items in their order of definition.

        The sequence can include C4 elements, relationships, boundaries, and
        backend-owned statements that affect declaration-order rendering.
        """
        return self.__ordered_elements

    @property
    def relationships(self) -> list[Relationship]:
        """
        Returns all relationships defined in the boundary.
        """
        return self._relationships

    def __enter__(self) -> Self:
        """
        Enter the boundary context.

        Returns:
            The boundary instance now active as context.
        """
        set_boundary(self)
        return self

    def __exit__(
        self,
        exc_type: type[BaseException] | None,
        exc_value: BaseException | None,
        traceback: TracebackType | None,
    ) -> None:
        """
        Exit the boundary context and restore the previous boundary.
        """
        set_boundary(self._parent)

    def add(self, element: TElement) -> TElement:
        """
        Add a diagram element to this boundary.

        Args:
            element: The element to add.

        Returns:
            The added element.
        """
        self._elements.append(element)
        self.__ordered_elements.append(element)

        return element

    def add_boundary(self, boundary: TBoundary) -> TBoundary:
        """
        Add a nested boundary to this boundary.

        Args:
            boundary: The boundary to add.

        Returns:
            The added boundary.
        """
        self._boundaries.append(boundary)
        self.__ordered_elements.append(boundary)

        return boundary

    def add_relationship(self, relationship: TRelationship) -> TRelationship:
        """
        Add a relationship between elements.

        Args:
            relationship: The relationship to add.

        Returns:
            The added relationship.
        """
        self._relationships.append(relationship)
        self.__ordered_elements.append(relationship)

        return relationship

    def add_ordered_element(
        self, element: BaseDiagramElement
    ) -> BaseDiagramElement:
        """Add a diagram object to this boundary declaration-order sequence."""
        self.__ordered_elements.append(element)

        return element

__init__

__init__(
    label: Required[str] = REQUIRED,
    description: str | None = None,
    extensions: ElementExtensions | None = None,
    plantuml: Mapping[str, Any] | None = None,
    mermaid: Mapping[str, Any] | None = None,
    alias: Maybe[str] = MISSING,
) -> None

Parameters:

Name Type Description Default
label Required[str]

Human-readable name for the boundary. Required.

REQUIRED
description str | None

Optional description.

None
extensions ElementExtensions | None

Backend-specific extension data.

None
plantuml Mapping[str, Any] | None

PlantUML-specific extension data.

None
mermaid Mapping[str, Any] | None

Mermaid-specific extension data.

None
alias Maybe[str]

Unique identifier for the boundary. If not provided, one is autogenerated.

MISSING
Notes
  • If the boundary is created within another boundary context, it is added as a nested boundary.
  • Otherwise, it is added directly to the current diagram.
Source code in c4/diagrams/core/components.py
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
def __init__(
    self,
    label: Required[str] = REQUIRED,
    description: str | None = None,
    extensions: ElementExtensions | None = None,
    plantuml: Mapping[str, Any] | None = None,
    mermaid: Mapping[str, Any] | None = None,
    alias: Maybe[str] = MISSING,
) -> None:
    """
    Initialize a new boundary element.

    Args:
        label: Human-readable name for the boundary. Required.
        description: Optional description.
        extensions: Backend-specific extension data.
        plantuml: PlantUML-specific extension data.
        mermaid: Mermaid-specific extension data.
        alias: Unique identifier for the boundary.
            If not provided, one is autogenerated.

    Notes:
        - If the boundary is created within another boundary context, it is
          added as a nested boundary.
        - Otherwise, it is added directly to the current diagram.
    """
    self._parent = get_boundary()

    super().__init__(
        label=label,
        alias=alias,
        description=description,
        extensions=extensions,
        plantuml=plantuml,
        mermaid=mermaid,
    )

    self._elements: list[Element] = []
    self._relationships: list[Relationship] = []
    self._boundaries: list[Boundary] = []

    self.__ordered_elements: list[BaseDiagramElement] = []

elements property

elements: list[Element]

Returns the list of diagram elements added to this boundary.

Returns:

Type Description
list[Element]

Child elements grouped under this boundary.

boundaries property

boundaries: list[Boundary]

Returns the list of nested boundaries inside this boundary.

Returns:

Type Description
list[Boundary]

Child boundaries nested within this boundary.

relationships property

relationships: list[Relationship]

Returns all relationships defined in the boundary.

__enter__

__enter__() -> Self

Enter the boundary context.

Returns:

Type Description
Self

The boundary instance now active as context.

Source code in c4/diagrams/core/components.py
795
796
797
798
799
800
801
802
803
def __enter__(self) -> Self:
    """
    Enter the boundary context.

    Returns:
        The boundary instance now active as context.
    """
    set_boundary(self)
    return self

__exit__

__exit__(
    exc_type: type[BaseException] | None,
    exc_value: BaseException | None,
    traceback: TracebackType | None,
) -> None

Exit the boundary context and restore the previous boundary.

Source code in c4/diagrams/core/components.py
805
806
807
808
809
810
811
812
813
814
def __exit__(
    self,
    exc_type: type[BaseException] | None,
    exc_value: BaseException | None,
    traceback: TracebackType | None,
) -> None:
    """
    Exit the boundary context and restore the previous boundary.
    """
    set_boundary(self._parent)

set_property_header

set_property_header(*args: str) -> Self

Sets the column headers for the element's property table.

This must be called either before adding any property rows, or the header length must match the number of values.

Parameters:

Name Type Description Default
*args str

Column names to use as the property header.

()

Returns:

Type Description
Self

The updated diagram element.

Raises:

Type Description
ValueError

If header length does not match the number of values.

Source code in c4/diagrams/core/components.py
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
def set_property_header(self, *args: str) -> Self:
    """
    Sets the column headers for the element's property table.

    This must be called either before adding any property rows, or
    the header length must match the number of values.

    Args:
        *args: Column names to use as the property header.

    Returns:
        The updated diagram element.

    Raises:
        ValueError: If header length does not match the number of values.
    """
    self.properties.set_header(*args)

    return self

without_property_header

without_property_header() -> Self

Disables the rendering of the header row in the property table.

Returns:

Type Description
Self

The updated diagram element.

Source code in c4/diagrams/core/components.py
335
336
337
338
339
340
341
342
343
344
def without_property_header(self) -> Self:
    """
    Disables the rendering of the header row in the property table.

    Returns:
        The updated diagram element.
    """
    self.properties.without_header()

    return self

add_property

add_property(*args: str) -> Self

Adds a row to the property table.

The number of arguments must match the number of header columns.

Parameters:

Name Type Description Default
*args str

Values for each column in the property row.

()

Returns:

Type Description
Self

The updated diagram element.

Raises:

Type Description
ValueError

If the number of values does not match the header length.

Source code in c4/diagrams/core/components.py
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
def add_property(self, *args: str) -> Self:
    """
    Adds a row to the property table.

    The number of arguments must match the number of header columns.

    Args:
        *args: Values for each column in the property row.

    Returns:
        The updated diagram element.

    Raises:
        ValueError: If the number of values does not match the
            header length.
    """
    self.properties.add_row(*args)

    return self

with_properties

with_properties(
    *properties: str | PropertyRow,
    header: Sequence[str] | None = None,
    show_header: bool = True,
) -> Self

Adds one or more rows to the property table.

For one row, pass values directly:

element.with_properties("Role", "Operator")

For multiple rows, pass row sequences:

element.with_properties(
    ("Role", "Operator"),
    ("Shift", "Daytime"),
)

Parameters:

Name Type Description Default
*properties str | PropertyRow

Values for one row, or row sequences.

()
header Sequence[str] | None

Optional property table header override.

None
show_header bool

Whether to render the property table header.

True

Returns:

Type Description
Self

The updated diagram element.

Source code in c4/diagrams/core/components.py
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
def with_properties(
    self,
    *properties: str | PropertyRow,
    header: Sequence[str] | None = None,
    show_header: bool = True,
) -> Self:
    """
    Adds one or more rows to the property table.

    For one row, pass values directly:

        element.with_properties("Role", "Operator")

    For multiple rows, pass row sequences:

        element.with_properties(
            ("Role", "Operator"),
            ("Shift", "Daytime"),
        )

    Args:
        *properties: Values for one row, or row sequences.
        header: Optional property table header override.
        show_header: Whether to render the property table header.

    Returns:
        The updated diagram element.
    """
    self.properties.with_rows(
        *properties,
        header=header,
        show_header=show_header,
    )

    return self

c4.diagrams.core.RelationshipType

Bases: EnumDescriptionsMixin, StrEnum

Relationship dispatch keys used by relationship DSL classes.

REL is the portable core relationship type. The other values map to backend-specific C4-PlantUML relationship macros and should normally be used through c4.contrib.plantuml relationship classes.

Source code in c4/diagrams/core/enums.py
 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
@unique
class RelationshipType(EnumDescriptionsMixin, StrEnum):
    """
    Relationship dispatch keys used by relationship DSL classes.

    `REL` is the portable core relationship type. The other values map to
    backend-specific C4-PlantUML relationship macros and should normally be
    used through `c4.contrib.plantuml` relationship classes.
    """

    REL = "REL"
    BI_REL = "BI_REL"
    REL_BACK = "REL_BACK"
    REL_NEIGHBOR = "REL_NEIGHBOR"
    BI_REL_NEIGHBOR = "BI_REL_NEIGHBOR"
    REL_BACK_NEIGHBOR = "REL_BACK_NEIGHBOR"
    REL_D = "REL_D"
    REL_DOWN = "REL_DOWN"
    BI_REL_D = "BI_REL_D"
    BI_REL_DOWN = "BI_REL_DOWN"
    REL_U = "REL_U"
    REL_UP = "REL_UP"
    BI_REL_U = "BI_REL_U"
    BI_REL_UP = "BI_REL_UP"
    REL_L = "REL_L"
    REL_LEFT = "REL_LEFT"
    BI_REL_L = "BI_REL_L"
    BI_REL_LEFT = "BI_REL_LEFT"
    REL_R = "REL_R"
    REL_RIGHT = "REL_RIGHT"
    BI_REL_R = "BI_REL_R"
    BI_REL_RIGHT = "BI_REL_RIGHT"

    @classmethod
    def get_descriptions(cls) -> dict[RelationshipType, str]:
        """Return the Enum items description used in documentation."""
        return {
            cls.BI_REL: "A bidirectional relationship between two elements.",
            cls.BI_REL_DOWN: "A bidirectional downward relationship.",
            cls.BI_REL_D: (
                "A bidirectional downward relationship. "
                "Shorthand for `BI_REL_DOWN`."
            ),
            cls.BI_REL_LEFT: "A bidirectional leftward relationship.",
            cls.BI_REL_L: (
                "A bidirectional leftward relationship. "
                "Shorthand for `BI_REL_LEFT`."
            ),
            cls.BI_REL_NEIGHBOR: (
                "A bidirectional neighboring relationship between two elements."
            ),
            cls.BI_REL_RIGHT: "A bidirectional rightward relationship.",
            cls.BI_REL_R: (
                "A bidirectional rightward relationship. "
                "Shorthand for `BI_REL_RIGHT`."
            ),
            cls.BI_REL_UP: "A bidirectional upward relationship.",
            cls.BI_REL_U: (
                "A bidirectional upward relationship. "
                "Shorthand for `BI_REL_UP`."
            ),
            cls.REL: "A unidirectional relationship between two elements.",
            cls.REL_BACK: "A unidirectional relationship pointing backward.",
            cls.REL_BACK_NEIGHBOR: (
                "A unidirectional relationship combining backward "
                "and neighboring semantics."
            ),
            cls.REL_DOWN: "A unidirectional downward relationship.",
            cls.REL_D: (
                "A unidirectional downward relationship. "
                "Shorthand for `REL_DOWN`."
            ),
            cls.REL_LEFT: "A unidirectional leftward relationship.",
            cls.REL_L: (
                "A unidirectional leftward relationship. "
                "Shorthand for `REL_LEFT`."
            ),
            cls.REL_NEIGHBOR: (
                "A unidirectional relationship representing a lateral "
                "or neighboring interaction."
            ),
            cls.REL_RIGHT: "A unidirectional rightward relationship.",
            cls.REL_R: (
                "A unidirectional rightward relationship. "
                "Shorthand for `REL_RIGHT`."
            ),
            cls.REL_UP: "A unidirectional upward relationship.",
            cls.REL_U: (
                "A unidirectional upward relationship. Shorthand for `REL_UP`."
            ),
        }

get_descriptions classmethod

get_descriptions() -> dict[RelationshipType, str]

Return the Enum items description used in documentation.

Source code in c4/diagrams/core/enums.py
 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
@classmethod
def get_descriptions(cls) -> dict[RelationshipType, str]:
    """Return the Enum items description used in documentation."""
    return {
        cls.BI_REL: "A bidirectional relationship between two elements.",
        cls.BI_REL_DOWN: "A bidirectional downward relationship.",
        cls.BI_REL_D: (
            "A bidirectional downward relationship. "
            "Shorthand for `BI_REL_DOWN`."
        ),
        cls.BI_REL_LEFT: "A bidirectional leftward relationship.",
        cls.BI_REL_L: (
            "A bidirectional leftward relationship. "
            "Shorthand for `BI_REL_LEFT`."
        ),
        cls.BI_REL_NEIGHBOR: (
            "A bidirectional neighboring relationship between two elements."
        ),
        cls.BI_REL_RIGHT: "A bidirectional rightward relationship.",
        cls.BI_REL_R: (
            "A bidirectional rightward relationship. "
            "Shorthand for `BI_REL_RIGHT`."
        ),
        cls.BI_REL_UP: "A bidirectional upward relationship.",
        cls.BI_REL_U: (
            "A bidirectional upward relationship. "
            "Shorthand for `BI_REL_UP`."
        ),
        cls.REL: "A unidirectional relationship between two elements.",
        cls.REL_BACK: "A unidirectional relationship pointing backward.",
        cls.REL_BACK_NEIGHBOR: (
            "A unidirectional relationship combining backward "
            "and neighboring semantics."
        ),
        cls.REL_DOWN: "A unidirectional downward relationship.",
        cls.REL_D: (
            "A unidirectional downward relationship. "
            "Shorthand for `REL_DOWN`."
        ),
        cls.REL_LEFT: "A unidirectional leftward relationship.",
        cls.REL_L: (
            "A unidirectional leftward relationship. "
            "Shorthand for `REL_LEFT`."
        ),
        cls.REL_NEIGHBOR: (
            "A unidirectional relationship representing a lateral "
            "or neighboring interaction."
        ),
        cls.REL_RIGHT: "A unidirectional rightward relationship.",
        cls.REL_R: (
            "A unidirectional rightward relationship. "
            "Shorthand for `REL_RIGHT`."
        ),
        cls.REL_UP: "A unidirectional upward relationship.",
        cls.REL_U: (
            "A unidirectional upward relationship. Shorthand for `REL_UP`."
        ),
    }

c4.diagrams.core.Relationship

Bases: BaseDiagramElement

Represents a connection between two elements.

Supports direct construction and fluent chaining using >> and << operators. Subclasses are registered by RelationshipType.

Source code in c4/diagrams/core/components.py
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
class Relationship(BaseDiagramElement):
    """
    Represents a connection between two elements.

    Supports direct construction and fluent chaining using `>>` and `<<`
    operators. Subclasses are registered by
    [`RelationshipType`][c4.diagrams.core.RelationshipType].
    """

    __relationship_by_type: ClassVar[
        dict[RelationshipType, type[Relationship]]
    ] = {}

    relationship_type: RelationshipType = RelationshipType.REL

    def __init__(
        self,
        label: str | None = None,
        description: str | None = None,
        technology: str | None = None,
        from_element: TElement | None = None,
        to_element: TElement | None = None,
        relationship_type: RelationshipType | None = None,
        extensions: ElementExtensions | None = None,
        plantuml: Mapping[str, Any] | None = None,
        mermaid: Mapping[str, Any] | None = None,
    ) -> None:
        """
        Initialize a relationship between two elements.

        Args:
            label: The label shown on the relationship edge.
            description: Additional details about the relationship.
            technology: The technology used in the communication.
            from_element: The source element. Optional.
            to_element: The destination element. Optional.
            relationship_type: Type of the relationship.
                Defaults to the class-level `relationship_type`.
            extensions: Backend-specific extension data.
            plantuml: PlantUML-specific extension data.
            mermaid: Mermaid-specific extension data.

        Notes:
            If both `from_element` and `to_element` are provided,
            the relationship will be registered in the current
            diagram immediately.
        """
        self.from_element = from_element
        self.to_element = to_element
        self.label = label
        self.technology = technology
        self.description = description
        self.extensions = merge_extensions(
            extensions,
            plantuml=plantuml,
            mermaid=mermaid,
        )

        self.relationship_type = relationship_type or self.relationship_type

        super().__init__()

    @override
    def __init_subclass__(cls, *args: Any, **kwargs: Any) -> None:
        """
        Registers the relationship subclass under its unique
        `relationship_type`.
        """
        super().__init_subclass__(*args, **kwargs)

        relationship_type = getattr(cls, "relationship_type", None)
        if (
            relationship_type is None
            or relationship_type in cls.__relationship_by_type
        ):
            raise TypeError(
                f"Please provide an unique `relationship_type` for this"
                f" class {cls.__name__}"
            )

        cls.__relationship_by_type[relationship_type] = cls

    def get_participants(self) -> tuple[TElement, TElement]:
        """
        Return the source and destination elements for a complete relationship.

        Raises:
            ValueError: If either endpoint has not been provided yet.
        """
        if not self.from_element:
            raise ValueError("from_element not provided")

        if not self.to_element:
            raise ValueError("to_element not provided")

        return self.from_element, self.to_element  # type: ignore[return-value]

    @overload
    def __rshift__(
        self, other: TElement
    ) -> Relationship: ...  # pragma: no cover

    @overload
    def __rshift__(
        self, other: list[TElement]
    ) -> list[Relationship]: ...  # pragma: no cover

    def __rshift__(
        self, other: TElement | list[TElement]
    ) -> Relationship | list[Relationship]:
        """Complete this partial relationship with one or more destinations."""
        self._ensure_not_completed()

        return self._connect(source=self.from_element, destination=other)  # type: ignore[arg-type,type-var]

    @overload
    def __lshift__(
        self, other: TElement
    ) -> Relationship: ...  # pragma: no cover

    @overload
    def __lshift__(
        self, other: list[TElement]
    ) -> list[Relationship]: ...  # pragma: no cover

    def __lshift__(
        self, other: TElement | list[TElement]
    ) -> Relationship | list[Relationship]:
        """Complete this partial relationship with one or more sources."""
        self._ensure_not_completed()

        return self._connect(source=other, destination=self.to_element)  # type: ignore[arg-type,type-var]

    @overload
    def __rrshift__(
        self, other: TElement
    ) -> Relationship: ...  # pragma: no cover

    @overload
    def __rrshift__(
        self, other: list[TElement]
    ) -> list[Relationship]: ...  # pragma: no cover

    def __rrshift__(
        self, other: TElement | list[TElement]
    ) -> Relationship | list[Relationship]:
        """Complete this partial relationship from left-hand sources."""
        self._ensure_not_completed()

        return self._connect(source=other, destination=self.to_element)  # type: ignore[arg-type,type-var]

    @overload
    def __rlshift__(
        self, other: TElement
    ) -> Relationship: ...  # pragma: no cover

    @overload
    def __rlshift__(
        self, other: list[TElement]
    ) -> list[Relationship]: ...  # pragma: no cover

    def __rlshift__(
        self, other: TElement | list[TElement]
    ) -> Relationship | list[Relationship]:
        """Complete this partial relationship to left-hand destinations."""
        self._ensure_not_completed()

        return self._connect(source=self.from_element, destination=other)  # type: ignore[arg-type,type-var]

    def __repr__(self) -> str:
        cls_name = self.__class__.__name__
        attrs = [
            f"{self.label!r}",
        ]

        if self.description:
            attrs.append(f"{self.description!r}")

        repr_attrs = ["technology"]

        for attr in repr_attrs:
            value = getattr(self, attr)
            if value:
                attrs.append(f"{attr}={value!r}")

        attrs.extend(_repr_extension_attrs(self.extensions))

        args = ", ".join(attrs)
        return f"{cls_name}({args})"

    @overload
    def _connect(
        self, source: None, destination: None
    ) -> NoReturn: ...  # pragma: no cover

    @overload
    def _connect(
        self, source: TElement, destination: None
    ) -> NoReturn: ...  # pragma: no cover

    @overload
    def _connect(
        self, source: None, destination: TElement
    ) -> NoReturn: ...  # pragma: no cover

    @overload
    def _connect(
        self, source: TElement, destination: TElement
    ) -> Relationship: ...  # pragma: no cover

    @overload
    def _connect(
        self, source: list[TElement], destination: None
    ) -> NoReturn: ...  # pragma: no cover

    @overload
    def _connect(
        self, source: None, destination: list[TElement]
    ) -> NoReturn: ...  # pragma: no cover

    @overload
    def _connect(
        self, source: list[TElement], destination: list[TElement]
    ) -> NoReturn: ...  # pragma: no cover

    @overload
    def _connect(
        self, source: list[TElement], destination: TElement
    ) -> list[Relationship]: ...  # pragma: no cover

    @overload
    def _connect(
        self, source: TElement, destination: list[TElement]
    ) -> list[Relationship]: ...  # pragma: no cover

    def _connect(
        self,
        source: TElement | list[TElement] | None,
        destination: TElement | list[TElement] | None,
    ) -> Relationship | list[Relationship]:
        """
        Create one or more completed relationship copies.

        Args:
            source: Source element, list of sources, or `None` for an
                already-stored source.
            destination: Destination element, list of destinations, or `None`
                for an already-stored destination.

        Returns:
            A completed relationship or a list of completed relationships.

        Raises:
            ValueError: If both endpoints are missing, both endpoints are
                lists, or this relationship is already complete.
        """
        self._ensure_not_completed()

        if not source and not destination:
            raise ValueError("Either source or destination must be provided")

        if isinstance(source, list) and isinstance(destination, list):
            raise ValueError(  # noqa: TRY004
                "Either source or destination must be a single element"
            )

        if isinstance(source, list):
            from_iter = source
            to_iter: Iterable[TElement] = repeat(destination)  # type: ignore[arg-type]
        elif isinstance(destination, list):
            from_iter: Iterable[TElement] = repeat(source)  # type: ignore[no-redef]
            to_iter = destination
        else:
            # Both are single elements
            return self.copy(from_element=source, to_element=destination)

        return [
            self.copy(from_element=src, to_element=dst)
            for src, dst in zip(from_iter, to_iter, strict=False)
        ]

    def _ensure_not_completed(self) -> None:
        """Raise if both relationship endpoints are already set."""
        if self.from_element and self.to_element:
            raise ValueError(
                "Cannot modify relationship with both specified elements"
            )

    @override
    def _contribute_to_diagram(self) -> None:
        """Register complete relationships in the current diagram context."""
        self._check_diagram_type()
        if self.from_element and self.to_element:
            self._diagram.add_relationship(self)

    def get_attrs(self) -> dict[str, Any]:
        """
        Return the constructor attributes for this relationship.
        """
        return {
            "from_element": self.from_element,
            "to_element": self.to_element,
            "label": self.label,
            "technology": self.technology,
            "description": self.description,
            "extensions": self.extensions,
            "relationship_type": self.relationship_type,
        }

    def copy(self, **overrides: Any) -> Relationship:
        """
        Clone this relationship, optionally overriding constructor fields.

        Args:
            **overrides: Field values to override in the cloned relationship.

        Returns:
            A new relationship with copied properties.
        """
        attrs = {**self.get_attrs(), **overrides}

        cls = self.get_relationship_by_type(self.relationship_type)

        relationship_copy = cls(**attrs)

        if self.properties.properties:
            relationship_copy.properties = copy.deepcopy(self.properties)

        return relationship_copy

    @classmethod
    def get_relationship_by_type(
        cls, relationship_type: RelationshipType
    ) -> type[Relationship]:
        """
        Retrieve the relationship class associated with the
        given RelationshipType.

        Args:
            relationship_type: The enum value representing the
                type of relationship.

        Returns:
            The corresponding Relationship subclass.

        Raises:
            KeyError: If no class is registered for the provided
                relationship type.
        """
        return cls.__relationship_by_type[relationship_type]

__init__

__init__(
    label: str | None = None,
    description: str | None = None,
    technology: str | None = None,
    from_element: TElement | None = None,
    to_element: TElement | None = None,
    relationship_type: RelationshipType | None = None,
    extensions: ElementExtensions | None = None,
    plantuml: Mapping[str, Any] | None = None,
    mermaid: Mapping[str, Any] | None = None,
) -> None

Parameters:

Name Type Description Default
label str | None

The label shown on the relationship edge.

None
description str | None

Additional details about the relationship.

None
technology str | None

The technology used in the communication.

None
from_element TElement | None

The source element. Optional.

None
to_element TElement | None

The destination element. Optional.

None
relationship_type RelationshipType | None

Type of the relationship. Defaults to the class-level relationship_type.

None
extensions ElementExtensions | None

Backend-specific extension data.

None
plantuml Mapping[str, Any] | None

PlantUML-specific extension data.

None
mermaid Mapping[str, Any] | None

Mermaid-specific extension data.

None
Notes

If both from_element and to_element are provided, the relationship will be registered in the current diagram immediately.

Source code in c4/diagrams/core/components.py
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
def __init__(
    self,
    label: str | None = None,
    description: str | None = None,
    technology: str | None = None,
    from_element: TElement | None = None,
    to_element: TElement | None = None,
    relationship_type: RelationshipType | None = None,
    extensions: ElementExtensions | None = None,
    plantuml: Mapping[str, Any] | None = None,
    mermaid: Mapping[str, Any] | None = None,
) -> None:
    """
    Initialize a relationship between two elements.

    Args:
        label: The label shown on the relationship edge.
        description: Additional details about the relationship.
        technology: The technology used in the communication.
        from_element: The source element. Optional.
        to_element: The destination element. Optional.
        relationship_type: Type of the relationship.
            Defaults to the class-level `relationship_type`.
        extensions: Backend-specific extension data.
        plantuml: PlantUML-specific extension data.
        mermaid: Mermaid-specific extension data.

    Notes:
        If both `from_element` and `to_element` are provided,
        the relationship will be registered in the current
        diagram immediately.
    """
    self.from_element = from_element
    self.to_element = to_element
    self.label = label
    self.technology = technology
    self.description = description
    self.extensions = merge_extensions(
        extensions,
        plantuml=plantuml,
        mermaid=mermaid,
    )

    self.relationship_type = relationship_type or self.relationship_type

    super().__init__()

get_attrs

get_attrs() -> dict[str, Any]

Return the constructor attributes for this relationship.

Source code in c4/diagrams/core/components.py
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
def get_attrs(self) -> dict[str, Any]:
    """
    Return the constructor attributes for this relationship.
    """
    return {
        "from_element": self.from_element,
        "to_element": self.to_element,
        "label": self.label,
        "technology": self.technology,
        "description": self.description,
        "extensions": self.extensions,
        "relationship_type": self.relationship_type,
    }

copy

copy(**overrides: Any) -> Relationship

Clone this relationship, optionally overriding constructor fields.

Parameters:

Name Type Description Default
**overrides Any

Field values to override in the cloned relationship.

{}

Returns:

Type Description
Relationship

A new relationship with copied properties.

Source code in c4/diagrams/core/components.py
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
def copy(self, **overrides: Any) -> Relationship:
    """
    Clone this relationship, optionally overriding constructor fields.

    Args:
        **overrides: Field values to override in the cloned relationship.

    Returns:
        A new relationship with copied properties.
    """
    attrs = {**self.get_attrs(), **overrides}

    cls = self.get_relationship_by_type(self.relationship_type)

    relationship_copy = cls(**attrs)

    if self.properties.properties:
        relationship_copy.properties = copy.deepcopy(self.properties)

    return relationship_copy

get_relationship_by_type classmethod

get_relationship_by_type(
    relationship_type: RelationshipType,
) -> type[Relationship]

Retrieve the relationship class associated with the given RelationshipType.

Parameters:

Name Type Description Default
relationship_type RelationshipType

The enum value representing the type of relationship.

required

Returns:

Type Description
type[Relationship]

The corresponding Relationship subclass.

Raises:

Type Description
KeyError

If no class is registered for the provided relationship type.

Source code in c4/diagrams/core/components.py
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
@classmethod
def get_relationship_by_type(
    cls, relationship_type: RelationshipType
) -> type[Relationship]:
    """
    Retrieve the relationship class associated with the
    given RelationshipType.

    Args:
        relationship_type: The enum value representing the
            type of relationship.

    Returns:
        The corresponding Relationship subclass.

    Raises:
        KeyError: If no class is registered for the provided
            relationship type.
    """
    return cls.__relationship_by_type[relationship_type]

set_property_header

set_property_header(*args: str) -> Self

Sets the column headers for the element's property table.

This must be called either before adding any property rows, or the header length must match the number of values.

Parameters:

Name Type Description Default
*args str

Column names to use as the property header.

()

Returns:

Type Description
Self

The updated diagram element.

Raises:

Type Description
ValueError

If header length does not match the number of values.

Source code in c4/diagrams/core/components.py
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
def set_property_header(self, *args: str) -> Self:
    """
    Sets the column headers for the element's property table.

    This must be called either before adding any property rows, or
    the header length must match the number of values.

    Args:
        *args: Column names to use as the property header.

    Returns:
        The updated diagram element.

    Raises:
        ValueError: If header length does not match the number of values.
    """
    self.properties.set_header(*args)

    return self

without_property_header

without_property_header() -> Self

Disables the rendering of the header row in the property table.

Returns:

Type Description
Self

The updated diagram element.

Source code in c4/diagrams/core/components.py
335
336
337
338
339
340
341
342
343
344
def without_property_header(self) -> Self:
    """
    Disables the rendering of the header row in the property table.

    Returns:
        The updated diagram element.
    """
    self.properties.without_header()

    return self

add_property

add_property(*args: str) -> Self

Adds a row to the property table.

The number of arguments must match the number of header columns.

Parameters:

Name Type Description Default
*args str

Values for each column in the property row.

()

Returns:

Type Description
Self

The updated diagram element.

Raises:

Type Description
ValueError

If the number of values does not match the header length.

Source code in c4/diagrams/core/components.py
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
def add_property(self, *args: str) -> Self:
    """
    Adds a row to the property table.

    The number of arguments must match the number of header columns.

    Args:
        *args: Values for each column in the property row.

    Returns:
        The updated diagram element.

    Raises:
        ValueError: If the number of values does not match the
            header length.
    """
    self.properties.add_row(*args)

    return self

with_properties

with_properties(
    *properties: str | PropertyRow,
    header: Sequence[str] | None = None,
    show_header: bool = True,
) -> Self

Adds one or more rows to the property table.

For one row, pass values directly:

element.with_properties("Role", "Operator")

For multiple rows, pass row sequences:

element.with_properties(
    ("Role", "Operator"),
    ("Shift", "Daytime"),
)

Parameters:

Name Type Description Default
*properties str | PropertyRow

Values for one row, or row sequences.

()
header Sequence[str] | None

Optional property table header override.

None
show_header bool

Whether to render the property table header.

True

Returns:

Type Description
Self

The updated diagram element.

Source code in c4/diagrams/core/components.py
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
def with_properties(
    self,
    *properties: str | PropertyRow,
    header: Sequence[str] | None = None,
    show_header: bool = True,
) -> Self:
    """
    Adds one or more rows to the property table.

    For one row, pass values directly:

        element.with_properties("Role", "Operator")

    For multiple rows, pass row sequences:

        element.with_properties(
            ("Role", "Operator"),
            ("Shift", "Daytime"),
        )

    Args:
        *properties: Values for one row, or row sequences.
        header: Optional property table header override.
        show_header: Whether to render the property table header.

    Returns:
        The updated diagram element.
    """
    self.properties.with_rows(
        *properties,
        header=header,
        show_header=show_header,
    )

    return self

Note

You can find a detailed description of the different relationship types in the corresponding sections of the documentation.

c4.diagrams.core.Diagram

Represents a complete C4 diagram.

Manages the registration and layout of elements, boundaries, relationships, and renderers.

Source code in c4/diagrams/core/diagram.py
 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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
class Diagram:
    """
    Represents a complete C4 diagram.

    Manages the registration and layout of elements, boundaries,
    relationships, and renderers.
    """

    type: ClassVar[DiagramType] = DiagramType.DIAGRAM

    def __init__(
        self,
        title: str | None = None,
        default_renderer: BaseRenderer[Diagram] | None = None,
        render_options: RenderOptions | None = None,
    ) -> None:
        """
        Initialize a new diagram.

        Args:
            title: Optional title to label the diagram.
            default_renderer: Optional default renderer to use for rendering.
            render_options: Optional renderer-specific options.
        """
        self._title = title
        self._default_renderer = default_renderer
        self._elements: list[Element] = []
        self._boundaries: list[Boundary] = []
        self._relationships: list[Relationship] = []
        self._render_options = render_options

        self.__elements_by_alias: dict[str, Element] = {}
        self.__elements_by_label: dict[str, list[Element]] = {}
        self.__alias_generator = AliasGenerator()
        self.__referenced_elements: list[str] = []
        self.__ordered_elements: list[BaseDiagramElement] = []

    def __enter__(self) -> Self:
        """
        Enter the diagram context.

        Automatically sets this diagram as the current active diagram.

        Returns:
            The current instance.
        """
        set_diagram(self)
        return self

    def __exit__(
        self,
        exc_type: type[BaseException] | None,  # type: ignore[valid-type]
        exc_value: BaseException | None,
        traceback: TracebackType | None,
    ) -> None:
        """
        Exit the diagram context and clear the current diagram.
        """
        set_diagram(None)

    def __repr__(self) -> str:
        cls_name = self.__class__.__name__
        attrs = []

        if self._title:
            attrs.append(f"title={self._title!r}")

        args = ", ".join(attrs)
        return f"{cls_name}({args})"

    def _check_alias(self, element: Element) -> None:
        """Validate and register an element alias within this diagram."""
        alias = element.alias

        if existing_element := self.get_element_by_alias(alias):
            raise ValueError(f"Duplicated alias {alias!r}: {existing_element}.")

        if not is_valid_alias(alias):
            raise ValueError(
                f"Alias {alias!r} of {element} must be a valid identifier."
            )

        self.__elements_by_alias[alias] = element

    def _check_label(self, element: Element) -> None:
        """Register an element under its human-readable label."""
        label = element.label

        self.__elements_by_label.setdefault(label, [])
        self.__elements_by_label[label].append(element)

    @property
    def title(self) -> str | None:
        """
        Returns the title of the diagram.
        """
        return self._title

    @property
    def elements(self) -> list[Element]:
        """
        Returns a list of top-level elements in the diagram.
        """
        return self._elements

    @property
    def boundaries(self) -> list[Boundary]:
        """
        Returns all top-level boundaries in the diagram.
        """
        return self._boundaries

    @property
    def ordered_elements(self) -> list[BaseDiagramElement]:
        """
        Return diagram items in their order of definition.

        The sequence can include C4 elements, relationships, boundaries, and
        backend-owned statements that affect declaration-order rendering.
        """
        return self.__ordered_elements

    @property
    def relationships(self) -> list[Relationship]:
        """
        Returns all relationships defined in the diagram.
        """
        return self._relationships

    def get_element_by_alias(self, alias: str) -> Element | None:
        """Return the element with the given alias."""
        return self.__elements_by_alias.get(alias)

    def get_elements_by_label(self, label: str) -> list[Element]:
        """Return all elements that share the given label."""
        return self.__elements_by_label.get(label, [])

    def generate_alias(
        self,
        label: str,
        alias: str | None = None,
        fallback_prefix: str | None = None,
    ) -> str:
        """
        Generate a unique alias.

        Args:
            label: Source label used to derive the alias when `alias` is None.
            alias: Optional explicit alias. If provided, it must be unique.
            fallback_prefix: Prefix to use when the label cannot produce a
                valid alias.

        Returns:
            A unique alias string.

        Raises:
            ValueError: If alias already exists.
        """
        return self.__alias_generator.generate(label, alias, fallback_prefix)

    def add_referenced_element(self, element: Element) -> None:
        """Mark an element as referenced by another diagram object."""
        self.__referenced_elements.append(element.alias)

    def add_ordered_element(
        self, element: BaseDiagramElement
    ) -> BaseDiagramElement:
        """Add a diagram object to the declaration-order sequence."""
        if boundary := get_boundary():
            boundary.add_ordered_element(element)
        else:
            self.__ordered_elements.append(element)

        return element

    def add(self, element: TElement) -> TElement:
        """
        Add an element to the diagram or the currently active boundary.

        Args:
            element: The element to add.

        Returns:
            The added element.
        """
        self._check_alias(element)
        self._check_label(element)

        if boundary := get_boundary():
            boundary.add(element)
        else:
            self._elements.append(element)
            self.__ordered_elements.append(element)

        return element

    def add_boundary(self, boundary: TBoundary) -> TBoundary:
        """
        Add a top-level boundary to the diagram.

        Args:
            boundary: The boundary to add.

        Returns:
            The added boundary.
        """
        self._check_alias(boundary)
        self._check_label(boundary)

        if parent := get_boundary():
            parent.add_boundary(boundary)
        else:
            self._boundaries.append(boundary)
            self.__ordered_elements.append(boundary)

        return boundary

    def add_relationship(self, relationship: TRelationship) -> TRelationship:
        """
        Add a relationship between elements.

        Args:
            relationship: The relationship to add.

        Returns:
            The added relationship.
        """
        from_element, to_element = relationship.get_participants()  # type: ignore[var-annotated]
        self.add_referenced_element(from_element)
        self.add_referenced_element(to_element)

        if boundary := get_boundary():
            boundary.add_relationship(relationship)
        else:
            self._relationships.append(relationship)
            self.__ordered_elements.append(relationship)

        return relationship

    def as_plantuml(self, **kwargs: Any) -> str:
        """
        Render the diagram using the built-in PlantUML renderer.

        Args:
            **kwargs: Optional keyword arguments passed to the
                [PlantUML renderer][c4.renderers.PlantUMLRenderer].

        Returns:
            The rendered PlantUML code.
        """
        renderer = self._build_plantuml_renderer(**kwargs)

        return self.render(renderer)

    def as_mermaid(self, **kwargs: Any) -> str:
        """
        Render the diagram using the built-in Mermaid renderer.

        Args:
            **kwargs: Optional keyword arguments passed to the
                [Mermaid renderer][c4.renderers.MermaidRenderer].

        Returns:
            The rendered Mermaid code.
        """
        renderer = self._build_mermaid_renderer(**kwargs)

        return self.render(renderer)

    def is_element_referenced_by_alias(self, alias: str) -> bool:
        """
        Check whether an element identified by the given alias is referenced.

        An element is considered "referenced" if it participates
        in relationships or layout definitions, and therefore must be
        rendered using its alias.
        """
        return alias in self.__referenced_elements

    def render(self, renderer: BaseRenderer[Diagram] | None = None) -> str:
        """
        Render the diagram to a string using the given or default renderer.

        Args:
            renderer: Optional renderer to override the default.

        Returns:
            The rendered diagram output.

        Raises:
            ValueError: If no renderer is provided and no default
                renderer is set.
        """
        renderer = renderer or self._default_renderer
        if not renderer:
            raise ValueError("No renderer provided and no default_renderer set")

        return renderer.render(self)

    def save(
        self,
        path: str | Path,
        renderer: BaseRenderer[Diagram] | None = None,
    ) -> None:
        """
        Render and save the diagram to a file.

        Args:
            path: Target path to save the rendered output.
            renderer: Optional renderer to override the default.
        """
        path = Path(path)

        path.parent.mkdir(parents=True, exist_ok=True)

        content = self.render(renderer)

        path.write_text(content, encoding="utf-8")

    def save_as_plantuml(self, path: str | Path, **kwargs: Any) -> None:
        """
        Render and save the diagram using the PlantUML renderer.

        Args:
            path: Target file path.
            **kwargs: Optional kwargs passed to the
                [PlantUML renderer][c4.renderers.PlantUMLRenderer].
        """
        renderer = self._build_plantuml_renderer(**kwargs)

        return self.save(path, renderer=renderer)

    def save_as_mermaid(self, path: str | Path, **kwargs: Any) -> None:
        """
        Render and save the diagram using the Mermaid renderer.

        Args:
            path: Target file path.
            **kwargs: Optional kwargs passed to the
                [Mermaid renderer][c4.renderers.MermaidRenderer].
        """
        renderer = self._build_mermaid_renderer(**kwargs)

        return self.save(path, renderer=renderer)

    @property
    def render_options(self) -> RenderOptions | None:
        """Return rendering options for the diagram."""
        return self._render_options

    @render_options.setter
    def render_options(self, render_options: RenderOptions) -> None:
        """Set rendering options for the diagram."""
        self._render_options = render_options

    def set_render_options(
        self,
        *,
        plantuml: Maybe[PlantUMLRenderOptions] = MISSING,
        mermaid: Maybe[MermaidRenderOptions] = MISSING,
    ) -> Self:
        """
        Patch renderer-specific options for this diagram.

        Omitted renderer keys are left unchanged. Passing `None` clears that
        renderer's diagram-level defaults.
        """
        if self._render_options is None:
            from c4.renderers import RenderOptions

            self._render_options = RenderOptions()

        if plantuml is not MISSING:
            self._render_options.plantuml = plantuml

        if mermaid is not MISSING:
            self._render_options.mermaid = mermaid

        return self

    def _build_plantuml_renderer(self, **kwargs: Any) -> PlantUMLRenderer:
        """
        Create and configure a `PlantUMLRenderer` instance.

        If diagram render options are set and include PlantUML-specific
        settings, they are applied as default `render_options` unless
        explicitly provided in `kwargs`.

        Args:
            **kwargs: Additional keyword arguments passed directly to
                `PlantUMLRenderer`.

        Returns:
            A configured `PlantUMLRenderer` instance.
        """
        from c4.renderers import PlantUMLRenderer

        if self._render_options and self._render_options.plantuml:
            kwargs.setdefault("render_options", self._render_options.plantuml)

        return PlantUMLRenderer(**kwargs)

    def _build_mermaid_renderer(self, **kwargs: Any) -> MermaidRenderer:
        """
        Create and configure a `MermaidRenderer` instance.

        If diagram render options are set and include Mermaid-specific
        settings, they are applied as default `render_options` unless
        explicitly provided in `kwargs`.

        Args:
            **kwargs: Additional keyword arguments passed directly to
                `MermaidRenderer`.

        Returns:
            A configured `MermaidRenderer` instance.
        """
        from c4.renderers import MermaidRenderer

        if self._render_options and self._render_options.mermaid:
            kwargs.setdefault("render_options", self._render_options.mermaid)

        return MermaidRenderer(**kwargs)

__init__

__init__(
    title: str | None = None,
    default_renderer: BaseRenderer[Diagram] | None = None,
    render_options: RenderOptions | None = None,
) -> None

Parameters:

Name Type Description Default
title str | None

Optional title to label the diagram.

None
default_renderer BaseRenderer[Diagram] | None

Optional default renderer to use for rendering.

None
render_options RenderOptions | None

Optional renderer-specific options.

None
Source code in c4/diagrams/core/diagram.py
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
def __init__(
    self,
    title: str | None = None,
    default_renderer: BaseRenderer[Diagram] | None = None,
    render_options: RenderOptions | None = None,
) -> None:
    """
    Initialize a new diagram.

    Args:
        title: Optional title to label the diagram.
        default_renderer: Optional default renderer to use for rendering.
        render_options: Optional renderer-specific options.
    """
    self._title = title
    self._default_renderer = default_renderer
    self._elements: list[Element] = []
    self._boundaries: list[Boundary] = []
    self._relationships: list[Relationship] = []
    self._render_options = render_options

    self.__elements_by_alias: dict[str, Element] = {}
    self.__elements_by_label: dict[str, list[Element]] = {}
    self.__alias_generator = AliasGenerator()
    self.__referenced_elements: list[str] = []
    self.__ordered_elements: list[BaseDiagramElement] = []

title property

title: str | None

Returns the title of the diagram.

elements property

elements: list[Element]

Returns a list of top-level elements in the diagram.

boundaries property

boundaries: list[Boundary]

Returns all top-level boundaries in the diagram.

ordered_elements property

ordered_elements: list[BaseDiagramElement]

Return diagram items in their order of definition.

The sequence can include C4 elements, relationships, boundaries, and backend-owned statements that affect declaration-order rendering.

relationships property

relationships: list[Relationship]

Returns all relationships defined in the diagram.

get_element_by_alias

get_element_by_alias(alias: str) -> Element | None

Return the element with the given alias.

Source code in c4/diagrams/core/diagram.py
174
175
176
def get_element_by_alias(self, alias: str) -> Element | None:
    """Return the element with the given alias."""
    return self.__elements_by_alias.get(alias)

get_elements_by_label

get_elements_by_label(label: str) -> list[Element]

Return all elements that share the given label.

Source code in c4/diagrams/core/diagram.py
178
179
180
def get_elements_by_label(self, label: str) -> list[Element]:
    """Return all elements that share the given label."""
    return self.__elements_by_label.get(label, [])

generate_alias

generate_alias(
    label: str,
    alias: str | None = None,
    fallback_prefix: str | None = None,
) -> str

Generate a unique alias.

Parameters:

Name Type Description Default
label str

Source label used to derive the alias when alias is None.

required
alias str | None

Optional explicit alias. If provided, it must be unique.

None
fallback_prefix str | None

Prefix to use when the label cannot produce a valid alias.

None

Returns:

Type Description
str

A unique alias string.

Raises:

Type Description
ValueError

If alias already exists.

Source code in c4/diagrams/core/diagram.py
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
def generate_alias(
    self,
    label: str,
    alias: str | None = None,
    fallback_prefix: str | None = None,
) -> str:
    """
    Generate a unique alias.

    Args:
        label: Source label used to derive the alias when `alias` is None.
        alias: Optional explicit alias. If provided, it must be unique.
        fallback_prefix: Prefix to use when the label cannot produce a
            valid alias.

    Returns:
        A unique alias string.

    Raises:
        ValueError: If alias already exists.
    """
    return self.__alias_generator.generate(label, alias, fallback_prefix)

__enter__

__enter__() -> Self

Enter the diagram context.

Automatically sets this diagram as the current active diagram.

Returns:

Type Description
Self

The current instance.

Source code in c4/diagrams/core/diagram.py
82
83
84
85
86
87
88
89
90
91
92
def __enter__(self) -> Self:
    """
    Enter the diagram context.

    Automatically sets this diagram as the current active diagram.

    Returns:
        The current instance.
    """
    set_diagram(self)
    return self

__exit__

__exit__(
    exc_type: type[BaseException] | None,
    exc_value: BaseException | None,
    traceback: TracebackType | None,
) -> None

Exit the diagram context and clear the current diagram.

Source code in c4/diagrams/core/diagram.py
 94
 95
 96
 97
 98
 99
100
101
102
103
def __exit__(
    self,
    exc_type: type[BaseException] | None,  # type: ignore[valid-type]
    exc_value: BaseException | None,
    traceback: TracebackType | None,
) -> None:
    """
    Exit the diagram context and clear the current diagram.
    """
    set_diagram(None)

as_plantuml

as_plantuml(**kwargs: Any) -> str

Render the diagram using the built-in PlantUML renderer.

Parameters:

Name Type Description Default
**kwargs Any

Optional keyword arguments passed to the PlantUML renderer.

{}

Returns:

Type Description
str

The rendered PlantUML code.

Source code in c4/diagrams/core/diagram.py
284
285
286
287
288
289
290
291
292
293
294
295
296
297
def as_plantuml(self, **kwargs: Any) -> str:
    """
    Render the diagram using the built-in PlantUML renderer.

    Args:
        **kwargs: Optional keyword arguments passed to the
            [PlantUML renderer][c4.renderers.PlantUMLRenderer].

    Returns:
        The rendered PlantUML code.
    """
    renderer = self._build_plantuml_renderer(**kwargs)

    return self.render(renderer)

as_mermaid

as_mermaid(**kwargs: Any) -> str

Render the diagram using the built-in Mermaid renderer.

Parameters:

Name Type Description Default
**kwargs Any

Optional keyword arguments passed to the Mermaid renderer.

{}

Returns:

Type Description
str

The rendered Mermaid code.

Source code in c4/diagrams/core/diagram.py
299
300
301
302
303
304
305
306
307
308
309
310
311
312
def as_mermaid(self, **kwargs: Any) -> str:
    """
    Render the diagram using the built-in Mermaid renderer.

    Args:
        **kwargs: Optional keyword arguments passed to the
            [Mermaid renderer][c4.renderers.MermaidRenderer].

    Returns:
        The rendered Mermaid code.
    """
    renderer = self._build_mermaid_renderer(**kwargs)

    return self.render(renderer)

render

render(
    renderer: BaseRenderer[Diagram] | None = None,
) -> str

Render the diagram to a string using the given or default renderer.

Parameters:

Name Type Description Default
renderer BaseRenderer[Diagram] | None

Optional renderer to override the default.

None

Returns:

Type Description
str

The rendered diagram output.

Raises:

Type Description
ValueError

If no renderer is provided and no default renderer is set.

Source code in c4/diagrams/core/diagram.py
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
def render(self, renderer: BaseRenderer[Diagram] | None = None) -> str:
    """
    Render the diagram to a string using the given or default renderer.

    Args:
        renderer: Optional renderer to override the default.

    Returns:
        The rendered diagram output.

    Raises:
        ValueError: If no renderer is provided and no default
            renderer is set.
    """
    renderer = renderer or self._default_renderer
    if not renderer:
        raise ValueError("No renderer provided and no default_renderer set")

    return renderer.render(self)

save

save(
    path: str | Path,
    renderer: BaseRenderer[Diagram] | None = None,
) -> None

Render and save the diagram to a file.

Parameters:

Name Type Description Default
path str | Path

Target path to save the rendered output.

required
renderer BaseRenderer[Diagram] | None

Optional renderer to override the default.

None
Source code in c4/diagrams/core/diagram.py
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
def save(
    self,
    path: str | Path,
    renderer: BaseRenderer[Diagram] | None = None,
) -> None:
    """
    Render and save the diagram to a file.

    Args:
        path: Target path to save the rendered output.
        renderer: Optional renderer to override the default.
    """
    path = Path(path)

    path.parent.mkdir(parents=True, exist_ok=True)

    content = self.render(renderer)

    path.write_text(content, encoding="utf-8")

save_as_plantuml

save_as_plantuml(path: str | Path, **kwargs: Any) -> None

Render and save the diagram using the PlantUML renderer.

Parameters:

Name Type Description Default
path str | Path

Target file path.

required
**kwargs Any

Optional kwargs passed to the PlantUML renderer.

{}
Source code in c4/diagrams/core/diagram.py
364
365
366
367
368
369
370
371
372
373
374
375
def save_as_plantuml(self, path: str | Path, **kwargs: Any) -> None:
    """
    Render and save the diagram using the PlantUML renderer.

    Args:
        path: Target file path.
        **kwargs: Optional kwargs passed to the
            [PlantUML renderer][c4.renderers.PlantUMLRenderer].
    """
    renderer = self._build_plantuml_renderer(**kwargs)

    return self.save(path, renderer=renderer)

save_as_mermaid

save_as_mermaid(path: str | Path, **kwargs: Any) -> None

Render and save the diagram using the Mermaid renderer.

Parameters:

Name Type Description Default
path str | Path

Target file path.

required
**kwargs Any

Optional kwargs passed to the Mermaid renderer.

{}
Source code in c4/diagrams/core/diagram.py
377
378
379
380
381
382
383
384
385
386
387
388
def save_as_mermaid(self, path: str | Path, **kwargs: Any) -> None:
    """
    Render and save the diagram using the Mermaid renderer.

    Args:
        path: Target file path.
        **kwargs: Optional kwargs passed to the
            [Mermaid renderer][c4.renderers.MermaidRenderer].
    """
    renderer = self._build_mermaid_renderer(**kwargs)

    return self.save(path, renderer=renderer)

render_options property writable

render_options: RenderOptions | None

Return rendering options for the diagram.

set_render_options

set_render_options(
    *,
    plantuml: Maybe[PlantUMLRenderOptions] = MISSING,
    mermaid: Maybe[MermaidRenderOptions] = MISSING,
) -> Self

Patch renderer-specific options for this diagram.

Omitted renderer keys are left unchanged. Passing None clears that renderer's diagram-level defaults.

Source code in c4/diagrams/core/diagram.py
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
def set_render_options(
    self,
    *,
    plantuml: Maybe[PlantUMLRenderOptions] = MISSING,
    mermaid: Maybe[MermaidRenderOptions] = MISSING,
) -> Self:
    """
    Patch renderer-specific options for this diagram.

    Omitted renderer keys are left unchanged. Passing `None` clears that
    renderer's diagram-level defaults.
    """
    if self._render_options is None:
        from c4.renderers import RenderOptions

        self._render_options = RenderOptions()

    if plantuml is not MISSING:
        self._render_options.plantuml = plantuml

    if mermaid is not MISSING:
        self._render_options.mermaid = mermaid

    return self