Run Flask CLI command with PyCharm debugger

by

PyCharm’s “Flask server” configuration only calls the flask run command, it doesn’t provide a way to call other commands. To do that, create a regular “Python” configuration that runs the flask command with the arguments you want.

  • Create a “Python” configuration and give it a name.
  • Select “Module name” instead of “Script path” and type flask.
  • Fill out “Parameters” with the arguments to pass. As of Flask 2.2, you can use the --app and --debug options. For example --app my_app my_command --option A.
    • Prior to Flask 2.2, edit the environment variables to include FLASK_APP=my_app and FLASK_ENV=development.
    • You may also need to configure “Working directory” to point at your project directory, if your command depends on where it’s being run from.

Running this configuration with the debugger will stop at breakpoints in your CLI command instead of running the server.

More Related Contents:

  1. Get the data received in a Flask request
  2. tkinter: how to use after method
  3. How to execute raw SQL in Flask-SQLAlchemy app
  4. Run / Debug a Django application’s UnitTests from the mouse right click context menu in PyCharm Community Edition?
  5. Why do some built-in Python functions only have pass?
  6. How do I get Flask to run on port 80?
  7. Get raw POST body in Python Flask regardless of Content-Type header
  8. Form sending error, Flask
  9. Pycharm: set environment variable for run manage.py Task
  10. Is there an easy way to make sessions timeout in flask?
  11. Where should I place the secret key in Flask?
  12. Process finished with exit code 137 in PyCharm
  13. Flask and uWSGI – unable to load app 0 (mountpoint=”) (callable not found or import error)
  14. RuntimeError: working outside of application context
  15. Code completion not giving recommendations
  16. Get list of all routes defined in the Flask app
  17. Flask App: Update progress bar while function runs
  18. Get inserted key before commit session
  19. Where do I define the domain to be used by url_for() in Flask?
  20. How to run Flask with Gunicorn in multithreaded mode
  21. Flask: Get the size of request.files object
  22. Flask isn’t getting the checkbox value
  23. Flask-SQLAlchemy Constructor
  24. PyCharm hangs on ‘scanning files to index’ background task
  25. How to type hint a dictionary with values of different types
  26. What is the type hint for a (any) python module?
  27. Pycharm: run only part of my Python file
  28. SQLAlchemy ordering by count on a many to many relationship
  29. How do I run a long-running job in the background in Python
  30. ModuleNotFoundError: No module named ‘MySQLdb’

Leave a Comment