update NEPI version on sphinx docs
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / util / serializer.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.serializer &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.serializer</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 <span class="kn">import</span> <span class="nn">datetime</span>
86 <span class="kn">import</span> <span class="nn">os</span>
87
88 <div class="viewcode-block" id="SFormats"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.serializer.SFormats">[docs]</a><span class="k">class</span> <span class="nc">SFormats</span><span class="p">:</span>
89     <span class="n">XML</span> <span class="o">=</span> <span class="s">&quot;xml&quot;</span>
90     </div>
91 <div class="viewcode-block" id="ECSerializer"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.serializer.ECSerializer">[docs]</a><span class="k">class</span> <span class="nc">ECSerializer</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
92 <div class="viewcode-block" id="ECSerializer.load"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.serializer.ECSerializer.load">[docs]</a>    <span class="k">def</span> <span class="nf">load</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filepath</span><span class="p">,</span> <span class="n">format</span> <span class="o">=</span> <span class="n">SFormats</span><span class="o">.</span><span class="n">XML</span><span class="p">):</span>
93         <span class="k">if</span> <span class="n">format</span> <span class="o">==</span> <span class="n">SFormats</span><span class="o">.</span><span class="n">XML</span><span class="p">:</span>
94             <span class="kn">from</span> <span class="nn">nepi.util.parsers.xml_parser</span> <span class="kn">import</span> <span class="n">ECXMLParser</span>
95             
96             <span class="n">parser</span> <span class="o">=</span> <span class="n">ECXMLParser</span><span class="p">()</span>
97             <span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">filepath</span><span class="p">,</span> <span class="s">&quot;r&quot;</span><span class="p">)</span>
98             <span class="n">xml</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
99             <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
100
101             <span class="n">ec</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">from_xml</span><span class="p">(</span><span class="n">xml</span><span class="p">)</span>
102
103         <span class="k">return</span> <span class="n">ec</span>
104 </div>
105 <div class="viewcode-block" id="ECSerializer.serialize"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.serializer.ECSerializer.serialize">[docs]</a>    <span class="k">def</span> <span class="nf">serialize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ec</span><span class="p">,</span> <span class="n">format</span> <span class="o">=</span> <span class="n">SFormats</span><span class="o">.</span><span class="n">XML</span><span class="p">):</span>
106         <span class="k">if</span> <span class="n">format</span> <span class="o">==</span> <span class="n">SFormats</span><span class="o">.</span><span class="n">XML</span><span class="p">:</span>
107             <span class="kn">from</span> <span class="nn">nepi.util.parsers.xml_parser</span> <span class="kn">import</span> <span class="n">ECXMLParser</span>
108             
109             <span class="n">parser</span> <span class="o">=</span> <span class="n">ECXMLParser</span><span class="p">()</span>
110             <span class="n">sec</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">to_xml</span><span class="p">(</span><span class="n">ec</span><span class="p">)</span>
111
112         <span class="k">return</span> <span class="n">sec</span>
113 </div>
114 <div class="viewcode-block" id="ECSerializer.save"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.serializer.ECSerializer.save">[docs]</a>    <span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ec</span><span class="p">,</span> <span class="n">dirpath</span><span class="p">,</span> <span class="n">format</span> <span class="o">=</span> <span class="n">SFormats</span><span class="o">.</span><span class="n">XML</span><span class="p">):</span>
115         <span class="n">date</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">now</span><span class="p">()</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s">&#39;%Y%m</span><span class="si">%d</span><span class="s">%H%M%S&#39;</span><span class="p">)</span>
116         <span class="n">filename</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">_</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">ec</span><span class="o">.</span><span class="n">exp_id</span><span class="p">,</span> <span class="n">date</span><span class="p">)</span>
117
118         <span class="k">if</span> <span class="n">format</span> <span class="o">==</span> <span class="n">SFormats</span><span class="o">.</span><span class="n">XML</span><span class="p">:</span>
119             <span class="n">filepath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">dirpath</span><span class="p">,</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">.xml&quot;</span> <span class="o">%</span> <span class="n">filename</span><span class="p">)</span>
120             <span class="n">sec</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="n">ec</span><span class="p">,</span> <span class="n">format</span> <span class="o">=</span> <span class="n">format</span><span class="p">)</span>
121             <span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">filepath</span><span class="p">,</span> <span class="s">&quot;w&quot;</span><span class="p">)</span>
122             <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">sec</span><span class="p">)</span>
123             <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
124
125         <span class="k">return</span> <span class="n">filepath</span>
126 </pre></div></div></div>
127
128           </div>
129         </div>
130       </div>
131       <div class="clearer"></div>
132     </div>
133     <div class="related">
134       <h3>Navigation</h3>
135       <ul>
136         <li class="right" style="margin-right: 10px">
137           <a href="../../../genindex.html" title="General Index"
138              >index</a></li>
139         <li class="right" >
140           <a href="../../../py-modindex.html" title="Python Module Index"
141              >modules</a> |</li>
142         <li><a href="../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
143           <li><a href="../../index.html" >Module code</a> &raquo;</li> 
144       </ul>
145     </div>
146     <div class="footer">
147         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
148       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
149     </div>
150   </body>
151 </html>