You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "KoviAnusha (via GitHub)" <gi...@apache.org> on 2025/11/19 07:05:00 UTC
[PR] Update docs to reflect relocation of decorator utilities from airflow.utils.decorators [airflow]
KoviAnusha opened a new pull request, #58479:
URL: https://github.com/apache/airflow/pull/58479
<!--
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.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
related: https://github.com/apache/airflow/issues/53693
Reflected the documentation based on the changes in https://github.com/apache/airflow/issues/53419
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
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-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update docs to reflect relocation of decorator utilities from airflow.utils.decorators [airflow]
Posted by "KoviAnusha (via GitHub)" <gi...@apache.org>.
KoviAnusha commented on PR #58479:
URL: https://github.com/apache/airflow/pull/58479#issuecomment-3594307196
no changes needed
--
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-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update docs to reflect relocation of decorator utilities from airflow.utils.decorators [airflow]
Posted by "KoviAnusha (via GitHub)" <gi...@apache.org>.
KoviAnusha closed pull request #58479: Update docs to reflect relocation of decorator utilities from airflow.utils.decorators
URL: https://github.com/apache/airflow/pull/58479
--
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-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update docs to reflect relocation of decorator utilities from airflow.utils.decorators [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #58479:
URL: https://github.com/apache/airflow/pull/58479#discussion_r2541924193
##########
airflow-core/docs/core-concepts/taskflow.rst:
##########
@@ -201,6 +201,33 @@ Sensors and the TaskFlow API
For an example of writing a Sensor using the TaskFlow API, see
:ref:`Using the TaskFlow API with Sensor operators <taskflow-using-sensors>`.
+Decorator Utilities Migration
+-----------------------------
+
+Several helper functions previously located in ``airflow.utils.decorators`` have been moved to more appropriate modules.
+
+The following imports are deprecated and will be removed in a future version:
+
+.. code-block:: python
+
+ from airflow.utils.decorators import classproperty
+ from airflow.utils.decorators import remove_task_decorator
+ from airflow.utils.decorators import fixup_decorator_warning_stack
+
+Use the updated import paths instead:
+
+.. code-block:: python
+
+ # classproperty is now part of the deadline model
+ from airflow.models.deadline import classproperty
+
+ # decorator utilities relocated to the Task SDK internal definitions module
+ from airflow.sdk.definitions._internal.decorators import remove_task_decorator
Review Comment:
No its not fine to write about internal modules thats why those are in `_internal` -- which means that they are not used anywhere in the codebase apart from within task sdk and aren't part of the public dag authoring interface of Airflow. Everyting of decorators that needs to be exposed is here: https://github.com/apache/airflow/blob/main/task-sdk/src/airflow/sdk/bases/decorator.py
--
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-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update docs to reflect relocation of decorator utilities from airflow.utils.decorators [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on code in PR #58479:
URL: https://github.com/apache/airflow/pull/58479#discussion_r2541550272
##########
airflow-core/docs/core-concepts/taskflow.rst:
##########
@@ -201,6 +201,33 @@ Sensors and the TaskFlow API
For an example of writing a Sensor using the TaskFlow API, see
:ref:`Using the TaskFlow API with Sensor operators <taskflow-using-sensors>`.
+Decorator Utilities Migration
+-----------------------------
+
+Several helper functions previously located in ``airflow.utils.decorators`` have been moved to more appropriate modules.
+
+The following imports are deprecated and will be removed in a future version:
+
+.. code-block:: python
+
+ from airflow.utils.decorators import classproperty
+ from airflow.utils.decorators import remove_task_decorator
+ from airflow.utils.decorators import fixup_decorator_warning_stack
+
+Use the updated import paths instead:
+
+.. code-block:: python
+
+ # classproperty is now part of the deadline model
+ from airflow.models.deadline import classproperty
+
+ # decorator utilities relocated to the Task SDK internal definitions module
+ from airflow.sdk.definitions._internal.decorators import remove_task_decorator
Review Comment:
Is this fine to write about `_internal` decorators in user's doc? Why are they internal? Are we not planning to make them available to the users @amoghrajesh ?
--
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-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org