| |
| |
| |
| |
| <!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.dates — 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> |
| |
| <script type="application/javascript"> |
| window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date; |
| ga("create", "UA-140539454-1", "auto"); |
| ga("send", "pageview"); |
| </script> |
| <script async src="https://www.google-analytics.com/analytics.js"></script> |
| </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.dates</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.dates</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">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">datetime</span> <span class="k">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">timedelta</span> |
| <span class="kn">from</span> <span class="nn">dateutil.relativedelta</span> <span class="k">import</span> <span class="n">relativedelta</span> <span class="c1"># noqa: F401 for doctest</span> |
| <span class="kn">import</span> <span class="nn">six</span> |
| |
| <span class="kn">from</span> <span class="nn">croniter</span> <span class="k">import</span> <span class="n">croniter</span> |
| |
| <div class="viewcode-block" id="cron_presets"><a class="viewcode-back" href="../../../_api/airflow/models/index.html#airflow.models.cron_presets">[docs]</a><span class="n">cron_presets</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'@hourly'</span><span class="p">:</span> <span class="s1">'0 * * * *'</span><span class="p">,</span> |
| <span class="s1">'@daily'</span><span class="p">:</span> <span class="s1">'0 0 * * *'</span><span class="p">,</span> |
| <span class="s1">'@weekly'</span><span class="p">:</span> <span class="s1">'0 0 * * 0'</span><span class="p">,</span> |
| <span class="s1">'@monthly'</span><span class="p">:</span> <span class="s1">'0 0 1 * *'</span><span class="p">,</span> |
| <span class="s1">'@yearly'</span><span class="p">:</span> <span class="s1">'0 0 1 1 *'</span><span class="p">,</span></div> |
| <span class="p">}</span> |
| |
| |
| <span class="k">def</span> <span class="nf">date_range</span><span class="p">(</span><span class="n">start_date</span><span class="p">,</span> <span class="n">end_date</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">num</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">delta</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Get a set of dates as a list based on a start, end and delta, delta</span> |
| <span class="sd"> can be something that can be added to `datetime.datetime`</span> |
| <span class="sd"> or a cron expression as a `str`</span> |
| |
| <span class="sd"> :Example::</span> |
| |
| <span class="sd"> date_range(datetime(2016, 1, 1), datetime(2016, 1, 3), delta=timedelta(1))</span> |
| <span class="sd"> [datetime.datetime(2016, 1, 1, 0, 0), datetime.datetime(2016, 1, 2, 0, 0),</span> |
| <span class="sd"> datetime.datetime(2016, 1, 3, 0, 0)]</span> |
| <span class="sd"> date_range(datetime(2016, 1, 1), datetime(2016, 1, 3), delta='0 0 * * *')</span> |
| <span class="sd"> [datetime.datetime(2016, 1, 1, 0, 0), datetime.datetime(2016, 1, 2, 0, 0),</span> |
| <span class="sd"> datetime.datetime(2016, 1, 3, 0, 0)]</span> |
| <span class="sd"> date_range(datetime(2016, 1, 1), datetime(2016, 3, 3), delta="0 0 0 * *")</span> |
| <span class="sd"> [datetime.datetime(2016, 1, 1, 0, 0), datetime.datetime(2016, 2, 1, 0, 0),</span> |
| <span class="sd"> datetime.datetime(2016, 3, 1, 0, 0)]</span> |
| |
| <span class="sd"> :param start_date: anchor date to start the series from</span> |
| <span class="sd"> :type start_date: datetime.datetime</span> |
| <span class="sd"> :param end_date: right boundary for the date range</span> |
| <span class="sd"> :type end_date: datetime.datetime</span> |
| <span class="sd"> :param num: alternatively to end_date, you can specify the number of</span> |
| <span class="sd"> number of entries you want in the range. This number can be negative,</span> |
| <span class="sd"> output will always be sorted regardless</span> |
| <span class="sd"> :type num: int</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">delta</span><span class="p">:</span> |
| <span class="k">return</span> <span class="p">[]</span> |
| <span class="k">if</span> <span class="n">end_date</span> <span class="ow">and</span> <span class="n">start_date</span> <span class="o">></span> <span class="n">end_date</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"Wait. start_date needs to be before end_date"</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">end_date</span> <span class="ow">and</span> <span class="n">num</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"Wait. Either specify end_date OR num"</span><span class="p">)</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">end_date</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">num</span><span class="p">:</span> |
| <span class="n">end_date</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">delta_iscron</span> <span class="o">=</span> <span class="kc">False</span> |
| <span class="n">tz</span> <span class="o">=</span> <span class="n">start_date</span><span class="o">.</span><span class="n">tzinfo</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">delta</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span> |
| <span class="n">delta_iscron</span> <span class="o">=</span> <span class="kc">True</span> |
| <span class="n">start_date</span> <span class="o">=</span> <span class="n">timezone</span><span class="o">.</span><span class="n">make_naive</span><span class="p">(</span><span class="n">start_date</span><span class="p">,</span> <span class="n">tz</span><span class="p">)</span> |
| <span class="n">cron</span> <span class="o">=</span> <span class="n">croniter</span><span class="p">(</span><span class="n">delta</span><span class="p">,</span> <span class="n">start_date</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">delta</span><span class="p">,</span> <span class="n">timedelta</span><span class="p">):</span> |
| <span class="n">delta</span> <span class="o">=</span> <span class="nb">abs</span><span class="p">(</span><span class="n">delta</span><span class="p">)</span> |
| <span class="n">dates</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="k">if</span> <span class="n">end_date</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">timezone</span><span class="o">.</span><span class="n">is_naive</span><span class="p">(</span><span class="n">start_date</span><span class="p">):</span> |
| <span class="n">end_date</span> <span class="o">=</span> <span class="n">timezone</span><span class="o">.</span><span class="n">make_naive</span><span class="p">(</span><span class="n">end_date</span><span class="p">,</span> <span class="n">tz</span><span class="p">)</span> |
| <span class="k">while</span> <span class="n">start_date</span> <span class="o"><=</span> <span class="n">end_date</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">timezone</span><span class="o">.</span><span class="n">is_naive</span><span class="p">(</span><span class="n">start_date</span><span class="p">):</span> |
| <span class="n">dates</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">timezone</span><span class="o">.</span><span class="n">make_aware</span><span class="p">(</span><span class="n">start_date</span><span class="p">,</span> <span class="n">tz</span><span class="p">))</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">dates</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">start_date</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">delta_iscron</span><span class="p">:</span> |
| <span class="n">start_date</span> <span class="o">=</span> <span class="n">cron</span><span class="o">.</span><span class="n">get_next</span><span class="p">(</span><span class="n">datetime</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">start_date</span> <span class="o">+=</span> <span class="n">delta</span> |
| <span class="k">else</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="nb">abs</span><span class="p">(</span><span class="n">num</span><span class="p">)):</span> |
| <span class="k">if</span> <span class="n">timezone</span><span class="o">.</span><span class="n">is_naive</span><span class="p">(</span><span class="n">start_date</span><span class="p">):</span> |
| <span class="n">dates</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">timezone</span><span class="o">.</span><span class="n">make_aware</span><span class="p">(</span><span class="n">start_date</span><span class="p">,</span> <span class="n">tz</span><span class="p">))</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">dates</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">start_date</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">delta_iscron</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">num</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> |
| <span class="n">start_date</span> <span class="o">=</span> <span class="n">cron</span><span class="o">.</span><span class="n">get_next</span><span class="p">(</span><span class="n">datetime</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">start_date</span> <span class="o">=</span> <span class="n">cron</span><span class="o">.</span><span class="n">get_prev</span><span class="p">(</span><span class="n">datetime</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">num</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> |
| <span class="n">start_date</span> <span class="o">+=</span> <span class="n">delta</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">start_date</span> <span class="o">-=</span> <span class="n">delta</span> |
| <span class="k">return</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">dates</span><span class="p">)</span> |
| |
| |
| <span class="k">def</span> <span class="nf">round_time</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">delta</span><span class="p">,</span> <span class="n">start_date</span><span class="o">=</span><span class="n">timezone</span><span class="o">.</span><span class="n">make_aware</span><span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">min</span><span class="p">)):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Returns the datetime of the form start_date + i * delta</span> |
| <span class="sd"> which is closest to dt for any non-negative integer i.</span> |
| <span class="sd"> Note that delta may be a datetime.timedelta or a dateutil.relativedelta</span> |
| <span class="sd"> >>> round_time(datetime(2015, 1, 1, 6), timedelta(days=1))</span> |
| <span class="sd"> datetime.datetime(2015, 1, 1, 0, 0)</span> |
| <span class="sd"> >>> round_time(datetime(2015, 1, 2), relativedelta(months=1))</span> |
| <span class="sd"> datetime.datetime(2015, 1, 1, 0, 0)</span> |
| <span class="sd"> >>> round_time(datetime(2015, 9, 16, 0, 0), timedelta(1), datetime(2015, 9, 14, 0, 0))</span> |
| <span class="sd"> datetime.datetime(2015, 9, 16, 0, 0)</span> |
| <span class="sd"> >>> round_time(datetime(2015, 9, 15, 0, 0), timedelta(1), datetime(2015, 9, 14, 0, 0))</span> |
| <span class="sd"> datetime.datetime(2015, 9, 15, 0, 0)</span> |
| <span class="sd"> >>> round_time(datetime(2015, 9, 14, 0, 0), timedelta(1), datetime(2015, 9, 14, 0, 0))</span> |
| <span class="sd"> datetime.datetime(2015, 9, 14, 0, 0)</span> |
| <span class="sd"> >>> round_time(datetime(2015, 9, 13, 0, 0), timedelta(1), datetime(2015, 9, 14, 0, 0))</span> |
| <span class="sd"> datetime.datetime(2015, 9, 14, 0, 0)</span> |
| <span class="sd"> """</span> |
| |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">delta</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span> |
| <span class="c1"># It's cron based, so it's easy</span> |
| <span class="n">tz</span> <span class="o">=</span> <span class="n">start_date</span><span class="o">.</span><span class="n">tzinfo</span> |
| <span class="n">start_date</span> <span class="o">=</span> <span class="n">timezone</span><span class="o">.</span><span class="n">make_naive</span><span class="p">(</span><span class="n">start_date</span><span class="p">,</span> <span class="n">tz</span><span class="p">)</span> |
| <span class="n">cron</span> <span class="o">=</span> <span class="n">croniter</span><span class="p">(</span><span class="n">delta</span><span class="p">,</span> <span class="n">start_date</span><span class="p">)</span> |
| <span class="n">prev</span> <span class="o">=</span> <span class="n">cron</span><span class="o">.</span><span class="n">get_prev</span><span class="p">(</span><span class="n">datetime</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">prev</span> <span class="o">==</span> <span class="n">start_date</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">timezone</span><span class="o">.</span><span class="n">make_aware</span><span class="p">(</span><span class="n">start_date</span><span class="p">,</span> <span class="n">tz</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">timezone</span><span class="o">.</span><span class="n">make_aware</span><span class="p">(</span><span class="n">prev</span><span class="p">,</span> <span class="n">tz</span><span class="p">)</span> |
| |
| <span class="c1"># Ignore the microseconds of dt</span> |
| <span class="n">dt</span> <span class="o">-=</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">microseconds</span><span class="o">=</span><span class="n">dt</span><span class="o">.</span><span class="n">microsecond</span><span class="p">)</span> |
| |
| <span class="c1"># We are looking for a datetime in the form start_date + i * delta</span> |
| <span class="c1"># which is as close as possible to dt. Since delta could be a relative</span> |
| <span class="c1"># delta we don't know its exact length in seconds so we cannot rely on</span> |
| <span class="c1"># division to find i. Instead we employ a binary search algorithm, first</span> |
| <span class="c1"># finding an upper and lower limit and then disecting the interval until</span> |
| <span class="c1"># we have found the closest match.</span> |
| |
| <span class="c1"># We first search an upper limit for i for which start_date + upper * delta</span> |
| <span class="c1"># exceeds dt.</span> |
| <span class="n">upper</span> <span class="o">=</span> <span class="mi">1</span> |
| <span class="k">while</span> <span class="n">start_date</span> <span class="o">+</span> <span class="n">upper</span> <span class="o">*</span> <span class="n">delta</span> <span class="o"><</span> <span class="n">dt</span><span class="p">:</span> |
| <span class="c1"># To speed up finding an upper limit we grow this exponentially by a</span> |
| <span class="c1"># factor of 2</span> |
| <span class="n">upper</span> <span class="o">*=</span> <span class="mi">2</span> |
| |
| <span class="c1"># Since upper is the first value for which start_date + upper * delta</span> |
| <span class="c1"># exceeds dt, upper // 2 is below dt and therefore forms a lower limited</span> |
| <span class="c1"># for the i we are looking for</span> |
| <span class="n">lower</span> <span class="o">=</span> <span class="n">upper</span> <span class="o">//</span> <span class="mi">2</span> |
| |
| <span class="c1"># We now continue to intersect the interval between</span> |
| <span class="c1"># start_date + lower * delta and start_date + upper * delta</span> |
| <span class="c1"># until we find the closest value</span> |
| <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> |
| <span class="c1"># Invariant: start + lower * delta < dt <= start + upper * delta</span> |
| <span class="c1"># If start_date + (lower + 1)*delta exceeds dt, then either lower or</span> |
| <span class="c1"># lower+1 has to be the solution we are searching for</span> |
| <span class="k">if</span> <span class="n">start_date</span> <span class="o">+</span> <span class="p">(</span><span class="n">lower</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="n">delta</span> <span class="o">>=</span> <span class="n">dt</span><span class="p">:</span> |
| <span class="c1"># Check if start_date + (lower + 1)*delta or</span> |
| <span class="c1"># start_date + lower*delta is closer to dt and return the solution</span> |
| <span class="k">if</span> <span class="p">(</span><span class="n">start_date</span> <span class="o">+</span> <span class="p">(</span><span class="n">lower</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="n">delta</span><span class="p">)</span> <span class="o">-</span> <span class="n">dt</span> <span class="o"><=</span> <span class="n">dt</span> <span class="o">-</span> <span class="p">(</span><span class="n">start_date</span> <span class="o">+</span> <span class="n">lower</span> <span class="o">*</span> <span class="n">delta</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">start_date</span> <span class="o">+</span> <span class="p">(</span><span class="n">lower</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="n">delta</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">start_date</span> <span class="o">+</span> <span class="n">lower</span> <span class="o">*</span> <span class="n">delta</span> |
| |
| <span class="c1"># We intersect the interval and either replace the lower or upper</span> |
| <span class="c1"># limit with the candidate</span> |
| <span class="n">candidate</span> <span class="o">=</span> <span class="n">lower</span> <span class="o">+</span> <span class="p">(</span><span class="n">upper</span> <span class="o">-</span> <span class="n">lower</span><span class="p">)</span> <span class="o">//</span> <span class="mi">2</span> |
| <span class="k">if</span> <span class="n">start_date</span> <span class="o">+</span> <span class="n">candidate</span> <span class="o">*</span> <span class="n">delta</span> <span class="o">>=</span> <span class="n">dt</span><span class="p">:</span> |
| <span class="n">upper</span> <span class="o">=</span> <span class="n">candidate</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">lower</span> <span class="o">=</span> <span class="n">candidate</span> |
| |
| <span class="c1"># in the special case when start_date > dt the search for upper will</span> |
| <span class="c1"># immediately stop for upper == 1 which results in lower = upper // 2 = 0</span> |
| <span class="c1"># and this function returns start_date.</span> |
| |
| |
| <span class="k">def</span> <span class="nf">infer_time_unit</span><span class="p">(</span><span class="n">time_seconds_arr</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Determine the most appropriate time unit for an array of time durations</span> |
| <span class="sd"> specified in seconds.</span> |
| <span class="sd"> e.g. 5400 seconds => 'minutes', 36000 seconds => 'hours'</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">time_seconds_arr</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| <span class="k">return</span> <span class="s1">'hours'</span> |
| <span class="n">max_time_seconds</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">time_seconds_arr</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">max_time_seconds</span> <span class="o"><=</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">2</span><span class="p">:</span> |
| <span class="k">return</span> <span class="s1">'seconds'</span> |
| <span class="k">elif</span> <span class="n">max_time_seconds</span> <span class="o"><=</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">2</span><span class="p">:</span> |
| <span class="k">return</span> <span class="s1">'minutes'</span> |
| <span class="k">elif</span> <span class="n">max_time_seconds</span> <span class="o"><=</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">2</span><span class="p">:</span> |
| <span class="k">return</span> <span class="s1">'hours'</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="s1">'days'</span> |
| |
| |
| <span class="k">def</span> <span class="nf">scale_time_units</span><span class="p">(</span><span class="n">time_seconds_arr</span><span class="p">,</span> <span class="n">unit</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Convert an array of time durations in seconds to the specified time unit.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="n">unit</span> <span class="o">==</span> <span class="s1">'minutes'</span><span class="p">:</span> |
| <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span> <span class="o">*</span> <span class="mf">1.0</span> <span class="o">/</span> <span class="mi">60</span><span class="p">,</span> <span class="n">time_seconds_arr</span><span class="p">))</span> |
| <span class="k">elif</span> <span class="n">unit</span> <span class="o">==</span> <span class="s1">'hours'</span><span class="p">:</span> |
| <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span> <span class="o">*</span> <span class="mf">1.0</span> <span class="o">/</span> <span class="p">(</span><span class="mi">60</span> <span class="o">*</span> <span class="mi">60</span><span class="p">),</span> <span class="n">time_seconds_arr</span><span class="p">))</span> |
| <span class="k">elif</span> <span class="n">unit</span> <span class="o">==</span> <span class="s1">'days'</span><span class="p">:</span> |
| <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span> <span class="o">*</span> <span class="mf">1.0</span> <span class="o">/</span> <span class="p">(</span><span class="mi">24</span> <span class="o">*</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">60</span><span class="p">),</span> <span class="n">time_seconds_arr</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">time_seconds_arr</span> |
| |
| |
| <span class="k">def</span> <span class="nf">days_ago</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="n">hour</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">minute</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">second</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">microsecond</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Get a datetime object representing `n` days ago. By default the time is</span> |
| <span class="sd"> set to midnight.</span> |
| <span class="sd"> """</span> |
| <span class="n">today</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="o">.</span><span class="n">replace</span><span class="p">(</span> |
| <span class="n">hour</span><span class="o">=</span><span class="n">hour</span><span class="p">,</span> |
| <span class="n">minute</span><span class="o">=</span><span class="n">minute</span><span class="p">,</span> |
| <span class="n">second</span><span class="o">=</span><span class="n">second</span><span class="p">,</span> |
| <span class="n">microsecond</span><span class="o">=</span><span class="n">microsecond</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">today</span> <span class="o">-</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="n">n</span><span class="p">)</span> |
| |
| |
| <span class="k">def</span> <span class="nf">parse_execution_date</span><span class="p">(</span><span class="n">execution_date_str</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Parse execution date string to datetime object.</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="n">timezone</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">execution_date_str</span><span class="p">)</span> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
