builders

feishu.task.builders

task_payload

Python

task_payload(summary: str, *, description: str | None = None, due: dict[str, Any] | None = None, start: dict[str, Any] | None = None, members: list[dict[str, Any]] | None = None, tasklists: list[dict[str, Any]] | None = None, **extra: Any) -> NestedDict

构造飞书任务创建载荷。

参数：

名称	类型	描述	默认
summary	str	任务标题。	必需
description	str | None	可选任务描述。	None
due	dict[str, Any] | None	可选飞书 due 对象，原样透传。	None
start	dict[str, Any] | None	可选飞书 start 对象，原样透传。	None
members	list[dict[str, Any]] | None	可选飞书任务成员对象列表。	None
tasklists	list[dict[str, Any]] | None	可选飞书任务清单对象列表。	None
extra	Any	其他飞书任务字段；值为 None 时忽略。	{}

返回：

类型	描述
NestedDict	可传给 feishu.task.tasks.TasksNamespace.create 的任务载荷。

示例：

>>> task_payload("写周报", description="周五前完成").summary
'写周报'

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

def task_payload(
    summary: str,
    *,
    description: str | None = None,
    due: dict[str, Any] | None = None,
    start: dict[str, Any] | None = None,
    members: list[dict[str, Any]] | None = None,
    tasklists: list[dict[str, Any]] | None = None,
    **extra: Any,
) -> NestedDict:
    r"""
    构造飞书任务创建载荷。

    Args:
        summary: 任务标题。
        description: 可选任务描述。
        due: 可选飞书 `due` 对象，原样透传。
        start: 可选飞书 `start` 对象，原样透传。
        members: 可选飞书任务成员对象列表。
        tasklists: 可选飞书任务清单对象列表。
        extra: 其他飞书任务字段；值为 `None` 时忽略。

    Returns:
        可传给 [feishu.task.tasks.TasksNamespace.create][] 的任务载荷。

    Examples:
        >>> task_payload("写周报", description="周五前完成").summary
        '写周报'
    """
    payload = NestedDict(summary=summary)
    if description:
        payload.description = description
    if due:
        payload.due = NestedDict(due)
    if start:
        payload.start = NestedDict(start)
    if members:
        payload.members = [NestedDict(item) for item in members]
    if tasklists:
        payload.tasklists = [NestedDict(item) for item in tasklists]
    for key, value in extra.items():
        if value is not None:
            payload[key] = value
    return payload