session() — flask Function Reference

Architecture documentation for the session() function in ctx.py from the flask codebase.

Function python ApplicationCore Scaffolding calls 2

Entity Profile

ApplicationCore→ Scaffolding→ session() — flask Function Reference

Dependency Diagram

graph TD
  91a99133_b1f0_35e9_438c_7ae6016b40a9["session()"]
  86817dcd_97b5_9a9f_aee8_5fa78b4cecc9["AppContext"]
  91a99133_b1f0_35e9_438c_7ae6016b40a9 -->|defined in| 86817dcd_97b5_9a9f_aee8_5fa78b4cecc9
  a3a36a1e_dcc4_1f61_b5f5_bce1cf9ca5df["make_null_session()"]
  91a99133_b1f0_35e9_438c_7ae6016b40a9 -->|calls| a3a36a1e_dcc4_1f61_b5f5_bce1cf9ca5df
  d601925b_3494_f541_847b_645b340fc0a1["open_session()"]
  91a99133_b1f0_35e9_438c_7ae6016b40a9 -->|calls| d601925b_3494_f541_847b_645b340fc0a1
  style 91a99133_b1f0_35e9_438c_7ae6016b40a9 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/flask/ctx.py lines 381–396

    def session(self) -> SessionMixin:
        """The session object associated with this context. Accessed through
        :data:`.session`. Only available in request contexts, otherwise raises
        :exc:`RuntimeError`.
        """
        if self._request is None:
            raise RuntimeError("There is no request in this context.")

        if self._session is None:
            si = self.app.session_interface
            self._session = si.open_session(self.app, self.request)

            if self._session is None:
                self._session = si.make_null_session(self.app)

        return self._session