How to run flask shell in PyCharm?

Question

I created new flask project in PyCharm but I can't see how to run flask shell in integrated PyCharm python console window.

Name app is not defined when start console:

I still can run command "flask shell" in integrated PyCharm terminal but it will start without code completion, hints, syntax checks, etc.

Flask app is defined in terminal:

Is there any way to start flask shell in integrated PyCharm python console?

Answer 1

You can use a combination of creating a request context for the Shell (which flask shell does) and a custom starting script for the PyCharm console.

# Step 1: acquire a reference to your Flask App instance
import app
app_instance = app.create_app()
# I return app instance from a factory method here, but might be be `app.app` for basic Flask projects

# Step 2: push test request context so that you can do stuff that needs App, like SQLAlchemy
ctx = app_instance.test_request_context()
ctx.push()

Now you should have the benefits of flask shell alongside the code completion and other benefits that IPython Shell provides, all from the default PyCharm Python Shell.

Answer 2

In my case (in my server.py I had app=Flask(__name__)) I used

from server import app
ctx = app.app_context()
ctx.push()

Then added this to File | Settings | Build, Execution, Deployment | Console | Python Console starting script

Answer 3

This also works:

from app import app
ctx = app.test_request_context()
ctx.push()

more on the Flask docs page