blob: b8888eccee57f66e22ad01db3e8fb375a1a08328 [file] [log] [blame]
<!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.executors.base_executor &mdash; 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 &amp; 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> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li><a href="../executors.html">airflow.executors</a> &raquo;</li>
<li>airflow.executors.base_executor</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.executors.base_executor</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"># &quot;License&quot;); 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"># &quot;AS IS&quot; 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">builtins</span> <span class="k">import</span> <span class="nb">range</span>
<span class="kn">from</span> <span class="nn">collections</span> <span class="k">import</span> <span class="n">OrderedDict</span>
<span class="c1"># To avoid circular imports</span>
<span class="kn">import</span> <span class="nn">airflow.utils.dag_processing</span>
<span class="kn">from</span> <span class="nn">airflow</span> <span class="k">import</span> <span class="n">configuration</span>
<span class="kn">from</span> <span class="nn">airflow.settings</span> <span class="k">import</span> <span class="n">Stats</span>
<span class="kn">from</span> <span class="nn">airflow.utils.log.logging_mixin</span> <span class="k">import</span> <span class="n">LoggingMixin</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="PARALLELISM"><a class="viewcode-back" href="../../../_api/airflow/executors/base_executor/index.html#airflow.executors.base_executor.PARALLELISM">[docs]</a><span class="n">PARALLELISM</span> <span class="o">=</span> <span class="n">configuration</span><span class="o">.</span><span class="n">conf</span><span class="o">.</span><span class="n">getint</span><span class="p">(</span><span class="s1">&#39;core&#39;</span><span class="p">,</span> <span class="s1">&#39;PARALLELISM&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="BaseExecutor"><a class="viewcode-back" href="../../../_api/airflow/executors/index.html#airflow.executors.base_executor.BaseExecutor">[docs]</a><span class="k">class</span> <span class="nc">BaseExecutor</span><span class="p">(</span><span class="n">LoggingMixin</span><span class="p">):</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">parallelism</span><span class="o">=</span><span class="n">PARALLELISM</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Class to derive in order to interface with executor-type systems</span>
<span class="sd"> like Celery, Mesos, Yarn and the likes.</span>
<span class="sd"> :param parallelism: how many jobs should run at one time. Set to</span>
<span class="sd"> ``0`` for infinity</span>
<span class="sd"> :type parallelism: int</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parallelism</span> <span class="o">=</span> <span class="n">parallelism</span>
<span class="bp">self</span><span class="o">.</span><span class="n">queued_tasks</span> <span class="o">=</span> <span class="n">OrderedDict</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">running</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">event_buffer</span> <span class="o">=</span> <span class="p">{}</span>
<div class="viewcode-block" id="BaseExecutor.start"><a class="viewcode-back" href="../../../_api/airflow/executors/base_executor/index.html#airflow.executors.base_executor.BaseExecutor.start">[docs]</a> <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c1"># pragma: no cover</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Executors may need to get things started. For example LocalExecutor</span>
<span class="sd"> starts N workers.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="BaseExecutor.queue_command"><a class="viewcode-back" href="../../../_api/airflow/executors/base_executor/index.html#airflow.executors.base_executor.BaseExecutor.queue_command">[docs]</a> <span class="k">def</span> <span class="nf">queue_command</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">simple_task_instance</span><span class="p">,</span> <span class="n">command</span><span class="p">,</span> <span class="n">priority</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">queue</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">key</span> <span class="o">=</span> <span class="n">simple_task_instance</span><span class="o">.</span><span class="n">key</span>
<span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">queued_tasks</span> <span class="ow">and</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Adding to queue: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">command</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">queued_tasks</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">priority</span><span class="p">,</span> <span class="n">queue</span><span class="p">,</span> <span class="n">simple_task_instance</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;could not queue task </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">key</span><span class="p">)</span></div>
<div class="viewcode-block" id="BaseExecutor.queue_task_instance"><a class="viewcode-back" href="../../../_api/airflow/executors/base_executor/index.html#airflow.executors.base_executor.BaseExecutor.queue_task_instance">[docs]</a> <span class="k">def</span> <span class="nf">queue_task_instance</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">task_instance</span><span class="p">,</span>
<span class="n">mark_success</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">pickle_id</span><span class="o">=</span><span class="kc">None</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_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="n">pool</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">cfg_path</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">pool</span> <span class="o">=</span> <span class="n">pool</span> <span class="ow">or</span> <span class="n">task_instance</span><span class="o">.</span><span class="n">pool</span>
<span class="c1"># TODO (edgarRd): AIRFLOW-1985:</span>
<span class="c1"># cfg_path is needed to propagate the config values if using impersonation</span>
<span class="c1"># (run_as_user), given that there are different code paths running tasks.</span>
<span class="c1"># For a long term solution we need to address AIRFLOW-1986</span>
<span class="n">command</span> <span class="o">=</span> <span class="n">task_instance</span><span class="o">.</span><span class="n">command_as_list</span><span class="p">(</span>
<span class="n">local</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">mark_success</span><span class="o">=</span><span class="n">mark_success</span><span class="p">,</span>
<span class="n">ignore_all_deps</span><span class="o">=</span><span class="n">ignore_all_deps</span><span class="p">,</span>
<span class="n">ignore_depends_on_past</span><span class="o">=</span><span class="n">ignore_depends_on_past</span><span class="p">,</span>
<span class="n">ignore_task_deps</span><span class="o">=</span><span class="n">ignore_task_deps</span><span class="p">,</span>
<span class="n">ignore_ti_state</span><span class="o">=</span><span class="n">ignore_ti_state</span><span class="p">,</span>
<span class="n">pool</span><span class="o">=</span><span class="n">pool</span><span class="p">,</span>
<span class="n">pickle_id</span><span class="o">=</span><span class="n">pickle_id</span><span class="p">,</span>
<span class="n">cfg_path</span><span class="o">=</span><span class="n">cfg_path</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">queue_command</span><span class="p">(</span>
<span class="n">airflow</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">dag_processing</span><span class="o">.</span><span class="n">SimpleTaskInstance</span><span class="p">(</span><span class="n">task_instance</span><span class="p">),</span>
<span class="n">command</span><span class="p">,</span>
<span class="n">priority</span><span class="o">=</span><span class="n">task_instance</span><span class="o">.</span><span class="n">task</span><span class="o">.</span><span class="n">priority_weight_total</span><span class="p">,</span>
<span class="n">queue</span><span class="o">=</span><span class="n">task_instance</span><span class="o">.</span><span class="n">task</span><span class="o">.</span><span class="n">queue</span><span class="p">)</span></div>
<div class="viewcode-block" id="BaseExecutor.has_task"><a class="viewcode-back" href="../../../_api/airflow/executors/base_executor/index.html#airflow.executors.base_executor.BaseExecutor.has_task">[docs]</a> <span class="k">def</span> <span class="nf">has_task</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">task_instance</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Checks if a task is either queued or running in this executor</span>
<span class="sd"> :param task_instance: TaskInstance</span>
<span class="sd"> :return: True if the task is known to this executor</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">task_instance</span><span class="o">.</span><span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">queued_tasks</span> <span class="ow">or</span> <span class="n">task_instance</span><span class="o">.</span><span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="BaseExecutor.sync"><a class="viewcode-back" href="../../../_api/airflow/executors/base_executor/index.html#airflow.executors.base_executor.BaseExecutor.sync">[docs]</a> <span class="k">def</span> <span class="nf">sync</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Sync will get called periodically by the heartbeat method.</span>
<span class="sd"> Executors should override this to perform gather statuses.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="BaseExecutor.heartbeat"><a class="viewcode-back" href="../../../_api/airflow/executors/base_executor/index.html#airflow.executors.base_executor.BaseExecutor.heartbeat">[docs]</a> <span class="k">def</span> <span class="nf">heartbeat</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Triggering new jobs</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">parallelism</span><span class="p">:</span>
<span class="n">open_slots</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">queued_tasks</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">open_slots</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parallelism</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="p">)</span>
<span class="n">num_running_tasks</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="p">)</span>
<span class="n">num_queued_tasks</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">queued_tasks</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> running task instances&quot;</span><span class="p">,</span> <span class="n">num_running_tasks</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> in queue&quot;</span><span class="p">,</span> <span class="n">num_queued_tasks</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> open slots&quot;</span><span class="p">,</span> <span class="n">open_slots</span><span class="p">)</span>
<span class="n">Stats</span><span class="o">.</span><span class="n">gauge</span><span class="p">(</span><span class="s1">&#39;executor.open_slots&#39;</span><span class="p">,</span> <span class="n">open_slots</span><span class="p">)</span>
<span class="n">Stats</span><span class="o">.</span><span class="n">gauge</span><span class="p">(</span><span class="s1">&#39;executor.queued_tasks&#39;</span><span class="p">,</span> <span class="n">num_queued_tasks</span><span class="p">)</span>
<span class="n">Stats</span><span class="o">.</span><span class="n">gauge</span><span class="p">(</span><span class="s1">&#39;executor.running_tasks&#39;</span><span class="p">,</span> <span class="n">num_running_tasks</span><span class="p">)</span>
<span class="n">sorted_queue</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span>
<span class="p">[(</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">queued_tasks</span><span class="o">.</span><span class="n">items</span><span class="p">()],</span>
<span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">[</span><span class="mi">1</span><span class="p">][</span><span class="mi">1</span><span class="p">],</span>
<span class="n">reverse</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">min</span><span class="p">((</span><span class="n">open_slots</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">queued_tasks</span><span class="p">)))):</span>
<span class="n">key</span><span class="p">,</span> <span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">queue</span><span class="p">,</span> <span class="n">simple_ti</span><span class="p">)</span> <span class="o">=</span> <span class="n">sorted_queue</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">queued_tasks</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">command</span>
<span class="bp">self</span><span class="o">.</span><span class="n">execute_async</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="n">key</span><span class="p">,</span>
<span class="n">command</span><span class="o">=</span><span class="n">command</span><span class="p">,</span>
<span class="n">queue</span><span class="o">=</span><span class="n">queue</span><span class="p">,</span>
<span class="n">executor_config</span><span class="o">=</span><span class="n">simple_ti</span><span class="o">.</span><span class="n">executor_config</span><span class="p">)</span>
<span class="c1"># Calling child class sync method</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Calling the </span><span class="si">%s</span><span class="s2"> sync method&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sync</span><span class="p">()</span></div>
<div class="viewcode-block" id="BaseExecutor.change_state"><a class="viewcode-back" href="../../../_api/airflow/executors/base_executor/index.html#airflow.executors.base_executor.BaseExecutor.change_state">[docs]</a> <span class="k">def</span> <span class="nf">change_state</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">state</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Changing state: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">key</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">event_buffer</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">state</span></div>
<div class="viewcode-block" id="BaseExecutor.fail"><a class="viewcode-back" href="../../../_api/airflow/executors/base_executor/index.html#airflow.executors.base_executor.BaseExecutor.fail">[docs]</a> <span class="k">def</span> <span class="nf">fail</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">change_state</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">State</span><span class="o">.</span><span class="n">FAILED</span><span class="p">)</span></div>
<div class="viewcode-block" id="BaseExecutor.success"><a class="viewcode-back" href="../../../_api/airflow/executors/base_executor/index.html#airflow.executors.base_executor.BaseExecutor.success">[docs]</a> <span class="k">def</span> <span class="nf">success</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">change_state</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">State</span><span class="o">.</span><span class="n">SUCCESS</span><span class="p">)</span></div>
<div class="viewcode-block" id="BaseExecutor.get_event_buffer"><a class="viewcode-back" href="../../../_api/airflow/executors/base_executor/index.html#airflow.executors.base_executor.BaseExecutor.get_event_buffer">[docs]</a> <span class="k">def</span> <span class="nf">get_event_buffer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dag_ids</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns and flush the event buffer. In case dag_ids is specified</span>
<span class="sd"> it will only return and flush events for the given dag_ids. Otherwise</span>
<span class="sd"> it returns and flushes all</span>
<span class="sd"> :param dag_ids: to dag_ids to return events for, if None returns all</span>
<span class="sd"> :return: a dict of events</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">cleared_events</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="k">if</span> <span class="n">dag_ids</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">cleared_events</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">event_buffer</span>
<span class="bp">self</span><span class="o">.</span><span class="n">event_buffer</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">event_buffer</span><span class="o">.</span><span class="n">keys</span><span class="p">()):</span>
<span class="n">dag_id</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">key</span>
<span class="k">if</span> <span class="n">dag_id</span> <span class="ow">in</span> <span class="n">dag_ids</span><span class="p">:</span>
<span class="n">cleared_events</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">event_buffer</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
<span class="k">return</span> <span class="n">cleared_events</span></div>
<div class="viewcode-block" id="BaseExecutor.execute_async"><a class="viewcode-back" href="../../../_api/airflow/executors/base_executor/index.html#airflow.executors.base_executor.BaseExecutor.execute_async">[docs]</a> <span class="k">def</span> <span class="nf">execute_async</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">key</span><span class="p">,</span>
<span class="n">command</span><span class="p">,</span>
<span class="n">queue</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">executor_config</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="c1"># pragma: no cover</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This method will execute the command asynchronously.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="BaseExecutor.end"><a class="viewcode-back" href="../../../_api/airflow/executors/base_executor/index.html#airflow.executors.base_executor.BaseExecutor.end">[docs]</a> <span class="k">def</span> <span class="nf">end</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c1"># pragma: no cover</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This method is called when the caller is done submitting job and is</span>
<span class="sd"> wants to wait synchronously for the job submitted previously to be</span>
<span class="sd"> all done.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="BaseExecutor.terminate"><a class="viewcode-back" href="../../../_api/airflow/executors/base_executor/index.html#airflow.executors.base_executor.BaseExecutor.terminate">[docs]</a> <span class="k">def</span> <span class="nf">terminate</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This method is called when the daemon receives a SIGTERM</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
</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>