You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2020/11/10 23:51:17 UTC

[GitHub] [airflow] eflann opened a new pull request #12271: Update example to use dag decorator tag

eflann opened a new pull request #12271:
URL: https://github.com/apache/airflow/pull/12271


   <!--
   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 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/master/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
   In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+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 [UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
   


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

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] github-actions[bot] commented on pull request #12271: Update example to use dag decorator tag

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #12271:
URL: https://github.com/apache/airflow/pull/12271#issuecomment-787558748


   This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.


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

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] ryw commented on pull request #12271: Update example to use dag decorator tag

Posted by GitBox <gi...@apache.org>.
ryw commented on pull request #12271:
URL: https://github.com/apache/airflow/pull/12271#issuecomment-735970004


   what is left to do on this 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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] boring-cyborg[bot] commented on pull request #12271: Update example to use dag decorator tag

Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on pull request #12271:
URL: https://github.com/apache/airflow/pull/12271#issuecomment-725037283


   Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst)
   Here are some useful points:
   - Pay attention to the quality of your code (flake8, pylint and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/master/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks) will help you with that.
   - In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/master/docs/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
   - Consider using [Breeze environment](https://github.com/apache/airflow/blob/master/BREEZE.rst) for testing locally, itโ€™s a heavy docker but it ships with a working Airflow and a lot of integrations.
   - Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
   - Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
   - Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#coding-style-and-best-practices).
   Apache Airflow is a community-driven project and together we are making it better ๐Ÿš€.
   In case of doubts contact the developers at:
   Mailing List: dev@airflow.apache.org
   Slack: https://s.apache.org/airflow-slack
   


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

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] kaxil commented on a change in pull request #12271: Update example to use dag decorator tag

Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #12271:
URL: https://github.com/apache/airflow/pull/12271#discussion_r520959402



##########
File path: airflow/example_dags/tutorial_taskflow_api_etl.py
##########
@@ -45,14 +46,8 @@
 # [END default_args]
 
 # [START instantiate_dag]
-with DAG(
-    'tutorial_taskflow_api_etl_dag',
-    default_args=default_args,
-    description='TaskFlow API ETL DAG tutorial',
-    schedule_interval=None,
-    start_date=days_ago(2),
-    tags=['example'],
-) as dag:
+@dag(default_args=default_args, schedule_interval=None, start_date=days_ago(2))
+def tutorial_taskflow_api_etl():

Review comment:
       +1




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

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] casassg commented on pull request #12271: Update example to use dag decorator tag

Posted by GitBox <gi...@apache.org>.
casassg commented on pull request #12271:
URL: https://github.com/apache/airflow/pull/12271#issuecomment-735971123


   I think it probably requires to restructure the tutorial to explain using docstrings for 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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] casassg commented on a change in pull request #12271: Update example to use dag decorator tag

Posted by GitBox <gi...@apache.org>.
casassg commented on a change in pull request #12271:
URL: https://github.com/apache/airflow/pull/12271#discussion_r520953070



##########
File path: airflow/example_dags/tutorial_taskflow_api_etl.py
##########
@@ -33,6 +33,7 @@
 # The DAG object; we'll need this to instantiate a DAG
 from airflow import DAG

Review comment:
       This is no longer needed!
   ```suggestion
   ```

##########
File path: airflow/example_dags/tutorial_taskflow_api_etl.py
##########
@@ -45,14 +46,8 @@
 # [END default_args]
 
 # [START instantiate_dag]
-with DAG(
-    'tutorial_taskflow_api_etl_dag',
-    default_args=default_args,
-    description='TaskFlow API ETL DAG tutorial',
-    schedule_interval=None,
-    start_date=days_ago(2),
-    tags=['example'],
-) as dag:
+@dag(default_args=default_args, schedule_interval=None, start_date=days_ago(2))
+def tutorial_taskflow_api_etl():

Review comment:
       Documentation in `@dag` decorator should  be a function `__doc__`
   ```suggestion
   def tutorial_taskflow_api_etl():
     """### TaskFlow API Tutorial Documentation
     This is a simple ETL data pipeline example which demonstrates the use of the TaskFlow API
     using three simple tasks for Extract, Transform, and Load.
     Documentation that goes along with the Airflow TaskFlow API tutorial located
     [here](https://airflow.apache.org/docs/stable/tutorial_taskflow_api.html)
     """
   ```




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

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] kaxil commented on pull request #12271: Update example to use dag decorator tag

Posted by GitBox <gi...@apache.org>.
kaxil commented on pull request #12271:
URL: https://github.com/apache/airflow/pull/12271#issuecomment-725049447


   > 2\. https://airflow.apache.org/docs/stable/tutorial_taskflow_api.html
   
   https://airflow.readthedocs.io/en/latest/tutorial_taskflow_api.html


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

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] github-actions[bot] commented on pull request #12271: Update example to use dag decorator tag

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #12271:
URL: https://github.com/apache/airflow/pull/12271#issuecomment-725054714


   [The Workflow run](https://github.com/apache/airflow/actions/runs/356890082) is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks,^Build docs$,^Spell check docs$,^Backport packages$,^Provider packages,^Checks: Helm tests$,^Test OpenAPI*.


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

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] github-actions[bot] closed pull request #12271: Update example to use dag decorator tag

Posted by GitBox <gi...@apache.org>.
github-actions[bot] closed pull request #12271:
URL: https://github.com/apache/airflow/pull/12271


   


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

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] kaxil edited a comment on pull request #12271: Update example to use dag decorator tag

Posted by GitBox <gi...@apache.org>.
kaxil edited a comment on pull request #12271:
URL: https://github.com/apache/airflow/pull/12271#issuecomment-725049447


   Check this: https://airflow.readthedocs.io/en/latest/tutorial_taskflow_api.html


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

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] eflann commented on pull request #12271: Update example to use dag decorator tag

Posted by GitBox <gi...@apache.org>.
eflann commented on pull request #12271:
URL: https://github.com/apache/airflow/pull/12271#issuecomment-725047995


   1. Where do you go to update the tutorial doc? 
   2. Just noticed this returns a 404 for me: https://airflow.apache.org/docs/stable/tutorial_taskflow_api.html
   
   (Really really new around here. Thanks for bearing with me.)


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

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] ashb commented on a change in pull request #12271: Update example to use dag decorator tag

Posted by GitBox <gi...@apache.org>.
ashb commented on a change in pull request #12271:
URL: https://github.com/apache/airflow/pull/12271#discussion_r521375354



##########
File path: airflow/example_dags/tutorial_taskflow_api_etl.py
##########
@@ -45,22 +35,23 @@
 # [END default_args]
 
 # [START instantiate_dag]
-with DAG(
-    'tutorial_taskflow_api_etl_dag',
-    default_args=default_args,
-    description='TaskFlow API ETL DAG tutorial',
-    schedule_interval=None,
-    start_date=days_ago(2),
-    tags=['example'],
-) as dag:
-    # [END instantiate_dag]
-
+@dag(default_args=default_args, schedule_interval=None, start_date=days_ago(2))
+# [END instantiate_dag]
+def tutorial_taskflow_api_etl():
     # [START documentation]

Review comment:
       We'll need to see how this renders in context -- we may need to make it clearer what this does




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

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] kaxil edited a comment on pull request #12271: Update example to use dag decorator tag

Posted by GitBox <gi...@apache.org>.
kaxil edited a comment on pull request #12271:
URL: https://github.com/apache/airflow/pull/12271#issuecomment-725049447


   Check this: https://airflow.readthedocs.io/en/latest/tutorial_taskflow_api.html
   
   and https://github.com/apache/airflow#getting-started for what is the difference between both doc sites


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

For queries about this service, please contact Infrastructure at:
users@infra.apache.org