Mika Naylor created FLINK-37365:
-----------------------------------
Summary: Add API stability annotations (@Experimental,
@PublicEvolving) to PyFlink APIs
Key: FLINK-37365
URL: https://issues.apache.org/jira/browse/FLINK-37365
Project: Flink
Issue Type: Improvement
Components: API / Python
Reporter: Mika Naylor
Currently, the Java APIs use annotations like @PublicEvolving and @Experimental
to clearly indicate the stability status of API components. This is super
helpful for understanding which parts of the API are stable for production use
and which might change in future releases.
The Python APIs lack this kind of explicit stability indication. We should
create a set of decorators, corresponding to the annotations used in the Java
APIs, that would allow us to decorate classes/functions depending on their
stability that would be reflected in the API docs, and also warn the user at
runtime in the case of deprecated classes/functions.
See: [https://lists.apache.org/thread/cff0kpxh9ojk3n6pwx4c4mrgrv2ob59h] for
discussion context.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
