You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "Lee-W (via GitHub)" <gi...@apache.org> on 2023/07/11 09:04:57 UTC

[GitHub] [airflow] Lee-W opened a new pull request, #32514: build(pre-commit): add list of supported deferrable operators to doc

Lee-W opened a new pull request, #32514:
URL: https://github.com/apache/airflow/pull/32514

   <!--
    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/
   -->
   
   ---
   **^ Add meaningful description above**
   
   Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/CONTRIBUTING.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 [newsfragments](https://github.com/apache/airflow/tree/main/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


[GitHub] [airflow] eladkal merged pull request #32514: build(pre-commit): add list of supported deferrable operators to doc

Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal merged PR #32514:
URL: https://github.com/apache/airflow/pull/32514


-- 
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


[GitHub] [airflow] potiuk commented on a diff in pull request #32514: build(pre-commit): add list of supported deferrable operators to doc

Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on code in PR #32514:
URL: https://github.com/apache/airflow/pull/32514#discussion_r1259474676


##########
docs/apache-airflow/deferrable-operator-ref.rst:
##########
@@ -0,0 +1,355 @@
+ .. 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.
+
+
+Supported Deferrable Operators
+==========================================
+
+List of operators that supports deferrable mode
+
+.. START automatically generated
+
+**apache-airflow**
+
+.. list-table::
+   :header-rows: 1
+
+   * - Modules
+     - Operators
+
+   * - :mod:`airflow.operators.trigger_dagrun`
+     - :mod:`TriggerDagRunOperator`
+
+
+**apache-airflow-providers-amazon**
+
+.. list-table::
+   :header-rows: 1
+
+   * - Modules
+     - Operators
+
+   * - :mod:`airflow.providers.amazon.aws.sensors.emr`
+     - :mod:`EmrContainerSensor`
+
+   * - :mod:`airflow.providers.amazon.aws.sensors.emr`
+     - :mod:`EmrJobFlowSensor`
+

Review Comment:
   Oh. Just noticed you commented the same @eladkal :)



-- 
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


[GitHub] [airflow] potiuk commented on pull request #32514: build(pre-commit): add list of supported deferrable operators to doc

Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #32514:
URL: https://github.com/apache/airflow/pull/32514#issuecomment-1630481974

   See also a few other places (like connections, secrets etc. where there are links from "apache-airflow" to "apache-airflow-providers" documentation.


-- 
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


[GitHub] [airflow] potiuk commented on pull request #32514: build(pre-commit): add list of supported deferrable operators to doc

Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #32514:
URL: https://github.com/apache/airflow/pull/32514#issuecomment-1643175935

   @eladkal ?


-- 
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


[GitHub] [airflow] Lee-W commented on a diff in pull request #32514: build(pre-commit): add list of supported deferrable operators to doc

Posted by "Lee-W (via GitHub)" <gi...@apache.org>.
Lee-W commented on code in PR #32514:
URL: https://github.com/apache/airflow/pull/32514#discussion_r1259464913


##########
STATIC_CODE_CHECKS.rst:
##########
@@ -171,7 +171,8 @@ require Breeze Docker image to be built locally.
 +-----------------------------------------------------------+--------------------------------------------------------------+---------+
 | check-decorated-operator-implements-custom-name           | Check @task decorator implements custom_operator_name        |         |
 +-----------------------------------------------------------+--------------------------------------------------------------+---------+
-| check-deferrable-default-value                            | Check default value of deferrable attribute                  |         |
+| check-deferrable-default-value                            | * Check default value of deferrable attribute                |         |
+|                                                           | * Check default value of deferrable attribute                |         |

Review Comment:
   Yep, I just found out I forget to change the pre-commit name. I've updated it. Thanks!



-- 
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


[GitHub] [airflow] eladkal commented on a diff in pull request #32514: build(pre-commit): add list of supported deferrable operators to doc

Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal commented on code in PR #32514:
URL: https://github.com/apache/airflow/pull/32514#discussion_r1259446598


##########
docs/apache-airflow/deferrable-operator-ref.rst:
##########
@@ -0,0 +1,355 @@
+ .. 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.
+
+
+Supported Deferrable Operators
+==========================================
+
+List of operators that supports deferrable mode
+
+.. START automatically generated
+
+**apache-airflow**
+
+.. list-table::
+   :header-rows: 1
+
+   * - Modules
+     - Operators
+
+   * - :mod:`airflow.operators.trigger_dagrun`
+     - :mod:`TriggerDagRunOperator`
+
+
+**apache-airflow-providers-amazon**
+
+.. list-table::
+   :header-rows: 1
+
+   * - Modules
+     - Operators
+
+   * - :mod:`airflow.providers.amazon.aws.sensors.emr`
+     - :mod:`EmrContainerSensor`
+
+   * - :mod:`airflow.providers.amazon.aws.sensors.emr`
+     - :mod:`EmrJobFlowSensor`
+

Review Comment:
   This list will be almost always not up to date because provider release cycle and core is not sync.
   If we want to have such list it should be part of the provider docs and linked from core
   The idea is similar to what we do with notifiers (just with direct link to index page rather than the class itself)
   https://airflow.apache.org/docs/apache-airflow-providers/core-extensions/notifications.html#notifications



-- 
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


[GitHub] [airflow] potiuk commented on pull request #32514: build(pre-commit): add list of supported deferrable operators to doc

Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #32514:
URL: https://github.com/apache/airflow/pull/32514#issuecomment-1634097338

   @eladkal ?


-- 
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


[GitHub] [airflow] potiuk commented on pull request #32514: build(pre-commit): add list of supported deferrable operators to doc

Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #32514:
URL: https://github.com/apache/airflow/pull/32514#issuecomment-1632644130

   nice one :)


-- 
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


[GitHub] [airflow] eladkal commented on a diff in pull request #32514: build(pre-commit): add list of supported deferrable operators to doc

Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal commented on code in PR #32514:
URL: https://github.com/apache/airflow/pull/32514#discussion_r1259446598


##########
docs/apache-airflow/deferrable-operator-ref.rst:
##########
@@ -0,0 +1,355 @@
+ .. 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.
+
+
+Supported Deferrable Operators
+==========================================
+
+List of operators that supports deferrable mode
+
+.. START automatically generated
+
+**apache-airflow**
+
+.. list-table::
+   :header-rows: 1
+
+   * - Modules
+     - Operators
+
+   * - :mod:`airflow.operators.trigger_dagrun`
+     - :mod:`TriggerDagRunOperator`
+
+
+**apache-airflow-providers-amazon**
+
+.. list-table::
+   :header-rows: 1
+
+   * - Modules
+     - Operators
+
+   * - :mod:`airflow.providers.amazon.aws.sensors.emr`
+     - :mod:`EmrContainerSensor`
+
+   * - :mod:`airflow.providers.amazon.aws.sensors.emr`
+     - :mod:`EmrJobFlowSensor`
+

Review Comment:
   This list will be almost always not up to date because provider release cycle and core is not sync.
   If we want to have such list it should be part of the provider docs and linked from core similar to what we do with notifiers
   https://airflow.apache.org/docs/apache-airflow-providers/core-extensions/notifications.html#notifications



-- 
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


[GitHub] [airflow] uranusjr commented on a diff in pull request #32514: build(pre-commit): add list of supported deferrable operators to doc

Posted by "uranusjr (via GitHub)" <gi...@apache.org>.
uranusjr commented on code in PR #32514:
URL: https://github.com/apache/airflow/pull/32514#discussion_r1259443455


##########
STATIC_CODE_CHECKS.rst:
##########
@@ -171,7 +171,8 @@ require Breeze Docker image to be built locally.
 +-----------------------------------------------------------+--------------------------------------------------------------+---------+
 | check-decorated-operator-implements-custom-name           | Check @task decorator implements custom_operator_name        |         |
 +-----------------------------------------------------------+--------------------------------------------------------------+---------+
-| check-deferrable-default-value                            | Check default value of deferrable attribute                  |         |
+| check-deferrable-default-value                            | * Check default value of deferrable attribute                |         |
+|                                                           | * Check default value of deferrable attribute                |         |

Review Comment:
   This seems out of place



-- 
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


[GitHub] [airflow] Lee-W commented on pull request #32514: build(pre-commit): add list of supported deferrable operators to doc

Posted by "Lee-W (via GitHub)" <gi...@apache.org>.
Lee-W commented on PR #32514:
URL: https://github.com/apache/airflow/pull/32514#issuecomment-1631014736

   Hi @eladkal @potiuk @uranusjr , thanks for your suggestions! I've made change accordingly


-- 
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