Minor doc updates and get rid of path attribute and [un]subscribe in api.

James William Pye · James William Pye · commit 49706cc33c85 · 2009-03-17T14:04:43.000-07:00
diff --git a/postgresql/api.py b/postgresql/api.py
@@ -504,10 +504,10 @@ def read(self,
 		quantity : "Number of rows to read" = None
 	) -> ["Row"]:
 		"""
-		Read the specified number of rows and return them in a list.
+		Read, fetch, the specified number of rows and return them in a list.
 		This alters the cursor's position.
 
-		If the quantity is a negative value, read backwards.
+		If the quantity is a negative value, fetch backwards.
 		"""
 
 	@abstractmethod
@@ -886,30 +886,6 @@ class Settings(
 	"""
 	ife_label = 'SETTINGS'
 
-	def getpath(self) -> [str]:
-		"""
-		Returns a sequence of the schemas that make up the current search_path.
-		"""
-	def setpath(self, seq : [str]):
-		"""
-		Set the "search_path" setting to the given a sequence of schema names, 
-		[Implementations must properly escape and join the strings]
-		"""
-	path = propertydoc(abstractproperty(
-		getpath, setpath,
-		doc = """
-		An interface to a structured ``search_path`` setting:
-
-		>>> db.settings.path
-		['public', '$user']
-
-		It may also be used to set the path:
-
-		>>> db.settings.path = ('public', 'tools')
-		"""
-	))
-	del getpath, setpath
-
 	@abstractmethod
 	def __getitem__(self, key):
 		"""
@@ -928,8 +904,8 @@ def __setitem__(self, key, value):
 	@abstractmethod
 	def __call__(self, **kw):
 		"""
-		Create a context manager applying the given settings. This is normally used
-		in conjunction with a with-statement:
+		Create a context manager applying the given settings on __enter__ and
+		restoring the old values on __exit__.
 
 		>>> with db.settings(search_path = 'local,public'):
 		...  ...
@@ -974,31 +950,6 @@ def items(self):
 		Return an iterator to all of the setting value pairs.
 		"""
 
-	@abstractmethod
-	def subscribe(self, key, callback):
-		"""
-		Subscribe to changes of the setting using the callback. When the setting
-		is changed, the callback will be invoked with the connection, the key,
-		and the new value. If the old value is locally cached, its value will
-		still be available for inspection, but there is no guarantee.
-		If `None` is passed as the key, the callback will be called whenever any
-		setting is remotely changed.
-
-		>>> def watch(connection, key, newval):
-		...
-		>>> db.settings.subscribe('TimeZone', watch)
-		"""
-
-	@abstractmethod
-	def unsubscribe(self, key, callback):
-		"""
-		Stop listening for changes to a setting. The setting name(`key`), and
-		the callback used to subscribe must be given again for successful
-		termination of the subscription.
-
-		>>> db.settings.unsubscribe('TimeZone', watch)
-		"""
-
 class Database(InterfaceElement):
 	"""
 	The interface to an individual database. `Connection` objects inherit from
@@ -1259,7 +1210,6 @@ def __init__(self,
 		password : str = None,
 		database : str = None,
 		settings : (dict, [(str,str)]) = None,
-		path : "sequence of schema names to set the search_path to" = None
 	):
 		if user is None:
 			# sure, it's a "required" keyword, makes for better documentation
@@ -1268,7 +1218,6 @@ def __init__(self,
 		self.password = password
 		self.database = database
 		self.settings = settings
-		self.path = path
 
 class Connection(Database):
 	"""
diff --git a/postgresql/configfile.py b/postgresql/configfile.py
@@ -331,11 +331,5 @@ def getset(self, keys):
 		for x in (keys - set(cfg.keys())):
 			cfg[x] = None
 		return cfg
-
-	def subscribe(self):
-		pass
-
-	def unsubscribe(self):
-		pass
 ##
 # vim: ts=3:sw=3:noet:
diff --git a/postgresql/driver/pq3.py b/postgresql/driver/pq3.py
@@ -1521,12 +1521,31 @@ def _notify(self, msg):
 		self.cache[key] = val
 
 	def subscribe(self, key, callback):
+		"""
+		Subscribe to changes of the setting using the callback. When the setting
+		is changed, the callback will be invoked with the connection, the key,
+		and the new value. If the old value is locally cached, its value will
+		still be available for inspection, but there is no guarantee.
+		If `None` is passed as the key, the callback will be called whenever any
+		setting is remotely changed.
+
+		>>> def watch(connection, key, newval):
+		...
+		>>> db.settings.subscribe('TimeZone', watch)
+		"""
 		subs = self._subscriptions = getattr(self, '_subscriptions', {})
 		callbacks = subs.setdefault(key, [])
 		if callback not in callbacks:
 			callbacks.append(callback)
 
 	def unsubscribe(self, key, callback):
+		"""
+		Stop listening for changes to a setting. The setting name(`key`), and
+		the callback used to subscribe must be given again for successful
+		termination of the subscription.
+
+		>>> db.settings.unsubscribe('TimeZone', watch)
+		"""
 		subs = getattr(self, '_subscriptions', {})
 		callbacks = subs.get(key, ())
 		if callback in callbacks:
diff --git a/postgresql/unittest.py b/postgresql/unittest.py
@@ -51,8 +51,8 @@ def configure_cluster(self):
 			e.raise_exception()
 		self.cluster.settings.update(dict(
 			port = str(self.cluster_port), # XXX: identify an available port and use it
-			max_connections = '16',
-			shared_buffers = '64',
+			max_connections = '8',
+			shared_buffers = '32',
 			listen_addresses = 'localhost',
 			log_destination = 'stderr',
 			log_min_messages = 'FATAL',
@@ -69,7 +69,6 @@ def initialize_database(self):
 				"where datname = 'test'"
 			).first() is None:
 				c.execute('create database test')
-			print("============ INITIALIZED test ==============")
 
 	def run(self, *args, **kw):
 		if not self.cluster.initialized():
