-
 

xacro package from xacro repo

xacro

Package Summary

Tags No category tags.
Version 2.0.11
License BSD
Build type AMENT_CMAKE
Use RECOMMENDED

Repository Summary

Checkout URI https://github.com/ros/xacro.git
VCS Type git
VCS Version ros2
Last Updated 2024-11-13
Dev Status MAINTAINED
CI status No Continuous Integration
Released RELEASED
Tags No category tags.
Contributing Help Wanted (0)
Good First Issues (0)
Pull Requests to Review (0)

Package Description

Xacro (XML Macros) Xacro is an XML macro language. With xacro, you can construct shorter and more readable XML files by using macros that expand to larger XML expressions.

Additional Links

Maintainers

  • Robert Haschke
  • Morgan Quigley

Authors

  • Stuart Glaser
  • William Woodall
  • Robert Haschke

Xacro (XML Macros)

Xacro is an XML macro language

With xacro, you can construct shorter and more readable XML files by using macros that expand to larger XML expressions. Recent documentation can be found in the wiki. For older releases, have a look at the ROS wiki.

CHANGELOG

Changelog for package xacro

2.0.11 (2024-04-02)

  • Allow substitution args without ROS (#340)
  • Add more unit tags for yaml files (#331)
  • Resolve $(find ...) as a result of a substitution argument (#339)
  • Mark regexes as raw strings (#336)
  • Add pyproject.toml for direct installation via pip (#329)
  • Contributors: Adam Heins, Bruno-Pier, Carlo Rizzardo, Lukas Huber, Robert Haschke

2.0.10 (2024-01-25)

  • Expose python.abs()
  • Fix hasattr support of YamlDictWrapper (#324)
  • Contributors: Robert Haschke

2.0.9 (2023-02-27)

  • Evaluate arg value as str/unicode (#322)
  • Contributors: Robert Haschke

2.0.8 (2022-10-22)

  • Install xacro using console_script entrypoint (#304)
  • Provide xacro.process() returning the processed file (#229)
  • Dotted YAML access from list iterator (#318)
  • Optionally allow comment evaluation (#310)

    Comment evaluation can be enabled with a special comment:

    • <!-- xacro:eval-comments --> or
    • <!-- xacro:eval-comments:on -->

    It remains active for the following comments until:

    • the current XML tag's scope is left (or a new tag entered)
    • another tag or non-whitespace text is processed
    • it becomes explicitly disabled via: <!-- xacro:eval-comments:off -->
  • Fix property resolution with namespace usage (#308)
    • Allow access to properties in parent scopes again (fixes #305)
    • Pick correct scope when defining a property into the parent (fixes #307)

      Setting a property within the parent scope may occur in two contexts:

      1. From within a macro. In that case, one wants to set the property in the caller's scope.
      2. From within the included file. In that case, one wants to set the property in the includer's scope.
  • Contributors: Chen Bainian, Gonzalo de Pedro, Gonzo, Jacob Perron, Melvin Wang, Robert Haschke, vandanamandlik

2.0.7 (2021-09-04)

  • Allow more builtin symbols: sorted, set
  • Don't import hidden symbols from math package
  • Fix eval security vulnerability
    • safe_eval()
    • unit tests validating the protection mechanism
  • Generalize yaml !degrees constructors: Enable expressions as well
  • Improve macro arg parsing (#278) to support:
    • $(substitution args)
    • ${python expressions}
    • single or double quoting of spaces
  • Contributors: Robert Haschke

2.0.6 (2021-05-30)

  • [feature] Expose YamlDictWrapper as dotify() to allow dotted access to any dict (#274)
  • [fix] Scoped macro evaluation (#272)
  • Contributors: Robert Haschke

2.0.5 (2021-03-02)

  • [fix] Report correct filename for XML errors (#268)
  • [fix] Python3-compatible property Table (#266)
  • [fix] Use outer-scope symbols to resolve include filename in xacro:include (#264)
  • [fix] Append test directory to existing AMENT_PREFIX_PATH (#260)
  • [fix] yaml loading: recursively wrap lists and dicts for dotted dict access (#258)
  • [feature] Provide support for yaml constructors !degrees and !radians (#252)
  • Contributors: Chen Bainian, Robert Haschke, G.A. vd. Hoorn

2.0.3 (2020-08-09)

  • Merge improvements of melodic and noetic branches into dashing-devel: see 1.14.2 and 1.14.3 for details
  • Contributors: Robert Haschke

2.0.2 (2020-03-29)

  • Merge improvements of melodic and noetic branches into dashing-devel: see 1.14.1, 1.13.5 for details
  • Contributors: Robert Haschke

2.0.1 (2019-10-06)

  • Revert requiring that all xacro commands are prefixed with 'xacro:' namespace Although this is deprecated since #79, the corresponding deprecation warning wasn't actually issued. Thus, we will accept non-prefixed xacro tags until F-turtle.
  • Install to both, bin/xacro and lib/xacro/xacro
  • Contributors: Robert Haschke

2.0.0 (2019-09-28)

  • PEP8 cleanup
    • code simplifications
    • avoid empty except
    • sort imports
    • format line breaks
  • Code cleanup
    • Removed deprecated options --legacy, --inorder, --check-order, --includes
    • Require all xacro commands to be prefixed with 'xacro:'
    • Added missing copyright notices
    • Removed python2 stuff
  • Adapt Travis config to use colcon
  • Provide ROS2-based replacement for substition args
  • Modified package structure as per ROS2 rules
    • Using ament_cmake
    • Moved source contents from "src/xacro" to "xacro"
    • Modified package.xml and setup.py according to ROS2 requirements
    • Configured completion hook
    • Removed catkin artifacts from cmake extension
  • Contributors: vandanamandlik, Jacob Perron, Robert Haschke

1.14.4 (2020-08-09)

  • [fix] Rework YamlDictWrapper to restore dict properties (#250)
  • [fix] Ignore underscores when parsing literal numeric values (#247)
  • Contributors: Robert Haschke

1.14.3 (2020-07-05)

  • [feature] Improve warnings
    • Unify meaning of verbosity > 0 (to print file location)
    • Provide file location on warning in check_attrs()
    • Issue warning on child elements of <xacro:include> tag
  • [feature] Allow dotted access to yaml-loaded dicts: d.key1.key2.key3 (#245)
  • [maint] Travis: Update distro to Bionic
  • Contributors: Robert Haschke, G.A. vd. Hoorn

1.14.2 (2020-05-21)

  • [maintanence] Remove deprecated xacro.py (#239)
  • Contributors: Shane Loretz

1.14.1 (2020-03-29)

  • [feature] allow optional xacro includes (#234)
  • Contributors: Robert Haschke

1.13.5 (2019-12-08)

  • [feature] Expose abs_filename() (#220)
  • [feature] Catch missing closing brace in $() and ${} expressions
  • [maintanence]
    • Replace deprecated yaml.load() -> yaml.safe_load()
    • Save macro names internally w/o 'xacro:' prefix
    • Correctly issue deprecation warning for non-prefixed xacro tags
  • Contributors: Robert Haschke

1.13.4 (2019-09-26)

  • [feature] remove xmlns:xacro from processed file (#207)
    • Remove all notions of xmlns:xacro from the resulting document.
    • If the root node defines a xacro:targetNamespace attribute, this will become the global xmlns namespace of the resulting document.
  • [feature] Add len() to allowed python functions (#208)
  • [maintanence]
    • --in-order warning: reduce severity level to message
    • fix and cleanup test of cmake extensions
    • adapt run_xacro() to run xacro from PATH
    • simplify import of substition_args
    • remove 'requires' field from setup.py
    • fix Travis config: use new repository key, use xenial/kinetic distro
    • basic README.md
    • fix catkin_lint issue
    • remove duplicate catkin_python_setup() (#206)
  • Contributors: Robert Haschke, James Xu, Martin Pecka

1.13.3 (2018-10-14)

  • use INORDER as default in cmake functions
  • remove weird 'None's in error messages
  • Contributors: Robert Haschke

1.13.2 (2018-05-14)

  • deprecate --includes option (which is tied to deprecated --legacy processing)
  • moved all option handling to cli.py, including deprecation warnings for options
  • Contributors: Robert Haschke

1.13.1 (2018-05-03)

  • fix parsing of quoted strings in default args for xacro params (#187)
  • Contributors: Robert Haschke

1.13.0 (2018-03-31)

  • make --inorder processing the default
  • Contributors: Robert Haschke

1.12.1 (2018-03-28)

  • #183: unicode support for python2 and python3
  • #178: extend list of allowed python builtins: min, max, round
  • #182: suppress xacro warnings when determining dependencies
  • #151: fixes for #149 and #148
  • #157: fix #156 access to undefined target_table
  • #150: allow True/False literals in python expressions
  • #159: load ROS-related packages on demand, thus becoming more independent from ROS
  • #173: allow default values for properties
  • #172: fix formatting of XacroException
  • #171: fix dependency handling (--deps option)
  • #163: full python 3 compatibility
  • Contributors: Robert Haschke, Kartik Mohta, Morgan Quigley, Steven Peters

1.12.0 (2017-03-25)

1.11.2 (2017-02-27)

  • Convert exception to string in a python2/3 compatible way.
  • Use python2/3 independent check for file type.
  • Contributors: Hans Gaiser, Maarten de Vries

1.11.1 (2016-06-22)

  • workaround for xml.dom.minidom issue
  • ensure non-empty error string
  • Contributors: Robert Haschke

1.11.0 (2016-03-25)

  • added short option -i as alternative to --inorder
  • refactored main to fix #122, #107
  • added xacro indicator to error message to fix #123
  • moved banner generation to process_file()
  • removed special (but obsolete) output handling for just_includes mode
  • moved core processing pipeline into function process_file()
  • improved documentation: more comments, input_file -> input_file_name
  • fix #120: handle non-space whitespace characters in params string
  • extended tests to handle non-space whitespace characters in params string
  • always store macros with xacro: prefix in front: #118
  • fix #115: enforce xacro namespace usage with --xacro-ns option
  • apply correct checking for include tags, and extend testcase
  • allow (one-level) nested expression/extension evaluation
  • Contributors: Robert Haschke, Morgan Quigley

1.10.6 (2015-09-01)

  • use correct catkin environment for cmake dependency checking
  • fixed dependency definition for cmake usage
  • Contributors: Robert Haschke

1.10.5 (2015-08-12)

  • fix #108: evaluate property blocks recursively too
  • improved macro parameter parsing
  • use a regular expression to parse a param spec with forwarding and default
  • allow for spaces in default string (within single quotes)
  • forwarding macro arguments from outer scope
  • switched to [\^|]{.title-ref} syntax
  • use more compact [$|]{.title-ref} syntax
  • moved parsing of argument defaults to grab_macro()
  • explicit forwarding of properties to macro scope
  • replace silent/implicit forwarding of properties from outer scope to macro scope by an explicit "call" to a [forward(<name>[,<default>])]{.title-ref} function.
  • implicit forwarding of outer-scope properties to macro args (#100)
  • property evaluation fixes
  • suppress double evaluation of properties
  • adapted unittest to cover the fixed issue
  • fixed evaluation order for properties exported to parent or global scope
  • Merge pull request #103 from ubi-agni/overwrite-check issue warning when attempting to overwrite existing global property
  • fixed unittest: avoid overwrite warning
  • warn when overwriting any globally defined variable
  • Merge pull request #102 from ubi-agni/completion bash completion
  • Merge pull request #99 from ubi-agni/jade-devel reworked macro resolution
  • moved test_macro_name_with_colon() to class TestXacro should be tested both, in oldorder and inorder mode
  • bash completion
  • improved error message for failed $(find)
  • reworked macro resolution python-eval-based macro resolution (introduced to enable namespaces) heavily restricted the set of possible macro names (only valid python identifiers were allowed) Particularly, xacro: prefixed macro names were forbidden.
  • initial attempt to fix #97
  • add failing test case with colon in the macro name
  • Contributors: Robert Haschke

1.10.4 (2015-06-18)

  • removed test_DEPRECATED_should_replace_before_macroexpand() duplicates test_should_replace_before_macroexpand()
  • fixed evaluation order of macro arguments and body Macro arguments need to be evaluated and assigned to properties before body is evaluated. Otherwise, the evaluated value will be converted to str, i.e. loosing original type.
  • Contributors: Robert Haschke

1.10.3 (2015-06-16)

  • deprecate --oldorder processing
  • added --check-order option to do a simple check for --inorder compatibility
    • Most probable incompatibility is redefining a property after its usage.
    • tested and reported with file location of (first) redefinition after usage.
  • moved command line processing to cli.py
  • explain verbosity levels in usage string
  • colorize errors during cli parsing
  • log definition and usage of properties
  • replaced debug option by verbosity options -q, -v
  • fixed evaluation time of default macro params
  • introduced Macro object to increase code readability
  • parse a macro's parameter list once at declaration time (instead of every instantiation)
  • extended test_multiple_blocks() to check for both normal and reversed order
  • added unittest to increase code coverage
  • do not issue deprecation warning for <include> tags that are non-xacro
  • added option --oldorder
  • allow to store properties to parent or global scope
  • added <xacro:attribute>
  • cleaned up error message about missing files
  • moved xml-specific functions to xmlutils.py new generic functions opt_attrs(), reqd_attrs(), and check_attrs() to fetch optional and required attributes and warn about unknown ones in a uniform fashion
  • unittest to allow empty <arg> defaults
  • Merge pull request #94 from ubi-agni/minor-fixes
  • minor fixes
  • remove duplicates in --deps output
  • fixed dependency checking for --inorder mode (which requires full processing)
  • fixed doc of xacro' cmake macros
  • renamed "xacro:rename" to "xacro:element"
  • allow namespacing for xacro:include's
  • allow renaming of element names using xacro:rename
  • unittest cleanup
  • check property and macro names to be valid python identifiers
  • allow namespacing of xacro:include's
  • properties and macros in an included file will go into their own, separate namespace, if the XML attribute [ns]{.title-ref} is provided. Access is by standard python syntax: namespace.name
  • allow renaming of element names <xacro:rename xacro:name="<new element name>"/>
  • moved unittests requiring --inorder processing to class TestXacroInorder
  • added unittest test_dynamic_macro_undefined()
  • improved error message when variable include filename is used without --inorder
  • stripped down unittest test_inorder_processing()
  • improved processing
  • adapted pr2 gold standard removing most comments again this partially reverts 59605fb1521583dc63efdea13f4c45128499bd20
  • remove all XML comments directly before xacro elements (These are considered xacro-related only and should be removed in the final doc.) Leaving an empty line between xacro-unrelated and xacro-related comments allows to include the former.
  • unittest: test_ignore_xacro_comments()
  • improved processing
    • recursive (instead of iterative) eval_all()
    • reusable process_include()
    • replace_node() function to replace xacro tag by some other content
    • avoid reprocessing of nodes
    • avoid deep copy where possible (speedup)
  • fix evaluation (#83)
  • yaml support
  • check for consistency of xml namespaces on xacro:include
  • replaced strip()=='' by more efficient isspace()
  • allow transitive definition of substition args
  • fixed evaluation of literals in property definitions
    • literals with preceding whitespace will be silently stripped (#83)
    • more complex evaluation test (perturbing spaces added)
  • fixed xacro namespaces in pr2 files to get rid of new inconsistency warning
  • warning message on inconsistent namespace redefinition for includes
  • yaml support ${load_yaml('file.yaml')} to load dict from yaml file
  • Merge pull request #85 from ubi-agni/error-reporting improved error reporting
  • nicer formatting of multiple "when evaluating expression" lines
  • improved formatting of error messages use XacroException to wrap and augment other exceptions to achieve a clearer error formatting
  • better error message for missing substitution args
  • use colorized warnings where possible
  • included macro stack in error-reporting
  • maintain filestack to facilitate error reporting at any time
  • Merge pull request #82 from ubi-agni/unittests improved unittesting
  • allow to capture (and check) stderr in unit tests
  • improved unittests to test both, classic and in-order processing
  • Merge pull request #81 from ubi-agni/jade-devel Thank you for your time and contributions. Improving cosmetics is important.
  • PEP8 cleanup
  • cmake: only copy files to devel space if new
  • Merge pull request #80 from ubi-agni/jade-devel
  • improved error-handling opening the output file - running multiple xacro process in parallel, all writing into a new dir could cause a race condition when creating the dir
    • improved error message on output creation failure
  • removed rospy dependency
    • Importing rospy caused build order issues with ros_comm in workspace
  • Filtering out REMAP command-line arguments is done manually now.
  • update authors/maintainers and copyright statements
  • deprecate non-namespaced xacro tags
  • added missing print_location_msg() for file that actually failed parsing
  • improved deprecation warnings
  • New cli option [--xacro-ns]{.title-ref} allows to enforce the new policy requiring the xacro namespace prefix (and suppressing deprecation warnings). However, non-prefixed tags will not be modified by xacro anymore (as requested by #41, #59, #60). Partially reverted cb73cfd8c678adfda2172accef398189ea2338a1, handling <arg> tags in the same fashion as other tags, i.e. issue a warning if used without prefix and ignoring it with cli argument [--xacro-ns]{.title-ref}.
  • fixed pr2 xacro files to use 'xacro:' prefixed tags only
  • fixed unittests in test_xacro.py to use 'xacro:' prefixed tags only
  • deprecation message for missing xacro namespace prefix in xml tags
  • moved colored warning messages into color.py (for reuseability)
  • added missing print_location_msg() for file that actually failed parsing
  • improved xacro's cmake macros
  • prepend ${PACKAGE_NAME} to all generated cmake targets Otherwise multiple packages employing xacro's cmake macros will use the same conflicting target name. This is only an issue with catkin_make, which defines a single global cmake namespace. The new catkin tools (or catkin_make_isolated) build each package separately.
  • basic unittest for xacro's cmake macros
  • improved xacro's cmake macros - xacro_add_xacro_file() automatically determines output file from input (removing .xacro suffix). If that fails, a fatal error is raised.
    • added xacro_install() to allow installation into both, devel and install space.
    • replaced conveniency function xacro_add_files()
  • Contributors: Robert Haschke

1.10.2 (2015-05-23)

  • added --debug option to explicitly enable stack traces By default, only show error message to the user. Stack traces are only interesting for xacro developers.
  • recursive include processing
    • more informed error messages (which file was included from where)

    - allows relative path names for include filename specs they are interpreted relative to the current file

  • new substitution command $(cwd) to extract current working directory
  • added unittest cases
    • creation of required subdirs for output
    • recursive xacro:include
    • extended test_include_glob() to check for all glob patterns
  • added run_xacro() function to simplify unittests running xacro script
  • moved xacro.py back to original location
  • nicely colored deprecation warning
  • create required dirs before opening output file
  • added convenience cmake-macro xacro_add_target() to auto-generate xacro-processed files
  • added cmake status message before launching xacro (xacro might run for quite a while)
  • fetch xacro --deps errors at report them as a warning
  • simplified deprecation message
  • added missing return statement
  • removed obsolete math import left over from deaaae2c69edd7d5e185eeb098c1521d8711608b
  • install xacro.py again (for backwards compatibility) usage of xacro.py issues a deprecation warning
  • simplified scripts/xacro - removed xacro.py
    • made run script "scripts/xacro" and install process follow standards
    • removed xacro.py

    - added dependencies to setup.py Having the binaries xacro and xacro.py installed side by side causes problems, because xacro.py is wrongly taken as the module. This was avoided by the rather complex filtering of the sys.path. Switched to ROS standard now, using a binary script called "xacro".

  • changed tests to use the whole xacro processing pipeline utilizing the modularization of main() from previous commit This simplifies several existing tests, especially these using files on disk.
  • split main() into process_cli_arg(), parse(), process_doc()
  • extended cmake macro xacro_add_xacro_file()
    • handle INORDER option
    • handle REMAP arguments

    - create absolute input file names automatically usage: xacro_add_xacro_file(input output INORDER REMAP ...)

  • stripped new unit tests to essential xml snippets
  • merged pull request #68: eval properties assigned from <arg> tags as literals In the following example: <xacro:arg name="val" default="0.5"/> <xacro:property name="val" value="$(arg val)"/> ${val} was not evaluated as a number, but as string only. Thus numerical expressions failed with an exception.
  • factored out get_boolean_value()
  • <xacro:arg> needs to be fully specified
  • (handling <arg> tags (without xacro ns-prefix) disabled native <arg> tags) add test for eating launch parameter arguments remove check for "arg" parameter. move new test function to bottom of source
  • added unit tests for evaluation of list, tuple, and dict literals
  • fixed some code style issues
  • fixed string-isinstance checks (for python 3 compatibility)
  • do not evaluate list, dict, tuple expressions as literals (without ${} syntax)
  • added dict to list of known global symbols
  • focused global_symbols definition in the beginning of the file added some basic python symbols: list, str, float, int and map allowing some basic computation
  • tuning performance: instantiate QuickLexer's regexps only once
  • Contributors: Robert Haschke, Martin Pecka, Mike O'Driscoll, Morgan Quigley

1.10.1 (2015-04-01)

  • improved error handling and more descriptive error messages
  • correctly raise a XacroException on invalid, i.e. non-boolean, <xacro:if> expressions. (removed left-over debugging code, added test case)
  • raise an exception on undefined, but used macros Using the syntax <xacro:macroname/> should raise an exception if macroname is not defined. Added appropriate code and a test case.
  • fixed bookkeeping in lazy evaluation switch Table.unevaluated from list to set to avoid multiple key entries
  • fix formatting of changelog
  • Contributors: Robert Haschke

1.10.0 (2015-03-13)

  • security measure: forbid access to __builtins__ in expressions
  • literal evaluation should only consider literals, but no expressions use ast.literal_eval()
  • removed eval() from xacro:if evaluation
  • back to string comparison to handle (lowercase) true and false
  • add test case for equality expressions in <xacro:if>
  • add test case for math function usage
  • python based evaluation of expressions
    • replaced handle_expr with python-internal eval() call
    • care has been taken to resolve variables recursively on demand (in Table.__getitem__)
    • allows for evaluation of standard math functions
    • other desired functions could be added in eval_self_contained
    • Values in Table symbols are not stored as strings but as typed values.
  • If text is required, a conversion with str() is performed, to ensure proper evaluation of expressions. Otherwise 3*"1" would evaluate to "111".
  • use __future__.division we can handle integer division evaluating to floating-point devision, as before
  • allow variable names for filename attribute in <xacro:include>
  • allow for ordered XML processing to avoid issues with multiply defined properties and macros in (typically 3rd party) include files
    • enable the new behaviour by passing --inorder cmdline option
    • to improve code readibility and reusability, introduced functions
  • process_include(node), grab_macro(elt, macros), grab_property(elt, symbols) containing 1:1 corresponding handling from process_includes, grab_macros, and grab_properties
    • added corresponding test case test_inorder_processing()
  • dynamic macro names using <xacro:call macro=""/>
  • fixup unittests and handling of non-element nodes in <include>, <if>, <macro>
  • updated pr2 gold standard to include all comments
  • allow to ignore comments in nodes_match()
  • New handling of non-element nodes invalidates pr2 gold standard (adding a lot more comments). To allow validation, allow to ignore all comments in comparison (as before).
  • fixed handling of non-element nodes in <include>, <if>, <macro>
  • fixed writexml: text nodes were not printed when other siblings exist
    • print all text, but skip whitespace-only text nodes
  • improved xml matching
    • so far only element nodes (with its attributes) were considered
    • now also consider TEXT, CDATA, and COMMENT nodes
    • added function text_matches (normalizing consecutive whitespace to a single space)
    • added some new unit tests

    - test_consider_non_elements: non-element nodes are not yet considered in <if> and <macro>

  • travis-ci: use catkin_make
  • travis-ci: fixup running of tests
  • fix pathnames used in test case
  • Include CATKIN_ENV params at build time.
  • use output filename flag instead of shell redirection
  • create output file after parsing is complete, not before
  • Contributors: Robert Haschke, Mike O'Driscoll, Morgan Quigley, William Woodall

1.9.3 (2015-01-14)

  • merge test cases
  • add a snapshot of the pr2 model to the test directory. add a test case which verifies that the pr2 model is parsed equal to a 'golden' parse of it.
  • add more tests
  • add default arg tests
  • Allow default values for substitution args
  • Fix up comments
  • Allow xacro macros to have default parameters
  • Contributors: Paul Bovbel, Morgan Quigley

1.9.2 (2014-07-11)

  • add a few more tests to exercise the symbol table a bit more
  • allow for recursive evaluation of properties in expressions
  • add useful debugging information when parameters are not set
  • stop test from failing the second time it is run
  • unified if/unless handling, correctly handle floating point expressions
  • floating point expressions not equal zero are now evaluated as True
  • changed quotes to omit cmake warning
  • Contributors: Robert Haschke, Mike Ferguson

1.9.1 (2014-06-21)

  • fixup tests so they run
  • export architecture_independent flag in package.xml
  • installed relocatable fix
  • Contributors: Michael Ferguson, Mike Purvis, Scott K Logan

1.9.0 (2014-03-28)

  • Remove the roslint_python glob, use the default one.
  • Add roslint target to xacro; two whitespace fixes so that it passes.
  • fix evaluation of integers in if statements also added a unit test, fixes #15
  • fix setting of _xacro_py CMake var, fixes #16
  • Add support for globbing multiple files in a single <xacro:include>
  • code cleanup and python3 support
  • check for CATKIN_ENABLE_TESTING

1.8.4 (2013-08-06)

  • Merge pull request #9 from davetcoleman/hydro-devel Xacro should not use plain 'include' tags but only namespaced ones.
  • Fix for the fact that minidom creates text nodes which count as child nodes
  • Removed <uri> checking and made it more general for any child element of an <include> tag
  • Removed Groovy reference, only being applied to Hydro
  • Created check for Gazebo's <uri> tabs only only shows deprecated warnings if not present.
  • Small spelling fix
  • Xacro should not use plain 'include' tags but only namespaced ones.
  • Merge pull request #8 from piyushk/hydro-devel-conditional xacro conditional blocks
  • using refined arguments instead of sys.argv for xml file location
  • adding conditional blocks to xacro

1.8.3 (2013-04-22)

  • bumped version to 1.8.3 for hydro release
  • backwards compatilibity with rosbuild
  • adding unit test for substitution args
  • Adding supoprt for substitution_args 'arg' fields
  • Remove bin copy of xacro.py
  • 1.7.3
  • Install xacro.py as a program so it can be run
  • 1.7.2
  • fixed build issues introduced in catkinization
  • 1.7.1
  • PEP8, cleanup, and remove roslib
  • Update copyright, self import guard, and catkinize
  • Catkinize.
  • Cleanup in preparation of catkinization.
  • Added tag unstable for changeset 169c4bf30367
  • Added tag xacro-1.6.1 for changeset fc45af7fdada
  • 1.6.1 marker
  • xacro: fuerte compat with sub args import
  • Added tag unstable for changeset 2d3c8dbfa3c9
  • Added tag xacro-1.6.0 for changeset e4a4455189bf
  • 1.6.0
  • converted to unary stack from common stack
  • xacro: fixed inserting property blocks (ros-pkg #4561)
  • xacro now uses XacroExceptions. String exceptions are not allowed in Python anymore. #4209
  • Added Ubuntu platform tags to manifest
  • Xacro now places comments below <?xml> tag (#3859)
  • Xacro prints out cleaner xml. Elements are now often separated by a newline.
  • xacro dependency on roslaunch removed #3451
  • Xacro now adds a message mentioning that the file was autogenerated (#2775)
  • Remove use of deprecated rosbuild macros
  • Integers stay integers in xacro, fixing #3287
  • Tests for r25868
  • Added a flag for only evaluating include tags in xacro
  • Allowing multiple blocks and multiple insert_blocks, fixing #3322 and #3323
  • doc review completed for xacro
  • adding mainpage for xacro doc review
  • Added xacro.cmake file that exports new xacro_add_xacro_file() macro, #3020
  • Namespaced "include" tag in xacro
  • Marked xacro as api reviewed
  • Xacro now correctly declares the namespaces of the included documents in the final
  • Made xacro accept xml namespaces
  • Xacro now errors hard when a property is used without being declared
  • Xacro no longer allows you to create properties with "${}" in the name
  • Added the ability to escape "${" in xacro
  • Made the tests in xacro run again.
  • Created xacro/src
  • migration part 1

Wiki Tutorials

This package does not provide any links to tutorials in it's rosindex metadata. You can check on the ROS Wiki Tutorials page for the package.

Dependant Packages

Name Deps
create_description
depthai_bridge
depthai_descriptions
depthai_examples
human_description
leo_description
leo_bringup
leo_gz_bringup
microstrain_inertial_description
mir_description
moveit_resources_prbt_moveit_config
moveit_resources_prbt_pg70_support
moveit_resources_prbt_support
moveit_ros_trajectory_cache
dual_arm_panda_moveit_config
moveit_resources_fanuc_moveit_config
moveit_resources_panda_moveit_config
qb_device_bringup
raspimouse_description
realsense2_description
talos_description
talos_description_calibration
talos_description_inertial
ur_bringup
ur_moveit_config
ur_robot_driver
urdf_sim_tutorial
urdf_test
velodyne_description
panda_arm_1_moveit_config
panda_arm_2_moveit_config
irobot_create_common_bringup
irobot_create_description
gazebo_ros2_control_demos
launch_param_builder
sick_safetyscanners2
simple_launch
ur_description
webots_ros2_importer
webots_ros2_universal_robot
bcr_bot
flir_camera_description
gazebo_set_joint_positions_plugin
qb_softhand_industry_ros2_control
reach_ros
sick_scan_xd
open_manipulator_x_description
pantilt_bot_description
ign_ros2_control_demos
canopen_tests
kortex_bringup
kinova_gen3_6dof_robotiq_2f_85_moveit_config
kinova_gen3_7dof_robotiq_2f_85_moveit_config
kinova_gen3_lite_moveit_config
robotiq_description
ros_gz_sim_demos
ur_simulation_gz
urdf_launch
nicla_vision_ros2
scenario_execution_ros
gazebo_static_camera
andino_description
andino_gz_classic
andino_gz
clearpath_manipulators
clearpath_manipulators_description
clearpath_platform_description
clearpath_config_live
crane_plus_control
crane_plus_description
crane_plus_moveit_config
franka_description
franka_bringup
franka_fr3_moveit_config
hey5_description
kuka_agilus_support
kuka_cybertech_support
kuka_fortec_support
kuka_iontec_support
kuka_kr_moveit_config
kuka_lbr_iisy_moveit_config
kuka_lbr_iisy_support
kuka_lbr_iiwa_moveit_config
kuka_lbr_iiwa_support
kuka_quantec_support
kuka_resources
omni_base_description
pal_gripper_description
pal_gripper_simulation
pal_hey5_description
pal_robotiq_description
pal_robotiq_epick_description
pal_urdf_utils
play_motion2
pmb2_description
raspimouse_slam
tiago_description
turtlebot3_manipulation_bringup
turtlebot3_manipulation_moveit_config

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

No plugins found.

Recent questions tagged xacro at Robotics Stack Exchange

xacro package from xacro repo

xacro

Package Summary

Tags No category tags.
Version 2.0.11
License BSD
Build type AMENT_CMAKE
Use RECOMMENDED

Repository Summary

Checkout URI https://github.com/ros/xacro.git
VCS Type git
VCS Version ros2
Last Updated 2024-11-13
Dev Status MAINTAINED
CI status No Continuous Integration
Released RELEASED
Tags No category tags.
Contributing Help Wanted (0)
Good First Issues (0)
Pull Requests to Review (0)

Package Description

Xacro (XML Macros) Xacro is an XML macro language. With xacro, you can construct shorter and more readable XML files by using macros that expand to larger XML expressions.

Additional Links

Maintainers

  • Robert Haschke
  • Morgan Quigley

Authors

  • Stuart Glaser
  • William Woodall
  • Robert Haschke

Xacro (XML Macros)

Xacro is an XML macro language

With xacro, you can construct shorter and more readable XML files by using macros that expand to larger XML expressions. Recent documentation can be found in the wiki. For older releases, have a look at the ROS wiki.

CHANGELOG

Changelog for package xacro

2.0.11 (2024-04-02)

  • Allow substitution args without ROS (#340)
  • Add more unit tags for yaml files (#331)
  • Resolve $(find ...) as a result of a substitution argument (#339)
  • Mark regexes as raw strings (#336)
  • Add pyproject.toml for direct installation via pip (#329)
  • Contributors: Adam Heins, Bruno-Pier, Carlo Rizzardo, Lukas Huber, Robert Haschke

2.0.10 (2024-01-25)

  • Expose python.abs()
  • Fix hasattr support of YamlDictWrapper (#324)
  • Contributors: Robert Haschke

2.0.9 (2023-02-27)

  • Evaluate arg value as str/unicode (#322)
  • Contributors: Robert Haschke

2.0.8 (2022-10-22)

  • Install xacro using console_script entrypoint (#304)
  • Provide xacro.process() returning the processed file (#229)
  • Dotted YAML access from list iterator (#318)
  • Optionally allow comment evaluation (#310)

    Comment evaluation can be enabled with a special comment:

    • <!-- xacro:eval-comments --> or
    • <!-- xacro:eval-comments:on -->

    It remains active for the following comments until:

    • the current XML tag's scope is left (or a new tag entered)
    • another tag or non-whitespace text is processed
    • it becomes explicitly disabled via: <!-- xacro:eval-comments:off -->
  • Fix property resolution with namespace usage (#308)
    • Allow access to properties in parent scopes again (fixes #305)
    • Pick correct scope when defining a property into the parent (fixes #307)

      Setting a property within the parent scope may occur in two contexts:

      1. From within a macro. In that case, one wants to set the property in the caller's scope.
      2. From within the included file. In that case, one wants to set the property in the includer's scope.
  • Contributors: Chen Bainian, Gonzalo de Pedro, Gonzo, Jacob Perron, Melvin Wang, Robert Haschke, vandanamandlik

2.0.7 (2021-09-04)

  • Allow more builtin symbols: sorted, set
  • Don't import hidden symbols from math package
  • Fix eval security vulnerability
    • safe_eval()
    • unit tests validating the protection mechanism
  • Generalize yaml !degrees constructors: Enable expressions as well
  • Improve macro arg parsing (#278) to support:
    • $(substitution args)
    • ${python expressions}
    • single or double quoting of spaces
  • Contributors: Robert Haschke

2.0.6 (2021-05-30)

  • [feature] Expose YamlDictWrapper as dotify() to allow dotted access to any dict (#274)
  • [fix] Scoped macro evaluation (#272)
  • Contributors: Robert Haschke

2.0.5 (2021-03-02)

  • [fix] Report correct filename for XML errors (#268)
  • [fix] Python3-compatible property Table (#266)
  • [fix] Use outer-scope symbols to resolve include filename in xacro:include (#264)
  • [fix] Append test directory to existing AMENT_PREFIX_PATH (#260)
  • [fix] yaml loading: recursively wrap lists and dicts for dotted dict access (#258)
  • [feature] Provide support for yaml constructors !degrees and !radians (#252)
  • Contributors: Chen Bainian, Robert Haschke, G.A. vd. Hoorn

2.0.3 (2020-08-09)

  • Merge improvements of melodic and noetic branches into dashing-devel: see 1.14.2 and 1.14.3 for details
  • Contributors: Robert Haschke

2.0.2 (2020-03-29)

  • Merge improvements of melodic and noetic branches into dashing-devel: see 1.14.1, 1.13.5 for details
  • Contributors: Robert Haschke

2.0.1 (2019-10-06)

  • Revert requiring that all xacro commands are prefixed with 'xacro:' namespace Although this is deprecated since #79, the corresponding deprecation warning wasn't actually issued. Thus, we will accept non-prefixed xacro tags until F-turtle.
  • Install to both, bin/xacro and lib/xacro/xacro
  • Contributors: Robert Haschke

2.0.0 (2019-09-28)

  • PEP8 cleanup
    • code simplifications
    • avoid empty except
    • sort imports
    • format line breaks
  • Code cleanup
    • Removed deprecated options --legacy, --inorder, --check-order, --includes
    • Require all xacro commands to be prefixed with 'xacro:'
    • Added missing copyright notices
    • Removed python2 stuff
  • Adapt Travis config to use colcon
  • Provide ROS2-based replacement for substition args
  • Modified package structure as per ROS2 rules
    • Using ament_cmake
    • Moved source contents from "src/xacro" to "xacro"
    • Modified package.xml and setup.py according to ROS2 requirements
    • Configured completion hook
    • Removed catkin artifacts from cmake extension
  • Contributors: vandanamandlik, Jacob Perron, Robert Haschke

1.14.4 (2020-08-09)

  • [fix] Rework YamlDictWrapper to restore dict properties (#250)
  • [fix] Ignore underscores when parsing literal numeric values (#247)
  • Contributors: Robert Haschke

1.14.3 (2020-07-05)

  • [feature] Improve warnings
    • Unify meaning of verbosity > 0 (to print file location)
    • Provide file location on warning in check_attrs()
    • Issue warning on child elements of <xacro:include> tag
  • [feature] Allow dotted access to yaml-loaded dicts: d.key1.key2.key3 (#245)
  • [maint] Travis: Update distro to Bionic
  • Contributors: Robert Haschke, G.A. vd. Hoorn

1.14.2 (2020-05-21)

  • [maintanence] Remove deprecated xacro.py (#239)
  • Contributors: Shane Loretz

1.14.1 (2020-03-29)

  • [feature] allow optional xacro includes (#234)
  • Contributors: Robert Haschke

1.13.5 (2019-12-08)

  • [feature] Expose abs_filename() (#220)
  • [feature] Catch missing closing brace in $() and ${} expressions
  • [maintanence]
    • Replace deprecated yaml.load() -> yaml.safe_load()
    • Save macro names internally w/o 'xacro:' prefix
    • Correctly issue deprecation warning for non-prefixed xacro tags
  • Contributors: Robert Haschke

1.13.4 (2019-09-26)

  • [feature] remove xmlns:xacro from processed file (#207)
    • Remove all notions of xmlns:xacro from the resulting document.
    • If the root node defines a xacro:targetNamespace attribute, this will become the global xmlns namespace of the resulting document.
  • [feature] Add len() to allowed python functions (#208)
  • [maintanence]
    • --in-order warning: reduce severity level to message
    • fix and cleanup test of cmake extensions
    • adapt run_xacro() to run xacro from PATH
    • simplify import of substition_args
    • remove 'requires' field from setup.py
    • fix Travis config: use new repository key, use xenial/kinetic distro
    • basic README.md
    • fix catkin_lint issue
    • remove duplicate catkin_python_setup() (#206)
  • Contributors: Robert Haschke, James Xu, Martin Pecka

1.13.3 (2018-10-14)

  • use INORDER as default in cmake functions
  • remove weird 'None's in error messages
  • Contributors: Robert Haschke

1.13.2 (2018-05-14)

  • deprecate --includes option (which is tied to deprecated --legacy processing)
  • moved all option handling to cli.py, including deprecation warnings for options
  • Contributors: Robert Haschke

1.13.1 (2018-05-03)

  • fix parsing of quoted strings in default args for xacro params (#187)
  • Contributors: Robert Haschke

1.13.0 (2018-03-31)

  • make --inorder processing the default
  • Contributors: Robert Haschke

1.12.1 (2018-03-28)

  • #183: unicode support for python2 and python3
  • #178: extend list of allowed python builtins: min, max, round
  • #182: suppress xacro warnings when determining dependencies
  • #151: fixes for #149 and #148
  • #157: fix #156 access to undefined target_table
  • #150: allow True/False literals in python expressions
  • #159: load ROS-related packages on demand, thus becoming more independent from ROS
  • #173: allow default values for properties
  • #172: fix formatting of XacroException
  • #171: fix dependency handling (--deps option)
  • #163: full python 3 compatibility
  • Contributors: Robert Haschke, Kartik Mohta, Morgan Quigley, Steven Peters

1.12.0 (2017-03-25)

1.11.2 (2017-02-27)

  • Convert exception to string in a python2/3 compatible way.
  • Use python2/3 independent check for file type.
  • Contributors: Hans Gaiser, Maarten de Vries

1.11.1 (2016-06-22)

  • workaround for xml.dom.minidom issue
  • ensure non-empty error string
  • Contributors: Robert Haschke

1.11.0 (2016-03-25)

  • added short option -i as alternative to --inorder
  • refactored main to fix #122, #107
  • added xacro indicator to error message to fix #123
  • moved banner generation to process_file()
  • removed special (but obsolete) output handling for just_includes mode
  • moved core processing pipeline into function process_file()
  • improved documentation: more comments, input_file -> input_file_name
  • fix #120: handle non-space whitespace characters in params string
  • extended tests to handle non-space whitespace characters in params string
  • always store macros with xacro: prefix in front: #118
  • fix #115: enforce xacro namespace usage with --xacro-ns option
  • apply correct checking for include tags, and extend testcase
  • allow (one-level) nested expression/extension evaluation
  • Contributors: Robert Haschke, Morgan Quigley

1.10.6 (2015-09-01)

  • use correct catkin environment for cmake dependency checking
  • fixed dependency definition for cmake usage
  • Contributors: Robert Haschke

1.10.5 (2015-08-12)

  • fix #108: evaluate property blocks recursively too
  • improved macro parameter parsing
  • use a regular expression to parse a param spec with forwarding and default
  • allow for spaces in default string (within single quotes)
  • forwarding macro arguments from outer scope
  • switched to [\^|]{.title-ref} syntax
  • use more compact [$|]{.title-ref} syntax
  • moved parsing of argument defaults to grab_macro()
  • explicit forwarding of properties to macro scope
  • replace silent/implicit forwarding of properties from outer scope to macro scope by an explicit "call" to a [forward(<name>[,<default>])]{.title-ref} function.
  • implicit forwarding of outer-scope properties to macro args (#100)
  • property evaluation fixes
  • suppress double evaluation of properties
  • adapted unittest to cover the fixed issue
  • fixed evaluation order for properties exported to parent or global scope
  • Merge pull request #103 from ubi-agni/overwrite-check issue warning when attempting to overwrite existing global property
  • fixed unittest: avoid overwrite warning
  • warn when overwriting any globally defined variable
  • Merge pull request #102 from ubi-agni/completion bash completion
  • Merge pull request #99 from ubi-agni/jade-devel reworked macro resolution
  • moved test_macro_name_with_colon() to class TestXacro should be tested both, in oldorder and inorder mode
  • bash completion
  • improved error message for failed $(find)
  • reworked macro resolution python-eval-based macro resolution (introduced to enable namespaces) heavily restricted the set of possible macro names (only valid python identifiers were allowed) Particularly, xacro: prefixed macro names were forbidden.
  • initial attempt to fix #97
  • add failing test case with colon in the macro name
  • Contributors: Robert Haschke

1.10.4 (2015-06-18)

  • removed test_DEPRECATED_should_replace_before_macroexpand() duplicates test_should_replace_before_macroexpand()
  • fixed evaluation order of macro arguments and body Macro arguments need to be evaluated and assigned to properties before body is evaluated. Otherwise, the evaluated value will be converted to str, i.e. loosing original type.
  • Contributors: Robert Haschke

1.10.3 (2015-06-16)

  • deprecate --oldorder processing
  • added --check-order option to do a simple check for --inorder compatibility
    • Most probable incompatibility is redefining a property after its usage.
    • tested and reported with file location of (first) redefinition after usage.
  • moved command line processing to cli.py
  • explain verbosity levels in usage string
  • colorize errors during cli parsing
  • log definition and usage of properties
  • replaced debug option by verbosity options -q, -v
  • fixed evaluation time of default macro params
  • introduced Macro object to increase code readability
  • parse a macro's parameter list once at declaration time (instead of every instantiation)
  • extended test_multiple_blocks() to check for both normal and reversed order
  • added unittest to increase code coverage
  • do not issue deprecation warning for <include> tags that are non-xacro
  • added option --oldorder
  • allow to store properties to parent or global scope
  • added <xacro:attribute>
  • cleaned up error message about missing files
  • moved xml-specific functions to xmlutils.py new generic functions opt_attrs(), reqd_attrs(), and check_attrs() to fetch optional and required attributes and warn about unknown ones in a uniform fashion
  • unittest to allow empty <arg> defaults
  • Merge pull request #94 from ubi-agni/minor-fixes
  • minor fixes
  • remove duplicates in --deps output
  • fixed dependency checking for --inorder mode (which requires full processing)
  • fixed doc of xacro' cmake macros
  • renamed "xacro:rename" to "xacro:element"
  • allow namespacing for xacro:include's
  • allow renaming of element names using xacro:rename
  • unittest cleanup
  • check property and macro names to be valid python identifiers
  • allow namespacing of xacro:include's
  • properties and macros in an included file will go into their own, separate namespace, if the XML attribute [ns]{.title-ref} is provided. Access is by standard python syntax: namespace.name
  • allow renaming of element names <xacro:rename xacro:name="<new element name>"/>
  • moved unittests requiring --inorder processing to class TestXacroInorder
  • added unittest test_dynamic_macro_undefined()
  • improved error message when variable include filename is used without --inorder
  • stripped down unittest test_inorder_processing()
  • improved processing
  • adapted pr2 gold standard removing most comments again this partially reverts 59605fb1521583dc63efdea13f4c45128499bd20
  • remove all XML comments directly before xacro elements (These are considered xacro-related only and should be removed in the final doc.) Leaving an empty line between xacro-unrelated and xacro-related comments allows to include the former.
  • unittest: test_ignore_xacro_comments()
  • improved processing
    • recursive (instead of iterative) eval_all()
    • reusable process_include()
    • replace_node() function to replace xacro tag by some other content
    • avoid reprocessing of nodes
    • avoid deep copy where possible (speedup)
  • fix evaluation (#83)
  • yaml support
  • check for consistency of xml namespaces on xacro:include
  • replaced strip()=='' by more efficient isspace()
  • allow transitive definition of substition args
  • fixed evaluation of literals in property definitions
    • literals with preceding whitespace will be silently stripped (#83)
    • more complex evaluation test (perturbing spaces added)
  • fixed xacro namespaces in pr2 files to get rid of new inconsistency warning
  • warning message on inconsistent namespace redefinition for includes
  • yaml support ${load_yaml('file.yaml')} to load dict from yaml file
  • Merge pull request #85 from ubi-agni/error-reporting improved error reporting
  • nicer formatting of multiple "when evaluating expression" lines
  • improved formatting of error messages use XacroException to wrap and augment other exceptions to achieve a clearer error formatting
  • better error message for missing substitution args
  • use colorized warnings where possible
  • included macro stack in error-reporting
  • maintain filestack to facilitate error reporting at any time
  • Merge pull request #82 from ubi-agni/unittests improved unittesting
  • allow to capture (and check) stderr in unit tests
  • improved unittests to test both, classic and in-order processing
  • Merge pull request #81 from ubi-agni/jade-devel Thank you for your time and contributions. Improving cosmetics is important.
  • PEP8 cleanup
  • cmake: only copy files to devel space if new
  • Merge pull request #80 from ubi-agni/jade-devel
  • improved error-handling opening the output file - running multiple xacro process in parallel, all writing into a new dir could cause a race condition when creating the dir
    • improved error message on output creation failure
  • removed rospy dependency
    • Importing rospy caused build order issues with ros_comm in workspace
  • Filtering out REMAP command-line arguments is done manually now.
  • update authors/maintainers and copyright statements
  • deprecate non-namespaced xacro tags
  • added missing print_location_msg() for file that actually failed parsing
  • improved deprecation warnings
  • New cli option [--xacro-ns]{.title-ref} allows to enforce the new policy requiring the xacro namespace prefix (and suppressing deprecation warnings). However, non-prefixed tags will not be modified by xacro anymore (as requested by #41, #59, #60). Partially reverted cb73cfd8c678adfda2172accef398189ea2338a1, handling <arg> tags in the same fashion as other tags, i.e. issue a warning if used without prefix and ignoring it with cli argument [--xacro-ns]{.title-ref}.
  • fixed pr2 xacro files to use 'xacro:' prefixed tags only
  • fixed unittests in test_xacro.py to use 'xacro:' prefixed tags only
  • deprecation message for missing xacro namespace prefix in xml tags
  • moved colored warning messages into color.py (for reuseability)
  • added missing print_location_msg() for file that actually failed parsing
  • improved xacro's cmake macros
  • prepend ${PACKAGE_NAME} to all generated cmake targets Otherwise multiple packages employing xacro's cmake macros will use the same conflicting target name. This is only an issue with catkin_make, which defines a single global cmake namespace. The new catkin tools (or catkin_make_isolated) build each package separately.
  • basic unittest for xacro's cmake macros
  • improved xacro's cmake macros - xacro_add_xacro_file() automatically determines output file from input (removing .xacro suffix). If that fails, a fatal error is raised.
    • added xacro_install() to allow installation into both, devel and install space.
    • replaced conveniency function xacro_add_files()
  • Contributors: Robert Haschke

1.10.2 (2015-05-23)

  • added --debug option to explicitly enable stack traces By default, only show error message to the user. Stack traces are only interesting for xacro developers.
  • recursive include processing
    • more informed error messages (which file was included from where)

    - allows relative path names for include filename specs they are interpreted relative to the current file

  • new substitution command $(cwd) to extract current working directory
  • added unittest cases
    • creation of required subdirs for output
    • recursive xacro:include
    • extended test_include_glob() to check for all glob patterns
  • added run_xacro() function to simplify unittests running xacro script
  • moved xacro.py back to original location
  • nicely colored deprecation warning
  • create required dirs before opening output file
  • added convenience cmake-macro xacro_add_target() to auto-generate xacro-processed files
  • added cmake status message before launching xacro (xacro might run for quite a while)
  • fetch xacro --deps errors at report them as a warning
  • simplified deprecation message
  • added missing return statement
  • removed obsolete math import left over from deaaae2c69edd7d5e185eeb098c1521d8711608b
  • install xacro.py again (for backwards compatibility) usage of xacro.py issues a deprecation warning
  • simplified scripts/xacro - removed xacro.py
    • made run script "scripts/xacro" and install process follow standards
    • removed xacro.py

    - added dependencies to setup.py Having the binaries xacro and xacro.py installed side by side causes problems, because xacro.py is wrongly taken as the module. This was avoided by the rather complex filtering of the sys.path. Switched to ROS standard now, using a binary script called "xacro".

  • changed tests to use the whole xacro processing pipeline utilizing the modularization of main() from previous commit This simplifies several existing tests, especially these using files on disk.
  • split main() into process_cli_arg(), parse(), process_doc()
  • extended cmake macro xacro_add_xacro_file()
    • handle INORDER option
    • handle REMAP arguments

    - create absolute input file names automatically usage: xacro_add_xacro_file(input output INORDER REMAP ...)

  • stripped new unit tests to essential xml snippets
  • merged pull request #68: eval properties assigned from <arg> tags as literals In the following example: <xacro:arg name="val" default="0.5"/> <xacro:property name="val" value="$(arg val)"/> ${val} was not evaluated as a number, but as string only. Thus numerical expressions failed with an exception.
  • factored out get_boolean_value()
  • <xacro:arg> needs to be fully specified
  • (handling <arg> tags (without xacro ns-prefix) disabled native <arg> tags) add test for eating launch parameter arguments remove check for "arg" parameter. move new test function to bottom of source
  • added unit tests for evaluation of list, tuple, and dict literals
  • fixed some code style issues
  • fixed string-isinstance checks (for python 3 compatibility)
  • do not evaluate list, dict, tuple expressions as literals (without ${} syntax)
  • added dict to list of known global symbols
  • focused global_symbols definition in the beginning of the file added some basic python symbols: list, str, float, int and map allowing some basic computation
  • tuning performance: instantiate QuickLexer's regexps only once
  • Contributors: Robert Haschke, Martin Pecka, Mike O'Driscoll, Morgan Quigley

1.10.1 (2015-04-01)

  • improved error handling and more descriptive error messages
  • correctly raise a XacroException on invalid, i.e. non-boolean, <xacro:if> expressions. (removed left-over debugging code, added test case)
  • raise an exception on undefined, but used macros Using the syntax <xacro:macroname/> should raise an exception if macroname is not defined. Added appropriate code and a test case.
  • fixed bookkeeping in lazy evaluation switch Table.unevaluated from list to set to avoid multiple key entries
  • fix formatting of changelog
  • Contributors: Robert Haschke

1.10.0 (2015-03-13)

  • security measure: forbid access to __builtins__ in expressions
  • literal evaluation should only consider literals, but no expressions use ast.literal_eval()
  • removed eval() from xacro:if evaluation
  • back to string comparison to handle (lowercase) true and false
  • add test case for equality expressions in <xacro:if>
  • add test case for math function usage
  • python based evaluation of expressions
    • replaced handle_expr with python-internal eval() call
    • care has been taken to resolve variables recursively on demand (in Table.__getitem__)
    • allows for evaluation of standard math functions
    • other desired functions could be added in eval_self_contained
    • Values in Table symbols are not stored as strings but as typed values.
  • If text is required, a conversion with str() is performed, to ensure proper evaluation of expressions. Otherwise 3*"1" would evaluate to "111".
  • use __future__.division we can handle integer division evaluating to floating-point devision, as before
  • allow variable names for filename attribute in <xacro:include>
  • allow for ordered XML processing to avoid issues with multiply defined properties and macros in (typically 3rd party) include files
    • enable the new behaviour by passing --inorder cmdline option
    • to improve code readibility and reusability, introduced functions
  • process_include(node), grab_macro(elt, macros), grab_property(elt, symbols) containing 1:1 corresponding handling from process_includes, grab_macros, and grab_properties
    • added corresponding test case test_inorder_processing()
  • dynamic macro names using <xacro:call macro=""/>
  • fixup unittests and handling of non-element nodes in <include>, <if>, <macro>
  • updated pr2 gold standard to include all comments
  • allow to ignore comments in nodes_match()
  • New handling of non-element nodes invalidates pr2 gold standard (adding a lot more comments). To allow validation, allow to ignore all comments in comparison (as before).
  • fixed handling of non-element nodes in <include>, <if>, <macro>
  • fixed writexml: text nodes were not printed when other siblings exist
    • print all text, but skip whitespace-only text nodes
  • improved xml matching
    • so far only element nodes (with its attributes) were considered
    • now also consider TEXT, CDATA, and COMMENT nodes
    • added function text_matches (normalizing consecutive whitespace to a single space)
    • added some new unit tests

    - test_consider_non_elements: non-element nodes are not yet considered in <if> and <macro>

  • travis-ci: use catkin_make
  • travis-ci: fixup running of tests
  • fix pathnames used in test case
  • Include CATKIN_ENV params at build time.
  • use output filename flag instead of shell redirection
  • create output file after parsing is complete, not before
  • Contributors: Robert Haschke, Mike O'Driscoll, Morgan Quigley, William Woodall

1.9.3 (2015-01-14)

  • merge test cases
  • add a snapshot of the pr2 model to the test directory. add a test case which verifies that the pr2 model is parsed equal to a 'golden' parse of it.
  • add more tests
  • add default arg tests
  • Allow default values for substitution args
  • Fix up comments
  • Allow xacro macros to have default parameters
  • Contributors: Paul Bovbel, Morgan Quigley

1.9.2 (2014-07-11)

  • add a few more tests to exercise the symbol table a bit more
  • allow for recursive evaluation of properties in expressions
  • add useful debugging information when parameters are not set
  • stop test from failing the second time it is run
  • unified if/unless handling, correctly handle floating point expressions
  • floating point expressions not equal zero are now evaluated as True
  • changed quotes to omit cmake warning
  • Contributors: Robert Haschke, Mike Ferguson

1.9.1 (2014-06-21)

  • fixup tests so they run
  • export architecture_independent flag in package.xml
  • installed relocatable fix
  • Contributors: Michael Ferguson, Mike Purvis, Scott K Logan

1.9.0 (2014-03-28)

  • Remove the roslint_python glob, use the default one.
  • Add roslint target to xacro; two whitespace fixes so that it passes.
  • fix evaluation of integers in if statements also added a unit test, fixes #15
  • fix setting of _xacro_py CMake var, fixes #16
  • Add support for globbing multiple files in a single <xacro:include>
  • code cleanup and python3 support
  • check for CATKIN_ENABLE_TESTING

1.8.4 (2013-08-06)

  • Merge pull request #9 from davetcoleman/hydro-devel Xacro should not use plain 'include' tags but only namespaced ones.
  • Fix for the fact that minidom creates text nodes which count as child nodes
  • Removed <uri> checking and made it more general for any child element of an <include> tag
  • Removed Groovy reference, only being applied to Hydro
  • Created check for Gazebo's <uri> tabs only only shows deprecated warnings if not present.
  • Small spelling fix
  • Xacro should not use plain 'include' tags but only namespaced ones.
  • Merge pull request #8 from piyushk/hydro-devel-conditional xacro conditional blocks
  • using refined arguments instead of sys.argv for xml file location
  • adding conditional blocks to xacro

1.8.3 (2013-04-22)

  • bumped version to 1.8.3 for hydro release
  • backwards compatilibity with rosbuild
  • adding unit test for substitution args
  • Adding supoprt for substitution_args 'arg' fields
  • Remove bin copy of xacro.py
  • 1.7.3
  • Install xacro.py as a program so it can be run
  • 1.7.2
  • fixed build issues introduced in catkinization
  • 1.7.1
  • PEP8, cleanup, and remove roslib
  • Update copyright, self import guard, and catkinize
  • Catkinize.
  • Cleanup in preparation of catkinization.
  • Added tag unstable for changeset 169c4bf30367
  • Added tag xacro-1.6.1 for changeset fc45af7fdada
  • 1.6.1 marker
  • xacro: fuerte compat with sub args import
  • Added tag unstable for changeset 2d3c8dbfa3c9
  • Added tag xacro-1.6.0 for changeset e4a4455189bf
  • 1.6.0
  • converted to unary stack from common stack
  • xacro: fixed inserting property blocks (ros-pkg #4561)
  • xacro now uses XacroExceptions. String exceptions are not allowed in Python anymore. #4209
  • Added Ubuntu platform tags to manifest
  • Xacro now places comments below <?xml> tag (#3859)
  • Xacro prints out cleaner xml. Elements are now often separated by a newline.
  • xacro dependency on roslaunch removed #3451
  • Xacro now adds a message mentioning that the file was autogenerated (#2775)
  • Remove use of deprecated rosbuild macros
  • Integers stay integers in xacro, fixing #3287
  • Tests for r25868
  • Added a flag for only evaluating include tags in xacro
  • Allowing multiple blocks and multiple insert_blocks, fixing #3322 and #3323
  • doc review completed for xacro
  • adding mainpage for xacro doc review
  • Added xacro.cmake file that exports new xacro_add_xacro_file() macro, #3020
  • Namespaced "include" tag in xacro
  • Marked xacro as api reviewed
  • Xacro now correctly declares the namespaces of the included documents in the final
  • Made xacro accept xml namespaces
  • Xacro now errors hard when a property is used without being declared
  • Xacro no longer allows you to create properties with "${}" in the name
  • Added the ability to escape "${" in xacro
  • Made the tests in xacro run again.
  • Created xacro/src
  • migration part 1

Wiki Tutorials

This package does not provide any links to tutorials in it's rosindex metadata. You can check on the ROS Wiki Tutorials page for the package.

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

No plugins found.

Recent questions tagged xacro at Robotics Stack Exchange

xacro package from xacro repo

xacro

Package Summary

Tags No category tags.
Version 2.0.11
License BSD
Build type AMENT_CMAKE
Use RECOMMENDED

Repository Summary

Checkout URI https://github.com/ros/xacro.git
VCS Type git
VCS Version ros2
Last Updated 2024-11-13
Dev Status MAINTAINED
CI status No Continuous Integration
Released RELEASED
Tags No category tags.
Contributing Help Wanted (0)
Good First Issues (0)
Pull Requests to Review (0)

Package Description

Xacro (XML Macros) Xacro is an XML macro language. With xacro, you can construct shorter and more readable XML files by using macros that expand to larger XML expressions.

Additional Links

Maintainers

  • Robert Haschke
  • Morgan Quigley

Authors

  • Stuart Glaser
  • William Woodall
  • Robert Haschke

Xacro (XML Macros)

Xacro is an XML macro language

With xacro, you can construct shorter and more readable XML files by using macros that expand to larger XML expressions. Recent documentation can be found in the wiki. For older releases, have a look at the ROS wiki.

CHANGELOG

Changelog for package xacro

2.0.11 (2024-04-02)

  • Allow substitution args without ROS (#340)
  • Add more unit tags for yaml files (#331)
  • Resolve $(find ...) as a result of a substitution argument (#339)
  • Mark regexes as raw strings (#336)
  • Add pyproject.toml for direct installation via pip (#329)
  • Contributors: Adam Heins, Bruno-Pier, Carlo Rizzardo, Lukas Huber, Robert Haschke

2.0.10 (2024-01-25)

  • Expose python.abs()
  • Fix hasattr support of YamlDictWrapper (#324)
  • Contributors: Robert Haschke

2.0.9 (2023-02-27)

  • Evaluate arg value as str/unicode (#322)
  • Contributors: Robert Haschke

2.0.8 (2022-10-22)

  • Install xacro using console_script entrypoint (#304)
  • Provide xacro.process() returning the processed file (#229)
  • Dotted YAML access from list iterator (#318)
  • Optionally allow comment evaluation (#310)

    Comment evaluation can be enabled with a special comment:

    • <!-- xacro:eval-comments --> or
    • <!-- xacro:eval-comments:on -->

    It remains active for the following comments until:

    • the current XML tag's scope is left (or a new tag entered)
    • another tag or non-whitespace text is processed
    • it becomes explicitly disabled via: <!-- xacro:eval-comments:off -->
  • Fix property resolution with namespace usage (#308)
    • Allow access to properties in parent scopes again (fixes #305)
    • Pick correct scope when defining a property into the parent (fixes #307)

      Setting a property within the parent scope may occur in two contexts:

      1. From within a macro. In that case, one wants to set the property in the caller's scope.
      2. From within the included file. In that case, one wants to set the property in the includer's scope.
  • Contributors: Chen Bainian, Gonzalo de Pedro, Gonzo, Jacob Perron, Melvin Wang, Robert Haschke, vandanamandlik

2.0.7 (2021-09-04)

  • Allow more builtin symbols: sorted, set
  • Don't import hidden symbols from math package
  • Fix eval security vulnerability
    • safe_eval()
    • unit tests validating the protection mechanism
  • Generalize yaml !degrees constructors: Enable expressions as well
  • Improve macro arg parsing (#278) to support:
    • $(substitution args)
    • ${python expressions}
    • single or double quoting of spaces
  • Contributors: Robert Haschke

2.0.6 (2021-05-30)

  • [feature] Expose YamlDictWrapper as dotify() to allow dotted access to any dict (#274)
  • [fix] Scoped macro evaluation (#272)
  • Contributors: Robert Haschke

2.0.5 (2021-03-02)

  • [fix] Report correct filename for XML errors (#268)
  • [fix] Python3-compatible property Table (#266)
  • [fix] Use outer-scope symbols to resolve include filename in xacro:include (#264)
  • [fix] Append test directory to existing AMENT_PREFIX_PATH (#260)
  • [fix] yaml loading: recursively wrap lists and dicts for dotted dict access (#258)
  • [feature] Provide support for yaml constructors !degrees and !radians (#252)
  • Contributors: Chen Bainian, Robert Haschke, G.A. vd. Hoorn

2.0.3 (2020-08-09)

  • Merge improvements of melodic and noetic branches into dashing-devel: see 1.14.2 and 1.14.3 for details
  • Contributors: Robert Haschke

2.0.2 (2020-03-29)

  • Merge improvements of melodic and noetic branches into dashing-devel: see 1.14.1, 1.13.5 for details
  • Contributors: Robert Haschke

2.0.1 (2019-10-06)

  • Revert requiring that all xacro commands are prefixed with 'xacro:' namespace Although this is deprecated since #79, the corresponding deprecation warning wasn't actually issued. Thus, we will accept non-prefixed xacro tags until F-turtle.
  • Install to both, bin/xacro and lib/xacro/xacro
  • Contributors: Robert Haschke

2.0.0 (2019-09-28)

  • PEP8 cleanup
    • code simplifications
    • avoid empty except
    • sort imports
    • format line breaks
  • Code cleanup
    • Removed deprecated options --legacy, --inorder, --check-order, --includes
    • Require all xacro commands to be prefixed with 'xacro:'
    • Added missing copyright notices
    • Removed python2 stuff
  • Adapt Travis config to use colcon
  • Provide ROS2-based replacement for substition args
  • Modified package structure as per ROS2 rules
    • Using ament_cmake
    • Moved source contents from "src/xacro" to "xacro"
    • Modified package.xml and setup.py according to ROS2 requirements
    • Configured completion hook
    • Removed catkin artifacts from cmake extension
  • Contributors: vandanamandlik, Jacob Perron, Robert Haschke

1.14.4 (2020-08-09)

  • [fix] Rework YamlDictWrapper to restore dict properties (#250)
  • [fix] Ignore underscores when parsing literal numeric values (#247)
  • Contributors: Robert Haschke

1.14.3 (2020-07-05)

  • [feature] Improve warnings
    • Unify meaning of verbosity > 0 (to print file location)
    • Provide file location on warning in check_attrs()
    • Issue warning on child elements of <xacro:include> tag
  • [feature] Allow dotted access to yaml-loaded dicts: d.key1.key2.key3 (#245)
  • [maint] Travis: Update distro to Bionic
  • Contributors: Robert Haschke, G.A. vd. Hoorn

1.14.2 (2020-05-21)

  • [maintanence] Remove deprecated xacro.py (#239)
  • Contributors: Shane Loretz

1.14.1 (2020-03-29)

  • [feature] allow optional xacro includes (#234)
  • Contributors: Robert Haschke

1.13.5 (2019-12-08)

  • [feature] Expose abs_filename() (#220)
  • [feature] Catch missing closing brace in $() and ${} expressions
  • [maintanence]
    • Replace deprecated yaml.load() -> yaml.safe_load()
    • Save macro names internally w/o 'xacro:' prefix
    • Correctly issue deprecation warning for non-prefixed xacro tags
  • Contributors: Robert Haschke

1.13.4 (2019-09-26)

  • [feature] remove xmlns:xacro from processed file (#207)
    • Remove all notions of xmlns:xacro from the resulting document.
    • If the root node defines a xacro:targetNamespace attribute, this will become the global xmlns namespace of the resulting document.
  • [feature] Add len() to allowed python functions (#208)
  • [maintanence]
    • --in-order warning: reduce severity level to message
    • fix and cleanup test of cmake extensions
    • adapt run_xacro() to run xacro from PATH
    • simplify import of substition_args
    • remove 'requires' field from setup.py
    • fix Travis config: use new repository key, use xenial/kinetic distro
    • basic README.md
    • fix catkin_lint issue
    • remove duplicate catkin_python_setup() (#206)
  • Contributors: Robert Haschke, James Xu, Martin Pecka

1.13.3 (2018-10-14)

  • use INORDER as default in cmake functions
  • remove weird 'None's in error messages
  • Contributors: Robert Haschke

1.13.2 (2018-05-14)

  • deprecate --includes option (which is tied to deprecated --legacy processing)
  • moved all option handling to cli.py, including deprecation warnings for options
  • Contributors: Robert Haschke

1.13.1 (2018-05-03)

  • fix parsing of quoted strings in default args for xacro params (#187)
  • Contributors: Robert Haschke

1.13.0 (2018-03-31)

  • make --inorder processing the default
  • Contributors: Robert Haschke

1.12.1 (2018-03-28)

  • #183: unicode support for python2 and python3
  • #178: extend list of allowed python builtins: min, max, round
  • #182: suppress xacro warnings when determining dependencies
  • #151: fixes for #149 and #148
  • #157: fix #156 access to undefined target_table
  • #150: allow True/False literals in python expressions
  • #159: load ROS-related packages on demand, thus becoming more independent from ROS
  • #173: allow default values for properties
  • #172: fix formatting of XacroException
  • #171: fix dependency handling (--deps option)
  • #163: full python 3 compatibility
  • Contributors: Robert Haschke, Kartik Mohta, Morgan Quigley, Steven Peters

1.12.0 (2017-03-25)

1.11.2 (2017-02-27)

  • Convert exception to string in a python2/3 compatible way.
  • Use python2/3 independent check for file type.
  • Contributors: Hans Gaiser, Maarten de Vries

1.11.1 (2016-06-22)

  • workaround for xml.dom.minidom issue
  • ensure non-empty error string
  • Contributors: Robert Haschke

1.11.0 (2016-03-25)

  • added short option -i as alternative to --inorder
  • refactored main to fix #122, #107
  • added xacro indicator to error message to fix #123
  • moved banner generation to process_file()
  • removed special (but obsolete) output handling for just_includes mode
  • moved core processing pipeline into function process_file()
  • improved documentation: more comments, input_file -> input_file_name
  • fix #120: handle non-space whitespace characters in params string
  • extended tests to handle non-space whitespace characters in params string
  • always store macros with xacro: prefix in front: #118
  • fix #115: enforce xacro namespace usage with --xacro-ns option
  • apply correct checking for include tags, and extend testcase
  • allow (one-level) nested expression/extension evaluation
  • Contributors: Robert Haschke, Morgan Quigley

1.10.6 (2015-09-01)

  • use correct catkin environment for cmake dependency checking
  • fixed dependency definition for cmake usage
  • Contributors: Robert Haschke

1.10.5 (2015-08-12)

  • fix #108: evaluate property blocks recursively too
  • improved macro parameter parsing
  • use a regular expression to parse a param spec with forwarding and default
  • allow for spaces in default string (within single quotes)
  • forwarding macro arguments from outer scope
  • switched to [\^|]{.title-ref} syntax
  • use more compact [$|]{.title-ref} syntax
  • moved parsing of argument defaults to grab_macro()
  • explicit forwarding of properties to macro scope
  • replace silent/implicit forwarding of properties from outer scope to macro scope by an explicit "call" to a [forward(<name>[,<default>])]{.title-ref} function.
  • implicit forwarding of outer-scope properties to macro args (#100)
  • property evaluation fixes
  • suppress double evaluation of properties
  • adapted unittest to cover the fixed issue
  • fixed evaluation order for properties exported to parent or global scope
  • Merge pull request #103 from ubi-agni/overwrite-check issue warning when attempting to overwrite existing global property
  • fixed unittest: avoid overwrite warning
  • warn when overwriting any globally defined variable
  • Merge pull request #102 from ubi-agni/completion bash completion
  • Merge pull request #99 from ubi-agni/jade-devel reworked macro resolution
  • moved test_macro_name_with_colon() to class TestXacro should be tested both, in oldorder and inorder mode
  • bash completion
  • improved error message for failed $(find)
  • reworked macro resolution python-eval-based macro resolution (introduced to enable namespaces) heavily restricted the set of possible macro names (only valid python identifiers were allowed) Particularly, xacro: prefixed macro names were forbidden.
  • initial attempt to fix #97
  • add failing test case with colon in the macro name
  • Contributors: Robert Haschke

1.10.4 (2015-06-18)

  • removed test_DEPRECATED_should_replace_before_macroexpand() duplicates test_should_replace_before_macroexpand()
  • fixed evaluation order of macro arguments and body Macro arguments need to be evaluated and assigned to properties before body is evaluated. Otherwise, the evaluated value will be converted to str, i.e. loosing original type.
  • Contributors: Robert Haschke

1.10.3 (2015-06-16)

  • deprecate --oldorder processing
  • added --check-order option to do a simple check for --inorder compatibility
    • Most probable incompatibility is redefining a property after its usage.
    • tested and reported with file location of (first) redefinition after usage.
  • moved command line processing to cli.py
  • explain verbosity levels in usage string
  • colorize errors during cli parsing
  • log definition and usage of properties
  • replaced debug option by verbosity options -q, -v
  • fixed evaluation time of default macro params
  • introduced Macro object to increase code readability
  • parse a macro's parameter list once at declaration time (instead of every instantiation)
  • extended test_multiple_blocks() to check for both normal and reversed order
  • added unittest to increase code coverage
  • do not issue deprecation warning for <include> tags that are non-xacro
  • added option --oldorder
  • allow to store properties to parent or global scope
  • added <xacro:attribute>
  • cleaned up error message about missing files
  • moved xml-specific functions to xmlutils.py new generic functions opt_attrs(), reqd_attrs(), and check_attrs() to fetch optional and required attributes and warn about unknown ones in a uniform fashion
  • unittest to allow empty <arg> defaults
  • Merge pull request #94 from ubi-agni/minor-fixes
  • minor fixes
  • remove duplicates in --deps output
  • fixed dependency checking for --inorder mode (which requires full processing)
  • fixed doc of xacro' cmake macros
  • renamed "xacro:rename" to "xacro:element"
  • allow namespacing for xacro:include's
  • allow renaming of element names using xacro:rename
  • unittest cleanup
  • check property and macro names to be valid python identifiers
  • allow namespacing of xacro:include's
  • properties and macros in an included file will go into their own, separate namespace, if the XML attribute [ns]{.title-ref} is provided. Access is by standard python syntax: namespace.name
  • allow renaming of element names <xacro:rename xacro:name="<new element name>"/>
  • moved unittests requiring --inorder processing to class TestXacroInorder
  • added unittest test_dynamic_macro_undefined()
  • improved error message when variable include filename is used without --inorder
  • stripped down unittest test_inorder_processing()
  • improved processing
  • adapted pr2 gold standard removing most comments again this partially reverts 59605fb1521583dc63efdea13f4c45128499bd20
  • remove all XML comments directly before xacro elements (These are considered xacro-related only and should be removed in the final doc.) Leaving an empty line between xacro-unrelated and xacro-related comments allows to include the former.
  • unittest: test_ignore_xacro_comments()
  • improved processing
    • recursive (instead of iterative) eval_all()
    • reusable process_include()
    • replace_node() function to replace xacro tag by some other content
    • avoid reprocessing of nodes
    • avoid deep copy where possible (speedup)
  • fix evaluation (#83)
  • yaml support
  • check for consistency of xml namespaces on xacro:include
  • replaced strip()=='' by more efficient isspace()
  • allow transitive definition of substition args
  • fixed evaluation of literals in property definitions
    • literals with preceding whitespace will be silently stripped (#83)
    • more complex evaluation test (perturbing spaces added)
  • fixed xacro namespaces in pr2 files to get rid of new inconsistency warning
  • warning message on inconsistent namespace redefinition for includes
  • yaml support ${load_yaml('file.yaml')} to load dict from yaml file
  • Merge pull request #85 from ubi-agni/error-reporting improved error reporting
  • nicer formatting of multiple "when evaluating expression" lines
  • improved formatting of error messages use XacroException to wrap and augment other exceptions to achieve a clearer error formatting
  • better error message for missing substitution args
  • use colorized warnings where possible
  • included macro stack in error-reporting
  • maintain filestack to facilitate error reporting at any time
  • Merge pull request #82 from ubi-agni/unittests improved unittesting
  • allow to capture (and check) stderr in unit tests
  • improved unittests to test both, classic and in-order processing
  • Merge pull request #81 from ubi-agni/jade-devel Thank you for your time and contributions. Improving cosmetics is important.
  • PEP8 cleanup
  • cmake: only copy files to devel space if new
  • Merge pull request #80 from ubi-agni/jade-devel
  • improved error-handling opening the output file - running multiple xacro process in parallel, all writing into a new dir could cause a race condition when creating the dir
    • improved error message on output creation failure
  • removed rospy dependency
    • Importing rospy caused build order issues with ros_comm in workspace
  • Filtering out REMAP command-line arguments is done manually now.
  • update authors/maintainers and copyright statements
  • deprecate non-namespaced xacro tags
  • added missing print_location_msg() for file that actually failed parsing
  • improved deprecation warnings
  • New cli option [--xacro-ns]{.title-ref} allows to enforce the new policy requiring the xacro namespace prefix (and suppressing deprecation warnings). However, non-prefixed tags will not be modified by xacro anymore (as requested by #41, #59, #60). Partially reverted cb73cfd8c678adfda2172accef398189ea2338a1, handling <arg> tags in the same fashion as other tags, i.e. issue a warning if used without prefix and ignoring it with cli argument [--xacro-ns]{.title-ref}.
  • fixed pr2 xacro files to use 'xacro:' prefixed tags only
  • fixed unittests in test_xacro.py to use 'xacro:' prefixed tags only
  • deprecation message for missing xacro namespace prefix in xml tags
  • moved colored warning messages into color.py (for reuseability)
  • added missing print_location_msg() for file that actually failed parsing
  • improved xacro's cmake macros
  • prepend ${PACKAGE_NAME} to all generated cmake targets Otherwise multiple packages employing xacro's cmake macros will use the same conflicting target name. This is only an issue with catkin_make, which defines a single global cmake namespace. The new catkin tools (or catkin_make_isolated) build each package separately.
  • basic unittest for xacro's cmake macros
  • improved xacro's cmake macros - xacro_add_xacro_file() automatically determines output file from input (removing .xacro suffix). If that fails, a fatal error is raised.
    • added xacro_install() to allow installation into both, devel and install space.
    • replaced conveniency function xacro_add_files()
  • Contributors: Robert Haschke

1.10.2 (2015-05-23)

  • added --debug option to explicitly enable stack traces By default, only show error message to the user. Stack traces are only interesting for xacro developers.
  • recursive include processing
    • more informed error messages (which file was included from where)

    - allows relative path names for include filename specs they are interpreted relative to the current file

  • new substitution command $(cwd) to extract current working directory
  • added unittest cases
    • creation of required subdirs for output
    • recursive xacro:include
    • extended test_include_glob() to check for all glob patterns
  • added run_xacro() function to simplify unittests running xacro script
  • moved xacro.py back to original location
  • nicely colored deprecation warning
  • create required dirs before opening output file
  • added convenience cmake-macro xacro_add_target() to auto-generate xacro-processed files
  • added cmake status message before launching xacro (xacro might run for quite a while)
  • fetch xacro --deps errors at report them as a warning
  • simplified deprecation message
  • added missing return statement
  • removed obsolete math import left over from deaaae2c69edd7d5e185eeb098c1521d8711608b
  • install xacro.py again (for backwards compatibility) usage of xacro.py issues a deprecation warning
  • simplified scripts/xacro - removed xacro.py
    • made run script "scripts/xacro" and install process follow standards
    • removed xacro.py

    - added dependencies to setup.py Having the binaries xacro and xacro.py installed side by side causes problems, because xacro.py is wrongly taken as the module. This was avoided by the rather complex filtering of the sys.path. Switched to ROS standard now, using a binary script called "xacro".

  • changed tests to use the whole xacro processing pipeline utilizing the modularization of main() from previous commit This simplifies several existing tests, especially these using files on disk.
  • split main() into process_cli_arg(), parse(), process_doc()
  • extended cmake macro xacro_add_xacro_file()
    • handle INORDER option
    • handle REMAP arguments

    - create absolute input file names automatically usage: xacro_add_xacro_file(input output INORDER REMAP ...)

  • stripped new unit tests to essential xml snippets
  • merged pull request #68: eval properties assigned from <arg> tags as literals In the following example: <xacro:arg name="val" default="0.5"/> <xacro:property name="val" value="$(arg val)"/> ${val} was not evaluated as a number, but as string only. Thus numerical expressions failed with an exception.
  • factored out get_boolean_value()
  • <xacro:arg> needs to be fully specified
  • (handling <arg> tags (without xacro ns-prefix) disabled native <arg> tags) add test for eating launch parameter arguments remove check for "arg" parameter. move new test function to bottom of source
  • added unit tests for evaluation of list, tuple, and dict literals
  • fixed some code style issues
  • fixed string-isinstance checks (for python 3 compatibility)
  • do not evaluate list, dict, tuple expressions as literals (without ${} syntax)
  • added dict to list of known global symbols
  • focused global_symbols definition in the beginning of the file added some basic python symbols: list, str, float, int and map allowing some basic computation
  • tuning performance: instantiate QuickLexer's regexps only once
  • Contributors: Robert Haschke, Martin Pecka, Mike O'Driscoll, Morgan Quigley

1.10.1 (2015-04-01)

  • improved error handling and more descriptive error messages
  • correctly raise a XacroException on invalid, i.e. non-boolean, <xacro:if> expressions. (removed left-over debugging code, added test case)
  • raise an exception on undefined, but used macros Using the syntax <xacro:macroname/> should raise an exception if macroname is not defined. Added appropriate code and a test case.
  • fixed bookkeeping in lazy evaluation switch Table.unevaluated from list to set to avoid multiple key entries
  • fix formatting of changelog
  • Contributors: Robert Haschke

1.10.0 (2015-03-13)

  • security measure: forbid access to __builtins__ in expressions
  • literal evaluation should only consider literals, but no expressions use ast.literal_eval()
  • removed eval() from xacro:if evaluation
  • back to string comparison to handle (lowercase) true and false
  • add test case for equality expressions in <xacro:if>
  • add test case for math function usage
  • python based evaluation of expressions
    • replaced handle_expr with python-internal eval() call
    • care has been taken to resolve variables recursively on demand (in Table.__getitem__)
    • allows for evaluation of standard math functions
    • other desired functions could be added in eval_self_contained
    • Values in Table symbols are not stored as strings but as typed values.
  • If text is required, a conversion with str() is performed, to ensure proper evaluation of expressions. Otherwise 3*"1" would evaluate to "111".
  • use __future__.division we can handle integer division evaluating to floating-point devision, as before
  • allow variable names for filename attribute in <xacro:include>
  • allow for ordered XML processing to avoid issues with multiply defined properties and macros in (typically 3rd party) include files
    • enable the new behaviour by passing --inorder cmdline option
    • to improve code readibility and reusability, introduced functions
  • process_include(node), grab_macro(elt, macros), grab_property(elt, symbols) containing 1:1 corresponding handling from process_includes, grab_macros, and grab_properties
    • added corresponding test case test_inorder_processing()
  • dynamic macro names using <xacro:call macro=""/>
  • fixup unittests and handling of non-element nodes in <include>, <if>, <macro>
  • updated pr2 gold standard to include all comments
  • allow to ignore comments in nodes_match()
  • New handling of non-element nodes invalidates pr2 gold standard (adding a lot more comments). To allow validation, allow to ignore all comments in comparison (as before).
  • fixed handling of non-element nodes in <include>, <if>, <macro>
  • fixed writexml: text nodes were not printed when other siblings exist
    • print all text, but skip whitespace-only text nodes
  • improved xml matching
    • so far only element nodes (with its attributes) were considered
    • now also consider TEXT, CDATA, and COMMENT nodes
    • added function text_matches (normalizing consecutive whitespace to a single space)
    • added some new unit tests

    - test_consider_non_elements: non-element nodes are not yet considered in <if> and <macro>

  • travis-ci: use catkin_make
  • travis-ci: fixup running of tests
  • fix pathnames used in test case
  • Include CATKIN_ENV params at build time.
  • use output filename flag instead of shell redirection
  • create output file after parsing is complete, not before
  • Contributors: Robert Haschke, Mike O'Driscoll, Morgan Quigley, William Woodall

1.9.3 (2015-01-14)

  • merge test cases
  • add a snapshot of the pr2 model to the test directory. add a test case which verifies that the pr2 model is parsed equal to a 'golden' parse of it.
  • add more tests
  • add default arg tests
  • Allow default values for substitution args
  • Fix up comments
  • Allow xacro macros to have default parameters
  • Contributors: Paul Bovbel, Morgan Quigley

1.9.2 (2014-07-11)

  • add a few more tests to exercise the symbol table a bit more
  • allow for recursive evaluation of properties in expressions
  • add useful debugging information when parameters are not set
  • stop test from failing the second time it is run
  • unified if/unless handling, correctly handle floating point expressions
  • floating point expressions not equal zero are now evaluated as True
  • changed quotes to omit cmake warning
  • Contributors: Robert Haschke, Mike Ferguson

1.9.1 (2014-06-21)

  • fixup tests so they run
  • export architecture_independent flag in package.xml
  • installed relocatable fix
  • Contributors: Michael Ferguson, Mike Purvis, Scott K Logan

1.9.0 (2014-03-28)

  • Remove the roslint_python glob, use the default one.
  • Add roslint target to xacro; two whitespace fixes so that it passes.
  • fix evaluation of integers in if statements also added a unit test, fixes #15
  • fix setting of _xacro_py CMake var, fixes #16
  • Add support for globbing multiple files in a single <xacro:include>
  • code cleanup and python3 support
  • check for CATKIN_ENABLE_TESTING

1.8.4 (2013-08-06)

  • Merge pull request #9 from davetcoleman/hydro-devel Xacro should not use plain 'include' tags but only namespaced ones.
  • Fix for the fact that minidom creates text nodes which count as child nodes
  • Removed <uri> checking and made it more general for any child element of an <include> tag
  • Removed Groovy reference, only being applied to Hydro
  • Created check for Gazebo's <uri> tabs only only shows deprecated warnings if not present.
  • Small spelling fix
  • Xacro should not use plain 'include' tags but only namespaced ones.
  • Merge pull request #8 from piyushk/hydro-devel-conditional xacro conditional blocks
  • using refined arguments instead of sys.argv for xml file location
  • adding conditional blocks to xacro

1.8.3 (2013-04-22)

  • bumped version to 1.8.3 for hydro release
  • backwards compatilibity with rosbuild
  • adding unit test for substitution args
  • Adding supoprt for substitution_args 'arg' fields
  • Remove bin copy of xacro.py
  • 1.7.3
  • Install xacro.py as a program so it can be run
  • 1.7.2
  • fixed build issues introduced in catkinization
  • 1.7.1
  • PEP8, cleanup, and remove roslib
  • Update copyright, self import guard, and catkinize
  • Catkinize.
  • Cleanup in preparation of catkinization.
  • Added tag unstable for changeset 169c4bf30367
  • Added tag xacro-1.6.1 for changeset fc45af7fdada
  • 1.6.1 marker
  • xacro: fuerte compat with sub args import
  • Added tag unstable for changeset 2d3c8dbfa3c9
  • Added tag xacro-1.6.0 for changeset e4a4455189bf
  • 1.6.0
  • converted to unary stack from common stack
  • xacro: fixed inserting property blocks (ros-pkg #4561)
  • xacro now uses XacroExceptions. String exceptions are not allowed in Python anymore. #4209
  • Added Ubuntu platform tags to manifest
  • Xacro now places comments below <?xml> tag (#3859)
  • Xacro prints out cleaner xml. Elements are now often separated by a newline.
  • xacro dependency on roslaunch removed #3451
  • Xacro now adds a message mentioning that the file was autogenerated (#2775)
  • Remove use of deprecated rosbuild macros
  • Integers stay integers in xacro, fixing #3287
  • Tests for r25868
  • Added a flag for only evaluating include tags in xacro
  • Allowing multiple blocks and multiple insert_blocks, fixing #3322 and #3323
  • doc review completed for xacro
  • adding mainpage for xacro doc review
  • Added xacro.cmake file that exports new xacro_add_xacro_file() macro, #3020
  • Namespaced "include" tag in xacro
  • Marked xacro as api reviewed
  • Xacro now correctly declares the namespaces of the included documents in the final
  • Made xacro accept xml namespaces
  • Xacro now errors hard when a property is used without being declared
  • Xacro no longer allows you to create properties with "${}" in the name
  • Added the ability to escape "${" in xacro
  • Made the tests in xacro run again.
  • Created xacro/src
  • migration part 1

Wiki Tutorials

This package does not provide any links to tutorials in it's rosindex metadata. You can check on the ROS Wiki Tutorials page for the package.

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

No plugins found.

Recent questions tagged xacro at Robotics Stack Exchange

xacro package from xacro repo

xacro

Package Summary

Tags No category tags.
Version 2.0.11
License BSD
Build type AMENT_CMAKE
Use RECOMMENDED

Repository Summary

Checkout URI https://github.com/ros/xacro.git
VCS Type git
VCS Version ros2
Last Updated 2024-11-13
Dev Status MAINTAINED
CI status No Continuous Integration
Released RELEASED
Tags No category tags.
Contributing Help Wanted (0)
Good First Issues (0)
Pull Requests to Review (0)

Package Description

Xacro (XML Macros) Xacro is an XML macro language. With xacro, you can construct shorter and more readable XML files by using macros that expand to larger XML expressions.

Additional Links

Maintainers

  • Robert Haschke
  • Morgan Quigley

Authors

  • Stuart Glaser
  • William Woodall
  • Robert Haschke

Xacro (XML Macros)

Xacro is an XML macro language

With xacro, you can construct shorter and more readable XML files by using macros that expand to larger XML expressions. Recent documentation can be found in the wiki. For older releases, have a look at the ROS wiki.

CHANGELOG

Changelog for package xacro

2.0.11 (2024-04-02)

  • Allow substitution args without ROS (#340)
  • Add more unit tags for yaml files (#331)
  • Resolve $(find ...) as a result of a substitution argument (#339)
  • Mark regexes as raw strings (#336)
  • Add pyproject.toml for direct installation via pip (#329)
  • Contributors: Adam Heins, Bruno-Pier, Carlo Rizzardo, Lukas Huber, Robert Haschke

2.0.10 (2024-01-25)

  • Expose python.abs()
  • Fix hasattr support of YamlDictWrapper (#324)
  • Contributors: Robert Haschke

2.0.9 (2023-02-27)

  • Evaluate arg value as str/unicode (#322)
  • Contributors: Robert Haschke

2.0.8 (2022-10-22)

  • Install xacro using console_script entrypoint (#304)
  • Provide xacro.process() returning the processed file (#229)
  • Dotted YAML access from list iterator (#318)
  • Optionally allow comment evaluation (#310)

    Comment evaluation can be enabled with a special comment:

    • <!-- xacro:eval-comments --> or
    • <!-- xacro:eval-comments:on -->

    It remains active for the following comments until:

    • the current XML tag's scope is left (or a new tag entered)
    • another tag or non-whitespace text is processed
    • it becomes explicitly disabled via: <!-- xacro:eval-comments:off -->
  • Fix property resolution with namespace usage (#308)
    • Allow access to properties in parent scopes again (fixes #305)
    • Pick correct scope when defining a property into the parent (fixes #307)

      Setting a property within the parent scope may occur in two contexts:

      1. From within a macro. In that case, one wants to set the property in the caller's scope.
      2. From within the included file. In that case, one wants to set the property in the includer's scope.
  • Contributors: Chen Bainian, Gonzalo de Pedro, Gonzo, Jacob Perron, Melvin Wang, Robert Haschke, vandanamandlik

2.0.7 (2021-09-04)

  • Allow more builtin symbols: sorted, set
  • Don't import hidden symbols from math package
  • Fix eval security vulnerability
    • safe_eval()
    • unit tests validating the protection mechanism
  • Generalize yaml !degrees constructors: Enable expressions as well
  • Improve macro arg parsing (#278) to support:
    • $(substitution args)
    • ${python expressions}
    • single or double quoting of spaces
  • Contributors: Robert Haschke

2.0.6 (2021-05-30)

  • [feature] Expose YamlDictWrapper as dotify() to allow dotted access to any dict (#274)
  • [fix] Scoped macro evaluation (#272)
  • Contributors: Robert Haschke

2.0.5 (2021-03-02)

  • [fix] Report correct filename for XML errors (#268)
  • [fix] Python3-compatible property Table (#266)
  • [fix] Use outer-scope symbols to resolve include filename in xacro:include (#264)
  • [fix] Append test directory to existing AMENT_PREFIX_PATH (#260)
  • [fix] yaml loading: recursively wrap lists and dicts for dotted dict access (#258)
  • [feature] Provide support for yaml constructors !degrees and !radians (#252)
  • Contributors: Chen Bainian, Robert Haschke, G.A. vd. Hoorn

2.0.3 (2020-08-09)

  • Merge improvements of melodic and noetic branches into dashing-devel: see 1.14.2 and 1.14.3 for details
  • Contributors: Robert Haschke

2.0.2 (2020-03-29)

  • Merge improvements of melodic and noetic branches into dashing-devel: see 1.14.1, 1.13.5 for details
  • Contributors: Robert Haschke

2.0.1 (2019-10-06)

  • Revert requiring that all xacro commands are prefixed with 'xacro:' namespace Although this is deprecated since #79, the corresponding deprecation warning wasn't actually issued. Thus, we will accept non-prefixed xacro tags until F-turtle.
  • Install to both, bin/xacro and lib/xacro/xacro
  • Contributors: Robert Haschke

2.0.0 (2019-09-28)

  • PEP8 cleanup
    • code simplifications
    • avoid empty except
    • sort imports
    • format line breaks
  • Code cleanup
    • Removed deprecated options --legacy, --inorder, --check-order, --includes
    • Require all xacro commands to be prefixed with 'xacro:'
    • Added missing copyright notices
    • Removed python2 stuff
  • Adapt Travis config to use colcon
  • Provide ROS2-based replacement for substition args
  • Modified package structure as per ROS2 rules
    • Using ament_cmake
    • Moved source contents from "src/xacro" to "xacro"
    • Modified package.xml and setup.py according to ROS2 requirements
    • Configured completion hook
    • Removed catkin artifacts from cmake extension
  • Contributors: vandanamandlik, Jacob Perron, Robert Haschke

1.14.4 (2020-08-09)

  • [fix] Rework YamlDictWrapper to restore dict properties (#250)
  • [fix] Ignore underscores when parsing literal numeric values (#247)
  • Contributors: Robert Haschke

1.14.3 (2020-07-05)

  • [feature] Improve warnings
    • Unify meaning of verbosity > 0 (to print file location)
    • Provide file location on warning in check_attrs()
    • Issue warning on child elements of <xacro:include> tag
  • [feature] Allow dotted access to yaml-loaded dicts: d.key1.key2.key3 (#245)
  • [maint] Travis: Update distro to Bionic
  • Contributors: Robert Haschke, G.A. vd. Hoorn

1.14.2 (2020-05-21)

  • [maintanence] Remove deprecated xacro.py (#239)
  • Contributors: Shane Loretz

1.14.1 (2020-03-29)

  • [feature] allow optional xacro includes (#234)
  • Contributors: Robert Haschke

1.13.5 (2019-12-08)

  • [feature] Expose abs_filename() (#220)
  • [feature] Catch missing closing brace in $() and ${} expressions
  • [maintanence]
    • Replace deprecated yaml.load() -> yaml.safe_load()
    • Save macro names internally w/o 'xacro:' prefix
    • Correctly issue deprecation warning for non-prefixed xacro tags
  • Contributors: Robert Haschke

1.13.4 (2019-09-26)

  • [feature] remove xmlns:xacro from processed file (#207)
    • Remove all notions of xmlns:xacro from the resulting document.
    • If the root node defines a xacro:targetNamespace attribute, this will become the global xmlns namespace of the resulting document.
  • [feature] Add len() to allowed python functions (#208)
  • [maintanence]
    • --in-order warning: reduce severity level to message
    • fix and cleanup test of cmake extensions
    • adapt run_xacro() to run xacro from PATH
    • simplify import of substition_args
    • remove 'requires' field from setup.py
    • fix Travis config: use new repository key, use xenial/kinetic distro
    • basic README.md
    • fix catkin_lint issue
    • remove duplicate catkin_python_setup() (#206)
  • Contributors: Robert Haschke, James Xu, Martin Pecka

1.13.3 (2018-10-14)

  • use INORDER as default in cmake functions
  • remove weird 'None's in error messages
  • Contributors: Robert Haschke

1.13.2 (2018-05-14)

  • deprecate --includes option (which is tied to deprecated --legacy processing)
  • moved all option handling to cli.py, including deprecation warnings for options
  • Contributors: Robert Haschke

1.13.1 (2018-05-03)

  • fix parsing of quoted strings in default args for xacro params (#187)
  • Contributors: Robert Haschke

1.13.0 (2018-03-31)

  • make --inorder processing the default
  • Contributors: Robert Haschke

1.12.1 (2018-03-28)

  • #183: unicode support for python2 and python3
  • #178: extend list of allowed python builtins: min, max, round
  • #182: suppress xacro warnings when determining dependencies
  • #151: fixes for #149 and #148
  • #157: fix #156 access to undefined target_table
  • #150: allow True/False literals in python expressions
  • #159: load ROS-related packages on demand, thus becoming more independent from ROS
  • #173: allow default values for properties
  • #172: fix formatting of XacroException
  • #171: fix dependency handling (--deps option)
  • #163: full python 3 compatibility
  • Contributors: Robert Haschke, Kartik Mohta, Morgan Quigley, Steven Peters

1.12.0 (2017-03-25)

1.11.2 (2017-02-27)

  • Convert exception to string in a python2/3 compatible way.
  • Use python2/3 independent check for file type.
  • Contributors: Hans Gaiser, Maarten de Vries

1.11.1 (2016-06-22)

  • workaround for xml.dom.minidom issue
  • ensure non-empty error string
  • Contributors: Robert Haschke

1.11.0 (2016-03-25)

  • added short option -i as alternative to --inorder
  • refactored main to fix #122, #107
  • added xacro indicator to error message to fix #123
  • moved banner generation to process_file()
  • removed special (but obsolete) output handling for just_includes mode
  • moved core processing pipeline into function process_file()
  • improved documentation: more comments, input_file -> input_file_name
  • fix #120: handle non-space whitespace characters in params string
  • extended tests to handle non-space whitespace characters in params string
  • always store macros with xacro: prefix in front: #118
  • fix #115: enforce xacro namespace usage with --xacro-ns option
  • apply correct checking for include tags, and extend testcase
  • allow (one-level) nested expression/extension evaluation
  • Contributors: Robert Haschke, Morgan Quigley

1.10.6 (2015-09-01)

  • use correct catkin environment for cmake dependency checking
  • fixed dependency definition for cmake usage
  • Contributors: Robert Haschke

1.10.5 (2015-08-12)

  • fix #108: evaluate property blocks recursively too
  • improved macro parameter parsing
  • use a regular expression to parse a param spec with forwarding and default
  • allow for spaces in default string (within single quotes)
  • forwarding macro arguments from outer scope
  • switched to [\^|]{.title-ref} syntax
  • use more compact [$|]{.title-ref} syntax
  • moved parsing of argument defaults to grab_macro()
  • explicit forwarding of properties to macro scope
  • replace silent/implicit forwarding of properties from outer scope to macro scope by an explicit "call" to a [forward(<name>[,<default>])]{.title-ref} function.
  • implicit forwarding of outer-scope properties to macro args (#100)
  • property evaluation fixes
  • suppress double evaluation of properties
  • adapted unittest to cover the fixed issue
  • fixed evaluation order for properties exported to parent or global scope
  • Merge pull request #103 from ubi-agni/overwrite-check issue warning when attempting to overwrite existing global property
  • fixed unittest: avoid overwrite warning
  • warn when overwriting any globally defined variable
  • Merge pull request #102 from ubi-agni/completion bash completion
  • Merge pull request #99 from ubi-agni/jade-devel reworked macro resolution
  • moved test_macro_name_with_colon() to class TestXacro should be tested both, in oldorder and inorder mode
  • bash completion
  • improved error message for failed $(find)
  • reworked macro resolution python-eval-based macro resolution (introduced to enable namespaces) heavily restricted the set of possible macro names (only valid python identifiers were allowed) Particularly, xacro: prefixed macro names were forbidden.
  • initial attempt to fix #97
  • add failing test case with colon in the macro name
  • Contributors: Robert Haschke

1.10.4 (2015-06-18)

  • removed test_DEPRECATED_should_replace_before_macroexpand() duplicates test_should_replace_before_macroexpand()
  • fixed evaluation order of macro arguments and body Macro arguments need to be evaluated and assigned to properties before body is evaluated. Otherwise, the evaluated value will be converted to str, i.e. loosing original type.
  • Contributors: Robert Haschke

1.10.3 (2015-06-16)

  • deprecate --oldorder processing
  • added --check-order option to do a simple check for --inorder compatibility
    • Most probable incompatibility is redefining a property after its usage.
    • tested and reported with file location of (first) redefinition after usage.
  • moved command line processing to cli.py
  • explain verbosity levels in usage string
  • colorize errors during cli parsing
  • log definition and usage of properties
  • replaced debug option by verbosity options -q, -v
  • fixed evaluation time of default macro params
  • introduced Macro object to increase code readability
  • parse a macro's parameter list once at declaration time (instead of every instantiation)
  • extended test_multiple_blocks() to check for both normal and reversed order
  • added unittest to increase code coverage
  • do not issue deprecation warning for <include> tags that are non-xacro
  • added option --oldorder
  • allow to store properties to parent or global scope
  • added <xacro:attribute>
  • cleaned up error message about missing files
  • moved xml-specific functions to xmlutils.py new generic functions opt_attrs(), reqd_attrs(), and check_attrs() to fetch optional and required attributes and warn about unknown ones in a uniform fashion
  • unittest to allow empty <arg> defaults
  • Merge pull request #94 from ubi-agni/minor-fixes
  • minor fixes
  • remove duplicates in --deps output
  • fixed dependency checking for --inorder mode (which requires full processing)
  • fixed doc of xacro' cmake macros
  • renamed "xacro:rename" to "xacro:element"
  • allow namespacing for xacro:include's
  • allow renaming of element names using xacro:rename
  • unittest cleanup
  • check property and macro names to be valid python identifiers
  • allow namespacing of xacro:include's
  • properties and macros in an included file will go into their own, separate namespace, if the XML attribute [ns]{.title-ref} is provided. Access is by standard python syntax: namespace.name
  • allow renaming of element names <xacro:rename xacro:name="<new element name>"/>
  • moved unittests requiring --inorder processing to class TestXacroInorder
  • added unittest test_dynamic_macro_undefined()
  • improved error message when variable include filename is used without --inorder
  • stripped down unittest test_inorder_processing()
  • improved processing
  • adapted pr2 gold standard removing most comments again this partially reverts 59605fb1521583dc63efdea13f4c45128499bd20
  • remove all XML comments directly before xacro elements (These are considered xacro-related only and should be removed in the final doc.) Leaving an empty line between xacro-unrelated and xacro-related comments allows to include the former.
  • unittest: test_ignore_xacro_comments()
  • improved processing
    • recursive (instead of iterative) eval_all()
    • reusable process_include()
    • replace_node() function to replace xacro tag by some other content
    • avoid reprocessing of nodes
    • avoid deep copy where possible (speedup)
  • fix evaluation (#83)
  • yaml support
  • check for consistency of xml namespaces on xacro:include
  • replaced strip()=='' by more efficient isspace()
  • allow transitive definition of substition args
  • fixed evaluation of literals in property definitions
    • literals with preceding whitespace will be silently stripped (#83)
    • more complex evaluation test (perturbing spaces added)
  • fixed xacro namespaces in pr2 files to get rid of new inconsistency warning
  • warning message on inconsistent namespace redefinition for includes
  • yaml support ${load_yaml('file.yaml')} to load dict from yaml file
  • Merge pull request #85 from ubi-agni/error-reporting improved error reporting
  • nicer formatting of multiple "when evaluating expression" lines
  • improved formatting of error messages use XacroException to wrap and augment other exceptions to achieve a clearer error formatting
  • better error message for missing substitution args
  • use colorized warnings where possible
  • included macro stack in error-reporting
  • maintain filestack to facilitate error reporting at any time
  • Merge pull request #82 from ubi-agni/unittests improved unittesting
  • allow to capture (and check) stderr in unit tests
  • improved unittests to test both, classic and in-order processing
  • Merge pull request #81 from ubi-agni/jade-devel Thank you for your time and contributions. Improving cosmetics is important.
  • PEP8 cleanup
  • cmake: only copy files to devel space if new
  • Merge pull request #80 from ubi-agni/jade-devel
  • improved error-handling opening the output file - running multiple xacro process in parallel, all writing into a new dir could cause a race condition when creating the dir
    • improved error message on output creation failure
  • removed rospy dependency
    • Importing rospy caused build order issues with ros_comm in workspace
  • Filtering out REMAP command-line arguments is done manually now.
  • update authors/maintainers and copyright statements
  • deprecate non-namespaced xacro tags
  • added missing print_location_msg() for file that actually failed parsing
  • improved deprecation warnings
  • New cli option [--xacro-ns]{.title-ref} allows to enforce the new policy requiring the xacro namespace prefix (and suppressing deprecation warnings). However, non-prefixed tags will not be modified by xacro anymore (as requested by #41, #59, #60). Partially reverted cb73cfd8c678adfda2172accef398189ea2338a1, handling <arg> tags in the same fashion as other tags, i.e. issue a warning if used without prefix and ignoring it with cli argument [--xacro-ns]{.title-ref}.
  • fixed pr2 xacro files to use 'xacro:' prefixed tags only
  • fixed unittests in test_xacro.py to use 'xacro:' prefixed tags only
  • deprecation message for missing xacro namespace prefix in xml tags
  • moved colored warning messages into color.py (for reuseability)
  • added missing print_location_msg() for file that actually failed parsing
  • improved xacro's cmake macros
  • prepend ${PACKAGE_NAME} to all generated cmake targets Otherwise multiple packages employing xacro's cmake macros will use the same conflicting target name. This is only an issue with catkin_make, which defines a single global cmake namespace. The new catkin tools (or catkin_make_isolated) build each package separately.
  • basic unittest for xacro's cmake macros
  • improved xacro's cmake macros - xacro_add_xacro_file() automatically determines output file from input (removing .xacro suffix). If that fails, a fatal error is raised.
    • added xacro_install() to allow installation into both, devel and install space.
    • replaced conveniency function xacro_add_files()
  • Contributors: Robert Haschke

1.10.2 (2015-05-23)

  • added --debug option to explicitly enable stack traces By default, only show error message to the user. Stack traces are only interesting for xacro developers.
  • recursive include processing
    • more informed error messages (which file was included from where)

    - allows relative path names for include filename specs they are interpreted relative to the current file

  • new substitution command $(cwd) to extract current working directory
  • added unittest cases
    • creation of required subdirs for output
    • recursive xacro:include
    • extended test_include_glob() to check for all glob patterns
  • added run_xacro() function to simplify unittests running xacro script
  • moved xacro.py back to original location
  • nicely colored deprecation warning
  • create required dirs before opening output file
  • added convenience cmake-macro xacro_add_target() to auto-generate xacro-processed files
  • added cmake status message before launching xacro (xacro might run for quite a while)
  • fetch xacro --deps errors at report them as a warning
  • simplified deprecation message
  • added missing return statement
  • removed obsolete math import left over from deaaae2c69edd7d5e185eeb098c1521d8711608b
  • install xacro.py again (for backwards compatibility) usage of xacro.py issues a deprecation warning
  • simplified scripts/xacro - removed xacro.py
    • made run script "scripts/xacro" and install process follow standards
    • removed xacro.py

    - added dependencies to setup.py Having the binaries xacro and xacro.py installed side by side causes problems, because xacro.py is wrongly taken as the module. This was avoided by the rather complex filtering of the sys.path. Switched to ROS standard now, using a binary script called "xacro".

  • changed tests to use the whole xacro processing pipeline utilizing the modularization of main() from previous commit This simplifies several existing tests, especially these using files on disk.
  • split main() into process_cli_arg(), parse(), process_doc()
  • extended cmake macro xacro_add_xacro_file()
    • handle INORDER option
    • handle REMAP arguments

    - create absolute input file names automatically usage: xacro_add_xacro_file(input output INORDER REMAP ...)

  • stripped new unit tests to essential xml snippets
  • merged pull request #68: eval properties assigned from <arg> tags as literals In the following example: <xacro:arg name="val" default="0.5"/> <xacro:property name="val" value="$(arg val)"/> ${val} was not evaluated as a number, but as string only. Thus numerical expressions failed with an exception.
  • factored out get_boolean_value()
  • <xacro:arg> needs to be fully specified
  • (handling <arg> tags (without xacro ns-prefix) disabled native <arg> tags) add test for eating launch parameter arguments remove check for "arg" parameter. move new test function to bottom of source
  • added unit tests for evaluation of list, tuple, and dict literals
  • fixed some code style issues
  • fixed string-isinstance checks (for python 3 compatibility)
  • do not evaluate list, dict, tuple expressions as literals (without ${} syntax)
  • added dict to list of known global symbols
  • focused global_symbols definition in the beginning of the file added some basic python symbols: list, str, float, int and map allowing some basic computation
  • tuning performance: instantiate QuickLexer's regexps only once
  • Contributors: Robert Haschke, Martin Pecka, Mike O'Driscoll, Morgan Quigley

1.10.1 (2015-04-01)

  • improved error handling and more descriptive error messages
  • correctly raise a XacroException on invalid, i.e. non-boolean, <xacro:if> expressions. (removed left-over debugging code, added test case)
  • raise an exception on undefined, but used macros Using the syntax <xacro:macroname/> should raise an exception if macroname is not defined. Added appropriate code and a test case.
  • fixed bookkeeping in lazy evaluation switch Table.unevaluated from list to set to avoid multiple key entries
  • fix formatting of changelog
  • Contributors: Robert Haschke

1.10.0 (2015-03-13)

  • security measure: forbid access to __builtins__ in expressions
  • literal evaluation should only consider literals, but no expressions use ast.literal_eval()
  • removed eval() from xacro:if evaluation
  • back to string comparison to handle (lowercase) true and false
  • add test case for equality expressions in <xacro:if>
  • add test case for math function usage
  • python based evaluation of expressions
    • replaced handle_expr with python-internal eval() call
    • care has been taken to resolve variables recursively on demand (in Table.__getitem__)
    • allows for evaluation of standard math functions
    • other desired functions could be added in eval_self_contained
    • Values in Table symbols are not stored as strings but as typed values.
  • If text is required, a conversion with str() is performed, to ensure proper evaluation of expressions. Otherwise 3*"1" would evaluate to "111".
  • use __future__.division we can handle integer division evaluating to floating-point devision, as before
  • allow variable names for filename attribute in <xacro:include>
  • allow for ordered XML processing to avoid issues with multiply defined properties and macros in (typically 3rd party) include files
    • enable the new behaviour by passing --inorder cmdline option
    • to improve code readibility and reusability, introduced functions
  • process_include(node), grab_macro(elt, macros), grab_property(elt, symbols) containing 1:1 corresponding handling from process_includes, grab_macros, and grab_properties
    • added corresponding test case test_inorder_processing()
  • dynamic macro names using <xacro:call macro=""/>
  • fixup unittests and handling of non-element nodes in <include>, <if>, <macro>
  • updated pr2 gold standard to include all comments
  • allow to ignore comments in nodes_match()
  • New handling of non-element nodes invalidates pr2 gold standard (adding a lot more comments). To allow validation, allow to ignore all comments in comparison (as before).
  • fixed handling of non-element nodes in <include>, <if>, <macro>
  • fixed writexml: text nodes were not printed when other siblings exist
    • print all text, but skip whitespace-only text nodes
  • improved xml matching
    • so far only element nodes (with its attributes) were considered
    • now also consider TEXT, CDATA, and COMMENT nodes
    • added function text_matches (normalizing consecutive whitespace to a single space)
    • added some new unit tests

    - test_consider_non_elements: non-element nodes are not yet considered in <if> and <macro>

  • travis-ci: use catkin_make
  • travis-ci: fixup running of tests
  • fix pathnames used in test case
  • Include CATKIN_ENV params at build time.
  • use output filename flag instead of shell redirection
  • create output file after parsing is complete, not before
  • Contributors: Robert Haschke, Mike O'Driscoll, Morgan Quigley, William Woodall

1.9.3 (2015-01-14)

  • merge test cases
  • add a snapshot of the pr2 model to the test directory. add a test case which verifies that the pr2 model is parsed equal to a 'golden' parse of it.
  • add more tests
  • add default arg tests
  • Allow default values for substitution args
  • Fix up comments
  • Allow xacro macros to have default parameters
  • Contributors: Paul Bovbel, Morgan Quigley

1.9.2 (2014-07-11)

  • add a few more tests to exercise the symbol table a bit more
  • allow for recursive evaluation of properties in expressions
  • add useful debugging information when parameters are not set
  • stop test from failing the second time it is run
  • unified if/unless handling, correctly handle floating point expressions
  • floating point expressions not equal zero are now evaluated as True
  • changed quotes to omit cmake warning
  • Contributors: Robert Haschke, Mike Ferguson

1.9.1 (2014-06-21)

  • fixup tests so they run
  • export architecture_independent flag in package.xml
  • installed relocatable fix
  • Contributors: Michael Ferguson, Mike Purvis, Scott K Logan

1.9.0 (2014-03-28)

  • Remove the roslint_python glob, use the default one.
  • Add roslint target to xacro; two whitespace fixes so that it passes.
  • fix evaluation of integers in if statements also added a unit test, fixes #15
  • fix setting of _xacro_py CMake var, fixes #16
  • Add support for globbing multiple files in a single <xacro:include>
  • code cleanup and python3 support
  • check for CATKIN_ENABLE_TESTING

1.8.4 (2013-08-06)

  • Merge pull request #9 from davetcoleman/hydro-devel Xacro should not use plain 'include' tags but only namespaced ones.
  • Fix for the fact that minidom creates text nodes which count as child nodes
  • Removed <uri> checking and made it more general for any child element of an <include> tag
  • Removed Groovy reference, only being applied to Hydro
  • Created check for Gazebo's <uri> tabs only only shows deprecated warnings if not present.
  • Small spelling fix
  • Xacro should not use plain 'include' tags but only namespaced ones.
  • Merge pull request #8 from piyushk/hydro-devel-conditional xacro conditional blocks
  • using refined arguments instead of sys.argv for xml file location
  • adding conditional blocks to xacro

1.8.3 (2013-04-22)

  • bumped version to 1.8.3 for hydro release
  • backwards compatilibity with rosbuild
  • adding unit test for substitution args
  • Adding supoprt for substitution_args 'arg' fields
  • Remove bin copy of xacro.py
  • 1.7.3
  • Install xacro.py as a program so it can be run
  • 1.7.2
  • fixed build issues introduced in catkinization
  • 1.7.1
  • PEP8, cleanup, and remove roslib
  • Update copyright, self import guard, and catkinize
  • Catkinize.
  • Cleanup in preparation of catkinization.
  • Added tag unstable for changeset 169c4bf30367
  • Added tag xacro-1.6.1 for changeset fc45af7fdada
  • 1.6.1 marker
  • xacro: fuerte compat with sub args import
  • Added tag unstable for changeset 2d3c8dbfa3c9
  • Added tag xacro-1.6.0 for changeset e4a4455189bf
  • 1.6.0
  • converted to unary stack from common stack
  • xacro: fixed inserting property blocks (ros-pkg #4561)
  • xacro now uses XacroExceptions. String exceptions are not allowed in Python anymore. #4209
  • Added Ubuntu platform tags to manifest
  • Xacro now places comments below <?xml> tag (#3859)
  • Xacro prints out cleaner xml. Elements are now often separated by a newline.
  • xacro dependency on roslaunch removed #3451
  • Xacro now adds a message mentioning that the file was autogenerated (#2775)
  • Remove use of deprecated rosbuild macros
  • Integers stay integers in xacro, fixing #3287
  • Tests for r25868
  • Added a flag for only evaluating include tags in xacro
  • Allowing multiple blocks and multiple insert_blocks, fixing #3322 and #3323
  • doc review completed for xacro
  • adding mainpage for xacro doc review
  • Added xacro.cmake file that exports new xacro_add_xacro_file() macro, #3020
  • Namespaced "include" tag in xacro
  • Marked xacro as api reviewed
  • Xacro now correctly declares the namespaces of the included documents in the final
  • Made xacro accept xml namespaces
  • Xacro now errors hard when a property is used without being declared
  • Xacro no longer allows you to create properties with "${}" in the name
  • Added the ability to escape "${" in xacro
  • Made the tests in xacro run again.
  • Created xacro/src
  • migration part 1

Wiki Tutorials

This package does not provide any links to tutorials in it's rosindex metadata. You can check on the ROS Wiki Tutorials page for the package.

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

No plugins found.

Recent questions tagged xacro at Robotics Stack Exchange

xacro package from xacro repo

xacro

Package Summary

Tags No category tags.
Version 1.14.18
License BSD
Build type CATKIN
Use RECOMMENDED

Repository Summary

Checkout URI https://github.com/ros/xacro.git
VCS Type git
VCS Version noetic-devel
Last Updated 2024-07-19
Dev Status MAINTAINED
CI status
Released RELEASED
Tags No category tags.
Contributing Help Wanted (0)
Good First Issues (0)
Pull Requests to Review (0)

Package Description

Xacro (XML Macros) Xacro is an XML macro language. With xacro, you can construct shorter and more readable XML files by using macros that expand to larger XML expressions.

Additional Links

Maintainers

  • Robert Haschke
  • Morgan Quigley

Authors

  • Stuart Glaser
  • William Woodall
  • Robert Haschke

Xacro (XML Macros)

Xacro is an XML macro language

With xacro, you can construct shorter and more readable XML files by using macros that expand to larger XML expressions. Recent documentation can be found in the wiki. For older releases, have a look at the ROS wiki.

CHANGELOG

Changelog for package xacro

1.14.18 (2024-04-02)

  • Add more unit tags for yaml files (#331)
  • Mark regexes as raw strings (#336)
  • Contributors: Adam Heins, Bruno-Pier

1.14.17 (2024-01-25)

  • Expose python.abs()
  • Contributors: Robert Haschke

1.14.16 (2023-05-24)

  • Fix hasattr support of YamlDictWrapper (#324)
  • Contributors: Alec Tiefenthal, Robert Haschke

1.14.15 (2023-02-27)

  • Evaluate arg value as str/unicode (#322)
  • Remove obsolete options from completion
  • Contributors: Robert Haschke

1.14.14 (2022-10-21)

  • Dotted YAML access from list iterator (#318)
  • Link to extended wiki
  • Contributors: Robert Haschke

1.14.13 (2022-02-12)

  • Only optionally activate comment evaluation (#310)

    Comment evaluation can be enabled with a special comment:

    • <!-- xacro:eval-comments --> or
    • <!-- xacro:eval-comments:on -->

    It remains active for the following comments until:

    • the current XML tag's scope is left (or a new tag entered)
    • another tag or non-whitespace text is processed
    • it becomes explicitly disabled via: <!-- xacro:eval-comments:off -->
  • Fix property resolution with namespace usage (#308)
    • Allow access to properties in parent scopes again (fixes #305)
    • Pick correct scope when defining a property into the parent (fixes #307)

      Setting a property within the parent scope may occur in two contexts:

      1. From within a macro. In that case, one wants to set the property in the caller's scope.
      2. From within the included file. In that case, one wants to set the property in the includer's scope.
  • Contributors: Robert Haschke

1.14.12 (2022-01-30)

  • Issue a warning only for evaluation errors in comments
  • Add LICENSE file
  • Contributors: Robert Haschke

1.14.11 (2022-01-20)

  • Fix resolving of macros and properties declared and used in/from a namespace (#297, #306)

    Macros and properties that are declared within a namespaced include shouldn't require the namespace prefix when used within the namespace.

  • Perform expression evaluation in comments (#300)
  • Expose xacro.arg() to facilitate access to substitution args
  • Fix scoped macro evaluation
    • Replace [Macro|Property]NameSpace with common NameSpace class derived from Table
    • Use the scoped macro Table
  • Contributors: Robert Haschke

1.14.10 (2021-10-02)

  • Allow property names to be evaluated from an expression This allows to turn macros into a function that can compute an arbitrary property:

    <xacro:macro name="square" params="name args">
      <!-- Perform some complex computation and set the property within the parent's scope -->
      <xacro:property name="${name}" value="${[float(x)**2 for x in args]}" scope="parent" />
    </xacro:macro>
    <xacro:square name="result" args="${python.range(5)}" />
    
  • Fix error reporting for invalid symbols in NameSpaces
  • Allow removal of a property definition (#288)

    <xacro:property name="prop" remove="true"/>

  • Allow greedy property evaluation (#284) This can be used, to redefine a property from its previous value, e.g. for normalization:

    <xacro:property name="prop" value="${prop.lower()}" lazy_eval="false"/>
    
  • Correctly expose XML namespaces imported via xacro:include within a macro (#287)
  • Throw when attempting to declare a property starting with double underscore (#286)
  • Improve global symbols (#283)
    • Expose most builtin symbols of python
    • Expose xacro functions into xacro namespace
      • xacro.print_location() to print the current filestack
      • tokenize(string, sep=',; ', skip_empty=True) to facilitate string tokenization
      • message(), warning(), error(), and fatal() to output messages on stderr. All but message() print the error location (macro call and file hierarchy) by default:

        ${xacro.message('message', 'text', 2, 3.14, color=32, print_location=True)}
        ${xacro.warning('warning')}
        ${xacro.error('error', print_location=False)}
        ${xacro.fatal('fatal')}
        
    • Rework handling of file and macro stack, such that print_location() works from anywhere
    • Unit tests: Reduce reported stdout/stderr output
    • Rework definition of global_symbols to expose functions into namespaces python, math, xacro
  • Contributors: Robert Haschke

1.14.9 (2021-09-03)

  • Allow more builtin symbols: sorted, set
  • Don't import hidden symbols from math package
  • Fix eval() security vulnerability
    • safe_eval(): Forbid symbol names starting with double underscore
    • unit tests validating the protection mechanism
  • Generalize yaml !degrees constructor: Enable expressions as well
  • Contributors: Robert Haschke

1.14.8 (2021-07-19)

  • Improve macro arg parsing (#278) to support:
    • $(substitution args)
    • ${python expressions}
    • single or double quoting of spaces
  • Contributors: Robert Haschke

1.14.7 (2021-05-30)

  • [feature] Expose YamlDictWrapper as dotify() to allow dotted access to any dict (#274)
  • [fix] Scoped macro evaluation (#272)
  • Contributors: Robert Haschke

1.14.6 (2021-03-02)

  • [fix] Report correct filename for XML errors (#268)
  • [fix] Python3-compatible property Table (#266)
  • [fix] Use outer-scope symbols to resolve include filename in xacro:include (#264)
  • Contributors: Robert Haschke

1.14.5 (2020-10-13)

  • [fix] yaml loading: recursively wrap lists and dicts for dotted dict access (#258)
  • [feature] Provide support for yaml constructors !degrees and !radians (#252)
  • Contributors: Robert Haschke, G.A. vd. Hoorn

1.14.4 (2020-08-09)

  • [fix] Rework YamlDictWrapper to restore dict properties (#250)
  • [fix] Ignore underscores when parsing literal numeric values (#247)
  • Contributors: Robert Haschke

1.14.3 (2020-07-05)

  • [feature] Improve warnings
    • Unify meaning of verbosity > 0 (to print file location)
    • Provide file location on warning in check_attrs()
    • Issue warning on child elements of <xacro:include> tag
  • [feature] Allow dotted access to yaml-loaded dicts: d.key1.key2.key3 (#245)
  • [maint] Travis: Update distro to Bionic
  • Contributors: Robert Haschke, G.A. vd. Hoorn

1.14.2 (2020-05-21)

  • [maintanence] Remove deprecated xacro.py (#239)
  • Contributors: Shane Loretz

1.14.1 (2020-03-29)

  • [feature] allow optional xacro includes (#234)
  • [maintanence] Use setuptools instead of distutils (#233)
  • [maintanence] fix Travis: export correct ROS_PYTHON_VERSION
  • Contributors: Alejandro Hernández Cordero, Robert Haschke

1.14.0 (2019-12-08)

  • [maintanence] Remove deprecations
    • Require all xacro commands to be prefixed with 'xacro:'
    • Remove options --legacy, --inorder, --check-order, --includes
  • Contributors: Robert Haschke

1.13.5 (2019-12-08)

  • [feature] Expose abs_filename() (#220)
  • [feature] Catch missing closing brace in $() and ${} expressions
  • [maintanence]
    • Replace deprecated yaml.load() -> yaml.safe_load()
    • Save macro names internally w/o 'xacro:' prefix
    • Correctly issue deprecation warning for non-prefixed xacro tags
  • Contributors: Robert Haschke

1.13.4 (2019-09-26)

  • [feature] remove xmlns:xacro from processed file (#207)
    • Remove all notions of xmlns:xacro from the resulting document.
    • If the root node defines a xacro:targetNamespace attribute, this will become the global xmlns namespace of the resulting document.
  • [feature] Add len() to allowed python functions (#208)
  • [maintanence]
    • --in-order warning: reduce severity level to message
    • fix and cleanup test of cmake extensions
    • adapt run_xacro() to run xacro from PATH
    • simplify import of substition_args
    • remove 'requires' field from setup.py
    • fix Travis config: use new repository key, use xenial/kinetic distro
    • basic README.md
    • fix catkin_lint issue
    • remove duplicate catkin_python_setup() (#206)
  • Contributors: Robert Haschke, James Xu, Martin Pecka

1.13.3 (2018-10-14)

  • use INORDER as default in cmake functions
  • remove weird 'None's in error messages
  • Contributors: Robert Haschke

1.13.2 (2018-05-14)

  • deprecate --includes option (which is tied to deprecated --legacy processing)
  • moved all option handling to cli.py, including deprecation warnings for options
  • Contributors: Robert Haschke

1.13.1 (2018-05-03)

  • fix parsing of quoted strings in default args for xacro params (#187)
  • Contributors: Robert Haschke

1.13.0 (2018-03-31)

  • make --inorder processing the default
  • Contributors: Robert Haschke

1.12.1 (2018-03-28)

  • #183: unicode support for python2 and python3
  • #178: extend list of allowed python builtins: min, max, round
  • #182: suppress xacro warnings when determining dependencies
  • #151: fixes for #149 and #148
  • #157: fix #156 access to undefined target_table
  • #150: allow True/False literals in python expressions
  • #159: load ROS-related packages on demand, thus becoming more independent from ROS
  • #173: allow default values for properties
  • #172: fix formatting of XacroException
  • #171: fix dependency handling (--deps option)
  • #163: full python 3 compatibility
  • Contributors: Robert Haschke, Kartik Mohta, Morgan Quigley, Steven Peters

1.12.0 (2017-03-25)

1.11.2 (2017-02-27)

  • Convert exception to string in a python2/3 compatible way.
  • Use python2/3 independent check for file type.
  • Contributors: Hans Gaiser, Maarten de Vries

1.11.1 (2016-06-22)

  • workaround for xml.dom.minidom issue
  • ensure non-empty error string
  • Contributors: Robert Haschke

1.11.0 (2016-03-25)

  • added short option -i as alternative to --inorder
  • refactored main to fix #122, #107
  • added xacro indicator to error message to fix #123
  • moved banner generation to process_file()
  • removed special (but obsolete) output handling for just_includes mode
  • moved core processing pipeline into function process_file()
  • improved documentation: more comments, input_file -> input_file_name
  • fix #120: handle non-space whitespace characters in params string
  • extended tests to handle non-space whitespace characters in params string
  • always store macros with xacro: prefix in front: #118
  • fix #115: enforce xacro namespace usage with --xacro-ns option
  • apply correct checking for include tags, and extend testcase
  • allow (one-level) nested expression/extension evaluation
  • Contributors: Robert Haschke, Morgan Quigley

1.10.6 (2015-09-01)

  • use correct catkin environment for cmake dependency checking
  • fixed dependency definition for cmake usage
  • Contributors: Robert Haschke

1.10.5 (2015-08-12)

  • fix #108: evaluate property blocks recursively too
  • improved macro parameter parsing
  • use a regular expression to parse a param spec with forwarding and default
  • allow for spaces in default string (within single quotes)
  • forwarding macro arguments from outer scope
  • switched to [\^|]{.title-ref} syntax
  • use more compact [$|]{.title-ref} syntax
  • moved parsing of argument defaults to grab_macro()
  • explicit forwarding of properties to macro scope
  • replace silent/implicit forwarding of properties from outer scope to macro scope by an explicit "call" to a [forward(<name>[,<default>])]{.title-ref} function.
  • implicit forwarding of outer-scope properties to macro args (#100)
  • property evaluation fixes
  • suppress double evaluation of properties
  • adapted unittest to cover the fixed issue
  • fixed evaluation order for properties exported to parent or global scope
  • Merge pull request #103 from ubi-agni/overwrite-check issue warning when attempting to overwrite existing global property
  • fixed unittest: avoid overwrite warning
  • warn when overwriting any globally defined variable
  • Merge pull request #102 from ubi-agni/completion bash completion
  • Merge pull request #99 from ubi-agni/jade-devel reworked macro resolution
  • moved test_macro_name_with_colon() to class TestXacro should be tested both, in oldorder and inorder mode
  • bash completion
  • improved error message for failed $(find)
  • reworked macro resolution python-eval-based macro resolution (introduced to enable namespaces) heavily restricted the set of possible macro names (only valid python identifiers were allowed) Particularly, xacro: prefixed macro names were forbidden.
  • initial attempt to fix #97
  • add failing test case with colon in the macro name
  • Contributors: Robert Haschke

1.10.4 (2015-06-18)

  • removed test_DEPRECATED_should_replace_before_macroexpand() duplicates test_should_replace_before_macroexpand()
  • fixed evaluation order of macro arguments and body Macro arguments need to be evaluated and assigned to properties before body is evaluated. Otherwise, the evaluated value will be converted to str, i.e. loosing original type.
  • Contributors: Robert Haschke

1.10.3 (2015-06-16)

  • deprecate --oldorder processing
  • added --check-order option to do a simple check for --inorder compatibility
    • Most probable incompatibility is redefining a property after its usage.
    • tested and reported with file location of (first) redefinition after usage.
  • moved command line processing to cli.py
  • explain verbosity levels in usage string
  • colorize errors during cli parsing
  • log definition and usage of properties
  • replaced debug option by verbosity options -q, -v
  • fixed evaluation time of default macro params
  • introduced Macro object to increase code readability
  • parse a macro's parameter list once at declaration time (instead of every instantiation)
  • extended test_multiple_blocks() to check for both normal and reversed order
  • added unittest to increase code coverage
  • do not issue deprecation warning for <include> tags that are non-xacro
  • added option --oldorder
  • allow to store properties to parent or global scope
  • added <xacro:attribute>
  • cleaned up error message about missing files
  • moved xml-specific functions to xmlutils.py new generic functions opt_attrs(), reqd_attrs(), and check_attrs() to fetch optional and required attributes and warn about unknown ones in a uniform fashion
  • unittest to allow empty <arg> defaults
  • Merge pull request #94 from ubi-agni/minor-fixes
  • minor fixes
  • remove duplicates in --deps output
  • fixed dependency checking for --inorder mode (which requires full processing)
  • fixed doc of xacro' cmake macros
  • renamed "xacro:rename" to "xacro:element"
  • allow namespacing for xacro:include's
  • allow renaming of element names using xacro:rename
  • unittest cleanup
  • check property and macro names to be valid python identifiers
  • allow namespacing of xacro:include's
  • properties and macros in an included file will go into their own, separate namespace, if the XML attribute [ns]{.title-ref} is provided. Access is by standard python syntax: namespace.name
  • allow renaming of element names <xacro:rename xacro:name="<new element name>"/>
  • moved unittests requiring --inorder processing to class TestXacroInorder
  • added unittest test_dynamic_macro_undefined()
  • improved error message when variable include filename is used without --inorder
  • stripped down unittest test_inorder_processing()
  • improved processing
  • adapted pr2 gold standard removing most comments again this partially reverts 59605fb1521583dc63efdea13f4c45128499bd20
  • remove all XML comments directly before xacro elements (These are considered xacro-related only and should be removed in the final doc.) Leaving an empty line between xacro-unrelated and xacro-related comments allows to include the former.
  • unittest: test_ignore_xacro_comments()
  • improved processing
    • recursive (instead of iterative) eval_all()
    • reusable process_include()
    • replace_node() function to replace xacro tag by some other content
    • avoid reprocessing of nodes
    • avoid deep copy where possible (speedup)
  • fix evaluation (#83)
  • yaml support
  • check for consistency of xml namespaces on xacro:include
  • replaced strip()=='' by more efficient isspace()
  • allow transitive definition of substition args
  • fixed evaluation of literals in property definitions
    • literals with preceding whitespace will be silently stripped (#83)
    • more complex evaluation test (perturbing spaces added)
  • fixed xacro namespaces in pr2 files to get rid of new inconsistency warning
  • warning message on inconsistent namespace redefinition for includes
  • yaml support ${load_yaml('file.yaml')} to load dict from yaml file
  • Merge pull request #85 from ubi-agni/error-reporting improved error reporting
  • nicer formatting of multiple "when evaluating expression" lines
  • improved formatting of error messages use XacroException to wrap and augment other exceptions to achieve a clearer error formatting
  • better error message for missing substitution args
  • use colorized warnings where possible
  • included macro stack in error-reporting
  • maintain filestack to facilitate error reporting at any time
  • Merge pull request #82 from ubi-agni/unittests improved unittesting
  • allow to capture (and check) stderr in unit tests
  • improved unittests to test both, classic and in-order processing
  • Merge pull request #81 from ubi-agni/jade-devel Thank you for your time and contributions. Improving cosmetics is important.
  • PEP8 cleanup
  • cmake: only copy files to devel space if new
  • Merge pull request #80 from ubi-agni/jade-devel
  • improved error-handling opening the output file - running multiple xacro process in parallel, all writing into a new dir could cause a race condition when creating the dir
    • improved error message on output creation failure
  • removed rospy dependency
    • Importing rospy caused build order issues with ros_comm in workspace
  • Filtering out REMAP command-line arguments is done manually now.
  • update authors/maintainers and copyright statements
  • deprecate non-namespaced xacro tags
  • added missing print_location_msg() for file that actually failed parsing
  • improved deprecation warnings
  • New cli option [--xacro-ns]{.title-ref} allows to enforce the new policy requiring the xacro namespace prefix (and suppressing deprecation warnings). However, non-prefixed tags will not be modified by xacro anymore (as requested by #41, #59, #60). Partially reverted cb73cfd8c678adfda2172accef398189ea2338a1, handling <arg> tags in the same fashion as other tags, i.e. issue a warning if used without prefix and ignoring it with cli argument [--xacro-ns]{.title-ref}.
  • fixed pr2 xacro files to use 'xacro:' prefixed tags only
  • fixed unittests in test_xacro.py to use 'xacro:' prefixed tags only
  • deprecation message for missing xacro namespace prefix in xml tags
  • moved colored warning messages into color.py (for reuseability)
  • added missing print_location_msg() for file that actually failed parsing
  • improved xacro's cmake macros
  • prepend ${PACKAGE_NAME} to all generated cmake targets Otherwise multiple packages employing xacro's cmake macros will use the same conflicting target name. This is only an issue with catkin_make, which defines a single global cmake namespace. The new catkin tools (or catkin_make_isolated) build each package separately.
  • basic unittest for xacro's cmake macros
  • improved xacro's cmake macros - xacro_add_xacro_file() automatically determines output file from input (removing .xacro suffix). If that fails, a fatal error is raised.
    • added xacro_install() to allow installation into both, devel and install space.
    • replaced conveniency function xacro_add_files()
  • Contributors: Robert Haschke

1.10.2 (2015-05-23)

  • added --debug option to explicitly enable stack traces By default, only show error message to the user. Stack traces are only interesting for xacro developers.
  • recursive include processing
    • more informed error messages (which file was included from where)

    - allows relative path names for include filename specs they are interpreted relative to the current file

  • new substitution command $(cwd) to extract current working directory
  • added unittest cases
    • creation of required subdirs for output
    • recursive xacro:include
    • extended test_include_glob() to check for all glob patterns
  • added run_xacro() function to simplify unittests running xacro script
  • moved xacro.py back to original location
  • nicely colored deprecation warning
  • create required dirs before opening output file
  • added convenience cmake-macro xacro_add_target() to auto-generate xacro-processed files
  • added cmake status message before launching xacro (xacro might run for quite a while)
  • fetch xacro --deps errors at report them as a warning
  • simplified deprecation message
  • added missing return statement
  • removed obsolete math import left over from deaaae2c69edd7d5e185eeb098c1521d8711608b
  • install xacro.py again (for backwards compatibility) usage of xacro.py issues a deprecation warning
  • simplified scripts/xacro - removed xacro.py
    • made run script "scripts/xacro" and install process follow standards
    • removed xacro.py

    - added dependencies to setup.py Having the binaries xacro and xacro.py installed side by side causes problems, because xacro.py is wrongly taken as the module. This was avoided by the rather complex filtering of the sys.path. Switched to ROS standard now, using a binary script called "xacro".

  • changed tests to use the whole xacro processing pipeline utilizing the modularization of main() from previous commit This simplifies several existing tests, especially these using files on disk.
  • split main() into process_cli_arg(), parse(), process_doc()
  • extended cmake macro xacro_add_xacro_file()
    • handle INORDER option
    • handle REMAP arguments

    - create absolute input file names automatically usage: xacro_add_xacro_file(input output INORDER REMAP ...)

  • stripped new unit tests to essential xml snippets
  • merged pull request #68: eval properties assigned from <arg> tags as literals In the following example: <xacro:arg name="val" default="0.5"/> <xacro:property name="val" value="$(arg val)"/> ${val} was not evaluated as a number, but as string only. Thus numerical expressions failed with an exception.
  • factored out get_boolean_value()
  • <xacro:arg> needs to be fully specified
  • (handling <arg> tags (without xacro ns-prefix) disabled native <arg> tags) add test for eating launch parameter arguments remove check for "arg" parameter. move new test function to bottom of source
  • added unit tests for evaluation of list, tuple, and dict literals
  • fixed some code style issues
  • fixed string-isinstance checks (for python 3 compatibility)
  • do not evaluate list, dict, tuple expressions as literals (without ${} syntax)
  • added dict to list of known global symbols
  • focused global_symbols definition in the beginning of the file added some basic python symbols: list, str, float, int and map allowing some basic computation
  • tuning performance: instantiate QuickLexer's regexps only once
  • Contributors: Robert Haschke, Martin Pecka, Mike O'Driscoll, Morgan Quigley

1.10.1 (2015-04-01)

  • improved error handling and more descriptive error messages
  • correctly raise a XacroException on invalid, i.e. non-boolean, <xacro:if> expressions. (removed left-over debugging code, added test case)
  • raise an exception on undefined, but used macros Using the syntax <xacro:macroname/> should raise an exception if macroname is not defined. Added appropriate code and a test case.
  • fixed bookkeeping in lazy evaluation switch Table.unevaluated from list to set to avoid multiple key entries
  • fix formatting of changelog
  • Contributors: Robert Haschke

1.10.0 (2015-03-13)

  • security measure: forbid access to __builtins__ in expressions
  • literal evaluation should only consider literals, but no expressions use ast.literal_eval()
  • removed eval() from xacro:if evaluation
  • back to string comparison to handle (lowercase) true and false
  • add test case for equality expressions in <xacro:if>
  • add test case for math function usage
  • python based evaluation of expressions
    • replaced handle_expr with python-internal eval() call
    • care has been taken to resolve variables recursively on demand (in Table.__getitem__)
    • allows for evaluation of standard math functions
    • other desired functions could be added in eval_self_contained
    • Values in Table symbols are not stored as strings but as typed values.
  • If text is required, a conversion with str() is performed, to ensure proper evaluation of expressions. Otherwise 3*"1" would evaluate to "111".
  • use __future__.division we can handle integer division evaluating to floating-point devision, as before
  • allow variable names for filename attribute in <xacro:include>
  • allow for ordered XML processing to avoid issues with multiply defined properties and macros in (typically 3rd party) include files
    • enable the new behaviour by passing --inorder cmdline option
    • to improve code readibility and reusability, introduced functions
  • process_include(node), grab_macro(elt, macros), grab_property(elt, symbols) containing 1:1 corresponding handling from process_includes, grab_macros, and grab_properties
    • added corresponding test case test_inorder_processing()
  • dynamic macro names using <xacro:call macro=""/>
  • fixup unittests and handling of non-element nodes in <include>, <if>, <macro>
  • updated pr2 gold standard to include all comments
  • allow to ignore comments in nodes_match()
  • New handling of non-element nodes invalidates pr2 gold standard (adding a lot more comments). To allow validation, allow to ignore all comments in comparison (as before).
  • fixed handling of non-element nodes in <include>, <if>, <macro>
  • fixed writexml: text nodes were not printed when other siblings exist
    • print all text, but skip whitespace-only text nodes
  • improved xml matching
    • so far only element nodes (with its attributes) were considered
    • now also consider TEXT, CDATA, and COMMENT nodes
    • added function text_matches (normalizing consecutive whitespace to a single space)
    • added some new unit tests

    - test_consider_non_elements: non-element nodes are not yet considered in <if> and <macro>

  • travis-ci: use catkin_make
  • travis-ci: fixup running of tests
  • fix pathnames used in test case
  • Include CATKIN_ENV params at build time.
  • use output filename flag instead of shell redirection
  • create output file after parsing is complete, not before
  • Contributors: Robert Haschke, Mike O'Driscoll, Morgan Quigley, William Woodall

1.9.3 (2015-01-14)

  • merge test cases
  • add a snapshot of the pr2 model to the test directory. add a test case which verifies that the pr2 model is parsed equal to a 'golden' parse of it.
  • add more tests
  • add default arg tests
  • Allow default values for substitution args
  • Fix up comments
  • Allow xacro macros to have default parameters
  • Contributors: Paul Bovbel, Morgan Quigley

1.9.2 (2014-07-11)

  • add a few more tests to exercise the symbol table a bit more
  • allow for recursive evaluation of properties in expressions
  • add useful debugging information when parameters are not set
  • stop test from failing the second time it is run
  • unified if/unless handling, correctly handle floating point expressions
  • floating point expressions not equal zero are now evaluated as True
  • changed quotes to omit cmake warning
  • Contributors: Robert Haschke, Mike Ferguson

1.9.1 (2014-06-21)

  • fixup tests so they run
  • export architecture_independent flag in package.xml
  • installed relocatable fix
  • Contributors: Michael Ferguson, Mike Purvis, Scott K Logan

1.9.0 (2014-03-28)

  • Remove the roslint_python glob, use the default one.
  • Add roslint target to xacro; two whitespace fixes so that it passes.
  • fix evaluation of integers in if statements also added a unit test, fixes #15
  • fix setting of _xacro_py CMake var, fixes #16
  • Add support for globbing multiple files in a single <xacro:include>
  • code cleanup and python3 support
  • check for CATKIN_ENABLE_TESTING

1.8.4 (2013-08-06)

  • Merge pull request #9 from davetcoleman/hydro-devel Xacro should not use plain 'include' tags but only namespaced ones.
  • Fix for the fact that minidom creates text nodes which count as child nodes
  • Removed <uri> checking and made it more general for any child element of an <include> tag
  • Removed Groovy reference, only being applied to Hydro
  • Created check for Gazebo's <uri> tabs only only shows deprecated warnings if not present.
  • Small spelling fix
  • Xacro should not use plain 'include' tags but only namespaced ones.
  • Merge pull request #8 from piyushk/hydro-devel-conditional xacro conditional blocks
  • using refined arguments instead of sys.argv for xml file location
  • adding conditional blocks to xacro

1.8.3 (2013-04-22)

  • bumped version to 1.8.3 for hydro release
  • backwards compatilibity with rosbuild
  • adding unit test for substitution args
  • Adding supoprt for substitution_args 'arg' fields
  • Remove bin copy of xacro.py
  • 1.7.3
  • Install xacro.py as a program so it can be run
  • 1.7.2
  • fixed build issues introduced in catkinization
  • 1.7.1
  • PEP8, cleanup, and remove roslib
  • Update copyright, self import guard, and catkinize
  • Catkinize.
  • Cleanup in preparation of catkinization.
  • Added tag unstable for changeset 169c4bf30367
  • Added tag xacro-1.6.1 for changeset fc45af7fdada
  • 1.6.1 marker
  • xacro: fuerte compat with sub args import
  • Added tag unstable for changeset 2d3c8dbfa3c9
  • Added tag xacro-1.6.0 for changeset e4a4455189bf
  • 1.6.0
  • converted to unary stack from common stack
  • xacro: fixed inserting property blocks (ros-pkg #4561)
  • xacro now uses XacroExceptions. String exceptions are not allowed in Python anymore. #4209
  • Added Ubuntu platform tags to manifest
  • Xacro now places comments below <?xml> tag (#3859)
  • Xacro prints out cleaner xml. Elements are now often separated by a newline.
  • xacro dependency on roslaunch removed #3451
  • Xacro now adds a message mentioning that the file was autogenerated (#2775)
  • Remove use of deprecated rosbuild macros
  • Integers stay integers in xacro, fixing #3287
  • Tests for r25868
  • Added a flag for only evaluating include tags in xacro
  • Allowing multiple blocks and multiple insert_blocks, fixing #3322 and #3323
  • doc review completed for xacro
  • adding mainpage for xacro doc review
  • Added xacro.cmake file that exports new xacro_add_xacro_file() macro, #3020
  • Namespaced "include" tag in xacro
  • Marked xacro as api reviewed
  • Xacro now correctly declares the namespaces of the included documents in the final
  • Made xacro accept xml namespaces
  • Xacro now errors hard when a property is used without being declared
  • Xacro no longer allows you to create properties with "${}" in the name
  • Added the ability to escape "${" in xacro
  • Made the tests in xacro run again.
  • Created xacro/src
  • migration part 1

Wiki Tutorials

This package does not provide any links to tutorials in it's rosindex metadata. You can check on the ROS Wiki Tutorials page for the package.

Package Dependencies

System Dependencies

No direct system dependencies.

Dependant Packages

Name Deps
audibot_description
rokubimini_description
cob_calibration_data
cob_description
raw_description
cob_cartesian_controller
cob_obstacle_distance
cob_twist_controller
cob_grasp_generation
cob_hardware_config
cob_moveit_config
cob_gazebo_worlds
crane_x7_moveit_config
create_description
dbw_fca_description
dbw_mkz_description
dbw_polaris_description
depthai_descriptions
depthai_examples
dingo_description
ensenso_description
fath_pivot_mount_description
fetch_description
fetch_moveit_config
franka_description
franka_visualization
hector_components_description
hector_sensors_description
hector_xacro_tools
human_description
husky_description
jackal_description
jackal_navigation
jsk_data
jsk_pcl_ros
khi_duaro_moveit_config
khi_rs007l_moveit_config
khi_rs007n_moveit_config
khi_rs013n_moveit_config
khi_rs020n_moveit_config
khi_rs025n_moveit_config
khi_rs030n_moveit_config
khi_rs080n_moveit_config
leo_description
leo_viz
leo_bringup
robot
microstrain_inertial_description
mir_description
moveit_setup_assistant
moveit_resources_dual_panda_moveit_config
moveit_resources_fanuc_moveit_config
moveit_resources_panda_description
moveit_resources_panda_moveit_config
moveit_resources_prbt_moveit_config
moveit_resources_prbt_pg70_support
moveit_resources_prbt_support
open_manipulator_p_gazebo
open_manipulator_gazebo
openni_description
panda_moveit_config
pass_through_controllers
pf_description
prbt_gazebo
prbt_moveit_config
prbt_support
pincher_arm_bringup
pincher_arm_moveit_config
pointgrey_camera_description
pr2_description
pr2_gazebo
prbt_pg70_support
psen_scan_v2
raspimouse_description
rc_visard_description
ridgeback_description
ridgeback_navigation
robot_upstart
robotont_description
robotont_nuc_description
ackermann_steering_controller
diff_drive_controller
effort_controllers
four_wheel_steering_controller
joint_trajectory_controller
cartesian_trajectory_controller
schunk_description
sciurus17_moveit_config
sick_ldmrs_description
sick_tim
trac_ik_examples
turtlebot3_description
ur10_moveit_config
ur10e_moveit_config
ur16e_moveit_config
ur20_moveit_config
ur30_moveit_config
ur3_moveit_config
ur3e_moveit_config
ur5_moveit_config
ur5e_moveit_config
ur_description
urdf_geometry_parser
urdf_sim_tutorial
urdf_tutorial
urg_node
velodyne_description
warthog_description
xpp_hyq
xpp_quadrotor
bcr_bot
clober_description
cpr_onav_description
diffbot_gazebo
flir_camera_description
ign_ros_control_demos
mia_hand_moveit_config
nicla_vision_ros
reach_ros
rm_description
sick_scan_xd
thunder_line_follower_pmr3100

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

No plugins found.

Recent questions tagged xacro at Robotics Stack Exchange

xacro package from xacro repo

xacro

Package Summary

Tags No category tags.
Version 2.0.11
License BSD
Build type AMENT_CMAKE
Use RECOMMENDED

Repository Summary

Checkout URI https://github.com/ros/xacro.git
VCS Type git
VCS Version ros2
Last Updated 2024-11-13
Dev Status MAINTAINED
CI status No Continuous Integration
Released RELEASED
Tags No category tags.
Contributing Help Wanted (0)
Good First Issues (0)
Pull Requests to Review (0)

Package Description

Xacro (XML Macros) Xacro is an XML macro language. With xacro, you can construct shorter and more readable XML files by using macros that expand to larger XML expressions.

Additional Links

Maintainers

  • Robert Haschke
  • Morgan Quigley

Authors

  • Stuart Glaser
  • William Woodall
  • Robert Haschke

Xacro (XML Macros)

Xacro is an XML macro language

With xacro, you can construct shorter and more readable XML files by using macros that expand to larger XML expressions. Recent documentation can be found in the wiki. For older releases, have a look at the ROS wiki.

CHANGELOG

Changelog for package xacro

2.0.11 (2024-04-02)

  • Allow substitution args without ROS (#340)
  • Add more unit tags for yaml files (#331)
  • Resolve $(find ...) as a result of a substitution argument (#339)
  • Mark regexes as raw strings (#336)
  • Add pyproject.toml for direct installation via pip (#329)
  • Contributors: Adam Heins, Bruno-Pier, Carlo Rizzardo, Lukas Huber, Robert Haschke

2.0.10 (2024-01-25)

  • Expose python.abs()
  • Fix hasattr support of YamlDictWrapper (#324)
  • Contributors: Robert Haschke

2.0.9 (2023-02-27)

  • Evaluate arg value as str/unicode (#322)
  • Contributors: Robert Haschke

2.0.8 (2022-10-22)

  • Install xacro using console_script entrypoint (#304)
  • Provide xacro.process() returning the processed file (#229)
  • Dotted YAML access from list iterator (#318)
  • Optionally allow comment evaluation (#310)

    Comment evaluation can be enabled with a special comment:

    • <!-- xacro:eval-comments --> or
    • <!-- xacro:eval-comments:on -->

    It remains active for the following comments until:

    • the current XML tag's scope is left (or a new tag entered)
    • another tag or non-whitespace text is processed
    • it becomes explicitly disabled via: <!-- xacro:eval-comments:off -->
  • Fix property resolution with namespace usage (#308)
    • Allow access to properties in parent scopes again (fixes #305)
    • Pick correct scope when defining a property into the parent (fixes #307)

      Setting a property within the parent scope may occur in two contexts:

      1. From within a macro. In that case, one wants to set the property in the caller's scope.
      2. From within the included file. In that case, one wants to set the property in the includer's scope.
  • Contributors: Chen Bainian, Gonzalo de Pedro, Gonzo, Jacob Perron, Melvin Wang, Robert Haschke, vandanamandlik

2.0.7 (2021-09-04)

  • Allow more builtin symbols: sorted, set
  • Don't import hidden symbols from math package
  • Fix eval security vulnerability
    • safe_eval()
    • unit tests validating the protection mechanism
  • Generalize yaml !degrees constructors: Enable expressions as well
  • Improve macro arg parsing (#278) to support:
    • $(substitution args)
    • ${python expressions}
    • single or double quoting of spaces
  • Contributors: Robert Haschke

2.0.6 (2021-05-30)

  • [feature] Expose YamlDictWrapper as dotify() to allow dotted access to any dict (#274)
  • [fix] Scoped macro evaluation (#272)
  • Contributors: Robert Haschke

2.0.5 (2021-03-02)

  • [fix] Report correct filename for XML errors (#268)
  • [fix] Python3-compatible property Table (#266)
  • [fix] Use outer-scope symbols to resolve include filename in xacro:include (#264)
  • [fix] Append test directory to existing AMENT_PREFIX_PATH (#260)
  • [fix] yaml loading: recursively wrap lists and dicts for dotted dict access (#258)
  • [feature] Provide support for yaml constructors !degrees and !radians (#252)
  • Contributors: Chen Bainian, Robert Haschke, G.A. vd. Hoorn

2.0.3 (2020-08-09)

  • Merge improvements of melodic and noetic branches into dashing-devel: see 1.14.2 and 1.14.3 for details
  • Contributors: Robert Haschke

2.0.2 (2020-03-29)

  • Merge improvements of melodic and noetic branches into dashing-devel: see 1.14.1, 1.13.5 for details
  • Contributors: Robert Haschke

2.0.1 (2019-10-06)

  • Revert requiring that all xacro commands are prefixed with 'xacro:' namespace Although this is deprecated since #79, the corresponding deprecation warning wasn't actually issued. Thus, we will accept non-prefixed xacro tags until F-turtle.
  • Install to both, bin/xacro and lib/xacro/xacro
  • Contributors: Robert Haschke

2.0.0 (2019-09-28)

  • PEP8 cleanup
    • code simplifications
    • avoid empty except
    • sort imports
    • format line breaks
  • Code cleanup
    • Removed deprecated options --legacy, --inorder, --check-order, --includes
    • Require all xacro commands to be prefixed with 'xacro:'
    • Added missing copyright notices
    • Removed python2 stuff
  • Adapt Travis config to use colcon
  • Provide ROS2-based replacement for substition args
  • Modified package structure as per ROS2 rules
    • Using ament_cmake
    • Moved source contents from "src/xacro" to "xacro"
    • Modified package.xml and setup.py according to ROS2 requirements
    • Configured completion hook
    • Removed catkin artifacts from cmake extension
  • Contributors: vandanamandlik, Jacob Perron, Robert Haschke

1.14.4 (2020-08-09)

  • [fix] Rework YamlDictWrapper to restore dict properties (#250)
  • [fix] Ignore underscores when parsing literal numeric values (#247)
  • Contributors: Robert Haschke

1.14.3 (2020-07-05)

  • [feature] Improve warnings
    • Unify meaning of verbosity > 0 (to print file location)
    • Provide file location on warning in check_attrs()
    • Issue warning on child elements of <xacro:include> tag
  • [feature] Allow dotted access to yaml-loaded dicts: d.key1.key2.key3 (#245)
  • [maint] Travis: Update distro to Bionic
  • Contributors: Robert Haschke, G.A. vd. Hoorn

1.14.2 (2020-05-21)

  • [maintanence] Remove deprecated xacro.py (#239)
  • Contributors: Shane Loretz

1.14.1 (2020-03-29)

  • [feature] allow optional xacro includes (#234)
  • Contributors: Robert Haschke

1.13.5 (2019-12-08)

  • [feature] Expose abs_filename() (#220)
  • [feature] Catch missing closing brace in $() and ${} expressions
  • [maintanence]
    • Replace deprecated yaml.load() -> yaml.safe_load()
    • Save macro names internally w/o 'xacro:' prefix
    • Correctly issue deprecation warning for non-prefixed xacro tags
  • Contributors: Robert Haschke

1.13.4 (2019-09-26)

  • [feature] remove xmlns:xacro from processed file (#207)
    • Remove all notions of xmlns:xacro from the resulting document.
    • If the root node defines a xacro:targetNamespace attribute, this will become the global xmlns namespace of the resulting document.
  • [feature] Add len() to allowed python functions (#208)
  • [maintanence]
    • --in-order warning: reduce severity level to message
    • fix and cleanup test of cmake extensions
    • adapt run_xacro() to run xacro from PATH
    • simplify import of substition_args
    • remove 'requires' field from setup.py
    • fix Travis config: use new repository key, use xenial/kinetic distro
    • basic README.md
    • fix catkin_lint issue
    • remove duplicate catkin_python_setup() (#206)
  • Contributors: Robert Haschke, James Xu, Martin Pecka

1.13.3 (2018-10-14)

  • use INORDER as default in cmake functions
  • remove weird 'None's in error messages
  • Contributors: Robert Haschke

1.13.2 (2018-05-14)

  • deprecate --includes option (which is tied to deprecated --legacy processing)
  • moved all option handling to cli.py, including deprecation warnings for options
  • Contributors: Robert Haschke

1.13.1 (2018-05-03)

  • fix parsing of quoted strings in default args for xacro params (#187)
  • Contributors: Robert Haschke

1.13.0 (2018-03-31)

  • make --inorder processing the default
  • Contributors: Robert Haschke

1.12.1 (2018-03-28)

  • #183: unicode support for python2 and python3
  • #178: extend list of allowed python builtins: min, max, round
  • #182: suppress xacro warnings when determining dependencies
  • #151: fixes for #149 and #148
  • #157: fix #156 access to undefined target_table
  • #150: allow True/False literals in python expressions
  • #159: load ROS-related packages on demand, thus becoming more independent from ROS
  • #173: allow default values for properties
  • #172: fix formatting of XacroException
  • #171: fix dependency handling (--deps option)
  • #163: full python 3 compatibility
  • Contributors: Robert Haschke, Kartik Mohta, Morgan Quigley, Steven Peters

1.12.0 (2017-03-25)

1.11.2 (2017-02-27)

  • Convert exception to string in a python2/3 compatible way.
  • Use python2/3 independent check for file type.
  • Contributors: Hans Gaiser, Maarten de Vries

1.11.1 (2016-06-22)

  • workaround for xml.dom.minidom issue
  • ensure non-empty error string
  • Contributors: Robert Haschke

1.11.0 (2016-03-25)

  • added short option -i as alternative to --inorder
  • refactored main to fix #122, #107
  • added xacro indicator to error message to fix #123
  • moved banner generation to process_file()
  • removed special (but obsolete) output handling for just_includes mode
  • moved core processing pipeline into function process_file()
  • improved documentation: more comments, input_file -> input_file_name
  • fix #120: handle non-space whitespace characters in params string
  • extended tests to handle non-space whitespace characters in params string
  • always store macros with xacro: prefix in front: #118
  • fix #115: enforce xacro namespace usage with --xacro-ns option
  • apply correct checking for include tags, and extend testcase
  • allow (one-level) nested expression/extension evaluation
  • Contributors: Robert Haschke, Morgan Quigley

1.10.6 (2015-09-01)

  • use correct catkin environment for cmake dependency checking
  • fixed dependency definition for cmake usage
  • Contributors: Robert Haschke

1.10.5 (2015-08-12)

  • fix #108: evaluate property blocks recursively too
  • improved macro parameter parsing
  • use a regular expression to parse a param spec with forwarding and default
  • allow for spaces in default string (within single quotes)
  • forwarding macro arguments from outer scope
  • switched to [\^|]{.title-ref} syntax
  • use more compact [$|]{.title-ref} syntax
  • moved parsing of argument defaults to grab_macro()
  • explicit forwarding of properties to macro scope
  • replace silent/implicit forwarding of properties from outer scope to macro scope by an explicit "call" to a [forward(<name>[,<default>])]{.title-ref} function.
  • implicit forwarding of outer-scope properties to macro args (#100)
  • property evaluation fixes
  • suppress double evaluation of properties
  • adapted unittest to cover the fixed issue
  • fixed evaluation order for properties exported to parent or global scope
  • Merge pull request #103 from ubi-agni/overwrite-check issue warning when attempting to overwrite existing global property
  • fixed unittest: avoid overwrite warning
  • warn when overwriting any globally defined variable
  • Merge pull request #102 from ubi-agni/completion bash completion
  • Merge pull request #99 from ubi-agni/jade-devel reworked macro resolution
  • moved test_macro_name_with_colon() to class TestXacro should be tested both, in oldorder and inorder mode
  • bash completion
  • improved error message for failed $(find)
  • reworked macro resolution python-eval-based macro resolution (introduced to enable namespaces) heavily restricted the set of possible macro names (only valid python identifiers were allowed) Particularly, xacro: prefixed macro names were forbidden.
  • initial attempt to fix #97
  • add failing test case with colon in the macro name
  • Contributors: Robert Haschke

1.10.4 (2015-06-18)

  • removed test_DEPRECATED_should_replace_before_macroexpand() duplicates test_should_replace_before_macroexpand()
  • fixed evaluation order of macro arguments and body Macro arguments need to be evaluated and assigned to properties before body is evaluated. Otherwise, the evaluated value will be converted to str, i.e. loosing original type.
  • Contributors: Robert Haschke

1.10.3 (2015-06-16)

  • deprecate --oldorder processing
  • added --check-order option to do a simple check for --inorder compatibility
    • Most probable incompatibility is redefining a property after its usage.
    • tested and reported with file location of (first) redefinition after usage.
  • moved command line processing to cli.py
  • explain verbosity levels in usage string
  • colorize errors during cli parsing
  • log definition and usage of properties
  • replaced debug option by verbosity options -q, -v
  • fixed evaluation time of default macro params
  • introduced Macro object to increase code readability
  • parse a macro's parameter list once at declaration time (instead of every instantiation)
  • extended test_multiple_blocks() to check for both normal and reversed order
  • added unittest to increase code coverage
  • do not issue deprecation warning for <include> tags that are non-xacro
  • added option --oldorder
  • allow to store properties to parent or global scope
  • added <xacro:attribute>
  • cleaned up error message about missing files
  • moved xml-specific functions to xmlutils.py new generic functions opt_attrs(), reqd_attrs(), and check_attrs() to fetch optional and required attributes and warn about unknown ones in a uniform fashion
  • unittest to allow empty <arg> defaults
  • Merge pull request #94 from ubi-agni/minor-fixes
  • minor fixes
  • remove duplicates in --deps output
  • fixed dependency checking for --inorder mode (which requires full processing)
  • fixed doc of xacro' cmake macros
  • renamed "xacro:rename" to "xacro:element"
  • allow namespacing for xacro:include's
  • allow renaming of element names using xacro:rename
  • unittest cleanup
  • check property and macro names to be valid python identifiers
  • allow namespacing of xacro:include's
  • properties and macros in an included file will go into their own, separate namespace, if the XML attribute [ns]{.title-ref} is provided. Access is by standard python syntax: namespace.name
  • allow renaming of element names <xacro:rename xacro:name="<new element name>"/>
  • moved unittests requiring --inorder processing to class TestXacroInorder
  • added unittest test_dynamic_macro_undefined()
  • improved error message when variable include filename is used without --inorder
  • stripped down unittest test_inorder_processing()
  • improved processing
  • adapted pr2 gold standard removing most comments again this partially reverts 59605fb1521583dc63efdea13f4c45128499bd20
  • remove all XML comments directly before xacro elements (These are considered xacro-related only and should be removed in the final doc.) Leaving an empty line between xacro-unrelated and xacro-related comments allows to include the former.
  • unittest: test_ignore_xacro_comments()
  • improved processing
    • recursive (instead of iterative) eval_all()
    • reusable process_include()
    • replace_node() function to replace xacro tag by some other content
    • avoid reprocessing of nodes
    • avoid deep copy where possible (speedup)
  • fix evaluation (#83)
  • yaml support
  • check for consistency of xml namespaces on xacro:include
  • replaced strip()=='' by more efficient isspace()
  • allow transitive definition of substition args
  • fixed evaluation of literals in property definitions
    • literals with preceding whitespace will be silently stripped (#83)
    • more complex evaluation test (perturbing spaces added)
  • fixed xacro namespaces in pr2 files to get rid of new inconsistency warning
  • warning message on inconsistent namespace redefinition for includes
  • yaml support ${load_yaml('file.yaml')} to load dict from yaml file
  • Merge pull request #85 from ubi-agni/error-reporting improved error reporting
  • nicer formatting of multiple "when evaluating expression" lines
  • improved formatting of error messages use XacroException to wrap and augment other exceptions to achieve a clearer error formatting
  • better error message for missing substitution args
  • use colorized warnings where possible
  • included macro stack in error-reporting
  • maintain filestack to facilitate error reporting at any time
  • Merge pull request #82 from ubi-agni/unittests improved unittesting
  • allow to capture (and check) stderr in unit tests
  • improved unittests to test both, classic and in-order processing
  • Merge pull request #81 from ubi-agni/jade-devel Thank you for your time and contributions. Improving cosmetics is important.
  • PEP8 cleanup
  • cmake: only copy files to devel space if new
  • Merge pull request #80 from ubi-agni/jade-devel
  • improved error-handling opening the output file - running multiple xacro process in parallel, all writing into a new dir could cause a race condition when creating the dir
    • improved error message on output creation failure
  • removed rospy dependency
    • Importing rospy caused build order issues with ros_comm in workspace
  • Filtering out REMAP command-line arguments is done manually now.
  • update authors/maintainers and copyright statements
  • deprecate non-namespaced xacro tags
  • added missing print_location_msg() for file that actually failed parsing
  • improved deprecation warnings
  • New cli option [--xacro-ns]{.title-ref} allows to enforce the new policy requiring the xacro namespace prefix (and suppressing deprecation warnings). However, non-prefixed tags will not be modified by xacro anymore (as requested by #41, #59, #60). Partially reverted cb73cfd8c678adfda2172accef398189ea2338a1, handling <arg> tags in the same fashion as other tags, i.e. issue a warning if used without prefix and ignoring it with cli argument [--xacro-ns]{.title-ref}.
  • fixed pr2 xacro files to use 'xacro:' prefixed tags only
  • fixed unittests in test_xacro.py to use 'xacro:' prefixed tags only
  • deprecation message for missing xacro namespace prefix in xml tags
  • moved colored warning messages into color.py (for reuseability)
  • added missing print_location_msg() for file that actually failed parsing
  • improved xacro's cmake macros
  • prepend ${PACKAGE_NAME} to all generated cmake targets Otherwise multiple packages employing xacro's cmake macros will use the same conflicting target name. This is only an issue with catkin_make, which defines a single global cmake namespace. The new catkin tools (or catkin_make_isolated) build each package separately.
  • basic unittest for xacro's cmake macros
  • improved xacro's cmake macros - xacro_add_xacro_file() automatically determines output file from input (removing .xacro suffix). If that fails, a fatal error is raised.
    • added xacro_install() to allow installation into both, devel and install space.
    • replaced conveniency function xacro_add_files()
  • Contributors: Robert Haschke

1.10.2 (2015-05-23)

  • added --debug option to explicitly enable stack traces By default, only show error message to the user. Stack traces are only interesting for xacro developers.
  • recursive include processing
    • more informed error messages (which file was included from where)

    - allows relative path names for include filename specs they are interpreted relative to the current file

  • new substitution command $(cwd) to extract current working directory
  • added unittest cases
    • creation of required subdirs for output
    • recursive xacro:include
    • extended test_include_glob() to check for all glob patterns
  • added run_xacro() function to simplify unittests running xacro script
  • moved xacro.py back to original location
  • nicely colored deprecation warning
  • create required dirs before opening output file
  • added convenience cmake-macro xacro_add_target() to auto-generate xacro-processed files
  • added cmake status message before launching xacro (xacro might run for quite a while)
  • fetch xacro --deps errors at report them as a warning
  • simplified deprecation message
  • added missing return statement
  • removed obsolete math import left over from deaaae2c69edd7d5e185eeb098c1521d8711608b
  • install xacro.py again (for backwards compatibility) usage of xacro.py issues a deprecation warning
  • simplified scripts/xacro - removed xacro.py
    • made run script "scripts/xacro" and install process follow standards
    • removed xacro.py

    - added dependencies to setup.py Having the binaries xacro and xacro.py installed side by side causes problems, because xacro.py is wrongly taken as the module. This was avoided by the rather complex filtering of the sys.path. Switched to ROS standard now, using a binary script called "xacro".

  • changed tests to use the whole xacro processing pipeline utilizing the modularization of main() from previous commit This simplifies several existing tests, especially these using files on disk.
  • split main() into process_cli_arg(), parse(), process_doc()
  • extended cmake macro xacro_add_xacro_file()
    • handle INORDER option
    • handle REMAP arguments

    - create absolute input file names automatically usage: xacro_add_xacro_file(input output INORDER REMAP ...)

  • stripped new unit tests to essential xml snippets
  • merged pull request #68: eval properties assigned from <arg> tags as literals In the following example: <xacro:arg name="val" default="0.5"/> <xacro:property name="val" value="$(arg val)"/> ${val} was not evaluated as a number, but as string only. Thus numerical expressions failed with an exception.
  • factored out get_boolean_value()
  • <xacro:arg> needs to be fully specified
  • (handling <arg> tags (without xacro ns-prefix) disabled native <arg> tags) add test for eating launch parameter arguments remove check for "arg" parameter. move new test function to bottom of source
  • added unit tests for evaluation of list, tuple, and dict literals
  • fixed some code style issues
  • fixed string-isinstance checks (for python 3 compatibility)
  • do not evaluate list, dict, tuple expressions as literals (without ${} syntax)
  • added dict to list of known global symbols
  • focused global_symbols definition in the beginning of the file added some basic python symbols: list, str, float, int and map allowing some basic computation
  • tuning performance: instantiate QuickLexer's regexps only once
  • Contributors: Robert Haschke, Martin Pecka, Mike O'Driscoll, Morgan Quigley

1.10.1 (2015-04-01)

  • improved error handling and more descriptive error messages
  • correctly raise a XacroException on invalid, i.e. non-boolean, <xacro:if> expressions. (removed left-over debugging code, added test case)
  • raise an exception on undefined, but used macros Using the syntax <xacro:macroname/> should raise an exception if macroname is not defined. Added appropriate code and a test case.
  • fixed bookkeeping in lazy evaluation switch Table.unevaluated from list to set to avoid multiple key entries
  • fix formatting of changelog
  • Contributors: Robert Haschke

1.10.0 (2015-03-13)

  • security measure: forbid access to __builtins__ in expressions
  • literal evaluation should only consider literals, but no expressions use ast.literal_eval()
  • removed eval() from xacro:if evaluation
  • back to string comparison to handle (lowercase) true and false
  • add test case for equality expressions in <xacro:if>
  • add test case for math function usage
  • python based evaluation of expressions
    • replaced handle_expr with python-internal eval() call
    • care has been taken to resolve variables recursively on demand (in Table.__getitem__)
    • allows for evaluation of standard math functions
    • other desired functions could be added in eval_self_contained
    • Values in Table symbols are not stored as strings but as typed values.
  • If text is required, a conversion with str() is performed, to ensure proper evaluation of expressions. Otherwise 3*"1" would evaluate to "111".
  • use __future__.division we can handle integer division evaluating to floating-point devision, as before
  • allow variable names for filename attribute in <xacro:include>
  • allow for ordered XML processing to avoid issues with multiply defined properties and macros in (typically 3rd party) include files
    • enable the new behaviour by passing --inorder cmdline option
    • to improve code readibility and reusability, introduced functions
  • process_include(node), grab_macro(elt, macros), grab_property(elt, symbols) containing 1:1 corresponding handling from process_includes, grab_macros, and grab_properties
    • added corresponding test case test_inorder_processing()
  • dynamic macro names using <xacro:call macro=""/>
  • fixup unittests and handling of non-element nodes in <include>, <if>, <macro>
  • updated pr2 gold standard to include all comments
  • allow to ignore comments in nodes_match()
  • New handling of non-element nodes invalidates pr2 gold standard (adding a lot more comments). To allow validation, allow to ignore all comments in comparison (as before).
  • fixed handling of non-element nodes in <include>, <if>, <macro>
  • fixed writexml: text nodes were not printed when other siblings exist
    • print all text, but skip whitespace-only text nodes
  • improved xml matching
    • so far only element nodes (with its attributes) were considered
    • now also consider TEXT, CDATA, and COMMENT nodes
    • added function text_matches (normalizing consecutive whitespace to a single space)
    • added some new unit tests

    - test_consider_non_elements: non-element nodes are not yet considered in <if> and <macro>

  • travis-ci: use catkin_make
  • travis-ci: fixup running of tests
  • fix pathnames used in test case
  • Include CATKIN_ENV params at build time.
  • use output filename flag instead of shell redirection
  • create output file after parsing is complete, not before
  • Contributors: Robert Haschke, Mike O'Driscoll, Morgan Quigley, William Woodall

1.9.3 (2015-01-14)

  • merge test cases
  • add a snapshot of the pr2 model to the test directory. add a test case which verifies that the pr2 model is parsed equal to a 'golden' parse of it.
  • add more tests
  • add default arg tests
  • Allow default values for substitution args
  • Fix up comments
  • Allow xacro macros to have default parameters
  • Contributors: Paul Bovbel, Morgan Quigley

1.9.2 (2014-07-11)

  • add a few more tests to exercise the symbol table a bit more
  • allow for recursive evaluation of properties in expressions
  • add useful debugging information when parameters are not set
  • stop test from failing the second time it is run
  • unified if/unless handling, correctly handle floating point expressions
  • floating point expressions not equal zero are now evaluated as True
  • changed quotes to omit cmake warning
  • Contributors: Robert Haschke, Mike Ferguson

1.9.1 (2014-06-21)

  • fixup tests so they run
  • export architecture_independent flag in package.xml
  • installed relocatable fix
  • Contributors: Michael Ferguson, Mike Purvis, Scott K Logan

1.9.0 (2014-03-28)

  • Remove the roslint_python glob, use the default one.
  • Add roslint target to xacro; two whitespace fixes so that it passes.
  • fix evaluation of integers in if statements also added a unit test, fixes #15
  • fix setting of _xacro_py CMake var, fixes #16
  • Add support for globbing multiple files in a single <xacro:include>
  • code cleanup and python3 support
  • check for CATKIN_ENABLE_TESTING

1.8.4 (2013-08-06)

  • Merge pull request #9 from davetcoleman/hydro-devel Xacro should not use plain 'include' tags but only namespaced ones.
  • Fix for the fact that minidom creates text nodes which count as child nodes
  • Removed <uri> checking and made it more general for any child element of an <include> tag
  • Removed Groovy reference, only being applied to Hydro
  • Created check for Gazebo's <uri> tabs only only shows deprecated warnings if not present.
  • Small spelling fix
  • Xacro should not use plain 'include' tags but only namespaced ones.
  • Merge pull request #8 from piyushk/hydro-devel-conditional xacro conditional blocks
  • using refined arguments instead of sys.argv for xml file location
  • adding conditional blocks to xacro

1.8.3 (2013-04-22)

  • bumped version to 1.8.3 for hydro release
  • backwards compatilibity with rosbuild
  • adding unit test for substitution args
  • Adding supoprt for substitution_args 'arg' fields
  • Remove bin copy of xacro.py
  • 1.7.3
  • Install xacro.py as a program so it can be run
  • 1.7.2
  • fixed build issues introduced in catkinization
  • 1.7.1
  • PEP8, cleanup, and remove roslib
  • Update copyright, self import guard, and catkinize
  • Catkinize.
  • Cleanup in preparation of catkinization.
  • Added tag unstable for changeset 169c4bf30367
  • Added tag xacro-1.6.1 for changeset fc45af7fdada
  • 1.6.1 marker
  • xacro: fuerte compat with sub args import
  • Added tag unstable for changeset 2d3c8dbfa3c9
  • Added tag xacro-1.6.0 for changeset e4a4455189bf
  • 1.6.0
  • converted to unary stack from common stack
  • xacro: fixed inserting property blocks (ros-pkg #4561)
  • xacro now uses XacroExceptions. String exceptions are not allowed in Python anymore. #4209
  • Added Ubuntu platform tags to manifest
  • Xacro now places comments below <?xml> tag (#3859)
  • Xacro prints out cleaner xml. Elements are now often separated by a newline.
  • xacro dependency on roslaunch removed #3451
  • Xacro now adds a message mentioning that the file was autogenerated (#2775)
  • Remove use of deprecated rosbuild macros
  • Integers stay integers in xacro, fixing #3287
  • Tests for r25868
  • Added a flag for only evaluating include tags in xacro
  • Allowing multiple blocks and multiple insert_blocks, fixing #3322 and #3323
  • doc review completed for xacro
  • adding mainpage for xacro doc review
  • Added xacro.cmake file that exports new xacro_add_xacro_file() macro, #3020
  • Namespaced "include" tag in xacro
  • Marked xacro as api reviewed
  • Xacro now correctly declares the namespaces of the included documents in the final
  • Made xacro accept xml namespaces
  • Xacro now errors hard when a property is used without being declared
  • Xacro no longer allows you to create properties with "${}" in the name
  • Added the ability to escape "${" in xacro
  • Made the tests in xacro run again.
  • Created xacro/src
  • migration part 1

Wiki Tutorials

This package does not provide any links to tutorials in it's rosindex metadata. You can check on the ROS Wiki Tutorials page for the package.

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

No plugins found.

Recent questions tagged xacro at Robotics Stack Exchange

xacro package from xacro repo

xacro

Package Summary

Tags No category tags.
Version 1.13.20
License BSD
Build type CATKIN
Use RECOMMENDED

Repository Summary

Checkout URI https://github.com/ros/xacro.git
VCS Type git
VCS Version melodic-devel
Last Updated 2023-05-24
Dev Status MAINTAINED
CI status
Released RELEASED
Tags No category tags.
Contributing Help Wanted (0)
Good First Issues (0)
Pull Requests to Review (0)

Package Description

Xacro (XML Macros) Xacro is an XML macro language. With xacro, you can construct shorter and more readable XML files by using macros that expand to larger XML expressions.

Additional Links

Maintainers

  • Robert Haschke
  • Morgan Quigley

Authors

  • Stuart Glaser
  • William Woodall
  • Robert Haschke

Xacro (XML Macros)

Xacro is an XML macro language

With Xacro, you can construct shorter and more readable XML files by using macros that expand to larger XML expressions. Documentation can be found in the wiki: http://wiki.ros.org/xacro

CHANGELOG

Changelog for package xacro

1.13.20 (2023-05-24)

  • Fix hasattr support of YamlDictWrapper (#324)
  • Contributors: Alec Tiefenthal

1.13.19 (2023-02-27)

  • Evaluate arg value as str/unicode (#322)
  • Contributors: Robert Haschke

1.13.18 (2022-10-21)

  • Dotted YAML access from list iterator (#318)
  • Contributors: Robert Haschke

1.13.17 (2022-02-12)

  • Only optionally activate comment evaluation (#310)

    Comment evaluation can be enabled with a special comment:

    • <!-- xacro:eval-comments --> or
    • <!-- xacro:eval-comments:on -->

    It remains active for the following comments until:

    • the current XML tag's scope is left (or a new tag entered)
    • another tag or non-whitespace text is processed
    • it becomes explicitly disabled via: <!-- xacro:eval-comments:off -->
  • Fix property resolution with namespace usage (#308)
    • Allow access to properties in parent scopes again (fixes #305)
    • Pick correct scope when defining a property into the parent (fixes #307)

      Setting a property within the parent scope may occur in two contexts:

      1. From within a macro. In that case, one wants to set the property in the caller's scope.
      2. From within the included file. In that case, one wants to set the property in the includer's scope.
  • Contributors: Robert Haschke

1.13.16 (2022-01-30)

  • Issue a warning only for evaluation errors in comments
  • Add LICENSE file
  • Contributors: Robert Haschke

1.13.15 (2022-01-20)

  • Fix resolving of macros and properties declared and used in/from a namespace (#297, #306)

    Macros and properties that are declared within a namespaced include shouldn't require the namespace prefix when used within the namespace.

  • Perform expression evaluation in comments (#300)
  • Expose xacro.arg() to facilitate access to substitution args
  • Contributors: Robert Haschke

1.13.14 (2021-10-02)

  • Allow property names to be evaluated from an expression This allows to turn macros into a function that can compute an arbitrary property:

    <xacro:macro name="square" params="name args">
      <!-- Perform some complex computation and set the property within the parent's scope -->
      <xacro:property name="${name}" value="${[float(x)**2 for x in args]}" scope="parent" />
    </xacro:macro>
    <xacro:square name="result" args="${python.range(5)}" />
    
  • Fix error reporting for invalid symbols in NameSpaces
  • Allow removal of a property definition (#288)

    <xacro:property name="prop" remove="true"/>

  • Allow greedy property evaluation (#284) This can be used, to redefine a property from its previous value, e.g. for normalization:

    <xacro:property name="prop" value="${prop.lower()}" lazy_eval="false"/>
    
  • Correctly expose XML namespaces imported via xacro:include within a macro (#287)
  • Throw when attempting to declare a property starting with double underscore (#286)
  • Improve global symbols (#283)
    • Expose most builtin symbols of python
    • Expose xacro functions into xacro namespace
      • xacro.print_location() to print the current filestack
      • tokenize(string, sep=',; ', skip_empty=True) to facilitate string tokenization
      • message(), warning(), error(), and fatal() to output messages on stderr. All but message() print the error location (macro call and file hierarchy) by default:

        ${xacro.message('message', 'text', 2, 3.14, color=32, print_location=True)}
        ${xacro.warning('warning')}
        ${xacro.error('error', print_location=False)}
        ${xacro.fatal('fatal')}
        
    • Rework handling of file and macro stack, such that print_location() works from anywhere
    • Unit tests: Reduce reported stdout/stderr output
    • Rework definition of global_symbols to expose functions into namespaces python, math, xacro
  • Contributors: Robert Haschke

1.13.13 (2021-09-03)

  • Allow more builtin symbols: sorted, set
  • Don't import hidden symbols from math package
  • Fix eval() security vulnerability
    • safe_eval(): Forbid symbol names starting with double underscore
    • unit tests validating the protection mechanism
  • Generalize yaml !degrees constructor: Enable expressions as well
  • Contributors: Robert Haschke

1.13.12 (2021-07-19)

  • Improve macro arg parsing (#278) to support:
    • $(substitution args)
    • ${python expressions}
    • single or double quoting of spaces
  • Contributors: Robert Haschke

1.13.11 (2021-05-30)

  • Expose YamlDictWrapper as dotify()
  • Contributors: Robert Haschke

1.13.10 (2021-02-11)

  • Use outer-scope symbols to resolve include filename in xacro:include (#264)
  • Contributors: Robert Haschke

1.13.9 (2020-10-13)

  • [fix] yaml loading: recursively wrap lists and dicts for dotted dict access (#258)
  • Contributors: Robert Haschke

1.13.8 (2020-08-28)

  • Provide support for yaml constructors !degrees and !radians (#252)
  • Contributors: Robert Haschke, G.A. vd. Hoorn

1.13.7 (2020-08-09)

  • [fix] Rework YamlDictWrapper to restore dict properties (#250)
  • Contributors: Robert Haschke

1.13.6 (2020-07-05)

  • [feature] Improve warnings
    • Unify meaning of verbosity > 0 (to print file location)
    • Provide file location on warning in check_attrs()
    • Issue warning on child elements of <xacro:include> tag
  • [feature] Allow dotted access to yaml-loaded dicts: d.key1.key2.key3 (#245)
  • [maint] Travis: Update distro to Bionic
  • Contributors: Robert Haschke, G.A. vd. Hoorn

1.13.5 (2019-12-08)

  • [feature] Expose abs_filename() (#220)
  • [feature] Catch missing closing brace in $() and ${} expressions
  • [maintanence]
    • Replace deprecated yaml.load() -> yaml.safe_load()
    • Save macro names internally w/o 'xacro:' prefix
    • Correctly issue deprecation warning for non-prefixed xacro tags
  • Contributors: Robert Haschke

1.13.4 (2019-09-26)

  • [feature] remove xmlns:xacro from processed file (#207)
    • Remove all notions of xmlns:xacro from the resulting document.
    • If the root node defines a xacro:targetNamespace attribute, this will become the global xmlns namespace of the resulting document.
  • [feature] Add len() to allowed python functions (#208)
  • [maintanence]
    • --in-order warning: reduce severity level to message
    • fix and cleanup test of cmake extensions
    • adapt run_xacro() to run xacro from PATH
    • simplify import of substition_args
    • remove 'requires' field from setup.py
    • fix Travis config: use new repository key, use xenial/kinetic distro
    • basic README.md
    • fix catkin_lint issue
    • remove duplicate catkin_python_setup() (#206)
  • Contributors: Robert Haschke, James Xu, Martin Pecka

1.13.3 (2018-10-14)

  • use INORDER as default in cmake functions
  • remove weird 'None's in error messages
  • Contributors: Robert Haschke

1.13.2 (2018-05-14)

  • deprecate --includes option (which is tied to deprecated --legacy processing)
  • moved all option handling to cli.py, including deprecation warnings for options
  • Contributors: Robert Haschke

1.13.1 (2018-05-03)

  • fix parsing of quoted strings in default args for xacro params (#187)
  • Contributors: Robert Haschke

1.13.0 (2018-03-31)

  • make --inorder processing the default
  • Contributors: Robert Haschke

1.12.1 (2018-03-28)

  • #183: unicode support for python2 and python3
  • #178: extend list of allowed python builtins: min, max, round
  • #182: suppress xacro warnings when determining dependencies
  • #151: fixes for #149 and #148
  • #157: fix #156 access to undefined target_table
  • #150: allow True/False literals in python expressions
  • #159: load ROS-related packages on demand, thus becoming more independent from ROS
  • #173: allow default values for properties
  • #172: fix formatting of XacroException
  • #171: fix dependency handling (--deps option)
  • #163: full python 3 compatibility
  • Contributors: Robert Haschke, Kartik Mohta, Morgan Quigley, Steven Peters

1.12.0 (2017-03-25)

1.11.2 (2017-02-27)

  • Convert exception to string in a python2/3 compatible way.
  • Use python2/3 independent check for file type.
  • Contributors: Hans Gaiser, Maarten de Vries

1.11.1 (2016-06-22)

  • workaround for xml.dom.minidom issue
  • ensure non-empty error string
  • Contributors: Robert Haschke

1.11.0 (2016-03-25)

  • added short option -i as alternative to --inorder
  • refactored main to fix #122, #107
  • added xacro indicator to error message to fix #123
  • moved banner generation to process_file()
  • removed special (but obsolete) output handling for just_includes mode
  • moved core processing pipeline into function process_file()
  • improved documentation: more comments, input_file -> input_file_name
  • fix #120: handle non-space whitespace characters in params string
  • extended tests to handle non-space whitespace characters in params string
  • always store macros with xacro: prefix in front: #118
  • fix #115: enforce xacro namespace usage with --xacro-ns option
  • apply correct checking for include tags, and extend testcase
  • allow (one-level) nested expression/extension evaluation
  • Contributors: Robert Haschke, Morgan Quigley

1.10.6 (2015-09-01)

  • use correct catkin environment for cmake dependency checking
  • fixed dependency definition for cmake usage
  • Contributors: Robert Haschke

1.10.5 (2015-08-12)

  • fix #108: evaluate property blocks recursively too
  • improved macro parameter parsing
  • use a regular expression to parse a param spec with forwarding and default
  • allow for spaces in default string (within single quotes)
  • forwarding macro arguments from outer scope
  • switched to [\^|]{.title-ref} syntax
  • use more compact [$|]{.title-ref} syntax
  • moved parsing of argument defaults to grab_macro()
  • explicit forwarding of properties to macro scope
  • replace silent/implicit forwarding of properties from outer scope to macro scope by an explicit "call" to a [forward(<name>[,<default>])]{.title-ref} function.
  • implicit forwarding of outer-scope properties to macro args (#100)
  • property evaluation fixes
  • suppress double evaluation of properties
  • adapted unittest to cover the fixed issue
  • fixed evaluation order for properties exported to parent or global scope
  • Merge pull request #103 from ubi-agni/overwrite-check issue warning when attempting to overwrite existing global property
  • fixed unittest: avoid overwrite warning
  • warn when overwriting any globally defined variable
  • Merge pull request #102 from ubi-agni/completion bash completion
  • Merge pull request #99 from ubi-agni/jade-devel reworked macro resolution
  • moved test_macro_name_with_colon() to class TestXacro should be tested both, in oldorder and inorder mode
  • bash completion
  • improved error message for failed $(find)
  • reworked macro resolution python-eval-based macro resolution (introduced to enable namespaces) heavily restricted the set of possible macro names (only valid python identifiers were allowed) Particularly, xacro: prefixed macro names were forbidden.
  • initial attempt to fix #97
  • add failing test case with colon in the macro name
  • Contributors: Robert Haschke

1.10.4 (2015-06-18)

  • removed test_DEPRECATED_should_replace_before_macroexpand() duplicates test_should_replace_before_macroexpand()
  • fixed evaluation order of macro arguments and body Macro arguments need to be evaluated and assigned to properties before body is evaluated. Otherwise, the evaluated value will be converted to str, i.e. loosing original type.
  • Contributors: Robert Haschke

1.10.3 (2015-06-16)

  • deprecate --oldorder processing
  • added --check-order option to do a simple check for --inorder compatibility
    • Most probable incompatibility is redefining a property after its usage.
    • tested and reported with file location of (first) redefinition after usage.
  • moved command line processing to cli.py
  • explain verbosity levels in usage string
  • colorize errors during cli parsing
  • log definition and usage of properties
  • replaced debug option by verbosity options -q, -v
  • fixed evaluation time of default macro params
  • introduced Macro object to increase code readability
  • parse a macro's parameter list once at declaration time (instead of every instantiation)
  • extended test_multiple_blocks() to check for both normal and reversed order
  • added unittest to increase code coverage
  • do not issue deprecation warning for <include> tags that are non-xacro
  • added option --oldorder
  • allow to store properties to parent or global scope
  • added <xacro:attribute>
  • cleaned up error message about missing files
  • moved xml-specific functions to xmlutils.py new generic functions opt_attrs(), reqd_attrs(), and check_attrs() to fetch optional and required attributes and warn about unknown ones in a uniform fashion
  • unittest to allow empty <arg> defaults
  • Merge pull request #94 from ubi-agni/minor-fixes
  • minor fixes
  • remove duplicates in --deps output
  • fixed dependency checking for --inorder mode (which requires full processing)
  • fixed doc of xacro' cmake macros
  • renamed "xacro:rename" to "xacro:element"
  • allow namespacing for xacro:include's
  • allow renaming of element names using xacro:rename
  • unittest cleanup
  • check property and macro names to be valid python identifiers
  • allow namespacing of xacro:include's
  • properties and macros in an included file will go into their own, separate namespace, if the XML attribute [ns]{.title-ref} is provided. Access is by standard python syntax: namespace.name
  • allow renaming of element names <xacro:rename xacro:name="<new element name>"/>
  • moved unittests requiring --inorder processing to class TestXacroInorder
  • added unittest test_dynamic_macro_undefined()
  • improved error message when variable include filename is used without --inorder
  • stripped down unittest test_inorder_processing()
  • improved processing
  • adapted pr2 gold standard removing most comments again this partially reverts 59605fb1521583dc63efdea13f4c45128499bd20
  • remove all XML comments directly before xacro elements (These are considered xacro-related only and should be removed in the final doc.) Leaving an empty line between xacro-unrelated and xacro-related comments allows to include the former.
  • unittest: test_ignore_xacro_comments()
  • improved processing
    • recursive (instead of iterative) eval_all()
    • reusable process_include()
    • replace_node() function to replace xacro tag by some other content
    • avoid reprocessing of nodes
    • avoid deep copy where possible (speedup)
  • fix evaluation (#83)
  • yaml support
  • check for consistency of xml namespaces on xacro:include
  • replaced strip()=='' by more efficient isspace()
  • allow transitive definition of substition args
  • fixed evaluation of literals in property definitions
    • literals with preceding whitespace will be silently stripped (#83)
    • more complex evaluation test (perturbing spaces added)
  • fixed xacro namespaces in pr2 files to get rid of new inconsistency warning
  • warning message on inconsistent namespace redefinition for includes
  • yaml support ${load_yaml('file.yaml')} to load dict from yaml file
  • Merge pull request #85 from ubi-agni/error-reporting improved error reporting
  • nicer formatting of multiple "when evaluating expression" lines
  • improved formatting of error messages use XacroException to wrap and augment other exceptions to achieve a clearer error formatting
  • better error message for missing substitution args
  • use colorized warnings where possible
  • included macro stack in error-reporting
  • maintain filestack to facilitate error reporting at any time
  • Merge pull request #82 from ubi-agni/unittests improved unittesting
  • allow to capture (and check) stderr in unit tests
  • improved unittests to test both, classic and in-order processing
  • Merge pull request #81 from ubi-agni/jade-devel Thank you for your time and contributions. Improving cosmetics is important.
  • PEP8 cleanup
  • cmake: only copy files to devel space if new
  • Merge pull request #80 from ubi-agni/jade-devel
  • improved error-handling opening the output file - running multiple xacro process in parallel, all writing into a new dir could cause a race condition when creating the dir
    • improved error message on output creation failure
  • removed rospy dependency
    • Importing rospy caused build order issues with ros_comm in workspace
  • Filtering out REMAP command-line arguments is done manually now.
  • update authors/maintainers and copyright statements
  • deprecate non-namespaced xacro tags
  • added missing print_location_msg() for file that actually failed parsing
  • improved deprecation warnings
  • New cli option [--xacro-ns]{.title-ref} allows to enforce the new policy requiring the xacro namespace prefix (and suppressing deprecation warnings). However, non-prefixed tags will not be modified by xacro anymore (as requested by #41, #59, #60). Partially reverted cb73cfd8c678adfda2172accef398189ea2338a1, handling <arg> tags in the same fashion as other tags, i.e. issue a warning if used without prefix and ignoring it with cli argument [--xacro-ns]{.title-ref}.
  • fixed pr2 xacro files to use 'xacro:' prefixed tags only
  • fixed unittests in test_xacro.py to use 'xacro:' prefixed tags only
  • deprecation message for missing xacro namespace prefix in xml tags
  • moved colored warning messages into color.py (for reuseability)
  • added missing print_location_msg() for file that actually failed parsing
  • improved xacro's cmake macros
  • prepend ${PACKAGE_NAME} to all generated cmake targets Otherwise multiple packages employing xacro's cmake macros will use the same conflicting target name. This is only an issue with catkin_make, which defines a single global cmake namespace. The new catkin tools (or catkin_make_isolated) build each package separately.
  • basic unittest for xacro's cmake macros
  • improved xacro's cmake macros - xacro_add_xacro_file() automatically determines output file from input (removing .xacro suffix). If that fails, a fatal error is raised.
    • added xacro_install() to allow installation into both, devel and install space.
    • replaced conveniency function xacro_add_files()
  • Contributors: Robert Haschke

1.10.2 (2015-05-23)

  • added --debug option to explicitly enable stack traces By default, only show error message to the user. Stack traces are only interesting for xacro developers.
  • recursive include processing
    • more informed error messages (which file was included from where)

    - allows relative path names for include filename specs they are interpreted relative to the current file

  • new substitution command $(cwd) to extract current working directory
  • added unittest cases
    • creation of required subdirs for output
    • recursive xacro:include
    • extended test_include_glob() to check for all glob patterns
  • added run_xacro() function to simplify unittests running xacro script
  • moved xacro.py back to original location
  • nicely colored deprecation warning
  • create required dirs before opening output file
  • added convenience cmake-macro xacro_add_target() to auto-generate xacro-processed files
  • added cmake status message before launching xacro (xacro might run for quite a while)
  • fetch xacro --deps errors at report them as a warning
  • simplified deprecation message
  • added missing return statement
  • removed obsolete math import left over from deaaae2c69edd7d5e185eeb098c1521d8711608b
  • install xacro.py again (for backwards compatibility) usage of xacro.py issues a deprecation warning
  • simplified scripts/xacro - removed xacro.py
    • made run script "scripts/xacro" and install process follow standards
    • removed xacro.py

    - added dependencies to setup.py Having the binaries xacro and xacro.py installed side by side causes problems, because xacro.py is wrongly taken as the module. This was avoided by the rather complex filtering of the sys.path. Switched to ROS standard now, using a binary script called "xacro".

  • changed tests to use the whole xacro processing pipeline utilizing the modularization of main() from previous commit This simplifies several existing tests, especially these using files on disk.
  • split main() into process_cli_arg(), parse(), process_doc()
  • extended cmake macro xacro_add_xacro_file()
    • handle INORDER option
    • handle REMAP arguments

    - create absolute input file names automatically usage: xacro_add_xacro_file(input output INORDER REMAP ...)

  • stripped new unit tests to essential xml snippets
  • merged pull request #68: eval properties assigned from <arg> tags as literals In the following example: <xacro:arg name="val" default="0.5"/> <xacro:property name="val" value="$(arg val)"/> ${val} was not evaluated as a number, but as string only. Thus numerical expressions failed with an exception.
  • factored out get_boolean_value()
  • <xacro:arg> needs to be fully specified
  • (handling <arg> tags (without xacro ns-prefix) disabled native <arg> tags) add test for eating launch parameter arguments remove check for "arg" parameter. move new test function to bottom of source
  • added unit tests for evaluation of list, tuple, and dict literals
  • fixed some code style issues
  • fixed string-isinstance checks (for python 3 compatibility)
  • do not evaluate list, dict, tuple expressions as literals (without ${} syntax)
  • added dict to list of known global symbols
  • focused global_symbols definition in the beginning of the file added some basic python symbols: list, str, float, int and map allowing some basic computation
  • tuning performance: instantiate QuickLexer's regexps only once
  • Contributors: Robert Haschke, Martin Pecka, Mike O'Driscoll, Morgan Quigley

1.10.1 (2015-04-01)

  • improved error handling and more descriptive error messages
  • correctly raise a XacroException on invalid, i.e. non-boolean, <xacro:if> expressions. (removed left-over debugging code, added test case)
  • raise an exception on undefined, but used macros Using the syntax <xacro:macroname/> should raise an exception if macroname is not defined. Added appropriate code and a test case.
  • fixed bookkeeping in lazy evaluation switch Table.unevaluated from list to set to avoid multiple key entries
  • fix formatting of changelog
  • Contributors: Robert Haschke

1.10.0 (2015-03-13)

  • security measure: forbid access to __builtins__ in expressions
  • literal evaluation should only consider literals, but no expressions use ast.literal_eval()
  • removed eval() from xacro:if evaluation
  • back to string comparison to handle (lowercase) true and false
  • add test case for equality expressions in <xacro:if>
  • add test case for math function usage
  • python based evaluation of expressions
    • replaced handle_expr with python-internal eval() call
    • care has been taken to resolve variables recursively on demand (in Table.__getitem__)
    • allows for evaluation of standard math functions
    • other desired functions could be added in eval_self_contained
    • Values in Table symbols are not stored as strings but as typed values.
  • If text is required, a conversion with str() is performed, to ensure proper evaluation of expressions. Otherwise 3*"1" would evaluate to "111".
  • use __future__.division we can handle integer division evaluating to floating-point devision, as before
  • allow variable names for filename attribute in <xacro:include>
  • allow for ordered XML processing to avoid issues with multiply defined properties and macros in (typically 3rd party) include files
    • enable the new behaviour by passing --inorder cmdline option
    • to improve code readibility and reusability, introduced functions
  • process_include(node), grab_macro(elt, macros), grab_property(elt, symbols) containing 1:1 corresponding handling from process_includes, grab_macros, and grab_properties
    • added corresponding test case test_inorder_processing()
  • dynamic macro names using <xacro:call macro=""/>
  • fixup unittests and handling of non-element nodes in <include>, <if>, <macro>
  • updated pr2 gold standard to include all comments
  • allow to ignore comments in nodes_match()
  • New handling of non-element nodes invalidates pr2 gold standard (adding a lot more comments). To allow validation, allow to ignore all comments in comparison (as before).
  • fixed handling of non-element nodes in <include>, <if>, <macro>
  • fixed writexml: text nodes were not printed when other siblings exist
    • print all text, but skip whitespace-only text nodes
  • improved xml matching
    • so far only element nodes (with its attributes) were considered
    • now also consider TEXT, CDATA, and COMMENT nodes
    • added function text_matches (normalizing consecutive whitespace to a single space)
    • added some new unit tests

    - test_consider_non_elements: non-element nodes are not yet considered in <if> and <macro>

  • travis-ci: use catkin_make
  • travis-ci: fixup running of tests
  • fix pathnames used in test case
  • Include CATKIN_ENV params at build time.
  • use output filename flag instead of shell redirection
  • create output file after parsing is complete, not before
  • Contributors: Robert Haschke, Mike O'Driscoll, Morgan Quigley, William Woodall

1.9.3 (2015-01-14)

  • merge test cases
  • add a snapshot of the pr2 model to the test directory. add a test case which verifies that the pr2 model is parsed equal to a 'golden' parse of it.
  • add more tests
  • add default arg tests
  • Allow default values for substitution args
  • Fix up comments
  • Allow xacro macros to have default parameters
  • Contributors: Paul Bovbel, Morgan Quigley

1.9.2 (2014-07-11)

  • add a few more tests to exercise the symbol table a bit more
  • allow for recursive evaluation of properties in expressions
  • add useful debugging information when parameters are not set
  • stop test from failing the second time it is run
  • unified if/unless handling, correctly handle floating point expressions
  • floating point expressions not equal zero are now evaluated as True
  • changed quotes to omit cmake warning
  • Contributors: Robert Haschke, Mike Ferguson

1.9.1 (2014-06-21)

  • fixup tests so they run
  • export architecture_independent flag in package.xml
  • installed relocatable fix
  • Contributors: Michael Ferguson, Mike Purvis, Scott K Logan

1.9.0 (2014-03-28)

  • Remove the roslint_python glob, use the default one.
  • Add roslint target to xacro; two whitespace fixes so that it passes.
  • fix evaluation of integers in if statements also added a unit test, fixes #15
  • fix setting of _xacro_py CMake var, fixes #16
  • Add support for globbing multiple files in a single <xacro:include>
  • code cleanup and python3 support
  • check for CATKIN_ENABLE_TESTING

1.8.4 (2013-08-06)

  • Merge pull request #9 from davetcoleman/hydro-devel Xacro should not use plain 'include' tags but only namespaced ones.
  • Fix for the fact that minidom creates text nodes which count as child nodes
  • Removed <uri> checking and made it more general for any child element of an <include> tag
  • Removed Groovy reference, only being applied to Hydro
  • Created check for Gazebo's <uri> tabs only only shows deprecated warnings if not present.
  • Small spelling fix
  • Xacro should not use plain 'include' tags but only namespaced ones.
  • Merge pull request #8 from piyushk/hydro-devel-conditional xacro conditional blocks
  • using refined arguments instead of sys.argv for xml file location
  • adding conditional blocks to xacro

1.8.3 (2013-04-22)

  • bumped version to 1.8.3 for hydro release
  • backwards compatilibity with rosbuild
  • adding unit test for substitution args
  • Adding supoprt for substitution_args 'arg' fields
  • Remove bin copy of xacro.py
  • 1.7.3
  • Install xacro.py as a program so it can be run
  • 1.7.2
  • fixed build issues introduced in catkinization
  • 1.7.1
  • PEP8, cleanup, and remove roslib
  • Update copyright, self import guard, and catkinize
  • Catkinize.
  • Cleanup in preparation of catkinization.
  • Added tag unstable for changeset 169c4bf30367
  • Added tag xacro-1.6.1 for changeset fc45af7fdada
  • 1.6.1 marker
  • xacro: fuerte compat with sub args import
  • Added tag unstable for changeset 2d3c8dbfa3c9
  • Added tag xacro-1.6.0 for changeset e4a4455189bf
  • 1.6.0
  • converted to unary stack from common stack
  • xacro: fixed inserting property blocks (ros-pkg #4561)
  • xacro now uses XacroExceptions. String exceptions are not allowed in Python anymore. #4209
  • Added Ubuntu platform tags to manifest
  • Xacro now places comments below <?xml> tag (#3859)
  • Xacro prints out cleaner xml. Elements are now often separated by a newline.
  • xacro dependency on roslaunch removed #3451
  • Xacro now adds a message mentioning that the file was autogenerated (#2775)
  • Remove use of deprecated rosbuild macros
  • Integers stay integers in xacro, fixing #3287
  • Tests for r25868
  • Added a flag for only evaluating include tags in xacro
  • Allowing multiple blocks and multiple insert_blocks, fixing #3322 and #3323
  • doc review completed for xacro
  • adding mainpage for xacro doc review
  • Added xacro.cmake file that exports new xacro_add_xacro_file() macro, #3020
  • Namespaced "include" tag in xacro
  • Marked xacro as api reviewed
  • Xacro now correctly declares the namespaces of the included documents in the final
  • Made xacro accept xml namespaces
  • Xacro now errors hard when a property is used without being declared
  • Xacro no longer allows you to create properties with "${}" in the name
  • Added the ability to escape "${" in xacro
  • Made the tests in xacro run again.
  • Created xacro/src
  • migration part 1

Wiki Tutorials

This package does not provide any links to tutorials in it's rosindex metadata. You can check on the ROS Wiki Tutorials page for the package.

Package Dependencies

System Dependencies

No direct system dependencies.

Dependant Packages

Name Deps
abb_irb2400_moveit_config
abb_irb4400_support
abb_irb6640_moveit_config
abb_irb6640_support
adi_driver
ati_force_torque
audibot_description
rokubimini_description
clover_description
clover_simulation
cob_calibration_data
cob_description
raw_description
cob_cartesian_controller
cob_obstacle_distance
cob_twist_controller
cob_grasp_generation
cob_hardware_config
cob_moveit_config
cob_gazebo_worlds
copernicus_description
crane_x7_moveit_config
create_description
dbw_fca_description
dbw_mkz_description
dbw_polaris_description
denso_robot_moveit_config
desistek_saga_description
dingo_description
eca_a9_description
ensenso_description
fake_joint_driver
fanuc_cr35ia_support
fanuc_cr7ia_moveit_config
fanuc_cr7ia_support
fanuc_cr7ial_moveit_config
fanuc_lrmate200i_moveit_config
fanuc_lrmate200i_support
fanuc_lrmate200ib3l_moveit_config
fanuc_lrmate200ib_moveit_config
fanuc_lrmate200ib_support
fanuc_lrmate200ic5h_moveit_config
fanuc_lrmate200ic5l_moveit_config
fanuc_lrmate200ic_moveit_config
fanuc_lrmate200ic_support
fanuc_m10ia_moveit_config
fanuc_m10ia_support
fanuc_m16ib20_moveit_config
fanuc_m16ib_support
fanuc_m20ia10l_moveit_config
fanuc_m20ia_moveit_config
fanuc_m20ia_support
fanuc_m20ib25_moveit_config
fanuc_m20ib_support
fanuc_m430ia2f_moveit_config
fanuc_m430ia2p_moveit_config
fanuc_m430ia_support
fanuc_m6ib6s_moveit_config
fanuc_m6ib_moveit_config
fanuc_m6ib_support
fanuc_m710ic_support
fanuc_m900ia_support
fanuc_m900ib_support
fanuc_r1000ia80f_moveit_config
fanuc_r1000ia_support
fanuc_lrmate200id7l_moveit_config
fanuc_lrmate200id_moveit_config
fanuc_lrmate200id_support
fanuc_r2000ib_support
fanuc_r2000ic_support
fath_pivot_mount_description
fetch_gazebo
fetch_description
fetch_moveit_config
flir_ptu_description
franka_description
franka_visualization
fsrobo_r_moveit_config
hector_components_description
hector_sensors_description
hector_xacro_tools
heifu_description
heron_description
heron_simulator
human_description
husky_description
husky_cartographer_navigation
igvc_self_drive_description
jackal_description
jackal_navigation
jackal_cartographer_navigation
jsk_data
jsk_pcl_ros
khi_duaro_moveit_config
khi_rs007l_moveit_config
khi_rs007n_moveit_config
khi_rs013n_moveit_config
khi_rs020n_moveit_config
khi_rs025n_moveit_config
khi_rs030n_moveit_config
khi_rs080n_moveit_config
kobuki_description
lauv_description
leo_description
leo_viz
leo_bringup
leuze_description
robot
microstrain_inertial_description
tra1_description
tra1_moveit_config
mir_description
moose_description
moveit_setup_assistant
moveit_resources_dual_panda_moveit_config
moveit_resources_fanuc_moveit_config
moveit_resources_panda_description
moveit_resources_panda_moveit_config
moveit_resources_prbt_moveit_config
moveit_resources_prbt_pg70_support
moveit_resources_prbt_support
mrp2_slam
mrp2_navigation
open_manipulator_description
open_manipulator_p_description
open_manipulator_p_gazebo
open_manipulator_gazebo
open_manipulator_with_tb3_description
open_manipulator_with_tb3_waffle_moveit
open_manipulator_with_tb3_waffle_pi_moveit
open_manipulator_with_tb3_gazebo
openni_description
panda_moveit_config
pass_through_controllers
pf_description
pheeno_ros_description
prbt_gazebo
prbt_moveit_config
prbt_support
pincher_arm_bringup
pincher_arm_moveit_config
play_motion
pointgrey_camera_description
pouco2000_ros_gazebo
pr2_description
pr2_gazebo
prbt_pg70_support
psen_scan_v2
raspimouse_description
raspimouse_gazebo
rc_visard_description
rexrov2_description
ridgeback_description
ridgeback_navigation
ridgeback_cartographer_navigation
robot_upstart
robotont_description
robotont_nuc_description
ackermann_steering_controller
diff_drive_controller
effort_controllers
gripper_action_controller
joint_trajectory_controller
cartesian_trajectory_controller
rotors_gazebo
schunk_description
sciurus17_moveit_config
seed_r7_description
seed_r7_gazebo
seed_r7_moveit_config
seed_r7_typef_moveit_config
seed_r7_typeg2_arm_moveit_config
seed_r7_typeg_arm_moveit_config
seed_r7_typeg_moveit_config
sick_ldmrs_description
sick_tim
sr_description
sr_edc_launch
sr_moveit_hand_config
sr_multi_description
sr_box_ur10_moveit_config
sr_multi_moveit_config
sr_multi_moveit_test
staubli_rx160_moveit_config
staubli_rx160_support
staubli_tx2_60_support
staubli_tx2_90_support
staubli_tx60_support
staubli_tx90_support
talos_description
talos_description_calibration
talos_description_inertial
trac_ik_examples
turtlebot3_description
uwsim
ur10_moveit_config
ur10e_moveit_config
ur16e_moveit_config
ur3_moveit_config
ur3e_moveit_config
ur5_moveit_config
ur5e_moveit_config
ur_description
uos_common_urdf
urdf_geometry_parser
urdf_sim_tutorial
urdf_test
urdf_tutorial
urg_node
uuv_thruster_manager
uuv_descriptions
uuv_gazebo_ros_plugins
uuv_sensor_ros_plugins
velodyne_description
warthog_description
xpp_hyq
xpp_quadrotor

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

No plugins found.

Recent questions tagged xacro at Robotics Stack Exchange