summaryrefslogtreecommitdiffstats
path: root/ipalib/backend.py
diff options
context:
space:
mode:
authorJason Gerard DeRose <jderose@redhat.com>2009-01-24 22:44:58 -0700
committerRob Crittenden <rcritten@redhat.com>2009-02-03 15:29:03 -0500
commit9efda29d60ae83d17bce793e0a23e3ec43c67f80 (patch)
treea032442e6d39ea37ca5d9380e3a9e3536b152a91 /ipalib/backend.py
parent66b6029e4058e1d29f35e4170423d127c2ebb2c4 (diff)
downloadfreeipa-9efda29d60ae83d17bce793e0a23e3ec43c67f80.tar.gz
freeipa-9efda29d60ae83d17bce793e0a23e3ec43c67f80.tar.xz
freeipa-9efda29d60ae83d17bce793e0a23e3ec43c67f80.zip
Added docstring to Connectible class
Diffstat (limited to 'ipalib/backend.py')
-rw-r--r--ipalib/backend.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/ipalib/backend.py b/ipalib/backend.py
index bb8d3101..f2741abe 100644
--- a/ipalib/backend.py
+++ b/ipalib/backend.py
@@ -36,6 +36,14 @@ class Backend(plugable.Plugin):
class Connectible(Backend):
+ """
+ Base class for backend plugins that create connections.
+
+ In addition to the nicety of providing a standard connection API, all
+ backend plugins that create connections should use this base class so that
+ `request.destroy_context()` can properly close all open connections.
+ """
+
def connect(self, *args, **kw):
"""
Create thread-local connection.