Namespaces
namespace	cli
namespace	color
namespace	xmlutils
Classes
class	Macro
class	MacroNameSpace
class	NameSpace
class	PropertyNameSpace
class	QuickLexer
class	Table
class	XacroException
Functions
def	abs_filename_spec
def	check_deprecated_tag
def	deprecated_tag
def	eval_extension
def	get_include_files
def	import_xml_namespaces
def	is_include
def	is_valid_name
def	load_yaml
def	process_include
def	process_includes
def	push_file
def	restore_filestack
Variables
	_basestr = basestring
list	all_includes = []
	allow_non_prefixed_tags = True
tuple	backup_path = list(sys.path)
tuple	cur_dir = os.getcwd()
list	filestack = []
dictionary	global_symbols = {'__builtins__': {k: __builtins__[k] for k in ['list', 'dict', 'map', 'str', 'float', 'int']}}
string	include_no_matches_msg = """Include tag's filename spec \"{}\" matched no files."""
dictionary	substitution_args_context = {}
tuple	this_dir = os.path.dirname(__file__)
tuple	this_dir_cwd = os.getcwd()
int	verbosity = 1

Function Documentation

def xacro.abs_filename_spec ( filename_spec )

Prepend the dirname of the currently processed file
if filename_spec is not yet absolute

Definition at line 80 of file src/xacro/__init__.py.

def xacro.check_deprecated_tag ( tag_name )

Check whether tagName starts with xacro prefix. If not, issue a warning.
:param tag_name:
:return: True if tagName is accepted as xacro tag
         False if tagName doesn't start with xacro prefix, but the prefix is required

Definition at line 155 of file src/xacro/__init__.py.

def xacro.deprecated_tag ( _issued = [False] )

Definition at line 138 of file src/xacro/__init__.py.

def xacro.eval_extension ( s )

Definition at line 178 of file src/xacro/__init__.py.

def xacro.get_include_files	(	filename_spec,
		symbols
	)

Definition at line 363 of file src/xacro/__init__.py.

def xacro.import_xml_namespaces	(	parent,
		attributes
	)

import all namespace declarations into parent

Definition at line 387 of file src/xacro/__init__.py.

def xacro.is_include ( elt )

Definition at line 341 of file src/xacro/__init__.py.

def xacro.is_valid_name ( name )

Checks whether name is a valid property or macro identifier.
With python-based evaluation, we need to avoid name clashes with python keywords.

Definition at line 445 of file src/xacro/__init__.py.

def xacro.load_yaml ( filename )

Definition at line 92 of file src/xacro/__init__.py.

def xacro.process_include	(	elt,
		macros,
		symbols,
		func
	)

Definition at line 401 of file src/xacro/__init__.py.

def xacro.process_includes	(	elt,
		macros = `None`,
		symbols = `None`
	)

Definition at line 433 of file src/xacro/__init__.py.

def xacro.push_file ( filename )

Push a new filename to the filestack.
Instead of directly modifying filestack, a deep-copy is created and modified,
while the old filestack is returned.
This allows to store the filestack that was active when a macro or property is defined

Definition at line 62 of file src/xacro/__init__.py.

def xacro.restore_filestack ( oldstack )

Definition at line 75 of file src/xacro/__init__.py.