<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>stem.util.str_tools — Stem 1.1.0 documentation</title>
<link rel="stylesheet" href="../../../_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/print.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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/theme_extras.js"></script>
<link rel="shortcut icon" href="../../../_static/favicon.png"/>
<link rel="top" title="Stem 1.1.0 documentation" href="../../../index.html" />
<link rel="up" title="stem" href="../../stem.html" />
</head>
<body>
<div class="header"><img class="rightlogo" src="../../../_static/logo.png" alt="Logo"/><h1 class="heading"><a href="../../../index.html">
<span>Stem Docs</span></a></h1>
<h2 class="heading"><span>stem.util.str_tools</span></h2>
</div>
<div class="topnav">
<p>
<ul id="navbar">
<li><a href="../../../index.html">Home</a></li>
<li><a href="../../../tutorials.html">Tutorials</a>
<ul>
<li><a href="../../../tutorials/the_little_relay_that_could.html">Hello World</a></li>
<li><a href="../../../tutorials/to_russia_with_love.html">Client Usage</a></li>
<li><a href="../../../tutorials/tortoise_and_the_hare.html">Event Listening</a></li>
<li><a href="../../../tutorials/mirror_mirror_on_the_wall.html">Tor Descriptors</a></li>
<li><a href="../../../tutorials/east_of_the_sun.html">Utilities</a></li>
<li><a href="../../../tutorials/double_double_toil_and_trouble.html">Examples</a></li>
</ul>
</li>
<li><a href="../../../api.html">API</a>
<ul>
<li><a href="../../../api/control.html">stem.control</a></li>
<li><a href="../../../api/connection.html">stem.connection</a></li>
<li><a href="../../../api/socket.html">stem.socket</a></li>
<li><a href="../../../api/process.html">stem.process</a></li>
<li><a href="../../../api/response.html">stem.response</a></li>
<li><a href="../../../api/exit_policy.html">stem.exit_policy</a></li>
<li><a href="../../../api/version.html">stem.version</a></li>
<li><a href="../../../api.html#descriptors">Descriptors</a></li>
<li><a href="../../../api.html#utilities">Utilities</a></li>
</ul>
</li>
<li><a href="https://trac.torproject.org/projects/tor/wiki/doc/stem">Development</a>
<ul>
<li><a href="../../../faq.html">FAQ</a></li>
<li><a href="../../../change_log.html">Change Log</a></li>
<li><a href="https://trac.torproject.org/projects/tor/wiki/doc/stem/bugs">Bug Tracker</a></li>
<li><a href="../../../download.html">Download</a></li>
</ul>
</li>
</ul>
</p>
</div>
<div class="content">
<h1>Source code for stem.util.str_tools</h1><div class="highlight"><pre>
<span class="c"># Copyright 2012-2013, Damian Johnson and The Tor Project</span>
<span class="c"># See LICENSE for licensing information</span>
<span class="sd">"""</span>
<span class="sd">Toolkit for various string activity.</span>
<span class="sd">**Module Overview:**</span>
<span class="sd">::</span>
<span class="sd"> get_size_label - human readable label for a number of bytes</span>
<span class="sd"> get_time_label - human readable label for a number of seconds</span>
<span class="sd"> get_time_labels - human readable labels for each time unit</span>
<span class="sd"> get_short_time_label - condensed time label output</span>
<span class="sd"> parse_short_time_label - seconds represented by a short time label</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">codecs</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="kn">import</span> <span class="nn">stem.prereq</span>
<span class="c"># label conversion tuples of the form...</span>
<span class="c"># (bits / bytes / seconds, short label, long label)</span>
<span class="n">SIZE_UNITS_BITS</span> <span class="o">=</span> <span class="p">(</span>
<span class="p">(</span><span class="mf">140737488355328.0</span><span class="p">,</span> <span class="s">" Pb"</span><span class="p">,</span> <span class="s">" Petabit"</span><span class="p">),</span>
<span class="p">(</span><span class="mf">137438953472.0</span><span class="p">,</span> <span class="s">" Tb"</span><span class="p">,</span> <span class="s">" Terabit"</span><span class="p">),</span>
<span class="p">(</span><span class="mf">134217728.0</span><span class="p">,</span> <span class="s">" Gb"</span><span class="p">,</span> <span class="s">" Gigabit"</span><span class="p">),</span>
<span class="p">(</span><span class="mf">131072.0</span><span class="p">,</span> <span class="s">" Mb"</span><span class="p">,</span> <span class="s">" Megabit"</span><span class="p">),</span>
<span class="p">(</span><span class="mf">128.0</span><span class="p">,</span> <span class="s">" Kb"</span><span class="p">,</span> <span class="s">" Kilobit"</span><span class="p">),</span>
<span class="p">(</span><span class="mf">0.125</span><span class="p">,</span> <span class="s">" b"</span><span class="p">,</span> <span class="s">" Bit"</span><span class="p">),</span>
<span class="p">)</span>
<span class="n">SIZE_UNITS_BYTES</span> <span class="o">=</span> <span class="p">(</span>
<span class="p">(</span><span class="mf">1125899906842624.0</span><span class="p">,</span> <span class="s">" PB"</span><span class="p">,</span> <span class="s">" Petabyte"</span><span class="p">),</span>
<span class="p">(</span><span class="mf">1099511627776.0</span><span class="p">,</span> <span class="s">" TB"</span><span class="p">,</span> <span class="s">" Terabyte"</span><span class="p">),</span>
<span class="p">(</span><span class="mf">1073741824.0</span><span class="p">,</span> <span class="s">" GB"</span><span class="p">,</span> <span class="s">" Gigabyte"</span><span class="p">),</span>
<span class="p">(</span><span class="mf">1048576.0</span><span class="p">,</span> <span class="s">" MB"</span><span class="p">,</span> <span class="s">" Megabyte"</span><span class="p">),</span>
<span class="p">(</span><span class="mf">1024.0</span><span class="p">,</span> <span class="s">" KB"</span><span class="p">,</span> <span class="s">" Kilobyte"</span><span class="p">),</span>
<span class="p">(</span><span class="mf">1.0</span><span class="p">,</span> <span class="s">" B"</span><span class="p">,</span> <span class="s">" Byte"</span><span class="p">),</span>
<span class="p">)</span>
<span class="n">TIME_UNITS</span> <span class="o">=</span> <span class="p">(</span>
<span class="p">(</span><span class="mf">86400.0</span><span class="p">,</span> <span class="s">"d"</span><span class="p">,</span> <span class="s">" day"</span><span class="p">),</span>
<span class="p">(</span><span class="mf">3600.0</span><span class="p">,</span> <span class="s">"h"</span><span class="p">,</span> <span class="s">" hour"</span><span class="p">),</span>
<span class="p">(</span><span class="mf">60.0</span><span class="p">,</span> <span class="s">"m"</span><span class="p">,</span> <span class="s">" minute"</span><span class="p">),</span>
<span class="p">(</span><span class="mf">1.0</span><span class="p">,</span> <span class="s">"s"</span><span class="p">,</span> <span class="s">" second"</span><span class="p">),</span>
<span class="p">)</span>
<span class="k">if</span> <span class="n">stem</span><span class="o">.</span><span class="n">prereq</span><span class="o">.</span><span class="n">is_python_3</span><span class="p">():</span>
<span class="k">def</span> <span class="nf">_to_bytes_impl</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">return</span> <span class="n">codecs</span><span class="o">.</span><span class="n">latin_1_encode</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="s">"replace"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">msg</span>
<span class="k">def</span> <span class="nf">_to_unicode_impl</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
<span class="k">if</span> <span class="n">msg</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">return</span> <span class="n">msg</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">"utf-8"</span><span class="p">,</span> <span class="s">"replace"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">msg</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">_to_bytes_impl</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
<span class="k">if</span> <span class="n">msg</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="nb">unicode</span><span class="p">):</span>
<span class="k">return</span> <span class="n">codecs</span><span class="o">.</span><span class="n">latin_1_encode</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="s">"replace"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">msg</span>
<span class="k">def</span> <span class="nf">_to_unicode_impl</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
<span class="k">if</span> <span class="n">msg</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="nb">unicode</span><span class="p">):</span>
<span class="k">return</span> <span class="n">msg</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">"utf-8"</span><span class="p">,</span> <span class="s">"replace"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">msg</span>
<span class="k">def</span> <span class="nf">_to_bytes</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Provides the ASCII bytes for the given string. This is purely to provide</span>
<span class="sd"> python 3 compatability, normalizing the unicode/ASCII change in the version</span>
<span class="sd"> bump. For an explanation of this see...</span>
<span class="sd"> http://python3porting.com/problems.html#nicer-solutions</span>
<span class="sd"> :param str,unicode msg: string to be converted</span>
<span class="sd"> :returns: ASCII bytes for string</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">_to_bytes_impl</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_to_unicode</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Provides the unicode string for the given ASCII bytes. This is purely to</span>
<span class="sd"> provide python 3 compatability, normalizing the unicode/ASCII change in the</span>
<span class="sd"> version bump.</span>
<span class="sd"> :param str,unicode msg: string to be converted</span>
<span class="sd"> :returns: unicode conversion</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">_to_unicode_impl</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_to_camel_case</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">divider</span> <span class="o">=</span> <span class="s">"_"</span><span class="p">,</span> <span class="n">joiner</span> <span class="o">=</span> <span class="s">" "</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Converts the given string to camel case, ie:</span>
<span class="sd"> ::</span>
<span class="sd"> >>> _to_camel_case("I_LIKE_PEPPERJACK!")</span>
<span class="sd"> 'I Like Pepperjack!'</span>
<span class="sd"> :param str label: input string to be converted</span>
<span class="sd"> :param str divider: word boundary</span>
<span class="sd"> :param str joiner: replacement for word boundaries</span>
<span class="sd"> :returns: camel cased string</span>
<span class="sd"> """</span>
<span class="n">words</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">label</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">divider</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">entry</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">words</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">""</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">entry</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">words</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">entry</span><span class="o">.</span><span class="n">upper</span><span class="p">())</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">words</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">entry</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="o">+</span> <span class="n">entry</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span><span class="o">.</span><span class="n">lower</span><span class="p">())</span>
<span class="k">return</span> <span class="n">joiner</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">words</span><span class="p">)</span>
<div class="viewcode-block" id="get_size_label"><a class="viewcode-back" href="../../../api/util/str_tools.html#stem.util.str_tools.get_size_label">[docs]</a><span class="k">def</span> <span class="nf">get_size_label</span><span class="p">(</span><span class="n">byte_count</span><span class="p">,</span> <span class="n">decimal</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">is_long</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span> <span class="n">is_bytes</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Converts a number of bytes into a human readable label in its most</span>
<span class="sd"> significant units. For instance, 7500 bytes would return "7 KB". If the</span>
<span class="sd"> is_long option is used this expands unit labels to be the properly pluralized</span>
<span class="sd"> full word (for instance 'Kilobytes' rather than 'KB'). Units go up through</span>
<span class="sd"> petabytes.</span>
<span class="sd"> ::</span>
<span class="sd"> >>> get_size_label(2000000)</span>
<span class="sd"> '1 MB'</span>
<span class="sd"> >>> get_size_label(1050, 2)</span>
<span class="sd"> '1.02 KB'</span>
<span class="sd"> >>> get_size_label(1050, 3, True)</span>
<span class="sd"> '1.025 Kilobytes'</span>
<span class="sd"> :param int byte_count: number of bytes to be converted</span>
<span class="sd"> :param int decimal: number of decimal digits to be included</span>
<span class="sd"> :param bool is_long: expands units label</span>
<span class="sd"> :param bool is_bytes: provides units in bytes if **True**, bits otherwise</span>
<span class="sd"> :returns: **str** with human readable representation of the size</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">is_bytes</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_get_label</span><span class="p">(</span><span class="n">SIZE_UNITS_BYTES</span><span class="p">,</span> <span class="n">byte_count</span><span class="p">,</span> <span class="n">decimal</span><span class="p">,</span> <span class="n">is_long</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_get_label</span><span class="p">(</span><span class="n">SIZE_UNITS_BITS</span><span class="p">,</span> <span class="n">byte_count</span><span class="p">,</span> <span class="n">decimal</span><span class="p">,</span> <span class="n">is_long</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="get_time_label"><a class="viewcode-back" href="../../../api/util/str_tools.html#stem.util.str_tools.get_time_label">[docs]</a><span class="k">def</span> <span class="nf">get_time_label</span><span class="p">(</span><span class="n">seconds</span><span class="p">,</span> <span class="n">decimal</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">is_long</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Converts seconds into a time label truncated to its most significant units.</span>
<span class="sd"> For instance, 7500 seconds would return "2h". Units go up through days.</span>
<span class="sd"> This defaults to presenting single character labels, but if the is_long</span>
<span class="sd"> option is used this expands labels to be the full word (space included and</span>
<span class="sd"> properly pluralized). For instance, "4h" would be "4 hours" and "1m" would</span>
<span class="sd"> become "1 minute".</span>
<span class="sd"> ::</span>
<span class="sd"> >>> get_time_label(10000)</span>
<span class="sd"> '2h'</span>
<span class="sd"> >>> get_time_label(61, 1, True)</span>
<span class="sd"> '1.0 minute'</span>
<span class="sd"> >>> get_time_label(61, 2, True)</span>
<span class="sd"> '1.01 minutes'</span>
<span class="sd"> :param int seconds: number of seconds to be converted</span>
<span class="sd"> :param int decimal: number of decimal digits to be included</span>
<span class="sd"> :param bool is_long: expands units label</span>
<span class="sd"> :returns: **str** with human readable representation of the time</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">_get_label</span><span class="p">(</span><span class="n">TIME_UNITS</span><span class="p">,</span> <span class="n">seconds</span><span class="p">,</span> <span class="n">decimal</span><span class="p">,</span> <span class="n">is_long</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="get_time_labels"><a class="viewcode-back" href="../../../api/util/str_tools.html#stem.util.str_tools.get_time_labels">[docs]</a><span class="k">def</span> <span class="nf">get_time_labels</span><span class="p">(</span><span class="n">seconds</span><span class="p">,</span> <span class="n">is_long</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Provides a list of label conversions for each time unit, starting with its</span>
<span class="sd"> most significant units on down. Any counts that evaluate to zero are omitted.</span>
<span class="sd"> For example...</span>
<span class="sd"> ::</span>
<span class="sd"> >>> get_time_labels(400)</span>
<span class="sd"> ['6m', '40s']</span>
<span class="sd"> >>> get_time_labels(3640, True)</span>
<span class="sd"> ['1 hour', '40 seconds']</span>
<span class="sd"> :param int seconds: number of seconds to be converted</span>
<span class="sd"> :param bool is_long: expands units label</span>
<span class="sd"> :returns: **list** of strings with human readable representations of the time</span>
<span class="sd"> """</span>
<span class="n">time_labels</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">count_per_unit</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="ow">in</span> <span class="n">TIME_UNITS</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">abs</span><span class="p">(</span><span class="n">seconds</span><span class="p">)</span> <span class="o">>=</span> <span class="n">count_per_unit</span><span class="p">:</span>
<span class="n">time_labels</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">_get_label</span><span class="p">(</span><span class="n">TIME_UNITS</span><span class="p">,</span> <span class="n">seconds</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">is_long</span><span class="p">))</span>
<span class="n">seconds</span> <span class="o">%=</span> <span class="n">count_per_unit</span>
<span class="k">return</span> <span class="n">time_labels</span>
</div>
<div class="viewcode-block" id="get_short_time_label"><a class="viewcode-back" href="../../../api/util/str_tools.html#stem.util.str_tools.get_short_time_label">[docs]</a><span class="k">def</span> <span class="nf">get_short_time_label</span><span class="p">(</span><span class="n">seconds</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Provides a time in the following format:</span>
<span class="sd"> [[dd-]hh:]mm:ss</span>
<span class="sd"> ::</span>
<span class="sd"> >>> get_short_time_label(111)</span>
<span class="sd"> '01:51'</span>
<span class="sd"> >>> get_short_time_label(544100)</span>
<span class="sd"> '6-07:08:20'</span>
<span class="sd"> :param int seconds: number of seconds to be converted</span>
<span class="sd"> :returns: **str** with the short representation for the time</span>
<span class="sd"> :raises: **ValueError** if the input is negative</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">seconds</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Input needs to be a non-negative integer, got '</span><span class="si">%i</span><span class="s">'"</span> <span class="o">%</span> <span class="n">seconds</span><span class="p">)</span>
<span class="n">time_comp</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">amount</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">label</span> <span class="ow">in</span> <span class="n">TIME_UNITS</span><span class="p">:</span>
<span class="n">count</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">seconds</span> <span class="o">/</span> <span class="n">amount</span><span class="p">)</span>
<span class="n">seconds</span> <span class="o">%=</span> <span class="n">amount</span>
<span class="n">time_comp</span><span class="p">[</span><span class="n">label</span><span class="o">.</span><span class="n">strip</span><span class="p">()]</span> <span class="o">=</span> <span class="n">count</span>
<span class="n">label</span> <span class="o">=</span> <span class="s">"</span><span class="si">%02i</span><span class="s">:</span><span class="si">%02i</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">time_comp</span><span class="p">[</span><span class="s">"minute"</span><span class="p">],</span> <span class="n">time_comp</span><span class="p">[</span><span class="s">"second"</span><span class="p">])</span>
<span class="k">if</span> <span class="n">time_comp</span><span class="p">[</span><span class="s">"day"</span><span class="p">]:</span>
<span class="n">label</span> <span class="o">=</span> <span class="s">"</span><span class="si">%i</span><span class="s">-</span><span class="si">%02i</span><span class="s">:</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">time_comp</span><span class="p">[</span><span class="s">"day"</span><span class="p">],</span> <span class="n">time_comp</span><span class="p">[</span><span class="s">"hour"</span><span class="p">],</span> <span class="n">label</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">time_comp</span><span class="p">[</span><span class="s">"hour"</span><span class="p">]:</span>
<span class="n">label</span> <span class="o">=</span> <span class="s">"</span><span class="si">%02i</span><span class="s">:</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">time_comp</span><span class="p">[</span><span class="s">"hour"</span><span class="p">],</span> <span class="n">label</span><span class="p">)</span>
<span class="k">return</span> <span class="n">label</span>
</div>
<div class="viewcode-block" id="parse_short_time_label"><a class="viewcode-back" href="../../../api/util/str_tools.html#stem.util.str_tools.parse_short_time_label">[docs]</a><span class="k">def</span> <span class="nf">parse_short_time_label</span><span class="p">(</span><span class="n">label</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Provides the number of seconds corresponding to the formatting used for the</span>
<span class="sd"> cputime and etime fields of ps:</span>
<span class="sd"> [[dd-]hh:]mm:ss or mm:ss.ss</span>
<span class="sd"> ::</span>
<span class="sd"> >>> parse_short_time_label('01:51')</span>
<span class="sd"> 111</span>
<span class="sd"> >>> parse_short_time_label('6-07:08:20')</span>
<span class="sd"> 544100</span>
<span class="sd"> :param str label: time entry to be parsed</span>
<span class="sd"> :returns: **int** with the number of seconds represented by the label</span>
<span class="sd"> :raises: **ValueError** if input is malformed</span>
<span class="sd"> """</span>
<span class="n">days</span><span class="p">,</span> <span class="n">hours</span><span class="p">,</span> <span class="n">minutes</span><span class="p">,</span> <span class="n">seconds</span> <span class="o">=</span> <span class="s">'0'</span><span class="p">,</span> <span class="s">'0'</span><span class="p">,</span> <span class="s">'0'</span><span class="p">,</span> <span class="s">'0'</span>
<span class="k">if</span> <span class="s">'-'</span> <span class="ow">in</span> <span class="n">label</span><span class="p">:</span>
<span class="n">days</span><span class="p">,</span> <span class="n">label</span> <span class="o">=</span> <span class="n">label</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'-'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="n">time_comp</span> <span class="o">=</span> <span class="n">label</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">":"</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">time_comp</span><span class="p">)</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
<span class="n">hours</span><span class="p">,</span> <span class="n">minutes</span><span class="p">,</span> <span class="n">seconds</span> <span class="o">=</span> <span class="n">time_comp</span>
<span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">time_comp</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">minutes</span><span class="p">,</span> <span class="n">seconds</span> <span class="o">=</span> <span class="n">time_comp</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Invalid time format, we expected '[[dd-]hh:]mm:ss' or 'mm:ss.ss': </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">label</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">time_sum</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="n">seconds</span><span class="p">))</span>
<span class="n">time_sum</span> <span class="o">+=</span> <span class="nb">int</span><span class="p">(</span><span class="n">minutes</span><span class="p">)</span> <span class="o">*</span> <span class="mi">60</span>
<span class="n">time_sum</span> <span class="o">+=</span> <span class="nb">int</span><span class="p">(</span><span class="n">hours</span><span class="p">)</span> <span class="o">*</span> <span class="mi">3600</span>
<span class="n">time_sum</span> <span class="o">+=</span> <span class="nb">int</span><span class="p">(</span><span class="n">days</span><span class="p">)</span> <span class="o">*</span> <span class="mi">86400</span>
<span class="k">return</span> <span class="n">time_sum</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Non-numeric value in time entry: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">label</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">_parse_iso_timestamp</span><span class="p">(</span><span class="n">entry</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Parses the ISO 8601 standard that provides for timestamps like...</span>
<span class="sd"> ::</span>
<span class="sd"> 2012-11-08T16:48:41.420251</span>
<span class="sd"> :param str entry: timestamp to be parsed</span>
<span class="sd"> :returns: datetime for the time represented by the timestamp</span>
<span class="sd"> :raises: ValueError if the timestamp is malformed</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"parse_iso_timestamp() input must be a str, got a </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="nb">type</span><span class="p">(</span><span class="n">entry</span><span class="p">))</span>
<span class="c"># based after suggestions from...</span>
<span class="c"># http://stackoverflow.com/questions/127803/how-to-parse-iso-formatted-date-in-python</span>
<span class="k">if</span> <span class="s">'.'</span> <span class="ow">in</span> <span class="n">entry</span><span class="p">:</span>
<span class="n">timestamp_str</span><span class="p">,</span> <span class="n">microseconds</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'.'</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">timestamp_str</span><span class="p">,</span> <span class="n">microseconds</span> <span class="o">=</span> <span class="n">entry</span><span class="p">,</span> <span class="s">'000000'</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">microseconds</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">6</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">microseconds</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"timestamp's microseconds should be six digits"</span><span class="p">)</span>
<span class="n">timestamp</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">strptime</span><span class="p">(</span><span class="n">timestamp_str</span><span class="p">,</span> <span class="s">"%Y-%m-</span><span class="si">%d</span><span class="s">T%H:%M:%S"</span><span class="p">)</span>
<span class="k">return</span> <span class="n">timestamp</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="nb">int</span><span class="p">(</span><span class="n">microseconds</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">_get_label</span><span class="p">(</span><span class="n">units</span><span class="p">,</span> <span class="n">count</span><span class="p">,</span> <span class="n">decimal</span><span class="p">,</span> <span class="n">is_long</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Provides label corresponding to units of the highest significance in the</span>
<span class="sd"> provided set. This rounds down (ie, integer truncation after visible units).</span>
<span class="sd"> :param tuple units: type of units to be used for conversion, containing</span>
<span class="sd"> (count_per_unit, short_label, long_label)</span>
<span class="sd"> :param int count: number of base units being converted</span>
<span class="sd"> :param int decimal: decimal precision of label</span>
<span class="sd"> :param bool is_long: uses the long label if **True**, short label otherwise</span>
<span class="sd"> """</span>
<span class="c"># formatted string for the requested number of digits</span>
<span class="n">label_format</span> <span class="o">=</span> <span class="s">"</span><span class="si">%%</span><span class="s">.</span><span class="si">%i</span><span class="s">f"</span> <span class="o">%</span> <span class="n">decimal</span>
<span class="k">if</span> <span class="n">count</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">label_format</span> <span class="o">=</span> <span class="s">"-"</span> <span class="o">+</span> <span class="n">label_format</span>
<span class="n">count</span> <span class="o">=</span> <span class="nb">abs</span><span class="p">(</span><span class="n">count</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">count</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">units_label</span> <span class="o">=</span> <span class="n">units</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">][</span><span class="mi">2</span><span class="p">]</span> <span class="o">+</span> <span class="s">"s"</span> <span class="k">if</span> <span class="n">is_long</span> <span class="k">else</span> <span class="n">units</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span>
<span class="k">return</span> <span class="s">"</span><span class="si">%s%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">label_format</span> <span class="o">%</span> <span class="n">count</span><span class="p">,</span> <span class="n">units_label</span><span class="p">)</span>
<span class="k">for</span> <span class="n">count_per_unit</span><span class="p">,</span> <span class="n">short_label</span><span class="p">,</span> <span class="n">long_label</span> <span class="ow">in</span> <span class="n">units</span><span class="p">:</span>
<span class="k">if</span> <span class="n">count</span> <span class="o">>=</span> <span class="n">count_per_unit</span><span class="p">:</span>
<span class="c"># Rounding down with a '%f' is a little clunky. Reducing the count so</span>
<span class="c"># it'll divide evenly as the rounded down value.</span>
<span class="n">count</span> <span class="o">-=</span> <span class="n">count</span> <span class="o">%</span> <span class="p">(</span><span class="n">count_per_unit</span> <span class="o">/</span> <span class="p">(</span><span class="mi">10</span> <span class="o">**</span> <span class="n">decimal</span><span class="p">))</span>
<span class="n">count_label</span> <span class="o">=</span> <span class="n">label_format</span> <span class="o">%</span> <span class="p">(</span><span class="n">count</span> <span class="o">/</span> <span class="n">count_per_unit</span><span class="p">)</span>
<span class="k">if</span> <span class="n">is_long</span><span class="p">:</span>
<span class="c"># Pluralize if any of the visible units make it greater than one. For</span>
<span class="c"># instance 1.0003 is plural but 1.000 isn't.</span>
<span class="k">if</span> <span class="n">decimal</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="n">is_plural</span> <span class="o">=</span> <span class="n">count</span> <span class="o">></span> <span class="n">count_per_unit</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">is_plural</span> <span class="o">=</span> <span class="n">count</span> <span class="o">>=</span> <span class="n">count_per_unit</span> <span class="o">*</span> <span class="mi">2</span>
<span class="k">return</span> <span class="n">count_label</span> <span class="o">+</span> <span class="n">long_label</span> <span class="o">+</span> <span class="p">(</span><span class="s">"s"</span> <span class="k">if</span> <span class="n">is_plural</span> <span class="k">else</span> <span class="s">""</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">count_label</span> <span class="o">+</span> <span class="n">short_label</span>
</pre></div>
</div>
<div class="bottomnav">
</div>
<div class="footer">
</div>
</body>
</html>
