/usr/share/doc/python-kiwi/api/kiwi.argcheck.argcheck.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 | <?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.argcheck.argcheck : 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="class"><code>kiwi.argcheck.argcheck(<span title="object">object</span>)</code> <small>class documentation</small></h1>
<span id="partOf">
Part of <code><a href="kiwi.html" data-type="Package" class="code">kiwi</a>.<a href="kiwi.argcheck.html" data-type="Module" class="code">argcheck</a></code>
<a href="classIndex.html#kiwi.argcheck.argcheck">(View In Hierarchy)</a>
</span>
</div>
<div class="extrasDocstring">
</div>
<div class="moduleDocstring">
<div><p>Decorator to check type and value of arguments.</p>
<p>Usage:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>@argcheck(types...)
<span class="py-more">... </span><span class="py-keyword">def</span> <span class="py-defname">function</span>(args..)</pre>
<p>or</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">class</span> <span class="py-defname">Class</span>:
<span class="py-more">... </span> @argcheck(types..)
<span class="py-more">... </span> <span class="py-keyword">def</span> <span class="py-defname">method</span>(self, args)</pre>
<p>You can customize the checks by subclassing your type from CustomType,
there are two builtin types: number which is a float/int combined check and
a percent which verifis that the value is a percentage</p><table class="fieldTable"></table></div>
</div>
<div id="splitTables">
<table class="children sortable" id="id44">
<tr class="method">
<td>Method</td>
<td><a href="kiwi.argcheck.argcheck.html#__init__" data-type="Method" class="code">__init__</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="classmethod">
<td>Class Method</td>
<td><a href="kiwi.argcheck.argcheck.html#enable" data-type="Class Method" class="code">enable</a></td>
<td><span>Enable argcheck globally</span></td>
</tr><tr class="classmethod">
<td>Class Method</td>
<td><a href="kiwi.argcheck.argcheck.html#disable" data-type="Class Method" class="code">disable</a></td>
<td><span>Disable argcheck globally</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.argcheck.argcheck.html#__call__" data-type="Method" class="code">__call__</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.argcheck.argcheck.html#extra_check" data-type="Method" class="code">extra_check</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="method private">
<td>Method</td>
<td><a href="kiwi.argcheck.argcheck.html#_type_check" data-type="Method" class="code">_type_check</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr>
</table>
</div>
<div id="childList">
<div class="basemethod">
<a name="kiwi.argcheck.argcheck.__init__">
</a>
<a name="__init__">
</a>
<div class="functionHeader">
def
__init__(self, *types):
</div>
<div class="docstring functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div><div class="baseclassmethod">
<a name="kiwi.argcheck.argcheck.enable">
</a>
<a name="enable">
</a>
<div class="functionHeader">
@classmethod<br />
def
enable(cls):
</div>
<div class="docstring functionBody">
<div><p>Enable argcheck globally</p><table class="fieldTable"></table></div>
</div>
</div><div class="baseclassmethod">
<a name="kiwi.argcheck.argcheck.disable">
</a>
<a name="disable">
</a>
<div class="functionHeader">
@classmethod<br />
def
disable(cls):
</div>
<div class="docstring functionBody">
<div><p>Disable argcheck globally</p><table class="fieldTable"></table></div>
</div>
</div><div class="basemethod">
<a name="kiwi.argcheck.argcheck.__call__">
</a>
<a name="__call__">
</a>
<div class="functionHeader">
def
__call__(self, func):
</div>
<div class="docstring functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div><div class="basemethod">
<a name="kiwi.argcheck.argcheck.extra_check">
</a>
<a name="extra_check">
</a>
<div class="functionHeader">
def
extra_check(self, names, types, args, kwargs):
</div>
<div class="docstring functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div><div class="basemethod private">
<a name="kiwi.argcheck.argcheck._type_check">
</a>
<a name="_type_check">
</a>
<div class="functionHeader">
def
_type_check(self, value, argument_type, name, default=_NoValue):
</div>
<div class="docstring functionBody">
<div class="undocumented">Undocumented</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>
|