lxml.objectify.StringElement

Package lxml :: Module objectify :: Class StringElement

[show private | hide private]

Type StringElement

object --+                
         |                
  _Element --+            
             |            
   ElementBase --+        
                 |        
ObjectifiedElement --+    
                     |    
ObjectifiedDataElement --+
                         |
                        StringElement

String data class.

Note that this class does *not* support the sequence protocol of strings: len(), iter(), str_attr[0], str_attr[0:1], etc. are *not* supported. Instead, use the .text attribute to get a 'real' string.

Method Summary
	`__add__(x, y)` x.__add__(y) <==> x+y
	`__eq__(x, y)` x.__eq__(y) <==> x==y
	`__ge__(x, y)` x.__ge__(y) <==> x>=y
	`__gt__(x, y)` x.__gt__(y) <==> x>y
	`__le__(x, y)` x.__le__(y) <==> x<=y
	`__lt__(x, y)` x.__lt__(y) <==> x<y
	`__mod__(x, y)` x.__mod__(y) <==> x%y
	`__mul__(x, y)` x.__mul__(y) <==> x*y
	`__ne__(x, y)` x.__ne__(y) <==> x!=y
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__nonzero__(x)` x.__nonzero__() <==> x != 0
	`__radd__(x, y)` x.__radd__(y) <==> y+x
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__rmod__(x, y)` x.__rmod__(y) <==> y%x
	`__rmul__(x, y)` x.__rmul__(y) <==> y*x
	`strlen(...)`
Inherited from ObjectifiedDataElement
	`__str__(x)` x.__str__() <==> str(x)
	`_setText(...)` For use in subclasses only.
Inherited from ObjectifiedElement
	`__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)
	`__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.
	`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__(...)`
	`__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`	`pyval` = `<attribute 'pyval' of 'lxml.objectify.StringElem...`
Inherited from ObjectifiedElement
`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

add(x, y)
(Addition operator)

x.__add__(y) <==> x+y

Returns:

x+y

eq(x, y)
(Equality operator)

x.__eq__(y) <==> x==y

Returns:

x==y

ge(x, y)
(Greater-than-or-equals operator)

x.__ge__(y) <==> x>=y

Returns:

x>=y

gt(x, y)
(Greater-than operator)

x.__gt__(y) <==> x>y

Returns:

x>y

le(x, y)
(Less-than-or-equals operator)

x.__le__(y) <==> x<=y

Returns:

x<=y

lt(x, y)
(Less-than operator)

x.__lt__(y) <==> x<y

Returns:

x<y

mod(x, y)

x.__mod__(y) <==> x%y

Returns:

x%y

mul(x, y)

x.__mul__(y) <==> x*y

Returns:

x*y

ne(x, y)

x.__ne__(y) <==> x!=y

Returns:

x!=y

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.objectify.ObjectifiedDataElement.__new__

nonzero(x)
(Boolean test operator)

x.__nonzero__() <==> x != 0

Returns:

x != 0

Overrides:: lxml.etree._Element.__nonzero__

radd(x, y)
(Right-side addition operator)

x.__radd__(y) <==> y+x

Returns:

y+x

repr(x)
(Representation operator)

x.__repr__() <==> repr(x)

Returns:

repr(x)

Overrides:: lxml.objectify.ObjectifiedDataElement.__repr__

rmod(x, y)

x.__rmod__(y) <==> y%x

Returns:

y%x

rmul(x, y)

x.__rmul__(y) <==> y*x

Returns:

y*x

Class Variable Details

pyval

Type:: getset_descriptor
Value:: <attribute 'pyval' of 'lxml.objectify.StringElement' objects>

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

http://epydoc.sf.net

Type StringElement

__add__(x, y) (Addition operator)

__eq__(x, y) (Equality operator)

__ge__(x, y) (Greater-than-or-equals operator)

__gt__(x, y) (Greater-than operator)

__le__(x, y) (Less-than-or-equals operator)

__lt__(x, y) (Less-than operator)

__mod__(x, y)

__mul__(x, y)

__ne__(x, y)

__new__(T, S, ...)

__nonzero__(x) (Boolean test operator)

__radd__(x, y) (Right-side addition operator)

__repr__(x) (Representation operator)

__rmod__(x, y)

__rmul__(x, y)

pyval

add(x, y)
(Addition operator)

eq(x, y)
(Equality operator)

ge(x, y)
(Greater-than-or-equals operator)

gt(x, y)
(Greater-than operator)

le(x, y)
(Less-than-or-equals operator)

lt(x, y)
(Less-than operator)

mod(x, y)

mul(x, y)

ne(x, y)

new(T, S, ...)

nonzero(x)
(Boolean test operator)

radd(x, y)
(Right-side addition operator)

repr(x)
(Representation operator)

rmod(x, y)

rmul(x, y)