/usr/share/doc/python-kiwi/api/kiwi.model.PickledModel.html is in python-kiwi 1.9.22-2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html><head>
<link rel="stylesheet" type="text/css" href="apidocs.css"/>
<title>API docs for “kiwi.model.PickledModel”</title>
</head>
<body><h1 class="class">Class k.m.PickledModel(<a href="kiwi.model.Model.html">Model</a>):</h1><span id="part">Part of <a href="kiwi.model.html">kiwi.model</a></span><div class="toplevel"><div><p>PickledModel is a model that is able to save itself into a pickle using
save(). This has all the limitations of a pickle: its instance variables
must be picklable, or pickle.dump() will raise exceptions. You can prefix
variables with an underscore to make them non-persistent (and you can
restore them accordingly by overriding __setstate__, but don't forget to
call PickledModel.__setstate__)</p>
</div></div><table class="children"><tr class="function"><td>Function</td><td><a href="#kiwi.model.PickledModel.__init__">__init__</a></td><td><span class="undocumented">Undocumented</span></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.model.PickledModel.__getstate__">__getstate__</a></td><td><div><p>Gets the state from the instance to be pickled</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.model.PickledModel.__setstate__">__setstate__</a></td><td><div><p>Sets the state to the instance when being unpickled</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.model.PickledModel.save">save</a></td><td><div><p>Saves the instance to a pickle filename. If no filename argument is</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.model.PickledModel.set_filename">set_filename</a></td><td><div><p>Sets the name of the file which will be used to pickle the</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.model.PickledModel.unpickle">unpickle</a></td><td><div><p>Loads an instance from a pickle file; if it fails for some reason,</p>
</div></td></tr></table>
<div class="function">
<div class="functionHeader">def <a name="kiwi.model.PickledModel.__init__">__init__(self):</a></div>
<div class="functionBody"><div class="undocumented">Undocumented</div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.model.PickledModel.__getstate__">__getstate__(self):</a></div>
<div class="functionBody"><div><p>Gets the state from the instance to be pickled</p>
</div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.model.PickledModel.__setstate__">__setstate__(self, dict):</a></div>
<div class="functionBody"><div><p>Sets the state to the instance when being unpickled</p>
</div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.model.PickledModel.save">save(self, filename=None):</a></div>
<div class="functionBody"><div><p>Saves the instance to a pickle filename. If no filename argument is
provided, will try to use the internal _filename attribute that is set
using set_filename()</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">filename</span><span class="body">optional filename to pass in
</span></div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.model.PickledModel.set_filename">set_filename(self, filename):</a></div>
<div class="functionBody"><div><p>Sets the name of the file which will be used to pickle the model</p>
</div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.model.PickledModel.unpickle">unpickle(cls, filename=None):</a></div>
<div class="functionBody"><div><p>Loads an instance from a pickle file; if it fails for some reason,
create a new instance.</p>
<ul>
<li>
filename: the file from which the pickle should be loaded. If file is
not provided, the name of the class suffixed by ".pickle" is
used (i.e. "FooClass.pickle" for the class FooClass).
</li>
</ul>
<p>If the pickle file is damaged, it will be saved with the extension
".err"; if a file with that name also exists, it will use
".err.1" and so on. This is to avoid the damaged file being
clobbered by an instance calling save() unsuspectingly.</p>
</div></div>
</div></body>
|