splunklib.searchcommands bug fixes

Author: David Noble

splunklib/searchcommands/search_command.py

@@ -275,7 +275,7 @@ def service(self):
     #region Methods
 
     def error_exit(self, error):
-        self.logger.error('Abnormal exit: ' + error)
+        self.logger.error('Abnormal exit: %s', error)
         self.write_error(error)
         exit(1)
 

splunklib/searchcommands/search_command_internals.py

@@ -275,8 +275,7 @@ def parse(self, argv, command):
 
         # Parse options
 
-        for option in SearchCommandParser._options_re.finditer(
-                command_args.group('options')):
+        for option in SearchCommandParser._options_re.finditer(command_args.group('options')):
             name, value = option.group(1), option.group(2)
             if not name in command.options:
                 raise ValueError('Unrecognized option: %s = %s' % (name, value))
@@ -288,9 +287,7 @@ def parse(self, argv, command):
             if len(missing) == 1:
                 raise ValueError('A value for "%s" is required' % missing[0])
             else:
-                raise ValueError(
-                    'Values for these options are required: %s' %
-                    ', '.join(missing))
+                raise ValueError('Values for these options are required: %s' % ', '.join(missing))
 
         # Parse field names
 
@@ -365,9 +362,9 @@ def replace(match):
 
     _options_re = re.compile(r"""
         # Captures a set of name/value pairs when used with re.finditer
-        ([_a-zA-Z][_a-zA-Z0-9]+)       # name
-        \s*=\s*                        # =
-        ([^\s"]+|"(?:[^"]+|""|\\")*")  # value
+        ([_a-zA-Z][_a-zA-Z0-9]+)         # name
+        \s*=\s*                          # =
+        ([^\s"]+|"(?:[^\\"]+|\\.|"")*")  # value
         """, re.VERBOSE)
 
     #endregion

splunklib/searchcommands/splunk_csv/dict_writer.py

@@ -63,7 +63,7 @@ def _encode_list(self, value):
         multi_value = ';'.join(
             ['$' + DictWriter._to_string(item).replace('$', '$$') + '$' for item
              in value])
-        value = self._mv_delimiter.join([repr(item) for item in value])
+        value = self._mv_delimiter.join([DictWriter._to_string(item) for item in value])
         return value, multi_value
 
     def _header_written(self):
@@ -73,8 +73,8 @@ def _header_written(self):
     def _to_string(item):
         if isinstance(item, bool):
             return 't' if item else 'f'
-        if isinstance(item, str):
-            return item
+        if isinstance(item, basestring):
+            return item.decode('utf-8')
         if isinstance(item, Number):
             return str(item)
         return repr(item)

splunklib/searchcommands/validators.py

@@ -214,6 +214,24 @@ def format(self, value):
         return value[:-1]
 
 
+class Map(Validator):
+    """ Validates map option values.
+
+    """
+    def __init__(self, **kwargs):
+        self.membership = kwargs
+
+    def __call__(self, value):
+        if value is not None:
+            value = str(value)
+            if value not in self.membership:
+                raise ValueError('Unrecognized value: %s' % value)
+        return self.membership[value]
+
+    def format(self, value):
+        return self.membership.keys()[self.membership.values().index(value)]
+
+
 class OptionName(Validator):
     """ Validates option names.