ModuleNotFoundError: No module named 'streamlit.script_run_context' (backward compatibility issue in 1.8.0)

[ahtokca]

Summary

After upgrading to 1.8.0 I got ModuleNotFoundError: No module named 'streamlit.script_run_context'
the module streamlit.script_run_context is renamed to streamlit.scriptrunner.
The change is not marked as 'breaking change', migration path is missing

Steps to reproduce

Code snippet:

from streamlit.script_run_context import get_script_run_ctx

Expected behavior:

Semantic versioning major part is used for breaking changes. Migration path provided.

Actual behavior:

breaking changes are not disclosed.

Is this a regression?

yes

Debug info

• Streamlit version: 1.8.0
• Python version: 3.9
• Using PipEnv

[nicornk]

We are using get_script_run_ctx to retrieve the http headers.

Could you please rollback this breaking change?

[AnOctopus]

script_run_context is internal, not part of our public api (we don't export it from the main streamlit module), so we don't consider this a breaking change for the purposes of semver.

[tconkling]

Hi @ahtokca and @nicornk - sorry for the trouble!

As AnOctopus notes, script_run_context is an internal implementation detail. We frequently refactor parts of Streamlit's internals to fix bugs, improve performance, and add new features; we're not able to maintain backwards compatibility for non-public APIs.

I know this can be frustrating! There are a couple of options here: the quickest fix is to pin Streamlit to an exact version. And the slower (but potentially more durable) option is to open an issue to discuss the functionality you need, so that we can consider adding it to the public API.

I'm going to close this issue, but feel free to continue the discussion and I'll offer more specific assistance if I can.

[nicornk]

@tconkling I totally understand your reasoning.
As a user I can just give you again the feedback that there is the need for a public streamlit API to access the http request headers from the current session. Is there any way you could consider that as a feature request?

[rebeccaatchristus]

We're using this module internally as well and support adding it to the public API.

[AEB26B]

We also use the request headers for user verification on our dashboards and would dearly love this implemented as a feature.

[ScatteredDev]

script_run_context is internal, not part of our public api (we don't export it from the main streamlit module), so we don't consider this a breaking change for the purposes of semver.

It would be great if private APIs used convention i.e. preceding underscore to mark as private if _script_run_context was used then we would have been able to use at our own risk knowing it was private and therefore a risk.

another +1 for a public interface to this

streamlit is great thanks for all the efforts