Public Member Functions
def	__init__
def	add_packages
def	add_plugin_export
def	format
def	get_child_indexes
def	get_elements_by_tags
def	get_insertion_index
def	get_license
def	get_license_element
def	get_packages
def	get_packages_by_tag
def	get_people
def	get_plugin_xmls
def	get_tab_element
def	insert_new_packages
def	insert_new_tag
def	insert_new_tag_inside_another
def	insert_new_tags
def	is_metapackage
def	name
def	remove_dependencies
def	remove_element
def	set_license
def	std_tab
def	update_people
def	write
Public Attributes
	changed
	fn
	format
	header
	root
	tree
Private Attributes
	_format
	_name
	_std_tab

Detailed Description

Definition at line 42 of file package_xml.py.

Constructor & Destructor Documentation

def ros_introspection.package_xml.PackageXML.__init__	(	self,
		fn
	)

Definition at line 43 of file package_xml.py.

Member Function Documentation

def ros_introspection.package_xml.PackageXML.add_packages	(	self,
		build_depends,
		run_depends,
		test_depends = `None`,
		prefer_depend_tag = `True`
	)

Definition at line 227 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.add_plugin_export	(	self,
		pkg_name,
		xml_path
	)

Adds the plugin configuration if not found. Adds export tag as needed.
    Returns the export tag it was added to.

Definition at line 339 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.format ( self )

Definition at line 66 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_child_indexes ( self )

   Return a dictionary where the keys are the types of nodes in the xml (build_depend, maintainer, etc)
   and the values are arrays marking the range of elements in the xml root that match that tag.

   For example, tags[build_depend] = [(5, 9), (11, 50)] means that elements [5, 9) and [11, 50) are
   either build_depend elements (or the strings between them)

Definition at line 116 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_elements_by_tags	(	self,
		tags
	)

Definition at line 277 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_insertion_index	(	self,
		tag,
		tag_value = `None`
	)

Returns the index where to insert a new element with the given tag type.
    If there are already elements of that type, then either insert after the last matching element,
    or if the list is alphabetized, insert it in the correct place alphabetically using the tag_value.
    Otherwise, look at the existing elements, and find ones that are supposed to come the closest
    before the given tag, and insert after them. If none found, add at the end.

Definition at line 147 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_license ( self )

Definition at line 308 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_license_element ( self )

Definition at line 302 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_packages	(	self,
		mode = `'build'`
	)

Definition at line 96 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_packages_by_tag	(	self,
		tag
	)

Definition at line 90 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_people ( self )

Definition at line 283 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_plugin_xmls ( self )

Returns a mapping from the package name to a list of the relative path(s) for the plugin xml(s)

Definition at line 326 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_tab_element	(	self,
		tabs = `1`
	)

Definition at line 113 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.insert_new_packages	(	self,
		tag,
		values
	)

Definition at line 220 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.insert_new_tag	(	self,
		tag
	)

Definition at line 193 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.insert_new_tag_inside_another	(	self,
		parent,
		tag,
		depth = `2`
	)

Definition at line 209 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.insert_new_tags	(	self,
		tags
	)

Definition at line 205 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.is_metapackage ( self )

Definition at line 318 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.name ( self )

Definition at line 55 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.remove_dependencies	(	self,
		name,
		pkgs,
		quiet = `False`
	)

Definition at line 269 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.remove_element	(	self,
		element
	)

Remove the given element AND the text element before it if it is just an indentation

Definition at line 258 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.set_license	(	self,
		license
	)

Definition at line 312 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.std_tab ( self )

Definition at line 76 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.update_people	(	self,
		target_name,
		target_email = `None`,
		search_name = `None`,
		search_email = `None`
	)