File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2020
2121### Fixed
2222
23+ - Clarify UDF documentation on required function type annotations. ([ #757 ] ( https://github.com/Open-EO/openeo-python-client/issues/757 ) )
2324
2425## [ 0.51.0] - 2026-07-16
2526
Original file line number Diff line number Diff line change @@ -152,6 +152,26 @@ as defined in the :py:mod:`openeo.udf.udf_signatures` module,
152152so that the back-end knows what the *entrypoint * function is
153153of your UDF implementation.
154154
155+ The function name and Python type annotations are part of that signature:
156+ they are used to detect how the UDF should be invoked.
157+ Do not omit the type annotations on the UDF entrypoint, even if your editor
158+ or linter would otherwise consider them optional.
159+ For example, this is not enough:
160+
161+ .. code-block :: python
162+
163+ def apply_datacube (cube , context ):
164+ ...
165+
166+ Instead, write the full annotated signature:
167+
168+ .. code-block :: python
169+
170+ import xarray
171+
172+ def apply_datacube (cube : xarray.DataArray, context : dict ) -> xarray.DataArray:
173+ ...
174+
155175
156176 Module ``openeo.udf.udf_signatures ``
157177-------------------------------------
You can’t perform that action at this time.
0 commit comments