functions
latest
false
函数用户指南
- 概述
- Python 函数
- 部署并运行
重要 :
请注意，此内容已使用机器翻译进行了本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
本页面将引导您安装 SDK、搭建项目以及在本地运行第一个 Python 函数。
先决条件
- Python 3.10 或更高版本。
- 使用
pip安装的uipathCLI 和 SDK 。 - 有权访问 Orchestrator 的 UiPath 帐户（用于发布和调用）。
安装 SDK
pip install uipath
pip install uipath
验证安装：
uipath --version
uipath --version
构建项目
新建函数项目：
uipath new my-function
uipath new my-function
这将构建您编辑的文件：
| 文件 | 用途 |
|---|---|
main.py | 您的函数逻辑和 Input/Output 模型。作为可运行的示例启动。 |
pyproject.toml | 项目元数据和依赖项。 |
uipath.json | 声明可调用的入口点。框架为您注册 main。 |
编写您的第一个函数
替换 main.py 中的框架逻辑：
from pydantic.dataclasses import dataclass
@dataclass
class Input:
message: str = ""
@dataclass
class Output:
reply: str = ""
def main(input: Input) -> Output:
return Output(reply=f"Hello, {input.message}!")
from pydantic.dataclasses import dataclass
@dataclass
class Input:
message: str = ""
@dataclass
class Output:
reply: str = ""
def main(input: Input) -> Output:
return Output(reply=f"Hello, {input.message}!")
框架式的 uipath.json 已经声明了此入口点：
{
"functions": {
"main": "main.py:main"
}
}
{
"functions": {
"main": "main.py:main"
}
}
键 (main) 是 CLI 命令中使用的入口点名称；该值引用文件和函数。仅在重命名函数或添加更多入口点时更新它。
生成项目架构
定义 Input 和 Output 后，生成架构和绑定：
uipath init
uipath init
这将读取您的代码和 uipath.json 并生成：
| 文件 | 用途 |
|---|---|
entry-points.json | 派生自您模型的输入/输出 JSON 架构，用于变量绑定。 |
bindings.json | 资源绑定清单，仅当文件不存在时使用空结构创建。 |
每当更改 uipath init 或 Input 模型时，请重新运行 Output。它会重新生成 entry-points.json 且永不修改 bindings.json — 资源绑定是手动维护的。有关它们的作用以及如何声明它们，请参阅资源绑定。
在本地运行
uipath run main '{"message": "world"}'
uipath run main '{"message": "world"}'
本地运行通过 bindings.json 中的条目解析平台资源，因此您可以在发布之前针对真实的 Orchestrator 资产和存储桶进行测试。当包在另一个租户中运行时，相同的条目用于重新映射每个资源。
后续步骤
- 构建 Python 函数— 类型化架构、错误处理和多入口点。
- 资源绑定— 声明您的函数到达的平台资源。
- 打包并发布— 部署到 Orchestrator。