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
|
****************
Public XPath API
****************
The package includes some classes and functions that implement XPath selectors, parsers, tokens,
contexts and schema proxy.
XPath selectors
===============
.. autofunction:: elementpath.select
.. autofunction:: elementpath.iter_select
.. autoclass:: elementpath.Selector
.. autoattribute:: namespaces
.. automethod:: select
.. automethod:: iter_select
XPath parsers
=============
.. autoclass:: elementpath.XPath1Parser
.. autoattribute:: DEFAULT_NAMESPACES
.. autoattribute:: version
Helper methods for defining token classes:
.. automethod:: axis
.. automethod:: function
.. autoclass:: elementpath.XPath2Parser
.. autoclass:: elementpath.xpath3.XPath30Parser
.. autoclass:: elementpath.xpath3.XPath31Parser
XPath tokens
============
.. autoclass:: elementpath.XPathToken
.. automethod:: evaluate
.. automethod:: select
Context manipulation helpers:
.. automethod:: get_argument
.. automethod:: atomization
.. automethod:: get_atomized_operand
.. automethod:: iter_comparison_data
.. automethod:: get_operands
.. automethod:: get_results
.. automethod:: select_results
.. automethod:: adjust_datetime
Schema context methods
.. automethod:: select_xsd_nodes
.. automethod:: add_xsd_type
.. automethod:: get_xsd_type
.. automethod:: get_typed_node
Data accessor helpers
.. automethod:: data_value
.. automethod:: boolean_value
.. automethod:: string_value
.. automethod:: number_value
.. automethod:: schema_node_value
Error management helper:
.. automethod:: error
XPath contexts
==============
.. autoclass:: elementpath.XPathContext
.. autoclass:: elementpath.XPathSchemaContext
XML Schema proxy
================
The XPath 2.0 parser can be interfaced with an XML Schema processor through a schema proxy.
An :class:`XMLSchemaProxy` class is defined for interfacing schemas created with the *xmlschema* package.
This class is based on an abstract class :class:`elementpath.AbstractSchemaProxy`, that can be used for
implementing concrete interfaces to other types of XML Schema processors.
.. autoclass:: elementpath.AbstractSchemaProxy
.. automethod:: bind_parser
.. automethod:: get_context
.. automethod:: find
.. automethod:: get_type
.. automethod:: get_attribute
.. automethod:: get_element
.. automethod:: is_instance
.. automethod:: cast_as
.. automethod:: iter_atomic_types
XPath nodes
===========
XPath nodes are processed using a set of classes derived from
:class:`elementpath.XPathNode`. This class hierarchy is as simple
as possible, with a focus on speed a low memory consumption.
.. autoclass:: elementpath.XPathNode
The seven XPath node types:
.. autoclass:: elementpath.AttributeNode
.. autoclass:: elementpath.NamespaceNode
.. autoclass:: elementpath.TextNode
.. autoclass:: elementpath.CommentNode
.. autoclass:: elementpath.ProcessingInstructionNode
.. autoclass:: elementpath.ElementNode
.. autoclass:: elementpath.DocumentNode
There are also other two specialized versions of ElementNode
usable on specific cases:
.. autoclass:: elementpath.LazyElementNode
.. autoclass:: elementpath.SchemaElementNode
Node tree builders
==================
Node trees are automatically created during the initialization of an
:class:`elementpath.XPathContext`. But if you need to process the same XML data
more times there is an helper API for creating document or element based node trees:
.. autofunction:: elementpath.get_node_tree
.. autofunction:: elementpath.build_node_tree
.. autofunction:: elementpath.build_lxml_node_tree
.. autofunction:: elementpath.build_schema_node_tree
XPath regular expressions
=========================
.. autofunction:: elementpath.translate_pattern
.. autofunction:: elementpath.install_unicode_data
.. autofunction:: elementpath.unicode_version
Exception classes
=================
.. autoexception:: elementpath.ElementPathError
.. autoexception:: elementpath.MissingContextError
.. autoexception:: elementpath.UnsupportedFeatureError
.. autoexception:: elementpath.RegexError
.. autoexception:: elementpath.ElementPathLocaleError
There are also other exceptions, multiple derived from the base exception
:class:`elementpath.ElementPathError` and Python built-in exceptions:
.. autoexception:: elementpath.ElementPathKeyError
.. autoexception:: elementpath.ElementPathNameError
.. autoexception:: elementpath.ElementPathOverflowError
.. autoexception:: elementpath.ElementPathRuntimeError
.. autoexception:: elementpath.ElementPathSyntaxError
.. autoexception:: elementpath.ElementPathTypeError
.. autoexception:: elementpath.ElementPathValueError
.. autoexception:: elementpath.ElementPathZeroDivisionError
XPath datatypes
===============
XPath datatypes include XSD datatypes and other datatype specific for XPath, like untyped atomic
type and sequences.
XSD special types
-----------------
.. autoclass:: elementpath.datatypes.AnyType
.. autoclass:: elementpath.datatypes.AnySimpleType
.. autoclass:: elementpath.datatypes.AnyAtomicType
Proxy classes for primitive datatypes
-------------------------------------
.. automodule:: elementpath.datatypes.proxies
.. autoclass:: elementpath.datatypes.StringProxy
.. autoclass:: elementpath.datatypes.BooleanProxy
.. autoclass:: elementpath.datatypes.DecimalProxy
.. autoclass:: elementpath.datatypes.DoubleProxy
XPath specific types
--------------------
.. autoclass:: elementpath.datatypes.UntypedAtomic
.. autoclass:: elementpath.sequences.XSequence
.. autoclass:: elementpath.datatypes.ErrorProxy
Numeric types
-------------
.. autoclass:: elementpath.datatypes.Float
.. autoclass:: elementpath.datatypes.Integer
.. autoclass:: elementpath.datatypes.NonPositiveInteger
.. autoclass:: elementpath.datatypes.NegativeInteger
.. autoclass:: elementpath.datatypes.Long
.. autoclass:: elementpath.datatypes.Int
.. autoclass:: elementpath.datatypes.Short
.. autoclass:: elementpath.datatypes.Byte
.. autoclass:: elementpath.datatypes.NonNegativeInteger
.. autoclass:: elementpath.datatypes.PositiveInteger
.. autoclass:: elementpath.datatypes.UnsignedLong
.. autoclass:: elementpath.datatypes.UnsignedInt
.. autoclass:: elementpath.datatypes.UnsignedShort
.. autoclass:: elementpath.datatypes.UnsignedByte
String based types
------------------
.. autoclass:: elementpath.datatypes.NormalizedString
.. autoclass:: elementpath.datatypes.XsdToken
.. autoclass:: elementpath.datatypes.Language
.. autoclass:: elementpath.datatypes.Name
.. autoclass:: elementpath.datatypes.NCName
.. autoclass:: elementpath.datatypes.Id
.. autoclass:: elementpath.datatypes.Idref
.. autoclass:: elementpath.datatypes.Entity
.. autoclass:: elementpath.datatypes.NMToken
List types
----------
.. autoclass:: elementpath.datatypes.NMTokens
.. autoclass:: elementpath.datatypes.Idrefs
.. autoclass:: elementpath.datatypes.Entities
QName types
-----------
.. autoclass:: elementpath.datatypes.QName
.. autoclass:: elementpath.datatypes.Notation
Binary types
------------
.. autoclass:: elementpath.datatypes.Base64Binary
.. autoclass:: elementpath.datatypes.HexBinary
URI types
---------
.. autoclass:: elementpath.datatypes.AnyURI
Date and time types
-------------------
.. autoclass:: elementpath.datatypes.DateTime
.. autoclass:: elementpath.datatypes.DateTime10
.. autoclass:: elementpath.datatypes.DateTimeStamp
.. autoclass:: elementpath.datatypes.Date
.. autoclass:: elementpath.datatypes.Date10
.. autoclass:: elementpath.datatypes.GregorianDay
.. autoclass:: elementpath.datatypes.GregorianMonth
.. autoclass:: elementpath.datatypes.GregorianMonthDay
.. autoclass:: elementpath.datatypes.GregorianYear
.. autoclass:: elementpath.datatypes.GregorianYear10
.. autoclass:: elementpath.datatypes.GregorianYearMonth
.. autoclass:: elementpath.datatypes.GregorianYearMonth10
.. autoclass:: elementpath.datatypes.Time
.. autoclass:: elementpath.datatypes.Timezone
Duration types
--------------
.. autoclass:: elementpath.datatypes.Duration
.. autoclass:: elementpath.datatypes.YearMonthDuration
.. autoclass:: elementpath.datatypes.DayTimeDuration
|
