Module rosdistro

Library for process rosdistro files.

New in ROS C-Turtle

Classes
	DistroException
	DistroStack Stores information about a stack release
	Variant A variant defines a specific set of stacks ("metapackage", in Debian parlance).
	Distro Store information in a rosdistro file.
	BZRConfig Configuration information about an BZR repository for a component of code.
	HgConfig Configuration information about an SVN repository for a component of code.
	GitConfig Configuration information about an SVN repository for a component of code.
	SvnConfig Configuration information about an SVN repository for a component of code.

Functions

distro_uri(distro_name)
Returns: the SVN/HTTP URL of the specified distro.

source code

distro_version(version_val)
Parse distro version value, converting SVN revision to version value if necessary

source code

expand_rule(rule, stack_name, stack_ver, release_name, revision=None)

source code

load_vcs_config(rules, rule_eval)

source code

get_variants(distro, stack_name)
Retrieve names of variants that stack is present in.

source code

get_rules(distro, stack_name)
Retrieve rules from distro for specified stack This operates on the raw distro dictionary document.

source code

{str : DistroStack}

load_distro_stacks(distro_doc, stack_names, release_name=None, version=None)
Returns: dictionary of stack names to DistroStack instances

source code

stack_to_rosinstall(stack, branch, anonymous=True)
Generate the rosinstall dictionary entry for a stack in the rosdistro.

source code

variant_to_rosinstall(variant_name, distro, branch, anonymous=True)

source code

extended_variant_to_rosinstall(variant_name, distro, branch, anonymous=True)

source code

distro_to_rosinstall(distro, branch, anonymous=True)

source code

Variables
	__package__ = `None`

Function Details

distro_uri(distro_name)

source code

Parameters:

distro_name - name of distro, e.g. 'diamondback'

Returns:

the SVN/HTTP URL of the specified distro. This function should only be used with the main distros.

get_variants(distro, stack_name)

source code

Retrieve names of variants that stack is present in. This operates on the raw distro dictionary document.

Parameters:

distro (dict) - rosdistro document

get_rules(distro, stack_name)

source code

Retrieve rules from distro for specified stack This operates on the raw distro dictionary document.

Parameters:

distro (dict) - rosdistro document
stack_name (str) - name of stack to get rules for

load_distro_stacks(distro_doc, stack_names, release_name=None, version=None)

source code

Parameters:

distro_doc (dict) - dictionary form of rosdistro file
stack_names ([str]) - names of stacks to load
release_name (str) - (optional) name of distro release to override distro_doc spec.
version (str) - (optional) distro version to override distro_doc spec.

Returns: {str : DistroStack}

dictionary of stack names to DistroStack instances

Raises:

DistroException - if distro_doc format is invalid

stack_to_rosinstall(stack, branch, anonymous=True)

source code

Generate the rosinstall dictionary entry for a stack in the rosdistro.

Parameters:

stack (DistroStack) - A DistroStack for a particular stack
branch (str) - Select the branch or tag from 'devel', 'release' or 'distro' of the stack to checkout
anonymous (bool) - If True, use anonymous-access URLs if available (optional, default True).