/usr/share/doc/python-kiwi/api/kiwi.python.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 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 | <!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.python”</title>
</head>
<body><h1 class="module">Module k.python</h1><span id="part">Part of <a href="kiwi.html">kiwi</a></span><div class="toplevel"><div><p>Generic python addons</p>
</div></div><table class="children"><tr class="class"><td>Class</td><td><a href="kiwi.python.ClassInittableMetaType.html">ClassInittableMetaType</a></td><td><span class="undocumented">Undocumented</span></td></tr><tr class="class"><td>Class</td><td><a href="kiwi.python.ClassInittableObject.html">ClassInittableObject</a></td><td><div><p>I am an object which will call a classmethod called</p>
</div></td></tr><tr class="class"><td>Class</td><td><a href="kiwi.python._ForwardedProperty.html">_ForwardedProperty</a></td><td><span class="undocumented">Undocumented</span></td></tr><tr class="class"><td>Class</td><td><a href="kiwi.python.AttributeForwarder.html">AttributeForwarder</a></td><td><div><p>AttributeForwarder is an object which is used to forward certain</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.python.namedAny">namedAny</a></td><td><div><p>Get a fully named package, module, module-global object, or
attribute.</p>
</div></td></tr><tr class="class"><td>Class</td><td><a href="kiwi.python.Settable.html">Settable</a></td><td><div><p>A mixin class for syntactic sugar. Lets you assign attributes by</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.python.qual">qual</a></td><td><div><p>Convert a class to a string representation, which is the name of the
module</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.python.clamp">clamp</a></td><td><div><p>Ensures that x is between the limits set by low and high.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.python.slicerange">slicerange</a></td><td><div><p>Takes a slice object and returns a range iterator</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.python.deprecationwarn">deprecationwarn</a></td><td><div><p>Prints a deprecation warning</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.python.disabledeprecationcall">disabledeprecationcall</a></td><td><div><p>Disables all deprecation warnings during the function call to func</p>
</div></td></tr><tr class="class"><td>Class</td><td><a href="kiwi.python.enum.html">enum</a></td><td><div><p>enum is an enumered type implementation in python.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.python.all">all</a></td><td><div><p>Predict used to check if all items in a seq are True.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.python.any">any</a></td><td><div><p>Predict used to check if any item in a seq are True.</p>
</div></td></tr></table>
<div class="function">
<div class="functionHeader">def <a name="kiwi.python.namedAny">namedAny(name):</a></div>
<div class="functionBody"><div><p>Get a fully named package, module, module-global object, or
attribute.</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">name</span><span class="body"></span></div><div class="metadata"><span class="tag">returns</span> <span class="arg">None</span><span class="body">object, module or attribute
</span></div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.python.qual">qual(klass):</a></div>
<div class="functionBody"><div><p>Convert a class to a string representation, which is the name of the
module plut a dot plus the name of the class.</p>
</div><div class="metadata"><span class="tag">returns</span> <span class="arg">None</span><span class="body">fully qualified module and class name
</span></div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.python.clamp">clamp(x, low, high):</a></div>
<div class="functionBody"><div><p>Ensures that x is between the limits set by low and high. For example, *
clamp(5, 10, 15) is 10. * clamp(15, 5, 10) is 10. * clamp(20, 15, 25) is
20.</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">x</span><span class="body">the value to clamp.
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">low</span><span class="body">the minimum value allowed.
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">high</span><span class="body">the maximum value allowed.
</span></div><div class="metadata"><span class="tag">returns</span> <span class="arg">None</span><span class="body">the clamped value
</span></div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.python.slicerange">slicerange(slice, limit):</a></div>
<div class="functionBody"><div><p>Takes a slice object and returns a range iterator</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">slice</span><span class="body">slice object
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">limit</span><span class="body">maximum value allowed
</span></div><div class="metadata"><span class="tag">returns</span> <span class="arg">None</span><span class="body">iterator
</span></div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.python.deprecationwarn">deprecationwarn(msg, stacklevel=2):</a></div>
<div class="functionBody"><div><p>Prints a deprecation warning</p>
</div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.python.disabledeprecationcall">disabledeprecationcall(func, *args, **kwargs):</a></div>
<div class="functionBody"><div><p>Disables all deprecation warnings during the function call to func</p>
</div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.python.all">all(seq):</a></div>
<div class="functionBody"><div><p>Predict used to check if all items in a seq are True.</p>
</div><div class="metadata"><span class="tag">returns</span> <span class="arg">None</span><span class="body">True if all items in seq are True
</span></div></div>
</div>
<div class="function">
<div class="functionHeader">def <a name="kiwi.python.any">any(seq):</a></div>
<div class="functionBody"><div><p>Predict used to check if any item in a seq are True.</p>
</div><div class="metadata"><span class="tag">returns</span> <span class="arg">None</span><span class="body">True if any item in seq is True
</span></div></div>
</div></body>
|