|
1 <?xml version="1.0" encoding="ascii"?> |
|
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"> |
|
5 <head> |
|
6 <title>helium.documentation.APIDeltaWriter</title> |
|
7 <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
|
8 <script type="text/javascript" src="epydoc.js"></script> |
|
9 </head> |
|
10 |
|
11 <body bgcolor="white" text="black" link="blue" vlink="#204080" |
|
12 alink="#204080"> |
|
13 <!-- ==================== NAVIGATION BAR ==================== --> |
|
14 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
15 bgcolor="#a0c0ff" cellspacing="0"> |
|
16 <tr valign="middle"> |
|
17 |
|
18 <!-- Tree link --> |
|
19 <th> <a |
|
20 href="module-tree.html">Trees</a> </th> |
|
21 |
|
22 <!-- Index link --> |
|
23 <th> <a |
|
24 href="identifier-index.html">Indices</a> </th> |
|
25 |
|
26 <!-- Help link --> |
|
27 <th> <a |
|
28 href="help.html">Help</a> </th> |
|
29 |
|
30 <th class="navbar" width="100%"></th> |
|
31 </tr> |
|
32 </table> |
|
33 <table width="100%" cellpadding="0" cellspacing="0"> |
|
34 <tr valign="top"> |
|
35 <td width="100%"> |
|
36 <span class="breadcrumbs"> |
|
37 <a href="helium-module.html">Package helium</a> :: |
|
38 <a href="helium.documentation-module.html">Module documentation</a> :: |
|
39 Class APIDeltaWriter |
|
40 </span> |
|
41 </td> |
|
42 <td> |
|
43 <table cellpadding="0" cellspacing="0"> |
|
44 <!-- hide/show private --> |
|
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
|
46 onclick="toggle_private();">hide private</a>]</span></td></tr> |
|
47 <tr><td align="right"><span class="options" |
|
48 >[<a href="frames.html" target="_top">frames</a |
|
49 >] | <a href="helium.documentation.APIDeltaWriter-class.html" |
|
50 target="_top">no frames</a>]</span></td></tr> |
|
51 </table> |
|
52 </td> |
|
53 </tr> |
|
54 </table> |
|
55 <!-- ==================== CLASS DESCRIPTION ==================== --> |
|
56 <h1 class="epydoc">Class APIDeltaWriter</h1><span class="codelink"><a href="helium.documentation-pysrc.html#APIDeltaWriter">source code</a></span><br /><br /> |
|
57 <pre class="base-tree"> |
|
58 object --+ |
|
59 | |
|
60 <strong class="uidshort">APIDeltaWriter</strong> |
|
61 </pre> |
|
62 |
|
63 <hr /> |
|
64 Creates an XML delta of the Helium API between releases.<br /><br /> |
|
65 |
|
66 <!-- ==================== INSTANCE METHODS ==================== --> |
|
67 <a name="section-InstanceMethods"></a> |
|
68 <table class="summary" border="1" cellpadding="3" |
|
69 cellspacing="0" width="100%" bgcolor="white"> |
|
70 <tr bgcolor="#70b0f0" class="table-header"> |
|
71 <td colspan="2" class="table-header"> |
|
72 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
73 <tr valign="top"> |
|
74 <td align="left"><span class="table-header">Instance Methods</span></td> |
|
75 <td align="right" valign="top" |
|
76 ><span class="options">[<a href="#section-InstanceMethods" |
|
77 class="privatelink" onclick="toggle_private();" |
|
78 >hide private</a>]</span></td> |
|
79 </tr> |
|
80 </table> |
|
81 </td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td width="15%" align="right" valign="top" class="summary"> |
|
85 <span class="summary-type"> </span> |
|
86 </td><td class="summary"> |
|
87 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
88 <tr> |
|
89 <td><span class="summary-sig"><a href="helium.documentation.APIDeltaWriter-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|
90 <span class="summary-sig-arg">old_database</span>, |
|
91 <span class="summary-sig-arg">new_database</span>)</span><br /> |
|
92 Initialisation.</td> |
|
93 <td align="right" valign="top"> |
|
94 <span class="codelink"><a href="helium.documentation-pysrc.html#APIDeltaWriter.__init__">source code</a></span> |
|
95 |
|
96 </td> |
|
97 </tr> |
|
98 </table> |
|
99 |
|
100 </td> |
|
101 </tr> |
|
102 <tr> |
|
103 <td width="15%" align="right" valign="top" class="summary"> |
|
104 <span class="summary-type"> </span> |
|
105 </td><td class="summary"> |
|
106 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
107 <tr> |
|
108 <td><span class="summary-sig"><a name="write"></a><span class="summary-sig-name">write</span>(<span class="summary-sig-arg">self</span>, |
|
109 <span class="summary-sig-arg">path</span>)</span><br /> |
|
110 Write the API delta information to an XML file.</td> |
|
111 <td align="right" valign="top"> |
|
112 <span class="codelink"><a href="helium.documentation-pysrc.html#APIDeltaWriter.write">source code</a></span> |
|
113 |
|
114 </td> |
|
115 </tr> |
|
116 </table> |
|
117 |
|
118 </td> |
|
119 </tr> |
|
120 <tr> |
|
121 <td colspan="2" class="summary"> |
|
122 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
123 <code>__delattr__</code>, |
|
124 <code>__getattribute__</code>, |
|
125 <code>__hash__</code>, |
|
126 <code>__new__</code>, |
|
127 <code>__reduce__</code>, |
|
128 <code>__reduce_ex__</code>, |
|
129 <code>__repr__</code>, |
|
130 <code>__setattr__</code>, |
|
131 <code>__str__</code> |
|
132 </p> |
|
133 </td> |
|
134 </tr> |
|
135 </table> |
|
136 <!-- ==================== PROPERTIES ==================== --> |
|
137 <a name="section-Properties"></a> |
|
138 <table class="summary" border="1" cellpadding="3" |
|
139 cellspacing="0" width="100%" bgcolor="white"> |
|
140 <tr bgcolor="#70b0f0" class="table-header"> |
|
141 <td colspan="2" class="table-header"> |
|
142 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
143 <tr valign="top"> |
|
144 <td align="left"><span class="table-header">Properties</span></td> |
|
145 <td align="right" valign="top" |
|
146 ><span class="options">[<a href="#section-Properties" |
|
147 class="privatelink" onclick="toggle_private();" |
|
148 >hide private</a>]</span></td> |
|
149 </tr> |
|
150 </table> |
|
151 </td> |
|
152 </tr> |
|
153 <tr> |
|
154 <td colspan="2" class="summary"> |
|
155 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
156 <code>__class__</code> |
|
157 </p> |
|
158 </td> |
|
159 </tr> |
|
160 </table> |
|
161 <!-- ==================== METHOD DETAILS ==================== --> |
|
162 <a name="section-MethodDetails"></a> |
|
163 <table class="details" border="1" cellpadding="3" |
|
164 cellspacing="0" width="100%" bgcolor="white"> |
|
165 <tr bgcolor="#70b0f0" class="table-header"> |
|
166 <td colspan="2" class="table-header"> |
|
167 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
168 <tr valign="top"> |
|
169 <td align="left"><span class="table-header">Method Details</span></td> |
|
170 <td align="right" valign="top" |
|
171 ><span class="options">[<a href="#section-MethodDetails" |
|
172 class="privatelink" onclick="toggle_private();" |
|
173 >hide private</a>]</span></td> |
|
174 </tr> |
|
175 </table> |
|
176 </td> |
|
177 </tr> |
|
178 </table> |
|
179 <a name="__init__"></a> |
|
180 <div> |
|
181 <table class="details" border="1" cellpadding="3" |
|
182 cellspacing="0" width="100%" bgcolor="white"> |
|
183 <tr><td> |
|
184 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
185 <tr valign="top"><td> |
|
186 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|
187 <span class="sig-arg">old_database</span>, |
|
188 <span class="sig-arg">new_database</span>)</span> |
|
189 <br /><em class="fname">(Constructor)</em> |
|
190 </h3> |
|
191 </td><td align="right" valign="top" |
|
192 ><span class="codelink"><a href="helium.documentation-pysrc.html#APIDeltaWriter.__init__">source code</a></span> |
|
193 </td> |
|
194 </table> |
|
195 |
|
196 Initialisation. |
|
197 <dl class="fields"> |
|
198 <dt>Overrides: |
|
199 object.__init__ |
|
200 </dt> |
|
201 </dl> |
|
202 </td></tr></table> |
|
203 </div> |
|
204 <br /> |
|
205 <!-- ==================== NAVIGATION BAR ==================== --> |
|
206 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
207 bgcolor="#a0c0ff" cellspacing="0"> |
|
208 <tr valign="middle"> |
|
209 |
|
210 <!-- Tree link --> |
|
211 <th> <a |
|
212 href="module-tree.html">Trees</a> </th> |
|
213 |
|
214 <!-- Index link --> |
|
215 <th> <a |
|
216 href="identifier-index.html">Indices</a> </th> |
|
217 |
|
218 <!-- Help link --> |
|
219 <th> <a |
|
220 href="help.html">Help</a> </th> |
|
221 |
|
222 <th class="navbar" width="100%"></th> |
|
223 </tr> |
|
224 </table> |
|
225 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
226 <tr> |
|
227 <td align="left" class="footer"> |
|
228 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:18 2009 |
|
229 </td> |
|
230 <td align="right" class="footer"> |
|
231 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
232 </td> |
|
233 </tr> |
|
234 </table> |
|
235 |
|
236 <script type="text/javascript"> |
|
237 <!-- |
|
238 // Private objects are initially displayed (because if |
|
239 // javascript is turned off then we want them to be |
|
240 // visible); but by default, we want to hide them. So hide |
|
241 // them unless we have a cookie that says to show them. |
|
242 checkCookie() |
|
243 // --> |
|
244 </script> |
|
245 |
|
246 </body> |
|
247 </html> |