| |
| |
| |
| |
| <!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.utils.sqlalchemy — Airflow Documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../../_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="../../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../search.html" /> |
| |
| <script> |
| document.addEventListener('DOMContentLoaded', function() { |
| var el = document.getElementById('changelog'); |
| if (el !== null ) { |
| // [AIRFLOW-...] |
| el.innerHTML = el.innerHTML.replace( |
| /\[(AIRFLOW-[\d]+)\]/g, |
| `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>` |
| ); |
| // (#...) |
| el.innerHTML = el.innerHTML.replace( |
| /\(#([\d]+)\)/g, |
| `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>` |
| ); |
| }; |
| }) |
| </script> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.3 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../cli.html">Command Line Interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../api.html">Experimental Rest API</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../_api/index.html">API Reference</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../../index.html">Airflow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../../index.html">Docs</a> »</li> |
| |
| <li><a href="../../index.html">Module code</a> »</li> |
| |
| <li>airflow.utils.sqlalchemy</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.utils.sqlalchemy</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="c1">#</span> |
| <span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span> |
| <span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">division</span> |
| <span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">print_function</span> |
| <span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">unicode_literals</span> |
| |
| <span class="kn">import</span> <span class="nn">datetime</span> |
| <span class="kn">import</span> <span class="nn">os</span> |
| <span class="kn">import</span> <span class="nn">json</span> |
| <span class="kn">import</span> <span class="nn">pendulum</span> |
| <span class="kn">import</span> <span class="nn">time</span> |
| <span class="kn">import</span> <span class="nn">random</span> |
| |
| <span class="kn">from</span> <span class="nn">dateutil</span> <span class="k">import</span> <span class="n">relativedelta</span> |
| <span class="kn">from</span> <span class="nn">sqlalchemy</span> <span class="k">import</span> <span class="n">event</span><span class="p">,</span> <span class="n">exc</span><span class="p">,</span> <span class="n">select</span> |
| <span class="kn">from</span> <span class="nn">sqlalchemy.types</span> <span class="k">import</span> <span class="n">Text</span><span class="p">,</span> <span class="n">DateTime</span><span class="p">,</span> <span class="n">TypeDecorator</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="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">utc</span> <span class="o">=</span> <span class="n">pendulum</span><span class="o">.</span><span class="n">timezone</span><span class="p">(</span><span class="s1">'UTC'</span><span class="p">)</span> |
| |
| |
| <span class="k">def</span> <span class="nf">setup_event_handlers</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> |
| <span class="n">reconnect_timeout_seconds</span><span class="p">,</span> |
| <span class="n">initial_backoff_seconds</span><span class="o">=</span><span class="mf">0.2</span><span class="p">,</span> |
| <span class="n">max_backoff_seconds</span><span class="o">=</span><span class="mi">120</span><span class="p">):</span> |
| <span class="nd">@event</span><span class="o">.</span><span class="n">listens_for</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="s2">"engine_connect"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">ping_connection</span><span class="p">(</span><span class="n">connection</span><span class="p">,</span> <span class="n">branch</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Pessimistic SQLAlchemy disconnect handling. Ensures that each</span> |
| <span class="sd"> connection returned from the pool is properly connected to the database.</span> |
| |
| <span class="sd"> http://docs.sqlalchemy.org/en/rel_1_1/core/pooling.html#disconnect-handling-pessimistic</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="n">branch</span><span class="p">:</span> |
| <span class="c1"># "branch" refers to a sub-connection of a connection,</span> |
| <span class="c1"># we don't want to bother pinging on these.</span> |
| <span class="k">return</span> |
| |
| <span class="n">start</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> |
| <span class="n">backoff</span> <span class="o">=</span> <span class="n">initial_backoff_seconds</span> |
| |
| <span class="c1"># turn off "close with result". This flag is only used with</span> |
| <span class="c1"># "connectionless" execution, otherwise will be False in any case</span> |
| <span class="n">save_should_close_with_result</span> <span class="o">=</span> <span class="n">connection</span><span class="o">.</span><span class="n">should_close_with_result</span> |
| |
| <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> |
| <span class="n">connection</span><span class="o">.</span><span class="n">should_close_with_result</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">connection</span><span class="o">.</span><span class="n">scalar</span><span class="p">(</span><span class="n">select</span><span class="p">([</span><span class="mi">1</span><span class="p">]))</span> |
| <span class="c1"># If we made it here then the connection appears to be healthy</span> |
| <span class="k">break</span> |
| <span class="k">except</span> <span class="n">exc</span><span class="o">.</span><span class="n">DBAPIError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">-</span> <span class="n">start</span> <span class="o">>=</span> <span class="n">reconnect_timeout_seconds</span><span class="p">:</span> |
| <span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span> |
| <span class="s2">"Failed to re-establish DB connection within </span><span class="si">%s</span><span class="s2"> secs: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> |
| <span class="n">reconnect_timeout_seconds</span><span class="p">,</span> |
| <span class="n">err</span><span class="p">)</span> |
| <span class="k">raise</span> |
| <span class="k">if</span> <span class="n">err</span><span class="o">.</span><span class="n">connection_invalidated</span><span class="p">:</span> |
| <span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"DB connection invalidated. Reconnecting..."</span><span class="p">)</span> |
| |
| <span class="c1"># Use a truncated binary exponential backoff. Also includes</span> |
| <span class="c1"># a jitter to prevent the thundering herd problem of</span> |
| <span class="c1"># simultaneous client reconnects</span> |
| <span class="n">backoff</span> <span class="o">+=</span> <span class="n">backoff</span> <span class="o">*</span> <span class="n">random</span><span class="o">.</span><span class="n">random</span><span class="p">()</span> |
| <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="nb">min</span><span class="p">(</span><span class="n">backoff</span><span class="p">,</span> <span class="n">max_backoff_seconds</span><span class="p">))</span> |
| |
| <span class="c1"># run the same SELECT again - the connection will re-validate</span> |
| <span class="c1"># itself and establish a new connection. The disconnect detection</span> |
| <span class="c1"># here also causes the whole connection pool to be invalidated</span> |
| <span class="c1"># so that all stale connections are discarded.</span> |
| <span class="k">continue</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span> |
| <span class="s2">"Unknown database connection error. Not retrying: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> |
| <span class="n">err</span><span class="p">)</span> |
| <span class="k">raise</span> |
| <span class="k">finally</span><span class="p">:</span> |
| <span class="c1"># restore "close with result"</span> |
| <span class="n">connection</span><span class="o">.</span><span class="n">should_close_with_result</span> <span class="o">=</span> <span class="n">save_should_close_with_result</span> |
| |
| <span class="nd">@event</span><span class="o">.</span><span class="n">listens_for</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="s2">"connect"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">connect</span><span class="p">(</span><span class="n">dbapi_connection</span><span class="p">,</span> <span class="n">connection_record</span><span class="p">):</span> |
| <span class="n">connection_record</span><span class="o">.</span><span class="n">info</span><span class="p">[</span><span class="s1">'pid'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getpid</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="n">engine</span><span class="o">.</span><span class="n">dialect</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s2">"sqlite"</span><span class="p">:</span> |
| <span class="nd">@event</span><span class="o">.</span><span class="n">listens_for</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="s2">"connect"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">set_sqlite_pragma</span><span class="p">(</span><span class="n">dbapi_connection</span><span class="p">,</span> <span class="n">connection_record</span><span class="p">):</span> |
| <span class="n">cursor</span> <span class="o">=</span> <span class="n">dbapi_connection</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span> |
| <span class="n">cursor</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"PRAGMA foreign_keys=ON"</span><span class="p">)</span> |
| <span class="n">cursor</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
| |
| <span class="c1"># this ensures sanity in mysql when storing datetimes (not required for postgres)</span> |
| <span class="k">if</span> <span class="n">engine</span><span class="o">.</span><span class="n">dialect</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s2">"mysql"</span><span class="p">:</span> |
| <span class="nd">@event</span><span class="o">.</span><span class="n">listens_for</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="s2">"connect"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">set_mysql_timezone</span><span class="p">(</span><span class="n">dbapi_connection</span><span class="p">,</span> <span class="n">connection_record</span><span class="p">):</span> |
| <span class="n">cursor</span> <span class="o">=</span> <span class="n">dbapi_connection</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span> |
| <span class="n">cursor</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"SET time_zone = '+00:00'"</span><span class="p">)</span> |
| <span class="n">cursor</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
| |
| <span class="nd">@event</span><span class="o">.</span><span class="n">listens_for</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="s2">"checkout"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">checkout</span><span class="p">(</span><span class="n">dbapi_connection</span><span class="p">,</span> <span class="n">connection_record</span><span class="p">,</span> <span class="n">connection_proxy</span><span class="p">):</span> |
| <span class="n">pid</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getpid</span><span class="p">()</span> |
| <span class="k">if</span> <span class="n">connection_record</span><span class="o">.</span><span class="n">info</span><span class="p">[</span><span class="s1">'pid'</span><span class="p">]</span> <span class="o">!=</span> <span class="n">pid</span><span class="p">:</span> |
| <span class="n">connection_record</span><span class="o">.</span><span class="n">connection</span> <span class="o">=</span> <span class="n">connection_proxy</span><span class="o">.</span><span class="n">connection</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="k">raise</span> <span class="n">exc</span><span class="o">.</span><span class="n">DisconnectionError</span><span class="p">(</span> |
| <span class="s2">"Connection record belongs to pid </span><span class="si">{}</span><span class="s2">, "</span> |
| <span class="s2">"attempting to check out in pid </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">connection_record</span><span class="o">.</span><span class="n">info</span><span class="p">[</span><span class="s1">'pid'</span><span class="p">],</span> <span class="n">pid</span><span class="p">)</span> |
| <span class="p">)</span> |
| |
| |
| <div class="viewcode-block" id="UtcDateTime"><a class="viewcode-back" href="../../../_api/airflow/models/index.html#airflow.models.UtcDateTime">[docs]</a><span class="k">class</span> <span class="nc">UtcDateTime</span><span class="p">(</span><span class="n">TypeDecorator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Almost equivalent to :class:`~sqlalchemy.types.DateTime` with</span> |
| <span class="sd"> ``timezone=True`` option, but it differs from that by:</span> |
| |
| <span class="sd"> - Never silently take naive :class:`~datetime.datetime`, instead it</span> |
| <span class="sd"> always raise :exc:`ValueError` unless time zone aware value.</span> |
| <span class="sd"> - :class:`~datetime.datetime` value's :attr:`~datetime.datetime.tzinfo`</span> |
| <span class="sd"> is always converted to UTC.</span> |
| <span class="sd"> - Unlike SQLAlchemy's built-in :class:`~sqlalchemy.types.DateTime`,</span> |
| <span class="sd"> it never return naive :class:`~datetime.datetime`, but time zone</span> |
| <span class="sd"> aware value, even with SQLite or MySQL.</span> |
| <span class="sd"> - Always returns DateTime in UTC</span> |
| |
| <span class="sd"> """</span> |
| |
| <span class="n">impl</span> <span class="o">=</span> <span class="n">DateTime</span><span class="p">(</span><span class="n">timezone</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">process_bind_param</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">dialect</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</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">value</span><span class="p">,</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'expected datetime.datetime, not '</span> <span class="o">+</span> |
| <span class="nb">repr</span><span class="p">(</span><span class="n">value</span><span class="p">))</span> |
| <span class="k">elif</span> <span class="n">value</span><span class="o">.</span><span class="n">tzinfo</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'naive datetime is disallowed'</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">value</span><span class="o">.</span><span class="n">astimezone</span><span class="p">(</span><span class="n">utc</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">process_result_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">dialect</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Processes DateTimes from the DB making sure it is always</span> |
| <span class="sd"> returning UTC. Not using timezone.convert_to_utc as that</span> |
| <span class="sd"> converts to configured TIMEZONE while the DB might be</span> |
| <span class="sd"> running with some other setting. We assume UTC datetimes</span> |
| <span class="sd"> in the database.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">value</span><span class="o">.</span><span class="n">tzinfo</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">tzinfo</span><span class="o">=</span><span class="n">utc</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">astimezone</span><span class="p">(</span><span class="n">utc</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">value</span></div> |
| |
| |
| <div class="viewcode-block" id="Interval"><a class="viewcode-back" href="../../../_api/airflow/models/index.html#airflow.models.Interval">[docs]</a><span class="k">class</span> <span class="nc">Interval</span><span class="p">(</span><span class="n">TypeDecorator</span><span class="p">):</span> |
| |
| <span class="n">impl</span> <span class="o">=</span> <span class="n">Text</span> |
| |
| <span class="n">attr_keys</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">:</span> <span class="p">(</span><span class="s1">'days'</span><span class="p">,</span> <span class="s1">'seconds'</span><span class="p">,</span> <span class="s1">'microseconds'</span><span class="p">),</span> |
| <span class="n">relativedelta</span><span class="o">.</span><span class="n">relativedelta</span><span class="p">:</span> <span class="p">(</span> |
| <span class="s1">'years'</span><span class="p">,</span> <span class="s1">'months'</span><span class="p">,</span> <span class="s1">'days'</span><span class="p">,</span> <span class="s1">'leapdays'</span><span class="p">,</span> <span class="s1">'hours'</span><span class="p">,</span> <span class="s1">'minutes'</span><span class="p">,</span> <span class="s1">'seconds'</span><span class="p">,</span> <span class="s1">'microseconds'</span><span class="p">,</span> |
| <span class="s1">'year'</span><span class="p">,</span> <span class="s1">'month'</span><span class="p">,</span> <span class="s1">'day'</span><span class="p">,</span> <span class="s1">'hour'</span><span class="p">,</span> <span class="s1">'minute'</span><span class="p">,</span> <span class="s1">'second'</span><span class="p">,</span> <span class="s1">'microsecond'</span><span class="p">,</span> |
| <span class="p">),</span> |
| <span class="p">}</span> |
| |
| <span class="k">def</span> <span class="nf">process_bind_param</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">dialect</span><span class="p">):</span> |
| <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">attr_keys</span><span class="p">:</span> |
| <span class="n">attrs</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="n">key</span><span class="p">:</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">key</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">attr_keys</span><span class="p">[</span><span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)]</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="s1">'type'</span><span class="p">:</span> <span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="s1">'attrs'</span><span class="p">:</span> <span class="n">attrs</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="k">def</span> <span class="nf">process_result_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">dialect</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">value</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">value</span> |
| <span class="n">data</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="n">value</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span> |
| <span class="n">type_map</span> <span class="o">=</span> <span class="p">{</span><span class="n">key</span><span class="o">.</span><span class="vm">__name__</span><span class="p">:</span> <span class="n">key</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">attr_keys</span><span class="p">}</span> |
| <span class="k">return</span> <span class="n">type_map</span><span class="p">[</span><span class="n">data</span><span class="p">[</span><span class="s1">'type'</span><span class="p">]](</span><span class="o">**</span><span class="n">data</span><span class="p">[</span><span class="s1">'attrs'</span><span class="p">])</span> |
| <span class="k">return</span> <span class="n">data</span></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> |