Minor documentation updates and remove --role.

James William Pye · James William Pye · commit 70ecc77af31d · 2009-03-31T23:40:26.000-07:00
--role didn't have any support with connectors/connections, so remove it
entirely. It will likely be implemented later.
diff --git a/postgresql/clientparameters.py b/postgresql/clientparameters.py
@@ -86,7 +86,7 @@ def getuser():
 	'KRBSRVNAME' : 'kerberos5_service',
 
 	# Extensions
-	'ROLE' : 'role', # SET ROLE $PGROLE
+	#'ROLE' : 'role', # SET ROLE $PGROLE
 
 	# This keyword *should* never make it to a connect() function
 	# as `resolve_password` should be called to fill in the
@@ -144,8 +144,6 @@ def envvars(environ = os.environ, modifier : "environment variable key modifier"
 		PGKRBSVRNAME -> kerberos5_service
 		PGSSLKEY -> sslkey
 
-		PGROLE -> role (role to set when connected)
-
 		PGTZ -> settings['timezone']
 		PGDATESTYLE -> settings['datestyle']
 		PGCLIENTENCODING -> settings['client_encoding']
@@ -262,12 +260,6 @@ def append_settings(option, opt_str, value, parser):
 	type = 'choice',
 )
 
-option_role = make_option('--role',
-	dest = 'role',
-	help = 'run operation as the role',
-	type = 'str',
-)
-
 def append_db_client_x_parameters(option, opt_str, value, parser):
 	parser.values.db_client_parameters.append((option.dest, value))
 make_x_option = partial(make_option, callback = append_db_client_x_parameters)
@@ -313,7 +305,6 @@ def _add_help_option(self):
 default_optparse_options = [
 	option_unix,
 	option_sslmode,
-	option_role,
 	option_settings,
 # Complex Options
 	option_iri,
@@ -323,7 +314,7 @@ def _add_help_option(self):
 class DefaultParser(StandardParser):
 	"""
 	Parser that includes a variety of connectivity options.
-	(IRI, sslmode, role(set role), settings)
+	(IRI, sslmode, settings)
 	"""
 	standard_option_list = default_optparse_options
 
diff --git a/postgresql/documentation/admin.py b/postgresql/documentation/admin.py
@@ -26,8 +26,9 @@
 
 	$ /usr/opt/bin/python3.0 ./setup.py install
 
-Under most POSIX systems, the above should work without problem. However, if it
-does fail, it is likely due to a C extension.
+Under most POSIX systems, the above should work without problem if the proper
+Python executable is referenced. However, if it does fail, it is likely due
+to a C extension's inability to compile.
 
 The building of C extensions can be disable using the ``PY_BUILD_EXTENSIONS``
 environment variable::
@@ -50,12 +51,14 @@
 	C:\-> setenv PY_BUILD_EXTENSIONS 1
 	C:\-> c:\python30\python setup.py install
 
-Or more likely, compile using mingw32::
+Or, more likely, compile using mingw32::
 
 	C:\-> setenv PY_BUILD_EXTENSIONS 1
 	C:\-> c:\python30\python setup.py build_ext --compiler=mingw32
 	C:\-> c:\python30\python setup.py install
 
+See http://www.mingw.org/ to get the compiler.
+
 
 Environment
 -----------
diff --git a/postgresql/documentation/bin.py b/postgresql/documentation/bin.py
@@ -14,9 +14,9 @@
 
 The ``pg_python`` command provides a simple way to write Python scripts against a
 single target database. It acts like the regular Python console command, but
-then takes standard PostgreSQL options as well to specify the client parameters
-to make the connection with. The Python environment is then augmented with the
-following additional built-ins:
+takes standard PostgreSQL options as well to specify the client parameters
+to make establish connection with. The Python environment is then augmented
+with the following built-ins:
 
  ``db``
   The PG-API connection object.
@@ -43,7 +43,6 @@
   --unix=UNIX           path to filesystem socket
   --ssl-mode=SSLMODE    SSL requirement for connectivity: require, prefer,
                         allow, disable
-  --role=ROLE           run operation as the role
   -s SETTINGS, --setting=SETTINGS
                         run-time parameters to set upon connecting
   -I PQ_IRI, --iri=PQ_IRI
@@ -112,12 +111,12 @@
 ``pg_dotconf``
 ==============
 
-pg_dotconf is used to safely modify a PostgreSQL cluster's configuration file.
+pg_dotconf is used to modify a PostgreSQL cluster's configuration file.
 It provides a means to apply settings specified from the command line and from a
 file referenced using the ``-f`` option.
 
 .. warning::
- ``include`` directives in configuration files are completely ignored. If
+ ``include`` directives in configuration files are *completely* ignored. If
  modification of an included file is desired, the command must be applied to
  that specific file.
 
diff --git a/postgresql/driver/pq3.py b/postgresql/driver/pq3.py
@@ -2056,16 +2056,6 @@ class Connection(pg_api.Connection):
 
 	_socketfactory = None
 
-	def user():
-		def fget(self):
-			return self.prepare('SELECT current_user').first()
-		def fset(self, val):
-			return self.execute('SET ROLE "%s"' %(val.replace('"', '""'),))
-		def fdel(self):
-			self.execute("RESET ROLE")
-		return locals()
-	user = property(**user())
-
 	_tracer = None
 	def tracer():
 		def fget(self):
diff --git a/postgresql/test/test_connect.py b/postgresql/test/test_connect.py
@@ -167,7 +167,7 @@ def test_md5_connect(self):
 			**self.params
 		)
 		with c:
-			self.failUnlessEqual(c.user, 'md5')
+			self.failUnlessEqual(c.prepare('select current_user').first(), 'md5')
 
 	def test_crypt_connect(self):
 		if self.do_crypt:
@@ -178,7 +178,7 @@ def test_crypt_connect(self):
 				**self.params
 			)
 			with c:
-				self.failUnlessEqual(c.user, 'crypt')
+				self.failUnlessEqual(c.prepare('select current_user').first(), 'crypt')
 
 	def test_password_connect(self):
 		c = self.cluster.connection(
@@ -187,7 +187,7 @@ def test_password_connect(self):
 			database = 'test',
 		)
 		with c:
-			self.failUnlessEqual(c.user, 'password')
+			self.failUnlessEqual(c.prepare('select current_user').first(), 'password')
 
 	def test_trusted_connect(self):
 		c = self.cluster.connection(
@@ -197,7 +197,7 @@ def test_trusted_connect(self):
 			**self.params
 		)
 		with c:
-			self.failUnlessEqual(c.user, 'trusted')
+			self.failUnlessEqual(c.prepare('select current_user').first(), 'trusted')
 
 if __name__ == '__main__':
 	unittest.main()
