Adding 'doc' attribute to roslaunch <arg> tags #379
Conversation
|
The output for the following roslaunch file is shown below: <launch>
<arg name="foo" default="true" doc="I pity the foo'."/>
<arg name="bar" doc="Someone walks into this."/>
<arg name="baz" default="false"/>
<arg name="nop"/>
</launch> |
|
Actually, I just had another idea on the output, so hold off on this PR. |
|
With the revised commit, it outputs the following: |
|
Please remove all Python related changes from the PR. There is a separate PR pending for Python 3 compatibility (#358). |
|
Will do. |
|
Updated to remove python3 future stuff. |
| @@ -45,7 +45,8 @@ | |||
| def get_args(roslaunch_files): | |||
| loader = roslaunch.xmlloader.XmlLoader(resolve_anon=False) | |||
| config = load_config_default(roslaunch_files, None, loader=loader, verbose=False, assign_machines=False) | |||
| return loader.root_context.resolve_dict['arg'] | |||
| resolve_dict = loader.root_context.resolve_dict | |||
| return resolve_dict['arg_doc'] if 'arg_doc' in resolve_dict else dict() | |||
There was a problem hiding this comment.
Please use the following instead:
return getattr(loader.root_context.resolve_dict, 'arg_doc', {})
There was a problem hiding this comment.
Replaced with return loader.root_context.resolve_dict.get('arg_doc', {})
|
The current PR has the following behavior: <launch>
<!-- ros_args.launch -->
<arg name="foo" default="true" doc="I pity the foo'."/>
<arg name="bar" doc="Someone walks into this."/>
<arg name="baz" default="false"/>
<arg name="nop"/>
<arg name="fix" value="true"/>
</launch> |
|
Could you also create a simple test which invoked the command line / API on the example launch file you already added? That would ensure that the functionality will keep working in the future. |
|
Unit test added. |
|
Thank you for that great PR. The CI job passes and the output of One minor thing before the merge, can please also update the test script to use spaces after commas as well as after colons in a dict (to follow PEP8). |
* This adds a 'doc' attribute to the roslaunch <arg> tag * This tag is read in and stored in the resolve_dict under 'arg_doc' * The keys in resolve_dict['arg_doc'] are the argument names, and the values are tuples where the first element is None or the doc string, and the second element is None or the default value. * The arg_dump.get_args function still returns a dict, so the return value's keys can still be used for a list of arg names. * A unit test has been added to test_roslaunch/test/roslaunch.test which loads the ros_args.launch launchfile and compares the output of arg_dump.get_args to the expected output.
Done. |
Adding 'doc' attribute to roslaunch <arg> tags
|
Wiki page is updated for this change. Please add any correction if necessary. |
Adding 'doc' attribute to roslaunch <arg> tags
This is implemented as described in #294 (comment)
Additionally, it brings
arg_dump.pyinto python3 compliance with theprint()function.This should also be a viable modification for release into hydro.