Namespaces | |
| cli | |
| color | |
| xmlutils | |
Classes | |
| class | Macro |
| class | MacroNameSpace |
| class | NameSpace |
| class | PropertyNameSpace |
| class | QuickLexer |
| class | Table |
| class | XacroException |
Functions | |
| def | abs_filename_spec (filename_spec) |
| def | check_deprecated_tag (tag_name) |
| def | deprecated_tag (_issued=[False]) |
| def | eval_extension (s) |
| def | get_include_files (filename_spec, symbols) |
| def | grab_macro (elt, macros) |
| def | grab_macros (elt, macros) |
| def | grab_properties (elt, table) |
| def | grab_property (elt, table) |
| def | import_xml_namespaces (parent, attributes) |
| def | is_include (elt) |
| def | is_valid_name (name) |
| def | load_yaml (filename) |
| def | parse_macro_arg (s) |
| def | process_include (elt, macros, symbols, func) |
| def | process_includes (elt, macros=None, symbols=None) |
| def | push_file (filename) |
| def | restore_filestack (oldstack) |
Variables | |
| _basestr = basestring | |
| list | all_includes = [] |
| bool | allow_non_prefixed_tags = True |
| backup_path = list(sys.path) | |
| cur_dir = os.getcwd() | |
| dictionary | encoding = { 'encoding': 'utf-8' } |
| list | filestack = [] |
| dictionary | global_symbols = {'__builtins__': {k: __builtins__[k] for k in ['list', 'dict', 'map', 'str', 'float', 'int', 'True', 'False', 'min', 'max', 'round']}} |
| string | include_no_matches_msg = """Include tag's filename spec \"{}\" matched no files.""" |
| path | |
| re_macro_arg = re.compile(r) | |
| dictionary | substitution_args_context = {} |
| this_dir = os.path.dirname(__file__) | |
| this_dir_cwd = os.getcwd() | |
| unicode = str | |
| int | verbosity = 1 |
| 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 81 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 158 of file src/xacro/__init__.py.
| def xacro.deprecated_tag | ( | _issued = [False] | ) |
Definition at line 141 of file src/xacro/__init__.py.
| def xacro.eval_extension | ( | s | ) |
Definition at line 181 of file src/xacro/__init__.py.
| def xacro.get_include_files | ( | filename_spec, | |
| symbols | |||
| ) |
Definition at line 369 of file src/xacro/__init__.py.
| def xacro.grab_macro | ( | elt, | |
| macros | |||
| ) |
Definition at line 494 of file src/xacro/__init__.py.
| def xacro.grab_macros | ( | elt, | |
| macros | |||
| ) |
Definition at line 527 of file src/xacro/__init__.py.
| def xacro.grab_properties | ( | elt, | |
| table | |||
| ) |
Definition at line 586 of file src/xacro/__init__.py.
| def xacro.grab_property | ( | elt, | |
| table | |||
| ) |
Definition at line 540 of file src/xacro/__init__.py.
| def xacro.import_xml_namespaces | ( | parent, | |
| attributes | |||
| ) |
import all namespace declarations into parent
Definition at line 393 of file src/xacro/__init__.py.
| def xacro.is_include | ( | elt | ) |
Definition at line 347 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 451 of file src/xacro/__init__.py.
| def xacro.load_yaml | ( | filename | ) |
Definition at line 93 of file src/xacro/__init__.py.
| def xacro.parse_macro_arg | ( | s | ) |
parse the first param spec from a macro parameter string s
accepting the following syntax: <param>[:=|=][^|]<default>
:param s: param spec string
:return: param, (forward, default), rest-of-string
forward will be either param or None (depending on whether ^ was specified)
default will be the default string or None
If there is no default spec at all, the middle pair will be replaced by None
Definition at line 472 of file src/xacro/__init__.py.
| def xacro.process_include | ( | elt, | |
| macros, | |||
| symbols, | |||
| func | |||
| ) |
Definition at line 407 of file src/xacro/__init__.py.
| def xacro.process_includes | ( | elt, | |
macros = None, |
|||
symbols = None |
|||
| ) |
Definition at line 439 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 63 of file src/xacro/__init__.py.
| def xacro.restore_filestack | ( | oldstack | ) |
Definition at line 76 of file src/xacro/__init__.py.
|
private |
Definition at line 49 of file src/xacro/__init__.py.
| list xacro.all_includes = [] |
Definition at line 342 of file src/xacro/__init__.py.
| bool xacro.allow_non_prefixed_tags = True |
Definition at line 155 of file src/xacro/__init__.py.
| dictionary xacro.encoding = { 'encoding': 'utf-8' } |
Definition at line 50 of file src/xacro/__init__.py.
| list xacro.filestack = [] |
Definition at line 61 of file src/xacro/__init__.py.
| dictionary xacro.global_symbols = {'__builtins__': {k: __builtins__[k] for k in ['list', 'dict', 'map', 'str', 'float', 'int', 'True', 'False', 'min', 'max', 'round']}} |
Definition at line 115 of file src/xacro/__init__.py.
| string xacro.include_no_matches_msg = """Include tag's filename spec \"{}\" matched no files.""" |
Definition at line 344 of file src/xacro/__init__.py.
| xacro.re_macro_arg = re.compile(r) |
Definition at line 470 of file src/xacro/__init__.py.
| dictionary xacro.substitution_args_context = {} |
Definition at line 57 of file src/xacro/__init__.py.
| xacro.unicode = str |
Definition at line 53 of file src/xacro/__init__.py.
| int xacro.verbosity = 1 |
Definition at line 139 of file src/xacro/__init__.py.