aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristopher Allan Webber <cwebber@dustycloud.org>2014-11-30 14:04:09 -0600
committerChristopher Allan Webber <cwebber@dustycloud.org>2014-12-03 15:40:57 -0600
commite248e1429a832c7b38094fe08155f163ffc6b9b2 (patch)
tree7f2a5f18d2637a9ce44e020cba8ce83f5654b9a7
parent63f6a418d1333e15522ec00be13d1525b68f36f5 (diff)
downloadmediagoblin-e248e1429a832c7b38094fe08155f163ffc6b9b2.tar.lz
mediagoblin-e248e1429a832c7b38094fe08155f163ffc6b9b2.tar.xz
mediagoblin-e248e1429a832c7b38094fe08155f163ffc6b9b2.zip
Some docstrings
-rw-r--r--mediagoblin/db/open.py13
1 files changed, 13 insertions, 0 deletions
diff --git a/mediagoblin/db/open.py b/mediagoblin/db/open.py
index 9922cc10..81cd019c 100644
--- a/mediagoblin/db/open.py
+++ b/mediagoblin/db/open.py
@@ -59,12 +59,25 @@ else:
from sqlalchemy.orm import sessionmaker
class DatabaseManager(object):
+ """
+ Manage database connections.
+
+ The main method here is session_scope which can be used with a
+ "with" statement to get a session that is properly torn down
+ by the end of execution.
+ """
def __init__(self, engine):
self.engine = engine
self.Session = sessionmaker(bind=engine)
@contextmanager
def session_scope(self):
+ """
+ This is a context manager, use like::
+
+ with dbmanager.session_scope() as request.db:
+ some_view(request)
+ """
session = self.Session()
#####################################