Package roslib :: Module manifestlib

Module manifestlib

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

Classes
	ManifestException
	Export Manifest 'export' tag
	Platform Manifest 'platform' tag
	Depend Manifest 'depend' tag
	StackDepend Stack Manifest 'depend' tag
	ROSDep Manifest 'rosdep' tag
	VersionControl Manifest 'versioncontrol' tag

Functions

get_nodes_by_name(n, name)

source code

check_optional(name, allowXHTML=False, merge_multiple=False)
Validator for optional elements.

source code

check_required(name, allowXHTML=False, merge_multiple=False)
Validator for required elements.

source code

check_platform(name)
Validator for manifest platform.

source code

check_depends(name)
Validator for manifest depends.

source code

check_stack_depends(name)
Validator for stack depends.

source code

check_rosdeps(name)
Validator for stack rosdeps.

source code

check_exports(name)

source code

check_versioncontrol(name)

source code

check(name, merge_multiple=False)

source code

_Manifest

parse_file(m, file)
Parse manifest file (package, stack)

source code

_Manifest

parse(m, string, filename='string')
Parse manifest.xml string contents source code

Variables
	REQUIRED = `['author', 'license']`
	ALLOWXHTML = `['description']`
	OPTIONAL = `['logo', 'url', 'brief', 'description', 'status', '...`
	VALID = `['author', 'license', 'logo', 'url', 'brief', 'descrip...`
	__package__ = `'roslib'`

Function Details

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

source code

Validator for optional elements.

Raises:

ManifestException - if validation fails

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

source code

Validator for required elements.

Raises:

ManifestException - if validation fails

check_platform(name)

source code

Validator for manifest platform.

Raises:

ManifestException - if validation fails

check_depends(name)

source code

Validator for manifest depends.

Raises:

ManifestException - if validation fails

check_stack_depends(name)

source code

Validator for stack depends.

Raises:

ManifestException - if validation fails

check_rosdeps(name)

source code

Validator for stack rosdeps.

Raises:

ManifestException - if validation fails

parse_file(m, file)

source code

Parse manifest file (package, stack)

Parameters:

m (_Manifest) - field to populate
file (str) - manifest.xml file path

Returns: _Manifest

return m, populated with parsed fields

parse(m, string, filename=`'string'`)

source code

Parse manifest.xml string contents

Parameters:

string (str) - manifest.xml contents
m (_Manifest) - field to populate

Returns: _Manifest

return m, populated with parsed fields

Variables Details

OPTIONAL

Value:

['logo',
 'url',
 'brief',
 'description',
 'status',
 'notes',
 'depend',
 'rosdep',
...

VALID

Value:

['author',
 'license',
 'logo',
 'url',
 'brief',
 'description',
 'status',
 'notes',
...

Module manifestlib

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

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

check_platform(name)

check_depends(name)

check_stack_depends(name)

check_rosdeps(name)

parse_file(m, file)

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

OPTIONAL

VALID

parse(m, string, filename=`'string'`)