should_set_cookie() — flask Function Reference

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

Function python ApplicationCore Scaffolding called by 1

Entity Profile

ApplicationCore→ Scaffolding→ should_set_cookie() — flask Function Reference

Dependency Diagram

graph TD
  2cf7467e_84a3_e5f7_ca7c_32bde50158e9["should_set_cookie()"]
  bbf56873_bd71_6e70_f44c_ca8a85b0a007["SessionInterface"]
  2cf7467e_84a3_e5f7_ca7c_32bde50158e9 -->|defined in| bbf56873_bd71_6e70_f44c_ca8a85b0a007
  58643c3f_4184_c18b_8361_a7d628d93359["save_session()"]
  58643c3f_4184_c18b_8361_a7d628d93359 -->|calls| 2cf7467e_84a3_e5f7_ca7c_32bde50158e9
  style 2cf7467e_84a3_e5f7_ca7c_32bde50158e9 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/flask/sessions.py lines 247–261

    def should_set_cookie(self, app: Flask, session: SessionMixin) -> bool:
        """Used by session backends to determine if a ``Set-Cookie`` header
        should be set for this session cookie for this response. If the session
        has been modified, the cookie is set. If the session is permanent and
        the ``SESSION_REFRESH_EACH_REQUEST`` config is true, the cookie is
        always set.

        This check is usually skipped if the session was deleted.

        .. versionadded:: 0.11
        """

        return session.modified or (
            session.permanent and app.config["SESSION_REFRESH_EACH_REQUEST"]
        )