Use 'CLIENT' instead of 'DRIVER' as it better communicates the purpose of 'source'.

James William Pye · James William Pye · commit 65e25ce87fc4 · 2009-04-01T02:49:35.000-07:00
Cleanup the OperationError messages in pq3.Transaction. Use 'cause' or 'hint'
label instead of 'driver'. 'cause' is new, but more descriptive than 'DRIVER'.

Unrelated: remove title keywords.
diff --git a/postgresql/api.py b/postgresql/api.py
@@ -298,7 +298,7 @@ class Message(InterfaceElement):
 	)
 	sources = (
 		'SERVER',
-		'DRIVER',
+		'CLIENT',
 	)
 
 	# What generated the message?
@@ -312,7 +312,7 @@ def __init__(self,
 		message : "The primary information of the message",
 		code : "Message code to attach (SQL state)" = None,
 		details : "additional information associated with the message" = {},
-		source : "What generated the message(SERVER, DRIVER)" = None,
+		source : "What generated the message(SERVER, CLIENT)" = None,
 	):
 		self.message = message
 		self.details = details
diff --git a/postgresql/documentation/driver.py b/postgresql/documentation/driver.py
@@ -1262,7 +1262,7 @@
 	postgresql.exceptions.InFailedTransactionError: invalid block exit detected
 	CODE: 25P02
 	SEVERITY: ERROR
-	SOURCE: DRIVER
+	SOURCE: CLIENT
 
 Normally, if a ``COMMIT`` is issued on a failed transaction, the command implies a
 ``ROLLBACK`` without error. This is a very undesirable result for the CM's exit
diff --git a/postgresql/driver/pq3.py b/postgresql/driver/pq3.py
@@ -1543,12 +1543,10 @@ def __init__(self, ident, database, description = ()):
 		if isinstance(ident, int):
 			proctup = database.prepare(
 				ProcedureLookup + ' WHERE pg_proc.oid = $1',
-				title = 'func_lookup_by_oid'
 			).first(int(ident))
 		else:
 			proctup = database.prepare(
 				ProcedureLookup + ' WHERE pg_proc.oid = regprocedurein($1)',
-				title = 'func_lookup_by_name'
 			).first(ident)
 		if proctup is None:
 			raise LookupError("no function with identifier %s" %(str(ident),))
@@ -1617,7 +1615,6 @@ def __getitem__(self, i):
 			db = self.database
 			r = db.prepare(
 				"SELECT setting FROM pg_settings WHERE name = $1",
-				title = 'lookup_setting_by_name'
 			)(i).read()
 
 			if r:
@@ -1633,7 +1630,6 @@ def __setitem__(self, i, v):
 
 		setas = self.database.prepare(
 			"SELECT set_config($1, $2, false)",
-			title = 'set_setting',
 		).first(i, v)
 		self.cache[i] = setas
 
@@ -1675,7 +1671,6 @@ def get(self, k, alt = None):
 		db = self.database
 		r = db.prepare(
 			"SELECT setting FROM pg_settings WHERE name = $1",
-			title = 'lookup_setting_by_name'
 		)(k).read()
 		if r:
 			v = r[0][0]
@@ -1697,7 +1692,6 @@ def getset(self, keys):
 		if rkeys:
 			r = self.database.prepare(
 				"SELECT name, setting FROM pg_settings WHERE name = ANY ($1)",
-				title = 'lookup_settings_by_name'
 			)(rkeys).read()
 			self.cache.update(r)
 			setmap.update(r)
@@ -1709,22 +1703,19 @@ def getset(self, keys):
 	def keys(self):
 		for x, in self.database.prepare(
 			"SELECT name FROM pg_settings ORDER BY name",
-			title = 'get_setting_names'
 		):
 			yield x
 	__iter__ = keys
 
 	def values(self):
 		for x, in self.database.prepare(
 			"SELECT setting FROM pg_settings ORDER BY name",
-			title = 'get_setting_values'
 		):
 			yield x
 
 	def items(self):
 		return self.database.prepare(
 			"SELECT name, setting FROM pg_settings ORDER BY name",
-			title = 'get_settings'
 		)
 
 	def update(self, d):
@@ -1733,7 +1724,6 @@ def update(self, d):
 			"SELECT ($1::text[][])[i][1] AS key, " \
 			"set_config(($1::text[][])[i][1], $1[i][2], false) AS value " \
 			"FROM generate_series(1, array_upper(($1::text[][]), 1)) g(i)",
-			title = 'update_settings'
 		)(kvl))
 
 	def _notify(self, msg):
@@ -1808,10 +1798,10 @@ def __exit__(self, typ, value, tb):
 			if self.database._pq_state == b'E':
 				err = pg_exc.InFailedTransactionError(
 					"invalid transaction block exit detected",
-					source = 'DRIVER',
+					source = 'CLIENT',
 					details = {
-						'DRIVER': \
-							'Connection was in an error-state, ' \
+						'cause': \
+							'Database was in an error-state, ' \
 							'but no exception was raised.'
 					},
 				)
@@ -1843,7 +1833,7 @@ def __exit__(self, typ, value, tb):
 					#
 					# But the occurrence of this exception means it's not in an active
 					# transaction, which means no cleanup other than raise is necessary.
-					err.details['DRIVER'] = \
+					err.details['cause'] = \
 						"The prepared transaction was not " \
 						"prepared prior to the block's exit."
 					raise
@@ -1897,7 +1887,7 @@ def start(self):
 			err = pg_exc.OperationError(
 				"transactions cannot be restarted",
 				details = {
-					'DRIVER': \
+					'hint': \
 					'Create a new transaction object instead of re-using an old one.'
 				}
 			)
@@ -1916,7 +1906,7 @@ def start(self):
 				err = pg_exc.OperationError(
 					"configured transaction used inside a transaction block",
 					details = {
-						'hint': 'A transaction block was already started.'
+						'cause': 'A transaction block was already started.'
 					}
 				)
 				self.ife_descend(err)
@@ -1968,7 +1958,7 @@ def recover(self):
 		else:
 			err = pg_exc.UndefinedObjectError(
 				"prepared transaction does not exist",
-				source = 'DRIVER',
+				source = 'CLIENT',
 			)
 			self.ife_descend(err)
 			err.raise_exception()
@@ -1978,11 +1968,7 @@ def commit(self):
 			return
 		if self.state not in ('prepared', 'open'):
 			err = pg_exc.OperationError(
-				"commit attempted on transaction with unexpected state",
-				details = {
-					'DRIVER': "Transaction was " + repr(self.state) + \
-					" , but it must be 'prepared' or 'open' in order to commit."
-				}
+				"commit attempted on transaction with unexpected state, " + repr(self.state),
 			)
 			self.ife_descend(err)
 			err.raise_exception()
@@ -1998,8 +1984,7 @@ def commit(self):
 				err = pg_exc.OperationError(
 					"savepoint configured with global identifier",
 					details = {
-						'DRIVER': \
-						"Don't configure savepoint transactions with global identifiers."
+						'cause': "Prepared transaction started inside transaction block?"
 					}
 				)
 				self.ife_descend(err)
@@ -2017,10 +2002,8 @@ def rollback(self):
 			return
 		if self.state not in ('prepared', 'open'):
 			err = pg_exc.OperationError(
-				"aborted attempted on transaction with unexpected state",
-				details = {
-					'hint': "Transactions cannot be re-used."
-				}
+				"aborted attempted on transaction with unexpected state, " \
+				+ repr(self.state),
 			)
 			self.ife_descend(err)
 			err.raise_exception()
@@ -2192,7 +2175,6 @@ def xact(self, gid = None, isolation = None, mode = None):
 	def prepare(self,
 		sql_statement_string : str,
 		statement_id = None,
-		title = None,
 	) -> PreparedStatement:
 		ps = PreparedStatement.from_string(sql_statement_string, self)
 		self.ife_descend(ps)
@@ -2295,7 +2277,7 @@ def connect(self, timeout = None):
 				details = {
 					"severity" : "FATAL",
 				},
-				source = 'DRIVER'
+				source = 'CLIENT'
 			)
 			self.ife_descend(err)
 			err.database = self
@@ -2350,7 +2332,7 @@ def connect(self, timeout = None):
 						# probably not PQv3..
 						raise pg_exc.ProtocolError(
 							"server did not support SSL negotiation",
-							source = 'DRIVER',
+							source = 'CLIENT',
 							details = {
 								'hint' : \
 								'The server is probably not PostgreSQL.'
@@ -2361,7 +2343,7 @@ def connect(self, timeout = None):
 						raise pg_exc.InsecurityError(
 							"`sslmode` required a secure connection, " \
 							"but was unsupported by server",
-							source = 'DRIVER'
+							source = 'CLIENT'
 						)
 					if supported:
 						self.socket = self.connector.socket_secure(self.socket)
@@ -2414,7 +2396,7 @@ def connect(self, timeout = None):
 					"severity" : "FATAL",
 				},
 				# It's really a sequence of exceptions.
-				source = 'DRIVER'
+				source = 'CLIENT'
 			)
 			self.ife_descend(err)
 			err.database = self
diff --git a/postgresql/exceptions.py b/postgresql/exceptions.py
@@ -64,7 +64,7 @@ class Warning(PythonMessage, Warning):
 
 class DriverWarning(Warning):
 	code = ''
-	source = 'DRIVER'
+	source = 'CLIENT'
 class IgnoredClientParameterWarning(DriverWarning):
 	'Warn the user of a valid, but ignored parameter.'
 class TypeConversionWarning(DriverWarning):
@@ -117,7 +117,7 @@ def raise_exception(self, raise_from = None):
 
 class DriverError(Error):
 	"Errors originating in the driver's implementation."
-	source = 'DRIVER'
+	source = 'CLIENT'
 class AuthenticationMethodError(DriverError):
 	"""
 	Server requested an authentication method that is not supported by the
@@ -127,7 +127,7 @@ class InsecurityError(DriverError):
 	"""
 	Error signifying a secure channel to a server cannot be established.
 	"""
-	source = 'DRIVER'
+
 class TypeIOError(DriverError):
 	"""
 	Driver failed to pack or unpack a tuple.
diff --git a/postgresql/test/test_driver.py b/postgresql/test/test_driver.py
@@ -1110,7 +1110,7 @@ def testFailedTransactionBlock(self):
 					pass
 			self.fail("__exit__ didn't identify failed transaction")
 		except pg_exc.InFailedTransactionError as err:
-			self.failUnlessEqual(err.source, 'DRIVER')
+			self.failUnlessEqual(err.source, 'CLIENT')
 
 	def testFailedSubtransactionBlock(self):
 		with self.db.xact():
@@ -1123,7 +1123,7 @@ def testFailedSubtransactionBlock(self):
 				self.fail("__exit__ didn't identify failed transaction")
 			except pg_exc.InFailedTransactionError as err:
 				# driver should have released/aborted instead
-				self.failUnlessEqual(err.source, 'DRIVER')
+				self.failUnlessEqual(err.source, 'CLIENT')
 
 	def testCloseInSubTransactionBlock(self):
 		try:
