I tried to tweak streamlit for a while, but debugging is definitely a challenge.
I learned that if the code sophistication is at a level that I might need to debug it, then it is better to consider Dash(https://dash.plotly.com/). The coding is a little more involved, but it totally worth effort since Dash provides a significantly more power and control over the code.
Iâm not a Windows user, so take this with a grain of saltâŠ
It would appear that PyCharm on Windows doesnât like the method on the forum you link toâŠas far as I can tell, you canât actually link to the Streamlit .exe file from the Script path: menu. It wants you to link to a Python script.
Instead, under interpreter options:, if you -m streamlit run, that will effectively expand to python -m streamlit run file.py, and this works for me under the RUN dialog.
But for debug, that configuration doesnât work for me. It appears that PyCharm dumps a bunch of arguments onto the command line, which are intended for the python executable, but because we put -m streamlit run in the interpreter options section, it gets messed up.
If I can figure out how to disable all of the additional options such as --multiprocessing that PyCharm dumps onto the command line, then it might work. Until then, not sure what to suggest here.
It turns out that the StackOverflow post that is linked does actually provide the answer, albeit indirectly.
If you take my suggestion above and make it -m streamlit run --, on my Windows PyCharm is has now started with Connected to pydev debugger (build 221.5080.212)
So give that a shot and see if it does what you want. Separately, Iâm going to play with this when I have some free time to understand it better, and once Iâm convinced weâve got a legitimate solution weâll add it to the docs.
Relevent link: (after line 'EDIT: adding @sismo âs commentâ):
Iâve tried the Stackoverflow post before I post my question here. Debugging Streamlit in overall is a challenge, but it is even more challenging in Windows platform.
To my understanding Stremlit debugging challenge is due to a fundamental engineering design decision. To elaborate, consider how we run a Dash application:
# this is how we run a dash dashboard application
app.run_server(debug=True)
That mans we can invoke a Dash dashboard within the running Python process and it flows well in any IDE or debugging environment.
However, Streamlit runs dashboards quite differently. We pass a Steamlit layout python file to Streamlit using a python -m . Among so many great things I can tell about Steamlit, I am confused why it doesnât provide a way to invoke dashboards in a python script like Dash does.
PyTest addresses this matter elegantly. We have many options to invoke Pytest (long topic ) . For debugging PyTest offers this option: How to invoke pytest â pytest documentation
I wish Streamlit provided the option to invoke a dashboard from code and follow the invoking from script pattern that PyTest provides so we can easily debug. I tried, but couldnât find it.
Unfortunately, I get the following when I change Interpreter Options to -m streamlit run --
Connected to pydev debugger (build 222.4345.23)
Usage:
pydevd.py --port N [(--client hostname) | --server] --file executable [file_options]
Traceback (most recent call last):
File "/home/user/.local/share/JetBrains/Toolbox/apps/PyCharm-P/ch-0/222.4345.23/plugins/python/helpers/pydev/pydevd.py", line 2016, in main
setup = process_command_line(sys.argv)
File "/home/user/.local/share/JetBrains/Toolbox/apps/PyCharm-P/ch-0/222.4345.23/plugins/python/helpers/pydev/_pydevd_bundle/pydevd_command_line_handling.py", line 146, in process_command_line
raise ValueError("Unexpected option: " + argv[i])
Traceback (most recent call last):
ValueError: Unexpected option: --model-test-filepath
File "/home/user/.local/share/JetBrains/Toolbox/apps/PyCharm-P/ch-0/222.4345.23/plugins/python/helpers/pydev/pydevd.py", line 2016, in main
setup = process_command_line(sys.argv)
File "/home/user/.local/share/JetBrains/Toolbox/apps/PyCharm-P/ch-0/222.4345.23/plugins/python/helpers/pydev/_pydevd_bundle/pydevd_command_line_handling.py", line 146, in process_command_line
raise ValueError("Unexpected option: " + argv[i])
ValueError: Unexpected option: --
Usage:
pydevd.py --port N [(--client hostname) | --server] --file executable [file_options]
Usage: python -m --model-test-filepath [OPTIONS]
Try 'python -m --model-test-filepath --help' for help.
I think tried the solution in StackOverflow, but it seems I do not have a streamlit.cli file.
I am very surprised there is no established method of debugging Streamlit applications. How are people getting complex applications done? I suppose you would complete all of the core application as much as possible then insert Streamlit capability, maybe?
Thanks for stopping by! We use cookies to help us understand how you interact with our website.
By clicking âAccept allâ, you consent to our use of cookies. For more information, please see our privacy policy.
Cookie settings
Strictly necessary cookies
These cookies are necessary for the website to function and cannot be switched off. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms.
Performance cookies
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us understand how visitors move around the site and which pages are most frequently visited.
Functional cookies
These cookies are used to record your choices and settings, maintain your preferences over time and recognize you when you return to our website. These cookies help us to personalize our content for you and remember your preferences.
Targeting cookies
These cookies may be deployed to our site by our advertising partners to build a profile of your interest and provide you with content that is relevant to you, including showing you relevant ads on other websites.
