diff options
author | Jason Kirtland <jek@discorporate.us> | 2007-08-01 06:27:31 +0000 |
---|---|---|
committer | Jason Kirtland <jek@discorporate.us> | 2007-08-01 06:27:31 +0000 |
commit | a52e5a772bfc93f5b04206705789b0ac53f2b18f (patch) | |
tree | eb6d3d725e7a4e604e55668b47708e810669811e /lib/sqlalchemy/interfaces.py | |
parent | b036af28711b1b4d2b463da55c9d1655297b66e4 (diff) | |
download | sqlalchemy-a52e5a772bfc93f5b04206705789b0ac53f2b18f.tar.gz |
Little docstring tweaks
Diffstat (limited to 'lib/sqlalchemy/interfaces.py')
-rw-r--r-- | lib/sqlalchemy/interfaces.py | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/lib/sqlalchemy/interfaces.py b/lib/sqlalchemy/interfaces.py index ad4d891ef..227e1b01a 100644 --- a/lib/sqlalchemy/interfaces.py +++ b/lib/sqlalchemy/interfaces.py @@ -12,11 +12,11 @@ class PoolListener(object): All of the standard connection [sqlalchemy.pool#Pool] types can accept event listeners for key connection lifecycle events: - creation, pool check-out and check-in. There are no events raised + creation, pool check-out and check-in. There are no events fired when a connection closes. For any given DB-API connection, there will be one ``connect`` - event, `n` number of ``checkout`` events, and `n` or `n -1` + event, `n` number of ``checkout`` events, and either `n` or `n - 1` ``checkin`` events. (If a ``Connection`` is detached from its pool via the ``detach()`` method, it won't be checked back in.) @@ -31,13 +31,14 @@ class PoolListener(object): connection pool. ``_ConnectionRecord`` objects have one public attribute of note: ``properties``, a dictionary whose contents are scoped to the lifetime of the DB-API connection managed by the - record. + record. You can use this shared storage area however you like. There is no need to subclass ``PoolListener`` to handle events. Any class that implements one or more of these methods can be used - as a pool listener. The ``Pool`` will inspect a listener and add - it to each internal event queue that it can handle. In terms of - efficiency and function call overhead, you're better off only + as a pool listener. The ``Pool`` will inspect the methods + provided by a listener object and add the listener to one or more + internal event queues based on its capabilities. In terms of + efficiency and function call overhead, you're much better off only providing implementations for the hooks you'll be using. """ |