drawlib.diagrams.class_diagram（UML クラス図）

3 区画（ヘッダー・属性・メソッド）のクラス／インターフェースカード、可視性記号（+、-、#、~）、および標準 UML 2.0 関連マーカーを備えたオブジェクト指向クラス図モジュールです。標準インポート: from drawlib.diagrams.class_diagram import ClassDiagram, ClassNode, ClassRelationship。

from drawlib.canvas import save, setup
from drawlib.diagrams.class_diagram import ClassDiagram, ClassNode
from drawlib.fonts import FontRoboto, FontSourceCode
from drawlib.styles import Colors, Styles

setup(width=120, height=64)

cd = ClassDiagram(
    node_style=Styles.Neutral.patch(text_font=FontSourceCode.ROBOTO_MONO, text_size=10.0),
    header_style=Styles.PrimaryNeutral.patch(
        text_font=FontRoboto.ROBOTO_BOLD, text_size=11.0, shape_line_color=Styles.Neutral.shape_line_color
    ),
    edge_style=Styles.DarkBold,
    edge_text_style=Styles.Dark.patch(text_size=10.0),
    margin=4.0,
)

repo_iface = cd.add(
    ClassNode(
        "Repository",
        stereotype="interface",
        width=40,
        row_height=3.8,
        header_style=Styles.PrimaryFlat.patch(
            text_color=Colors.White, text_font=FontRoboto.ROBOTO_BOLD, text_size=11.0
        ),
    ).add_method("save", "order: Order", "None"),
    xy=(25.0, 49.0),
)

sql_repo = cd.add(
    ClassNode("SqlRepository", width=40, row_height=3.8)
    .add_attribute("dsn", "str", visibility="-")
    .add_method("save", "order: Order", "None"),
    xy=(25.0, 17.0),
)

order = cd.add(
    ClassNode(
        "Order",
        width=40,
        row_height=3.8,
        header_style=Styles.SecondaryNeutral.patch(
            text_font=FontRoboto.ROBOTO_BOLD, text_size=11.0, shape_line_color=Styles.Neutral.shape_line_color
        ),
    )
    .add_attribute("id", "UUID", visibility="+")
    .add_method("total", "", "Decimal"),
    xy=(95.0, 49.0),
)

item = cd.add(
    ClassNode("OrderItem", width=40, row_height=3.8)
    .add_attribute("sku", "str", visibility="+")
    .add_attribute("qty", "int", default_value="1", visibility="+"),
    xy=(95.0, 17.0),
)

cd.connect(sql_repo, repo_iface, "realization", start_side="top", end_side="bottom")
cd.connect(repo_iface, order, "dependency", label="«persists»", start_side="right", end_side="left")
cd.connect(
    order,
    item,
    "composition",
    start_multiplicity="1",
    end_multiplicity="1..*",
    directed=True,
    start_side="bottom",
    end_side="top",
)

cd.draw(xy=(60.0, 32.0), align="center")
save()

classAttributeInfo#

ClassNode の属性区画（中段）内の 1 フィールド行を表すバリデーション付き Pydantic データモデルです。通常は node.add_attribute(...) または node.add_attributes([...]) から生成します。

AttributeInfo(
    *,
    name: str,
    type: str = "",
    is_public: bool = True,
    visibility: str | None = None,
    default_value: str = "",
    is_static: bool = False,
) -> None

• 座標アンカー: ClassNode の中段コンパートメント内に左揃えの行として順番に描画されます。

コンストラクタ引数・フィールド#

パブリックメソッド・プロパティ#

(このほか pydantic.BaseModel 標準の互換メンバー model_extra、model_fields_set、model_parametrized_name、model_post_init、model_rebuild、construct、copy、dict、from_orm、json、parse_file、parse_obj、parse_raw、schema、schema_json、update_forward_refs、validate を継承します。)

classClassDiagram#

ClassNode カード、ClassRelationship コネクタ、および全体のバウンディングボックス配置を統合管理する UML 2.0 クラス図のトップレベルコンテナです。

ClassDiagram(
    *,
    node_style: Style,
    edge_style: Style,
    edge_text_style: Style,
    title: str = "",
    title_style: Style | None = None,
    style: Style | None = None,
    width: float | None = None,
    height: float | None = None,
    margin: float = 5.0,
    header_style: Style | None = None,
) -> None

• 座標アンカー: draw(xy=(0.0, 0.0), align="bottom_left") はローカル座標を xy 分シフトして描画します（align="center" の場合は全クラスの包含境界中心を xy に配置）。

コンストラクタ引数#

パブリックメソッド・プロパティ#

classClassNode#

具象クラス、抽象クラス、インターフェース、列挙型、データクラスを表す UML 2.0 の 3 区画カード要素です。

ClassNode(
    name: str,
    stereotype: str = "",
    is_abstract: bool = False,
    width: float = 28.0,
    height: float | None = None,
    header_height: float | None = None,
    row_height: float = 3.2,
    style: Style | None = None,
    header_style: Style | None = None,
    show: bool = True,
) -> None

• 座標アンカー: cd.add(node, xy=(cx, cy)) で登録する際の中心座標 (cx, cy)。Styles.PrimaryFlat 等の濃いヘッダー背景を使用する場合は、header_style=Styles.PrimaryFlat.patch(text_color=Colors.White, text_size=11.0) で白文字を指定してください。

コンストラクタ引数#

パブリックメソッド・プロパティ#

classClassRelationship#

白抜き三角形、黒塗り／白抜きひし形、開いた矢印、多重度、およびロール名を用いて 2 つの ClassNode を結ぶ UML 2.0 関連エッジです。

ClassRelationship(
    start: ClassNode,
    end: ClassNode,
    relationship_type: RelationshipType = "association",
    start_side: Side = "auto",
    end_side: Side = "auto",
    label: str = "",
    start_multiplicity: str = "",
    end_multiplicity: str = "",
    start_role: str = "",
    end_role: str = "",
    directed: bool = False,
    style: Style | None = None,
    text_style: Style | None = None,
    routing: RoutingType = "orthogonal",
    padding: PaddingType = 0.0,
    show: bool = True,
) -> None

• 座標アンカー: start の start_side 境界ポートから end の end_side 境界ポートへ接続されます。cd.connect(...) または cd.add_relationship(rel) で登録します。

コンストラクタ引数・属性#

classMethodInfo#

ClassNode のメソッド区画（下段）内の 1 操作行を表すバリデーション付き Pydantic データモデルです。通常は node.add_method(...) または node.add_methods([...]) から生成します。

MethodInfo(
    *,
    name: str,
    params: str = "",
    return_type: str = "",
    is_public: bool = True,
    visibility: str | None = None,
    is_static: bool = False,
    is_abstract: bool = False,
) -> None

• 座標アンカー: ClassNode の下段コンパートメント内に左揃えの行として順番に描画されます。

コンストラクタ引数・フィールド#

パブリックメソッド・プロパティ#

(このほか pydantic.BaseModel 標準の互換メンバー model_extra、model_fields_set、model_parametrized_name、model_post_init、model_rebuild、construct、copy、dict、from_orm、json、parse_file、parse_obj、parse_raw、schema、schema_json、update_forward_refs、validate を継承します。)

typeRelationshipType#

ClassDiagram.connect() および ClassRelationship で指定可能な UML 2.0 標準の 6 種類のクラス間関連（および短縮エイリアス）を表す Literal 型です。

RelationshipType = Literal[
    "inheritance",
    "realization",
    "composition",
    "aggregation",
    "association",
    "dependency",
    "inherit",
    "realize",
    "composite",
    "aggregate",
    "associate",
    "depend",
]

• 座標アンカー: start 側（ひし形マーカー）および end 側（白抜き三角形・開いた矢印）のマーカー形状を決定します。

typeRoutingType#

ClassRelationship コネクタの経路計算方式を指定する Literal 型です。

RoutingType = Literal["orthogonal", "direct"]

• 座標アンカー: 解決された start と end のクラス境界ポート間のルーティングを制御します。

typeSide#

ClassNode ボックス上の接続辺を指定する Literal 型です。

Side = Literal["left", "right", "top", "bottom", "auto"]

• 座標アンカー: "left"、"right"、"top"、"bottom" は各辺の中点に接続し、"auto" は対向する最近傍の辺を自動選択します。