From 47e775be2bf0da77be1b9cf4b7b2eb8ebad50054 Mon Sep 17 00:00:00 2001 From: jonathan vanasco Date: Thu, 2 Apr 2015 14:46:40 -0400 Subject: [PATCH] updates to scoping docs to make `.session_factory` appear public --- lib/sqlalchemy/orm/scoping.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/lib/sqlalchemy/orm/scoping.py b/lib/sqlalchemy/orm/scoping.py index b3f2fa5db4..9c6166af3b 100644 --- a/lib/sqlalchemy/orm/scoping.py +++ b/lib/sqlalchemy/orm/scoping.py @@ -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. -- 2.47.3