more ironing in the corner of that 'types' modules
[plcapi.git] / PLC / PostgreSQL.py
index ae6c55a..2368419 100644 (file)
@@ -5,6 +5,12 @@
 # Mark Huang <mlhuang@cs.princeton.edu>
 # Copyright (C) 2006 The Trustees of Princeton University
 #
+# pylint: disable=c0103, c0111
+
+import subprocess
+import re
+from pprint import pformat
+from datetime import datetime as DateTimeType
 
 import psycopg2
 import psycopg2.extensions
@@ -12,16 +18,9 @@ psycopg2.extensions.register_type(psycopg2.extensions.UNICODE)
 # UNICODEARRAY not exported yet
 psycopg2.extensions.register_type(psycopg2._psycopg.UNICODEARRAY)
 
-import types
-import traceback
-import subprocess
-import re
-from pprint import pformat
-
 from PLC.Logger import logger
-from PLC.Debug import profile
+#from PLC.Debug import profile
 from PLC.Faults import *
-from datetime import datetime as DateTimeType
 
 class PostgreSQL:
     def __init__(self, api):
@@ -35,16 +34,18 @@ class PostgreSQL:
             # (Re)initialize database connection
             try:
                 # Try UNIX socket first
-                self.connection = psycopg2.connect(user = self.api.config.PLC_DB_USER,
-                                                   password = self.api.config.PLC_DB_PASSWORD,
-                                                   database = self.api.config.PLC_DB_NAME)
+                self.connection = psycopg2.connect(
+                    user=self.api.config.PLC_DB_USER,
+                    password=self.api.config.PLC_DB_PASSWORD,
+                    database=self.api.config.PLC_DB_NAME)
             except psycopg2.OperationalError:
                 # Fall back on TCP
-                self.connection = psycopg2.connect(user = self.api.config.PLC_DB_USER,
-                                                   password = self.api.config.PLC_DB_PASSWORD,
-                                                   database = self.api.config.PLC_DB_NAME,
-                                                   host = self.api.config.PLC_DB_HOST,
-                                                   port = self.api.config.PLC_DB_PORT)
+                self.connection = psycopg2.connect(
+                    user=self.api.config.PLC_DB_USER,
+                    password=self.api.config.PLC_DB_PASSWORD,
+                    database=self.api.config.PLC_DB_NAME,
+                    host=self.api.config.PLC_DB_HOST,
+                    port=self.api.config.PLC_DB_PORT)
             self.connection.set_client_encoding("UNICODE")
 
         (self.rowcount, self.description, self.lastrowid) = \
@@ -63,7 +64,7 @@ class PostgreSQL:
         if isinstance(x, DateTimeType):
             x = str(x)
         elif isinstance(x, str):
-            x = x.encode( 'utf-8' )
+            x = x.encode('utf-8')
 
         if isinstance(x, bytes):
             x = "'%s'" % str(x).replace("\\", "\\\\").replace("'", "''")
@@ -72,7 +73,7 @@ class PostgreSQL:
         elif x is None:
             x = 'NULL'
         elif isinstance(x, (list, tuple, set)):
-            x = 'ARRAY[%s]' % ', '.join([str(_quote(x)) for x in x])
+            x = 'ARRAY[%s]' % ', '.join([str(PostgreSQL._quote(x)) for x in x])
         elif hasattr(x, '__pg_repr__'):
             x = x.__pg_repr__()
         else:
@@ -84,7 +85,7 @@ class PostgreSQL:
         """
         Returns quoted version of the specified value.
         """
-        return PostgreSQL._quote (value)
+        return PostgreSQL._quote(value)
 
 # following is an unsuccessful attempt to re-use lib code as much as possible
 #    def quote(self, value):
@@ -103,7 +104,7 @@ class PostgreSQL:
 #                return adapt (value)
 
     @classmethod
-    def param(self, name, value):
+    def param(cls, name, value):
         # None is converted to the unquoted string NULL
         if isinstance(value, type(None)):
             conversion = "s"
@@ -129,25 +130,24 @@ class PostgreSQL:
     def rollback(self):
         self.connection.rollback()
 
-    def do(self, query, params = None):
+    def do(self, query, params=None):
         cursor = self.execute(query, params)
         cursor.close()
         return self.rowcount
 
     def next_id(self, table_name, primary_key):
-        sequence = "%(table_name)s_%(primary_key)s_seq" % locals()
-        sql = "SELECT nextval('%(sequence)s')" % locals()
-        rows = self.selectall(sql, hashref = False)
+        sequence = "{}_{}_seq".format(table_name, primary_key)
+        sql = "SELECT nextval('{}')".format(sequence)
+        rows = self.selectall(sql, hashref=False)
         if rows:
             return rows[0][0]
-
         return None
 
     def last_insert_id(self, table_name, primary_key):
         if isinstance(self.lastrowid, int):
             sql = "SELECT %s FROM %s WHERE oid = %d" % \
                   (primary_key, table_name, self.lastrowid)
-            rows = self.selectall(sql, hashref = False)
+            rows = self.selectall(sql, hashref=False)
             if rows:
                 return rows[0][0]
 
@@ -158,7 +158,7 @@ class PostgreSQL:
     # see http://www.python.org/dev/peps/pep-0249/
     # accepts either None, a single dict, a tuple of single dict - in which case it execute's
     # or a tuple of several dicts, in which case it executemany's
-    def execute(self, query, params = None):
+    def execute(self, query, params=None):
 
         cursor = self.cursor()
         try:
@@ -171,7 +171,7 @@ class PostgreSQL:
             if psycopg2:
                 query = re.sub(r'(%\([^)]*\)|%)[df]', r'\1s', query)
             # rewrite wildcards set by Filter.py as '***' into '%'
-            query = query.replace ('***','%')
+            query = query.replace('***', '%')
 
             if not params:
                 if self.debug:
@@ -182,12 +182,12 @@ class PostgreSQL:
                     logger.debug('execute-dict: params {} query {}'
                                  .format(params, query%params))
                 cursor.execute(query, params)
-            elif isinstance(params,tuple) and len(params)==1:
+            elif isinstance(params, tuple) and len(params) == 1:
                 if self.debug:
                     logger.debug('execute-tuple {}'.format(query%params[0]))
-                cursor.execute(query,params[0])
+                cursor.execute(query, params[0])
             else:
-                param_seq=(params,)
+                param_seq = (params,)
                 if self.debug:
                     for params in param_seq:
                         logger.debug('executemany {}'.format(query%params))
@@ -209,7 +209,7 @@ class PostgreSQL:
 
         return cursor
 
-    def selectall(self, query, params = None, hashref = True, key_field = None):
+    def selectall(self, query, params=None, hashref=True, key_field=None):
         """
         Return each row as a dictionary keyed on field name (like DBI
         selectrow_hashref()). If key_field is specified, return rows
@@ -233,11 +233,11 @@ class PostgreSQL:
         if key_field is not None and key_field in labels:
             # Return rows as a dictionary keyed on the specified field
             # (like DBI selectall_hashref()).
-            return dict([(row[key_field], row) for row in rows])
+            return {row[key_field]: row for row in rows}
         else:
             return rows
 
-    def fields(self, table, notnull = None, hasdef = None):
+    def fields(self, table, notnull=None, hasdef=None):
         """
         Return the names of the fields of the specified table.
         """
@@ -258,7 +258,7 @@ class PostgreSQL:
         if hasdef is not None:
             sql += " AND atthasdef is %(hasdef)s"
 
-        rows = self.selectall(sql, locals(), hashref = False)
+        rows = self.selectall(sql, locals(), hashref=False)
 
         self.fields_cache[(table, notnull, hasdef)] = [row[0] for row in rows]