This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author scoder
Recipients docs@python, scoder
Date 2011-03-02.19:25:07
SpamBayes Score 6.13892e-05
Marked as misclassified No
Message-id <1299093908.17.0.828802315354.issue11379@psf.upfronthosting.co.za>
In-reply-to
Content
http://docs.python.org/library/xml.dom.minidom.html

presents MiniDOM as a "Lightweight DOM implementation". The word "lightweight" is easily misunderstood as meaning "efficient" or "memory friendly". MiniDOM is well known to be neither of the two.

The first paragraph then continues:

"""
xml.dom.minidom is a light-weight implementation of the Document Object Model interface. It is intended to be simpler than the full DOM and also significantly smaller.
"""

Again, "smaller" can be misread as "low memory footprint", whereas it is actually supposed to refer to an incomplete DOM API implementation. And "simpler" is also clearly exaggerated when compared to the alternative ElementTree package.

I would like to see this changed and combined with a clear and visible comment that MiniDOM has very high resource profile, e.g.

"""
19.7. xml.dom.minidom — Pure Python DOM implementation

xml.dom.minidom is a pure Python implementation of the Document Object Model interface, as known from other programming languages. It is intended to provide a smaller API than the full DOM.

Note, however, that MiniDOM has a very large memory footprint compared to other Python XML libraries. If you need a fast and memory friendly XML tree implementation with a vastly simpler API, use the xml.etree package instead.
"""
History
Date User Action Args
2011-03-02 19:25:08scodersetrecipients: + scoder, docs@python
2011-03-02 19:25:08scodersetmessageid: <1299093908.17.0.828802315354.issue11379@psf.upfronthosting.co.za>
2011-03-02 19:25:07scoderlinkissue11379 messages
2011-03-02 19:25:07scodercreate