FastAPI · 函数

查询参数

创建查询参数。

调用签名(名称: 'str', 类型=<class 'str'>, 默认=None, 描述: 'str' = '', **选项)

查ZHONGWEN
PYTHON

Chinese example

中文代码示例

# 完整案例：按字段调用 查询参数
设 结果 = FastAPI.查询参数(
    名称="示例",  # 必填；对象在代码和设计稿里的唯一名称，后续查找、更新、...
    类型=<class 'str'>,  # 可选；要创建或处理的对象类型，例如按钮、标签、表格、输...
    默认=None,  # 可选；按函数业务含义传入 默认;首次使用建议先 打印(...
    描述='',  # 可选；字符串类型的 描述 参数,按函数业务含义传入对应...
    **{"字段": "值"},  # 可选；额外关键字参数，用字典形式展开传入
)
打印(结果)

可直接放进 .cs / .中py 文件运行。转换器会把中文代码交给真实 Python 解释器。

Parameters

参数说明

5 个参数

参数类型 / 传入方式说明

名称可选 · 默认无

str位置参数或字段名=值

对象在代码和设计稿里的唯一名称，后续查找、更新、删除都靠它。

常见错误：漏传会报 TypeError: missing required argument: '名称';检查调用是否漏了这行

类型可选 · 默认 <class 'str'>

未声明位置参数或字段名=值

要创建或处理的对象类型，例如按钮、标签、表格、输入框。

常见错误：类型不匹配会报 TypeError;按字段类型列传值,首次使用建议先打印(结果) 确认结构

默认可选 · 默认 None

未声明位置参数或字段名=值

按函数业务含义传入默认;首次使用建议先打印(结果) 确认其作用。

常见错误：类型不匹配会报 TypeError;按字段类型列传值,首次使用建议先打印(结果) 确认结构

描述可选 · 默认 ''

str位置参数或字段名=值

字符串类型的描述参数,按函数业务含义传入对应文本。

常见错误：传非字符串会报 TypeError;按字符串类型传值

选项可选 · 默认不传则为空

未声明可变关键字参数，用 **字典展开

额外关键字参数，用字典形式展开传入。

常见错误：类型不匹配会报 TypeError;按字段类型列传值,首次使用建议先打印(结果) 确认结构

Playbook

基础用法 · 进阶组合 · 错误排查

# 完整案例：按字段调用 查询参数
设 结果 = FastAPI.查询参数(
    名称="示例",  # 必填；对象在代码和设计稿里的唯一名称，后续查找、更新、...
    类型=<class 'str'>,  # 可选；要创建或处理的对象类型，例如按钮、标签、表格、输...
    默认=None,  # 可选；按函数业务含义传入 默认;首次使用建议先 打印(...
    描述='',  # 可选；字符串类型的 描述 参数,按函数业务含义传入对应...
    **{"字段": "值"},  # 可选；额外关键字参数，用字典形式展开传入
)
打印(结果)

# 进阶组合:展示关键字段组合
设 结果 = FastAPI.查询参数(
    名称="示例",  # 必填
    类型=<class 'str'>,  # 可选
    默认=None,  # 可选
)
打印(结果)

# 错误排查:覆盖 1 个必填参数

## 参数 1: 名称
# 错误:名称拼写错误或重复会报 KeyError/ValueError
# 设 结果 = FastAPI.查询参数(名称="不存在的名称")  # KeyError
# 修复:先打印可用名称列表确认
设 结果 = FastAPI.查询参数(名称="示例")
打印(结果)