Rename .COPY(...) to .transfer(...)

James William Pye · James William Pye · commit 31c655539fb3 · 2010-03-15T16:57:28.000-07:00
diff --git a/postgresql/copyman.py b/postgresql/copyman.py
@@ -4,14 +4,8 @@
 """
 Manage complex COPY operations; one-to-many COPY streaming.
 
-Primarily this module houses the `CopyManager` class.
-
-	>>> import postgresql
-	>>> src = postgresql.open(...)
-	>>> dst = postgresql.open(...)
-	>>> from postgresql.copyman import COPY
-	>>> 
-	>>> COPY(src.prepare("COPY"), dst.prepare("COPY"))
+Primarily this module houses the `CopyManager` class, and the `transfer`
+function for a high-level interface to using the `CopyManager`.
 """
 import sys
 from abc import abstractmethod, abstractproperty
@@ -815,17 +809,16 @@ def __next__(self):
 		self._stats = (0, 0)
 		return current_stats
 
-def COPY(producer, *receivers, progress = None):
+def transfer(producer, *receivers):
+	"""
+	Perform a COPY operation using the given statements::
+
+		>>> import copyman
+		>>> copyman.transfer(src.prepare("COPY table TO STDOUT"), dst.prepare("COPY table FROM STDIN"))
+	"""
 	cm = CopyManager(	
 		StatementProducer(producer),
 		*[x if isinstance(x, Receiver) else StatementReceiver(x) for x in receivers]
 	)
-	try:
-		if progress:
-			pass
-		else:
-			cm.run()
-	except Fault as e:
-		typ, val, tb = next(iter(e.faults.values()))
-		raise val
+	cm.run()
 	return (cm.producer.total_messages, cm.producer.total_bytes)
diff --git a/postgresql/documentation/copyman.txt b/postgresql/documentation/copyman.txt
@@ -16,13 +16,13 @@ be used when transferring COPY data to and from arbitrary Python
 interfaces.
 
 Direct connection-to-connection COPY operations can be performed using the
-high-level `postgresql.copyman.COPY` function::
+high-level `postgresql.copyman.transfer` function::
 
-	>>> from postgresql.copyman import COPY
+	>>> from postgresql import copyman
 	>>> send_stmt = source.prepare("COPY (SELECT i FROM generate_series(1, 1000000) AS g(i)) TO STDOUT")
 	>>> destination.execute("CREATE TEMP TABLE loading_table (i int8)")
 	>>> receive_stmt = destination.prepare("COPY loading_table FROM STDIN")
-	>>> total_rows, total_bytes = COPY(send_stmt, receive_stmt)
+	>>> total_rows, total_bytes = copyman.transfer(send_stmt, receive_stmt)
 
 However, if more control is needed, the `postgresql.copyman.CopyManager` class
 should be used directly.
diff --git a/postgresql/test/test_copyman.py b/postgresql/test/test_copyman.py
@@ -360,7 +360,7 @@ def testEmptyRows(self):
 	def testCopyOne(self):
 		from io import BytesIO
 		b = BytesIO()
-		copyman.COPY(
+		copyman.transfer(
 			prepare('COPY (SELECT 1) TO STDOUT'),
 			copyman.CallReceiver(b.writelines)
 		)
@@ -371,7 +371,7 @@ def testCopyOne(self):
 	def testCopyNone(self):
 		from io import BytesIO
 		b = BytesIO()
-		copyman.COPY(
+		copyman.transfer(
 			prepare('COPY (SELECT 1 LIMIT 0) TO STDOUT'),
 			copyman.CallReceiver(b.writelines)
 		)
