Converted file_format script to python and added command line auto-completion of paths/ros packages using autocomplete.py

Author: ipa-srd-rd

cfg/pep8.cfg

@@ -0,0 +1,3 @@
+[pep8]
+in-place = true
+max-line-length = 120

src/autocomplete.py

@@ -0,0 +1,24 @@
+#!/usr/bin/env python
+
+
+class AutoComplete(object):  # Custom completer
+
+    def __init__(self, options=[]):
+        self.options = sorted(options)
+
+    def complete(self, text, state):
+        if state == 0:  # on first trigger, build possible matches
+            if text:  # cache matches (entries that start with entered text)
+                self.matches = [s for s in self.options
+                                if s and s.startswith(text)]
+            else:  # no text entered, all matches possible
+                self.matches = self.options[:]
+
+        # return match indexed by state
+        try:
+            return self.matches[state]
+        except IndexError:
+            return None
+
+    def set_options(self, options):
+        self.options = sorted(options)

src/cpp_format

@@ -4,4 +4,4 @@ echo
 echo "This is an auto-formatting script for .h/.cpp files."
 echo
 
-./file-format 'cpp'
+rosrun ipa_code_refactoring file_format.py 'cpp'

src/file_format

@@ -0,0 +1,111 @@
+#!/usr/bin/env python
+
+from operator import itemgetter
+from sets import Set
+import re
+import sys
+import os.path
+import os
+import subprocess
+import rospkg
+import fnmatch
+import yaml
+import readline
+import glob
+from autocomplete import AutoComplete
+
+# Function for user input completion of the current path
+def complete_path(text, state):
+    return (glob.glob(text + '*') + [None])[state]
+
+
+# Important global variables
+rospack = rospkg.RosPack()
+
+try:
+    this_pkg_path = rospack.get_path('ipa_code_refactoring')
+except Exception, e:
+    print "Unable to find ROS Package with name 'ipa_code_refactoring'."
+    sys.exit()
+
+# set autocompletion to ros packages
+try:
+    autocomplete = AutoComplete(rospack.list())
+except Exception, e:
+    print "Unable to get ROS Package List."
+    sys.exit()
+
+readline.set_completer_delims(' \t\n;')
+readline.set_completer(complete_path)
+readline.parse_and_bind('tab: complete')
+
+
+exec_policy = {'cpp': ' -name "*.h" -or -name "*.hpp" -or -name "*.cpp" | xargs rosrun ipa_code_refactoring clang-format -i -style=file',            # CPP
+               'py': ' -name "*.py" | xargs autopep8 --global-config ' + this_pkg_path + '/cfg/pep8.cfg'}                                            # Python
+
+if len(sys.argv) <= 1:
+    print 'You need to provide a file type. Program shutting down now.'
+    sys.exit()
+
+file_type = sys.argv[1]
+
+
+print
+print "1)  Do you want to \n\t[a] Format all files within the 'src' Folder \n\t[b] Format all files in certain ROS packages \n\t[c] Format all files within a repository"
+
+user_input = raw_input("Choice:  ")
+
+if user_input in ['a', 'A']:
+    print "\n2)  Please enter the full path to your 'src' folder:"
+    input_src_path = raw_input("Path:  ")
+    os.system('find ' + input_src_path + exec_policy.get(file_type))
+    print "Formatted all files in:  '" + input_src_path + "'\n"
+
+elif user_input in ['b', 'B']:
+    readline.set_completer(autocomplete.complete)
+    print "\n2)  Specify the ROS packages you want to format (quit by entering [q/Q]):"
+    input_ros_pkg = raw_input("ROS Package:  ")
+
+    while input_ros_pkg not in ['q', 'Q']:
+        # try to find ros package by name
+        try:
+            ros_pkg_path = rospack.get_path(input_ros_pkg)
+        except Exception, e:
+            print "Can't find ROS Package with name '" + input_ros_pkg + "', please try another one."
+            continue
+
+        # format all files according to the selected file type
+        os.system('find ' + ros_pkg_path + exec_policy.get(file_type))
+        print "Formatted all files in:  '" + ros_pkg_path + "'\n"
+
+        # read in new ros package
+        input_ros_pkg = raw_input("ROS Package:  ")
+
+elif user_input in ['c', 'C']:
+    print "\n2)  Please enter the full path to your 'src' folder:"
+    input_src_path = raw_input("Path:  ")
+    if not os.path.isdir(input_src_path):
+        print "Path does not exist. Program will shut down now."
+        sys.exit()
+
+    autocomplete.set_options(next(os.walk(input_src_path))[1])
+    readline.set_completer(autocomplete.complete)
+    print "3)  Specify the repositories you want to format (quit by entering [q/Q]):"
+    input_repo_name = raw_input("Repository:  ")
+
+    while input_repo_name not in ['q', 'Q']:
+        if not os.path.isdir(input_src_path + '/' + input_repo_name):
+            print "Path does not exist, please try again."
+        else:
+            # format all files according to the selected file type
+            repo_path = (input_src_path + '/' + input_repo_name).replace('//', '/')
+            os.system('find ' + repo_path + exec_policy.get(file_type))
+            print "Formatted all files in:  '" + repo_path + "'\n"
+
+        # read new repo
+        input_repo_name = raw_input("Repository:  ")
+
+else:
+    print "Error! Wrong character, program is shutting down now."
+
+print "\nProgram is shutting down now."

src/file_format.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python
 
+from autocomplete import AutoComplete
 from operator import itemgetter
 from sets import Set
 import re
@@ -10,6 +11,7 @@
 import rospkg
 import fnmatch
 import yaml
+import readline
 
 
 def print_params(input_list):
@@ -233,7 +235,6 @@ def find_file(in_root_path, in_file_name):
 
 # read config-yaml file
 this_cfg = {}
-print this_cfg_path
 if os.path.exists(this_cfg_path):
     with open(this_cfg_path, 'r') as stream:
         try:
@@ -255,28 +256,36 @@ def find_file(in_root_path, in_file_name):
 
 editor = this_cfg.get('editor', 'subl')
 
+# add autocompletion of ros packages
+try:
+    autocomplete = AutoComplete(rospack.list())
+except Exception, e:
+    print "Unable to get ROS Package List."
+    sys.exit()
+
+readline.set_completer_delims(' \t\n;')
+readline.set_completer(autocomplete.complete)
+readline.parse_and_bind('tab: complete')
+
 # check if additional filename was provided,
 # otherwise take the package name as filename
-if len(sys.argv) <= 1:
-    print 'You need to provide at least a package name. Program shutting down now.'
-    sys.exit()
+print "\n1)  Specify the name of the ROS package for parameter updates:"
+input_ros_pkg = raw_input("ROS Package:  ")
 
-pkg_name = sys.argv[1]
-if len(sys.argv) > 2:
-    file_name = sys.argv[2]
-else:
-    file_name = pkg_name
+print "\n1)  Specify the name of the node if it differs from the ROS package name (optional):"
+input_node_name = raw_input("Node name:  ")
 
-old_names = []
-new_names = []
-zip_names = zip(old_names, new_names)
+if len(input_node_name) > 0:
+    file_name = input_node_name
+else:
+    file_name = input_ros_pkg
 
 
 # find path to ros package
 try:
-    pkg_path = rospack.get_path(pkg_name)
+    pkg_path = rospack.get_path(input_ros_pkg)
 except Exception, e:
-    print "Can't find ROS Package with name '" + pkg_name + "'"
+    print "Can't find ROS Package with name '" + input_ros_pkg + "'"
     sys.exit()
 
 # find cpp, cfg and yaml files in pkg_path
@@ -295,6 +304,9 @@ def find_file(in_root_path, in_file_name):
 # list of methods for constructing lines for missing parameters
 extract_values = [extract_values_common, extract_values_ros, extract_values_cfg, extract_values_yaml]
 
+old_names = []
+new_names = []
+zip_names = zip(old_names, new_names)
 
 ### Regular Expressions ###
 

src/param_update.py

@@ -12,4 +12,4 @@ echo
 echo "This is an auto-formatting script for .py files."
 echo
 
-./file-format 'py'
+rosrun ipa_code_refactoring file_format.py 'py'