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
|
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html>
<head>
<title>API docs for “kiwi.component”</title>
<meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
<link href="apidocs.css" type="text/css" rel="stylesheet" />
</head>
<body>
<h1 class="module">Module k.component</h1>
<p>
<span id="part">Part of <a href="kiwi.html">kiwi</a></span>
</p>
<div>
</div>
<div class="undocumented">No module docstring</div>
<div id="splitTables">
<table class="children sortable" id="id363">
<tr class="class">
<td>Class</td>
<td><a href="kiwi.component.Interface.html">Interface</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="class">
<td>Class</td>
<td><a href="kiwi.component.Attribute.html">Attribute</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.component.html#implements">implements</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="class">
<td>Class</td>
<td><a href="kiwi.component.AlreadyImplementedError.html">AlreadyImplementedError</a></td>
<td><span>Called when a utility already exists.
</span></td>
</tr><tr class="class">
<td>Class</td>
<td><a href="kiwi.component._UtilityHandler.html">_UtilityHandler</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.component.html#provide_utility">provide_utility</a></td>
<td><span>Set the utility for the named interface. If the utility is already
</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.component.html#get_utility">get_utility</a></td>
<td><span>Get the utility for the named interface. If the utility is not
</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.component.html#remove_utility">remove_utility</a></td>
<td><span>Remove the utility provided for an interface
</span></td>
</tr>
</table>
</div>
<div class="function">
<a name="kiwi.component.implements"></a>
<a name="implements"></a>
<div class="functionHeader">
def implements(iface):
</div>
<div class="functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div><div class="function">
<a name="kiwi.component.provide_utility"></a>
<a name="provide_utility"></a>
<div class="functionHeader">
def provide_utility(iface, utility, replace=False):
</div>
<div class="functionBody">
<div>Set the utility for the named interface. If the utility is already set,
an {AlreadyImplementedError} is raised.
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">iface</td><td>interface to set the utility for.
</td></tr><tr><td></td><td class="fieldArg">utility</td><td>utility providing the interface.
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.component.get_utility"></a>
<a name="get_utility"></a>
<div class="functionHeader">
def get_utility(iface, default=ValueUnset):
</div>
<div class="functionBody">
<div>Get the utility for the named interface. If the utility is not available
(has not been set) a {NotImplementedError} is raised unless default is
set.
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">iface</td><td>an interface
</td></tr><tr><td></td><td class="fieldArg">default</td><td>optional, if set return if a utility is not found
</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">the utility
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.component.remove_utility"></a>
<a name="remove_utility"></a>
<div class="functionHeader">
def remove_utility(iface):
</div>
<div class="functionBody">
<div>Remove the utility provided for an interface If the utility is not
available (has not been set) {NotImplementedError} is raised.
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">iface</td><td>the interface
</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">the removed utility
</td></tr></table></div>
</div>
</div>
<address>
<a href="index.html">API Documentation</a> for Kiwi, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2008-05-29 16:06:17.
</address>
</body>
</html>
|
