Skip to content

[hotfix][python][docs] add bundling udfs section #15790

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
t0t07 wants to merge 7 commits into from
Closed

[hotfix][python][docs] add bundling udfs section #15790

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
40ff67a
[hotfix][python][docs] add bundling udfs section
t0t07 Apr 28, 2021
1a991b8
Take suggestion
t0t07 Apr 28, 2021
27162f8
per suggestion
t0t07 Apr 28, 2021
57608d1
newline
t0t07 Apr 28, 2021
86c54e9
add zh docs
t0t07 Apr 28, 2021
573ea5b
take suggestion
t0t07 Apr 28, 2021
1c2dd4a
rm
t0t07 Apr 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/content.zh/docs/dev/python/table/udfs/python_udfs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,3 +554,11 @@ class ListViewConcatTableAggregateFunction(TableAggregateFunction):
def get_result_type(self):
return DataTypes.ROW([DataTypes.FIELD("a", DataTypes.STRING())])
```

## 打包 UDFs

To run Python UDFs (as well as Pandas UDFs) in any non-local mode, it is strongly recommended to bundle your Python UDF definitions using the config option [`python-files`]({{< ref "docs/dev/python/python_config" >}}#python-files), if your Python UDFs live outside of the file where the `main()` function is defined.
Otherwise, you may run into `ModuleNotFoundError: No module named 'my_udf'` if you define Python UDFs in a file called `my_udf.py`.

如果你在非 local 模式下运行 Python UDFs 和 Pandas UDFs，且 Python UDFs 没有定义在含 `main()` 入口的 Python 主文件中，我们强烈建议你通过 [`python-files`]({{< ref "docs/dev/python/python_config" >}}#python-files) 配置项将 Python UDF 的定义打包起来。
否则，如果你将 Python UDFs 定义在名为 `my_udf.py` 的文件中，你可能会遇到 `ModuleNotFoundError: No module named 'my_udf'` 这样的报错。
5 changes: 5 additions & 0 deletions docs/content/docs/dev/python/table/udfs/python_udfs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -553,3 +553,8 @@ class ListViewConcatTableAggregateFunction(TableAggregateFunction):
def get_result_type(self):
return DataTypes.ROW([DataTypes.FIELD("a", DataTypes.STRING())])
```

## Bundling UDFs

To run Python UDFs (as well as Pandas UDFs) in any non-local mode, it is strongly recommended to bundle your Python UDF definitions using the config option [`python-files`]({{< ref "docs/dev/python/python_config" >}}#python-files), if your Python UDFs live outside of the file where the `main()` function is defined.
Otherwise, you may run into `ModuleNotFoundError: No module named 'my_udf'` if you define Python UDFs in a file called `my_udf.py`.