| |
| |
| |
| |
| <!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.models.xcom — 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.4 |
| </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><a href="../models.html">airflow.models</a> »</li> |
| |
| <li>airflow.models.xcom</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.models.xcom</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">import</span> <span class="nn">json</span> |
| <span class="kn">import</span> <span class="nn">pickle</span> |
| |
| <span class="kn">from</span> <span class="nn">sqlalchemy</span> <span class="k">import</span> <span class="n">Column</span><span class="p">,</span> <span class="n">Integer</span><span class="p">,</span> <span class="n">String</span><span class="p">,</span> <span class="n">Index</span><span class="p">,</span> <span class="n">LargeBinary</span><span class="p">,</span> <span class="n">and_</span> |
| <span class="kn">from</span> <span class="nn">sqlalchemy.orm</span> <span class="k">import</span> <span class="n">reconstructor</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.models.base</span> <span class="k">import</span> <span class="n">Base</span><span class="p">,</span> <span class="n">ID_LEN</span> |
| <span class="kn">from</span> <span class="nn">airflow.utils</span> <span class="k">import</span> <span class="n">timezone</span> |
| <span class="kn">from</span> <span class="nn">airflow.utils.db</span> <span class="k">import</span> <span class="n">provide_session</span> |
| <span class="kn">from</span> <span class="nn">airflow.utils.helpers</span> <span class="k">import</span> <span class="n">as_tuple</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.sqlalchemy</span> <span class="k">import</span> <span class="n">UtcDateTime</span> |
| |
| |
| <span class="c1"># MAX XCOM Size is 48KB</span> |
| <span class="c1"># https://github.com/apache/airflow/pull/1618#discussion_r68249677</span> |
| <div class="viewcode-block" id="MAX_XCOM_SIZE"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.MAX_XCOM_SIZE">[docs]</a><span class="n">MAX_XCOM_SIZE</span> <span class="o">=</span> <span class="mi">49344</span></div> |
| <div class="viewcode-block" id="XCOM_RETURN_KEY"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCOM_RETURN_KEY">[docs]</a><span class="n">XCOM_RETURN_KEY</span> <span class="o">=</span> <span class="s1">'return_value'</span></div> |
| |
| |
| <div class="viewcode-block" id="XCom"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom">[docs]</a><span class="k">class</span> <span class="nc">XCom</span><span class="p">(</span><span class="n">Base</span><span class="p">,</span> <span class="n">LoggingMixin</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Base class for XCom objects.</span> |
| <span class="sd"> """</span> |
| <div class="viewcode-block" id="XCom.__tablename__"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.__tablename__">[docs]</a> <span class="n">__tablename__</span> <span class="o">=</span> <span class="s2">"xcom"</span></div> |
| |
| <div class="viewcode-block" id="XCom.id"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.id">[docs]</a> <span class="nb">id</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">Integer</span><span class="p">,</span> <span class="n">primary_key</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></div> |
| <div class="viewcode-block" id="XCom.key"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.key">[docs]</a> <span class="n">key</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">String</span><span class="p">(</span><span class="mi">512</span><span class="p">))</span></div> |
| <div class="viewcode-block" id="XCom.value"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.value">[docs]</a> <span class="n">value</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">LargeBinary</span><span class="p">)</span></div> |
| <div class="viewcode-block" id="XCom.timestamp"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.timestamp">[docs]</a> <span class="n">timestamp</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span> |
| <span class="n">UtcDateTime</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">timezone</span><span class="o">.</span><span class="n">utcnow</span><span class="p">,</span> <span class="n">nullable</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></div> |
| <div class="viewcode-block" id="XCom.execution_date"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.execution_date">[docs]</a> <span class="n">execution_date</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">UtcDateTime</span><span class="p">,</span> <span class="n">nullable</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></div> |
| |
| <span class="c1"># source information</span> |
| <div class="viewcode-block" id="XCom.task_id"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.task_id">[docs]</a> <span class="n">task_id</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">String</span><span class="p">(</span><span class="n">ID_LEN</span><span class="p">),</span> <span class="n">nullable</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></div> |
| <div class="viewcode-block" id="XCom.dag_id"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.dag_id">[docs]</a> <span class="n">dag_id</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">String</span><span class="p">(</span><span class="n">ID_LEN</span><span class="p">),</span> <span class="n">nullable</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="XCom.__table_args__"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.__table_args__">[docs]</a> <span class="n">__table_args__</span> <span class="o">=</span> <span class="p">(</span> |
| <span class="n">Index</span><span class="p">(</span><span class="s1">'idx_xcom_dag_task_date'</span><span class="p">,</span> <span class="n">dag_id</span><span class="p">,</span> <span class="n">task_id</span><span class="p">,</span> <span class="n">execution_date</span><span class="p">,</span> <span class="n">unique</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span></div> |
| <span class="p">)</span> |
| |
| <span class="sd">"""</span> |
| <span class="sd"> TODO: "pickling" has been deprecated and JSON is preferred.</span> |
| <span class="sd"> "pickling" will be removed in Airflow 2.0.</span> |
| <span class="sd"> """</span> |
| <span class="nd">@reconstructor</span> |
| <div class="viewcode-block" id="XCom.init_on_load"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.init_on_load">[docs]</a> <span class="k">def</span> <span class="nf">init_on_load</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">enable_pickling</span> <span class="o">=</span> <span class="n">configuration</span><span class="o">.</span><span class="n">getboolean</span><span class="p">(</span><span class="s1">'core'</span><span class="p">,</span> <span class="s1">'enable_xcom_pickling'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">enable_pickling</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">)</span> |
| <span class="k">else</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">value</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'UTF-8'</span><span class="p">))</span> |
| <span class="k">except</span> <span class="p">(</span><span class="ne">UnicodeEncodeError</span><span class="p">,</span> <span class="ne">ValueError</span><span class="p">):</span> |
| <span class="c1"># For backward-compatibility.</span> |
| <span class="c1"># Preventing errors in webserver</span> |
| <span class="c1"># due to XComs mixed with pickled and unpickled.</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="XCom.__repr__"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.__repr__">[docs]</a> <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="s1">'<XCom "</span><span class="si">{key}</span><span class="s1">" (</span><span class="si">{task_id}</span><span class="s1"> @ </span><span class="si">{execution_date}</span><span class="s1">)>'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">key</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">,</span> |
| <span class="n">task_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">task_id</span><span class="p">,</span> |
| <span class="n">execution_date</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">execution_date</span><span class="p">)</span></div> |
| |
| <span class="nd">@classmethod</span> |
| <span class="nd">@provide_session</span> |
| <div class="viewcode-block" id="XCom.set"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span> |
| <span class="bp">cls</span><span class="p">,</span> |
| <span class="n">key</span><span class="p">,</span> |
| <span class="n">value</span><span class="p">,</span> |
| <span class="n">execution_date</span><span class="p">,</span> |
| <span class="n">task_id</span><span class="p">,</span> |
| <span class="n">dag_id</span><span class="p">,</span> |
| <span class="n">session</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Store an XCom value.</span> |
| |
| <span class="sd"> :return: None</span> |
| <span class="sd"> """</span> |
| <span class="n">session</span><span class="o">.</span><span class="n">expunge_all</span><span class="p">()</span> |
| |
| <span class="n">value</span> <span class="o">=</span> <span class="n">XCom</span><span class="o">.</span><span class="n">serialize_value</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="c1"># remove any duplicate XComs</span> |
| <span class="n">session</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span> |
| <span class="bp">cls</span><span class="o">.</span><span class="n">key</span> <span class="o">==</span> <span class="n">key</span><span class="p">,</span> |
| <span class="bp">cls</span><span class="o">.</span><span class="n">execution_date</span> <span class="o">==</span> <span class="n">execution_date</span><span class="p">,</span> |
| <span class="bp">cls</span><span class="o">.</span><span class="n">task_id</span> <span class="o">==</span> <span class="n">task_id</span><span class="p">,</span> |
| <span class="bp">cls</span><span class="o">.</span><span class="n">dag_id</span> <span class="o">==</span> <span class="n">dag_id</span><span class="p">)</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span> |
| |
| <span class="n">session</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span> |
| |
| <span class="c1"># insert new XCom</span> |
| <span class="n">session</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">XCom</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">value</span><span class="o">=</span><span class="n">value</span><span class="p">,</span> |
| <span class="n">execution_date</span><span class="o">=</span><span class="n">execution_date</span><span class="p">,</span> |
| <span class="n">task_id</span><span class="o">=</span><span class="n">task_id</span><span class="p">,</span> |
| <span class="n">dag_id</span><span class="o">=</span><span class="n">dag_id</span><span class="p">))</span> |
| |
| <span class="n">session</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span></div> |
| |
| <span class="nd">@classmethod</span> |
| <span class="nd">@provide_session</span> |
| <div class="viewcode-block" id="XCom.get_one"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.get_one">[docs]</a> <span class="k">def</span> <span class="nf">get_one</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> |
| <span class="n">execution_date</span><span class="p">,</span> |
| <span class="n">key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">task_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">dag_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">include_prior_dates</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">session</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Retrieve an XCom value, optionally meeting certain criteria.</span> |
| <span class="sd"> TODO: "pickling" has been deprecated and JSON is preferred.</span> |
| <span class="sd"> "pickling" will be removed in Airflow 2.0.</span> |
| |
| <span class="sd"> :return: XCom value</span> |
| <span class="sd"> """</span> |
| <span class="n">filters</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="k">if</span> <span class="n">key</span><span class="p">:</span> |
| <span class="n">filters</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">key</span> <span class="o">==</span> <span class="n">key</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">task_id</span><span class="p">:</span> |
| <span class="n">filters</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">task_id</span> <span class="o">==</span> <span class="n">task_id</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">dag_id</span><span class="p">:</span> |
| <span class="n">filters</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">dag_id</span> <span class="o">==</span> <span class="n">dag_id</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">include_prior_dates</span><span class="p">:</span> |
| <span class="n">filters</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">execution_date</span> <span class="o"><=</span> <span class="n">execution_date</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">filters</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">execution_date</span> <span class="o">==</span> <span class="n">execution_date</span><span class="p">)</span> |
| |
| <span class="n">query</span> <span class="o">=</span> <span class="p">(</span> |
| <span class="n">session</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">value</span><span class="p">)</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">and_</span><span class="p">(</span><span class="o">*</span><span class="n">filters</span><span class="p">))</span> |
| <span class="o">.</span><span class="n">order_by</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">execution_date</span><span class="o">.</span><span class="n">desc</span><span class="p">(),</span> <span class="bp">cls</span><span class="o">.</span><span class="n">timestamp</span><span class="o">.</span><span class="n">desc</span><span class="p">()))</span> |
| |
| <span class="n">result</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">first</span><span class="p">()</span> |
| <span class="k">if</span> <span class="n">result</span><span class="p">:</span> |
| <span class="n">enable_pickling</span> <span class="o">=</span> <span class="n">configuration</span><span class="o">.</span><span class="n">getboolean</span><span class="p">(</span><span class="s1">'core'</span><span class="p">,</span> <span class="s1">'enable_xcom_pickling'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">enable_pickling</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">pickle</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">value</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'UTF-8'</span><span class="p">))</span> |
| <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span> |
| <span class="n">log</span> <span class="o">=</span> <span class="n">LoggingMixin</span><span class="p">()</span><span class="o">.</span><span class="n">log</span> |
| <span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"Could not deserialize the XCOM value from JSON. "</span> |
| <span class="s2">"If you are using pickles instead of JSON "</span> |
| <span class="s2">"for XCOM, then you need to enable pickle "</span> |
| <span class="s2">"support for XCOM in your airflow config."</span><span class="p">)</span> |
| <span class="k">raise</span></div> |
| |
| <span class="nd">@classmethod</span> |
| <span class="nd">@provide_session</span> |
| <div class="viewcode-block" id="XCom.get_many"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.get_many">[docs]</a> <span class="k">def</span> <span class="nf">get_many</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> |
| <span class="n">execution_date</span><span class="p">,</span> |
| <span class="n">key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">task_ids</span><span class="o">=</span><span class="kc">None</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="n">include_prior_dates</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">limit</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> |
| <span class="n">session</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Retrieve an XCom value, optionally meeting certain criteria</span> |
| <span class="sd"> TODO: "pickling" has been deprecated and JSON is preferred.</span> |
| <span class="sd"> "pickling" will be removed in Airflow 2.0.</span> |
| <span class="sd"> """</span> |
| <span class="n">filters</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="k">if</span> <span class="n">key</span><span class="p">:</span> |
| <span class="n">filters</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">key</span> <span class="o">==</span> <span class="n">key</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">task_ids</span><span class="p">:</span> |
| <span class="n">filters</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">task_id</span><span class="o">.</span><span class="n">in_</span><span class="p">(</span><span class="n">as_tuple</span><span class="p">(</span><span class="n">task_ids</span><span class="p">)))</span> |
| <span class="k">if</span> <span class="n">dag_ids</span><span class="p">:</span> |
| <span class="n">filters</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">dag_id</span><span class="o">.</span><span class="n">in_</span><span class="p">(</span><span class="n">as_tuple</span><span class="p">(</span><span class="n">dag_ids</span><span class="p">)))</span> |
| <span class="k">if</span> <span class="n">include_prior_dates</span><span class="p">:</span> |
| <span class="n">filters</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">execution_date</span> <span class="o"><=</span> <span class="n">execution_date</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">filters</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">execution_date</span> <span class="o">==</span> <span class="n">execution_date</span><span class="p">)</span> |
| |
| <span class="n">query</span> <span class="o">=</span> <span class="p">(</span> |
| <span class="n">session</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">and_</span><span class="p">(</span><span class="o">*</span><span class="n">filters</span><span class="p">))</span> |
| <span class="o">.</span><span class="n">order_by</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">execution_date</span><span class="o">.</span><span class="n">desc</span><span class="p">(),</span> <span class="bp">cls</span><span class="o">.</span><span class="n">timestamp</span><span class="o">.</span><span class="n">desc</span><span class="p">())</span> |
| <span class="o">.</span><span class="n">limit</span><span class="p">(</span><span class="n">limit</span><span class="p">))</span> |
| <span class="n">results</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">all</span><span class="p">()</span> |
| <span class="k">return</span> <span class="n">results</span></div> |
| |
| <span class="nd">@classmethod</span> |
| <span class="nd">@provide_session</span> |
| <div class="viewcode-block" id="XCom.delete"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">xcoms</span><span class="p">,</span> <span class="n">session</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">xcoms</span><span class="p">,</span> <span class="n">XCom</span><span class="p">):</span> |
| <span class="n">xcoms</span> <span class="o">=</span> <span class="p">[</span><span class="n">xcoms</span><span class="p">]</span> |
| <span class="k">for</span> <span class="n">xcom</span> <span class="ow">in</span> <span class="n">xcoms</span><span class="p">:</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">xcom</span><span class="p">,</span> <span class="n">XCom</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span> |
| <span class="s1">'Expected XCom; received </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">xcom</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="p">)</span> |
| <span class="n">session</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">xcom</span><span class="p">)</span> |
| <span class="n">session</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="XCom.serialize_value"><a class="viewcode-back" href="../../../_api/airflow/models/xcom/index.html#airflow.models.XCom.serialize_value">[docs]</a> <span class="k">def</span> <span class="nf">serialize_value</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> |
| <span class="c1"># TODO: "pickling" has been deprecated and JSON is preferred.</span> |
| <span class="c1"># "pickling" will be removed in Airflow 2.0.</span> |
| <span class="k">if</span> <span class="n">configuration</span><span class="o">.</span><span class="n">getboolean</span><span class="p">(</span><span class="s1">'core'</span><span class="p">,</span> <span class="s1">'enable_xcom_pickling'</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">pickle</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">value</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-8'</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span> |
| <span class="n">log</span> <span class="o">=</span> <span class="n">LoggingMixin</span><span class="p">()</span><span class="o">.</span><span class="n">log</span> |
| <span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"Could not serialize the XCOM value into JSON. "</span> |
| <span class="s2">"If you are using pickles instead of JSON "</span> |
| <span class="s2">"for XCOM, then you need to enable pickle "</span> |
| <span class="s2">"support for XCOM in your airflow config."</span><span class="p">)</span> |
| <span class="k">raise</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> |
