| |
| |
| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>airflow.ti_deps.dep_context — Airflow Documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../../_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="../../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../search.html" /> |
| |
| <script> |
| document.addEventListener('DOMContentLoaded', function() { |
| var el = document.getElementById('changelog'); |
| if (el !== null ) { |
| // [AIRFLOW-...] |
| el.innerHTML = el.innerHTML.replace( |
| /\[(AIRFLOW-[\d]+)\]/g, |
| `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>` |
| ); |
| // (#...) |
| el.innerHTML = el.innerHTML.replace( |
| /\(#([\d]+)\)/g, |
| `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>` |
| ); |
| }; |
| }) |
| </script> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.3 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../cli.html">Command Line Interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../api.html">Experimental Rest API</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../_api/index.html">API Reference</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../../index.html">Airflow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../../index.html">Docs</a> »</li> |
| |
| <li><a href="../../index.html">Module code</a> »</li> |
| |
| <li>airflow.ti_deps.dep_context</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <h1>Source code for airflow.ti_deps.dep_context</h1><div class="highlight"><pre> |
| <span></span><span class="c1"># -*- coding: utf-8 -*-</span> |
| <span class="c1">#</span> |
| <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="c1"># or more contributor license agreements. See the NOTICE file</span> |
| <span class="c1"># distributed with this work for additional information</span> |
| <span class="c1"># regarding copyright ownership. The ASF licenses this file</span> |
| <span class="c1"># to you under the Apache License, Version 2.0 (the</span> |
| <span class="c1"># "License"); you may not use this file except in compliance</span> |
| <span class="c1"># with the License. You may obtain a copy of the License at</span> |
| <span class="c1">#</span> |
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="c1">#</span> |
| <span class="c1"># Unless required by applicable law or agreed to in writing,</span> |
| <span class="c1"># software distributed under the License is distributed on an</span> |
| <span class="c1"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span> |
| <span class="c1"># KIND, either express or implied. See the License for the</span> |
| <span class="c1"># specific language governing permissions and limitations</span> |
| <span class="c1"># under the License.</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow.ti_deps.deps.dag_ti_slots_available_dep</span> <span class="k">import</span> <span class="n">DagTISlotsAvailableDep</span> |
| <span class="kn">from</span> <span class="nn">airflow.ti_deps.deps.dag_unpaused_dep</span> <span class="k">import</span> <span class="n">DagUnpausedDep</span> |
| <span class="kn">from</span> <span class="nn">airflow.ti_deps.deps.dagrun_exists_dep</span> <span class="k">import</span> <span class="n">DagrunRunningDep</span> |
| <span class="kn">from</span> <span class="nn">airflow.ti_deps.deps.exec_date_after_start_date_dep</span> <span class="k">import</span> <span class="n">ExecDateAfterStartDateDep</span> |
| <span class="kn">from</span> <span class="nn">airflow.ti_deps.deps.not_running_dep</span> <span class="k">import</span> <span class="n">NotRunningDep</span> |
| <span class="kn">from</span> <span class="nn">airflow.ti_deps.deps.not_skipped_dep</span> <span class="k">import</span> <span class="n">NotSkippedDep</span> |
| <span class="kn">from</span> <span class="nn">airflow.ti_deps.deps.runnable_exec_date_dep</span> <span class="k">import</span> <span class="n">RunnableExecDateDep</span> |
| <span class="kn">from</span> <span class="nn">airflow.ti_deps.deps.valid_state_dep</span> <span class="k">import</span> <span class="n">ValidStateDep</span> |
| <span class="kn">from</span> <span class="nn">airflow.ti_deps.deps.task_concurrency_dep</span> <span class="k">import</span> <span class="n">TaskConcurrencyDep</span> |
| <span class="kn">from</span> <span class="nn">airflow.utils.state</span> <span class="k">import</span> <span class="n">State</span> |
| |
| |
| <div class="viewcode-block" id="DepContext"><a class="viewcode-back" href="../../../_api/airflow/models/index.html#airflow.models.DepContext">[docs]</a><span class="k">class</span> <span class="nc">DepContext</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> A base class for contexts that specifies which dependencies should be evaluated in</span> |
| <span class="sd"> the context for a task instance to satisfy the requirements of the context. Also</span> |
| <span class="sd"> stores state related to the context that can be used by dependency classes.</span> |
| |
| <span class="sd"> For example there could be a SomeRunContext that subclasses this class which has</span> |
| <span class="sd"> dependencies for:</span> |
| |
| <span class="sd"> - Making sure there are slots available on the infrastructure to run the task instance</span> |
| <span class="sd"> - A task-instance's task-specific dependencies are met (e.g. the previous task</span> |
| <span class="sd"> instance completed successfully)</span> |
| <span class="sd"> - ...</span> |
| |
| <span class="sd"> :param deps: The context-specific dependencies that need to be evaluated for a</span> |
| <span class="sd"> task instance to run in this execution context.</span> |
| <span class="sd"> :type deps: set(airflow.ti_deps.deps.base_ti_dep.BaseTIDep)</span> |
| <span class="sd"> :param flag_upstream_failed: This is a hack to generate the upstream_failed state</span> |
| <span class="sd"> creation while checking to see whether the task instance is runnable. It was the</span> |
| <span class="sd"> shortest path to add the feature. This is bad since this class should be pure (no</span> |
| <span class="sd"> side effects).</span> |
| <span class="sd"> :type flag_upstream_failed: bool</span> |
| <span class="sd"> :param ignore_all_deps: Whether or not the context should ignore all ignoreable</span> |
| <span class="sd"> dependencies. Overrides the other ignore_* parameters</span> |
| <span class="sd"> :type ignore_all_deps: bool</span> |
| <span class="sd"> :param ignore_depends_on_past: Ignore depends_on_past parameter of DAGs (e.g. for</span> |
| <span class="sd"> Backfills)</span> |
| <span class="sd"> :type ignore_depends_on_past: bool</span> |
| <span class="sd"> :param ignore_in_retry_period: Ignore the retry period for task instances</span> |
| <span class="sd"> :type ignore_in_retry_period: bool</span> |
| <span class="sd"> :param ignore_in_reschedule_period: Ignore the reschedule period for task instances</span> |
| <span class="sd"> :type ignore_in_reschedule_period: bool</span> |
| <span class="sd"> :param ignore_task_deps: Ignore task-specific dependencies such as depends_on_past and</span> |
| <span class="sd"> trigger rule</span> |
| <span class="sd"> :type ignore_task_deps: bool</span> |
| <span class="sd"> :param ignore_ti_state: Ignore the task instance's previous failure/success</span> |
| <span class="sd"> :type ignore_ti_state: bool</span> |
| <span class="sd"> """</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">deps</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">flag_upstream_failed</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">ignore_all_deps</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">ignore_depends_on_past</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">ignore_in_retry_period</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">ignore_in_reschedule_period</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">ignore_task_deps</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">ignore_ti_state</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">deps</span> <span class="o">=</span> <span class="n">deps</span> <span class="ow">or</span> <span class="nb">set</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">flag_upstream_failed</span> <span class="o">=</span> <span class="n">flag_upstream_failed</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">ignore_all_deps</span> <span class="o">=</span> <span class="n">ignore_all_deps</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">ignore_depends_on_past</span> <span class="o">=</span> <span class="n">ignore_depends_on_past</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">ignore_in_retry_period</span> <span class="o">=</span> <span class="n">ignore_in_retry_period</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">ignore_in_reschedule_period</span> <span class="o">=</span> <span class="n">ignore_in_reschedule_period</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">ignore_task_deps</span> <span class="o">=</span> <span class="n">ignore_task_deps</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">ignore_ti_state</span> <span class="o">=</span> <span class="n">ignore_ti_state</span></div> |
| |
| |
| <span class="c1"># In order to be able to get queued a task must have one of these states</span> |
| <span class="n">QUEUEABLE_STATES</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="n">State</span><span class="o">.</span><span class="n">FAILED</span><span class="p">,</span> |
| <span class="n">State</span><span class="o">.</span><span class="n">NONE</span><span class="p">,</span> |
| <span class="n">State</span><span class="o">.</span><span class="n">QUEUED</span><span class="p">,</span> |
| <span class="n">State</span><span class="o">.</span><span class="n">SCHEDULED</span><span class="p">,</span> |
| <span class="n">State</span><span class="o">.</span><span class="n">SKIPPED</span><span class="p">,</span> |
| <span class="n">State</span><span class="o">.</span><span class="n">UPSTREAM_FAILED</span><span class="p">,</span> |
| <span class="n">State</span><span class="o">.</span><span class="n">UP_FOR_RETRY</span><span class="p">,</span> |
| <span class="n">State</span><span class="o">.</span><span class="n">UP_FOR_RESCHEDULE</span><span class="p">,</span> |
| <span class="p">}</span> |
| |
| <span class="c1"># Context to get the dependencies that need to be met in order for a task instance to</span> |
| <span class="c1"># be backfilled.</span> |
| <div class="viewcode-block" id="QUEUE_DEPS"><a class="viewcode-back" href="../../../_api/airflow/models/index.html#airflow.models.QUEUE_DEPS">[docs]</a><span class="n">QUEUE_DEPS</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="n">NotRunningDep</span><span class="p">(),</span> |
| <span class="n">NotSkippedDep</span><span class="p">(),</span> |
| <span class="n">RunnableExecDateDep</span><span class="p">(),</span> |
| <span class="n">ValidStateDep</span><span class="p">(</span><span class="n">QUEUEABLE_STATES</span><span class="p">),</span></div> |
| <span class="p">}</span> |
| |
| <span class="c1"># Dependencies that need to be met for a given task instance to be able to get run by an</span> |
| <span class="c1"># executor. This class just extends QueueContext by adding dependencies for resources.</span> |
| <div class="viewcode-block" id="RUN_DEPS"><a class="viewcode-back" href="../../../_api/airflow/models/index.html#airflow.models.RUN_DEPS">[docs]</a><span class="n">RUN_DEPS</span> <span class="o">=</span> <span class="n">QUEUE_DEPS</span> <span class="o">|</span> <span class="p">{</span> |
| <span class="n">DagTISlotsAvailableDep</span><span class="p">(),</span> |
| <span class="n">TaskConcurrencyDep</span><span class="p">(),</span></div> |
| <span class="p">}</span> |
| |
| <span class="c1"># TODO(aoen): SCHEDULER_DEPS is not coupled to actual execution in any way and</span> |
| <span class="c1"># could easily be modified or removed from the scheduler causing this dependency to become</span> |
| <span class="c1"># outdated and incorrect. This coupling should be created (e.g. via a dag_deps analog of</span> |
| <span class="c1"># ti_deps that will be used in the scheduler code) to ensure that the logic here is</span> |
| <span class="c1"># equivalent to the logic in the scheduler.</span> |
| |
| <span class="c1"># Dependencies that need to be met for a given task instance to get scheduled by the</span> |
| <span class="c1"># scheduler, then queued by the scheduler, then run by an executor.</span> |
| <span class="n">SCHEDULER_DEPS</span> <span class="o">=</span> <span class="n">RUN_DEPS</span> <span class="o">|</span> <span class="p">{</span> |
| <span class="n">DagrunRunningDep</span><span class="p">(),</span> |
| <span class="n">DagUnpausedDep</span><span class="p">(),</span> |
| <span class="n">ExecDateAfterStartDateDep</span><span class="p">(),</span> |
| <span class="p">}</span> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
