lxml.objectify.ObjectifiedElement

Package lxml :: Module objectify :: Class ObjectifiedElement

[show private | hide private]

Type ObjectifiedElement

object --+        
         |        
  _Element --+    
             |    
   ElementBase --+
                 |
                ObjectifiedElement

Known Subclasses:: ObjectifiedDataElement

Main XML Element class.

Element children are accessed as object attributes. Multiple children with the same name are available through a list index. Example:

>>> root = etree.XML("<root><c1><c2>0</c2><c2>1</c2></c1></root>")
>>> second_c2 = root.c1.c2[1]

Method Summary
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__delitem__(x, y)` x.__delitem__(y) <==> del x[y]
	`__delslice__(x, i, j)` Use of negative indices is not supported.
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__getitem__(x, y)` x.__getitem__(y) <==> x[y]
	`__getslice__(x, i, j)` Use of negative indices is not supported.
	`__iter__(x)` x.__iter__() <==> iter(x)
	`__len__(x)` x.__len__() <==> len(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__setitem__(x, i, y)` x.__setitem__(i, y) <==> x[i]=y
	`__setslice__(x, i, j, y)` Use of negative indices is not supported.
	`__str__(x)` x.__str__() <==> str(x)
	`addattr(...)` Add a child value to the element.
	`countchildren(...)` Return the number of children of this element, regardless of their name.
	`descendantpaths(...)` Returns a list of object path expressions for all descendants.
	`find(...)`
	`findall(...)`
	`findtext(...)`
Inherited from _Element
	`__contains__(x, y)` x.__contains__(y) <==> y in x
	`__copy__(...)`
	`__deepcopy__(...)`
	`__nonzero__(x)` x.__nonzero__() <==> x != 0
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__reversed__(...)`
	`_init(...)` Called after object initialisation.
	`addnext(...)` Adds the element as a following sibling directly after this element.
	`addprevious(...)` Adds the element as a preceding sibling directly before this element.
	`append(...)` Adds a subelement to the end of this element.
	`clear(...)` Resets an element.
	`extend(...)` Extends the current children by the elements in the iterable.
	`get(...)` Gets an element attribute.
	`getchildren(...)` Returns all subelements.
	`getiterator(...)` Iterate over all elements in the subtree in document order (depth first pre-order), starting with this element.
	`getnext(...)` Returns the following sibling of this element or None.
	`getparent(...)` Returns the parent of this element or None for the root element.
	`getprevious(...)` Returns the preceding sibling of this element or None.
	`getroottree(...)` Return an ElementTree for the root node of the document that contains this element.
	`index(...)` Find the position of the child within the parent.
	`insert(...)` Inserts a subelement at the given position in this element
	`items(...)` Gets element attributes, as a sequence.
	`iter(...)` Iterate over all elements in the subtree in document order (depth first pre-order), starting with this element.
	`iterancestors(...)` Iterate over the ancestors of this element (from parent to parent).
	`iterchildren(...)` Iterate over the children of this element.
	`iterdescendants(...)` Iterate over the descendants of this element in document order.
	`itersiblings(...)` Iterate over the following or preceding siblings of this element.
	`keys(...)` Gets a list of attribute names.
	`makeelement(...)` Creates a new element associated with the same document.
	`remove(...)` Removes a matching subelement.
	`replace(...)` Replaces a subelement with the element passed as second argument.
	`set(...)` Sets an element attribute.
	`values(...)` Gets element attribute values as a sequence of strings.
	`xpath(...)` Evaluate an xpath expression using the element as context node.
Inherited from object
	`__init__(...)` x.__init__(...) initializes x; see x.__class__.__doc__ for signature
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle

Class Variable Summary
`getset_descriptor`	`text` = `<attribute 'text' of 'lxml.objectify.ObjectifiedE...`
Inherited from _Element
`getset_descriptor`	`attrib` = `<attribute 'attrib' of 'lxml.etree._Element' ob...`
`getset_descriptor`	`nsmap` = `<attribute 'nsmap' of 'lxml.etree._Element' obje...`
`getset_descriptor`	`prefix` = `<attribute 'prefix' of 'lxml.etree._Element' ob...`
`getset_descriptor`	`sourceline` = `<attribute 'sourceline' of 'lxml.etree._Ele...`
`getset_descriptor`	`tag` = `<attribute 'tag' of 'lxml.etree._Element' objects>`
`getset_descriptor`	`tail` = `<attribute 'tail' of 'lxml.etree._Element' object...`

Method Details

delattr(...)

x.__delattr__('name') <==> del x.name

Overrides:: __builtin__.object.__delattr__

delitem(x, y)
(Index deletion operator)

x.__delitem__(y) <==> del x[y]

Returns:

del x[y]

Overrides:: lxml.etree._Element.__delitem__

delslice(x, i, j)
(Slice deletion operator)

Use of negative indices is not supported.

Returns:

del x[i:j]

Overrides:: lxml.etree._Element.__delslice__

getattribute(...)

x.__getattribute__('name') <==> x.name

Overrides:: __builtin__.object.__getattribute__

getitem(x, y)
(Indexing operator)

x.__getitem__(y) <==> x[y]

Returns:

x[y]

Overrides:: lxml.etree._Element.__getitem__

getslice(x, i, j)
(Slicling operator)

Use of negative indices is not supported.

Returns:

x[i:j]

Overrides:: lxml.etree._Element.__getslice__

iter(x)

x.__iter__() <==> iter(x)

Returns:

iter(x)

Overrides:: lxml.etree._Element.__iter__

len(x)
(Length operator)

x.__len__() <==> len(x)

Returns:

len(x)

Overrides:: lxml.etree._Element.__len__

new(T, S, ...)

T.__new__(S, ...) -> a new object with type S, a subtype of T

Returns:

a new object with type S, a subtype of T

Overrides:: lxml.etree.ElementBase.__new__

setattr(...)

x.__setattr__('name', value) <==> x.name = value

Overrides:: __builtin__.object.__setattr__

setitem(x, i, y)
(Index assignment operator)

x.__setitem__(i, y) <==> x[i]=y

Returns:

x[i]=y

Overrides:: lxml.etree._Element.__setitem__

setslice(x, i, j, y)
(Slice assignment operator)

Use of negative indices is not supported.

Returns:

x[i:j]=y

Overrides:: lxml.etree._Element.__setslice__

str(x)
(Informal representation operator)

x.__str__() <==> str(x)

Returns:

str(x)

Overrides:: __builtin__.object.__str__

addattr(...)

Add a child value to the element.

As opposed to append(), it sets a data value, not an element.

countchildren(...)

Return the number of children of this element, regardless of their name.

descendantpaths(...)

Returns a list of object path expressions for all descendants.

Class Variable Details

text

Type:: getset_descriptor
Value:: <attribute 'text' of 'lxml.objectify.ObjectifiedElement' objects>

Generated by Epydoc 2.1 on Sat Aug 18 12:44:27 2007

http://epydoc.sf.net

Type ObjectifiedElement

__delattr__(...)

__delitem__(x, y) (Index deletion operator)

__delslice__(x, i, j) (Slice deletion operator)

__getattribute__(...)

__getitem__(x, y) (Indexing operator)

__getslice__(x, i, j) (Slicling operator)

__iter__(x)

__len__(x) (Length operator)

__new__(T, S, ...)

__setattr__(...)

__setitem__(x, i, y) (Index assignment operator)

__setslice__(x, i, j, y) (Slice assignment operator)

__str__(x) (Informal representation operator)

addattr(...)

countchildren(...)

descendantpaths(...)

text

delattr(...)

delitem(x, y)
(Index deletion operator)

delslice(x, i, j)
(Slice deletion operator)

getattribute(...)

getitem(x, y)
(Indexing operator)

getslice(x, i, j)
(Slicling operator)

iter(x)

len(x)
(Length operator)

new(T, S, ...)

setattr(...)

setitem(x, i, y)
(Index assignment operator)

setslice(x, i, j, y)
(Slice assignment operator)

str(x)
(Informal representation operator)