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/04/27 09:58:02 UTC

[GitHub] [airflow] jonathanshir opened a new pull request #8580: Implement airflow lazy execution context retrieval

jonathanshir opened a new pull request #8580:
URL: https://github.com/apache/airflow/pull/8580


   Description: Allow users to access airflow's execution context without altering their function signature, in a lazy and comfortable way.
   Github Issue: https://github.com/apache/airflow/issues/8058 #8058 
   ---
   Make sure to mark the boxes below before creating PR: [x]
   
   - [ ] Description above provides context of the change
   - [ ] Unit tests coverage for changes (not needed for documentation changes)
   - [ ] Target Github ISSUE in description if exists
   - [ ] Commits follow "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
   - [ ] Relevant documentation is updated including usage instructions.
   - [ ] I will engage committers as explained in [Contribution Workflow Example](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#contribution-workflow-example).
   
   ---
   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).
   Read the [Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines) for more information.
   


----------------------------------------------------------------
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] mik-laj commented on a change in pull request #8580: Implement airflow lazy execution context retrieval

Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #8580:
URL: https://github.com/apache/airflow/pull/8580#discussion_r415688916



##########
File path: airflow/task/context/execution_context.py
##########
@@ -0,0 +1,83 @@
+# 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.
+
+from types import ModuleType
+from typing import Any, NamedTuple
+
+from pendulum import Pendulum
+
+from airflow.exceptions import AirflowException
+
+
+class ExecutionContext(NamedTuple):
+    """
+    Defines all stateful properties during execution.
+    This context can be passed to any task either via task.context.current.get_current_context, or via
+    requesting specific properties through the task's ctor, as in:
+
+        def f(execution_date):
+            print(execution_date) # This property is filled automatically by airflow
+    """
+    conf: Any
+    dag: Any
+    dag_run: str
+    ds: str
+    ds_nodash: str
+    execution_date: Pendulum
+    inlets: list
+    macros: ModuleType
+    next_ds: str
+    next_ds_nodash: str
+    next_execution_date: Pendulum
+    outlets: list
+    params: dict
+    prev_ds: str
+    prev_ds_nodash: str
+    prev_execution_date: Pendulum
+    prev_execution_date_success: Pendulum
+    prev_start_date_success: Pendulum
+    run_id: str
+    task: Any
+    task_instance: Any
+    task_instance_key_str: str
+    test_mode: bool
+    ti: Any
+    tomorrow_ds: str
+    tomorrow_ds_nodash: str
+    ts: str
+    ts_nodash: str
+    ts_nodash_with_tz: str
+    var: dict
+    yesterday_ds: str
+    yesterday_ds_nodash: str
+
+    def __getitem__(self, *args, **kwargs):
+        """
+        Allow slicing syntax for backwards compatibility to old-style context (dict access style)
+        """
+        if len(args) == 1 and isinstance(args[0], str):
+            return getattr(self, args[0])
+        raise AirflowException("Can only retrieve execution context properties via single string argument")
+
+    def get(self, key):
+        """
+        Retrieve property via key (dict access style)

Review comment:
       ```suggestion
           Retrieve property via attribute (object access style)
   ```




----------------------------------------------------------------
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] jonathanshir commented on pull request #8580: Implement airflow lazy execution context retrieval

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


   hey, I am going to remove ExecutionContext named tuple ( move it to separate MR) and force push  this commit again


----------------------------------------------------------------
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 #8580: Implement airflow lazy execution context retrieval

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


   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.
   - 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://apache-airflow-slack.herokuapp.com/
   


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