[Lxml-checkins] r51459 - in lxml/trunk: . src/lxml src/lxml/html src/lxml/tests
scoder at codespeak.net
scoder at codespeak.net
Wed Feb 13 21:49:13 CET 2008
Author: scoder
Date: Wed Feb 13 21:49:12 2008
New Revision: 51459
Modified:
lxml/trunk/ (props changed)
lxml/trunk/src/lxml/ElementInclude.py
lxml/trunk/src/lxml/builder.py
lxml/trunk/src/lxml/cssselect.py
lxml/trunk/src/lxml/doctestcompare.py
lxml/trunk/src/lxml/html/__init__.py
lxml/trunk/src/lxml/html/builder.py
lxml/trunk/src/lxml/html/clean.py
lxml/trunk/src/lxml/lxml.etree.pyx
lxml/trunk/src/lxml/lxml.objectify.pyx
lxml/trunk/src/lxml/sax.py
lxml/trunk/src/lxml/tests/__init__.py
Log:
r3470 at delle: sbehnel | 2008-02-13 20:12:19 +0100
loads of docstrings
Modified: lxml/trunk/src/lxml/ElementInclude.py
==============================================================================
--- lxml/trunk/src/lxml/ElementInclude.py (original)
+++ lxml/trunk/src/lxml/ElementInclude.py Wed Feb 13 21:49:12 2008
@@ -41,9 +41,14 @@
# OF THIS SOFTWARE.
# --------------------------------------------------------------------
-##
-# Limited XInclude support for the ElementTree package.
-##
+"""
+Limited XInclude support for the ElementTree package.
+
+While lxml.etree has full support for XInclude (see
+`etree.ElementTree.xinclude()`), this module provides a simpler, pure
+Python, ElementTree compatible implementation that supports a simple
+form of custom URL resolvers.
+"""
import copy, etree
from urlparse import urljoin
Modified: lxml/trunk/src/lxml/builder.py
==============================================================================
--- lxml/trunk/src/lxml/builder.py (original)
+++ lxml/trunk/src/lxml/builder.py Wed Feb 13 21:49:12 2008
@@ -33,6 +33,10 @@
# OF THIS SOFTWARE.
# --------------------------------------------------------------------
+"""
+The ``E`` Element factory for generating XML documents.
+"""
+
import etree as ET
try:
Modified: lxml/trunk/src/lxml/cssselect.py
==============================================================================
--- lxml/trunk/src/lxml/cssselect.py (original)
+++ lxml/trunk/src/lxml/cssselect.py Wed Feb 13 21:49:12 2008
@@ -1,3 +1,9 @@
+"""CSS Selectors based on XPath.
+
+This module supports selecting XML/HTML tags based on CSS selectors.
+See the `CSSSelector` class for details.
+"""
+
import re
from lxml import etree
@@ -11,7 +17,17 @@
pass
class CSSSelector(etree.XPath):
+ """A CSS selector.
+
+ Usage::
+ >>> from lxml import etree, cssselect
+ >>> select = cssselect.CSSSelector("a tag > child")
+
+ >>> root = etree.XML("<a><b><c/><tag><child>TEXT</child></tag></b></a>")
+ >>> [ el.tag for el in select(root) ]
+ ['child']
+ """
def __init__(self, css):
path = css_to_xpath(css)
etree.XPath.__init__(self, path)
@@ -575,9 +591,8 @@
self.condition = other.condition
class XPathExprOr(XPathExpr):
-
"""
- Represents on |'d expressions. Note that unfortunately it isn't
+ Represents |'d expressions. Note that unfortunately it isn't
the union, it's the sum, so duplicate elements will appear.
"""
Modified: lxml/trunk/src/lxml/doctestcompare.py
==============================================================================
--- lxml/trunk/src/lxml/doctestcompare.py (original)
+++ lxml/trunk/src/lxml/doctestcompare.py Wed Feb 13 21:49:12 2008
@@ -1,8 +1,16 @@
"""
lxml-based doctest output comparison.
-To use this you must call ``lxmldoctest.install()``, which will cause
-doctest to use this in all subsequent calls.
+Note: normally, you should just import the `lxml.usedoctest` and
+`lxml.html.usedoctest` modules from within a doctest, instead of this
+one::
+
+ >>> import lxml.usedoctest # for XML output
+
+ >>> import lxml.html.usedoctest # for HTML output
+
+To use this module directly, you must call ``lxmldoctest.install()``,
+which will cause doctest to use this in all subsequent calls.
This changes the way output is checked and comparisons are made for
XML or HTML-like content.
Modified: lxml/trunk/src/lxml/html/__init__.py
==============================================================================
--- lxml/trunk/src/lxml/html/__init__.py (original)
+++ lxml/trunk/src/lxml/html/__init__.py Wed Feb 13 21:49:12 2008
@@ -1,3 +1,6 @@
+"""The ``lxml.html`` tool set for HTML handling.
+"""
+
import threading
import re
import urlparse
Modified: lxml/trunk/src/lxml/html/builder.py
==============================================================================
--- lxml/trunk/src/lxml/html/builder.py (original)
+++ lxml/trunk/src/lxml/html/builder.py Wed Feb 13 21:49:12 2008
@@ -4,7 +4,7 @@
# --------------------------------------------------------------------
"""
-HTML specialisation of ``builder.py`` by Fredrik Lundh
+A set of HTML generator tags for building HTML documents.
Usage::
Modified: lxml/trunk/src/lxml/html/clean.py
==============================================================================
--- lxml/trunk/src/lxml/html/clean.py (original)
+++ lxml/trunk/src/lxml/html/clean.py Wed Feb 13 21:49:12 2008
@@ -1,3 +1,9 @@
+"""A cleanup tool for HTML.
+
+Removes unwanted tags and content. See the `Cleaner` class for
+details.
+"""
+
import re
import copy
import urlparse
Modified: lxml/trunk/src/lxml/lxml.etree.pyx
==============================================================================
--- lxml/trunk/src/lxml/lxml.etree.pyx (original)
+++ lxml/trunk/src/lxml/lxml.etree.pyx Wed Feb 13 21:49:12 2008
@@ -1,5 +1,5 @@
-"""The lxml.etree module implements the extended ElementTree API for
-XML.
+"""The ``lxml.etree`` module implements the extended ElementTree API
+for XML.
"""
__docformat__ = "restructuredtext en"
Modified: lxml/trunk/src/lxml/lxml.objectify.pyx
==============================================================================
--- lxml/trunk/src/lxml/lxml.objectify.pyx (original)
+++ lxml/trunk/src/lxml/lxml.objectify.pyx Wed Feb 13 21:49:12 2008
@@ -1,3 +1,7 @@
+"""The ``lxml.objectify`` module implements a Python object API for
+XML. It is based on `lxml.etree`.
+"""
+
from etreepublic cimport _Document, _Element, ElementBase
from etreepublic cimport _ElementIterator, ElementClassLookup
from etreepublic cimport elementFactory, import_lxml__etree, textOf
Modified: lxml/trunk/src/lxml/sax.py
==============================================================================
--- lxml/trunk/src/lxml/sax.py (original)
+++ lxml/trunk/src/lxml/sax.py Wed Feb 13 21:49:12 2008
@@ -1,3 +1,15 @@
+"""
+SAX-based adapter to copy trees from/to the Python standard library.
+
+Use the `ElementTreeContentHandler` class to build an ElementTree from
+SAX events.
+
+Use the `ElementTreeProducer` class or the `saxify()` function to fire
+the SAX events of an ElementTree against a SAX ContentHandler.
+
+See http://codespeak.net/lxml/sax.html
+"""
+
from xml.sax.handler import ContentHandler
import etree
from etree import ElementTree, SubElement
@@ -220,4 +232,7 @@
return prefix + ':' + local_name
def saxify(element_or_tree, content_handler):
+ """One-shot helper to generate SAX events from an XML tree and fire
+ them against a SAX ContentHandler.
+ """
return ElementTreeProducer(element_or_tree, content_handler).saxify()
Modified: lxml/trunk/src/lxml/tests/__init__.py
==============================================================================
--- lxml/trunk/src/lxml/tests/__init__.py (original)
+++ lxml/trunk/src/lxml/tests/__init__.py Wed Feb 13 21:49:12 2008
@@ -1,2 +1,4 @@
-# this is a package
+"""
+The lxml test suite for lxml, ElementTree and cElementTree.
+"""
More information about the lxml-checkins
mailing list