niryo_libraries.roslib.manifestlib

module documentation

Internal library for processing 'manifest' files, i.e. manifest.xml and stack.xml. For external code apis, see L{roslib.manifest} and L{roslib.stack_manifest}.

Class Depend Manifest 'depend' tag
Class Export Manifest 'export' tag
Class ManifestException Undocumented
Class Platform Manifest 'platform' tag
Class ROSDep Manifest 'rosdep' tag
Class StackDepend Stack Manifest 'depend' tag
Class VersionControl Manifest 'versioncontrol' tag
Function check Undocumented
Function check_depends Validator for manifest depends. @raise ManifestException: if validation fails
Function check_exports Undocumented
Function check_optional Validator for optional elements. @raise ManifestException: if validation fails
Function check_platform Validator for manifest platform. @raise ManifestException: if validation fails
Function check_required Validator for required elements. @raise ManifestException: if validation fails
Function check_rosdeps Validator for stack rosdeps. @raise ManifestException: if validation fails
Function check_stack_depends Validator for stack depends. @raise ManifestException: if validation fails
Function check_versioncontrol Undocumented
Function get_nodes_by_name Undocumented
Function parse Parse manifest.xml string contents @param string: manifest.xml contents @type string: str @param m: field to populate @type m: L{_Manifest} @return: return m, populated with parsed fields @rtype: L{_Manifest}...
Function parse_file Parse manifest file (package, stack) @param m: field to populate @type m: L{_Manifest} @param file: manifest.xml file path @type file: str @return: return m, populated with parsed fields @rtype: L{_Manifest}...
Constant ALLOWXHTML Undocumented
Constant OPTIONAL Undocumented
Constant REQUIRED Undocumented
Constant VALID Undocumented
Class _Manifest Object representation of a ROS manifest file
Function _attrs Undocumented
Function _get_text DOM utility routine for getting contents of text nodes
def check(name, merge_multiple=False):

Undocumented

def check_depends(name):

Validator for manifest depends. @raise ManifestException: if validation fails

def check_exports(name):

Undocumented

def check_optional(name, allowXHTML=False, merge_multiple=False):

Validator for optional elements. @raise ManifestException: if validation fails

def check_platform(name):

Validator for manifest platform. @raise ManifestException: if validation fails

def check_required(name, allowXHTML=False, merge_multiple=False):

Validator for required elements. @raise ManifestException: if validation fails

def check_rosdeps(name):

Validator for stack rosdeps. @raise ManifestException: if validation fails

def check_stack_depends(name):

Validator for stack depends. @raise ManifestException: if validation fails

def check_versioncontrol(name):

Undocumented

def get_nodes_by_name(n, name):

Undocumented

def parse(m, string, filename='string'):

Parse manifest.xml string contents @param string: manifest.xml contents @type string: str @param m: field to populate @type m: L{_Manifest} @return: return m, populated with parsed fields @rtype: L{_Manifest}

def parse_file(m, file):

Parse manifest file (package, stack) @param m: field to populate @type m: L{_Manifest} @param file: manifest.xml file path @type file: str @return: return m, populated with parsed fields @rtype: L{_Manifest}

ALLOWXHTML: list[str] =

Undocumented

Value
['description']
OPTIONAL: list[str] =

Undocumented

Value
['logo',
 'url',
 'brief',
 'description',
 'status',
 'notes',
 'depend',
...
REQUIRED: list[str] =

Undocumented

Value
['author', 'license']
VALID =

Undocumented

Value
REQUIRED+OPTIONAL
def _attrs(node):

Undocumented

def _get_text(nodes):

DOM utility routine for getting contents of text nodes