顶层 API / params.py

qs.pms

创建参数对象（统一入口）。

可执行示例returns: Paramstop-level

输入 / 输出

输入

按下表列名和类型准备输入。

输入项	类型	示例
当前对象	Expr / DataFrame / Params	由调用链左侧对象提供

输出

项目	说明
返回类型	`Params`
输出对象	DataFrame 执行计划或 Polars DataFrame
输出语义	输出列由算子、alias 或底层实现决定；需要稳定列名时显式使用 alias。
执行方式	调用后用真实 Polars DataFrame 执行。
核心调用	`qs.pms(2, 120).title("window").value(20).step(1)`

打印输入 / 打印输出

下面内容来自本页示例代码真实执行后的 stdout，不是手写占位。

打印输入

print(data)

无表格输入；本例直接使用调用参数、当前对象或类型构造器。

打印输出

print(out)

shape: (2, 2)
┌──────┬─────────────────────────────────┐
│ 项目 ┆ 内容                            │
│ ---  ┆ ---                             │
│ str  ┆ str                             │
╞══════╪═════════════════════════════════╡
│ 调用 ┆ qs.pms(2, 120).title("window")… │
│ 输出 ┆ Params { inner: ParamsSliceUsi… │
└──────┴─────────────────────────────────┘

调用

Python

qs.pms(2, 120).title("window").value(20).step(1)

参数	类型	默认值	说明
`start`	`int \| float \| list[str] \| list['Expr']`	`必填`	位置参数
`end`	`int \| float \| str \| None`	`None`	位置参数

完整代码

本页完整例子会执行真实的 calc_data 或对象调用。

展开可复制完整代码

Python

import qust as qs

print("算子:")
print('qs.pms')
print("场景:")
print('顶层 API：读取、保存数据和创建 live 参数。')
print("模式:")
print('顶层 API 示例：创建 live 参数。')
print("输入列:")
print('无固定表格输入列')
print("调用:")
print('qs.pms(2, 120).title("window").value(20).step(1)')
result = qs.pms(2, 120).title("window").value(20).step(1)
print("输出:")
print(result)

改成业务代码

改哪里	怎么改
列名	把示例 DataFrame 里的列名换成你的真实列名，列顺序保持和用法一致。
参数	只改函数括号里的参数；不要随意改变 `rolling/over/batch/select` 的链式层级。
输出名	需要稳定输出列名时，在表达式尾部加 `.alias("name")`。
调试	先打印输入数据和调用字符串，再执行 `calc_data`；报 schema 错时先检查列数和 dtype。

注意事项

- 字符串枚举参数不支持 `.step(...)`。
- `pms` 只能接收两参，传入旧签名会抛 `TypeError`。

来源

项目	位置
源码文件	`params.py`
类/对象	`module`