Add Connection.transaction alias for asyncpg consistency.

jwp · jwp · commit 6731fe3be5f6 · 2020-12-19T12:01:18.000-07:00
diff --git a/postgresql/documentation/changes-v1.3.rst b/postgresql/documentation/changes-v1.3.rst
@@ -6,6 +6,7 @@ Changes in v1.3
 
  * Commit DB-API 2.0 ClientCannotConnect exception correction.
  * Eliminate types-as-documentation annotations.
+ * Add Connection.transaction alias for asyncpg consistency.
  * Eliminate multiple inheritance in `postgresql.api` in favor of ABC registration.
  * Add support for PGTEST environment variable (pq-IRI) to improve test performance
    and to aid in cases where the target fixture is already available.
diff --git a/postgresql/documentation/sphinx/changes-v1.3.rst b/postgresql/documentation/sphinx/changes-v1.3.rst
@@ -0,0 +1 @@
+../changes-v1.3.rst
diff --git a/postgresql/driver/pq3.py b/postgresql/driver/pq3.py
@@ -2324,9 +2324,12 @@ def do(self, language : str, source : str,
 		sql = "DO " + qlit(source) + " LANGUAGE " + qid(language) + ";"
 		self.execute(sql)
 
-	def xact(self, isolation = None, mode = None) -> Transaction:
+	# Alias transaction as xact. xact is the original term, but support
+	# the full word for identifier consistency with asyncpg.
+	def transaction(self, isolation = None, mode = None) -> Transaction:
 		x = Transaction(self, isolation = isolation, mode = mode)
 		return x
+	xact=transaction
 
 	def prepare(self,
 		sql_statement_string : str,
diff --git a/postgresql/test/test_driver.py b/postgresql/test/test_driver.py
@@ -824,6 +824,27 @@ def testSelectInXact(self):
 		with db.xact():
 			self.select()
 
+	@pg_tmp
+	def testTransactionAlias(self):
+		self.assertEqual(db.transaction, db.xact)
+
+		try:
+			with db.transaction():
+				db.execute("CREATE TABLE t (i int);")
+				raise Exception('some failure')
+		except:
+			pass
+		else:
+			self.fail("expected exception was not raised")
+
+		try:
+			db.query("select * from t")
+		except:
+			# No table.
+			pass
+		else:
+			self.fail("transaction abort had no effect")
+
 	def cursor_read(self):
 		ps = db.prepare("SELECT i FROM generate_series(0, (2^8)::int - 1) AS g(i)")
 		c = ps.declare()
