Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Calling flash after get_flashed_messages fails #5458

Closed
inducer opened this issue Apr 7, 2024 · 3 comments
Closed

Calling flash after get_flashed_messages fails #5458

inducer opened this issue Apr 7, 2024 · 3 comments

Comments

@inducer
Copy link

inducer commented Apr 7, 2024

In a single request, do this:

  • call get_flashed_messages()
  • call flash(...)
  • call get_flashed_messages() again, observe that it returns the empty list, despite a message just having been flashed.

After the first call to get_flashed_messages(), request_ctx.flashes is [], which appears to send this code in get_flashed_messages off the rails:

flask/src/flask/helpers.py

Lines 364 to 367 in 98a7f9f

flashes = request_ctx.flashes
if flashes is None:
flashes = session.pop("_flashes") if "_flashes" in session else []
request_ctx.flashes = flashes

Environment:

  • Python version: 3.11
  • Flask version: 3.0.2
@davidism
Copy link
Member

davidism commented Apr 7, 2024

What does "off the rails" mean? Did an error happen? Be sure to provide a minimal reproducible example and the full traceback when reporting an issue.

@inducer
Copy link
Author

inducer commented Apr 7, 2024

Sure, fair:

from flask import Flask, flash, get_flashed_messages

app = Flask(__name__)
app.secret_key = "abcdef"

@app.route("/")
def hello_world():
    get_flashed_messages()
    flash("hi")
    assert get_flashed_messages()

Run with

flask --app=flask_repro run 

go to http://127.0.0.1:5000/ and see

Traceback (most recent call last):
  File "/home/andreas/src/env-3.12/lib/python3.12/site-packages/flask/app.py", line 1455, in wsgi_app
    response = self.full_dispatch_request()
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/andreas/src/env-3.12/lib/python3.12/site-packages/flask/app.py", line 869, in full_dispatch_request
    rv = self.handle_user_exception(e)
         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/andreas/src/env-3.12/lib/python3.12/site-packages/flask/app.py", line 867, in full_dispatch_request
    rv = self.dispatch_request()
         ^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/andreas/src/env-3.12/lib/python3.12/site-packages/flask/app.py", line 852, in dispatch_request
    return self.ensure_sync(self.view_functions[rule.endpoint])(**view_args)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/andreas/tmp/flask_repro.py", line 10, in hello_world
    assert get_flashed_messages()
AssertionError

What does "off the rails" mean?

"Off the rails" means that flashes is not None there, and so the code does not look in the session (assuming that's what it's supposed to do).

@davidism davidism modified the milestone: 3.0.3 Apr 7, 2024
@davidism
Copy link
Member

davidism commented Apr 7, 2024

This is documented: https://flask.palletsprojects.com/en/3.0.x/api/#flask.get_flashed_messages

Further calls in the same request to the function will return the same messages.

The intended use is documented as well: https://flask.palletsprojects.com/en/3.0.x/patterns/flashing/

The flashing system basically makes it possible to record a message at the end of a request and access it next request and only next request.

You're intended to put messages into one request, then get them out in the next request. Getting them out, putting them in, and getting them out again in the same request is not the intended use case.

@davidism davidism closed this as not planned Won't fix, can't repro, duplicate, stale Apr 7, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants