Improved samples and test suite.

Author: anthony-tuininga

doc/src/release_notes.rst

@@ -17,6 +17,7 @@ Version 8.3 (TBD)
     implicit conversion to integer has become an error in Python 3.10) and
     values that are not `int`, `float` or `decimal.Decimal` are explicitly
     rejected.
+#)  Improved samples and test suite.
 
 
 Version 8.2.1 (June 2021)

samples/bulk_aq.py

@@ -10,8 +10,8 @@
 #------------------------------------------------------------------------------
 # bulk_aq.py
 #   This script demonstrates how to use bulk enqueuing and dequeuing of
-# messages with advanced queuing using cx_Oracle. It makes use of a RAW queue
-# created in the sample setup.
+# messages with advanced queuing. It makes use of a RAW queue created in the
+# sample setup.
 #
 # This script requires cx_Oracle 8.2 and higher.
 #------------------------------------------------------------------------------

samples/connection_pool.py

@@ -4,8 +4,8 @@
 
 #------------------------------------------------------------------------------
 # connection_pool.py
-#   This script demonstrates the use of connection pooling in cx_Oracle. Pools
-# can significantly reduce connection times for long running applications that
+#   This script demonstrates the use of connection pooling. Pools can
+# significantly reduce connection times for long running applications that
 # repeatedly open and close connections. Internal features help protect against
 # dead connections, and also aid use of Oracle Database features such as FAN
 # and Application Continuity.
@@ -27,8 +27,8 @@
 # Create a Connection Pool
 pool = oracledb.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)
+                            dsn=sample_env.get_connect_string(), min=2, max=5,
+                            increment=1)
 
 def the_long_query():
     with pool.acquire() as conn:

samples/cqn.py

@@ -12,7 +12,7 @@
 #   This script demonstrates using continuous query notification in Python, a
 # feature that is available in Oracle 11g and later. Once this script is
 # running, use another session to insert, update or delete rows from the table
-# cx_Oracle.TestTempTable and you will see the notification of that change.
+# TestTempTable and you will see the notification of that change.
 #
 # This script requires cx_Oracle 5.3 and higher.
 #------------------------------------------------------------------------------

samples/database_change_notification.py

@@ -12,7 +12,7 @@
 #   This script demonstrates using database change notification in Python, a
 # feature that is available in Oracle 10g Release 2. Once this script is
 # running, use another session to insert, update or delete rows from the table
-# cx_Oracle.TestTempTable and you will see the notification of that change.
+# TestTempTable and you will see the notification of that change.
 #
 # This script requires cx_Oracle 5.3 and higher.
 #------------------------------------------------------------------------------

samples/generic_row_factory.py

@@ -10,6 +10,7 @@
 #------------------------------------------------------------------------------
 
 import collections
+
 import cx_Oracle as oracledb
 import sample_env
 
@@ -21,7 +22,7 @@ def cursor(self):
 
 class Cursor(oracledb.Cursor):
 
-    def execute(self, statement, args = None):
+    def execute(self, statement, args=None):
         prepare_needed = (self.statement != statement)
         result = super().execute(statement, args or [])
         if prepare_needed:

samples/json_blob.py

@@ -15,8 +15,9 @@
 #
 #------------------------------------------------------------------------------
 
-import sys
 import json
+import sys
+
 import cx_Oracle as oracledb
 import sample_env
 

samples/json_direct.py

@@ -10,8 +10,9 @@
 #   For JSON with older databases see json_blob.py
 #------------------------------------------------------------------------------
 
-import sys
 import json
+import sys
+
 import cx_Oracle as oracledb
 import sample_env
 

samples/multi_consumer_aq.py

@@ -9,8 +9,8 @@
 
 #------------------------------------------------------------------------------
 # multi_consumer_aq.py
-#   This script demonstrates how to use multi-consumer advanced queuing using
-# cx_Oracle. It makes use of a RAW queue created in the sample setup.
+#   This script demonstrates how to use multi-consumer advanced queuing. It
+# makes use of a RAW queue created in the sample setup.
 #
 # This script requires cx_Oracle 8.2 and higher.
 #------------------------------------------------------------------------------

samples/object_aq.py

@@ -9,9 +9,8 @@
 
 #------------------------------------------------------------------------------
 # object_aq.py
-#   This script demonstrates how to use advanced queuing with objects using
-# cx_Oracle. It makes use of a simple type and queue created in the sample
-# setup.
+#   This script demonstrates how to use advanced queuing with objects. It makes
+# use of a simple type and queue created in the sample setup.
 #
 # This script requires cx_Oracle 8.2 and higher.
 #------------------------------------------------------------------------------

samples/plsql_record.py

@@ -7,8 +7,7 @@
 #
 # Demonstrate how to bind (in and out) a PL/SQL record.
 #
-# This feature is new in cx_Oracle 5.3 and is only available in Oracle
-# Database 12.1 and higher.
+# This feature is only available in Oracle Database 12.1 and higher.
 #------------------------------------------------------------------------------
 
 import datetime

samples/raw_aq.py

@@ -9,8 +9,8 @@
 
 #------------------------------------------------------------------------------
 # raw_aq.py
-#   This script demonstrates how to use advanced queuing with RAW data using
-# cx_Oracle. It makes use of a RAW queue created in the sample setup.
+#   This script demonstrates how to use advanced queuing with RAW data. It
+# makes use of a RAW queue created in the sample setup.
 #
 # This script requires cx_Oracle 8.2 and higher.
 #------------------------------------------------------------------------------

samples/ref_cursor.py

@@ -4,7 +4,7 @@
 
 #------------------------------------------------------------------------------
 # ref_cursor.py
-#   Demonstrates the use of REF cursors with cx_Oracle.
+#   Demonstrates the use of REF cursors.
 #------------------------------------------------------------------------------
 
 import cx_Oracle as oracledb

samples/sample_env.py

@@ -3,9 +3,9 @@
 #------------------------------------------------------------------------------
 
 #------------------------------------------------------------------------------
-# Sets the environment used by most Python cx_Oracle samples. Production
-# applications should consider using External Authentication to
-# avoid hard coded credentials.
+# Sets the environment used by the sample scripts. Production applications
+# should consider using External Authentication to avoid hard coded
+# credentials.
 #
 # You can set values in environment variables to bypass the sample requesting
 # the information it requires.
@@ -24,8 +24,8 @@
 # Net Service Name from a tnsnames.ora file or external naming service,
 # or it can be the name of a local Oracle database instance.
 #
-# If cx_Oracle is using Instant Client, then an Easy Connect string is
-# generally appropriate. The syntax is:
+# If using Instant Client, then an Easy Connect string is generally
+# appropriate. The syntax is:
 #
 #   [//]host_name[:port][/service_name][:server_type][/instance_name]
 #

samples/session_callback_plsql.py

@@ -29,7 +29,8 @@
 pool = oracledb.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, session_callback="pkg_SessionCallback.TheCallback")
+                            increment=1,
+                            session_callback="pkg_SessionCallback.TheCallback")
 
 # truncate table logging calls to PL/SQL session callback
 with pool.acquire() as conn:

samples/setup_samples.py

@@ -6,7 +6,7 @@
 # setup_samples.py
 #
 # Creates users and populates their schemas with the tables and packages
-# necessary for the cx_Oracle samples. An edition is also created for the
+# necessary for running the sample scripts. An edition is also created for the
 # demonstration of PL/SQL editioning.
 #------------------------------------------------------------------------------
 

samples/sql/setup_samples_exec.sql

@@ -5,7 +5,7 @@
 /*-----------------------------------------------------------------------------
  * setup_samples_exec.sql
  *   This script performs the actual work of creating and populating the
- * schemas with the database objects used by the cx_Oracle samples. An edition
+ * schemas with the database objects used by the sample scripts. An edition
  * is also created for the demonstration of PL/SQL editioning. It is called by
  * the setup_samples.sql file after acquiring the necessary parameters and also
  * by the Python script setup_samples.py.

samples/subclassing.py

@@ -5,9 +5,9 @@
 #------------------------------------------------------------------------------
 # subclassing.py
 #
-#   Demonstrate how to subclass cx_Oracle connections and cursors in order to
-# add additional functionality (like logging) or create specialized interfaces
-# for paticular applications.
+#   Demonstrate how to subclass connections and cursors in order to add
+# additional functionality (like logging) or create specialized interfaces for
+# paticular applications.
 #------------------------------------------------------------------------------
 
 import cx_Oracle as oracledb

test/drop_test.py

@@ -1,14 +1,14 @@
 #------------------------------------------------------------------------------
-# Copyright (c) 2019, 2020, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2019, 2021, Oracle and/or its affiliates. All rights reserved.
 #------------------------------------------------------------------------------
 
 #------------------------------------------------------------------------------
 # drop_test.py
 #
-# Drops the database objects used for the cx_Oracle test suite.
+# Drops the database objects used by the test suite.
 #------------------------------------------------------------------------------
 
-import cx_Oracle
+import cx_Oracle as oracledb
 import test_env
 
 def drop_tests(conn):
@@ -18,6 +18,6 @@ def drop_tests(conn):
                             proxy_user=test_env.get_proxy_user())
 
 if __name__ == "__main__":
-    conn = cx_Oracle.connect(test_env.get_admin_connect_string())
+    conn = oracledb.connect(test_env.get_admin_connect_string())
     drop_tests(conn)
     print("Done.")

test/setup_test.py

@@ -6,16 +6,15 @@
 # setup_test.py
 #
 # Creates users and populates their schemas with the tables and packages
-# necessary for the cx_Oracle test suite.
+# necessary for the test suite.
 #------------------------------------------------------------------------------
 
-import cx_Oracle
-
-import test_env
+import cx_Oracle as oracledb
 import drop_test
+import test_env
 
 # connect as administrative user (usually SYSTEM or ADMIN)
-conn = cx_Oracle.connect(test_env.get_admin_connect_string())
+conn = oracledb.connect(test_env.get_admin_connect_string())
 
 # drop existing users and editions, if applicable
 drop_test.drop_tests(conn)

test/test_1000_module.py

@@ -6,12 +6,12 @@
 1000 - Module for testing top-level module methods
 """
 
-import test_env
-
-import cx_Oracle as oracledb
 import datetime
 import time
 
+import cx_Oracle as oracledb
+import test_env
+
 class TestCase(test_env.BaseTestCase):
     requires_connection = False