Release 1.2.3

Author: David Noble

CHANGELOG.md

@@ -1,5 +1,41 @@
 # Splunk SDK for Python Changelog
 
+
+## Version 1.2.3
+
+### New features and APIs
+
+* Improved error handling in custom search commands
+
+  SearchCommand.process now catches all exceptions and
+
+  1. Writes an error message for display in the Splunk UI.
+
+     The error message is the text of the exception. This is new behavior.
+
+  2. Logs a traceback to SearchCommand.logger. This is old behavior.
+
+* Made ResponseReader more streamlike, so that it can be wrapped in an 
+  io.BufferedReader to realize a significant performance gain.
+
+  *Example usage*
+
+  ```
+  import io
+  ...
+  response = job.results(count=maxRecords, offset=self._offset)
+  resultsList = results.ResultsReader(io.BufferedReader(response)) 
+  ```
+
+### Bug fixes
+
+1. The results reader now catches SyntaxError exceptions instead of
+   `xml.etree.ElementTree.ParseError` exceptions. `ParseError` wasn't
+   introduced until Python 2.7. This masked the root cause of errors
+   data errors in result elements.
+
+2. When writing a ReportingCommand you no longer need to include a map method.
+ 
 ## Version 1.2.2
 
 ### Bug fixes

Commands.conf.spec.xlsx

@@ -1,6 +1,6 @@
 # The Splunk Software Development Kit for Python
 
-#### Version 1.2.2
+#### Version 1.2.3
 
 The Splunk Software Development Kit (SDK) for Python contains library code and 
 examples designed to enable developers to build applications using Splunk.

README.md

@@ -1,3 +1,8 @@
+#
+# The format of this file is described in this article at Python.org:
+#
+#     [Configuration file format](http://goo.gl/K6edZ8)
+#
 [loggers]
 keys = root, CountMatchesCommand, SimulateCommand, SumCommand
 
@@ -8,25 +13,34 @@ handlers = stderr ; Default: stderr
 [logger_CountMatchesCommand]
 qualname = CountMatchesCommand
 level = NOTSET    ; Default: WARNING
-handlers = stderr ; Default: stderr
+handlers = file   ; Default: stderr
 propagate = 0     ; Default: 1
 
 [logger_SimulateCommand]
 qualname = SimulateCommand
 level = NOTSET    ; Default: WARNING
-handlers = stderr ; Default: stderr
+handlers = file   ; Default: stderr
 propagate = 0     ; Default: 1
 
 [logger_SumCommand]
 qualname = SumCommand
 level = NOTSET    ; Default: WARNING
-handlers = stderr ; Default: stderr
+handlers = file   ; Default: stderr
 propagate = 0     ; Default: 1
 
 [handlers]
-keys=stderr
+# See [logging.handlers](http://goo.gl/9aoOx)
+keys=file, stderr
+
+[handler_file]
+# Select this handler to log events to $SPLUNK_HOME/etc/apps/searchcommands_app/searchcommands_app.log
+class = logging.FileHandler
+level = NOTSET
+args = ('searchcommand_app.log', 'a', 'utf-8', True)
+formatter = search_command
 
 [handler_stderr]
+# Select this handler to log events to $SPLUNK_HOME/var/log/splunk/splunkd.log
 class = logging.StreamHandler
 level = NOTSET
 args = (sys.stderr,)

examples/searchcommands_app/bin/population.csv

@@ -1,18 +1,4 @@
 #!/usr/bin/env python
-#
-# Copyright 2011-2014 Splunk, Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"): you may
-# not use this file except in compliance with the License. You may obtain
-# a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-# License for the specific language governing permissions and limitations
-# under the License.
 
 import sys
 from splunklib.searchcommands import \

examples/searchcommands_app/default/logging.conf

@@ -1,18 +1,4 @@
 #!/usr/bin/env python
-#
-# Copyright 2011-2014 Splunk, Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"): you may
-# not use this file except in compliance with the License. You may obtain
-# a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-# License for the specific language governing permissions and limitations
-# under the License.
 
 import sys
 from splunklib.searchcommands import \

examples/searchcommands_template/bin/generate.py

@@ -1,18 +1,4 @@
 #!/usr/bin/env python
-#
-# Copyright 2011-2014 Splunk, Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"): you may
-# not use this file except in compliance with the License. You may obtain
-# a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-# License for the specific language governing permissions and limitations
-# under the License.
 
 import sys
 from splunklib.searchcommands import \

examples/searchcommands_template/bin/report.py

@@ -1,4 +1,3 @@
-<!-- TODO: Templatize this content -->
 <nav>
     <view name="flashtimeline" default='true' />
     <collection label="Dashboards">

examples/searchcommands_template/bin/stream.py

@@ -1,3 +1,8 @@
+#
+# The format of this file is described in this article at Python.org:
+#
+#     [Configuration file format](http://goo.gl/K6edZ8)
+#
 [loggers]
 keys = root, %(command.title())Command