1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 <title>nepi.util.timefuncs — NEPI 3.0 documentation</title>
11 <link rel="stylesheet" href="../../../_static/sphinxdoc.css" type="text/css" />
12 <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
14 <script type="text/javascript">
15 var DOCUMENTATION_OPTIONS = {
16 URL_ROOT: '../../../',
18 COLLAPSE_INDEX: false,
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.0 documentation" href="../../../index.html" />
27 <link rel="up" title="Module code" href="../../index.html" />
33 <li class="right" style="margin-right: 10px">
34 <a href="../../../genindex.html" title="General Index"
35 accesskey="I">index</a></li>
37 <a href="../../../py-modindex.html" title="Python Module Index"
39 <li><a href="../../../index.html">NEPI 3.0 documentation</a> »</li>
40 <li><a href="../../index.html" accesskey="U">Module code</a> »</li>
43 <div class="sphinxsidebar">
44 <div class="sphinxsidebarwrapper">
45 <div id="searchbox" style="display: none">
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" />
53 <p class="searchtip" style="font-size: 90%">
54 Enter search terms or a module, class or function name.
57 <script type="text/javascript">$('#searchbox').show(0);</script>
61 <div class="document">
62 <div class="documentwrapper">
63 <div class="bodywrapper">
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 <http://www.gnu.org/licenses/>.</span>
82 <span class="c">#</span>
83 <span class="c"># Author: Alina Quereilhac <alina.quereilhac@inria.fr></span>
86 <span class="kn">import</span> <span class="nn">datetime</span>
87 <span class="kn">import</span> <span class="nn">re</span>
89 <span class="n">_strf</span> <span class="o">=</span> <span class="s">"%Y%m</span><span class="si">%d</span><span class="s">%H%M%S</span><span class="si">%f</span><span class="s">"</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">"^\d{20}$"</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">"^(?P<time>\d+(.\d+)?)(?P<units>h|m|s|ms|us)$"</span><span class="p">)</span>
93 <span class="c"># Work around to fix "ImportError: Failed to import _strptime because the import lock is held by another thread."</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">"20120807124732894211"</span><span class="p">,</span> <span class="n">_strf</span><span class="p">)</span>
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">""" Constructs a datetime object from a string date with</span>
98 <span class="sd"> format YYYYMMddHHMMSSffff </span>
100 <span class="sd"> """</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>
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">""" 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"> """</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>
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>
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">""" Returns datetime object with the current time """</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>
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">""" 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"> """</span>
122 <span class="k">return</span> <span class="n">date1</span> <span class="o">-</span> <span class="n">date2</span>
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>
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">""" 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"> """</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>
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">""" 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 '5m' or '10s'). </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>
145 <span class="sd"> :param date : string date </span>
146 <span class="sd"> :type date : date </span>
148 <span class="sd"> """</span>
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>
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>
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">'time'</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">'units'</span><span class="p">]</span>
163 <span class="k">if</span> <span class="n">units</span> <span class="o">==</span> <span class="s">'h'</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">'m'</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">'s'</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">'ms'</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>
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>
177 <span class="k">return</span> <span class="n">dbase</span> <span class="o">+</span> <span class="n">delta</span>
179 <span class="k">return</span> <span class="bp">None</span>
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>
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>
193 <div class="clearer"></div>
195 <div class="related">
198 <li class="right" style="margin-right: 10px">
199 <a href="../../../genindex.html" title="General Index"
202 <a href="../../../py-modindex.html" title="Python Module Index"
204 <li><a href="../../../index.html">NEPI 3.0 documentation</a> »</li>
205 <li><a href="../../index.html" >Module code</a> »</li>
209 © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
210 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.