libxml2-python/libxml2-python-api.xml at master · jessecollier/libxml2-python · GitHub

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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
<?xml version="1.0" encoding="ISO-8859-1"?>
<apiname='libxml2-python'>
 <symbols>
 <functionname='xmlRegisterXPathFunction'file='python'>
 <cond>defined(LIBXML_XPATH_ENABLED)</cond>
 <info>Register a Python written function to the XPath interpreter</info>
 <returntype='int'info="1 in case of success, 0 or -1 in case of error"/>
 <argname='ctx'type='xmlXPathContextPtr'info='the xpathContext'/>
 <argname='name'type='xmlChar *'info='the function name'/>
 <argname='ns_uri'type='xmlChar *'info='the namespace or NULL'/>
 <argname='f'type='pythonObject'info='the python function'/>
 </function>
 <functionname='xmlXPathRegisterVariable'file='python'>
 <cond>defined(LIBXML_XPATH_ENABLED)</cond>
 <info>Register a variable with the XPath context</info>
 <returntype='int'info="1 in case of success, 0 or -1 in case of error"/>
 <argname='ctx'type='xmlXPathContextPtr'info='the xpathContext'/>
 <argname='name'type='xmlChar *'info='the variable name'/>
 <argname='ns_uri'type='xmlChar *'info='the namespace or NULL'/>
 <argname='value'type='pythonObject'info='the value'/>
 </function>
 <functionname='xmlNewNode'file='python'>
 <info>Create a new Node</info>
 <returntype='xmlNodePtr'info="A new element node"/>
 <argname='name'type='xmlChar *'info='the node name'/>
 </function>
 <functionname='xmlCreatePushParser'file='python'>
 <info>Create a progressive XML parser context to build either an event flow if the SAX object is not None, or a DOM tree otherwise.</info>
 <returntype='xmlParserCtxtPtr'info="the parser context or None in case of error"/>
 <argname='SAX'type='pythonObject'info='the SAX callback object or None'/>
 <argname='chunk'type='xmlChar *'info='the initial data'/>
 <argname='size'type='int'info='the size of the initial data'/>
 <argname='URI'type='xmlChar *'info='The URI used for base computations'/>
 </function>
 <functionname='htmlCreatePushParser'file='python'>
 <cond>defined(LIBXML_HTML_ENABLED)</cond>
 <info>Create a progressive HTML parser context to build either an event flow if the SAX object is not None, or a DOM tree otherwise.</info>
 <returntype='xmlParserCtxtPtr'info="the parser context or None in case of error"/>
 <argname='SAX'type='pythonObject'info='the SAX callback object or None'/>
 <argname='chunk'type='xmlChar *'info='the initial data'/>
 <argname='size'type='int'info='the size of the initial data'/>
 <argname='URI'type='xmlChar *'info='The URI used for base computations'/>
 </function>
 <functionname='xmlSAXParseFile'file='python'>
 <info>Interface to parse an XML file or resource pointed by an URI to build an event flow to the SAX object</info>
 <returntype='void'/>
 <argname='SAX'type='pythonObject'info='the SAX callback object or None'/>
 <argname='URI'type='xmlChar *'info='The URI of the resource'/>
 <argname='recover'type='int'info='allow recovery in case of error'/>
 </function>
 <functionname='htmlSAXParseFile'file='python'>
 <cond>defined(LIBXML_HTML_ENABLED)</cond>
 <info>Interface to parse an HTML file or resource pointed by an URI to build an event flow to the SAX object</info>
 <returntype='void'/>
 <argname='SAX'type='pythonObject'info='the SAX callback object or None'/>
 <argname='URI'type='xmlChar *'info='The URI of the resource'/>
 <argname='encoding'type='const char *'info='encoding or None'/>
 </function>
 <functionname='xmlCreateOutputBuffer'file='python'>
 <info>Create a libxml2 output buffer from a Python file</info>
 <returntype='xmlOutputBufferPtr'info="the output buffer"/>
 <argname='file'type='pythonObject'info='the Python file'/>
 <argname='encoding'type='xmlChar *'info='an optionnal encoding'/>
 </function>
 <functionname='xmlCreateInputBuffer'file='python'>
 <info>Create a libxml2 input buffer from a Python file</info>
 <returntype='xmlParserInputBufferPtr'info="the input buffer"/>
 <argname='file'type='pythonObject'info='the Python file'/>
 <argname='encoding'type='xmlChar *'info='an optionnal encoding'/>
 </function>
 <functionname='xmlSetEntityLoader'file='python'>
 <info>Set the entity resolver as a python function</info>
 <returntype='int'info="0 in case of success, -1 for error"/>
 <argname='resolver'type='pythonObject'info='the Python function'/>
 </function>
<!-- xmlParserCtxtPtr accessors -->
 <functionname='xmlParserGetDoc'file='python_accessor'>
 <info>Get the document tree from a parser context.</info>
 <returntype='xmlDocPtr'info="the document tree"field="myDoc"/>
 <argname='ctxt'type='xmlParserCtxtPtr'info='the parser context'/>
 </function>
 <functionname='xmlParserGetWellFormed'file='python_accessor'>
 <info>Get the well formed information from a parser context.</info>
 <returntype='int'info="the wellFormed field"field="wellFormed"/>
 <argname='ctxt'type='xmlParserCtxtPtr'info='the parser context'/>
 </function>
 <functionname='xmlParserGetIsValid'file='python_accessor'>
 <info>Get the validity information from a parser context.</info>
 <returntype='int'info="the valid field"field="valid"/>
 <argname='ctxt'type='xmlParserCtxtPtr'info='the parser context'/>
 </function>
 <functionname='xmlParserSetValidate'file='python_accessor'>
 <info>Switch the parser to validation mode.</info>
 <returntype='void'/>
 <argname='ctxt'type='xmlParserCtxtPtr'info='the parser context'/>
 <argname='validate'type='int'info='1 to activate validation'/>
 </function>
 <functionname='xmlParserSetReplaceEntities'file='python_accessor'>
 <info>Switch the parser to replace entities.</info>
 <returntype='void'/>
 <argname='ctxt'type='xmlParserCtxtPtr'info='the parser context'/>
 <argname='replaceEntities'type='int'info='1 to replace entities'/>
 </function>
 <functionname='xmlParserSetPedantic'file='python_accessor'>
 <info>Switch the parser to be pedantic.</info>
 <returntype='void'/>
 <argname='ctxt'type='xmlParserCtxtPtr'info='the parser context'/>
 <argname='pedantic'type='int'info='1 to run in pedantic mode'/>
 </function>
 <functionname='xmlParserSetLoadSubset'file='python_accessor'>
 <info>Switch the parser to load the DTD without validating.</info>
 <returntype='void'/>
 <argname='ctxt'type='xmlParserCtxtPtr'info='the parser context'/>
 <argname='loadsubset'type='int'info='1 to load the DTD'/>
 </function>
 <functionname='xmlParserSetLineNumbers'file='python_accessor'>
 <info>Switch on the generation of line number for elements nodes.</info>
 <returntype='void'/>
 <argname='ctxt'type='xmlParserCtxtPtr'info='the parser context'/>
 <argname='linenumbers'type='int'info='1 to save line numbers'/>
 </function>
 <functionname='xmlDebugMemory'file='python'>
 <info>Switch on the generation of line number for elements nodes. Also returns the number of bytes allocated and not freed by libxml2 since memory debugging was switched on.</info>
 <returntype='int'info="returns the number of bytes allocated and not freed"/>
 <argname='activate'type='int'info='1 switch on memory debugging 0 switch it off'/>
 </function>
 <functionname='xmlDumpMemory'file='python'>
 <info>dump the memory allocated in the file .memdump</info>
 <returntype='void'/>
 </function>
<!-- xmlNsPtr accessors -->
 <functionname='xmlNodeGetNs'file='python_accessor'>
 <info>Get the namespace of a node</info>
 <returntype='xmlNsPtr'info="The namespace or None"/>
 <argname='node'type='xmlNodePtr'info='the node'/>
 </function>
 <functionname='xmlNodeGetNsDefs'file='python_accessor'>
 <info>Get the namespace of a node</info>
 <returntype='xmlNsPtr'info="The namespace or None"/>
 <argname='node'type='xmlNodePtr'info='the node'/>
 </function>
<!-- xmlXPathContextPtr accessors -->
 <functionname='xmlXPathParserGetContext'file='python_accessor'>
 <cond>defined(LIBXML_XPATH_ENABLED)</cond>
 <info>Get the xpathContext from an xpathParserContext</info>
 <returntype='xmlXPathContextPtr'info="The XPath context"field="context"/>
 <argname='ctxt'type='xmlXPathParserContextPtr'info='the XPath parser context'/>
 </function>
 <functionname='xmlXPathGetContextDoc'file='python_accessor'>
 <cond>defined(LIBXML_XPATH_ENABLED)</cond>
 <info>Get the doc from an xpathContext</info>
 <returntype='xmlDocPtr'info="The doc context"field="doc"/>
 <argname='ctxt'type='xmlXPathContextPtr'info='the XPath context'/>
 </function>
 <functionname='xmlXPathGetContextNode'file='python_accessor'>
 <cond>defined(LIBXML_XPATH_ENABLED)</cond>
 <info>Get the current node from an xpathContext</info>
 <returntype='xmlNodePtr'info="The node context"field="node"/>
 <argname='ctxt'type='xmlXPathContextPtr'info='the XPath context'/>
 </function>
 <functionname='xmlXPathSetContextDoc'file='python_accessor'>
 <cond>defined(LIBXML_XPATH_ENABLED)</cond>
 <info>Set the doc of an xpathContext</info>
 <returntype='void'/>
 <argname='ctxt'type='xmlXPathContextPtr'info='the XPath context'/>
 <argname="doc"type='xmlDocPtr'info="The doc context"/>
 </function>
 <functionname='xmlXPathSetContextNode'file='python_accessor'>
 <cond>defined(LIBXML_XPATH_ENABLED)</cond>
 <info>Set the current node of an xpathContext</info>
 <returntype='void'/>
 <argname='ctxt'type='xmlXPathContextPtr'info='the XPath context'/>
 <argname="node"type='xmlNodePtr'info="The node context"/>
 </function>
 <functionname='xmlXPathGetContextPosition'file='python_accessor'>
 <cond>defined(LIBXML_XPATH_ENABLED)</cond>
 <info>Get the current node from an xpathContext</info>
 <returntype='int'info="The node context"field="proximityPosition"/>
 <argname='ctxt'type='xmlXPathContextPtr'info='the XPath context'/>
 </function>
 <functionname='xmlXPathGetContextSize'file='python_accessor'>
 <cond>defined(LIBXML_XPATH_ENABLED)</cond>
 <info>Get the current node from an xpathContext</info>
 <returntype='int'info="The node context"field="contextSize"/>
 <argname='ctxt'type='xmlXPathContextPtr'info='the XPath context'/>
 </function>
 <functionname='xmlXPathGetFunction'file='python_accessor'>
 <cond>defined(LIBXML_XPATH_ENABLED)</cond>
 <info>Get the current function name xpathContext</info>
 <returntype='const xmlChar *'info="The function name"field="function"/>
 <argname='ctxt'type='xmlXPathContextPtr'info='the XPath context'/>
 </function>
 <functionname='xmlXPathGetFunctionURI'file='python_accessor'>
 <cond>defined(LIBXML_XPATH_ENABLED)</cond>
 <info>Get the current function name URI xpathContext</info>
 <returntype='const xmlChar *'info="The function name URI"field="functionURI"/>
 <argname='ctxt'type='xmlXPathContextPtr'info='the XPath context'/>
 </function>
<!-- xmlURIPtr accessors -->
 <functionname='xmlURIGetScheme'file='python_accessor'>
 <info>Get the scheme part from an URI</info>
 <returntype='const char *'info="The URI scheme"field="scheme"/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 </function>
 <functionname='xmlURISetScheme'file='python_accessor'>
 <info>Set the scheme part of an URI.</info>
 <returntype='void'/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 <argname='scheme'type='char *'info='The URI scheme part'/>
 </function>
 <functionname='xmlURIGetOpaque'file='python_accessor'>
 <info>Get the opaque part from an URI</info>
 <returntype='const char *'info="The URI opaque"field="opaque"/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 </function>
 <functionname='xmlURISetOpaque'file='python_accessor'>
 <info>Set the opaque part of an URI.</info>
 <returntype='void'/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 <argname='opaque'type='char *'info='The URI opaque part'/>
 </function>
 <functionname='xmlURIGetAuthority'file='python_accessor'>
 <info>Get the authority part from an URI</info>
 <returntype='const char *'info="The URI authority"field="authority"/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 </function>
 <functionname='xmlURISetAuthority'file='python_accessor'>
 <info>Set the authority part of an URI.</info>
 <returntype='void'/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 <argname='authority'type='char *'info='The URI authority part'/>
 </function>
 <functionname='xmlURIGetServer'file='python_accessor'>
 <info>Get the server part from an URI</info>
 <returntype='const char *'info="The URI server"field="server"/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 </function>
 <functionname='xmlURISetServer'file='python_accessor'>
 <info>Set the server part of an URI.</info>
 <returntype='void'/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 <argname='server'type='char *'info='The URI server part'/>
 </function>
 <functionname='xmlURIGetUser'file='python_accessor'>
 <info>Get the user part from an URI</info>
 <returntype='const char *'info="The URI user"field="user"/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 </function>
 <functionname='xmlURISetUser'file='python_accessor'>
 <info>Set the user part of an URI.</info>
 <returntype='void'/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 <argname='user'type='char *'info='The URI user part'/>
 </function>
 <functionname='xmlURIGetPath'file='python_accessor'>
 <info>Get the path part from an URI</info>
 <returntype='const char *'info="The URI path"field="path"/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 </function>
 <functionname='xmlURISetPath'file='python_accessor'>
 <info>Set the path part of an URI.</info>
 <returntype='void'/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 <argname='path'type='char *'info='The URI path part'/>
 </function>
 <functionname='xmlURIGetQuery'file='python_accessor'>
 <info>Get the query part from an URI</info>
 <returntype='const char *'info="The URI query"field="query"/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 </function>
 <functionname='xmlURISetQuery'file='python_accessor'>
 <info>Set the query part of an URI.</info>
 <returntype='void'/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 <argname='query'type='char *'info='The URI query part'/>
 </function>
 <functionname='xmlURIGetQueryRaw'file='python_accessor'>
 <info>Get the raw query part from an URI (i.e. the unescaped form).</info>
 <returntype='const char *'info="The URI query"field="query_raw"/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 </function>
 <functionname='xmlURISetQueryRaw'file='python_accessor'>
 <info>Set the raw query part of an URI (i.e. the unescaped form).</info>
 <returntype='void'/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 <argname='query_raw'type='char *'info='The raw URI query part'/>
 </function>
 <functionname='xmlURIGetFragment'file='python_accessor'>
 <info>Get the fragment part from an URI</info>
 <returntype='const char *'info="The URI fragment"field="fragment"/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 </function>
 <functionname='xmlURISetFragment'file='python_accessor'>
 <info>Set the fragment part of an URI.</info>
 <returntype='void'/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 <argname='fragment'type='char *'info='The URI fragment part'/>
 </function>
 <functionname='xmlURIGetPort'file='python_accessor'>
 <info>Get the port part from an URI</info>
 <returntype='int'info="The URI port"field="port"/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 </function>
 <functionname='xmlURISetPort'file='python_accessor'>
 <info>Set the port part of an URI.</info>
 <returntype='void'/>
 <argname='URI'type='xmlURIPtr'info='the URI'/>
 <argname='port'type='int'info='The URI port part'/>
 </function>
<!-- xmlErrorPtr accessors -->
 <functionname='xmlErrorGetDomain'file='python_accessor'>
 <info>What part of the library raised this error</info>
 <returntype='int'info="The error domain"field="domain"/>
 <argname='Error'type='xmlErrorPtr'info='the Error'/>
 </function>
 <functionname='xmlErrorGetCode'file='python_accessor'>
 <info>The error code, e.g. an xmlParserError</info>
 <returntype='int'info="The error code"field="code"/>
 <argname='Error'type='xmlErrorPtr'info='the Error'/>
 </function>
 <functionname='xmlErrorGetMessage'file='python_accessor'>
 <info>human-readable informative error message</info>
 <returntype='const char *'info="The error message"field="message"/>
 <argname='Error'type='xmlErrorPtr'info='the Error'/>
 </function>
 <functionname='xmlErrorGetLevel'file='python_accessor'>
 <info>how consequent is the error</info>
 <returntype='int'info="The error level"field="level"/>
 <argname='Error'type='xmlErrorPtr'info='the Error'/>
 </function>
 <functionname='xmlErrorGetFile'file='python_accessor'>
 <info>the filename</info>
 <returntype='const char *'info="The error file"field="file"/>
 <argname='Error'type='xmlErrorPtr'info='the Error'/>
 </function>
 <functionname='xmlErrorGetLine'file='python_accessor'>
 <info>the line number if available</info>
 <returntype='int'info="The error line"field="line"/>
 <argname='Error'type='xmlErrorPtr'info='the Error'/>
 </function>
 <functionname='xmlPythonCleanupParser'file='python'>
 <info>Cleanup function for the XML library. It tries to reclaim all parsing related global memory allocated for the library processing. It doesn't deallocate any document related memory. Calling this function should not prevent reusing the library but one should call xmlCleanupParser() only when the process has finished using the library or XML document built with it.</info>
 <returntype='void'/>
 </function>
 <functionname='xmlMemoryUsed'file='python'>
 <info>Returns the total amount of memory allocated by libxml2</info>
 <returntype='int'info='number of bytes allocated'/>
 </function>
 </symbols>
</api>