summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine/threadlocal.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2007-12-18 23:53:40 +0000
committerMike Bayer <mike_mp@zzzcomputing.com>2007-12-18 23:53:40 +0000
commitba0267a955d40efb09de06ce226fbab63994aa78 (patch)
treeb2a24709e6b3c474949e0ee50b2755c24cc49e56 /lib/sqlalchemy/engine/threadlocal.py
parent1dc4546aa95d3adfff910430afe922bf137bf595 (diff)
downloadsqlalchemy-ba0267a955d40efb09de06ce226fbab63994aa78.tar.gz
introductory docstring bonanza
Diffstat (limited to 'lib/sqlalchemy/engine/threadlocal.py')
-rw-r--r--lib/sqlalchemy/engine/threadlocal.py11
1 files changed, 6 insertions, 5 deletions
diff --git a/lib/sqlalchemy/engine/threadlocal.py b/lib/sqlalchemy/engine/threadlocal.py
index 6122b61b2..d07d8da83 100644
--- a/lib/sqlalchemy/engine/threadlocal.py
+++ b/lib/sqlalchemy/engine/threadlocal.py
@@ -1,12 +1,13 @@
-from sqlalchemy import util
-from sqlalchemy.engine import base
-
"""Provides a thread-local transactional wrapper around the root Engine class.
-Provides begin/commit methods on the engine itself which correspond to
-a thread-local transaction.
+The ``threadlocal`` module is invoked when using the ``strategy="threadlocal"`` flag
+with [sqlalchemy.engine#create_engine()]. This module is semi-private and is
+invoked automatically when the threadlocal engine strategy is used.
"""
+from sqlalchemy import util
+from sqlalchemy.engine import base
+
class TLSession(object):
def __init__(self, engine):
self.engine = engine