winros_create_msg_pkg::utils Namespace Reference

Functions
def	author_name
	Author.
def	instantiate_template
def	is_legal_resource_base_name
def	parse_arguments
	Argument Parser.
def	read_template
	Templates.
Variables
tuple	BASE_RESOURCE_NAME_LEGAL_CHARS_P = re.compile('^[A-Za-z][\w_]*$')
	Names.

---

Function Documentation

def winros_create_msg_pkg.utils.author_name

(

)

Author.

Utility to compute logged in user name

:returns: name of current user, ``str``

Definition at line 11 of file utils.py.

def winros_create_msg_pkg.utils.instantiate_template	(		template,
			package,
			description,
			author,
			build_depends,
			run_depends,
			cmake_depends
	)

Definition at line 49 of file utils.py.

def winros_create_msg_pkg.utils.is_legal_resource_base_name

(

name

)

Validates that name is a legal resource base name. A base name has
no package context, e.g. "String".

Definition at line 60 of file utils.py.

def winros_create_msg_pkg.utils.parse_arguments

(

extra_depends = []

)

Argument Parser.

Parse the command line arguments - in format <package-name> [dependencies]".

This will need to upgrade from optparse to argparse post python 2.7 

Definition at line 75 of file utils.py.

def winros_create_msg_pkg.utils.read_template

(

tmplf

)

Templates.

Definition at line 39 of file utils.py.

---

Variable Documentation

tuple winros_create_msg_pkg::utils::BASE_RESOURCE_NAME_LEGAL_CHARS_P = re.compile('^[A-Za-z][\w_]*$')

Names.

Definition at line 59 of file utils.py.