U
    ccY                  !   @   s  d dl mZ d dl mZ d dlmZ ddl mZ ddlmZ ddlm	Z	 ddlm
Z
 ddlmZ dd	lmZ d
dgZG dd deZeedddddgddddddddddddddd d!d"d#d$d%d&d'd(d)d*d+d,d-gd.d/d0d1d2d3d4d5d6d7g
d8G d9d
 d
eZeZd:S );   )class_mapper)exc)Session   )create_proxy_methods)ScopedRegistry)ThreadLocalRegistry)warn)warn_deprecatedscoped_sessionScopedSessionMixinc                   @   s(   e Zd Zedd Zdd Zdd ZdS )r   c                 C   s   |   S )N)registryself r   :/tmp/pip-unpacked-wheel-8u86ls_i/sqlalchemy/orm/scoping.py_proxied   s    zScopedSessionMixin._proxiedc                 K   sV   |r4| j  rtdq<| jf |}| j | n|   }| jsR|jrRtdd |S )a  Return the current :class:`.Session`, creating it
        using the :attr:`.scoped_session.session_factory` if not present.

        :param \**kw: Keyword arguments will be passed to the
         :attr:`.scoped_session.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.

        zEScoped session is already present; no new arguments may be specified.zUsing `scoped_session` with asyncio is deprecated and will raise an error in a future version. Please use `async_scoped_session` instead.z1.4.23)	r   hassa_excZInvalidRequestErrorsession_factoryset_support_asyncZ_is_asyncior
   )r   kwsessr   r   r   __call__   s    
zScopedSessionMixin.__call__c                 K   s$   | j  rtd | jjf | dS )zreconfigure the :class:`.sessionmaker` used by this
        :class:`.scoped_session`.

        See :meth:`.sessionmaker.configure`.

        ztAt least one scoped session is already present.  configure() can not affect sessions that have already been created.N)r   r   r	   r   	configure)r   kwargsr   r   r   r   9   s
    
zScopedSessionMixin.configureN)__name__
__module____qualname__propertyr   r   r   r   r   r   r   r      s   
z:class:`_orm.Session`z$:class:`_orm.scoping.scoped_session`Z	close_allZobject_sessionZidentity_key__contains____iter__addZadd_allbeginZbegin_nestedclosecommit
connectiondeleteexecuteZexpireZ
expire_allZexpungeZexpunge_allflushgetZget_bindZis_modifiedZbulk_save_objectsZbulk_insert_mappingsZbulk_update_mappingsmergequeryZrefreshrollbackZscalarZscalarsbindZdirtyZdeletednewZidentity_mapZ	is_activeZ	autoflushZno_autoflushinfoZ
autocommit)Zclassmethodsmethods
attributesc                   @   s4   e Zd ZdZdZdZd
ddZdd Zddd	ZdS )r   a4  Provides scoped management of :class:`.Session` objects.

    See :ref:`unitofwork_contextual` for a tutorial.

    .. note::

       When using :ref:`asyncio_toplevel`, the async-compatible
       :class:`_asyncio.async_scoped_session` class should be
       used in place of :class:`.scoped_session`.

    FNc                 C   s&   || _ |rt||| _n
t|| _dS )a  Construct a new :class:`.scoped_session`.

        :param session_factory: a factory to create new :class:`.Session`
         instances. This is usually, but not necessarily, an instance
         of :class:`.sessionmaker`.
        :param scopefunc: optional function which defines
         the current scope.   If not passed, the :class:`.scoped_session`
         object assumes "thread-local" scope, and will use
         a Python ``threading.local()`` in order to maintain the current
         :class:`.Session`.  If passed, the function should return
         a hashable token; this token will be used as the key in a
         dictionary in order to store and retrieve the current
         :class:`.Session`.

        N)r   r   r   r   )r   r   Z	scopefuncr   r   r   __init__   s    zscoped_session.__init__c                 C   s$   | j  r|     | j   dS )a  Dispose of the current :class:`.Session`, if present.

        This will first call :meth:`.Session.close` method
        on the current :class:`.Session`, which releases any existing
        transactional/connection resources still being held; transactions
        specifically are rolled back.  The :class:`.Session` is then
        discarded.   Upon next usage within the same scope,
        the :class:`.scoped_session` will produce a new
        :class:`.Session` object.

        N)r   r   r%   clearr   r   r   r   remove   s    
zscoped_session.removec                    s   G  fdddt }| S )a0  return a class property which produces a :class:`_query.Query`
        object
        against the class and the current :class:`.Session` when called.

        e.g.::

            Session = scoped_session(sessionmaker())

            class MyClass(object):
                query = Session.query_property()

            # after mappers are defined
            result = MyClass.query.filter(MyClass.name=='foo').all()

        Produces instances of the session's configured query class by
        default.  To override and use a custom implementation, provide
        a ``query_cls`` callable.  The callable will be invoked with
        the class's mapper as a positional argument and a session
        keyword argument.

        There is no limit to the number of query properties placed on
        a class.

        c                       s   e Zd Z fddZdS )z,scoped_session.query_property.<locals>.queryc                    sT   z6t |}|r4 r$ | dW S  |W S W n tjk
rN   Y d S X d S )N)session)r   r   r-   orm_excZUnmappedClassError)sinstanceownerZmapper	query_clsr   r   r   __get__   s    z4scoped_session.query_property.<locals>.query.__get__N)r   r   r   r>   r   r<   r   r   r-      s   r-   )object)r   r=   r-   r   r<   r   query_property   s    zscoped_session.query_property)N)N)	r   r   r   __doc__r   r   r4   r6   r@   r   r   r   r   r   K   s   1
N) r   r   r8   r7   r   r   utilr   r   r   r	   r
   __all__r?   r   r   ZScopedSessionr   r   r   r   <module>   sv   60h