Public Member Functions | Public Attributes | Private Attributes | List of all members
ros_introspection.package_xml.PackageXML Class Reference

Public Member Functions

def __init__ (self, fn)
 
def add_packages (self, build_depends, run_depends, test_depends=None, prefer_depend_tag=True)
 
def add_plugin_export (self, pkg_name, xml_path)
 
def format (self)
 
def get_child_indexes (self)
 
def get_elements_by_tags (self, tags)
 
def get_export_tag (self)
 
def get_insertion_index (self, tag, tag_value=None)
 
def get_license (self)
 
def get_license_element (self)
 
def get_packages (self, mode='build')
 
def get_packages_by_tag (self, tag)
 
def get_people (self)
 
def get_plugin_xmls (self)
 
def get_tab_element (self, tabs=1)
 
def insert_new_packages (self, tag, values)
 
def insert_new_tag (self, tag)
 
def insert_new_tag_inside_another (self, parent, tag, depth=2)
 
def insert_new_tags (self, tags)
 
def is_metapackage (self)
 
def name (self)
 
def remove_dependencies (self, name, pkgs, quiet=False)
 
def remove_element (self, element)
 
def set_license (self, license_str)
 
def std_tab (self)
 
def update_people (self, target_name, target_email=None, search_name=None, search_email=None)
 
def upgrade (self, new_format=2, quiet=True)
 
def write (self, new_fn=None)
 

Public Attributes

 changed
 
 fn
 
 format
 
 header
 
 root
 
 tree
 

Private Attributes

 _format
 
 _name
 
 _std_tab
 

Detailed Description

Definition at line 62 of file package_xml.py.

Constructor & Destructor Documentation

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

Definition at line 63 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 270 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.add_plugin_export (   self,
  pkg_name,
  xml_path 
)
Add the plugin configuration if not found. Add export tag as needed. Return the surrounding export tag.

Definition at line 392 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.format (   self)

Definition at line 86 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_child_indexes (   self)
Return a dictionary based on which children span which indexes.

The keys are the types of nodes in the xml (build_depend, maintainer, etc).
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 136 of file package_xml.py.

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

Definition at line 320 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_export_tag (   self)
Get the export tag. Create it if it doesn't exist.

Definition at line 382 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_insertion_index (   self,
  tag,
  tag_value = None 
)
Return 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 168 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_license (   self)

Definition at line 351 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_license_element (   self)

Definition at line 345 of file package_xml.py.

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

Definition at line 116 of file package_xml.py.

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

Definition at line 110 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_people (   self)

Definition at line 326 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.get_plugin_xmls (   self)
Return a mapping from the package name to a list of the relative path(s) for the plugin xml(s).

Definition at line 369 of file package_xml.py.

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

Definition at line 133 of file package_xml.py.

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

Definition at line 263 of file package_xml.py.

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

Definition at line 225 of file package_xml.py.

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

Definition at line 252 of file package_xml.py.

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

Definition at line 248 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.is_metapackage (   self)

Definition at line 361 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.name (   self)

Definition at line 75 of file package_xml.py.

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

Definition at line 312 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 301 of file package_xml.py.

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

Definition at line 355 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.std_tab (   self)

Definition at line 96 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 
)

Definition at line 334 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.upgrade (   self,
  new_format = 2,
  quiet = True 
)

Definition at line 409 of file package_xml.py.

def ros_introspection.package_xml.PackageXML.write (   self,
  new_fn = None 
)

Definition at line 435 of file package_xml.py.

Member Data Documentation

ros_introspection.package_xml.PackageXML._format
private

Definition at line 70 of file package_xml.py.

ros_introspection.package_xml.PackageXML._name
private

Definition at line 69 of file package_xml.py.

ros_introspection.package_xml.PackageXML._std_tab
private

Definition at line 71 of file package_xml.py.

ros_introspection.package_xml.PackageXML.changed

Definition at line 72 of file package_xml.py.

ros_introspection.package_xml.PackageXML.fn

Definition at line 64 of file package_xml.py.

ros_introspection.package_xml.PackageXML.format

Definition at line 120 of file package_xml.py.

ros_introspection.package_xml.PackageXML.header

Definition at line 68 of file package_xml.py.

ros_introspection.package_xml.PackageXML.root

Definition at line 66 of file package_xml.py.

ros_introspection.package_xml.PackageXML.tree

Definition at line 65 of file package_xml.py.


The documentation for this class was generated from the following file:


ros_introspection
Author(s):
autogenerated on Wed Mar 3 2021 03:56:00