| |
| |
| |
| |
| |
| <!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.local_executor — 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> |
| <script type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-140539454-1']); |
| _gaq.push(['_trackPageview']); |
| </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.5 |
| </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 Reference</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">REST API Reference</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">Python API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../privacy_notice.html">Privacy Notice</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><a href="../executors.html">airflow.executors</a> »</li> |
| |
| <li>airflow.executors.local_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.local_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"># "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="sd">"""</span> |
| <span class="sd">LocalExecutor runs tasks by spawning processes in a controlled fashion in different</span> |
| <span class="sd">modes. Given that BaseExecutor has the option to receive a `parallelism` parameter to</span> |
| <span class="sd">limit the number of process spawned, when this parameter is `0` the number of processes</span> |
| <span class="sd">that LocalExecutor can spawn is unlimited.</span> |
| |
| <span class="sd">The following strategies are implemented:</span> |
| <span class="sd">1. Unlimited Parallelism (self.parallelism == 0): In this strategy, LocalExecutor will</span> |
| <span class="sd">spawn a process every time `execute_async` is called, that is, every task submitted to the</span> |
| <span class="sd">LocalExecutor will be executed in its own process. Once the task is executed and the</span> |
| <span class="sd">result stored in the `result_queue`, the process terminates. There is no need for a</span> |
| <span class="sd">`task_queue` in this approach, since as soon as a task is received a new process will be</span> |
| <span class="sd">allocated to the task. Processes used in this strategy are of class LocalWorker.</span> |
| |
| <span class="sd">2. Limited Parallelism (self.parallelism > 0): In this strategy, the LocalExecutor spawns</span> |
| <span class="sd">the number of processes equal to the value of `self.parallelism` at `start` time,</span> |
| <span class="sd">using a `task_queue` to coordinate the ingestion of tasks and the work distribution among</span> |
| <span class="sd">the workers, which will take a task as soon as they are ready. During the lifecycle of</span> |
| <span class="sd">the LocalExecutor, the worker processes are running waiting for tasks, once the</span> |
| <span class="sd">LocalExecutor receives the call to shutdown the executor a poison token is sent to the</span> |
| <span class="sd">workers to terminate them. Processes used in this strategy are of class QueuedLocalWorker.</span> |
| |
| <span class="sd">Arguably, `SequentialExecutor` could be thought as a LocalExecutor with limited</span> |
| <span class="sd">parallelism of just 1 worker, i.e. `self.parallelism = 1`.</span> |
| <span class="sd">This option could lead to the unification of the executor implementations, running</span> |
| <span class="sd">locally, into just one `LocalExecutor` with multiple modes.</span> |
| <span class="sd">"""</span> |
| |
| <span class="kn">import</span> <span class="nn">multiprocessing</span> |
| <span class="kn">import</span> <span class="nn">subprocess</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">queue</span> <span class="k">import</span> <span class="n">Empty</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow.executors.base_executor</span> <span class="k">import</span> <span class="n">BaseExecutor</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="LocalWorker"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalWorker">[docs]</a><span class="k">class</span> <span class="nc">LocalWorker</span><span class="p">(</span><span class="n">multiprocessing</span><span class="o">.</span><span class="n">Process</span><span class="p">,</span> <span class="n">LoggingMixin</span><span class="p">):</span> |
| |
| <span class="sd">"""LocalWorker Process implementation to run airflow commands. Executes the given</span> |
| <span class="sd"> command and puts the result into a result queue when done, terminating execution."""</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">result_queue</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> :param result_queue: the queue to store result states tuples (key, State)</span> |
| <span class="sd"> :type result_queue: multiprocessing.Queue</span> |
| <span class="sd"> """</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">LocalWorker</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">daemon</span> <span class="o">=</span> <span class="kc">True</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">result_queue</span> <span class="o">=</span> <span class="n">result_queue</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">key</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">command</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <div class="viewcode-block" id="LocalWorker.execute_work"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalWorker.execute_work">[docs]</a> <span class="k">def</span> <span class="nf">execute_work</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="sd">"""</span> |
| <span class="sd"> Executes command received and stores result state in queue.</span> |
| <span class="sd"> :param key: the key to identify the TI</span> |
| <span class="sd"> :type key: tuple(dag_id, task_id, execution_date)</span> |
| <span class="sd"> :param command: the command to execute</span> |
| <span class="sd"> :type command: str</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="n">key</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">return</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">"</span><span class="si">%s</span><span class="s2"> running </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="n">command</span><span class="p">)</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">subprocess</span><span class="o">.</span><span class="n">check_call</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">close_fds</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> |
| <span class="n">state</span> <span class="o">=</span> <span class="n">State</span><span class="o">.</span><span class="n">SUCCESS</span> |
| <span class="k">except</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">CalledProcessError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="n">state</span> <span class="o">=</span> <span class="n">State</span><span class="o">.</span><span class="n">FAILED</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"Failed to execute task </span><span class="si">%s</span><span class="s2">."</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span> |
| <span class="c1"># TODO: Why is this commented out?</span> |
| <span class="c1"># raise e</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">result_queue</span><span class="o">.</span><span class="n">put</span><span class="p">((</span><span class="n">key</span><span class="p">,</span> <span class="n">state</span><span class="p">))</span></div> |
| |
| <div class="viewcode-block" id="LocalWorker.run"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalWorker.run">[docs]</a> <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">execute_work</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="QueuedLocalWorker"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.QueuedLocalWorker">[docs]</a><span class="k">class</span> <span class="nc">QueuedLocalWorker</span><span class="p">(</span><span class="n">LocalWorker</span><span class="p">):</span> |
| |
| <span class="sd">"""LocalWorker implementation that is waiting for tasks from a queue and will</span> |
| <span class="sd"> continue executing commands as they become available in the queue. It will terminate</span> |
| <span class="sd"> execution once the poison token is found."""</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">task_queue</span><span class="p">,</span> <span class="n">result_queue</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">QueuedLocalWorker</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">result_queue</span><span class="o">=</span><span class="n">result_queue</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">task_queue</span> <span class="o">=</span> <span class="n">task_queue</span> |
| |
| <div class="viewcode-block" id="QueuedLocalWorker.run"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.QueuedLocalWorker.run">[docs]</a> <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> |
| <span class="n">key</span><span class="p">,</span> <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">task_queue</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">key</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="c1"># Received poison pill, no more tasks to run</span> |
| <span class="k">break</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">execute_work</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="k">finally</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">task_queue</span><span class="o">.</span><span class="n">task_done</span><span class="p">()</span></div></div> |
| |
| |
| <div class="viewcode-block" id="LocalExecutor"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalExecutor">[docs]</a><span class="k">class</span> <span class="nc">LocalExecutor</span><span class="p">(</span><span class="n">BaseExecutor</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> LocalExecutor executes tasks locally in parallel. It uses the</span> |
| <span class="sd"> multiprocessing Python library and queues to parallelize the execution</span> |
| <span class="sd"> of tasks.</span> |
| <span class="sd"> """</span> |
| |
| <div class="viewcode-block" id="LocalExecutor._UnlimitedParallelism"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalExecutor._UnlimitedParallelism">[docs]</a> <span class="k">class</span> <span class="nc">_UnlimitedParallelism</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Implements LocalExecutor with unlimited parallelism, starting one process</span> |
| <span class="sd"> per each command to execute."""</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">executor</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> :param executor: the executor instance to implement.</span> |
| <span class="sd"> :type executor: LocalExecutor</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">executor</span> <span class="o">=</span> <span class="n">executor</span> |
| |
| <div class="viewcode-block" id="LocalExecutor._UnlimitedParallelism.start"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalExecutor._UnlimitedParallelism.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="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">workers_used</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">workers_active</span> <span class="o">=</span> <span class="mi">0</span></div> |
| |
| <div class="viewcode-block" id="LocalExecutor._UnlimitedParallelism.execute_async"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalExecutor._UnlimitedParallelism.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="sd">"""</span> |
| <span class="sd"> :param key: the key to identify the TI</span> |
| <span class="sd"> :type key: tuple(dag_id, task_id, execution_date)</span> |
| <span class="sd"> :param command: the command to execute</span> |
| <span class="sd"> :type command: str</span> |
| <span class="sd"> """</span> |
| <span class="n">local_worker</span> <span class="o">=</span> <span class="n">LocalWorker</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">result_queue</span><span class="p">)</span> |
| <span class="n">local_worker</span><span class="o">.</span><span class="n">key</span> <span class="o">=</span> <span class="n">key</span> |
| <span class="n">local_worker</span><span class="o">.</span><span class="n">command</span> <span class="o">=</span> <span class="n">command</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">workers_used</span> <span class="o">+=</span> <span class="mi">1</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">workers_active</span> <span class="o">+=</span> <span class="mi">1</span> |
| <span class="n">local_worker</span><span class="o">.</span><span class="n">start</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="LocalExecutor._UnlimitedParallelism.sync"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalExecutor._UnlimitedParallelism.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="k">while</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">result_queue</span><span class="o">.</span><span class="n">empty</span><span class="p">():</span> |
| <span class="n">results</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">result_queue</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">change_state</span><span class="p">(</span><span class="o">*</span><span class="n">results</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">workers_active</span> <span class="o">-=</span> <span class="mi">1</span></div> |
| |
| <div class="viewcode-block" id="LocalExecutor._UnlimitedParallelism.end"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalExecutor._UnlimitedParallelism.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="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">workers_active</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">sync</span><span class="p">()</span></div></div> |
| |
| <div class="viewcode-block" id="LocalExecutor._LimitedParallelism"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalExecutor._LimitedParallelism">[docs]</a> <span class="k">class</span> <span class="nc">_LimitedParallelism</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""Implements LocalExecutor with limited parallelism using a task queue to</span> |
| <span class="sd"> coordinate work distribution."""</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">executor</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">executor</span> <span class="o">=</span> <span class="n">executor</span> |
| |
| <div class="viewcode-block" id="LocalExecutor._LimitedParallelism.start"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalExecutor._LimitedParallelism.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="bp">self</span><span class="o">.</span><span class="n">queue</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">manager</span><span class="o">.</span><span class="n">Queue</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">workers</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="n">QueuedLocalWorker</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">queue</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">result_queue</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">parallelism</span><span class="p">)</span> |
| <span class="p">]</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">workers_used</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">executor</span><span class="o">.</span><span class="n">workers</span><span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">w</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">workers</span><span class="p">:</span> |
| <span class="n">w</span><span class="o">.</span><span class="n">start</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="LocalExecutor._LimitedParallelism.execute_async"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalExecutor._LimitedParallelism.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="sd">"""</span> |
| <span class="sd"> :param key: the key to identify the TI</span> |
| <span class="sd"> :type key: tuple(dag_id, task_id, execution_date)</span> |
| <span class="sd"> :param command: the command to execute</span> |
| <span class="sd"> :type command: str</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">queue</span><span class="o">.</span><span class="n">put</span><span class="p">((</span><span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">))</span></div> |
| |
| <div class="viewcode-block" id="LocalExecutor._LimitedParallelism.sync"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalExecutor._LimitedParallelism.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="k">while</span> <span class="kc">True</span><span class="p">:</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">results</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">result_queue</span><span class="o">.</span><span class="n">get_nowait</span><span class="p">()</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">change_state</span><span class="p">(</span><span class="o">*</span><span class="n">results</span><span class="p">)</span> |
| <span class="k">finally</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">result_queue</span><span class="o">.</span><span class="n">task_done</span><span class="p">()</span> |
| <span class="k">except</span> <span class="n">Empty</span><span class="p">:</span> |
| <span class="k">break</span></div> |
| |
| <div class="viewcode-block" id="LocalExecutor._LimitedParallelism.end"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalExecutor._LimitedParallelism.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"># Sending poison pill to all worker</span> |
| <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">workers</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">queue</span><span class="o">.</span><span class="n">put</span><span class="p">((</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span> |
| |
| <span class="c1"># Wait for commands to finish</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">queue</span><span class="o">.</span><span class="n">join</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">executor</span><span class="o">.</span><span class="n">sync</span><span class="p">()</span></div></div> |
| |
| <div class="viewcode-block" id="LocalExecutor.start"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalExecutor.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="bp">self</span><span class="o">.</span><span class="n">manager</span> <span class="o">=</span> <span class="n">multiprocessing</span><span class="o">.</span><span class="n">Manager</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">result_queue</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">manager</span><span class="o">.</span><span class="n">Queue</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">workers</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">workers_used</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">workers_active</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">impl</span> <span class="o">=</span> <span class="p">(</span><span class="n">LocalExecutor</span><span class="o">.</span><span class="n">_UnlimitedParallelism</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">parallelism</span> <span class="o">==</span> <span class="mi">0</span> |
| <span class="k">else</span> <span class="n">LocalExecutor</span><span class="o">.</span><span class="n">_LimitedParallelism</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">impl</span><span class="o">.</span><span class="n">start</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="LocalExecutor.execute_async"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalExecutor.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="bp">self</span><span class="o">.</span><span class="n">impl</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></div> |
| |
| <div class="viewcode-block" id="LocalExecutor.sync"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalExecutor.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="bp">self</span><span class="o">.</span><span class="n">impl</span><span class="o">.</span><span class="n">sync</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="LocalExecutor.end"><a class="viewcode-back" href="../../../_api/airflow/executors/local_executor/index.html#airflow.executors.LocalExecutor.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="bp">self</span><span class="o">.</span><span class="n">impl</span><span class="o">.</span><span class="n">end</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">manager</span><span class="o">.</span><span class="n">shutdown</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>. |
| <div class="footer">This page uses <a href="https://analytics.google.com/"> |
| Google Analytics</a> to collect statistics. You can disable it by blocking |
| the JavaScript coming from www.google-analytics.com. Check our |
| <a href="../../../privacy_notice.html">Privacy Policy</a> |
| for more details. |
| <script type="text/javascript"> |
| (function() { |
| var ga = document.createElement('script'); |
| ga.src = ('https:' == document.location.protocol ? |
| 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| ga.setAttribute('async', 'true'); |
| var nodes = document.documentElement.childNodes; |
| var i = -1; |
| var node; |
| do { |
| i++; |
| node = nodes[i] |
| } while(node.nodeType !== Node.ELEMENT_NODE); |
| node.appendChild(ga); |
| })(); |
| </script> |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
