/usr/share/doc/python-kiwi/api/kiwi.python.html is in python-kiwi 1.9.22-4.
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 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 | <?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html>
<head>
<title>kiwi.python : API documentation</title>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<link type="text/css" rel="stylesheet" href="bootstrap.min.css" />
<link type="text/css" rel="stylesheet" href="apidocs.css" />
</head>
<body>
<nav class="navbar navbar-default">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">
Kiwi API Documentation
</a>
</div>
</div>
</nav>
<div id="showPrivate">
<button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
</div>
<div class="container">
<div class="page-header">
<h1 class="module"><code>kiwi.python</code> <small>module documentation</small></h1>
<span id="partOf">
Part of <code><a href="kiwi.html" data-type="Package" class="code">kiwi</a></code>
</span>
</div>
<div class="extrasDocstring">
</div>
<div class="moduleDocstring">
<div><p>Generic python addons</p><table class="fieldTable"></table></div>
</div>
<div id="splitTables">
<table class="children sortable" id="id60">
<tr class="class">
<td>Class</td>
<td><a href="kiwi.python.ClassInittableMetaType.html" data-type="Class" class="code">ClassInittableMetaType</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="class">
<td>Class</td>
<td><a href="kiwi.python.ClassInittableObject.html" data-type="Class" class="code">ClassInittableObject</a></td>
<td><span>I am an object which will call a classmethod called __class_init__ when
I am created. Subclasses of me will also have __class_init__ called.</span></td>
</tr><tr class="class">
<td>Class</td>
<td><a href="kiwi.python.AttributeForwarder.html" data-type="Class" class="code">AttributeForwarder</a></td>
<td><span>AttributeForwarder is an object which is used to forward certain
attributes to another object.</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.python.html#namedAny" data-type="Function" class="code">namedAny</a></td>
<td><span>Get a fully named package, module, module-global object, or
attribute.</span></td>
</tr><tr class="class">
<td>Class</td>
<td><a href="kiwi.python.Settable.html" data-type="Class" class="code">Settable</a></td>
<td><span class="undocumented">No summary</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.python.html#qual" data-type="Function" class="code">qual</a></td>
<td><span>Convert a class to a string representation, which is the name of the
module plut a dot plus the name of the class.</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.python.html#clamp" data-type="Function" class="code">clamp</a></td>
<td><span class="undocumented">No summary</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.python.html#slicerange" data-type="Function" class="code">slicerange</a></td>
<td><span>Takes a slice object and returns a range iterator</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.python.html#deprecationwarn" data-type="Function" class="code">deprecationwarn</a></td>
<td><span>Prints a deprecation warning</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.python.html#disabledeprecationcall" data-type="Function" class="code">disabledeprecationcall</a></td>
<td><span>Disables all deprecation warnings during the function call to func</span></td>
</tr><tr class="class">
<td>Class</td>
<td><a href="kiwi.python.enum.html" data-type="Class" class="code">enum</a></td>
<td><span>enum is an enumered type implementation in python.</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.python.html#all" data-type="Function" class="code">all</a></td>
<td><span>Predict used to check if all items in a seq are True. @returns: True if
all items in seq are True</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.python.html#any" data-type="Function" class="code">any</a></td>
<td><span>Predict used to check if any item in a seq are True. @returns: True if
any item in seq is True</span></td>
</tr><tr class="class private">
<td>Class</td>
<td><a href="kiwi.python._ForwardedProperty.html" data-type="Class" class="code">_ForwardedProperty</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr>
</table>
</div>
<div id="childList">
<div class="basefunction">
<a name="kiwi.python.namedAny">
</a>
<a name="namedAny">
</a>
<div class="functionHeader">
def
namedAny(name):
</div>
<div class="docstring functionBody">
<div><p>Get a fully named package, module, module-global object, or
attribute.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">name</td><td></td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">object, module or attribute</td></tr></table></div>
</div>
</div><div class="basefunction">
<a name="kiwi.python.qual">
</a>
<a name="qual">
</a>
<div class="functionHeader">
def
qual(klass):
</div>
<div class="docstring 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><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">fully qualified module and class name</td></tr></table></div>
</div>
</div><div class="basefunction">
<a name="kiwi.python.clamp">
</a>
<a name="clamp">
</a>
<div class="functionHeader">
def
clamp(x, low, high):
</div>
<div class="docstring 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><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">x</td><td>the value to clamp.</td></tr><tr><td></td><td class="fieldArg">low</td><td>the minimum value allowed.</td></tr><tr><td></td><td class="fieldArg">high</td><td>the maximum value allowed.</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">the clamped value</td></tr></table></div>
</div>
</div><div class="basefunction">
<a name="kiwi.python.slicerange">
</a>
<a name="slicerange">
</a>
<div class="functionHeader">
def
slicerange(slice, limit):
</div>
<div class="docstring functionBody">
<div><p>Takes a slice object and returns a range iterator</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">slice</td><td>slice object</td></tr><tr><td></td><td class="fieldArg">limit</td><td>maximum value allowed</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">iterator</td></tr></table></div>
</div>
</div><div class="basefunction">
<a name="kiwi.python.deprecationwarn">
</a>
<a name="deprecationwarn">
</a>
<div class="functionHeader">
def
deprecationwarn(msg, stacklevel=2):
</div>
<div class="docstring functionBody">
<div><p>Prints a deprecation warning</p><table class="fieldTable"></table></div>
</div>
</div><div class="basefunction">
<a name="kiwi.python.disabledeprecationcall">
</a>
<a name="disabledeprecationcall">
</a>
<div class="functionHeader">
def
disabledeprecationcall(func, *args, **kwargs):
</div>
<div class="docstring functionBody">
<div><p>Disables all deprecation warnings during the function call to func</p><table class="fieldTable"></table></div>
</div>
</div><div class="basefunction">
<a name="kiwi.python.all">
</a>
<a name="all">
</a>
<div class="functionHeader">
def
all(seq):
</div>
<div class="docstring functionBody">
<div><p>Predict used to check if all items in a seq are True.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">True if all items in seq are True</td></tr></table></div>
</div>
</div><div class="basefunction">
<a name="kiwi.python.any">
</a>
<a name="any">
</a>
<div class="functionHeader">
def
any(seq):
</div>
<div class="docstring functionBody">
<div><p>Predict used to check if any item in a seq are True.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">True if any item in seq is True</td></tr></table></div>
</div>
</div>
</div>
<address>
<a href="index.html">API Documentation</a> for Kiwi, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> at 2015-12-15 11:23:22.
</address>
</div>
<script type="text/javascript" src="pydoctor.js"></script>
</body>
</html>
|