You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "erik-farmer (via GitHub)" <gi...@apache.org> on 2023/10/18 18:58:29 UTC

[PR] Update datasets.rst issue with running example code [airflow]

erik-farmer opened a new pull request, #35035:
URL: https://github.com/apache/airflow/pull/35035

   Fixes two small issues with running code from the dataset.rst example.
   
   `dataset_list` is a list so running `print(dataset, dataset_list, dataset_list[dataset])` causes a `TypeError: list indices must be integers or slices, not str`
   
   Additionally the attribute name should be `dag_id` and not `dag_run_id`
   
   <!--
    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/
   -->
   
   
   
   <!-- 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.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


Re: [PR] Update datasets.rst issue with running example code [airflow]

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


-- 
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 datasets.rst issue with running example code [airflow]

Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #35035:
URL: https://github.com/apache/airflow/pull/35035#issuecomment-1769142109

   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/main/CONTRIBUTING.rst)
   Here are some useful points:
   - Pay attention to the quality of your code (ruff, mypy and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/main/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/main/docs/apache-airflow/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/main/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/main/CONTRIBUTING.rst#coding-style-and-best-practices).
   - Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
   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.

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 datasets.rst issue with running example code [airflow]

Posted by "erik-farmer (via GitHub)" <gi...@apache.org>.
erik-farmer commented on code in PR #35035:
URL: https://github.com/apache/airflow/pull/35035#discussion_r1364433952


##########
docs/apache-airflow/authoring-and-scheduling/datasets.rst:
##########
@@ -230,8 +230,8 @@ Example:
         @task
         def print_triggering_dataset_events(triggering_dataset_events=None):
             for dataset, dataset_list in triggering_dataset_events.items():
-                print(dataset, dataset_list, dataset_list[dataset])
-                print(dataset_list[dataset][0].source_dag_run.dag_run_id)
+                print(dataset, dataset_list)
+                print(dataset_list[0].source_dag_run.dag_id)

Review Comment:
   Both are correct:
   
   Running:
   ```
           for dataset, dataset_list in triggering_dataset_events.items():
               print(dataset, dataset_list)
               print(f"{dataset_list[0].source_dag_run.dag_id=}")
               print(f"{dataset_list[0].source_dag_id=}")
   ```
   
   results in:
   
   ```
   [2023-10-18, 19:34:38 UTC] {logging_mixin.py:151} INFO - local://some_file.txt [DatasetEvent(id=6, dataset_id=6, extra={}, source_task_id='producer_task', source_dag_id='producer_dag', source_run_id='manual__2023-10-18T19:34:37.507108+00:00', source_map_index=-1)]
   [2023-10-18, 19:34:38 UTC] {logging_mixin.py:151} INFO - dataset_list[0].source_dag_run.dag_id='producer_dag'
   [2023-10-18, 19:34:38 UTC] {logging_mixin.py:151} INFO - dataset_list[0].source_dag_id='producer_dag'
   ```
   
   (Granted my test dag is `producer_dag` and not `load_snowflake_data` from the demo.
   
   I'm open to either but I like showing `source_dag_run` because it can also hint at getting items like. `source_dag_run.data_interval_start` which could be useful for the consumer dag



-- 
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 datasets.rst issue with running example code [airflow]

Posted by "erik-farmer (via GitHub)" <gi...@apache.org>.
erik-farmer commented on code in PR #35035:
URL: https://github.com/apache/airflow/pull/35035#discussion_r1364433952


##########
docs/apache-airflow/authoring-and-scheduling/datasets.rst:
##########
@@ -230,8 +230,8 @@ Example:
         @task
         def print_triggering_dataset_events(triggering_dataset_events=None):
             for dataset, dataset_list in triggering_dataset_events.items():
-                print(dataset, dataset_list, dataset_list[dataset])
-                print(dataset_list[dataset][0].source_dag_run.dag_run_id)
+                print(dataset, dataset_list)
+                print(dataset_list[0].source_dag_run.dag_id)

Review Comment:
   Both are correct:
   
   Running:
   ```
           for dataset, dataset_list in triggering_dataset_events.items():
               print(dataset, dataset_list)
               print(f"{dataset_list[0].source_dag_run.dag_id=}")
               print(f"{dataset_list[0].source_dag_id=}")
   ```
   
   results in:
   
   ```
   [2023-10-18, 19:34:38 UTC] {logging_mixin.py:151} INFO - local://some_file.txt [DatasetEvent(id=6, dataset_id=6, extra={}, source_task_id='producer_task', source_dag_id='producer_dag', source_run_id='manual__2023-10-18T19:34:37.507108+00:00', source_map_index=-1)]
   [2023-10-18, 19:34:38 UTC] {logging_mixin.py:151} INFO - dataset_list[0].source_dag_run.dag_id='producer_dag'
   [2023-10-18, 19:34:38 UTC] {logging_mixin.py:151} INFO - dataset_list[0].source_dag_id='producer_dag'
   ```
   
   (Granted my test dag is `producer_dag` and not `load_snowflake_data` from the demo



-- 
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 datasets.rst issue with running example code [airflow]

Posted by "jens-scheffler-bosch (via GitHub)" <gi...@apache.org>.
jens-scheffler-bosch commented on code in PR #35035:
URL: https://github.com/apache/airflow/pull/35035#discussion_r1364482519


##########
docs/apache-airflow/authoring-and-scheduling/datasets.rst:
##########
@@ -230,8 +230,8 @@ Example:
         @task
         def print_triggering_dataset_events(triggering_dataset_events=None):
             for dataset, dataset_list in triggering_dataset_events.items():
-                print(dataset, dataset_list, dataset_list[dataset])
-                print(dataset_list[dataset][0].source_dag_run.dag_run_id)
+                print(dataset, dataset_list)
+                print(dataset_list[0].source_dag_run.dag_id)

Review Comment:
   Aaah, yes, you are right. I over-looked /home/jscheffl/Workspace/airflow/airflow/models/dataset.py:304 where the relation is modelled. Danger-zone is that from typing it can be also class of type `DatasetEventPydantic` if airflow switches to use internal API and this does not carry the relation parameter. Internal API is coming, adding a bit of more API complexity here for the future benefit of multi tenancy.



-- 
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 datasets.rst issue with running example code [airflow]

Posted by "jens-scheffler-bosch (via GitHub)" <gi...@apache.org>.
jens-scheffler-bosch commented on code in PR #35035:
URL: https://github.com/apache/airflow/pull/35035#discussion_r1364414728


##########
docs/apache-airflow/authoring-and-scheduling/datasets.rst:
##########
@@ -230,8 +230,8 @@ Example:
         @task
         def print_triggering_dataset_events(triggering_dataset_events=None):
             for dataset, dataset_list in triggering_dataset_events.items():
-                print(dataset, dataset_list, dataset_list[dataset])
-                print(dataset_list[dataset][0].source_dag_run.dag_run_id)
+                print(dataset, dataset_list)
+                print(dataset_list[0].source_dag_run.dag_id)

Review Comment:
   Checking the signature of `triggering_dataset_events` in airflow/utils/context.pyi is defined with typing `Mapping[str, Collection[DatasetEvent | DatasetEventPydantic]]`.
   
   I assume the example is also after correction not correct, it rather needs to be (see airflow/models/dataset.py:275):
   ```suggestion
                   print(dataset_list[0].source_dag_id)
   ```



-- 
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 datasets.rst issue with running example code [airflow]

Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #35035:
URL: https://github.com/apache/airflow/pull/35035#issuecomment-1780816125

   Awesome work, congrats on your first merged pull request! You are invited to check our [Issue Tracker](https://github.com/apache/airflow/issues) for additional 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.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

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