doc/sphinx/_build/html/_modules/nepi/util/timefuncs.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8
   9     <title>nepi.util.timefuncs &mdash; NEPI 3.2 documentation</title>
  10
  11     <link rel="stylesheet" href="../../../_static/sphinxdoc.css" type="text/css" />
  12     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
  13
  14     <script type="text/javascript">
  15       var DOCUMENTATION_OPTIONS = {
  16         URL_ROOT:    '../../../',
  17         VERSION:     '3.2',
  18         COLLAPSE_INDEX: false,
  19         FILE_SUFFIX: '.html',
  20         HAS_SOURCE:  true
  21       };
  22     </script>
  23     <script type="text/javascript" src="../../../_static/jquery.js"></script>
  24     <script type="text/javascript" src="../../../_static/underscore.js"></script>
  25     <script type="text/javascript" src="../../../_static/doctools.js"></script>
  26     <link rel="top" title="NEPI 3.2 documentation" href="../../../index.html" />
  27     <link rel="up" title="Module code" href="../../index.html" />
  28   </head>
  29   <body>
  30     <div class="related">
  31       <h3>Navigation</h3>
  32       <ul>
  33         <li class="right" style="margin-right: 10px">
  34           <a href="../../../genindex.html" title="General Index"
  35              accesskey="I">index</a></li>
  36         <li class="right" >
  37           <a href="../../../py-modindex.html" title="Python Module Index"
  38              >modules</a> |</li>
  39         <li><a href="../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
  40           <li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</li>
  41       </ul>
  42     </div>
  43       <div class="sphinxsidebar">
  44         <div class="sphinxsidebarwrapper">
  45 <div id="searchbox" style="display: none">
  46   <h3>Quick search</h3>
  47     <form class="search" action="../../../search.html" method="get">
  48       <input type="text" name="q" />
  49       <input type="submit" value="Go" />
  50       <input type="hidden" name="check_keywords" value="yes" />
  51       <input type="hidden" name="area" value="default" />
  52     </form>
  53     <p class="searchtip" style="font-size: 90%">
  54     Enter search terms or a module, class or function name.
  55     </p>
  56 </div>
  57 <script type="text/javascript">$('#searchbox').show(0);</script>
  58         </div>
  59       </div>
  60
  61     <div class="document">
  62       <div class="documentwrapper">
  63         <div class="bodywrapper">
  64           <div class="body">
  65
  66   <h1>Source code for nepi.util.timefuncs</h1><div class="highlight"><pre>
  67 <span class="c">#</span>
  68 <span class="c">#    NEPI, a framework to manage network experiments</span>
  69 <span class="c">#    Copyright (C) 2013 INRIA</span>
  70 <span class="c">#</span>
  71 <span class="c">#    This program is free software: you can redistribute it and/or modify</span>
  72 <span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
  73 <span class="c">#    published by the Free Software Foundation;</span>
  74 <span class="c">#</span>
  75 <span class="c">#    This program is distributed in the hope that it will be useful,</span>
  76 <span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  77 <span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
  78 <span class="c">#    GNU General Public License for more details.</span>
  79 <span class="c">#</span>
  80 <span class="c">#    You should have received a copy of the GNU General Public License</span>
  81 <span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
  82 <span class="c">#</span>
  83 <span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
  84
  85
  86 <span class="kn">import</span> <span class="nn">datetime</span>
  87 <span class="kn">import</span> <span class="nn">re</span>
  88
  89 <span class="n">_strf</span> <span class="o">=</span> <span class="s">&quot;%Y%m</span><span class="si">%d</span><span class="s">%H%M%S</span><span class="si">%f</span><span class="s">&quot;</span>
  90 <span class="n">_reabs</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">&quot;^\d{20}$&quot;</span><span class="p">)</span>
  91 <span class="n">_rerel</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">&quot;^(?P&lt;time&gt;\d+(.\d+)?)(?P&lt;units&gt;h|m|s|ms|us)$&quot;</span><span class="p">)</span>
  92
  93 <span class="c"># Work around to fix &quot;ImportError: Failed to import _strptime because the import lock is held by another thread.&quot;</span>
  94 <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="s">&quot;20120807124732894211&quot;</span><span class="p">,</span> <span class="n">_strf</span><span class="p">)</span>
  95
  96 <div class="viewcode-block" id="stformat"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.timefuncs.stformat">[docs]</a><span class="k">def</span> <span class="nf">stformat</span><span class="p">(</span><span class="n">sdate</span><span class="p">):</span>
  97     <span class="sd">&quot;&quot;&quot; Constructs a datetime object from a string date with</span>
  98 <span class="sd">    format YYYYMMddHHMMSSffff </span>
  99
 100 <span class="sd">    &quot;&quot;&quot;</span>
 101     <span class="k">return</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">sdate</span><span class="p">,</span> <span class="n">_strf</span><span class="p">)</span><span class="o">.</span><span class="n">date</span><span class="p">()</span>
 102 </div>
 103 <div class="viewcode-block" id="tsformat"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.timefuncs.tsformat">[docs]</a><span class="k">def</span> <span class="nf">tsformat</span><span class="p">(</span><span class="n">date</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
 104     <span class="sd">&quot;&quot;&quot; Formats a datetime object to a string with format YYYYMMddHHMMSSffff.</span>
 105 <span class="sd">    If no date is given, the current date is used.</span>
 106 <span class="sd">    </span>
 107 <span class="sd">    &quot;&quot;&quot;</span>
 108     <span class="k">if</span> <span class="ow">not</span> <span class="n">date</span><span class="p">:</span>
 109         <span class="n">date</span> <span class="o">=</span> <span class="n">tnow</span><span class="p">()</span>
 110
 111     <span class="k">return</span> <span class="n">date</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="n">_strf</span><span class="p">)</span>
 112 </div>
 113 <div class="viewcode-block" id="tnow"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.timefuncs.tnow">[docs]</a><span class="k">def</span> <span class="nf">tnow</span><span class="p">():</span>
 114     <span class="sd">&quot;&quot;&quot; Returns datetime object with the current time &quot;&quot;&quot;</span>
 115     <span class="k">return</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span>
 116 </div>
 117 <div class="viewcode-block" id="tdiff"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.timefuncs.tdiff">[docs]</a><span class="k">def</span> <span class="nf">tdiff</span><span class="p">(</span><span class="n">date1</span><span class="p">,</span> <span class="n">date2</span><span class="p">):</span>
 118     <span class="sd">&quot;&quot;&quot; Returns difference ( date1 - date2 ) as a datetime object,</span>
 119 <span class="sd">    where date1 and date 2 are datetime objects </span>
 120 <span class="sd">    </span>
 121 <span class="sd">    &quot;&quot;&quot;</span>
 122     <span class="k">return</span> <span class="n">date1</span> <span class="o">-</span> <span class="n">date2</span>
 123 </div>
 124 <span class="k">def</span> <span class="nf">_get_total_seconds</span><span class="p">(</span><span class="n">td</span><span class="p">):</span>
 125     <span class="k">return</span> <span class="p">(</span><span class="n">td</span><span class="o">.</span><span class="n">microseconds</span> <span class="o">+</span> <span class="p">(</span><span class="n">td</span><span class="o">.</span><span class="n">seconds</span> <span class="o">+</span> <span class="n">td</span><span class="o">.</span><span class="n">days</span> <span class="o">*</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">3600</span><span class="p">)</span> <span class="o">*</span> <span class="mf">1e6</span><span class="p">)</span> <span class="o">/</span> <span class="mf">1e6</span>
 126
 127 <div class="viewcode-block" id="tdiffsec"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.timefuncs.tdiffsec">[docs]</a><span class="k">def</span> <span class="nf">tdiffsec</span><span class="p">(</span><span class="n">date1</span><span class="p">,</span> <span class="n">date2</span><span class="p">):</span>
 128     <span class="sd">&quot;&quot;&quot; Returns the date difference ( date1 - date2 ) in seconds,</span>
 129 <span class="sd">    where date1 and date 2 are datetime objects </span>
 130 <span class="sd">    </span>
 131 <span class="sd">    &quot;&quot;&quot;</span>
 132     <span class="n">diff</span> <span class="o">=</span> <span class="n">tdiff</span><span class="p">(</span><span class="n">date1</span><span class="p">,</span> <span class="n">date2</span><span class="p">)</span>
 133     <span class="k">return</span> <span class="n">_get_total_seconds</span><span class="p">(</span><span class="n">diff</span><span class="p">)</span>
 134 </div>
 135 <div class="viewcode-block" id="stabsformat"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.timefuncs.stabsformat">[docs]</a><span class="k">def</span> <span class="nf">stabsformat</span><span class="p">(</span><span class="n">sdate</span><span class="p">,</span> <span class="n">dbase</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
 136     <span class="sd">&quot;&quot;&quot; Constructs a datetime object from a string date.</span>
 137 <span class="sd">    The string date can be expressed as an absolute date</span>
 138 <span class="sd">    ( i.e. format YYYYMMddHHMMSSffff ) or as a relative time</span>
 139 <span class="sd">    ( e.g. format &#39;5m&#39; or &#39;10s&#39;). </span>
 140 <span class="sd">    If the date is a relative time and the dbase parameter </span>
 141 <span class="sd">    is given (dbase must be datetime object), the returned</span>
 142 <span class="sd">    date will be dbase + sdate. If dbase is None, </span>
 143 <span class="sd">    current time will be used instead as base time.</span>
 144
 145 <span class="sd">    :param date : string date  </span>
 146 <span class="sd">    :type date : date </span>
 147
 148 <span class="sd">    &quot;&quot;&quot;</span>
 149
 150     <span class="c"># No date given, return current datetime</span>
 151     <span class="k">if</span> <span class="ow">not</span> <span class="n">sdate</span><span class="p">:</span>
 152         <span class="k">return</span> <span class="n">tnow</span><span class="p">()</span>
 153
 154     <span class="c"># Absolute date is given</span>
 155     <span class="k">if</span> <span class="n">_reabs</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">sdate</span><span class="p">):</span>
 156         <span class="k">return</span> <span class="n">stformat</span><span class="p">(</span><span class="n">sdate</span><span class="p">)</span>
 157
 158     <span class="c"># Relative time is given</span>
 159     <span class="n">m</span> <span class="o">=</span> <span class="n">_rerel</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">sdate</span><span class="p">)</span>
 160     <span class="k">if</span> <span class="n">m</span><span class="p">:</span>
 161         <span class="n">time</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">groupdict</span><span class="p">()[</span><span class="s">&#39;time&#39;</span><span class="p">])</span>
 162         <span class="n">units</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">groupdict</span><span class="p">()[</span><span class="s">&#39;units&#39;</span><span class="p">]</span>
 163         <span class="k">if</span> <span class="n">units</span> <span class="o">==</span> <span class="s">&#39;h&#39;</span><span class="p">:</span>
 164             <span class="n">delta</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">hours</span> <span class="o">=</span> <span class="n">time</span><span class="p">)</span>
 165         <span class="k">elif</span> <span class="n">units</span> <span class="o">==</span> <span class="s">&#39;m&#39;</span><span class="p">:</span>
 166             <span class="n">delta</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">minutes</span> <span class="o">=</span> <span class="n">time</span><span class="p">)</span>
 167         <span class="k">elif</span> <span class="n">units</span> <span class="o">==</span> <span class="s">&#39;s&#39;</span><span class="p">:</span>
 168             <span class="n">delta</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">seconds</span> <span class="o">=</span> <span class="n">time</span><span class="p">)</span>
 169         <span class="k">elif</span> <span class="n">units</span> <span class="o">==</span> <span class="s">&#39;ms&#39;</span><span class="p">:</span>
 170             <span class="n">delta</span> <span class="o">=</span> <span class="n">datetime</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="p">(</span><span class="n">time</span><span class="o">*</span><span class="mi">1000</span><span class="p">))</span>
 171         <span class="k">else</span><span class="p">:</span>
 172             <span class="n">delta</span> <span class="o">=</span> <span class="n">datetime</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">time</span><span class="p">)</span>
 173
 174         <span class="k">if</span> <span class="ow">not</span> <span class="n">dbase</span><span class="p">:</span>
 175             <span class="n">dbase</span> <span class="o">=</span> <span class="n">tnow</span><span class="p">()</span>
 176
 177         <span class="k">return</span> <span class="n">dbase</span> <span class="o">+</span> <span class="n">delta</span>
 178
 179     <span class="k">return</span> <span class="bp">None</span>
 180 </div>
 181 <div class="viewcode-block" id="compute_delay_ms"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.timefuncs.compute_delay_ms">[docs]</a><span class="k">def</span> <span class="nf">compute_delay_ms</span><span class="p">(</span><span class="n">timestamp2</span><span class="p">,</span> <span class="n">timestamp1</span><span class="p">):</span>
 182     <span class="n">d1</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="n">timestamp1</span><span class="p">))</span>
 183     <span class="n">d2</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="n">timestamp2</span><span class="p">))</span>
 184     <span class="n">delay</span> <span class="o">=</span> <span class="n">d2</span> <span class="o">-</span> <span class="n">d1</span>
 185
 186     <span class="c"># round up resolution - round up to miliseconds</span>
 187     <span class="k">return</span> <span class="n">delay</span><span class="o">.</span><span class="n">total_seconds</span><span class="p">()</span> <span class="o">*</span> <span class="mi">1000</span>
 188 </pre></div></div>
 189
 190           </div>
 191         </div>
 192       </div>
 193       <div class="clearer"></div>
 194     </div>
 195     <div class="related">
 196       <h3>Navigation</h3>
 197       <ul>
 198         <li class="right" style="margin-right: 10px">
 199           <a href="../../../genindex.html" title="General Index"
 200              >index</a></li>
 201         <li class="right" >
 202           <a href="../../../py-modindex.html" title="Python Module Index"
 203              >modules</a> |</li>
 204         <li><a href="../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
 205           <li><a href="../../index.html" >Module code</a> &raquo;</li>
 206       </ul>
 207     </div>
 208     <div class="footer">
 209         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 210       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 211     </div>
 212   </body>
 213 </html>