open_session() — flask Function Reference

Architecture documentation for the open_session() function in sessions.py from the flask codebase.

Function python ApplicationCore Scaffolding calls 1 called by 2

Entity Profile

ApplicationCore→ Scaffolding→ open_session() — flask Function Reference

Dependency Diagram

graph TD
  f07e3f84_ffc5_9004_1d81_703a5234af84["open_session()"]
  bbf56873_bd71_6e70_f44c_ca8a85b0a007["SessionInterface"]
  f07e3f84_ffc5_9004_1d81_703a5234af84 -->|defined in| bbf56873_bd71_6e70_f44c_ca8a85b0a007
  d601925b_3494_f541_847b_645b340fc0a1["open_session()"]
  d601925b_3494_f541_847b_645b340fc0a1 -->|calls| f07e3f84_ffc5_9004_1d81_703a5234af84
  eb7c3517_582e_6dd2_c80b_a8be784317c7["session_transaction()"]
  eb7c3517_582e_6dd2_c80b_a8be784317c7 -->|calls| f07e3f84_ffc5_9004_1d81_703a5234af84
  d601925b_3494_f541_847b_645b340fc0a1["open_session()"]
  f07e3f84_ffc5_9004_1d81_703a5234af84 -->|calls| d601925b_3494_f541_847b_645b340fc0a1
  style f07e3f84_ffc5_9004_1d81_703a5234af84 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/flask/sessions.py lines 263–275

    def open_session(self, app: Flask, request: Request) -> SessionMixin | None:
        """This is called at the beginning of each request, after
        pushing the request context, before matching the URL.

        This must return an object which implements a dictionary-like
        interface as well as the :class:`SessionMixin` interface.

        This will return ``None`` to indicate that loading failed in
        some way that is not immediately an error. The request
        context will fall back to using :meth:`make_null_session`
        in this case.
        """
        raise NotImplementedError()