]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
updates to scoping docs to make `.session_factory` appear public
authorjonathan vanasco <jonathan@2xlp.com>
Thu, 2 Apr 2015 18:46:40 +0000 (14:46 -0400)
committerjonathan vanasco <jonathan@2xlp.com>
Thu, 2 Apr 2015 18:46:40 +0000 (14:46 -0400)
lib/sqlalchemy/orm/scoping.py

index b3f2fa5db4986ebc72fa45442518bf4b4b65dd19..9c6166af3b4bc0cc375e188d93cdae5b9f6fa7c6 100644 (file)
@@ -38,6 +38,11 @@ class scoped_session(object):
 
         """
         self.session_factory = session_factory
+        """The `session_factory` provided to `__init__` is stored in this
+        attribute and may be accessed at a later time.  This can be useful when
+        a new non-scoped :class:`.Session` or :class:`.Connection` to the
+        database is needed."""
+
         if scopefunc:
             self.registry = ScopedRegistry(session_factory, scopefunc)
         else:
@@ -45,10 +50,10 @@ class scoped_session(object):
 
     def __call__(self, **kw):
         """Return the current :class:`.Session`, creating it
-        using the session factory if not present.
+        using the :class:`.session_factory` if not present.
 
         :param \**kw: Keyword arguments will be passed to the
-         session factory callable, if an existing :class:`.Session`
+         :class:`.session_factory` callable, if an existing :class:`.Session`
          is not present.  If the :class:`.Session` is present and
          keyword arguments have been passed,
          :exc:`~sqlalchemy.exc.InvalidRequestError` is raised.