跳转至

builder

feishu.cards.builder

ColumnSet

卡片 2.0 分栏（column_set）元素的子构造器。

通过链式调用 .column(...) 逐列添加内容，再用 feishu.cards.builder.ColumnSet.to_dict 生成元素字典；若绑定了父级 feishu.cards.builder.Card，可用 feishu.cards.builder.ColumnSet.end 将其追加回父卡片。

飞书文档

多列布局组件

示例：

Python Console Session
1
2
3
4
5
6
>>> cs = ColumnSet(flex_mode="stretch").column({"tag": "markdown", "content": "a"}, weight=1)
>>> d = cs.to_dict()
>>> d["tag"], d["flex_mode"]
('column_set', 'stretch')
>>> d["columns"][0]
{'tag': 'column', 'width': 'auto', 'elements': [{'tag': 'markdown', 'content': 'a'}], 'weight': 1}
源代码位于： feishu/cards/builder.py
Python
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
class ColumnSet:
    r"""
    卡片 2.0 分栏（column_set）元素的子构造器。

    通过链式调用 `.column(...)` 逐列添加内容，再用 [feishu.cards.builder.ColumnSet.to_dict][]
    生成元素字典；若绑定了父级 [feishu.cards.builder.Card][]，可用
    [feishu.cards.builder.ColumnSet.end][] 将其追加回父卡片。

    飞书文档:
        [多列布局组件](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-v2-components/containers/column-set)

    Examples:
        >>> cs = ColumnSet(flex_mode="stretch").column({"tag": "markdown", "content": "a"}, weight=1)
        >>> d = cs.to_dict()
        >>> d["tag"], d["flex_mode"]
        ('column_set', 'stretch')
        >>> d["columns"][0]
        {'tag': 'column', 'width': 'auto', 'elements': [{'tag': 'markdown', 'content': 'a'}], 'weight': 1}
    """

    def __init__(
        self,
        *,
        flex_mode: str = "none",
        horizontal_spacing: str | int | None = None,
        parent: Card | None = None,
        **opts: Any,
    ):
        self._flex_mode = flex_mode
        self._horizontal_spacing = horizontal_spacing
        self._parent = parent
        self._opts = opts
        self._columns: list[dict[str, Any]] = []

    def column(
        self,
        *els: dict[str, Any],
        width: str = "auto",
        weight: int | None = None,
        vertical_align: str | None = None,
        **opts: Any,
    ) -> ColumnSet:
        r"""
        追加一列，列内含给定的元素及配置，并返回自身以便链式调用。

        Args:
            *els: 该列内的元素字典。
            width: 列宽，如 `auto`、`weighted`。
            weight: 当 `width="weighted"` 时该列所占权重。
            vertical_align: 列内元素的垂直对齐方式，如 `top`、`center`、`bottom`。
            **opts: 其余原样透传给该列字典的字段。

        Returns:
            当前 [feishu.cards.builder.ColumnSet][] 实例。

        Examples:
            >>> cs = ColumnSet().column({"tag": "markdown", "content": "x"}, width="weighted", weight=2)
            >>> cs.to_dict()["columns"][0]["weight"]
            2
        """
        col: dict[str, Any] = {"tag": "column", "width": width, "elements": list(els)}
        if weight is not None:
            col["weight"] = weight
        if vertical_align is not None:
            col["vertical_align"] = vertical_align
        col.update(opts)
        self._columns.append(col)
        return self

    def to_dict(self) -> dict[str, Any]:
        r"""
        生成分栏元素字典，委托给 [feishu.cards.elements.column_set][] 实现。

        Returns:
            分栏（column_set）元素的字典表示。

        Examples:
            >>> ColumnSet(flex_mode="stretch").to_dict()
            {'tag': 'column_set', 'flex_mode': 'stretch', 'columns': []}
        """
        return elements.column_set(
            self._columns,
            flex_mode=self._flex_mode,
            horizontal_spacing=self._horizontal_spacing,
            **self._opts,
        )

    def end(self) -> Card:
        r"""
        将本分栏追加到绑定的父级 [feishu.cards.builder.Card][]，并返回该父卡片。

        Returns:
            绑定的父级 [feishu.cards.builder.Card][] 实例。

        Raises:
            ValueError: 当本 `ColumnSet` 未绑定父卡片（独立构造）时抛出。

        Examples:
            >>> card = Card()
            >>> card.column_set().column({"tag": "markdown", "content": "a"}).end() is card
            True
        """
        if self._parent is None:
            raise ValueError("ColumnSet.end() requires a parent Card; use Card.column_set()")
        self._parent.add(self.to_dict())
        return self._parent

column

Python
column(*els: dict[str, Any], width: str = 'auto', weight: int | None = None, vertical_align: str | None = None, **opts: Any) -> ColumnSet

追加一列，列内含给定的元素及配置，并返回自身以便链式调用。

参数：

名称 类型 描述 默认
*els
dict[str, Any]

该列内的元素字典。

 ()
width
str

列宽，如 auto、weighted。

 'auto'
weight
int | None

当 width="weighted" 时该列所占权重。

 None
vertical_align
str | None

列内元素的垂直对齐方式，如 top、center、bottom。

 None
**opts
Any

其余原样透传给该列字典的字段。

 {}

返回：

类型 描述
ColumnSet

当前 feishu.cards.builder.ColumnSet 实例。

示例：

Python Console Session
1
2
3
>>> cs = ColumnSet().column({"tag": "markdown", "content": "x"}, width="weighted", weight=2)
>>> cs.to_dict()["columns"][0]["weight"]
2
源代码位于： feishu/cards/builder.py
Python
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
def column(
    self,
    *els: dict[str, Any],
    width: str = "auto",
    weight: int | None = None,
    vertical_align: str | None = None,
    **opts: Any,
) -> ColumnSet:
    r"""
    追加一列，列内含给定的元素及配置，并返回自身以便链式调用。

    Args:
        *els: 该列内的元素字典。
        width: 列宽，如 `auto`、`weighted`。
        weight: 当 `width="weighted"` 时该列所占权重。
        vertical_align: 列内元素的垂直对齐方式，如 `top`、`center`、`bottom`。
        **opts: 其余原样透传给该列字典的字段。

    Returns:
        当前 [feishu.cards.builder.ColumnSet][] 实例。

    Examples:
        >>> cs = ColumnSet().column({"tag": "markdown", "content": "x"}, width="weighted", weight=2)
        >>> cs.to_dict()["columns"][0]["weight"]
        2
    """
    col: dict[str, Any] = {"tag": "column", "width": width, "elements": list(els)}
    if weight is not None:
        col["weight"] = weight
    if vertical_align is not None:
        col["vertical_align"] = vertical_align
    col.update(opts)
    self._columns.append(col)
    return self

to_dict

Python
to_dict() -> dict[str, Any]

生成分栏元素字典，委托给 feishu.cards.elements.column_set 实现。

返回：

类型 描述
dict[str, Any]

分栏（column_set）元素的字典表示。

示例：

Python Console Session
1
2
>>> ColumnSet(flex_mode="stretch").to_dict()
{'tag': 'column_set', 'flex_mode': 'stretch', 'columns': []}
源代码位于： feishu/cards/builder.py
Python
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
def to_dict(self) -> dict[str, Any]:
    r"""
    生成分栏元素字典，委托给 [feishu.cards.elements.column_set][] 实现。

    Returns:
        分栏（column_set）元素的字典表示。

    Examples:
        >>> ColumnSet(flex_mode="stretch").to_dict()
        {'tag': 'column_set', 'flex_mode': 'stretch', 'columns': []}
    """
    return elements.column_set(
        self._columns,
        flex_mode=self._flex_mode,
        horizontal_spacing=self._horizontal_spacing,
        **self._opts,
    )

end

Python
end() -> Card

将本分栏追加到绑定的父级 feishu.cards.builder.Card，并返回该父卡片。

返回：

类型 描述
Card

绑定的父级 feishu.cards.builder.Card 实例。

引发：

类型 描述
ValueError

当本 ColumnSet 未绑定父卡片（独立构造）时抛出。

示例：

Python Console Session
1
2
3
>>> card = Card()
>>> card.column_set().column({"tag": "markdown", "content": "a"}).end() is card
True
源代码位于： feishu/cards/builder.py
Python
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
def end(self) -> Card:
    r"""
    将本分栏追加到绑定的父级 [feishu.cards.builder.Card][]，并返回该父卡片。

    Returns:
        绑定的父级 [feishu.cards.builder.Card][] 实例。

    Raises:
        ValueError: 当本 `ColumnSet` 未绑定父卡片（独立构造）时抛出。

    Examples:
        >>> card = Card()
        >>> card.column_set().column({"tag": "markdown", "content": "a"}).end() is card
        True
    """
    if self._parent is None:
        raise ValueError("ColumnSet.end() requires a parent Card; use Card.column_set()")
    self._parent.add(self.to_dict())
    return self._parent

Card

飞书卡片 JSON 2.0 的链式构造器。

链式调用各方法逐步拼装卡片，再用 feishu.cards.builder.Card.to_dict 或其别名 build 生成最终的 {"schema": "2.0", ...} 字典。未设置过 config 与 header 时， 它们不会出现在输出中。

飞书文档

卡片 JSON 2.0 结构

示例：

Python Console Session
1
2
3
4
5
6
7
>>> d = Card().header("Report", template="blue").markdown("**hi**").to_dict()
>>> d["schema"], d["header"]["template"]
('2.0', 'blue')
>>> d["body"]["elements"]
[{'tag': 'markdown', 'content': '**hi**'}]
>>> Card().to_dict()
{'schema': '2.0', 'body': {'elements': []}}
源代码位于： feishu/cards/builder.py
Python
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
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
class Card:
    r"""
    飞书卡片 JSON 2.0 的链式构造器。

    链式调用各方法逐步拼装卡片，再用 [feishu.cards.builder.Card.to_dict][] 或其别名
    `build` 生成最终的 `{"schema": "2.0", ...}` 字典。未设置过 `config` 与 `header` 时，
    它们不会出现在输出中。

    飞书文档:
        [卡片 JSON 2.0 结构](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-v2-structure)

    Examples:
        >>> d = Card().header("Report", template="blue").markdown("**hi**").to_dict()
        >>> d["schema"], d["header"]["template"]
        ('2.0', 'blue')
        >>> d["body"]["elements"]
        [{'tag': 'markdown', 'content': '**hi**'}]
        >>> Card().to_dict()
        {'schema': '2.0', 'body': {'elements': []}}
    """

    def __init__(self) -> None:
        self._header: dict[str, Any] | None = None
        self._config: dict[str, Any] = {}
        self._elements: list[dict[str, Any]] = []

    # ------------------------------------------------------------------
    # Header / config
    # ------------------------------------------------------------------

    def header(
        self,
        title: str,
        *,
        subtitle: str | None = None,
        template: str = "blue",
        icon: dict[str, Any] | None = None,
        tags: list[dict[str, Any]] | None = None,
    ) -> Card:
        r"""
        设置卡片标题栏，并返回自身以便链式调用。

        Args:
            title: 标题文案。
            subtitle: 副标题文案。
            template: 标题栏颜色主题，会经 [feishu.cards.validation.validate_template][] 校验。
            icon: 标题栏图标配置。
            tags: 标题栏右侧的文本标签列表（对应 `text_tag_list`）。

        Returns:
            当前 [feishu.cards.builder.Card][] 实例。

        飞书文档:
            [标题组件](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-v2-components/containers/title)

        Examples:
            >>> hdr = Card().header("Title", subtitle="sub", template="green").to_dict()["header"]
            >>> hdr["title"], hdr["template"]
            ({'tag': 'plain_text', 'content': 'Title'}, 'green')
            >>> hdr["subtitle"]
            {'tag': 'plain_text', 'content': 'sub'}
        """
        hdr: dict[str, Any] = {
            "title": elements._plain_text(title),
            "template": validate_template(template),
        }
        if subtitle is not None:
            hdr["subtitle"] = elements._plain_text(subtitle)
        if icon is not None:
            hdr["icon"] = icon
        if tags is not None:
            hdr["text_tag_list"] = tags
        self._header = hdr
        return self

    def config(self, **opts: Any) -> Card:
        r"""
        将关键字参数合并进卡片的全局配置（如 `streaming_mode`、`width_mode` 等），并返回自身。

        Args:
            **opts: 待合并进卡片 `config` 的配置项。

        Returns:
            当前 [feishu.cards.builder.Card][] 实例。

        飞书文档:
            [卡片全局配置](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-v2-structure)

        Examples:
            >>> Card().config(width_mode="fill").to_dict()["config"]
            {'width_mode': 'fill'}
        """
        self._config.update(opts)
        return self

    # ------------------------------------------------------------------
    # Element appenders — all delegate to elements.* (Task 3)
    # ------------------------------------------------------------------

    def markdown(
        self,
        content: str,
        *,
        text_align: str | None = None,
        text_size: str | None = None,
        escape: bool = False,
        element_id: str | None = None,
    ) -> Card:
        r"""
        追加一个 markdown 元素（委托给 [feishu.cards.elements.md][]），并返回自身。

        Args:
            content: markdown 文本内容。
            text_align: 文本对齐方式，如 `left`、`center`、`right`。
            text_size: 文本字号，如 `normal`、`heading`。
            escape: 是否先对 `content` 转义控制字符。
            element_id: 元素的自定义 ID，会经 [feishu.cards.validation.validate_element_id][] 校验。

        Returns:
            当前 [feishu.cards.builder.Card][] 实例。

        Examples:
            >>> Card().markdown("**bold**", text_align="center").to_dict()["body"]["elements"][0]
            {'tag': 'markdown', 'content': '**bold**', 'text_align': 'center'}
        """
        self._elements.append(
            elements.md(
                content,
                text_align=text_align,
                text_size=text_size,
                escape=escape,
                element_id=element_id,
            )
        )
        return self

    def text(self, content: str) -> Card:
        r"""
        追加纯文本（不转义）的便捷方法，等价于 [feishu.cards.builder.Card.markdown][]。

        Args:
            content: 文本内容。

        Returns:
            当前 [feishu.cards.builder.Card][] 实例。

        Examples:
            >>> Card().text("plain").to_dict()["body"]["elements"][0]
            {'tag': 'markdown', 'content': 'plain'}
        """
        return self.markdown(content)

    def divider(self) -> Card:
        r"""
        追加一条分割线元素（委托给 [feishu.cards.elements.hr][]），并返回自身。

        Returns:
            当前 [feishu.cards.builder.Card][] 实例。

        Examples:
            >>> Card().divider().to_dict()["body"]["elements"][0]
            {'tag': 'hr'}
        """
        self._elements.append(elements.hr())
        return self

    def image(self, img_key: str, alt: str, **opts: Any) -> Card:
        r"""
        追加一个图片元素（委托给 [feishu.cards.elements.img][]），并返回自身。

        Args:
            img_key: 图片的 key，通过上传图片接口获取。
            alt: 图片的悬浮提示文案（无障碍替代文本）。
            **opts: 其余原样透传给图片元素的字段，如 `scale_type`、`element_id` 等。

        Returns:
            当前 [feishu.cards.builder.Card][] 实例。

        Examples:
            >>> Card().image("img_1", "alt").to_dict()["body"]["elements"][0]["tag"]
            'img'
        """
        self._elements.append(elements.img(img_key, alt, **opts))
        return self

    def button(
        self,
        text: str,
        *,
        value: dict[str, Any] | None = None,
        url: str | None = None,
        type: str = "default",  # noqa: A002 - matches Feishu field name
        confirm: dict[str, Any] | None = None,
        icon: dict[str, Any] | None = None,
        element_id: str | None = None,
    ) -> Card:
        r"""
        追加一个按钮元素（委托给 [feishu.cards.elements.button][]），并返回自身。

        Args:
            text: 按钮文案。
            value: 点击回调时回传的业务数据，生成 `callback` 行为。
            url: 点击时跳转的链接，生成 `open_url` 行为。
            type: 按钮样式类型，如 `default`、`primary`、`danger`。
            confirm: 点击前的二次确认弹窗配置。
            icon: 按钮图标配置。
            element_id: 元素的自定义 ID，会经 [feishu.cards.validation.validate_element_id][] 校验。

        Returns:
            当前 [feishu.cards.builder.Card][] 实例。

        Examples:
            >>> Card().button("Go", value={"x": 1}).to_dict()["body"]["elements"][0]["behaviors"]
            [{'type': 'callback', 'value': {'x': 1}}]
        """
        self._elements.append(
            elements.button(
                text,
                value=value,
                url=url,
                type=type,
                confirm=confirm,
                icon=icon,
                element_id=element_id,
            )
        )
        return self

    def columns(
        self,
        *cols: ColumnSet | dict[str, Any],
        flex_mode: str = "none",
        horizontal_spacing: str | int | None = None,
        **opts: Any,
    ) -> Card:
        r"""
        追加一个分栏（column_set）元素，并返回自身。

        当仅传入单个 [feishu.cards.builder.ColumnSet][] 时，直接调用其
        [feishu.cards.builder.ColumnSet.to_dict][] 追加；此时以该 `ColumnSet` 自身的
        `flex_mode`/间距为准，调用方传入的关键字参数不会生效（此优先级为有意设计）。

        否则（零个、两个及以上参数，或单个非 `ColumnSet` 参数），每个参数都必须是原始的
        列字典（`{"tag": "column", ...}`）。它们会被包裹进经 [feishu.cards.elements.column_set][]
        构造的同一个分栏中，此时调用方的 `flex_mode`、`horizontal_spacing` 及额外的 `**opts`
        均会生效。在该路径上传入 `ColumnSet` 实例会抛出 `TypeError`，以避免静默生成结构错误的嵌套分栏。

        Args:
            *cols: 单个 [feishu.cards.builder.ColumnSet][]，或一组原始列字典。
            flex_mode: 列在窄屏下的自适应方式（仅在原始列字典路径生效）。
            horizontal_spacing: 列间水平间距（仅在原始列字典路径生效）。
            **opts: 其余原样透传给分栏字典的字段（仅在原始列字典路径生效）。

        Returns:
            当前 [feishu.cards.builder.Card][] 实例。

        Raises:
            TypeError: 在原始列字典路径上传入了 [feishu.cards.builder.ColumnSet][] 实例时抛出。

        飞书文档:
            [多列布局组件](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-v2-components/containers/column-set)

        Examples:
            >>> col = {"tag": "column", "width": "auto", "elements": []}
            >>> Card().columns(col, col, flex_mode="stretch").to_dict()["body"]["elements"][0]["flex_mode"]
            'stretch'
        """
        if len(cols) == 1 and isinstance(cols[0], ColumnSet):
            self._elements.append(cols[0].to_dict())
            return self
        for c in cols:
            if isinstance(c, ColumnSet):
                raise TypeError(
                    "columns() accepts a single ColumnSet, or raw column dicts; "
                    "to add multiple column_sets, call .columns()/.column_set() once per column_set"
                )
        self._elements.append(
            elements.column_set(
                cast(list[dict[str, Any]], list(cols)),
                flex_mode=flex_mode,
                horizontal_spacing=horizontal_spacing,
                **opts,
            )
        )
        return self

    def column_set(self) -> ColumnSet:
        r"""
        返回一个绑定到本卡片的全新 [feishu.cards.builder.ColumnSet][] 子构造器。

        在返回对象上链式调用 [feishu.cards.builder.ColumnSet.column][] 逐列添加内容，
        再调用 [feishu.cards.builder.ColumnSet.end][] 将分栏追加回本卡片并取回本卡片。

        Returns:
            绑定到本卡片的 [feishu.cards.builder.ColumnSet][] 实例。

        Examples:
            >>> card = Card()
            >>> card.column_set().column({"tag": "markdown", "content": "a"}).end() is card
            True
            >>> card.to_dict()["body"]["elements"][0]["tag"]
            'column_set'
        """
        return ColumnSet(parent=self)

    def add(self, raw: dict[str, Any]) -> Card:
        r"""
        逃生通道：原样追加任意元素字典，并返回自身。

        Args:
            raw: 待追加的原始元素字典。

        Returns:
            当前 [feishu.cards.builder.Card][] 实例。

        Examples:
            >>> Card().add({"tag": "custom_thing", "k": 1}).to_dict()["body"]["elements"]
            [{'tag': 'custom_thing', 'k': 1}]
        """
        self._elements.append(raw)
        return self

    # ------------------------------------------------------------------
    # Serialisation
    # ------------------------------------------------------------------

    def to_dict(self) -> dict[str, Any]:
        r"""
        生成卡片 2.0 的骨架字典。

        包含的键：

        - `"schema": "2.0"`：始终存在。
        - `"config": {...}`：仅在至少设置过一项配置时出现。
        - `"header": {...}`：仅在调用过 [feishu.cards.builder.Card.header][] 时出现。
        - `"body": {"elements": [...]}`：始终存在（元素列表可能为空）。

        别名 `build` 与本方法等价。

        Returns:
            卡片 2.0 的字典表示。

        飞书文档:
            [卡片 JSON 2.0 结构](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-v2-structure)

        Examples:
            >>> Card().to_dict()
            {'schema': '2.0', 'body': {'elements': []}}
            >>> c = Card().text("hi")
            >>> c.build() == c.to_dict()
            True
        """
        out: dict[str, Any] = {"schema": "2.0"}
        if self._config:
            out["config"] = dict(self._config)
        if self._header is not None:
            out["header"] = self._header
        out["body"] = {"elements": list(self._elements)}
        return out

    build = to_dict

header

Python
header(title: str, *, subtitle: str | None = None, template: str = 'blue', icon: dict[str, Any] | None = None, tags: list[dict[str, Any]] | None = None) -> Card

设置卡片标题栏，并返回自身以便链式调用。

参数：

名称 类型 描述 默认
title
str

标题文案。

 必需
subtitle
str | None

副标题文案。

 None
template
str

标题栏颜色主题，会经 feishu.cards.validation.validate_template 校验。

 'blue'
icon
dict[str, Any] | None

标题栏图标配置。

 None
tags
list[dict[str, Any]] | None

标题栏右侧的文本标签列表（对应 text_tag_list）。

 None

返回：

类型 描述
Card

当前 feishu.cards.builder.Card 实例。
飞书文档

标题组件

示例：

Python Console Session
1
2
3
4
5
>>> hdr = Card().header("Title", subtitle="sub", template="green").to_dict()["header"]
>>> hdr["title"], hdr["template"]
({'tag': 'plain_text', 'content': 'Title'}, 'green')
>>> hdr["subtitle"]
{'tag': 'plain_text', 'content': 'sub'}
源代码位于： feishu/cards/builder.py
Python
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
def header(
    self,
    title: str,
    *,
    subtitle: str | None = None,
    template: str = "blue",
    icon: dict[str, Any] | None = None,
    tags: list[dict[str, Any]] | None = None,
) -> Card:
    r"""
    设置卡片标题栏，并返回自身以便链式调用。

    Args:
        title: 标题文案。
        subtitle: 副标题文案。
        template: 标题栏颜色主题，会经 [feishu.cards.validation.validate_template][] 校验。
        icon: 标题栏图标配置。
        tags: 标题栏右侧的文本标签列表（对应 `text_tag_list`）。

    Returns:
        当前 [feishu.cards.builder.Card][] 实例。

    飞书文档:
        [标题组件](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-v2-components/containers/title)

    Examples:
        >>> hdr = Card().header("Title", subtitle="sub", template="green").to_dict()["header"]
        >>> hdr["title"], hdr["template"]
        ({'tag': 'plain_text', 'content': 'Title'}, 'green')
        >>> hdr["subtitle"]
        {'tag': 'plain_text', 'content': 'sub'}
    """
    hdr: dict[str, Any] = {
        "title": elements._plain_text(title),
        "template": validate_template(template),
    }
    if subtitle is not None:
        hdr["subtitle"] = elements._plain_text(subtitle)
    if icon is not None:
        hdr["icon"] = icon
    if tags is not None:
        hdr["text_tag_list"] = tags
    self._header = hdr
    return self

config

Python
config(**opts: Any) -> Card

将关键字参数合并进卡片的全局配置（如 streaming_mode、width_mode 等），并返回自身。

参数：

名称 类型 描述 默认
**opts
Any

待合并进卡片 config 的配置项。

 {}

返回：

类型 描述
Card

当前 feishu.cards.builder.Card 实例。
飞书文档

卡片全局配置

示例：

Python Console Session
1
2
>>> Card().config(width_mode="fill").to_dict()["config"]
{'width_mode': 'fill'}
源代码位于： feishu/cards/builder.py
Python
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
def config(self, **opts: Any) -> Card:
    r"""
    将关键字参数合并进卡片的全局配置（如 `streaming_mode`、`width_mode` 等），并返回自身。

    Args:
        **opts: 待合并进卡片 `config` 的配置项。

    Returns:
        当前 [feishu.cards.builder.Card][] 实例。

    飞书文档:
        [卡片全局配置](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-v2-structure)

    Examples:
        >>> Card().config(width_mode="fill").to_dict()["config"]
        {'width_mode': 'fill'}
    """
    self._config.update(opts)
    return self

markdown

Python
markdown(content: str, *, text_align: str | None = None, text_size: str | None = None, escape: bool = False, element_id: str | None = None) -> Card

追加一个 markdown 元素（委托给 feishu.cards.elements.md），并返回自身。

参数：

名称 类型 描述 默认
content
str

markdown 文本内容。

 必需
text_align
str | None

文本对齐方式，如 left、center、right。

 None
text_size
str | None

文本字号，如 normal、heading。

 None
escape
bool

是否先对 content 转义控制字符。

 False
element_id
str | None

元素的自定义 ID，会经 feishu.cards.validation.validate_element_id 校验。

 None

返回：

类型 描述
Card

当前 feishu.cards.builder.Card 实例。

示例：

Python Console Session
1
2
>>> Card().markdown("**bold**", text_align="center").to_dict()["body"]["elements"][0]
{'tag': 'markdown', 'content': '**bold**', 'text_align': 'center'}
源代码位于： feishu/cards/builder.py
Python
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
def markdown(
    self,
    content: str,
    *,
    text_align: str | None = None,
    text_size: str | None = None,
    escape: bool = False,
    element_id: str | None = None,
) -> Card:
    r"""
    追加一个 markdown 元素（委托给 [feishu.cards.elements.md][]），并返回自身。

    Args:
        content: markdown 文本内容。
        text_align: 文本对齐方式，如 `left`、`center`、`right`。
        text_size: 文本字号，如 `normal`、`heading`。
        escape: 是否先对 `content` 转义控制字符。
        element_id: 元素的自定义 ID，会经 [feishu.cards.validation.validate_element_id][] 校验。

    Returns:
        当前 [feishu.cards.builder.Card][] 实例。

    Examples:
        >>> Card().markdown("**bold**", text_align="center").to_dict()["body"]["elements"][0]
        {'tag': 'markdown', 'content': '**bold**', 'text_align': 'center'}
    """
    self._elements.append(
        elements.md(
            content,
            text_align=text_align,
            text_size=text_size,
            escape=escape,
            element_id=element_id,
        )
    )
    return self

text

Python
text(content: str) -> Card

追加纯文本（不转义）的便捷方法，等价于 feishu.cards.builder.Card.markdown。

参数：

名称 类型 描述 默认
content
str

文本内容。

 必需

返回：

类型 描述
Card

当前 feishu.cards.builder.Card 实例。

示例：

Python Console Session
1
2
>>> Card().text("plain").to_dict()["body"]["elements"][0]
{'tag': 'markdown', 'content': 'plain'}
源代码位于： feishu/cards/builder.py
Python
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
def text(self, content: str) -> Card:
    r"""
    追加纯文本（不转义）的便捷方法，等价于 [feishu.cards.builder.Card.markdown][]。

    Args:
        content: 文本内容。

    Returns:
        当前 [feishu.cards.builder.Card][] 实例。

    Examples:
        >>> Card().text("plain").to_dict()["body"]["elements"][0]
        {'tag': 'markdown', 'content': 'plain'}
    """
    return self.markdown(content)

divider

Python
divider() -> Card

追加一条分割线元素（委托给 feishu.cards.elements.hr），并返回自身。

返回：

类型 描述
Card

当前 feishu.cards.builder.Card 实例。

示例：

Python Console Session
1
2
>>> Card().divider().to_dict()["body"]["elements"][0]
{'tag': 'hr'}
源代码位于： feishu/cards/builder.py
Python
290
291
292
293
294
295
296
297
298
299
300
301
302
def divider(self) -> Card:
    r"""
    追加一条分割线元素（委托给 [feishu.cards.elements.hr][]），并返回自身。

    Returns:
        当前 [feishu.cards.builder.Card][] 实例。

    Examples:
        >>> Card().divider().to_dict()["body"]["elements"][0]
        {'tag': 'hr'}
    """
    self._elements.append(elements.hr())
    return self

image

Python
image(img_key: str, alt: str, **opts: Any) -> Card

追加一个图片元素（委托给 feishu.cards.elements.img），并返回自身。

参数：

名称 类型 描述 默认
img_key
str

图片的 key，通过上传图片接口获取。

 必需
alt
str

图片的悬浮提示文案（无障碍替代文本）。

 必需
**opts
Any

其余原样透传给图片元素的字段，如 scale_type、element_id 等。

 {}

返回：

类型 描述
Card

当前 feishu.cards.builder.Card 实例。

示例：

Python Console Session
1
2
>>> Card().image("img_1", "alt").to_dict()["body"]["elements"][0]["tag"]
'img'
源代码位于： feishu/cards/builder.py
Python
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
def image(self, img_key: str, alt: str, **opts: Any) -> Card:
    r"""
    追加一个图片元素（委托给 [feishu.cards.elements.img][]），并返回自身。

    Args:
        img_key: 图片的 key，通过上传图片接口获取。
        alt: 图片的悬浮提示文案（无障碍替代文本）。
        **opts: 其余原样透传给图片元素的字段，如 `scale_type`、`element_id` 等。

    Returns:
        当前 [feishu.cards.builder.Card][] 实例。

    Examples:
        >>> Card().image("img_1", "alt").to_dict()["body"]["elements"][0]["tag"]
        'img'
    """
    self._elements.append(elements.img(img_key, alt, **opts))
    return self

button

Python
button(text: str, *, value: dict[str, Any] | None = None, url: str | None = None, type: str = 'default', confirm: dict[str, Any] | None = None, icon: dict[str, Any] | None = None, element_id: str | None = None) -> Card

追加一个按钮元素（委托给 feishu.cards.elements.button），并返回自身。

参数：

名称 类型 描述 默认
text
str

按钮文案。

 必需
value
dict[str, Any] | None

点击回调时回传的业务数据，生成 callback 行为。

 None
url
str | None

点击时跳转的链接，生成 open_url 行为。

 None
type
str

按钮样式类型，如 default、primary、danger。

 'default'
confirm
dict[str, Any] | None

点击前的二次确认弹窗配置。

 None
icon
dict[str, Any] | None

按钮图标配置。

 None
element_id
str | None

元素的自定义 ID，会经 feishu.cards.validation.validate_element_id 校验。

 None

返回：

类型 描述
Card

当前 feishu.cards.builder.Card 实例。

示例：

Python Console Session
1
2
>>> Card().button("Go", value={"x": 1}).to_dict()["body"]["elements"][0]["behaviors"]
[{'type': 'callback', 'value': {'x': 1}}]
源代码位于： feishu/cards/builder.py
Python
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
def button(
    self,
    text: str,
    *,
    value: dict[str, Any] | None = None,
    url: str | None = None,
    type: str = "default",  # noqa: A002 - matches Feishu field name
    confirm: dict[str, Any] | None = None,
    icon: dict[str, Any] | None = None,
    element_id: str | None = None,
) -> Card:
    r"""
    追加一个按钮元素（委托给 [feishu.cards.elements.button][]），并返回自身。

    Args:
        text: 按钮文案。
        value: 点击回调时回传的业务数据，生成 `callback` 行为。
        url: 点击时跳转的链接，生成 `open_url` 行为。
        type: 按钮样式类型，如 `default`、`primary`、`danger`。
        confirm: 点击前的二次确认弹窗配置。
        icon: 按钮图标配置。
        element_id: 元素的自定义 ID，会经 [feishu.cards.validation.validate_element_id][] 校验。

    Returns:
        当前 [feishu.cards.builder.Card][] 实例。

    Examples:
        >>> Card().button("Go", value={"x": 1}).to_dict()["body"]["elements"][0]["behaviors"]
        [{'type': 'callback', 'value': {'x': 1}}]
    """
    self._elements.append(
        elements.button(
            text,
            value=value,
            url=url,
            type=type,
            confirm=confirm,
            icon=icon,
            element_id=element_id,
        )
    )
    return self

columns

Python
columns(*cols: ColumnSet | dict[str, Any], flex_mode: str = 'none', horizontal_spacing: str | int | None = None, **opts: Any) -> Card

追加一个分栏（column_set）元素，并返回自身。

当仅传入单个 feishu.cards.builder.ColumnSet 时，直接调用其 feishu.cards.builder.ColumnSet.to_dict 追加；此时以该 ColumnSet 自身的 flex_mode/间距为准，调用方传入的关键字参数不会生效（此优先级为有意设计）。

否则（零个、两个及以上参数，或单个非 ColumnSet 参数），每个参数都必须是原始的 列字典（{"tag": "column", ...}）。它们会被包裹进经 feishu.cards.elements.column_set 构造的同一个分栏中，此时调用方的 flex_mode、horizontal_spacing 及额外的 **opts 均会生效。在该路径上传入 ColumnSet 实例会抛出 TypeError，以避免静默生成结构错误的嵌套分栏。

参数：

名称 类型 描述 默认
*cols
ColumnSet | dict[str, Any]

单个 feishu.cards.builder.ColumnSet，或一组原始列字典。

 ()
flex_mode
str

列在窄屏下的自适应方式（仅在原始列字典路径生效）。

 'none'
horizontal_spacing
str | int | None

列间水平间距（仅在原始列字典路径生效）。

 None
**opts
Any

其余原样透传给分栏字典的字段（仅在原始列字典路径生效）。

 {}

返回：

类型 描述
Card

当前 feishu.cards.builder.Card 实例。

引发：

类型 描述
TypeError

在原始列字典路径上传入了 feishu.cards.builder.ColumnSet 实例时抛出。
飞书文档

多列布局组件

示例：

Python Console Session
1
2
3
>>> col = {"tag": "column", "width": "auto", "elements": []}
>>> Card().columns(col, col, flex_mode="stretch").to_dict()["body"]["elements"][0]["flex_mode"]
'stretch'
源代码位于： feishu/cards/builder.py
Python
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
def columns(
    self,
    *cols: ColumnSet | dict[str, Any],
    flex_mode: str = "none",
    horizontal_spacing: str | int | None = None,
    **opts: Any,
) -> Card:
    r"""
    追加一个分栏（column_set）元素，并返回自身。

    当仅传入单个 [feishu.cards.builder.ColumnSet][] 时，直接调用其
    [feishu.cards.builder.ColumnSet.to_dict][] 追加；此时以该 `ColumnSet` 自身的
    `flex_mode`/间距为准，调用方传入的关键字参数不会生效（此优先级为有意设计）。

    否则（零个、两个及以上参数，或单个非 `ColumnSet` 参数），每个参数都必须是原始的
    列字典（`{"tag": "column", ...}`）。它们会被包裹进经 [feishu.cards.elements.column_set][]
    构造的同一个分栏中，此时调用方的 `flex_mode`、`horizontal_spacing` 及额外的 `**opts`
    均会生效。在该路径上传入 `ColumnSet` 实例会抛出 `TypeError`，以避免静默生成结构错误的嵌套分栏。

    Args:
        *cols: 单个 [feishu.cards.builder.ColumnSet][]，或一组原始列字典。
        flex_mode: 列在窄屏下的自适应方式（仅在原始列字典路径生效）。
        horizontal_spacing: 列间水平间距（仅在原始列字典路径生效）。
        **opts: 其余原样透传给分栏字典的字段（仅在原始列字典路径生效）。

    Returns:
        当前 [feishu.cards.builder.Card][] 实例。

    Raises:
        TypeError: 在原始列字典路径上传入了 [feishu.cards.builder.ColumnSet][] 实例时抛出。

    飞书文档:
        [多列布局组件](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-v2-components/containers/column-set)

    Examples:
        >>> col = {"tag": "column", "width": "auto", "elements": []}
        >>> Card().columns(col, col, flex_mode="stretch").to_dict()["body"]["elements"][0]["flex_mode"]
        'stretch'
    """
    if len(cols) == 1 and isinstance(cols[0], ColumnSet):
        self._elements.append(cols[0].to_dict())
        return self
    for c in cols:
        if isinstance(c, ColumnSet):
            raise TypeError(
                "columns() accepts a single ColumnSet, or raw column dicts; "
                "to add multiple column_sets, call .columns()/.column_set() once per column_set"
            )
    self._elements.append(
        elements.column_set(
            cast(list[dict[str, Any]], list(cols)),
            flex_mode=flex_mode,
            horizontal_spacing=horizontal_spacing,
            **opts,
        )
    )
    return self

column_set

Python
column_set() -> ColumnSet

返回一个绑定到本卡片的全新 feishu.cards.builder.ColumnSet 子构造器。

在返回对象上链式调用 feishu.cards.builder.ColumnSet.column 逐列添加内容， 再调用 feishu.cards.builder.ColumnSet.end 将分栏追加回本卡片并取回本卡片。

返回：

类型 描述
ColumnSet

绑定到本卡片的 feishu.cards.builder.ColumnSet 实例。

示例：

Python Console Session
1
2
3
4
5
>>> card = Card()
>>> card.column_set().column({"tag": "markdown", "content": "a"}).end() is card
True
>>> card.to_dict()["body"]["elements"][0]["tag"]
'column_set'
源代码位于： feishu/cards/builder.py
Python
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
def column_set(self) -> ColumnSet:
    r"""
    返回一个绑定到本卡片的全新 [feishu.cards.builder.ColumnSet][] 子构造器。

    在返回对象上链式调用 [feishu.cards.builder.ColumnSet.column][] 逐列添加内容，
    再调用 [feishu.cards.builder.ColumnSet.end][] 将分栏追加回本卡片并取回本卡片。

    Returns:
        绑定到本卡片的 [feishu.cards.builder.ColumnSet][] 实例。

    Examples:
        >>> card = Card()
        >>> card.column_set().column({"tag": "markdown", "content": "a"}).end() is card
        True
        >>> card.to_dict()["body"]["elements"][0]["tag"]
        'column_set'
    """
    return ColumnSet(parent=self)

add

Python
add(raw: dict[str, Any]) -> Card

逃生通道：原样追加任意元素字典，并返回自身。

参数：

名称 类型 描述 默认
raw
dict[str, Any]

待追加的原始元素字典。

 必需

返回：

类型 描述
Card

当前 feishu.cards.builder.Card 实例。

示例：

Python Console Session
1
2
>>> Card().add({"tag": "custom_thing", "k": 1}).to_dict()["body"]["elements"]
[{'tag': 'custom_thing', 'k': 1}]
源代码位于： feishu/cards/builder.py
Python
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
def add(self, raw: dict[str, Any]) -> Card:
    r"""
    逃生通道：原样追加任意元素字典，并返回自身。

    Args:
        raw: 待追加的原始元素字典。

    Returns:
        当前 [feishu.cards.builder.Card][] 实例。

    Examples:
        >>> Card().add({"tag": "custom_thing", "k": 1}).to_dict()["body"]["elements"]
        [{'tag': 'custom_thing', 'k': 1}]
    """
    self._elements.append(raw)
    return self

to_dict

Python
to_dict() -> dict[str, Any]

生成卡片 2.0 的骨架字典。

包含的键：

  • "schema": "2.0"：始终存在。
  • "config": {...}：仅在至少设置过一项配置时出现。
  • "header": {...}：仅在调用过 feishu.cards.builder.Card.header 时出现。
  • "body": {"elements": [...]}：始终存在（元素列表可能为空）。

别名 build 与本方法等价。

返回：

类型 描述
dict[str, Any]

卡片 2.0 的字典表示。
飞书文档

卡片 JSON 2.0 结构

示例：

Python Console Session
1
2
3
4
5
>>> Card().to_dict()
{'schema': '2.0', 'body': {'elements': []}}
>>> c = Card().text("hi")
>>> c.build() == c.to_dict()
True
源代码位于： feishu/cards/builder.py
Python
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
def to_dict(self) -> dict[str, Any]:
    r"""
    生成卡片 2.0 的骨架字典。

    包含的键：

    - `"schema": "2.0"`：始终存在。
    - `"config": {...}`：仅在至少设置过一项配置时出现。
    - `"header": {...}`：仅在调用过 [feishu.cards.builder.Card.header][] 时出现。
    - `"body": {"elements": [...]}`：始终存在（元素列表可能为空）。

    别名 `build` 与本方法等价。

    Returns:
        卡片 2.0 的字典表示。

    飞书文档:
        [卡片 JSON 2.0 结构](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-v2-structure)

    Examples:
        >>> Card().to_dict()
        {'schema': '2.0', 'body': {'elements': []}}
        >>> c = Card().text("hi")
        >>> c.build() == c.to_dict()
        True
    """
    out: dict[str, Any] = {"schema": "2.0"}
    if self._config:
        out["config"] = dict(self._config)
    if self._header is not None:
        out["header"] = self._header
    out["body"] = {"elements": list(self._elements)}
    return out