Merge branch 'develop' into bug/namespace-for-server-endpoints

Conflicts:
	splunklib/client.py

Author: Shakeel Mohamed

examples/analytics/README.md

@@ -73,7 +73,7 @@ Similarly to `AnalyticsTracker`, the `output.py` file defines the "output" side
 of the Analytics service. If you want to extract the events you logged in using
 `AnalyticsTracker`, you'd use the `AnalyticsRetriever` class.
 
-Creating an `AnalyticsTracker` instance is identical to the `AnalyticsTracker`:
+Creating an `AnalyticsRetriever` instance is identical to the `AnalyticsTracker`:
 
 ```python
 from analytics.output import AnalyticsRetriever
@@ -138,7 +138,7 @@ you can see a graph of events over time, properties, etc.
 
 We make use of the excellent open source
 [flot](http://code.google.com/p/flot/) graphing library to render
-our Javascript graphs. We also use the [`bottle.py`](bottlepy.org)
+our Javascript graphs. We also use the [`bottle.py`](http://bottlepy.org)
 micro-web framework.
 
 ## Running the Sample

examples/github_forks/github_forks.py

@@ -50,6 +50,7 @@ def get_scheme(self):
         scheme.use_single_instance = True
 
         owner_argument = Argument("owner")
+        owner_argument.title = "Owner"
         owner_argument.data_type = Argument.data_type_string
         owner_argument.description = "Github user or organization that created the repository."
         owner_argument.required_on_create = True
@@ -59,6 +60,7 @@ def get_scheme(self):
         scheme.add_argument(owner_argument)
 
         repo_name_argument = Argument("repo_name")
+        repo_name_argument.title = "Repo Name"
         repo_name_argument.data_type = Argument.data_type_string
         repo_name_argument.description = "Name of the Github repository."
         repo_name_argument.required_on_create = True

examples/random_numbers/random_numbers.py

@@ -50,6 +50,7 @@ def get_scheme(self):
         scheme.use_single_instance = True
 
         min_argument = Argument("min")
+        min_argument.title = "Minimum"
         min_argument.data_type = Argument.data_type_number
         min_argument.description = "Minimum random number to be produced by this input."
         min_argument.required_on_create = True
@@ -59,6 +60,7 @@ def get_scheme(self):
         scheme.add_argument(min_argument)
 
         max_argument = Argument("max")
+        max_argument.title = "Maximum"
         max_argument.data_type = Argument.data_type_number
         max_argument.description = "Maximum random number to be produced by this input."
         max_argument.required_on_create = True

examples/searchcommands_app/bin/simulate.py

@@ -86,7 +86,7 @@ class SimulateCommand(GeneratingCommand):
 
     def generate(self):
         """ Yields one random record at a time for the duration of `duration` """
-        self.logger.debug('SimulateCommand: %s' % self)  # log command line
+        self.logger.debug('SimulateCommand: %s', self)  # log command line
         if not self.records:
             if self.seed is not None:
                 random.seed(self.seed)

setup.py

@@ -168,7 +168,7 @@ def run(self):
         sdk_dir = os.path.abspath('.')
 
         def exclude(path):
-            # TODO: Replace with filter function because exclude is deprecated
+            # TODO: DVPL-5866 - Replace with filter function because exclude is deprecated
             basename = os.path.basename(path)
             for pattern in ['.DS_Store', '.idea', '*.log', '*.py[co]']:
                 if fnmatch(basename, pattern):

splunklib/binding.py

@@ -39,7 +39,7 @@
 
 from contextlib import contextmanager
 
-from xml.etree.ElementTree import XML
+from xml.etree.ElementTree import XML, ParseError
 
 from data import record
 
@@ -974,7 +974,10 @@ def __init__(self, response, _message=None):
         status = response.status
         reason = response.reason
         body = response.body.read()
-        detail = XML(body).findtext("./messages/msg")
+        try:
+            detail = XML(body).findtext("./messages/msg")
+        except ParseError as err:
+            detail = body
         message = "HTTP %d %s%s" % (
             status, reason, "" if detail is None else " -- %s" % detail)
         Exception.__init__(self, _message or message)

splunklib/client.py

@@ -237,7 +237,18 @@ def _parse_atom_entry(entry):
 
     # Filter some of the noise out of the content record
     content = record((k, v) for k, v in content.iteritems()
-        if k not in ['eai:acl', 'eai:attributes', 'type'])
+                     if k not in ['eai:acl', 'eai:attributes'])
+
+    if isinstance(content['type'], list):
+        content['type'] = [t for t in content['type'] if t != 'text/xml']
+        # Unset type if it was only 'text/xml'
+        if len(content['type']) == 0:
+            content.pop('type', None)
+        # Flatten 1 element list
+        if len(content['type']) == 1:
+            content['type'] = content['type'][0]
+    else:
+        content.pop('type', None)
 
     return record({
         'title': title,
@@ -1619,7 +1630,7 @@ def get(self, name="", owner=None, app=None, sharing=None, **query):
         name = UrlEncoded(name, encode_slash=True)
         return super(Collection, self).get(name, owner, app, sharing, **query)
 
-    
+
 
 
 class ConfigurationFile(Collection):
@@ -1799,7 +1810,7 @@ def create(self, password, username, realm=None):
         storage_password = StoragePassword(self.service, self._entity_path(state), state=state, skip_refresh=True)
 
         return storage_password
-    
+
     def delete(self, username, realm=None):
         """Delete a storage password by username and/or realm.
 
@@ -1977,7 +1988,7 @@ def clean(self, timeout=60):
         :return: The :class:`Index`.
         """
         self.refresh()
-        
+
         tds = self['maxTotalDataSizeMB']
         ftp = self['frozenTimePeriodInSecs']
         was_disabled_initially = self.disabled
@@ -1996,7 +2007,7 @@ def clean(self, timeout=60):
             while self.content.totalEventCount != '0' and datetime.now() < start+diff:
                 sleep(1)
                 self.refresh()
-            
+
             if self.content.totalEventCount != '0':
                 raise OperationError, "Cleaning index %s took longer than %s seconds; timing out." %\
                                       (self.name, timeout)
@@ -2941,7 +2952,7 @@ def export(self, query, **params):
             raise TypeError("Cannot specify an exec_mode to export.")
         params['segmentation'] = params.get('segmentation', 'none')
         return self.post(path_segment="export",
-                         search=query, 
+                         search=query,
                          **params).body
 
     def itemmeta(self):
@@ -3004,7 +3015,7 @@ def oneshot(self, query, **params):
             raise TypeError("Cannot specify an exec_mode to oneshot.")
         params['segmentation'] = params.get('segmentation', 'none')
         return self.post(search=query,
-                         exec_mode="oneshot", 
+                         exec_mode="oneshot",
                          **params).body
 
 
@@ -3032,7 +3043,8 @@ def __init__(self, service, path, **kwargs):
     def value(self):
         """Returns the message value.
 
-        :return: The :class:`Loggers` collection.
+        :return: The message value.
+        :rtype: ``string``
         """
         return self[self.name]
 

splunklib/modularinput/argument.py

@@ -80,6 +80,9 @@ def add_to_document(self, parent):
         arg = ET.SubElement(parent, "arg")
         arg.set("name", self.name)
 
+        if self.title is not None:
+            ET.SubElement(arg, "title").text = self.title
+
         if self.description is not None:
             ET.SubElement(arg, "description").text = self.description
 

splunklib/results.py

@@ -246,7 +246,25 @@ def _parse_results(self, stream):
                         elem.clear()
 
                 elif elem.tag in ('text', 'v') and event == 'end':
-                    text = "".join(elem.itertext())
+                    try:
+                        text = "".join(elem.itertext())
+                    except AttributeError:
+                        # Assume we're running in Python < 2.7, before itertext() was added
+                        # So we'll define it here
+
+                        def __itertext(self):
+                          tag = self.tag
+                          if not isinstance(tag, basestring) and tag is not None:
+                              return
+                          if self.text:
+                              yield self.text
+                          for e in self:
+                              for s in __itertext(e):
+                                  yield s
+                              if e.tail:
+                                  yield e.tail
+
+                        text = "".join(__itertext(elem))
                     values.append(text.encode('utf8'))
                     elem.clear()
 

splunklib/searchcommands/decorators.py

@@ -222,7 +222,7 @@ def __repr__(self):
             return str(self)
 
         def __str__(self):
-            value = self.validator.format(self.value) if self.validator is not None else str(self.value)
+            value = str(self.value) if self.validator is None else self.validator.format(self.value)
             encoder = Option.Encoder(self)
             text = '='.join([self.name, encoder.encode(value)])
             return text