2007-08-15 11:28:22 -03:00
|
|
|
:mod:`xml.parsers.expat` --- Fast XML parsing using Expat
|
|
|
|
=========================================================
|
|
|
|
|
|
|
|
.. module:: xml.parsers.expat
|
|
|
|
:synopsis: An interface to the Expat non-validating XML parser.
|
|
|
|
.. moduleauthor:: Paul Prescod <paul@prescod.net>
|
|
|
|
|
|
|
|
|
Merged revisions 59605-59624 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r59606 | georg.brandl | 2007-12-29 11:57:00 +0100 (Sat, 29 Dec 2007) | 2 lines
Some cleanup in the docs.
........
r59611 | martin.v.loewis | 2007-12-29 19:49:21 +0100 (Sat, 29 Dec 2007) | 2 lines
Bug #1699: Define _BSD_SOURCE only on OpenBSD.
........
r59612 | raymond.hettinger | 2007-12-29 23:09:34 +0100 (Sat, 29 Dec 2007) | 1 line
Simpler documentation for itertools.tee(). Should be backported.
........
r59613 | raymond.hettinger | 2007-12-29 23:16:24 +0100 (Sat, 29 Dec 2007) | 1 line
Improve docs for itertools.groupby(). The use of xrange(0) to create a unique object is less obvious than object().
........
r59620 | christian.heimes | 2007-12-31 15:47:07 +0100 (Mon, 31 Dec 2007) | 3 lines
Added wininst-9.0.exe executable for VS 2008
Integrated bdist_wininst into PCBuild9 directory
........
r59621 | christian.heimes | 2007-12-31 15:51:18 +0100 (Mon, 31 Dec 2007) | 1 line
Moved PCbuild directory to PC/VS7.1
........
r59622 | christian.heimes | 2007-12-31 15:59:26 +0100 (Mon, 31 Dec 2007) | 1 line
Fix paths for build bot
........
r59623 | christian.heimes | 2007-12-31 16:02:41 +0100 (Mon, 31 Dec 2007) | 1 line
Fix paths for build bot, part 2
........
r59624 | christian.heimes | 2007-12-31 16:18:55 +0100 (Mon, 31 Dec 2007) | 1 line
Renamed PCBuild9 directory to PCBuild
........
2007-12-31 12:14:33 -04:00
|
|
|
.. Markup notes:
|
|
|
|
|
|
|
|
Many of the attributes of the XMLParser objects are callbacks. Since
|
|
|
|
signature information must be presented, these are described using the method
|
|
|
|
directive. Since they are attributes which are set by client code, in-text
|
|
|
|
references to these attributes should be marked using the :member: role.
|
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2013-03-26 13:35:55 -03:00
|
|
|
.. warning::
|
|
|
|
|
|
|
|
The :mod:`pyexpat` module is not secure against maliciously
|
|
|
|
constructed data. If you need to parse untrusted or unauthenticated data see
|
|
|
|
:ref:`xml-vulnerabilities`.
|
|
|
|
|
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
.. index:: single: Expat
|
|
|
|
|
|
|
|
The :mod:`xml.parsers.expat` module is a Python interface to the Expat
|
|
|
|
non-validating XML parser. The module provides a single extension type,
|
|
|
|
:class:`xmlparser`, that represents the current state of an XML parser. After
|
|
|
|
an :class:`xmlparser` object has been created, various attributes of the object
|
|
|
|
can be set to handler functions. When an XML document is then fed to the
|
|
|
|
parser, the handler functions are called for the character data and markup in
|
|
|
|
the XML document.
|
|
|
|
|
|
|
|
.. index:: module: pyexpat
|
|
|
|
|
|
|
|
This module uses the :mod:`pyexpat` module to provide access to the Expat
|
|
|
|
parser. Direct use of the :mod:`pyexpat` module is deprecated.
|
|
|
|
|
|
|
|
This module provides one exception and one type object:
|
|
|
|
|
|
|
|
|
|
|
|
.. exception:: ExpatError
|
|
|
|
|
|
|
|
The exception raised when Expat reports an error. See section
|
|
|
|
:ref:`expaterror-objects` for more information on interpreting Expat errors.
|
|
|
|
|
|
|
|
|
|
|
|
.. exception:: error
|
|
|
|
|
|
|
|
Alias for :exc:`ExpatError`.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XMLParserType
|
|
|
|
|
|
|
|
The type of the return values from the :func:`ParserCreate` function.
|
|
|
|
|
|
|
|
The :mod:`xml.parsers.expat` module contains two functions:
|
|
|
|
|
|
|
|
|
|
|
|
.. function:: ErrorString(errno)
|
|
|
|
|
|
|
|
Returns an explanatory string for a given error number *errno*.
|
|
|
|
|
|
|
|
|
2009-09-02 17:34:52 -03:00
|
|
|
.. function:: ParserCreate(encoding=None, namespace_separator=None)
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
Creates and returns a new :class:`xmlparser` object. *encoding*, if specified,
|
|
|
|
must be a string naming the encoding used by the XML data. Expat doesn't
|
|
|
|
support as many encodings as Python does, and its repertoire of encodings can't
|
|
|
|
be extended; it supports UTF-8, UTF-16, ISO-8859-1 (Latin1), and ASCII. If
|
Merged revisions 61431,61433-61436,61439,61444,61449-61450,61453,61458,61465,61468,61471-61474,61480,61483-61484,61488,61495-61496,61498,61503-61504,61507,61509-61510,61515-61518 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r61431 | vinay.sajip | 2008-03-16 22:35:58 +0100 (So, 16 Mär 2008) | 1 line
Clarified documentation on use of shutdown().
........
r61433 | mark.summerfield | 2008-03-17 09:28:15 +0100 (Mo, 17 Mär 2008) | 5 lines
Added a footnote to each pointing out that for XML output if an encoding
string is given it should conform to the appropriate XML standards---for
example, "UTF-8" is okay, but "UTF8" is not.
........
r61434 | eric.smith | 2008-03-17 12:01:01 +0100 (Mo, 17 Mär 2008) | 7 lines
Issue 2264: empty float presentation type needs to have at least one digit past the decimal point.
Added "Z" format_char to PyOS_ascii_formatd to support empty float presentation type.
Renamed buf_size in PyOS_ascii_formatd to more accurately reflect it's meaning.
Modified format.__float__ to use the new "Z" format as the default.
Added test cases.
........
r61435 | eric.smith | 2008-03-17 13:14:29 +0100 (Mo, 17 Mär 2008) | 2 lines
Reformated lines > 79 chars.
Deleted unused macro ISXDIGIT.
........
r61436 | jeffrey.yasskin | 2008-03-17 15:40:53 +0100 (Mo, 17 Mär 2008) | 13 lines
Allow Gnu gcc's to build python on OSX by removing -Wno-long-double,
-no-cpp-precomp, and -mno-fused-madd from configure.
* r22183 added -no-cpp-precomp, which
http://gcc.gnu.org/ml/gcc/2005-12/msg00368.html claims hasn't been
needed since gcc-3.1.
* r25607 added -Wno-long-double to avoid a warning in
Include/objimpl.h (issue 525481). The long double is still there,
but OSX 10.4's gcc no longer warns about it.
* r33666 fixed issue 775892 on OSX 10.3 by adding -mno-fused-madd,
which changed the sign of some float 0s. Tim Peters said it wasn't
a real issue anyway, and it no longer causes test failures.
Fixes issue #1779871.
........
r61439 | martin.v.loewis | 2008-03-17 17:31:57 +0100 (Mo, 17 Mär 2008) | 2 lines
Add Trent Nelson.
........
r61444 | travis.oliphant | 2008-03-17 18:36:12 +0100 (Mo, 17 Mär 2008) | 1 line
Add necessary headers to back-port new buffer protocol to Python 2.6
........
r61449 | gregory.p.smith | 2008-03-17 19:48:05 +0100 (Mo, 17 Mär 2008) | 8 lines
Force zlib.crc32 and zlib.adler32 to return a signed integer on all platforms
regardless of the native sizeof(long) used in the integer object.
This somewhat odd behavior of returning a signed is maintained in 2.x for
compatibility reasons of always returning an integer rather than a long object.
Fixes Issue1202 for Python 2.6
........
r61450 | neal.norwitz | 2008-03-17 20:02:45 +0100 (Mo, 17 Mär 2008) | 3 lines
Use a buffer large enough to ensure we don't overrun, even if the value
is outside the range we expect.
........
r61453 | steven.bethard | 2008-03-17 20:33:11 +0100 (Mo, 17 Mär 2008) | 1 line
Document unicode.isnumeric() and unicode.isdecimal() (issue2326)
........
r61458 | neal.norwitz | 2008-03-17 21:22:43 +0100 (Mo, 17 Mär 2008) | 5 lines
Issue 2321: reduce memory usage (increase the memory that is returned
to the system) by using pymalloc for the data of unicode objects.
Will backport.
........
r61465 | martin.v.loewis | 2008-03-17 22:55:30 +0100 (Mo, 17 Mär 2008) | 2 lines
Add David Wolever.
........
r61468 | gregory.p.smith | 2008-03-18 01:20:01 +0100 (Di, 18 Mär 2008) | 3 lines
Fix the IOError message text when opening a file with an invalid filename.
Error reported by Ilan Schnell.
........
r61471 | brett.cannon | 2008-03-18 02:00:07 +0100 (Di, 18 Mär 2008) | 2 lines
Convert test_strftime, test_getargs, and test_pep247 to use unittest.
........
r61472 | jeffrey.yasskin | 2008-03-18 02:09:59 +0100 (Di, 18 Mär 2008) | 2 lines
Fix build on platforms that don't have intptr_t. Patch by Joseph Armbruster.
........
r61473 | brett.cannon | 2008-03-18 02:50:25 +0100 (Di, 18 Mär 2008) | 2 lines
Convert test_dummy_threading and test_dbm to unittest.
........
r61474 | brett.cannon | 2008-03-18 02:58:56 +0100 (Di, 18 Mär 2008) | 2 lines
Move test_extcall to doctest.
........
r61480 | brett.cannon | 2008-03-18 04:46:22 +0100 (Di, 18 Mär 2008) | 2 lines
test_errno was a no-op test; now it actually tests things and uses unittest.
........
r61483 | brett.cannon | 2008-03-18 05:09:00 +0100 (Di, 18 Mär 2008) | 3 lines
Remove our implementation of memmove() and strerror(); both are in the C89
standard library.
........
r61484 | brett.cannon | 2008-03-18 05:16:06 +0100 (Di, 18 Mär 2008) | 2 lines
The output directory for tests that compare against stdout is now gone!
........
r61488 | jeffrey.yasskin | 2008-03-18 05:29:35 +0100 (Di, 18 Mär 2008) | 2 lines
Block the "socket.ssl() is deprecated" warning from test_socket_ssl.
........
r61495 | jeffrey.yasskin | 2008-03-18 05:56:06 +0100 (Di, 18 Mär 2008) | 4 lines
Speed test_thread up from 51.328s to 0.081s by reducing its sleep times. We
still sleep at all to make it likely that all threads are active at the same
time.
........
r61496 | jeffrey.yasskin | 2008-03-18 06:12:41 +0100 (Di, 18 Mär 2008) | 4 lines
Speed up test_dict by about 10x by only checking selected dict literal sizes,
instead of every integer from 0 to 400. Exhaustive testing wastes time without
providing enough more assurance that the code is correct.
........
r61498 | neal.norwitz | 2008-03-18 06:20:29 +0100 (Di, 18 Mär 2008) | 1 line
Try increasing the timeout to reduce the flakiness of this test.
........
r61503 | brett.cannon | 2008-03-18 06:43:04 +0100 (Di, 18 Mär 2008) | 2 lines
Improve the error message for a test that failed on the S-390 Debian buildbot.
........
r61504 | jeffrey.yasskin | 2008-03-18 06:45:40 +0100 (Di, 18 Mär 2008) | 3 lines
Add a -S/--slow flag to regrtest to have it print the 10 slowest tests with
their times.
........
r61507 | neal.norwitz | 2008-03-18 07:03:46 +0100 (Di, 18 Mär 2008) | 1 line
Add some info to the failure messages
........
r61509 | trent.nelson | 2008-03-18 08:02:12 +0100 (Di, 18 Mär 2008) | 1 line
Issue 2286: bump up the stack size of the 64-bit debug python_d.exe to 2100000. The default value of 200000 causes a stack overflow at 1965 iterations of r_object() in marshal.c, 35 iterations before the 2000 limit enforced by MAX_MARSHAL_STACK_DEPTH.
........
r61510 | trent.nelson | 2008-03-18 08:32:47 +0100 (Di, 18 Mär 2008) | 5 lines
The behaviour of winsound.Beep() seems to differ between different versions of Windows when there's either:
a) no sound card entirely
b) legacy beep driver has been disabled
c) the legacy beep driver has been uninstalled
Sometimes RuntimeErrors are raised, sometimes they're not. If _have_soundcard() returns False, don't expect winsound.Beep() to raise a RuntimeError, as this clearly isn't the case, as demonstrated by the various Win32 XP buildbots.
........
r61515 | martin.v.loewis | 2008-03-18 13:20:15 +0100 (Di, 18 Mär 2008) | 2 lines
norwitz-amd64 (gentoo) has EREMOTEIO.
........
r61516 | martin.v.loewis | 2008-03-18 13:45:37 +0100 (Di, 18 Mär 2008) | 2 lines
Add more Linux error codes.
........
r61517 | martin.v.loewis | 2008-03-18 14:05:03 +0100 (Di, 18 Mär 2008) | 2 lines
Add WSA errors.
........
r61518 | martin.v.loewis | 2008-03-18 14:16:05 +0100 (Di, 18 Mär 2008) | 2 lines
Note that the stderr output of the test is intentional.
........
2008-03-18 12:15:01 -03:00
|
|
|
*encoding* [1]_ is given it will override the implicit or explicit encoding of the
|
2007-08-15 11:28:22 -03:00
|
|
|
document.
|
|
|
|
|
|
|
|
Expat can optionally do XML namespace processing for you, enabled by providing a
|
|
|
|
value for *namespace_separator*. The value must be a one-character string; a
|
|
|
|
:exc:`ValueError` will be raised if the string has an illegal length (``None``
|
|
|
|
is considered the same as omission). When namespace processing is enabled,
|
|
|
|
element type names and attribute names that belong to a namespace will be
|
|
|
|
expanded. The element name passed to the element handlers
|
|
|
|
:attr:`StartElementHandler` and :attr:`EndElementHandler` will be the
|
|
|
|
concatenation of the namespace URI, the namespace separator character, and the
|
|
|
|
local part of the name. If the namespace separator is a zero byte (``chr(0)``)
|
|
|
|
then the namespace URI and the local part will be concatenated without any
|
|
|
|
separator.
|
|
|
|
|
|
|
|
For example, if *namespace_separator* is set to a space character (``' '``) and
|
|
|
|
the following document is parsed::
|
|
|
|
|
|
|
|
<?xml version="1.0"?>
|
|
|
|
<root xmlns = "http://default-namespace.org/"
|
|
|
|
xmlns:py = "http://www.python.org/ns/">
|
|
|
|
<py:elem1 />
|
|
|
|
<elem2 xmlns="" />
|
|
|
|
</root>
|
|
|
|
|
|
|
|
:attr:`StartElementHandler` will receive the following strings for each
|
|
|
|
element::
|
|
|
|
|
|
|
|
http://default-namespace.org/ root
|
|
|
|
http://www.python.org/ns/ elem1
|
|
|
|
elem2
|
|
|
|
|
|
|
|
|
|
|
|
.. seealso::
|
|
|
|
|
|
|
|
`The Expat XML Parser <http://www.libexpat.org/>`_
|
|
|
|
Home page of the Expat project.
|
|
|
|
|
|
|
|
|
|
|
|
.. _xmlparser-objects:
|
|
|
|
|
|
|
|
XMLParser Objects
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
:class:`xmlparser` objects have the following methods:
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.Parse(data[, isfinal])
|
|
|
|
|
|
|
|
Parses the contents of the string *data*, calling the appropriate handler
|
|
|
|
functions to process the parsed data. *isfinal* must be true on the final call
|
|
|
|
to this method. *data* can be the empty string at any time.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.ParseFile(file)
|
|
|
|
|
|
|
|
Parse XML data reading from the object *file*. *file* only needs to provide
|
|
|
|
the ``read(nbytes)`` method, returning the empty string when there's no more
|
|
|
|
data.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.SetBase(base)
|
|
|
|
|
|
|
|
Sets the base to be used for resolving relative URIs in system identifiers in
|
|
|
|
declarations. Resolving relative identifiers is left to the application: this
|
|
|
|
value will be passed through as the *base* argument to the
|
|
|
|
:func:`ExternalEntityRefHandler`, :func:`NotationDeclHandler`, and
|
|
|
|
:func:`UnparsedEntityDeclHandler` functions.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.GetBase()
|
|
|
|
|
|
|
|
Returns a string containing the base set by a previous call to :meth:`SetBase`,
|
|
|
|
or ``None`` if :meth:`SetBase` hasn't been called.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.GetInputContext()
|
|
|
|
|
|
|
|
Returns the input data that generated the current event as a string. The data is
|
|
|
|
in the encoding of the entity which contains the text. When called while an
|
|
|
|
event handler is not active, the return value is ``None``.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.ExternalEntityParserCreate(context[, encoding])
|
|
|
|
|
|
|
|
Create a "child" parser which can be used to parse an external parsed entity
|
|
|
|
referred to by content parsed by the parent parser. The *context* parameter
|
|
|
|
should be the string passed to the :meth:`ExternalEntityRefHandler` handler
|
|
|
|
function, described below. The child parser is created with the
|
|
|
|
:attr:`ordered_attributes` and :attr:`specified_attributes` set to the values of
|
|
|
|
this parser.
|
|
|
|
|
2011-01-05 14:37:22 -04:00
|
|
|
.. method:: xmlparser.SetParamEntityParsing(flag)
|
|
|
|
|
|
|
|
Control parsing of parameter entities (including the external DTD subset).
|
|
|
|
Possible *flag* values are :const:`XML_PARAM_ENTITY_PARSING_NEVER`,
|
|
|
|
:const:`XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE` and
|
|
|
|
:const:`XML_PARAM_ENTITY_PARSING_ALWAYS`. Return true if setting the flag
|
|
|
|
was successful.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
.. method:: xmlparser.UseForeignDTD([flag])
|
|
|
|
|
|
|
|
Calling this with a true value for *flag* (the default) will cause Expat to call
|
|
|
|
the :attr:`ExternalEntityRefHandler` with :const:`None` for all arguments to
|
|
|
|
allow an alternate DTD to be loaded. If the document does not contain a
|
|
|
|
document type declaration, the :attr:`ExternalEntityRefHandler` will still be
|
|
|
|
called, but the :attr:`StartDoctypeDeclHandler` and
|
|
|
|
:attr:`EndDoctypeDeclHandler` will not be called.
|
|
|
|
|
|
|
|
Passing a false value for *flag* will cancel a previous call that passed a true
|
|
|
|
value, but otherwise has no effect.
|
|
|
|
|
|
|
|
This method can only be called before the :meth:`Parse` or :meth:`ParseFile`
|
|
|
|
methods are called; calling it after either of those have been called causes
|
|
|
|
:exc:`ExpatError` to be raised with the :attr:`code` attribute set to
|
2010-10-15 11:46:48 -03:00
|
|
|
``errors.codes[errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING]``.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
:class:`xmlparser` objects have the following attributes:
|
|
|
|
|
|
|
|
|
|
|
|
.. attribute:: xmlparser.buffer_size
|
|
|
|
|
2009-01-03 17:18:54 -04:00
|
|
|
The size of the buffer used when :attr:`buffer_text` is true.
|
|
|
|
A new buffer size can be set by assigning a new integer value
|
|
|
|
to this attribute.
|
Merged revisions 59843-59863 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r59844 | raymond.hettinger | 2008-01-07 21:56:05 +0100 (Mon, 07 Jan 2008) | 1 line
Use get() instead of pop() for the optimized version of _replace().
........
r59847 | raymond.hettinger | 2008-01-07 22:33:51 +0100 (Mon, 07 Jan 2008) | 1 line
Documentation nits.
........
r59849 | raymond.hettinger | 2008-01-08 03:02:05 +0100 (Tue, 08 Jan 2008) | 1 line
Expand comment.
........
r59850 | raymond.hettinger | 2008-01-08 03:24:15 +0100 (Tue, 08 Jan 2008) | 1 line
Docs on named tuple's naming conventions and limits of subclassing
........
r59851 | christian.heimes | 2008-01-08 04:40:04 +0100 (Tue, 08 Jan 2008) | 1 line
It's verbose, not debug
........
r59852 | facundo.batista | 2008-01-08 13:25:20 +0100 (Tue, 08 Jan 2008) | 4 lines
Issue #1757: The hash of a Decimal instance is no longer affected
by the current context. Thanks Mark Dickinson.
........
r59853 | andrew.kuchling | 2008-01-08 15:30:55 +0100 (Tue, 08 Jan 2008) | 1 line
Patch 1137: allow assigning to .buffer_size attribute of PyExpat.parser objects
........
r59854 | andrew.kuchling | 2008-01-08 15:56:02 +0100 (Tue, 08 Jan 2008) | 1 line
Patch 1114: fix compilation of curses module on 64-bit AIX, and any other LP64 platforms where attr_t isn't a C long
........
r59856 | thomas.heller | 2008-01-08 16:15:09 +0100 (Tue, 08 Jan 2008) | 5 lines
Use relative instead of absolute filenames in the C-level tracebacks.
This prevents traceback prints pointing to files in this way:
File "\loewis\25\python\Modules\_ctypes\callbacks.c", line 206, in 'calling callback function'
........
r59857 | christian.heimes | 2008-01-08 16:46:10 +0100 (Tue, 08 Jan 2008) | 2 lines
Added __enter__ and __exit__ functions to HKEY object
Added ExpandEnvironmentStrings to the _winreg module.
........
r59858 | georg.brandl | 2008-01-08 17:18:26 +0100 (Tue, 08 Jan 2008) | 2 lines
Fix markup errors from r59857 and clarify key.__enter__/__exit__ docs
........
r59860 | georg.brandl | 2008-01-08 20:42:30 +0100 (Tue, 08 Jan 2008) | 2 lines
Better method for associating .py files with the interpreter.
........
r59862 | facundo.batista | 2008-01-08 22:10:12 +0100 (Tue, 08 Jan 2008) | 9 lines
Issue 846388. Adds a call to PyErr_CheckSignals to
SRE_MATCH so that signal handlers can be invoked during
long regular expression matches. It also adds a new
error return value indicating that an exception
occurred in a signal handler during the match, allowing
exceptions in the signal handler to propagate up to the
main loop. Thanks Josh Hoyt and Ralf Schmitt.
........
2008-01-08 20:17:24 -04:00
|
|
|
When the size is changed, the buffer will be flushed.
|
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
.. attribute:: xmlparser.buffer_text
|
|
|
|
|
|
|
|
Setting this to true causes the :class:`xmlparser` object to buffer textual
|
|
|
|
content returned by Expat to avoid multiple calls to the
|
|
|
|
:meth:`CharacterDataHandler` callback whenever possible. This can improve
|
|
|
|
performance substantially since Expat normally breaks character data into chunks
|
|
|
|
at every line ending. This attribute is false by default, and may be changed at
|
|
|
|
any time.
|
|
|
|
|
|
|
|
|
|
|
|
.. attribute:: xmlparser.buffer_used
|
|
|
|
|
|
|
|
If :attr:`buffer_text` is enabled, the number of bytes stored in the buffer.
|
|
|
|
These bytes represent UTF-8 encoded text. This attribute has no meaningful
|
|
|
|
interpretation when :attr:`buffer_text` is false.
|
|
|
|
|
|
|
|
|
|
|
|
.. attribute:: xmlparser.ordered_attributes
|
|
|
|
|
|
|
|
Setting this attribute to a non-zero integer causes the attributes to be
|
|
|
|
reported as a list rather than a dictionary. The attributes are presented in
|
|
|
|
the order found in the document text. For each attribute, two list entries are
|
|
|
|
presented: the attribute name and the attribute value. (Older versions of this
|
|
|
|
module also used this format.) By default, this attribute is false; it may be
|
|
|
|
changed at any time.
|
|
|
|
|
|
|
|
|
|
|
|
.. attribute:: xmlparser.specified_attributes
|
|
|
|
|
|
|
|
If set to a non-zero integer, the parser will report only those attributes which
|
|
|
|
were specified in the document instance and not those which were derived from
|
|
|
|
attribute declarations. Applications which set this need to be especially
|
|
|
|
careful to use what additional information is available from the declarations as
|
|
|
|
needed to comply with the standards for the behavior of XML processors. By
|
|
|
|
default, this attribute is false; it may be changed at any time.
|
|
|
|
|
|
|
|
|
|
|
|
The following attributes contain values relating to the most recent error
|
|
|
|
encountered by an :class:`xmlparser` object, and will only have correct values
|
|
|
|
once a call to :meth:`Parse` or :meth:`ParseFile` has raised a
|
|
|
|
:exc:`xml.parsers.expat.ExpatError` exception.
|
|
|
|
|
|
|
|
|
|
|
|
.. attribute:: xmlparser.ErrorByteIndex
|
|
|
|
|
|
|
|
Byte index at which an error occurred.
|
|
|
|
|
|
|
|
|
|
|
|
.. attribute:: xmlparser.ErrorCode
|
|
|
|
|
|
|
|
Numeric code specifying the problem. This value can be passed to the
|
|
|
|
:func:`ErrorString` function, or compared to one of the constants defined in the
|
|
|
|
``errors`` object.
|
|
|
|
|
|
|
|
|
|
|
|
.. attribute:: xmlparser.ErrorColumnNumber
|
|
|
|
|
|
|
|
Column number at which an error occurred.
|
|
|
|
|
|
|
|
|
|
|
|
.. attribute:: xmlparser.ErrorLineNumber
|
|
|
|
|
|
|
|
Line number at which an error occurred.
|
|
|
|
|
|
|
|
The following attributes contain values relating to the current parse location
|
|
|
|
in an :class:`xmlparser` object. During a callback reporting a parse event they
|
|
|
|
indicate the location of the first of the sequence of characters that generated
|
|
|
|
the event. When called outside of a callback, the position indicated will be
|
|
|
|
just past the last parse event (regardless of whether there was an associated
|
|
|
|
callback).
|
|
|
|
|
|
|
|
|
|
|
|
.. attribute:: xmlparser.CurrentByteIndex
|
|
|
|
|
|
|
|
Current byte index in the parser input.
|
|
|
|
|
|
|
|
|
|
|
|
.. attribute:: xmlparser.CurrentColumnNumber
|
|
|
|
|
|
|
|
Current column number in the parser input.
|
|
|
|
|
|
|
|
|
|
|
|
.. attribute:: xmlparser.CurrentLineNumber
|
|
|
|
|
|
|
|
Current line number in the parser input.
|
|
|
|
|
|
|
|
Here is the list of handlers that can be set. To set a handler on an
|
|
|
|
:class:`xmlparser` object *o*, use ``o.handlername = func``. *handlername* must
|
|
|
|
be taken from the following list, and *func* must be a callable object accepting
|
|
|
|
the correct number of arguments. The arguments are all strings, unless
|
|
|
|
otherwise stated.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.XmlDeclHandler(version, encoding, standalone)
|
|
|
|
|
|
|
|
Called when the XML declaration is parsed. The XML declaration is the
|
|
|
|
(optional) declaration of the applicable version of the XML recommendation, the
|
|
|
|
encoding of the document text, and an optional "standalone" declaration.
|
|
|
|
*version* and *encoding* will be strings, and *standalone* will be ``1`` if the
|
|
|
|
document is declared standalone, ``0`` if it is declared not to be standalone,
|
|
|
|
or ``-1`` if the standalone clause was omitted. This is only available with
|
|
|
|
Expat version 1.95.0 or newer.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.StartDoctypeDeclHandler(doctypeName, systemId, publicId, has_internal_subset)
|
|
|
|
|
|
|
|
Called when Expat begins parsing the document type declaration (``<!DOCTYPE
|
|
|
|
...``). The *doctypeName* is provided exactly as presented. The *systemId* and
|
|
|
|
*publicId* parameters give the system and public identifiers if specified, or
|
|
|
|
``None`` if omitted. *has_internal_subset* will be true if the document
|
|
|
|
contains and internal document declaration subset. This requires Expat version
|
|
|
|
1.2 or newer.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.EndDoctypeDeclHandler()
|
|
|
|
|
|
|
|
Called when Expat is done parsing the document type declaration. This requires
|
|
|
|
Expat version 1.2 or newer.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.ElementDeclHandler(name, model)
|
|
|
|
|
|
|
|
Called once for each element type declaration. *name* is the name of the
|
|
|
|
element type, and *model* is a representation of the content model.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.AttlistDeclHandler(elname, attname, type, default, required)
|
|
|
|
|
|
|
|
Called for each declared attribute for an element type. If an attribute list
|
|
|
|
declaration declares three attributes, this handler is called three times, once
|
|
|
|
for each attribute. *elname* is the name of the element to which the
|
|
|
|
declaration applies and *attname* is the name of the attribute declared. The
|
|
|
|
attribute type is a string passed as *type*; the possible values are
|
|
|
|
``'CDATA'``, ``'ID'``, ``'IDREF'``, ... *default* gives the default value for
|
|
|
|
the attribute used when the attribute is not specified by the document instance,
|
|
|
|
or ``None`` if there is no default value (``#IMPLIED`` values). If the
|
|
|
|
attribute is required to be given in the document instance, *required* will be
|
|
|
|
true. This requires Expat version 1.95.0 or newer.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.StartElementHandler(name, attributes)
|
|
|
|
|
|
|
|
Called for the start of every element. *name* is a string containing the
|
2013-08-25 23:05:55 -03:00
|
|
|
element name, and *attributes* is the element attributes. If
|
|
|
|
:attr:`ordered_attributes` is true, this is a list (see
|
|
|
|
:attr:`ordered_attributes` for a full description). Otherwise it's a
|
|
|
|
dictionary mapping names to values.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.EndElementHandler(name)
|
|
|
|
|
|
|
|
Called for the end of every element.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.ProcessingInstructionHandler(target, data)
|
|
|
|
|
|
|
|
Called for every processing instruction.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.CharacterDataHandler(data)
|
|
|
|
|
|
|
|
Called for character data. This will be called for normal character data, CDATA
|
|
|
|
marked content, and ignorable whitespace. Applications which must distinguish
|
|
|
|
these cases can use the :attr:`StartCdataSectionHandler`,
|
|
|
|
:attr:`EndCdataSectionHandler`, and :attr:`ElementDeclHandler` callbacks to
|
|
|
|
collect the required information.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.UnparsedEntityDeclHandler(entityName, base, systemId, publicId, notationName)
|
|
|
|
|
|
|
|
Called for unparsed (NDATA) entity declarations. This is only present for
|
|
|
|
version 1.2 of the Expat library; for more recent versions, use
|
|
|
|
:attr:`EntityDeclHandler` instead. (The underlying function in the Expat
|
|
|
|
library has been declared obsolete.)
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.EntityDeclHandler(entityName, is_parameter_entity, value, base, systemId, publicId, notationName)
|
|
|
|
|
|
|
|
Called for all entity declarations. For parameter and internal entities,
|
|
|
|
*value* will be a string giving the declared contents of the entity; this will
|
|
|
|
be ``None`` for external entities. The *notationName* parameter will be
|
|
|
|
``None`` for parsed entities, and the name of the notation for unparsed
|
|
|
|
entities. *is_parameter_entity* will be true if the entity is a parameter entity
|
|
|
|
or false for general entities (most applications only need to be concerned with
|
|
|
|
general entities). This is only available starting with version 1.95.0 of the
|
|
|
|
Expat library.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.NotationDeclHandler(notationName, base, systemId, publicId)
|
|
|
|
|
|
|
|
Called for notation declarations. *notationName*, *base*, and *systemId*, and
|
|
|
|
*publicId* are strings if given. If the public identifier is omitted,
|
|
|
|
*publicId* will be ``None``.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.StartNamespaceDeclHandler(prefix, uri)
|
|
|
|
|
|
|
|
Called when an element contains a namespace declaration. Namespace declarations
|
|
|
|
are processed before the :attr:`StartElementHandler` is called for the element
|
|
|
|
on which declarations are placed.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.EndNamespaceDeclHandler(prefix)
|
|
|
|
|
|
|
|
Called when the closing tag is reached for an element that contained a
|
|
|
|
namespace declaration. This is called once for each namespace declaration on
|
|
|
|
the element in the reverse of the order for which the
|
|
|
|
:attr:`StartNamespaceDeclHandler` was called to indicate the start of each
|
|
|
|
namespace declaration's scope. Calls to this handler are made after the
|
|
|
|
corresponding :attr:`EndElementHandler` for the end of the element.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.CommentHandler(data)
|
|
|
|
|
|
|
|
Called for comments. *data* is the text of the comment, excluding the leading
|
2012-09-20 03:47:03 -03:00
|
|
|
``'<!-``\ ``-'`` and trailing ``'-``\ ``->'``.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.StartCdataSectionHandler()
|
|
|
|
|
|
|
|
Called at the start of a CDATA section. This and :attr:`EndCdataSectionHandler`
|
|
|
|
are needed to be able to identify the syntactical start and end for CDATA
|
|
|
|
sections.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.EndCdataSectionHandler()
|
|
|
|
|
|
|
|
Called at the end of a CDATA section.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.DefaultHandler(data)
|
|
|
|
|
|
|
|
Called for any characters in the XML document for which no applicable handler
|
|
|
|
has been specified. This means characters that are part of a construct which
|
|
|
|
could be reported, but for which no handler has been supplied.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.DefaultHandlerExpand(data)
|
|
|
|
|
|
|
|
This is the same as the :func:`DefaultHandler`, but doesn't inhibit expansion
|
|
|
|
of internal entities. The entity reference will not be passed to the default
|
|
|
|
handler.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.NotStandaloneHandler()
|
|
|
|
|
|
|
|
Called if the XML document hasn't been declared as being a standalone document.
|
|
|
|
This happens when there is an external subset or a reference to a parameter
|
|
|
|
entity, but the XML declaration does not set standalone to ``yes`` in an XML
|
2010-08-03 09:06:29 -03:00
|
|
|
declaration. If this handler returns ``0``, then the parser will raise an
|
2007-08-15 11:28:22 -03:00
|
|
|
:const:`XML_ERROR_NOT_STANDALONE` error. If this handler is not set, no
|
|
|
|
exception is raised by the parser for this condition.
|
|
|
|
|
|
|
|
|
|
|
|
.. method:: xmlparser.ExternalEntityRefHandler(context, base, systemId, publicId)
|
|
|
|
|
|
|
|
Called for references to external entities. *base* is the current base, as set
|
|
|
|
by a previous call to :meth:`SetBase`. The public and system identifiers,
|
|
|
|
*systemId* and *publicId*, are strings if given; if the public identifier is not
|
|
|
|
given, *publicId* will be ``None``. The *context* value is opaque and should
|
|
|
|
only be used as described below.
|
|
|
|
|
|
|
|
For external entities to be parsed, this handler must be implemented. It is
|
|
|
|
responsible for creating the sub-parser using
|
|
|
|
``ExternalEntityParserCreate(context)``, initializing it with the appropriate
|
|
|
|
callbacks, and parsing the entity. This handler should return an integer; if it
|
2010-08-03 09:06:29 -03:00
|
|
|
returns ``0``, the parser will raise an
|
2007-08-15 11:28:22 -03:00
|
|
|
:const:`XML_ERROR_EXTERNAL_ENTITY_HANDLING` error, otherwise parsing will
|
|
|
|
continue.
|
|
|
|
|
|
|
|
If this handler is not provided, external entities are reported by the
|
|
|
|
:attr:`DefaultHandler` callback, if provided.
|
|
|
|
|
|
|
|
|
|
|
|
.. _expaterror-objects:
|
|
|
|
|
|
|
|
ExpatError Exceptions
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
|
|
|
|
|
|
|
|
|
|
|
|
:exc:`ExpatError` exceptions have a number of interesting attributes:
|
|
|
|
|
|
|
|
|
|
|
|
.. attribute:: ExpatError.code
|
|
|
|
|
2010-10-15 11:46:48 -03:00
|
|
|
Expat's internal error number for the specific error. The
|
2013-10-13 17:09:14 -03:00
|
|
|
:data:`errors.messages <xml.parsers.expat.errors.messages>` dictionary maps
|
|
|
|
these error numbers to Expat's error messages. For example::
|
2010-10-15 11:46:48 -03:00
|
|
|
|
|
|
|
from xml.parsers.expat import ParserCreate, ExpatError, errors
|
|
|
|
|
|
|
|
p = ParserCreate()
|
|
|
|
try:
|
|
|
|
p.Parse(some_xml_document)
|
|
|
|
except ExpatError as err:
|
|
|
|
print("Error:", errors.messages[err.code])
|
|
|
|
|
2013-10-13 17:09:14 -03:00
|
|
|
The :mod:`~xml.parsers.expat.errors` module also provides error message
|
|
|
|
constants and a dictionary :data:`~xml.parsers.expat.errors.codes` mapping
|
|
|
|
these messages back to the error codes, see below.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
|
|
|
|
.. attribute:: ExpatError.lineno
|
|
|
|
|
|
|
|
Line number on which the error was detected. The first line is numbered ``1``.
|
|
|
|
|
|
|
|
|
|
|
|
.. attribute:: ExpatError.offset
|
|
|
|
|
|
|
|
Character offset into the line where the error occurred. The first column is
|
|
|
|
numbered ``0``.
|
|
|
|
|
|
|
|
|
|
|
|
.. _expat-example:
|
|
|
|
|
|
|
|
Example
|
|
|
|
-------
|
|
|
|
|
|
|
|
The following program defines three handlers that just print out their
|
|
|
|
arguments. ::
|
|
|
|
|
|
|
|
import xml.parsers.expat
|
|
|
|
|
|
|
|
# 3 handler functions
|
|
|
|
def start_element(name, attrs):
|
2007-09-04 04:15:32 -03:00
|
|
|
print('Start element:', name, attrs)
|
2007-08-15 11:28:22 -03:00
|
|
|
def end_element(name):
|
2007-09-04 04:15:32 -03:00
|
|
|
print('End element:', name)
|
2007-08-15 11:28:22 -03:00
|
|
|
def char_data(data):
|
2007-09-04 04:15:32 -03:00
|
|
|
print('Character data:', repr(data))
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
p = xml.parsers.expat.ParserCreate()
|
|
|
|
|
|
|
|
p.StartElementHandler = start_element
|
|
|
|
p.EndElementHandler = end_element
|
|
|
|
p.CharacterDataHandler = char_data
|
|
|
|
|
|
|
|
p.Parse("""<?xml version="1.0"?>
|
|
|
|
<parent id="top"><child1 name="paul">Text goes here</child1>
|
|
|
|
<child2 name="fred">More text</child2>
|
|
|
|
</parent>""", 1)
|
|
|
|
|
|
|
|
The output from this program is::
|
|
|
|
|
|
|
|
Start element: parent {'id': 'top'}
|
|
|
|
Start element: child1 {'name': 'paul'}
|
|
|
|
Character data: 'Text goes here'
|
|
|
|
End element: child1
|
|
|
|
Character data: '\n'
|
|
|
|
Start element: child2 {'name': 'fred'}
|
|
|
|
Character data: 'More text'
|
|
|
|
End element: child2
|
|
|
|
Character data: '\n'
|
|
|
|
End element: parent
|
|
|
|
|
|
|
|
|
|
|
|
.. _expat-content-models:
|
|
|
|
|
|
|
|
Content Model Descriptions
|
|
|
|
--------------------------
|
|
|
|
|
2010-10-15 11:46:48 -03:00
|
|
|
.. module:: xml.parsers.expat.model
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2010-10-15 11:46:48 -03:00
|
|
|
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
Content modules are described using nested tuples. Each tuple contains four
|
|
|
|
values: the type, the quantifier, the name, and a tuple of children. Children
|
|
|
|
are simply additional content module descriptions.
|
|
|
|
|
2010-10-15 11:46:48 -03:00
|
|
|
The values of the first two fields are constants defined in the
|
|
|
|
:mod:`xml.parsers.expat.model` module. These constants can be collected in two
|
2007-08-15 11:28:22 -03:00
|
|
|
groups: the model type group and the quantifier group.
|
|
|
|
|
|
|
|
The constants in the model type group are:
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_CTYPE_ANY
|
|
|
|
:noindex:
|
|
|
|
|
|
|
|
The element named by the model name was declared to have a content model of
|
|
|
|
``ANY``.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_CTYPE_CHOICE
|
|
|
|
:noindex:
|
|
|
|
|
|
|
|
The named element allows a choice from a number of options; this is used for
|
|
|
|
content models such as ``(A | B | C)``.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_CTYPE_EMPTY
|
|
|
|
:noindex:
|
|
|
|
|
|
|
|
Elements which are declared to be ``EMPTY`` have this model type.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_CTYPE_MIXED
|
|
|
|
:noindex:
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_CTYPE_NAME
|
|
|
|
:noindex:
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_CTYPE_SEQ
|
|
|
|
:noindex:
|
|
|
|
|
|
|
|
Models which represent a series of models which follow one after the other are
|
|
|
|
indicated with this model type. This is used for models such as ``(A, B, C)``.
|
|
|
|
|
|
|
|
The constants in the quantifier group are:
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_CQUANT_NONE
|
|
|
|
:noindex:
|
|
|
|
|
|
|
|
No modifier is given, so it can appear exactly once, as for ``A``.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_CQUANT_OPT
|
|
|
|
:noindex:
|
|
|
|
|
|
|
|
The model is optional: it can appear once or not at all, as for ``A?``.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_CQUANT_PLUS
|
|
|
|
:noindex:
|
|
|
|
|
|
|
|
The model must occur one or more times (like ``A+``).
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_CQUANT_REP
|
|
|
|
:noindex:
|
|
|
|
|
|
|
|
The model must occur zero or more times, as for ``A*``.
|
|
|
|
|
|
|
|
|
|
|
|
.. _expat-errors:
|
|
|
|
|
|
|
|
Expat error constants
|
|
|
|
---------------------
|
|
|
|
|
2010-10-15 11:46:48 -03:00
|
|
|
.. module:: xml.parsers.expat.errors
|
|
|
|
|
|
|
|
The following constants are provided in the :mod:`xml.parsers.expat.errors`
|
|
|
|
module. These constants are useful in interpreting some of the attributes of
|
|
|
|
the :exc:`ExpatError` exception objects raised when an error has occurred.
|
|
|
|
Since for backwards compatibility reasons, the constants' value is the error
|
|
|
|
*message* and not the numeric error *code*, you do this by comparing its
|
|
|
|
:attr:`code` attribute with
|
|
|
|
:samp:`errors.codes[errors.XML_ERROR_{CONSTANT_NAME}]`.
|
|
|
|
|
|
|
|
The ``errors`` module has the following attributes:
|
|
|
|
|
|
|
|
.. data:: codes
|
|
|
|
|
|
|
|
A dictionary mapping numeric error codes to their string descriptions.
|
|
|
|
|
|
|
|
.. versionadded:: 3.2
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: messages
|
|
|
|
|
|
|
|
A dictionary mapping string descriptions to their error codes.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2010-10-15 11:46:48 -03:00
|
|
|
.. versionadded:: 3.2
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_ASYNC_ENTITY
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF
|
|
|
|
|
|
|
|
An entity reference in an attribute value referred to an external entity instead
|
|
|
|
of an internal entity.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_BAD_CHAR_REF
|
|
|
|
|
|
|
|
A character reference referred to a character which is illegal in XML (for
|
|
|
|
example, character ``0``, or '``�``').
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_BINARY_ENTITY_REF
|
|
|
|
|
|
|
|
An entity reference referred to an entity which was declared with a notation, so
|
|
|
|
cannot be parsed.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_DUPLICATE_ATTRIBUTE
|
|
|
|
|
|
|
|
An attribute was used more than once in a start tag.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_INCORRECT_ENCODING
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_INVALID_TOKEN
|
|
|
|
|
|
|
|
Raised when an input byte could not properly be assigned to a character; for
|
|
|
|
example, a NUL byte (value ``0``) in a UTF-8 input stream.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_JUNK_AFTER_DOC_ELEMENT
|
|
|
|
|
|
|
|
Something other than whitespace occurred after the document element.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_MISPLACED_XML_PI
|
|
|
|
|
|
|
|
An XML declaration was found somewhere other than the start of the input data.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_NO_ELEMENTS
|
|
|
|
|
|
|
|
The document contains no elements (XML requires all documents to contain exactly
|
|
|
|
one top-level element)..
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_NO_MEMORY
|
|
|
|
|
|
|
|
Expat was not able to allocate memory internally.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_PARAM_ENTITY_REF
|
|
|
|
|
|
|
|
A parameter entity reference was found where it was not allowed.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_PARTIAL_CHAR
|
|
|
|
|
|
|
|
An incomplete character was found in the input.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_RECURSIVE_ENTITY_REF
|
|
|
|
|
|
|
|
An entity reference contained another reference to the same entity; possibly via
|
|
|
|
a different name, and possibly indirectly.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_SYNTAX
|
|
|
|
|
|
|
|
Some unspecified syntax error was encountered.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_TAG_MISMATCH
|
|
|
|
|
|
|
|
An end tag did not match the innermost open start tag.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_UNCLOSED_TOKEN
|
|
|
|
|
|
|
|
Some token (such as a start tag) was not closed before the end of the stream or
|
|
|
|
the next token was encountered.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_UNDEFINED_ENTITY
|
|
|
|
|
|
|
|
A reference was made to a entity which was not defined.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_UNKNOWN_ENCODING
|
|
|
|
|
|
|
|
The document encoding is not supported by Expat.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_UNCLOSED_CDATA_SECTION
|
|
|
|
|
|
|
|
A CDATA marked section was not closed.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_EXTERNAL_ENTITY_HANDLING
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_NOT_STANDALONE
|
|
|
|
|
|
|
|
The parser determined that the document was not "standalone" though it declared
|
|
|
|
itself to be in the XML declaration, and the :attr:`NotStandaloneHandler` was
|
|
|
|
set and returned ``0``.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_UNEXPECTED_STATE
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_ENTITY_DECLARED_IN_PE
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_FEATURE_REQUIRES_XML_DTD
|
|
|
|
|
|
|
|
An operation was requested that requires DTD support to be compiled in, but
|
|
|
|
Expat was configured without DTD support. This should never be reported by a
|
|
|
|
standard build of the :mod:`xml.parsers.expat` module.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING
|
|
|
|
|
|
|
|
A behavioral change was requested after parsing started that can only be changed
|
|
|
|
before parsing has started. This is (currently) only raised by
|
|
|
|
:meth:`UseForeignDTD`.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_UNBOUND_PREFIX
|
|
|
|
|
|
|
|
An undeclared prefix was found when namespace processing was enabled.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_UNDECLARING_PREFIX
|
|
|
|
|
|
|
|
The document attempted to remove the namespace declaration associated with a
|
|
|
|
prefix.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_INCOMPLETE_PE
|
|
|
|
|
|
|
|
A parameter entity contained incomplete markup.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_XML_DECL
|
|
|
|
|
|
|
|
The document contained no document element at all.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_TEXT_DECL
|
|
|
|
|
|
|
|
There was an error parsing a text declaration in an external entity.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_PUBLICID
|
|
|
|
|
|
|
|
Characters were found in the public id that are not allowed.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_SUSPENDED
|
|
|
|
|
|
|
|
The requested operation was made on a suspended parser, but isn't allowed. This
|
|
|
|
includes attempts to provide additional input or to stop the parser.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_NOT_SUSPENDED
|
|
|
|
|
|
|
|
An attempt to resume the parser was made when the parser had not been suspended.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_ABORTED
|
|
|
|
|
|
|
|
This should not be reported to Python applications.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_FINISHED
|
|
|
|
|
|
|
|
The requested operation was made on a parser which was finished parsing input,
|
|
|
|
but isn't allowed. This includes attempts to provide additional input or to
|
|
|
|
stop the parser.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: XML_ERROR_SUSPEND_PE
|
|
|
|
|
Merged revisions 61431,61433-61436,61439,61444,61449-61450,61453,61458,61465,61468,61471-61474,61480,61483-61484,61488,61495-61496,61498,61503-61504,61507,61509-61510,61515-61518 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r61431 | vinay.sajip | 2008-03-16 22:35:58 +0100 (So, 16 Mär 2008) | 1 line
Clarified documentation on use of shutdown().
........
r61433 | mark.summerfield | 2008-03-17 09:28:15 +0100 (Mo, 17 Mär 2008) | 5 lines
Added a footnote to each pointing out that for XML output if an encoding
string is given it should conform to the appropriate XML standards---for
example, "UTF-8" is okay, but "UTF8" is not.
........
r61434 | eric.smith | 2008-03-17 12:01:01 +0100 (Mo, 17 Mär 2008) | 7 lines
Issue 2264: empty float presentation type needs to have at least one digit past the decimal point.
Added "Z" format_char to PyOS_ascii_formatd to support empty float presentation type.
Renamed buf_size in PyOS_ascii_formatd to more accurately reflect it's meaning.
Modified format.__float__ to use the new "Z" format as the default.
Added test cases.
........
r61435 | eric.smith | 2008-03-17 13:14:29 +0100 (Mo, 17 Mär 2008) | 2 lines
Reformated lines > 79 chars.
Deleted unused macro ISXDIGIT.
........
r61436 | jeffrey.yasskin | 2008-03-17 15:40:53 +0100 (Mo, 17 Mär 2008) | 13 lines
Allow Gnu gcc's to build python on OSX by removing -Wno-long-double,
-no-cpp-precomp, and -mno-fused-madd from configure.
* r22183 added -no-cpp-precomp, which
http://gcc.gnu.org/ml/gcc/2005-12/msg00368.html claims hasn't been
needed since gcc-3.1.
* r25607 added -Wno-long-double to avoid a warning in
Include/objimpl.h (issue 525481). The long double is still there,
but OSX 10.4's gcc no longer warns about it.
* r33666 fixed issue 775892 on OSX 10.3 by adding -mno-fused-madd,
which changed the sign of some float 0s. Tim Peters said it wasn't
a real issue anyway, and it no longer causes test failures.
Fixes issue #1779871.
........
r61439 | martin.v.loewis | 2008-03-17 17:31:57 +0100 (Mo, 17 Mär 2008) | 2 lines
Add Trent Nelson.
........
r61444 | travis.oliphant | 2008-03-17 18:36:12 +0100 (Mo, 17 Mär 2008) | 1 line
Add necessary headers to back-port new buffer protocol to Python 2.6
........
r61449 | gregory.p.smith | 2008-03-17 19:48:05 +0100 (Mo, 17 Mär 2008) | 8 lines
Force zlib.crc32 and zlib.adler32 to return a signed integer on all platforms
regardless of the native sizeof(long) used in the integer object.
This somewhat odd behavior of returning a signed is maintained in 2.x for
compatibility reasons of always returning an integer rather than a long object.
Fixes Issue1202 for Python 2.6
........
r61450 | neal.norwitz | 2008-03-17 20:02:45 +0100 (Mo, 17 Mär 2008) | 3 lines
Use a buffer large enough to ensure we don't overrun, even if the value
is outside the range we expect.
........
r61453 | steven.bethard | 2008-03-17 20:33:11 +0100 (Mo, 17 Mär 2008) | 1 line
Document unicode.isnumeric() and unicode.isdecimal() (issue2326)
........
r61458 | neal.norwitz | 2008-03-17 21:22:43 +0100 (Mo, 17 Mär 2008) | 5 lines
Issue 2321: reduce memory usage (increase the memory that is returned
to the system) by using pymalloc for the data of unicode objects.
Will backport.
........
r61465 | martin.v.loewis | 2008-03-17 22:55:30 +0100 (Mo, 17 Mär 2008) | 2 lines
Add David Wolever.
........
r61468 | gregory.p.smith | 2008-03-18 01:20:01 +0100 (Di, 18 Mär 2008) | 3 lines
Fix the IOError message text when opening a file with an invalid filename.
Error reported by Ilan Schnell.
........
r61471 | brett.cannon | 2008-03-18 02:00:07 +0100 (Di, 18 Mär 2008) | 2 lines
Convert test_strftime, test_getargs, and test_pep247 to use unittest.
........
r61472 | jeffrey.yasskin | 2008-03-18 02:09:59 +0100 (Di, 18 Mär 2008) | 2 lines
Fix build on platforms that don't have intptr_t. Patch by Joseph Armbruster.
........
r61473 | brett.cannon | 2008-03-18 02:50:25 +0100 (Di, 18 Mär 2008) | 2 lines
Convert test_dummy_threading and test_dbm to unittest.
........
r61474 | brett.cannon | 2008-03-18 02:58:56 +0100 (Di, 18 Mär 2008) | 2 lines
Move test_extcall to doctest.
........
r61480 | brett.cannon | 2008-03-18 04:46:22 +0100 (Di, 18 Mär 2008) | 2 lines
test_errno was a no-op test; now it actually tests things and uses unittest.
........
r61483 | brett.cannon | 2008-03-18 05:09:00 +0100 (Di, 18 Mär 2008) | 3 lines
Remove our implementation of memmove() and strerror(); both are in the C89
standard library.
........
r61484 | brett.cannon | 2008-03-18 05:16:06 +0100 (Di, 18 Mär 2008) | 2 lines
The output directory for tests that compare against stdout is now gone!
........
r61488 | jeffrey.yasskin | 2008-03-18 05:29:35 +0100 (Di, 18 Mär 2008) | 2 lines
Block the "socket.ssl() is deprecated" warning from test_socket_ssl.
........
r61495 | jeffrey.yasskin | 2008-03-18 05:56:06 +0100 (Di, 18 Mär 2008) | 4 lines
Speed test_thread up from 51.328s to 0.081s by reducing its sleep times. We
still sleep at all to make it likely that all threads are active at the same
time.
........
r61496 | jeffrey.yasskin | 2008-03-18 06:12:41 +0100 (Di, 18 Mär 2008) | 4 lines
Speed up test_dict by about 10x by only checking selected dict literal sizes,
instead of every integer from 0 to 400. Exhaustive testing wastes time without
providing enough more assurance that the code is correct.
........
r61498 | neal.norwitz | 2008-03-18 06:20:29 +0100 (Di, 18 Mär 2008) | 1 line
Try increasing the timeout to reduce the flakiness of this test.
........
r61503 | brett.cannon | 2008-03-18 06:43:04 +0100 (Di, 18 Mär 2008) | 2 lines
Improve the error message for a test that failed on the S-390 Debian buildbot.
........
r61504 | jeffrey.yasskin | 2008-03-18 06:45:40 +0100 (Di, 18 Mär 2008) | 3 lines
Add a -S/--slow flag to regrtest to have it print the 10 slowest tests with
their times.
........
r61507 | neal.norwitz | 2008-03-18 07:03:46 +0100 (Di, 18 Mär 2008) | 1 line
Add some info to the failure messages
........
r61509 | trent.nelson | 2008-03-18 08:02:12 +0100 (Di, 18 Mär 2008) | 1 line
Issue 2286: bump up the stack size of the 64-bit debug python_d.exe to 2100000. The default value of 200000 causes a stack overflow at 1965 iterations of r_object() in marshal.c, 35 iterations before the 2000 limit enforced by MAX_MARSHAL_STACK_DEPTH.
........
r61510 | trent.nelson | 2008-03-18 08:32:47 +0100 (Di, 18 Mär 2008) | 5 lines
The behaviour of winsound.Beep() seems to differ between different versions of Windows when there's either:
a) no sound card entirely
b) legacy beep driver has been disabled
c) the legacy beep driver has been uninstalled
Sometimes RuntimeErrors are raised, sometimes they're not. If _have_soundcard() returns False, don't expect winsound.Beep() to raise a RuntimeError, as this clearly isn't the case, as demonstrated by the various Win32 XP buildbots.
........
r61515 | martin.v.loewis | 2008-03-18 13:20:15 +0100 (Di, 18 Mär 2008) | 2 lines
norwitz-amd64 (gentoo) has EREMOTEIO.
........
r61516 | martin.v.loewis | 2008-03-18 13:45:37 +0100 (Di, 18 Mär 2008) | 2 lines
Add more Linux error codes.
........
r61517 | martin.v.loewis | 2008-03-18 14:05:03 +0100 (Di, 18 Mär 2008) | 2 lines
Add WSA errors.
........
r61518 | martin.v.loewis | 2008-03-18 14:16:05 +0100 (Di, 18 Mär 2008) | 2 lines
Note that the stderr output of the test is intentional.
........
2008-03-18 12:15:01 -03:00
|
|
|
|
|
|
|
.. rubric:: Footnotes
|
|
|
|
|
|
|
|
.. [#] The encoding string included in XML output should conform to the
|
|
|
|
appropriate standards. For example, "UTF-8" is valid, but "UTF8" is
|
|
|
|
not. See http://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl
|
2013-12-23 12:20:51 -04:00
|
|
|
and http://www.iana.org/assignments/character-sets\ .
|
Merged revisions 61431,61433-61436,61439,61444,61449-61450,61453,61458,61465,61468,61471-61474,61480,61483-61484,61488,61495-61496,61498,61503-61504,61507,61509-61510,61515-61518 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r61431 | vinay.sajip | 2008-03-16 22:35:58 +0100 (So, 16 Mär 2008) | 1 line
Clarified documentation on use of shutdown().
........
r61433 | mark.summerfield | 2008-03-17 09:28:15 +0100 (Mo, 17 Mär 2008) | 5 lines
Added a footnote to each pointing out that for XML output if an encoding
string is given it should conform to the appropriate XML standards---for
example, "UTF-8" is okay, but "UTF8" is not.
........
r61434 | eric.smith | 2008-03-17 12:01:01 +0100 (Mo, 17 Mär 2008) | 7 lines
Issue 2264: empty float presentation type needs to have at least one digit past the decimal point.
Added "Z" format_char to PyOS_ascii_formatd to support empty float presentation type.
Renamed buf_size in PyOS_ascii_formatd to more accurately reflect it's meaning.
Modified format.__float__ to use the new "Z" format as the default.
Added test cases.
........
r61435 | eric.smith | 2008-03-17 13:14:29 +0100 (Mo, 17 Mär 2008) | 2 lines
Reformated lines > 79 chars.
Deleted unused macro ISXDIGIT.
........
r61436 | jeffrey.yasskin | 2008-03-17 15:40:53 +0100 (Mo, 17 Mär 2008) | 13 lines
Allow Gnu gcc's to build python on OSX by removing -Wno-long-double,
-no-cpp-precomp, and -mno-fused-madd from configure.
* r22183 added -no-cpp-precomp, which
http://gcc.gnu.org/ml/gcc/2005-12/msg00368.html claims hasn't been
needed since gcc-3.1.
* r25607 added -Wno-long-double to avoid a warning in
Include/objimpl.h (issue 525481). The long double is still there,
but OSX 10.4's gcc no longer warns about it.
* r33666 fixed issue 775892 on OSX 10.3 by adding -mno-fused-madd,
which changed the sign of some float 0s. Tim Peters said it wasn't
a real issue anyway, and it no longer causes test failures.
Fixes issue #1779871.
........
r61439 | martin.v.loewis | 2008-03-17 17:31:57 +0100 (Mo, 17 Mär 2008) | 2 lines
Add Trent Nelson.
........
r61444 | travis.oliphant | 2008-03-17 18:36:12 +0100 (Mo, 17 Mär 2008) | 1 line
Add necessary headers to back-port new buffer protocol to Python 2.6
........
r61449 | gregory.p.smith | 2008-03-17 19:48:05 +0100 (Mo, 17 Mär 2008) | 8 lines
Force zlib.crc32 and zlib.adler32 to return a signed integer on all platforms
regardless of the native sizeof(long) used in the integer object.
This somewhat odd behavior of returning a signed is maintained in 2.x for
compatibility reasons of always returning an integer rather than a long object.
Fixes Issue1202 for Python 2.6
........
r61450 | neal.norwitz | 2008-03-17 20:02:45 +0100 (Mo, 17 Mär 2008) | 3 lines
Use a buffer large enough to ensure we don't overrun, even if the value
is outside the range we expect.
........
r61453 | steven.bethard | 2008-03-17 20:33:11 +0100 (Mo, 17 Mär 2008) | 1 line
Document unicode.isnumeric() and unicode.isdecimal() (issue2326)
........
r61458 | neal.norwitz | 2008-03-17 21:22:43 +0100 (Mo, 17 Mär 2008) | 5 lines
Issue 2321: reduce memory usage (increase the memory that is returned
to the system) by using pymalloc for the data of unicode objects.
Will backport.
........
r61465 | martin.v.loewis | 2008-03-17 22:55:30 +0100 (Mo, 17 Mär 2008) | 2 lines
Add David Wolever.
........
r61468 | gregory.p.smith | 2008-03-18 01:20:01 +0100 (Di, 18 Mär 2008) | 3 lines
Fix the IOError message text when opening a file with an invalid filename.
Error reported by Ilan Schnell.
........
r61471 | brett.cannon | 2008-03-18 02:00:07 +0100 (Di, 18 Mär 2008) | 2 lines
Convert test_strftime, test_getargs, and test_pep247 to use unittest.
........
r61472 | jeffrey.yasskin | 2008-03-18 02:09:59 +0100 (Di, 18 Mär 2008) | 2 lines
Fix build on platforms that don't have intptr_t. Patch by Joseph Armbruster.
........
r61473 | brett.cannon | 2008-03-18 02:50:25 +0100 (Di, 18 Mär 2008) | 2 lines
Convert test_dummy_threading and test_dbm to unittest.
........
r61474 | brett.cannon | 2008-03-18 02:58:56 +0100 (Di, 18 Mär 2008) | 2 lines
Move test_extcall to doctest.
........
r61480 | brett.cannon | 2008-03-18 04:46:22 +0100 (Di, 18 Mär 2008) | 2 lines
test_errno was a no-op test; now it actually tests things and uses unittest.
........
r61483 | brett.cannon | 2008-03-18 05:09:00 +0100 (Di, 18 Mär 2008) | 3 lines
Remove our implementation of memmove() and strerror(); both are in the C89
standard library.
........
r61484 | brett.cannon | 2008-03-18 05:16:06 +0100 (Di, 18 Mär 2008) | 2 lines
The output directory for tests that compare against stdout is now gone!
........
r61488 | jeffrey.yasskin | 2008-03-18 05:29:35 +0100 (Di, 18 Mär 2008) | 2 lines
Block the "socket.ssl() is deprecated" warning from test_socket_ssl.
........
r61495 | jeffrey.yasskin | 2008-03-18 05:56:06 +0100 (Di, 18 Mär 2008) | 4 lines
Speed test_thread up from 51.328s to 0.081s by reducing its sleep times. We
still sleep at all to make it likely that all threads are active at the same
time.
........
r61496 | jeffrey.yasskin | 2008-03-18 06:12:41 +0100 (Di, 18 Mär 2008) | 4 lines
Speed up test_dict by about 10x by only checking selected dict literal sizes,
instead of every integer from 0 to 400. Exhaustive testing wastes time without
providing enough more assurance that the code is correct.
........
r61498 | neal.norwitz | 2008-03-18 06:20:29 +0100 (Di, 18 Mär 2008) | 1 line
Try increasing the timeout to reduce the flakiness of this test.
........
r61503 | brett.cannon | 2008-03-18 06:43:04 +0100 (Di, 18 Mär 2008) | 2 lines
Improve the error message for a test that failed on the S-390 Debian buildbot.
........
r61504 | jeffrey.yasskin | 2008-03-18 06:45:40 +0100 (Di, 18 Mär 2008) | 3 lines
Add a -S/--slow flag to regrtest to have it print the 10 slowest tests with
their times.
........
r61507 | neal.norwitz | 2008-03-18 07:03:46 +0100 (Di, 18 Mär 2008) | 1 line
Add some info to the failure messages
........
r61509 | trent.nelson | 2008-03-18 08:02:12 +0100 (Di, 18 Mär 2008) | 1 line
Issue 2286: bump up the stack size of the 64-bit debug python_d.exe to 2100000. The default value of 200000 causes a stack overflow at 1965 iterations of r_object() in marshal.c, 35 iterations before the 2000 limit enforced by MAX_MARSHAL_STACK_DEPTH.
........
r61510 | trent.nelson | 2008-03-18 08:32:47 +0100 (Di, 18 Mär 2008) | 5 lines
The behaviour of winsound.Beep() seems to differ between different versions of Windows when there's either:
a) no sound card entirely
b) legacy beep driver has been disabled
c) the legacy beep driver has been uninstalled
Sometimes RuntimeErrors are raised, sometimes they're not. If _have_soundcard() returns False, don't expect winsound.Beep() to raise a RuntimeError, as this clearly isn't the case, as demonstrated by the various Win32 XP buildbots.
........
r61515 | martin.v.loewis | 2008-03-18 13:20:15 +0100 (Di, 18 Mär 2008) | 2 lines
norwitz-amd64 (gentoo) has EREMOTEIO.
........
r61516 | martin.v.loewis | 2008-03-18 13:45:37 +0100 (Di, 18 Mär 2008) | 2 lines
Add more Linux error codes.
........
r61517 | martin.v.loewis | 2008-03-18 14:05:03 +0100 (Di, 18 Mär 2008) | 2 lines
Add WSA errors.
........
r61518 | martin.v.loewis | 2008-03-18 14:16:05 +0100 (Di, 18 Mär 2008) | 2 lines
Note that the stderr output of the test is intentional.
........
2008-03-18 12:15:01 -03:00
|
|
|
|