builders

feishu.bitable.builders

bitable_record

Python

bitable_record(fields: dict[str, Any], *, record_id: str | None = None, **extra: Any) -> NestedDict

构造飞书多维表格记录载荷。

参数：

名称	类型	描述	默认
fields	dict[str, Any]	记录字段值，键为多维表格字段名。	必需
record_id	str | None	可选记录 ID，通常用于更新记录载荷。	None
extra	Any	其他需要透传的记录字段；值为 None 时忽略。	{}

返回：

类型	描述
NestedDict	形如 {"fields": {...}} 的记录载荷，可传给
NestedDict	feishu.bitable.records.RecordsNamespace.create /
NestedDict	feishu.bitable.records.RecordsNamespace.update。

示例：

>>> bitable_record({"Title": "hi"}).fields.Title
'hi'

源代码位于： feishu/bitable/builders.py

def bitable_record(
    fields: dict[str, Any],
    *,
    record_id: str | None = None,
    **extra: Any,
) -> NestedDict:
    r"""
    构造飞书多维表格记录载荷。

    Args:
        fields: 记录字段值，键为多维表格字段名。
        record_id: 可选记录 ID，通常用于更新记录载荷。
        extra: 其他需要透传的记录字段；值为 `None` 时忽略。

    Returns:
        形如 `{"fields": {...}}` 的记录载荷，可传给
        [feishu.bitable.records.RecordsNamespace.create][] /
        [feishu.bitable.records.RecordsNamespace.update][]。

    Examples:
        >>> bitable_record({"Title": "hi"}).fields.Title
        'hi'
    """
    payload = NestedDict(fields=NestedDict(fields))
    if record_id:
        payload.record_id = record_id
    for key, value in extra.items():
        if value is not None:
            payload[key] = value
    return payload