PL/Python: Clean up extended error reporting docs and tests

Format the example and test code more to Python style standards.
Improve whitespace.  Improve documentation formatting.

2 files changed, 133 insertions, 121 deletions

diff --git a/src/pl/plpython/expected/plpython_ereport.out b/src/pl/plpython/expected/plpython_ereport.out
index e32b672fb01..43ce035de61 100644
--- a/src/pl/plpython/expected/plpython_ereport.out
+++ b/src/pl/plpython/expected/plpython_ereport.out
@@ -1,22 +1,22 @@
 CREATE FUNCTION elog_test() RETURNS void
 AS $$
-plpy.debug('debug', detail = 'some detail')
-plpy.log('log', detail = 'some detail')
-plpy.info('info', detail = 'some detail')
+plpy.debug('debug', detail='some detail')
+plpy.log('log', detail='some detail')
+plpy.info('info', detail='some detail')
 plpy.info()
-plpy.info('the question', detail = 42);
+plpy.info('the question', detail=42);
 plpy.info('This is message text.',
-                    detail = 'This is detail text',
-                    hint = 'This is hint text.',
-                    sqlstate = 'XX000',
-                    schema_name = 'any info about schema',
-                    table_name = 'any info about table',
-                    column_name = 'any info about column',
-                    datatype_name = 'any info about datatype',
-                    constraint_name = 'any info about constraint')
-plpy.notice('notice', detail = 'some detail')
-plpy.warning('warning', detail = 'some detail')
-plpy.error('stop on error', detail = 'some detail', hint = 'some hint')
+          detail='This is detail text',
+          hint='This is hint text.',
+          sqlstate='XX000',
+          schema_name='any info about schema',
+          table_name='any info about table',
+          column_name='any info about column',
+          datatype_name='any info about datatype',
+          constraint_name='any info about constraint')
+plpy.notice('notice', detail='some detail')
+plpy.warning('warning', detail='some detail')
+plpy.error('stop on error', detail='some detail', hint='some hint')
 $$ LANGUAGE plpythonu;
 SELECT elog_test();
 INFO:  info
@@ -36,92 +36,98 @@ DETAIL:  some detail
 HINT:  some hint
 CONTEXT:  Traceback (most recent call last):
   PL/Python function "elog_test", line 18, in <module>
-    plpy.error('stop on error', detail = 'some detail', hint = 'some hint')
+    plpy.error('stop on error', detail='some detail', hint='some hint')
 PL/Python function "elog_test"
-do $$ plpy.info('other types', detail = (10,20)) $$ LANGUAGE plpythonu;
+DO $$ plpy.info('other types', detail=(10, 20)) $$ LANGUAGE plpythonu;
 INFO:  other types
 DETAIL:  (10, 20)
-do $$
+DO $$
 import time;
 from datetime import date
-plpy.info('other types', detail = date(2016,2,26))
+plpy.info('other types', detail=date(2016, 2, 26))
 $$ LANGUAGE plpythonu;
 INFO:  other types
 DETAIL:  2016-02-26
-do $$
+DO $$
 basket = ['apple', 'orange', 'apple', 'pear', 'orange', 'banana']
-plpy.info('other types', detail = basket)
+plpy.info('other types', detail=basket)
 $$ LANGUAGE plpythonu;
 INFO:  other types
 DETAIL:  ['apple', 'orange', 'apple', 'pear', 'orange', 'banana']
 -- should fail
-do $$ plpy.info('wrong sqlstate', sqlstate='54444A') $$ LANGUAGE plpythonu;
+DO $$ plpy.info('wrong sqlstate', sqlstate='54444A') $$ LANGUAGE plpythonu;
 ERROR:  invalid SQLSTATE code
 CONTEXT:  PL/Python anonymous code block
-do $$ plpy.info('unsupported argument', blabla='fooboo') $$ LANGUAGE plpythonu;
+DO $$ plpy.info('unsupported argument', blabla='fooboo') $$ LANGUAGE plpythonu;
 ERROR:  'blabla' is an invalid keyword argument for this function
 CONTEXT:  PL/Python anonymous code block
-do $$ plpy.info('first message', message='second message') $$ LANGUAGE plpythonu;
+DO $$ plpy.info('first message', message='second message') $$ LANGUAGE plpythonu;
 ERROR:  the message is already specified
 CONTEXT:  PL/Python anonymous code block
-do $$ plpy.info('first message', 'second message', message='third message') $$ LANGUAGE plpythonu;
+DO $$ plpy.info('first message', 'second message', message='third message') $$ LANGUAGE plpythonu;
 ERROR:  the message is already specified
 CONTEXT:  PL/Python anonymous code block
 -- raise exception in python, handle exception in plgsql
 CREATE OR REPLACE FUNCTION raise_exception(_message text, _detail text DEFAULT NULL, _hint text DEFAULT NULL,
-						_sqlstate text DEFAULT NULL,
-						_schema_name text DEFAULT NULL, _table_name text DEFAULT NULL, _column_name text DEFAULT NULL,
-						_datatype_name text DEFAULT NULL, _constraint_name text DEFAULT NULL)
+                                           _sqlstate text DEFAULT NULL,
+                                           _schema_name text DEFAULT NULL,
+                                           _table_name text DEFAULT NULL,
+                                           _column_name text DEFAULT NULL,
+                                           _datatype_name text DEFAULT NULL,
+                                           _constraint_name text DEFAULT NULL)
 RETURNS void AS $$
-kwargs = { "message":_message, "detail":_detail, "hint":_hint,
-			"sqlstate":_sqlstate, "schema_name":_schema_name, "table_name":_table_name,
-			"column_name":_column_name, "datatype_name":_datatype_name, "constraint_name":_constraint_name }
+kwargs = {
+    "message": _message, "detail": _detail, "hint": _hint,
+    "sqlstate": _sqlstate, "schema_name": _schema_name, "table_name": _table_name,
+    "column_name": _column_name, "datatype_name": _datatype_name,
+    "constraint_name": _constraint_name
+}
 # ignore None values - should work on Python2.3
 dict = {}
 for k in kwargs:
-	if kwargs[k] is not None:
-		dict[k] = kwargs[k]
+    if kwargs[k] is not None:
+        dict[k] = kwargs[k]
 plpy.error(**dict)
 $$ LANGUAGE plpythonu;
 SELECT raise_exception('hello', 'world');
 ERROR:  plpy.Error: hello
 DETAIL:  world
 CONTEXT:  Traceback (most recent call last):
-  PL/Python function "raise_exception", line 10, in <module>
+  PL/Python function "raise_exception", line 13, in <module>
     plpy.error(**dict)
 PL/Python function "raise_exception"
 SELECT raise_exception('message text', 'detail text', _sqlstate => 'YY333');
 ERROR:  plpy.Error: message text
 DETAIL:  detail text
 CONTEXT:  Traceback (most recent call last):
-  PL/Python function "raise_exception", line 10, in <module>
+  PL/Python function "raise_exception", line 13, in <module>
     plpy.error(**dict)
 PL/Python function "raise_exception"
 SELECT raise_exception(_message => 'message text',
-						_detail => 'detail text',
-						_hint => 'hint text',
-						_sqlstate => 'XX555',
-						_schema_name => 'schema text',
-						_table_name => 'table text',
-						_column_name => 'column text',
-						_datatype_name => 'datatype text',
-						_constraint_name => 'constraint text');
+                       _detail => 'detail text',
+                       _hint => 'hint text',
+                       _sqlstate => 'XX555',
+                       _schema_name => 'schema text',
+                       _table_name => 'table text',
+                       _column_name => 'column text',
+                       _datatype_name => 'datatype text',
+                       _constraint_name => 'constraint text');
 ERROR:  plpy.Error: message text
 DETAIL:  detail text
 HINT:  hint text
 CONTEXT:  Traceback (most recent call last):
-  PL/Python function "raise_exception", line 10, in <module>
+  PL/Python function "raise_exception", line 13, in <module>
     plpy.error(**dict)
 PL/Python function "raise_exception"
 SELECT raise_exception(_message => 'message text',
-						_hint => 'hint text',
-						_schema_name => 'schema text',
-						_column_name => 'column text',
-						_constraint_name => 'constraint text');
+                       _hint => 'hint text',
+                       _schema_name => 'schema text',
+                       _column_name => 'column text',
+                       _constraint_name => 'constraint text');
 ERROR:  plpy.Error: message text
 HINT:  hint text
 CONTEXT:  Traceback (most recent call last):
-  PL/Python function "raise_exception", line 10, in <module>
+  PL/Python function "raise_exception", line 13, in <module>
     plpy.error(**dict)
 PL/Python function "raise_exception"
 DO $$
@@ -157,34 +163,34 @@ BEGIN
                             __datatype_name = PG_DATATYPE_NAME,
                             __constraint_name = CONSTRAINT_NAME;
     RAISE NOTICE 'handled exception'
-       USING DETAIL = format('message:(%s), detail:(%s), hint: (%s), sqlstate: (%s), '
-                             'schema_name:(%s), table_name:(%s), column_name:(%s), datatype_name:(%s), constraint_name:(%s)',
-                             __message, __detail, __hint, __sqlstate, __schema_name,
-                             __table_name, __column_name, __datatype_name, __constraint_name);
+      USING DETAIL = format('message:(%s), detail:(%s), hint: (%s), sqlstate: (%s), '
+                            'schema_name:(%s), table_name:(%s), column_name:(%s), datatype_name:(%s), constraint_name:(%s)',
+                            __message, __detail, __hint, __sqlstate, __schema_name,
+                            __table_name, __column_name, __datatype_name, __constraint_name);
   END;
 END;
 $$;
 NOTICE:  handled exception
 DETAIL:  message:(plpy.Error: message text), detail:(detail text), hint: (hint text), sqlstate: (XX555), schema_name:(schema text), table_name:(table text), column_name:(column text), datatype_name:(datatype text), constraint_name:(constraint text)
--- the displayed context is different between Python2 and Python3,
--- but that's not important for this test
+-- The displayed context is different between Python2 and Python3,
+-- but that's not important for this test.
 \set SHOW_CONTEXT never
-do $$
+DO $$
 try:
-	plpy.execute("select raise_exception(_message => 'my message', _sqlstate => 'XX987', _hint => 'some hint', _table_name => 'users_tab', _datatype_name => 'user_type')")
+    plpy.execute("select raise_exception(_message => 'my message', _sqlstate => 'XX987', _hint => 'some hint', _table_name => 'users_tab', _datatype_name => 'user_type')")
 except Exception, e:
-	plpy.info(e.spidata)
-	raise e
+    plpy.info(e.spidata)
+    raise e
 $$ LANGUAGE plpythonu;
 INFO:  (119577128, None, 'some hint', None, 0, None, 'users_tab', None, 'user_type', None)
 ERROR:  plpy.SPIError: plpy.Error: my message
 HINT:  some hint
-do $$
+DO $$
 try:
-  plpy.error(message  = 'my message', sqlstate = 'XX987', hint = 'some hint', table_name = 'users_tab', datatype_name = 'user_type')
+    plpy.error(message  = 'my message', sqlstate = 'XX987', hint = 'some hint', table_name = 'users_tab', datatype_name = 'user_type')
 except Exception, e:
-  plpy.info('sqlstate: %s, hint: %s, table_name: %s, datatype_name: %s' % (e.sqlstate, e.hint, e.table_name, e.datatype_name))
-  raise e
+    plpy.info('sqlstate: %s, hint: %s, table_name: %s, datatype_name: %s' % (e.sqlstate, e.hint, e.table_name, e.datatype_name))
+    raise e
 $$ LANGUAGE plpythonu;
 INFO:  sqlstate: XX987, hint: some hint, table_name: users_tab, datatype_name: user_type
 ERROR:  plpy.Error: my message
diff --git a/src/pl/plpython/sql/plpython_ereport.sql b/src/pl/plpython/sql/plpython_ereport.sql
index 19b14c6048b..2612e933876 100644
--- a/src/pl/plpython/sql/plpython_ereport.sql
+++ b/src/pl/plpython/sql/plpython_ereport.sql
@@ -1,79 +1,85 @@
 CREATE FUNCTION elog_test() RETURNS void
 AS $$
-plpy.debug('debug', detail = 'some detail')
-plpy.log('log', detail = 'some detail')
-plpy.info('info', detail = 'some detail')
+plpy.debug('debug', detail='some detail')
+plpy.log('log', detail='some detail')
+plpy.info('info', detail='some detail')
 plpy.info()
-plpy.info('the question', detail = 42);
+plpy.info('the question', detail=42);
 plpy.info('This is message text.',
-                    detail = 'This is detail text',
-                    hint = 'This is hint text.',
-                    sqlstate = 'XX000',
-                    schema_name = 'any info about schema',
-                    table_name = 'any info about table',
-                    column_name = 'any info about column',
-                    datatype_name = 'any info about datatype',
-                    constraint_name = 'any info about constraint')
-plpy.notice('notice', detail = 'some detail')
-plpy.warning('warning', detail = 'some detail')
-plpy.error('stop on error', detail = 'some detail', hint = 'some hint')
+          detail='This is detail text',
+          hint='This is hint text.',
+          sqlstate='XX000',
+          schema_name='any info about schema',
+          table_name='any info about table',
+          column_name='any info about column',
+          datatype_name='any info about datatype',
+          constraint_name='any info about constraint')
+plpy.notice('notice', detail='some detail')
+plpy.warning('warning', detail='some detail')
+plpy.error('stop on error', detail='some detail', hint='some hint')
 $$ LANGUAGE plpythonu;
 
 SELECT elog_test();
 
-do $$ plpy.info('other types', detail = (10,20)) $$ LANGUAGE plpythonu;
+DO $$ plpy.info('other types', detail=(10, 20)) $$ LANGUAGE plpythonu;
 
-do $$
+DO $$
 import time;
 from datetime import date
-plpy.info('other types', detail = date(2016,2,26))
+plpy.info('other types', detail=date(2016, 2, 26))
 $$ LANGUAGE plpythonu;
 
-do $$
+DO $$
 basket = ['apple', 'orange', 'apple', 'pear', 'orange', 'banana']
-plpy.info('other types', detail = basket)
+plpy.info('other types', detail=basket)
 $$ LANGUAGE plpythonu;
 
 -- should fail
-do $$ plpy.info('wrong sqlstate', sqlstate='54444A') $$ LANGUAGE plpythonu;
-do $$ plpy.info('unsupported argument', blabla='fooboo') $$ LANGUAGE plpythonu;
-do $$ plpy.info('first message', message='second message') $$ LANGUAGE plpythonu;
-do $$ plpy.info('first message', 'second message', message='third message') $$ LANGUAGE plpythonu;
+DO $$ plpy.info('wrong sqlstate', sqlstate='54444A') $$ LANGUAGE plpythonu;
+DO $$ plpy.info('unsupported argument', blabla='fooboo') $$ LANGUAGE plpythonu;
+DO $$ plpy.info('first message', message='second message') $$ LANGUAGE plpythonu;
+DO $$ plpy.info('first message', 'second message', message='third message') $$ LANGUAGE plpythonu;
 
 -- raise exception in python, handle exception in plgsql
 CREATE OR REPLACE FUNCTION raise_exception(_message text, _detail text DEFAULT NULL, _hint text DEFAULT NULL,
-						_sqlstate text DEFAULT NULL,
-						_schema_name text DEFAULT NULL, _table_name text DEFAULT NULL, _column_name text DEFAULT NULL,
-						_datatype_name text DEFAULT NULL, _constraint_name text DEFAULT NULL)
+                                           _sqlstate text DEFAULT NULL,
+                                           _schema_name text DEFAULT NULL,
+                                           _table_name text DEFAULT NULL,
+                                           _column_name text DEFAULT NULL,
+                                           _datatype_name text DEFAULT NULL,
+                                           _constraint_name text DEFAULT NULL)
 RETURNS void AS $$
-kwargs = { "message":_message, "detail":_detail, "hint":_hint,
-			"sqlstate":_sqlstate, "schema_name":_schema_name, "table_name":_table_name,
-			"column_name":_column_name, "datatype_name":_datatype_name, "constraint_name":_constraint_name }
+kwargs = {
+    "message": _message, "detail": _detail, "hint": _hint,
+    "sqlstate": _sqlstate, "schema_name": _schema_name, "table_name": _table_name,
+    "column_name": _column_name, "datatype_name": _datatype_name,
+    "constraint_name": _constraint_name
+}
 # ignore None values - should work on Python2.3
 dict = {}
 for k in kwargs:
-	if kwargs[k] is not None:
-		dict[k] = kwargs[k]
+    if kwargs[k] is not None:
+        dict[k] = kwargs[k]
 plpy.error(**dict)
 $$ LANGUAGE plpythonu;
 
 SELECT raise_exception('hello', 'world');
 SELECT raise_exception('message text', 'detail text', _sqlstate => 'YY333');
 SELECT raise_exception(_message => 'message text',
-						_detail => 'detail text',
-						_hint => 'hint text',
-						_sqlstate => 'XX555',
-						_schema_name => 'schema text',
-						_table_name => 'table text',
-						_column_name => 'column text',
-						_datatype_name => 'datatype text',
-						_constraint_name => 'constraint text');
+                       _detail => 'detail text',
+                       _hint => 'hint text',
+                       _sqlstate => 'XX555',
+                       _schema_name => 'schema text',
+                       _table_name => 'table text',
+                       _column_name => 'column text',
+                       _datatype_name => 'datatype text',
+                       _constraint_name => 'constraint text');
 
 SELECT raise_exception(_message => 'message text',
-						_hint => 'hint text',
-						_schema_name => 'schema text',
-						_column_name => 'column text',
-						_constraint_name => 'constraint text');
+                       _hint => 'hint text',
+                       _schema_name => 'schema text',
+                       _column_name => 'column text',
+                       _constraint_name => 'constraint text');
 
 DO $$
 DECLARE
@@ -108,30 +114,30 @@ BEGIN
                             __datatype_name = PG_DATATYPE_NAME,
                             __constraint_name = CONSTRAINT_NAME;
     RAISE NOTICE 'handled exception'
-       USING DETAIL = format('message:(%s), detail:(%s), hint: (%s), sqlstate: (%s), '
-                             'schema_name:(%s), table_name:(%s), column_name:(%s), datatype_name:(%s), constraint_name:(%s)',
-                             __message, __detail, __hint, __sqlstate, __schema_name,
-                             __table_name, __column_name, __datatype_name, __constraint_name);
+      USING DETAIL = format('message:(%s), detail:(%s), hint: (%s), sqlstate: (%s), '
+                            'schema_name:(%s), table_name:(%s), column_name:(%s), datatype_name:(%s), constraint_name:(%s)',
+                            __message, __detail, __hint, __sqlstate, __schema_name,
+                            __table_name, __column_name, __datatype_name, __constraint_name);
   END;
 END;
 $$;
 
--- the displayed context is different between Python2 and Python3,
--- but that's not important for this test
+-- The displayed context is different between Python2 and Python3,
+-- but that's not important for this test.
 \set SHOW_CONTEXT never
 
-do $$
+DO $$
 try:
-	plpy.execute("select raise_exception(_message => 'my message', _sqlstate => 'XX987', _hint => 'some hint', _table_name => 'users_tab', _datatype_name => 'user_type')")
+    plpy.execute("select raise_exception(_message => 'my message', _sqlstate => 'XX987', _hint => 'some hint', _table_name => 'users_tab', _datatype_name => 'user_type')")
 except Exception, e:
-	plpy.info(e.spidata)
-	raise e
+    plpy.info(e.spidata)
+    raise e
 $$ LANGUAGE plpythonu;
 
-do $$
+DO $$
 try:
-  plpy.error(message  = 'my message', sqlstate = 'XX987', hint = 'some hint', table_name = 'users_tab', datatype_name = 'user_type')
+    plpy.error(message  = 'my message', sqlstate = 'XX987', hint = 'some hint', table_name = 'users_tab', datatype_name = 'user_type')
 except Exception, e:
-  plpy.info('sqlstate: %s, hint: %s, table_name: %s, datatype_name: %s' % (e.sqlstate, e.hint, e.table_name, e.datatype_name))
-  raise e
+    plpy.info('sqlstate: %s, hint: %s, table_name: %s, datatype_name: %s' % (e.sqlstate, e.hint, e.table_name, e.datatype_name))
+    raise e
 $$ LANGUAGE plpythonu;