summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarco De Paoli <depaolim@gmail.com>2018-10-05 09:23:13 +0200
committerMarco De Paoli <depaolim@gmail.com>2018-10-06 15:19:01 +0200
commit1c553bb703d5b087e1f5b7966584c70b0b8a196a (patch)
treef3b2be0a949b6fc10a00371663412dfa143333b7
parent9d83b036059d88b49477d5a068b4fad84076de30 (diff)
downloadpsycopg2-1c553bb703d5b087e1f5b7966584c70b0b8a196a.tar.gz
Added connection.host
Return the server host name of the current connect.
-rw-r--r--NEWS1
-rw-r--r--doc/src/connection.rst18
-rw-r--r--psycopg/connection_type.c22
-rwxr-xr-xtests/test_connection.py15
4 files changed, 55 insertions, 1 deletions
diff --git a/NEWS b/NEWS
index eabb839..a47b2a5 100644
--- a/NEWS
+++ b/NEWS
@@ -13,6 +13,7 @@ New features:
(:ticket:`#773`).
- `~psycopg2.extras.DictCursor` and `~psycopg2.extras.RealDictCursor` rows
maintain columns order (:ticket:`#177`).
+- Added `connection.host` property (:ticket:`#726`).
Other changes:
diff --git a/doc/src/connection.rst b/doc/src/connection.rst
index 2910f30..2231995 100644
--- a/doc/src/connection.rst
+++ b/doc/src/connection.rst
@@ -600,6 +600,24 @@ The ``connection`` class
.. index::
+ pair: Backend; Host
+
+ .. attribute:: host
+
+ Returns the server host name of the active connection.
+
+ This can be a host name, an IP address, or a directory path if the
+ connection is via Unix socket. (The path case can be distinguished
+ because it will always be an absolute path, beginning with /.)
+
+ .. seealso:: libpq docs for `PQhost()`__ for details.
+
+ .. __: http://www.postgresql.org/docs/current/static/libpq-status.html#LIBPQ-PQHOST
+
+ .. versionadded:: 2.8.0
+
+
+ .. index::
pair: Backend; PID
.. method:: get_backend_pid()
diff --git a/psycopg/connection_type.c b/psycopg/connection_type.c
index 6a66d48..da421c0 100644
--- a/psycopg/connection_type.c
+++ b/psycopg/connection_type.c
@@ -992,6 +992,25 @@ psyco_conn_get_backend_pid(connectionObject *self)
return PyInt_FromLong((long)PQbackendPID(self->pgconn));
}
+/* get the current host */
+
+#define psyco_conn_host_get_doc \
+"host -- Get the host name."
+
+static PyObject *
+psyco_conn_host_get(connectionObject *self)
+{
+ const char *val = NULL;
+
+ EXC_IF_CONN_CLOSED(self);
+
+ val = PQhost(self->pgconn);
+ if (!val) {
+ Py_RETURN_NONE;
+ }
+ return conn_text_from_chars(self, val);
+}
+
/* reset the currect connection */
#define psyco_conn_reset_doc \
@@ -1243,6 +1262,9 @@ static struct PyGetSetDef connectionObject_getsets[] = {
(getter)psyco_conn_deferrable_get,
(setter)psyco_conn_deferrable_set,
psyco_conn_deferrable_doc },
+ { "host",
+ (getter)psyco_conn_host_get, NULL,
+ psyco_conn_host_get_doc },
{NULL}
};
#undef EXCEPTION_GETTER
diff --git a/tests/test_connection.py b/tests/test_connection.py
index 1342f9f..498f351 100755
--- a/tests/test_connection.py
+++ b/tests/test_connection.py
@@ -39,7 +39,7 @@ from .testutils import (
skip_after_postgres, skip_before_libpq, skip_after_libpq,
ConnectingTestCase, skip_if_tpc_disabled, skip_if_windows, slow)
-from .testconfig import dsn, dbname
+from .testconfig import dbhost, dsn, dbname
class ConnectionTests(ConnectingTestCase):
@@ -1682,6 +1682,19 @@ while True:
self.assert_(not err, err)
+class TestConnectionProps(ConnectingTestCase):
+ def test_host(self):
+ self.assertFalse(self.conn.closed)
+ expected = dbhost if dbhost else "/"
+ self.assertIn(expected, self.conn.host)
+
+ def test_host_readonly(self):
+ self.assertFalse(self.conn.closed)
+ with self.assertRaises(AttributeError):
+ self.conn.host = 'override'
+
+
+
def test_suite():
return unittest.TestLoader().loadTestsFromName(__name__)