core.browser_session
====================

.. py:module:: core.browser_session


Attributes
----------

.. autoapisummary::

   core.browser_session.OnDirtyCallback
   core.browser_session._T


Classes
-------

.. autoapisummary::

   core.browser_session.Prefixed
   core.browser_session.BrowserSession


Module Contents
---------------

.. py:data:: OnDirtyCallback

.. py:data:: _T

.. py:class:: Prefixed(prefix: str, cache: core.cache.RedisCacheRegion)

   .. py:attribute:: prefix


   .. py:attribute:: cache


   .. py:method:: mangle(key: str) -> str


   .. py:method:: get(key: str) -> Any


   .. py:method:: set(key: str, value: Any) -> None


   .. py:method:: delete(key: str) -> None


   .. py:method:: count() -> int


   .. py:method:: flush() -> int


.. py:class:: BrowserSession(cache: core.cache.RedisCacheRegion, token: str, on_dirty: OnDirtyCallback = lambda session, token: None)

   A session bound to a token (session_id cookie). Used to store data
   about a client on the server.

   Instances should be called ``browser_session`` to make sure we don't
   confuse this with the orm sessions.

   Used by :class:`onegov.core.request.CoreRequest`.

   Example::

       browser_session = request.browser_session
       browser_session.name = 'Foo'
       assert client.session.name == 'Foo'
       del client.session.name

   This class can act like an object, through attribute access, or like a
   dict, through square brackets. Whatever you prefer.



   .. py:attribute:: _cache


   .. py:attribute:: _token


   .. py:attribute:: _is_dirty
      :value: False



   .. py:attribute:: _on_dirty


   .. py:method:: has(name: str) -> bool


   .. py:method:: flush() -> None


   .. py:method:: count() -> int


   .. py:method:: pop(name: str, default: Any = None) -> Any

      Returns the value for the given name, removing the value in
      the process.




   .. py:method:: mark_as_dirty() -> None


   .. py:method:: get(name: str) -> Any | None
                  get(name: str, default: _T) -> Any | _T


   .. py:method:: __getitem__(name: str, *args: Never) -> Any


   .. py:method:: __getattr__(name: str) -> Any


   .. py:method:: __setattr__(name: str, value: Any) -> None


   .. py:method:: __delattr__(name: str) -> None


   .. py:attribute:: __setitem__


   .. py:attribute:: __delitem__


   .. py:attribute:: __contains__