Modify samples to follow the PEP 8 style guide.

Author: anthony-tuininga

doc/src/release_notes.rst

@@ -26,7 +26,7 @@ Version 8.1 (TBD)
 #)  Tests can now be run with tox in order to automate testing of the different
     environments that are supported.
 #)  The value of prefetchrows for REF CURSOR variables is now honored.
-#)  Improved documentation and test suite.
+#)  Improved documentation, samples and test suite.
 
 
 Version 8.0.1 (August 2020)

samples/AdvancedQueuingNotification.py

@@ -1,5 +1,5 @@
 #------------------------------------------------------------------------------
-# Copyright (c) 2018, 2019, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2018, 2020, Oracle and/or its affiliates. All rights reserved.
 #------------------------------------------------------------------------------
 
 #------------------------------------------------------------------------------
@@ -13,7 +13,7 @@
 #------------------------------------------------------------------------------
 
 import cx_Oracle
-import SampleEnv
+import sample_env
 import threading
 import time
 
@@ -29,9 +29,11 @@ def ProcessMessages(message):
     print("Queue name:", message.queueName)
     print("Consumer name:", message.consumerName)
 
-connection = cx_Oracle.connect(SampleEnv.GetMainConnectString(), events = True)
+connection = cx_Oracle.connect(sample_env.get_main_connect_string(),
+                               events=True)
 sub = connection.subscribe(namespace=cx_Oracle.SUBSCR_NAMESPACE_AQ,
-        name="DEMO_BOOK_QUEUE", callback=ProcessMessages, timeout=300)
+                           name="DEMO_BOOK_QUEUE", callback=ProcessMessages,
+                           timeout=300)
 print("Subscription:", sub)
 print("--> Connection:", sub.connection)
 print("--> Callback:", sub.callback)

samples/AppContext.py

@@ -1,5 +1,5 @@
 #------------------------------------------------------------------------------
-# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
 #
 # Portions Copyright 2007-2015, Anthony Tuininga. All rights reserved.
 #
@@ -17,7 +17,7 @@
 #------------------------------------------------------------------------------
 
 import cx_Oracle
-import SampleEnv
+import sample_env
 
 # define constants used throughout the script; adjust as desired
 APP_CTX_NAMESPACE = "CLIENTCONTEXT"
@@ -27,8 +27,8 @@
     ( APP_CTX_NAMESPACE, "ATTR3", "VALUE3" )
 ]
 
-connection = cx_Oracle.connect(SampleEnv.GetMainConnectString(),
-        appcontext = APP_CTX_ENTRIES)
+connection = cx_Oracle.connect(sample_env.get_main_connect_string(),
+                               appcontext=APP_CTX_ENTRIES)
 cursor = connection.cursor()
 for namespace, name, value in APP_CTX_ENTRIES:
     cursor.execute("select sys_context(:1, :2) from dual", (namespace, name))

samples/ArrayDMLRowCounts.py

@@ -1,5 +1,5 @@
 #------------------------------------------------------------------------------
-# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
 #------------------------------------------------------------------------------
 
 #------------------------------------------------------------------------------
@@ -14,36 +14,36 @@
 #------------------------------------------------------------------------------
 
 import cx_Oracle
-import SampleEnv
+import sample_env
 
-connection = cx_Oracle.connect(SampleEnv.GetMainConnectString())
+connection = cx_Oracle.connect(sample_env.get_main_connect_string())
 cursor = connection.cursor()
 
 # show the number of rows for each parent ID as a means of verifying the
 # output from the delete statement
-for parentId, count in cursor.execute("""
+for parent_id, count in cursor.execute("""
         select ParentId, count(*)
         from ChildTable
         group by ParentId
         order by ParentId"""):
-    print("Parent ID:", parentId, "has", int(count), "rows.")
+    print("Parent ID:", parent_id, "has", int(count), "rows.")
 print()
 
 # delete the following parent IDs only
-parentIdsToDelete = [20, 30, 50]
+parent_ids_to_delete = [20, 30, 50]
 
-print("Deleting Parent IDs:", parentIdsToDelete)
+print("Deleting Parent IDs:", parent_ids_to_delete)
 print()
 
 # enable array DML row counts for each iteration executed in executemany()
 cursor.executemany("""
         delete from ChildTable
         where ParentId = :1""",
-        [(i,) for i in parentIdsToDelete],
+        [(i,) for i in parent_ids_to_delete],
         arraydmlrowcounts = True)
 
 # display the number of rows deleted for each parent ID
-rowCounts = cursor.getarraydmlrowcounts()
-for parentId, count in zip(parentIdsToDelete, rowCounts):
-    print("Parent ID:", parentId, "deleted", count, "rows.")
+row_counts = cursor.getarraydmlrowcounts()
+for parent_id, count in zip(parent_ids_to_delete, row_counts):
+    print("Parent ID:", parent_id, "deleted", count, "rows.")
 

samples/BatchErrors.py

@@ -1,5 +1,5 @@
 #------------------------------------------------------------------------------
-# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
 #------------------------------------------------------------------------------
 
 #------------------------------------------------------------------------------
@@ -16,13 +16,13 @@
 #------------------------------------------------------------------------------
 
 import cx_Oracle
-import SampleEnv
+import sample_env
 
-connection = cx_Oracle.connect(SampleEnv.GetMainConnectString())
+connection = cx_Oracle.connect(sample_env.get_main_connect_string())
 cursor = connection.cursor()
 
 # define data to insert
-dataToInsert = [
+data_to_insert = [
     (1016, 10, 'Child B of Parent 10'),
     (1017, 10, 'Child C of Parent 10'),
     (1018, 20, 'Child D of Parent 20'),
@@ -39,14 +39,14 @@
         from ChildTable""")
 count, = cursor.fetchone()
 print("number of rows in child table:", int(count))
-print("number of rows to insert:", len(dataToInsert))
+print("number of rows to insert:", len(data_to_insert))
 
 # old method: executemany() with data errors results in stoppage after the
 # first error takes place; the row count is updated to show how many rows
 # actually succeeded
 try:
     cursor.executemany("insert into ChildTable values (:1, :2, :3)",
-            dataToInsert)
+                       data_to_insert)
 except cx_Oracle.DatabaseError as e:
     error, = e.args
     print("FAILED with error:", error.message)
@@ -64,12 +64,12 @@
 
 # new method: executemany() with batch errors enabled (and array DML row counts
 # also enabled) results in no immediate error being raised
-cursor.executemany("insert into ChildTable values (:1, :2, :3)", dataToInsert,
-        batcherrors = True, arraydmlrowcounts = True)
+cursor.executemany("insert into ChildTable values (:1, :2, :3)",
+                   data_to_insert, batcherrors=True, arraydmlrowcounts=True)
 
 # where errors have taken place, the row count is 0; otherwise it is 1
-rowCounts = cursor.getarraydmlrowcounts()
-print("Array DML row counts:", rowCounts)
+row_counts = cursor.getarraydmlrowcounts()
+print("Array DML row counts:", row_counts)
 
 # display the errors that have taken place
 errors = cursor.getbatcherrors()

samples/BindInsert.py

@@ -1,5 +1,5 @@
 #------------------------------------------------------------------------------
-# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
 #------------------------------------------------------------------------------
 
 #------------------------------------------------------------------------------
@@ -9,9 +9,9 @@
 #------------------------------------------------------------------------------
 
 import cx_Oracle
-import SampleEnv
+import sample_env
 
-connection = cx_Oracle.connect(SampleEnv.GetMainConnectString())
+connection = cx_Oracle.connect(sample_env.get_main_connect_string())
 
 rows = [ (1, "First" ),
          (2, "Second" ),

samples/BindQuery.py

@@ -1,5 +1,5 @@
 #------------------------------------------------------------------------------
-# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
 #------------------------------------------------------------------------------
 
 #------------------------------------------------------------------------------
@@ -13,9 +13,9 @@
 #------------------------------------------------------------------------------
 
 import cx_Oracle
-import SampleEnv
+import sample_env
 
-connection = cx_Oracle.connect(SampleEnv.GetMainConnectString())
+connection = cx_Oracle.connect(sample_env.get_main_connect_string())
 
 cursor = connection.cursor()
 sql = 'select * from SampleQueryTab where id = :bvid'

samples/BulkAQ.py

@@ -1,5 +1,5 @@
 #------------------------------------------------------------------------------
-# Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2019, 2020, Oracle and/or its affiliates. All rights reserved.
 #
 # Portions Copyright 2007-2015, Anthony Tuininga. All rights reserved.
 #
@@ -17,7 +17,7 @@
 #------------------------------------------------------------------------------
 
 import cx_Oracle
-import SampleEnv
+import sample_env
 
 QUEUE_NAME = "DEMO_RAW_QUEUE"
 PAYLOAD_DATA = [
@@ -36,7 +36,7 @@
 ]
 
 # connect to database
-connection = cx_Oracle.connect(SampleEnv.GetMainConnectString())
+connection = cx_Oracle.connect(sample_env.get_main_connect_string())
 cursor = connection.cursor()
 
 # create queue
@@ -51,22 +51,22 @@
 
 # enqueue a few messages
 print("Enqueuing messages...")
-batchSize = 6
-dataToEnq = PAYLOAD_DATA
-while dataToEnq:
-    batchData = dataToEnq[:batchSize]
-    dataToEnq = dataToEnq[batchSize:]
-    messages = [connection.msgproperties(payload=d) for d in batchData]
-    for data in batchData:
+batch_size = 6
+data_to_enqueue = PAYLOAD_DATA
+while data_to_enqueue:
+    batch_data = data_to_enqueue[:batch_size]
+    data_to_enqueue = data_to_enqueue[batch_size:]
+    messages = [connection.msgproperties(payload=d) for d in batch_data]
+    for data in batch_data:
         print(data)
     queue.enqMany(messages)
 connection.commit()
 
 # dequeue the messages
 print("\nDequeuing messages...")
-batchSize = 8
+batch_size = 8
 while True:
-    messages = queue.deqMany(batchSize)
+    messages = queue.deqMany(batch_size)
     if not messages:
         break
     for props in messages:

samples/CQN.py

@@ -1,5 +1,5 @@
 #------------------------------------------------------------------------------
-# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
 #
 # Portions Copyright 2007-2015, Anthony Tuininga. All rights reserved.
 #
@@ -18,7 +18,7 @@
 #------------------------------------------------------------------------------
 
 import cx_Oracle
-import SampleEnv
+import sample_env
 import time
 
 registered = True
@@ -47,7 +47,8 @@ def callback(message):
                     print("-" * 60)
             print("=" * 60)
 
-connection = cx_Oracle.connect(SampleEnv.GetMainConnectString(), events = True)
+connection = cx_Oracle.connect(sample_env.get_main_connect_string(),
+                               events=True)
 sub = connection.subscribe(callback = callback, timeout = 1800,
         qos = cx_Oracle.SUBSCR_QOS_QUERY | cx_Oracle.SUBSCR_QOS_ROWIDS)
 print("Subscription:", sub)
@@ -64,4 +65,3 @@ def callback(message):
 while registered:
     print("Waiting for notifications....")
     time.sleep(5)
-

samples/CQN2.py

@@ -17,7 +17,7 @@
 #------------------------------------------------------------------------------
 
 import cx_Oracle
-import SampleEnv
+import sample_env
 import time
 
 registered = True
@@ -34,11 +34,11 @@ def callback(message):
             if table.rows is None:
                 print("Too many row changes detected in table", table.name)
                 continue
-            numRowsDeleted = 0
+            num_rows_deleted = 0
             print(len(table.rows), "row changes detected in table", table.name)
             for row in table.rows:
                 if row.operation & cx_Oracle.OPCODE_DELETE:
-                    numRowsDeleted += 1
+                    num_rows_deleted += 1
                     continue
                 ops = []
                 if row.operation & cx_Oracle.OPCODE_INSERT:
@@ -51,21 +51,22 @@ def callback(message):
                         from TestTempTable
                         where rowid = :rid""",
                         rid=row.rowid)
-                intCol, = cursor.fetchone()
-                print("    Row with IntCol", intCol, "was", " and ".join(ops))
-            if numRowsDeleted > 0:
-                print("   ", numRowsDeleted, "rows deleted")
+                int_col, = cursor.fetchone()
+                print("    Row with IntCol", int_col, "was", " and ".join(ops))
+            if num_rows_deleted > 0:
+                print("   ", num_rows_deleted, "rows deleted")
             print("=" * 60)
 
-pool = cx_Oracle.SessionPool(SampleEnv.GetMainUser(),
-        SampleEnv.GetMainPassword(), SampleEnv.GetConnectString(), min=2,
-        max=5, increment=1, events=True, threaded=True)
+pool = cx_Oracle.SessionPool(user=sample_env.get_main_user(),
+                             password=sample_env.get_main_password(),
+                             dsn=sample_env.get_connect_string(), min=2,
+                             max=5, increment=1, events=True, threaded=True)
 with pool.acquire() as connection:
     sub = connection.subscribe(callback=callback, timeout=1800,
             qos=cx_Oracle.SUBSCR_QOS_QUERY | cx_Oracle.SUBSCR_QOS_ROWIDS)
     print("Subscription created with ID:", sub.id)
-    queryId = sub.registerquery("select * from TestTempTable")
-    print("Registered query with ID:", queryId)
+    query_id = sub.registerquery("select * from TestTempTable")
+    print("Registered query with ID:", query_id)
 
 while registered:
     print("Waiting for notifications....")