1
<?xml version="1.0" encoding="iso-8859-1"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
"DTD/xhtml1-transitional.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>kiwi.argcheck.argcheck</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="kiwi.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
23
<a class="navbar" target="_top" href="http://www.async.com.br/projects/kiwi/">Kiwi 1.9.12</a>
24
</p></th></tr></table>
28
<table width="100%" cellpadding="0" cellspacing="0">
31
<font size="-1"><b class="breadcrumbs">
32
<a href="kiwi.html">Package kiwi</a> ::
33
<a href="kiwi.argcheck.html">Module argcheck</a> ::
37
<td><table cellpadding="0" cellspacing="0">
38
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="kiwi.argcheck.argcheck.html" target="_top">no frames</a>]</font></td></tr>
42
<!-- =========== START OF CLASS DESCRIPTION =========== -->
43
<h2 class="class">Type argcheck</h2>
45
<pre class="base-tree">
46
<a href="__builtin__.object.html"><code>object</code></a> --+
53
<p>Decorator to check type and value of arguments.</p>
55
<pre class="doctestblock">
56
<span class="py-src"><span class="py-prompt">>>> </span>@argcheck(types...)
57
<span class="py-prompt">... </span><span class="py-keyword">def</span> function(args..)</span></pre>
59
<pre class="doctestblock">
60
<span class="py-src"><span class="py-prompt">>>> </span><span class="py-keyword">class</span> Class:
61
<span class="py-prompt">... </span> @argcheck(types..)
62
<span class="py-prompt">... </span> <span class="py-keyword">def</span> method(self, args)</span></pre>
63
You can customize the checks by subclassing your type from CustomType,
64
there are two builtin types: number which is a float/int combined check
65
and a percent which verifis that the value is a percentage
69
<!-- =========== START OF METHOD SUMMARY =========== -->
70
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
71
<tr bgcolor="#70b0f0" class="summary">
72
<th colspan="2">Method Summary</th></tr>
73
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
74
<td><code><span class="summary-sig"><a href="kiwi.argcheck.argcheck.html#disable" class="summary-sig-name"><code>disable</code></a>(<span class=summary-sig-arg>cls</span>)</span></code>
76
Disable argcheck globally <i>(Class method)</i>
78
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
79
<td><code><span class="summary-sig"><a href="kiwi.argcheck.argcheck.html#enable" class="summary-sig-name"><code>enable</code></a>(<span class=summary-sig-arg>cls</span>)</span></code>
81
Enable argcheck globally <i>(Class method)</i>
83
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
84
<td><code><a name="extra_check"></a><span class="summary-sig"><span class="summary-sig-name">extra_check</span>(<span class=summary-sig-arg>self</span>,
85
<span class=summary-sig-arg>names</span>,
86
<span class=summary-sig-arg>types</span>,
87
<span class=summary-sig-arg>args</span>,
88
<span class=summary-sig-arg>kwargs</span>)</span></code>
93
<!-- =========== START OF CLASS METHOD DETAILS =========== -->
94
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
95
<tr bgcolor="#70b0f0" class="details">
96
<th colspan="2">Class Method Details</th></tr>
99
<a name="disable"></a>
100
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
101
<h3><span class="sig"><span class="sig-name">disable</span>(<span class=sig-arg>cls</span>)</span>
103
Disable argcheck globally
108
<a name="enable"></a>
109
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
110
<h3><span class="sig"><span class="sig-name">enable</span>(<span class=sig-arg>cls</span>)</span>
112
Enable argcheck globally
119
<!-- =========== START OF NAVBAR =========== -->
120
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
122
<th class="navbar"> <a class="navbar" href="kiwi.html">Home</a> </th>
123
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
124
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
125
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
126
<th class="navbar" align="right" width="100%">
127
<table border="0" cellpadding="0" cellspacing="0">
128
<tr><th class="navbar" align="center">
130
<a class="navbar" target="_top" href="http://www.async.com.br/projects/kiwi/">Kiwi 1.9.12</a>
131
</p></th></tr></table>
136
<table border="0" cellpadding="0" cellspacing="0" width="100%">
138
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Jan 29 16:43:00 2007</font></td>
139
<td align="right"><a href="http://epydoc.sourceforge.net"
140
><font size="-2">http://epydoc.sf.net</font></a></td>
added
removed
doc/api/kiwi.argcheck.argcheck.html
