Refpurpose#

class pyconverter.xml2py.ast_tree.Refpurpose(element, parse_children=True)#

Provides the refpurpose element, which contains a short synopsis of a reference.

Methods

Refpurpose.find(_type[, terms])

Find the first type matching a given type string.

Refpurpose.find_all(_type[, recursive, terms])

Find all types matching a given type string.

Refpurpose.get(entry)

Get an item from an element.

Refpurpose.has_children()

Return wether the element has children.

Refpurpose.print_tree()

Print the tree.

Refpurpose.rec_find(_type[, terms])

Find the first type matching a given type string recursively.

Refpurpose.to_rst([prefix, links, base_url, ...])

Return a string to enable converting the element to an RST format.

Refpurpose.types_repr()

Return the string types.

Attributes

Refpurpose.added

Has the revision flag added.

Refpurpose.any_isalnum

Returns True if any characters are alphanumeric.

Refpurpose.children

Children of the tree.

Refpurpose.content

Text content.

Refpurpose.id

ID of the element.

Refpurpose.next_elem

Next element.

Refpurpose.prev_elem

Previous element.

Refpurpose.raw

Raw string of the element.

Refpurpose.tag

Element tag.

Refpurpose.tail

Tail of the element as a string.

Refpurpose.text_content

Text content.

Refpurpose.title

Element title.

Refpurpose.tostring

Attributes of the element as a dictionary.