/usr/share/doc/python-pint-doc/html/serialization.html is in python-pint-doc 0.7.2-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 | <!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>Serialization — pint 0.7.2 documentation</title>
<link rel="stylesheet" href="_static/flasky.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.7.2',
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>
<link rel="top" title="pint 0.7.2 documentation" href="index.html" />
<link rel="next" title="Buckingham Pi Theorem" href="pitheorem.html" />
<link rel="prev" title="Wrapping and checking functions" href="wrapping.html" />
<link media="only screen and (max-device-width: 480px)" href="_static/small_flask.css" type= "text/css" rel="stylesheet" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="pitheorem.html" title="Buckingham Pi Theorem"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="wrapping.html" title="Wrapping and checking functions"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">pint 0.7.2 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="serialization">
<span id="id1"></span><h1>Serialization<a class="headerlink" href="#serialization" title="Permalink to this headline">ΒΆ</a></h1>
<p>In order to dump a <strong>Quantity</strong> to disk, store it in a database or
transmit it over the wire you need to be able to serialize and then
deserialize the object.</p>
<p>The easiest way to do this is by converting the quantity to a string:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pint</span>
<span class="gp">>>> </span><span class="n">ureg</span> <span class="o">=</span> <span class="n">pint</span><span class="o">.</span><span class="n">UnitRegistry</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">duration</span> <span class="o">=</span> <span class="mf">24.2</span> <span class="o">*</span> <span class="n">ureg</span><span class="o">.</span><span class="n">years</span>
<span class="gp">>>> </span><span class="n">duration</span>
<span class="go"><Quantity(24.2, 'year')></span>
<span class="gp">>>> </span><span class="n">serialized</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">duration</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">serialized</span><span class="p">)</span>
<span class="go">24.2 year</span>
</pre></div>
</div>
<p>Remember that you can easily control the number of digits in the representation
as shown in <a class="reference internal" href="tutorial.html#sec-string-formatting"><span class="std std-ref">String formatting</span></a>.</p>
<p>You dump/store/transmit the content of serialized (‘24.2 year’). When you want
to recover it in another process/machine, you just:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pint</span>
<span class="gp">>>> </span><span class="n">ureg</span> <span class="o">=</span> <span class="n">pint</span><span class="o">.</span><span class="n">UnitRegistry</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">duration</span> <span class="o">=</span> <span class="n">ureg</span><span class="p">(</span><span class="s1">'24.2 year'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">duration</span><span class="p">)</span>
<span class="go">24.2 year</span>
</pre></div>
</div>
<p>Notice that the serialized quantity is likely to be parsed in <strong>another</strong> registry
as shown in this example. Pint Quantities do not exist on their own but they are
always related to a <strong>UnitRegistry</strong>. Everything will work as expected if both registries,
are compatible (e.g. they were created using the same definition file). However, things
could go wrong if the registries are incompatible. For example, <strong>year</strong> could not be
defined in the target registry. Or what is even worse, it could be defined in a different
way. Always have to keep in mind that the interpretation and conversion of Quantities are
UnitRegistry dependent.</p>
<p>In certain cases, you want a binary representation of the data. Python’s standard algorithm
for serialization is called <a class="reference external" href="http://docs.python.org/3/library/pickle.html">Pickle</a>. Pint quantities implement the magic <cite>__reduce__</cite>
method and therefore can be <em>Pickled</em> and <em>Unpickled</em>. However, you have to bear in mind, that
the <strong>DEFAULT_REGISTRY</strong> is used for unpickling and this might be different from the one
that was used during pickling. If you want to have control over the deserialization, the
best way is to create a tuple with the magnitude and the units:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">to_serialize</span> <span class="o">=</span> <span class="n">duration</span><span class="o">.</span><span class="n">to_tuple</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">to_serialize</span><span class="p">)</span>
<span class="go">(24.2, (('year', 1.0),))</span>
</pre></div>
</div>
<p>And then you can just pickle that:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pickle</span>
<span class="gp">>>> </span><span class="n">serialized</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">to_serialize</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span>
</pre></div>
</div>
<p>To unpickle, just</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">loaded</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">serialized</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">ureg</span><span class="o">.</span><span class="n">Quantity</span><span class="o">.</span><span class="n">from_tuple</span><span class="p">(</span><span class="n">loaded</span><span class="p">)</span>
<span class="go"><Quantity(24.2, 'year')></span>
</pre></div>
</div>
<p>(To pickle to and from a file just use the dump and load method as described in _Pickle)</p>
<p>You can use the same mechanism with any serialization protocol, not only with binary ones.
(In fact, version 0 of the Pickle protocol is ASCII). Other common serialization protocols/packages
are <a class="reference external" href="http://docs.python.org/3/library/json.html">json</a>, <a class="reference external" href="http://pyyaml.org/">yaml</a>, <a class="reference external" href="http://docs.python.org/3.4/library/shelve.html">shelve</a>, <a class="reference external" href="http://www.h5py.org/">hdf5</a> (or via <a class="reference external" href="http://www.pytables.org">PyTables</a>) and <a class="reference external" href="https://pypi.python.org/pypi/dill">dill</a>.
Notice that not all of these packages will serialize properly the magnitude (which can be any
numerical type such as <cite>numpy.ndarray</cite>).</p>
<p>Using the <a class="reference external" href="https://github.com/hgrecco/serialize">serialize</a> package you can load and read from multiple formats:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">serialize</span> <span class="k">import</span> <span class="n">dump</span><span class="p">,</span> <span class="n">load</span><span class="p">,</span> <span class="n">register_class</span>
<span class="gp">>>> </span><span class="n">register_class</span><span class="p">(</span><span class="n">ureg</span><span class="o">.</span><span class="n">Quantity</span><span class="p">,</span> <span class="n">ureg</span><span class="o">.</span><span class="n">Quantity</span><span class="o">.</span><span class="n">to_tuple</span><span class="p">,</span> <span class="n">ureg</span><span class="o">.</span><span class="n">Quantity</span><span class="o">.</span><span class="n">from_tuple</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">dump</span><span class="p">(</span><span class="n">duration</span><span class="p">,</span> <span class="s1">'output.yaml'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">load</span><span class="p">(</span><span class="s1">'output.yaml'</span><span class="p">)</span>
</pre></div>
</div>
<p>(Check out the <a class="reference external" href="https://github.com/hgrecco/serialize">serialize</a> docs for more information)</p>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><p><a href="index.html">
<img src="_images/logo-full.jpg" alt="Logo" style="width:80%;height:80%"/>
</a></p>
<h3>About Pint</h3>
Units in Python.
You are currently looking at the documentation of version 0.7.2.
<h3>Other Formats</h3>
<p>
You can download the documentation in other formats as well:
</p>
<ul>
<li><a href="https://media.readthedocs.org/pdf/pint/latest/pint.pdf">as PDF</a>
<li><a href="https://media.readthedocs.org/htmlzip/pint/latest/pint.zip">as zipped HTML</a>
<li><a href="https://media.readthedocs.org/epub/pint/latest/pint.epub">as ePub</a>
</ul>
<h3>Useful Links</h3>
<ul>
<li><a href="https://pypi.python.org/pypi/Pint/">Pint @ PyPI</a></li>
<li><a href="https://github.com/hgrecco/pint">Code in GitHub</a></li>
<li><a href="https://github.com/hgrecco/pint/issues">Issue Tracker</a></li>
</ul>
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a></li>
<p>
<b>Previous</b><br/>
<a href="wrapping.html" title="previous chapter">Wrapping and checking functions</a>
</p>
<p>
<b>Next</b><br/>
<a href="pitheorem.html" title="next chapter">Buckingham Pi Theorem</a>
</p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/serialization.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<a href="http://github.com/hgrecco/pint"><img style="position: fixed; top: 0; right: 0; border: 0;"
src="" alt="Fork me on GitHub" /></a>
<div class="footer">
© Copyright 2016, Hernan E. Grecco. Pint 0.7.2.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
</body>
</html>
|