pflag.FlagSet Accessors, Annotations & Relational Flag Groups

from drawlib.canvas import save, setup
from drawlib.icons import phosphor
from drawlib.smartarts import CardList, Panel
from drawlib.styles import Colors, Styles

setup(width=188, height=78)

_ = Colors

col_specs = [
    (
        4.0,
        "1. FlagSet Hierarchy",
        Styles.PrimaryNeutral,
        Styles.PrimaryFlat,
        Styles.WhiteBold.patch(text_size=11.0),
        phosphor.sliders_horizontal,
        Styles.WhiteBold,
        [
            ("Flags() & PersistentFlags()", "Local + inherited pflag sets", phosphor.flag, True),
            ("LocalFlags / InheritedFlags", "Scoped views for help & docs", phosphor.git_merge, False),
            ("ParseFlags & Flag(name)", "Merge parent pflags & parse", phosphor.magnifying_glass, False),
        ],
    ),
    (
        65.5,
        "2. Relational Flag Groups",
        Styles.Neutral,
        Styles.SecondaryNeutral,
        Styles.DarkBold.patch(text_size=11.0),
        phosphor.intersect,
        Styles.PrimaryBold,
        [
            ("MarkFlagsRequiredTogether", "All-or-nothing flag co-presence", phosphor.link, False),
            ("MarkFlagsOneRequired", "At least 1 flag in group set", phosphor.check_square, False),
            ("MarkFlagsMutuallyExclusive", "At most 1 flag in group set", phosphor.prohibit, False),
        ],
    ),
    (
        127.0,
        "3. Flag Annotations",
        Styles.Neutral,
        Styles.SecondaryNeutral,
        Styles.DarkBold.patch(text_size=11.0),
        phosphor.tag,
        Styles.PrimaryBold,
        [
            ("MarkFlagRequired", "Mandatory single flag check", phosphor.asterisk, False),
            ("MarkFlagFilename / Dirname", "Shell file & dir completion", phosphor.folder_open, False),
            ("SetGlobalNormalizationFunc", "Tree-wide flag name canonical", phosphor.arrows_left_right, False),
        ],
    ),
]

for x0, title, body_style, hdr_style, hdr_text_style, hdr_icon, hdr_icon_style, items in col_specs:
    panel = Panel(
        title,
        "",
        style=body_style,
        header_style=hdr_style,
        text_style=hdr_text_style,
        icon=hdr_icon,
        icon_style=hdr_icon_style,
        header_variant="filled",
        header_height=8.5,
    )
    panel.draw((x0, 4.0), width=57.0, height=70.0, align="bottom_left")
    inner_xy, inner_w, inner_h = panel.get_content_box(
        (x0, 4.0),
        width=57.0,
        height=70.0,
        padding=(2.8, 2.8),
        align="bottom_left",
    )

    cards = CardList(
        style=Styles.White,
        text_style=Styles.DarkBold.patch(text_size=10.5),
        description_style=Styles.Muted.patch(text_size=10.0),
        badge_shape="rounded_rect",
        badge_style=Styles.PrimaryNeutral,
        icon_style=Styles.PrimaryBold,
        direction="vertical",
        spacing=2.6,
    )
    for mod_name, mod_desc, mod_icon, is_focal in items:
        if is_focal:
            cards.add(
                mod_name,
                mod_desc,
                icon=mod_icon,
                badge_style=Styles.PrimaryFlat,
                icon_style=Styles.WhiteBold,
            )
        else:
            cards.add(mod_name, mod_desc, icon=mod_icon)
    cards.draw(inner_xy, width=inner_w, height=inner_h, align="bottom_left")

save()

from drawlib.canvas import save, setup
from drawlib.diagrams.architecture import ArchitectureDiagram, Node, NodeGroup, PhosphorIcon
from drawlib.styles import Colors, Styles

setup(width=184, height=84)

_ = Colors

d = ArchitectureDiagram(
    node_style=Styles.PrimaryBold,
    node_text_style=Styles.DarkBold.patch(text_size=10.0),
    edge_style=Styles.DarkBold.patch(line_width=1.5),
    edge_text_style=Styles.Dark.patch(text_size=9.8),
    node_card_style=Styles.White,
)

decl_grp = d.add(
    NodeGroup(
        "1. Group Constraint Registration",
        width=62,
        height=74,
        style=Styles.PrimaryNeutral.patch(shape_r=2.0),
        text_style=Styles.DarkBold.patch(text_size=10.8, halign="left", valign="top"),
    ),
    xy=(4.0, 5.0),
)

req_tog = decl_grp.add(
    Node(
        "MarkFlagsRequiredTogether\nAll flags if any 1 is set",
        icon=PhosphorIcon.LINK,
        icon_size=5.8,
        width=52,
        height=16,
        card_style=Styles.White.patch(shape_r=2.0),
    ),
    xy=(31.0, 54.0),
)

one_req = decl_grp.add(
    Node(
        "MarkFlagsOneRequired\nAt least 1 flag in group",
        icon=PhosphorIcon.CHECK_SQUARE,
        icon_size=5.8,
        width=52,
        height=16,
        card_style=Styles.White.patch(shape_r=2.0),
    ),
    xy=(31.0, 34.0),
)

mut_excl = decl_grp.add(
    Node(
        "MarkFlagsMutuallyExclusive\nAt most 1 flag in group",
        icon=PhosphorIcon.PROHIBIT,
        icon_size=5.8,
        width=52,
        height=16,
        card_style=Styles.White.patch(shape_r=2.0),
    ),
    xy=(31.0, 14.0),
)

exec_grp = d.add(
    NodeGroup(
        "2. Runtime & Completion Enforcement",
        width=110,
        height=74,
        style=Styles.Neutral.patch(shape_r=2.0),
        text_style=Styles.DarkBold.patch(text_size=10.8, halign="left", valign="top"),
    ),
    xy=(70.0, 5.0),
)

annot_node = exec_grp.add(
    Node(
        "pflag.Flag.Annotations\ncobra_annotation_* keys",
        icon=PhosphorIcon.TAG,
        icon_size=6.2,
        width=46,
        height=20,
        style=Styles.White,
        text_style=Styles.WhiteBold.patch(text_size=10.2),
        card_style=Styles.PrimaryFlat.patch(shape_r=2.0),
    ),
    xy=(27.0, 34.0),
)

val_node = exec_grp.add(
    Node(
        "ValidateFlagGroups()\nRuns in execute() after PreRun\nDeterministic sorted errors",
        icon=PhosphorIcon.SHIELD_CHECK,
        icon_size=6.0,
        width=48,
        height=22,
        card_style=Styles.White.patch(shape_r=2.0),
    ),
    xy=(82.0, 50.0),
)

comp_node = exec_grp.add(
    Node(
        "enforceFlagGroupsForCompletion\nAuto-marks required or hides\nmutually exclusive siblings",
        icon=PhosphorIcon.SPARKLE,
        icon_size=6.0,
        width=48,
        height=22,
        card_style=Styles.SecondaryNeutral.patch(shape_r=2.0),
    ),
    xy=(82.0, 18.0),
)

d.connect(req_tog, annot_node)
d.connect(one_req, annot_node)
d.connect(mut_excl, annot_node)
d.connect(annot_node, val_node)
d.connect(annot_node, comp_node)

d.draw((0.0, 0.0))
save()