Python code coverage for Lib/xml/dom/xmlbuilder.py

#	count	content
1	n/a	"""Implementation of the DOM Level 3 'LS-Load' feature."""
2	n/a
3	n/a	import copy
4	n/a	import warnings
5	n/a	import xml.dom
6	n/a
7	n/a	from xml.dom.NodeFilter import NodeFilter
8	n/a
9	n/a
10	n/a	__all__ = ["DOMBuilder", "DOMEntityResolver", "DOMInputSource"]
11	n/a
12	n/a
13	n/a	class Options:
14	n/a	"""Features object that has variables set for each DOMBuilder feature.
15	n/a
16	n/a	The DOMBuilder class uses an instance of this class to pass settings to
17	n/a	the ExpatBuilder class.
18	n/a	"""
19	n/a
20	n/a	# Note that the DOMBuilder class in LoadSave constrains which of these
21	n/a	# values can be set using the DOM Level 3 LoadSave feature.
22	n/a
23	n/a	namespaces = 1
24	n/a	namespace_declarations = True
25	n/a	validation = False
26	n/a	external_parameter_entities = True
27	n/a	external_general_entities = True
28	n/a	external_dtd_subset = True
29	n/a	validate_if_schema = False
30	n/a	validate = False
31	n/a	datatype_normalization = False
32	n/a	create_entity_ref_nodes = True
33	n/a	entities = True
34	n/a	whitespace_in_element_content = True
35	n/a	cdata_sections = True
36	n/a	comments = True
37	n/a	charset_overrides_xml_encoding = True
38	n/a	infoset = False
39	n/a	supported_mediatypes_only = False
40	n/a
41	n/a	errorHandler = None
42	n/a	filter = None
43	n/a
44	n/a
45	n/a	class DOMBuilder:
46	n/a	entityResolver = None
47	n/a	errorHandler = None
48	n/a	filter = None
49	n/a
50	n/a	ACTION_REPLACE = 1
51	n/a	ACTION_APPEND_AS_CHILDREN = 2
52	n/a	ACTION_INSERT_AFTER = 3
53	n/a	ACTION_INSERT_BEFORE = 4
54	n/a
55	n/a	_legal_actions = (ACTION_REPLACE, ACTION_APPEND_AS_CHILDREN,
56	n/a	ACTION_INSERT_AFTER, ACTION_INSERT_BEFORE)
57	n/a
58	n/a	def __init__(self):
59	n/a	self._options = Options()
60	n/a
61	n/a	def _get_entityResolver(self):
62	n/a	return self.entityResolver
63	n/a	def _set_entityResolver(self, entityResolver):
64	n/a	self.entityResolver = entityResolver
65	n/a
66	n/a	def _get_errorHandler(self):
67	n/a	return self.errorHandler
68	n/a	def _set_errorHandler(self, errorHandler):
69	n/a	self.errorHandler = errorHandler
70	n/a
71	n/a	def _get_filter(self):
72	n/a	return self.filter
73	n/a	def _set_filter(self, filter):
74	n/a	self.filter = filter
75	n/a
76	n/a	def setFeature(self, name, state):
77	n/a	if self.supportsFeature(name):
78	n/a	state = state and 1 or 0
79	n/a	try:
80	n/a	settings = self._settings[(_name_xform(name), state)]
81	n/a	except KeyError:
82	n/a	raise xml.dom.NotSupportedErr(
83	n/a	"unsupported feature: %r" % (name,))
84	n/a	else:
85	n/a	for name, value in settings:
86	n/a	setattr(self._options, name, value)
87	n/a	else:
88	n/a	raise xml.dom.NotFoundErr("unknown feature: " + repr(name))
89	n/a
90	n/a	def supportsFeature(self, name):
91	n/a	return hasattr(self._options, _name_xform(name))
92	n/a
93	n/a	def canSetFeature(self, name, state):
94	n/a	key = (_name_xform(name), state and 1 or 0)
95	n/a	return key in self._settings
96	n/a
97	n/a	# This dictionary maps from (feature,value) to a list of
98	n/a	# (option,value) pairs that should be set on the Options object.
99	n/a	# If a (feature,value) setting is not in this dictionary, it is
100	n/a	# not supported by the DOMBuilder.
101	n/a	#
102	n/a	_settings = {
103	n/a	("namespace_declarations", 0): [
104	n/a	("namespace_declarations", 0)],
105	n/a	("namespace_declarations", 1): [
106	n/a	("namespace_declarations", 1)],
107	n/a	("validation", 0): [
108	n/a	("validation", 0)],
109	n/a	("external_general_entities", 0): [
110	n/a	("external_general_entities", 0)],
111	n/a	("external_general_entities", 1): [
112	n/a	("external_general_entities", 1)],
113	n/a	("external_parameter_entities", 0): [
114	n/a	("external_parameter_entities", 0)],
115	n/a	("external_parameter_entities", 1): [
116	n/a	("external_parameter_entities", 1)],
117	n/a	("validate_if_schema", 0): [
118	n/a	("validate_if_schema", 0)],
119	n/a	("create_entity_ref_nodes", 0): [
120	n/a	("create_entity_ref_nodes", 0)],
121	n/a	("create_entity_ref_nodes", 1): [
122	n/a	("create_entity_ref_nodes", 1)],
123	n/a	("entities", 0): [
124	n/a	("create_entity_ref_nodes", 0),
125	n/a	("entities", 0)],
126	n/a	("entities", 1): [
127	n/a	("entities", 1)],
128	n/a	("whitespace_in_element_content", 0): [
129	n/a	("whitespace_in_element_content", 0)],
130	n/a	("whitespace_in_element_content", 1): [
131	n/a	("whitespace_in_element_content", 1)],
132	n/a	("cdata_sections", 0): [
133	n/a	("cdata_sections", 0)],
134	n/a	("cdata_sections", 1): [
135	n/a	("cdata_sections", 1)],
136	n/a	("comments", 0): [
137	n/a	("comments", 0)],
138	n/a	("comments", 1): [
139	n/a	("comments", 1)],
140	n/a	("charset_overrides_xml_encoding", 0): [
141	n/a	("charset_overrides_xml_encoding", 0)],
142	n/a	("charset_overrides_xml_encoding", 1): [
143	n/a	("charset_overrides_xml_encoding", 1)],
144	n/a	("infoset", 0): [],
145	n/a	("infoset", 1): [
146	n/a	("namespace_declarations", 0),
147	n/a	("validate_if_schema", 0),
148	n/a	("create_entity_ref_nodes", 0),
149	n/a	("entities", 0),
150	n/a	("cdata_sections", 0),
151	n/a	("datatype_normalization", 1),
152	n/a	("whitespace_in_element_content", 1),
153	n/a	("comments", 1),
154	n/a	("charset_overrides_xml_encoding", 1)],
155	n/a	("supported_mediatypes_only", 0): [
156	n/a	("supported_mediatypes_only", 0)],
157	n/a	("namespaces", 0): [
158	n/a	("namespaces", 0)],
159	n/a	("namespaces", 1): [
160	n/a	("namespaces", 1)],
161	n/a	}
162	n/a
163	n/a	def getFeature(self, name):
164	n/a	xname = _name_xform(name)
165	n/a	try:
166	n/a	return getattr(self._options, xname)
167	n/a	except AttributeError:
168	n/a	if name == "infoset":
169	n/a	options = self._options
170	n/a	return (options.datatype_normalization
171	n/a	and options.whitespace_in_element_content
172	n/a	and options.comments
173	n/a	and options.charset_overrides_xml_encoding
174	n/a	and not (options.namespace_declarations
175	n/a	or options.validate_if_schema
176	n/a	or options.create_entity_ref_nodes
177	n/a	or options.entities
178	n/a	or options.cdata_sections))
179	n/a	raise xml.dom.NotFoundErr("feature %s not known" % repr(name))
180	n/a
181	n/a	def parseURI(self, uri):
182	n/a	if self.entityResolver:
183	n/a	input = self.entityResolver.resolveEntity(None, uri)
184	n/a	else:
185	n/a	input = DOMEntityResolver().resolveEntity(None, uri)
186	n/a	return self.parse(input)
187	n/a
188	n/a	def parse(self, input):
189	n/a	options = copy.copy(self._options)
190	n/a	options.filter = self.filter
191	n/a	options.errorHandler = self.errorHandler
192	n/a	fp = input.byteStream
193	n/a	if fp is None and options.systemId:
194	n/a	import urllib.request
195	n/a	fp = urllib.request.urlopen(input.systemId)
196	n/a	return self._parse_bytestream(fp, options)
197	n/a
198	n/a	def parseWithContext(self, input, cnode, action):
199	n/a	if action not in self._legal_actions:
200	n/a	raise ValueError("not a legal action")
201	n/a	raise NotImplementedError("Haven't written this yet...")
202	n/a
203	n/a	def _parse_bytestream(self, stream, options):
204	n/a	import xml.dom.expatbuilder
205	n/a	builder = xml.dom.expatbuilder.makeBuilder(options)
206	n/a	return builder.parseFile(stream)
207	n/a
208	n/a
209	n/a	def _name_xform(name):
210	n/a	return name.lower().replace('-', '_')
211	n/a
212	n/a
213	n/a	class DOMEntityResolver(object):
214	n/a	__slots__ = '_opener',
215	n/a
216	n/a	def resolveEntity(self, publicId, systemId):
217	n/a	assert systemId is not None
218	n/a	source = DOMInputSource()
219	n/a	source.publicId = publicId
220	n/a	source.systemId = systemId
221	n/a	source.byteStream = self._get_opener().open(systemId)
222	n/a
223	n/a	# determine the encoding if the transport provided it
224	n/a	source.encoding = self._guess_media_encoding(source)
225	n/a
226	n/a	# determine the base URI is we can
227	n/a	import posixpath, urllib.parse
228	n/a	parts = urllib.parse.urlparse(systemId)
229	n/a	scheme, netloc, path, params, query, fragment = parts
230	n/a	# XXX should we check the scheme here as well?
231	n/a	if path and not path.endswith("/"):
232	n/a	path = posixpath.dirname(path) + "/"
233	n/a	parts = scheme, netloc, path, params, query, fragment
234	n/a	source.baseURI = urllib.parse.urlunparse(parts)
235	n/a
236	n/a	return source
237	n/a
238	n/a	def _get_opener(self):
239	n/a	try:
240	n/a	return self._opener
241	n/a	except AttributeError:
242	n/a	self._opener = self._create_opener()
243	n/a	return self._opener
244	n/a
245	n/a	def _create_opener(self):
246	n/a	import urllib.request
247	n/a	return urllib.request.build_opener()
248	n/a
249	n/a	def _guess_media_encoding(self, source):
250	n/a	info = source.byteStream.info()
251	n/a	if "Content-Type" in info:
252	n/a	for param in info.getplist():
253	n/a	if param.startswith("charset="):
254	n/a	return param.split("=", 1)[1].lower()
255	n/a
256	n/a
257	n/a	class DOMInputSource(object):
258	n/a	__slots__ = ('byteStream', 'characterStream', 'stringData',
259	n/a	'encoding', 'publicId', 'systemId', 'baseURI')
260	n/a
261	n/a	def __init__(self):
262	n/a	self.byteStream = None
263	n/a	self.characterStream = None
264	n/a	self.stringData = None
265	n/a	self.encoding = None
266	n/a	self.publicId = None
267	n/a	self.systemId = None
268	n/a	self.baseURI = None
269	n/a
270	n/a	def _get_byteStream(self):
271	n/a	return self.byteStream
272	n/a	def _set_byteStream(self, byteStream):
273	n/a	self.byteStream = byteStream
274	n/a
275	n/a	def _get_characterStream(self):
276	n/a	return self.characterStream
277	n/a	def _set_characterStream(self, characterStream):
278	n/a	self.characterStream = characterStream
279	n/a
280	n/a	def _get_stringData(self):
281	n/a	return self.stringData
282	n/a	def _set_stringData(self, data):
283	n/a	self.stringData = data
284	n/a
285	n/a	def _get_encoding(self):
286	n/a	return self.encoding
287	n/a	def _set_encoding(self, encoding):
288	n/a	self.encoding = encoding
289	n/a
290	n/a	def _get_publicId(self):
291	n/a	return self.publicId
292	n/a	def _set_publicId(self, publicId):
293	n/a	self.publicId = publicId
294	n/a
295	n/a	def _get_systemId(self):
296	n/a	return self.systemId
297	n/a	def _set_systemId(self, systemId):
298	n/a	self.systemId = systemId
299	n/a
300	n/a	def _get_baseURI(self):
301	n/a	return self.baseURI
302	n/a	def _set_baseURI(self, uri):
303	n/a	self.baseURI = uri
304	n/a
305	n/a
306	n/a	class DOMBuilderFilter:
307	n/a	"""Element filter which can be used to tailor construction of
308	n/a	a DOM instance.
309	n/a	"""
310	n/a
311	n/a	# There's really no need for this class; concrete implementations
312	n/a	# should just implement the endElement() and startElement()
313	n/a	# methods as appropriate. Using this makes it easy to only
314	n/a	# implement one of them.
315	n/a
316	n/a	FILTER_ACCEPT = 1
317	n/a	FILTER_REJECT = 2
318	n/a	FILTER_SKIP = 3
319	n/a	FILTER_INTERRUPT = 4
320	n/a
321	n/a	whatToShow = NodeFilter.SHOW_ALL
322	n/a
323	n/a	def _get_whatToShow(self):
324	n/a	return self.whatToShow
325	n/a
326	n/a	def acceptNode(self, element):
327	n/a	return self.FILTER_ACCEPT
328	n/a
329	n/a	def startContainer(self, element):
330	n/a	return self.FILTER_ACCEPT
331	n/a
332	n/a	del NodeFilter
333	n/a
334	n/a
335	n/a	class _AsyncDeprecatedProperty:
336	n/a	def warn(self, cls):
337	n/a	clsname = cls.__name__
338	n/a	warnings.warn(
339	n/a	"{cls}.async is deprecated; use {cls}.async_".format(cls=clsname),
340	n/a	DeprecationWarning)
341	n/a
342	n/a	def __get__(self, instance, cls):
343	n/a	self.warn(cls)
344	n/a	if instance is not None:
345	n/a	return instance.async_
346	n/a	return False
347	n/a
348	n/a	def __set__(self, instance, value):
349	n/a	self.warn(type(instance))
350	n/a	setattr(instance, 'async_', value)
351	n/a
352	n/a
353	n/a	class DocumentLS:
354	n/a	"""Mixin to create documents that conform to the load/save spec."""
355	n/a
356	n/a	async_ = False
357	n/a	locals()['async'] = _AsyncDeprecatedProperty() # Avoid DeprecationWarning
358	n/a
359	n/a	def _get_async(self):
360	n/a	return False
361	n/a
362	n/a	def _set_async(self, flag):
363	n/a	if flag:
364	n/a	raise xml.dom.NotSupportedErr(
365	n/a	"asynchronous document loading is not supported")
366	n/a
367	n/a	def abort(self):
368	n/a	# What does it mean to "clear" a document? Does the
369	n/a	# documentElement disappear?
370	n/a	raise NotImplementedError(
371	n/a	"haven't figured out what this means yet")
372	n/a
373	n/a	def load(self, uri):
374	n/a	raise NotImplementedError("haven't written this yet")
375	n/a
376	n/a	def loadXML(self, source):
377	n/a	raise NotImplementedError("haven't written this yet")
378	n/a
379	n/a	def saveXML(self, snode):
380	n/a	if snode is None:
381	n/a	snode = self
382	n/a	elif snode.ownerDocument is not self:
383	n/a	raise xml.dom.WrongDocumentErr()
384	n/a	return snode.toxml()
385	n/a
386	n/a
387	n/a	del _AsyncDeprecatedProperty
388	n/a
389	n/a
390	n/a	class DOMImplementationLS:
391	n/a	MODE_SYNCHRONOUS = 1
392	n/a	MODE_ASYNCHRONOUS = 2
393	n/a
394	n/a	def createDOMBuilder(self, mode, schemaType):
395	n/a	if schemaType is not None:
396	n/a	raise xml.dom.NotSupportedErr(
397	n/a	"schemaType not yet supported")
398	n/a	if mode == self.MODE_SYNCHRONOUS:
399	n/a	return DOMBuilder()
400	n/a	if mode == self.MODE_ASYNCHRONOUS:
401	n/a	raise xml.dom.NotSupportedErr(
402	n/a	"asynchronous builders are not supported")
403	n/a	raise ValueError("unknown value for mode")
404	n/a
405	n/a	def createDOMWriter(self):
406	n/a	raise NotImplementedError(
407	n/a	"the writer interface hasn't been written yet!")
408	n/a
409	n/a	def createDOMInputSource(self):
410	n/a	return DOMInputSource()