sunank200 commented on code in PR #51153: URL: https://github.com/apache/airflow/pull/51153#discussion_r2123457973
########## task-sdk/docs/api.rst: ########## @@ -0,0 +1,159 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +airflow.sdk API Reference +========================= + +This page documents the full public API exposed in Airflow 3.0+ via the Task SDK python module. + +If something is not on this page it is best to assume that it is not part of the public API and use of it is entirely at your own risk +-- we won't go out of our way break usage of them, but we make no promises either. + +.. :py:module: airflow.sdk + +Defining DAGs +------------- +.. autoapiclass:: airflow.sdk.DAG + +.. autoapifunction:: airflow.sdk.dag + +Decorators +---------- +.. autoapifunction:: airflow.sdk.task + +.. autoapifunction:: airflow.sdk.task_group + +.. autoapifunction:: airflow.sdk.setup + +.. autoapifunction:: airflow.sdk.teardown + +.. autofunction:: airflow.sdk.task +.. autofunction:: airflow.sdk.setup +.. autofunction:: airflow.sdk.teardown +.. autofunction:: airflow.sdk.asset + +Utilities +--------- +.. autoapifunction:: airflow.sdk.chain + +.. autoapifunction:: airflow.sdk.chain_linear + +.. autoapifunction:: airflow.sdk.cross_downstream + +.. autoapifunction:: airflow.sdk.literal + +.. autoapifunction:: airflow.sdk.__version__ +.. autofunction:: airflow.sdk.__version__ + +Bases +----- +.. autoapiclass:: airflow.sdk.BaseOperator + +.. autoapiclass:: airflow.sdk.BaseSensorOperator + +.. autoapiclass:: airflow.sdk.BaseNotifier + +.. autoapiclass:: airflow.sdk.BaseOperatorLink + +.. autoapiclass:: airflow.sdk.XComArg + +.. autoapiclass:: airflow.sdk.PokeReturnValue + +Connections & Variables +----------------------- +.. autoapiclass:: airflow.sdk.Connection + +.. autoapiclass:: airflow.sdk.Variable + +Tasks & Operators +----------------- +.. autoapiclass:: airflow.sdk.TaskGroup + +.. autoapiclass:: airflow.sdk.MappedOperator + +.. autoapifunction:: airflow.sdk.get_current_context + +.. autoapifunction:: airflow.sdk.get_parsing_context + +.. autoapiclass:: airflow.sdk.Param + +Edges & Labels +-------------- +.. autoapiclass:: airflow.sdk.EdgeModifier + +.. autoapiclass:: airflow.sdk.Label + +Metadata +-------- +.. autoapiclass:: airflow.sdk.Metadata + +Assets +------ +.. autoapiclass:: airflow.sdk.Asset + +.. autoapiclass:: airflow.sdk.AssetAlias + +.. autoapiclass:: airflow.sdk.AssetAll + +.. autoapiclass:: airflow.sdk.AssetAny + +.. autoapiclass:: airflow.sdk.AssetWatcher + +I/O Helpers +----------- +.. autoapiclass:: airflow.sdk.ObjectStoragePath + +Execution Time Components +------------------------- +.. rubric:: Supervisor + +.. autoapimodule:: airflow.sdk.execution_time.supervisor + :members: + :undoc-members: + +.. rubric:: TaskRunner + +.. autoapimodule:: airflow.sdk.execution_time.task_runner + :members: + :undoc-members: + +.. rubric:: Context +.. autoapiclass:: airflow.sdk.Context +.. autoapimodule:: airflow.sdk.execution_time.context + :members: + :undoc-members: + +.. rubric:: Cache + +.. autoapiclass:: airflow.sdk.SecretCache +.. autoclass:: airflow.sdk.SecretCache Review Comment: I've exposed MappedOperator in the SDK exactly like SecretCache so that both runtime imports and mypy picks it up -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@airflow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
