Source Code for Module roslaunch.arg_dump

 1  # Software License Agreement (BSD License) 
 2  # 
 3  # Copyright (c) 2013, Willow Garage, Inc. 
 4  # All rights reserved. 
 5  # 
 6  # Redistribution and use in source and binary forms, with or without 
 7  # modification, are permitted provided that the following conditions 
 8  # are met: 
 9  # 
10  #  * Redistributions of source code must retain the above copyright 
11  #    notice, this list of conditions and the following disclaimer. 
12  #  * Redistributions in binary form must reproduce the above 
13  #    copyright notice, this list of conditions and the following 
14  #    disclaimer in the documentation and/or other materials provided 
15  #    with the distribution. 
16  #  * Neither the name of Willow Garage, Inc. nor the names of its 
17  #    contributors may be used to endorse or promote products derived 
18  #    from this software without specific prior written permission. 
19  # 
20  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
21  # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
22  # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
23  # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
24  # COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
25  # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
26  # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
27  # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
28  # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
29  # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
30  # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
31  # POSSIBILITY OF SUCH DAMAGE. 
32  # 
33  # Revision $Id$ 
34   
35  from __future__ import print_function 
36   
37  """ 
38  Utility module of roslaunch that computes the command-line arguments 
39  for a launch file. 
40  """ 
41   
42  import sys 
43  import roslaunch.xmlloader 
44  from roslaunch.core import RLException 
45  from roslaunch.config import load_config_default 
46   
47 -def get_args(roslaunch_files): 
48      loader = roslaunch.xmlloader.XmlLoader(resolve_anon=False, args_only=True) 
49      config = load_config_default(roslaunch_files, None, loader=loader, verbose=False, assign_machines=False) 
50      return loader.root_context.resolve_dict.get('arg_doc', {}) 
51   
52 -def dump_args(roslaunch_files): 
53      """ 
54      Print list of args to screen. Will cause system exit if exception 
55      occurs. This is a subroutine for the roslaunch main handler. 
56   
57      @param roslaunch_files: list of launch files to load 
58      @type  roslaunch_files: str 
59      """ 
60   
61      try: 
62          args = get_args(roslaunch_files) 
63   
64          if len(args) == 0: 
65              print("No arguments.") 
66          else: 
67              required_args = [(name, (doc or 'undocumented', default)) for (name, (doc, default)) in args.items() if not default] 
68              optional_args = [(name, (doc or 'undocumented', default)) for (name, (doc, default)) in args.items() if default] 
69   
70              if len(required_args) > 0: 
71                  print("Required Arguments:") 
72                  for (name, (doc, _)) in sorted(required_args): 
73                      print("  %s: %s" % (name, doc)) 
74   
75              if len(optional_args) > 0: 
76                  print("Optional Arguments:") 
77                  for (name, (doc, default)) in sorted(optional_args): 
78                      print("  %s (default \"%s\"): %s" % (name, default, doc)) 
79   
80      except RLException as e: 
81          print(str(e), file=sys.stderr) 
82          sys.exit(1) 
83