Add support for Altair 5 #6618

lukasmasuch · 2023-05-03T01:53:28Z

📚 Context

Altair 5 was released in a couple of days ago. This PR makes Streamlit compatible with the 5.x version. More specifically, we previously explicitly used the altair.vegalite.v4.api.Chart module (part of the internal API), but this no longer exists in Altair 5. Instead, it is advised to directly use altair.Chart (see conversation in #6215), which is the official public API that will stay stable.

In addition, this PR also updates our frontend vega dependencies to the latest versions and moves the altair import to lazy loading for performance improvement. This also removes the registered streamlit altair theme, which was only an unofficial workaround for the initial implementation of the Streamlit chart theme.

Since we were anyways already running Vega lite v5 in our frontend for the last few months, I don't expect this update to introduce any incompatibilities. V4 and v5 should be "mostly" compatible anyways. The backend changes are also completely independent of the Altair version since the public API relevant to Streamlit (e.g. altair.Chart) was stable across the versions.

What kind of change does this PR introduce?
- Bugfix
- Feature
- Refactoring
- Other, please describe: Dependency upgrade

🧪 Testing Done

Screenshots included
Added/Updated unit tests
Added/Updated e2e tests

🌐 References

Does this depend on other work, documents, or tickets?

Issue: Closes Support Altair 5 #6215

Contribution License Agreement

By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.

lib/setup.py

lib/tests/streamlit/runtime/legacy_caching/hashing_test.py

lib/streamlit/type_util.py

binste · 2023-05-09T15:09:19Z

@lukasmasuch Just fyi, Altair 5 got released today 🥳

Co-authored-by: Stefan Binder <binder_stefan@outlook.com>

…upport

…it/streamlit into feature/altair-5-support

…upport

kmcgrady · 2023-05-15T23:35:15Z

lib/setup.py

 # - Include relevant lower bound for any features we use from our dependencies
 # - And include an upper bound that's < NEXT_MAJOR_VERSION
 INSTALL_REQUIRES = [
-    "altair>=3.2.0, <5",


Is this breaking for Altair 3? We had conversations about 4 to 5, but want to verify the problem with 3.

Ah Lukas pointed this out, but we already used v4 as well, so we were probably already breaking.

The 3.x version does not even contain the altair.vegalite.v4.api.Chart import we were using, so I'm pretty sure that we haven't been supporting this version anyways for a while 😅

lukasmasuch · 2023-05-15T23:44:03Z

lib/tests/streamlit/elements/arrow_altair_test.py

        )
        self.assertEqual(spec_dict["data"], {"name": proto.datasets[0].name})
-        self.assertEqual(spec_dict["mark"], "bar")
+        self.assertIn(spec_dict["mark"], ["bar", {"type": "bar"}])


We check both here bar and {"type": "bar"} to allow our tests to run with v4 and v5 versions.

tconkling

Looks good to me - my only concern is how sure we are that we're still compatible with Altair 4 ... and beyond that, how do we ensure that we remain compatible with Altair 4.

Maybe we just cross our fingers now, and it gets worked out with @AnOctopus's "test min versions of dependencies in CI" project?
Alternately: do we want to require altair >=5, <6 for now, and drop Altair 4 support?

tconkling · 2023-05-18T23:01:21Z

e2e/scripts/st_arrow_altair_global_theme.py

@@ -1,29 +0,0 @@
-# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022)


Why don't we want this test anymore?

This was just a temporary feature - before we had the theme parameter - that got removed in this PR as a side-effect. It was possible to set the theme via:

alt.themes.enable("streamlit")

But we never advertised it and this has some technical issue related to it, so we introduced the theme parameter with our charting commands instead. So this is just removing some unused tech debt.

tconkling · 2023-05-18T23:03:35Z

lib/streamlit/elements/arrow_altair.py

    def _arrow_altair_chart(
        self,
-        altair_chart: Chart,
+        altair_chart: "Chart",


Nit: I think you can avoid the quotes for this type annotation if you add a from __future__ import annotations at the top of the file (even though the import is conditional on the TYPE_CHECKING flag)

Oh, I didn't know. I will update this later :)

tconkling · 2023-05-18T23:05:31Z

lib/streamlit/elements/dataframe_selector.py


 if TYPE_CHECKING:
-    from altair.vegalite.v4.api import Chart
+    from altair import Chart


Does this "from altair import Chart" import work for Altair 4?

Yep, from altair import Chart is the actual public API that always existed this way :)

lukasmasuch · 2023-05-19T00:12:25Z

my only concern is how sure we are that we're still compatible with Altair 4

From a Python side, this PR will make Streamli neutral to the underlying vega-lite version since we just use the actual public Altair API: from altair import Chart

However, the frontend part is more relevant regarding the compatibility of the vega-lite specs. We have been running vega-lite spec v5 anyways already in the frontend for a few months (probably accidentally), even though the supported Altair version has been producing v4 spec. Since it didn't cause any issues in the last few months, I don't expect that this change will introduce any additional issues.

lukasmasuch · 2023-05-19T00:15:56Z

@tconkling

Alternately: do we want to require altair >=5, <6 for now, and drop Altair 4 support?

I assume this would probably be a too harsh pin here since Altair 5 just got released

Maybe we just cross our fingers now, and it gets worked out with @AnOctopus's "test min versions of dependencies in CI" project?

I think I will merge this PR after the 1.23 release, so we will have another 4 weeks to maybe get something in for the min version testing. Maybe an MVP with just altair and pandas min versions.

…upport

binste · 2023-05-19T05:33:33Z

From a Python side, this PR will make Streamli neutral to the underlying vega-lite version since we just use the actual public Altair API: from altair import Chart

However, the frontend part is more relevant regarding the compatibility of the vega-lite specs. We have been running vega-lite spec v5 anyways already in the frontend for a few months (probably accidentally), even though the supported Altair version has been producing v4 spec. Since it didn't cause any issues in the last few months, I don't expect that this change will introduce any additional issues.

I fully agree with this, the frontend has already been updated anyway, and I again went through the changes and can't spot anything that would no longer work with Altair 4. Apart from the changes in imports to the altair.Chart API which has always been there, the only change in logic I can find is https://github.com/streamlit/streamlit/pull/6618/files#diff-3b83cc7a5d368917b0a9872a1d9476a9f9bf205a5ad7b388407e451e8d87b5baR604. That statement also works in Altair 4.

I think many users are looking forward to this and so it would be great if it can already be included in the 1.23 release but I also understand if you first want to improve the testing strategy! Thank you in any case, looking forward to it.

lib/streamlit/elements/arrow_altair.py

…upport

lukasmasuch · 2023-05-23T19:38:06Z

@binste Thanks for all the help and input on the Altair 5 update! 👍

binste · 2023-05-24T04:57:05Z

Sure, thank you for doing it and always happy to chat about the Altair integration in Streamlit! :)

* develop: (22 commits) enzyme -> react-testing-library (Countdown, Modal, ProgressBar) (streamlit#6744) Remove console.log (streamlit#6753) Update `st.data_editor` and `st.dataframe` docstrings (streamlit#6752) Update `st.data_editor` session state format (streamlit#6711) Cypress flaky test fixes (streamlit#6743) Document integer size limit for number_input and slider (streamlit#6724) Change default theme hash on app init (streamlit#6729) Use .genericFonts instead of .fonts to fix bug with theme postMessage. (streamlit#6732) Improve startup performance by lazy loading some dependencies (streamlit#6531) Add support for Altair 5 (streamlit#6618) Update modals (streamlit#6688) Improve docstrings for `ttl` and `max_entries` (streamlit#6733) Improve `st.columns` docstring (streamlit#6727) Removed orphan line in dataframe docstring (streamlit#6734) Fix useIsOverflowing dependency array (streamlit#6731) Remove experimental from data editor (streamlit#6712) Clarify set_page_config docstring and exception message (streamlit#6594) Add a config option to disable warning for setting both a widget default and its key in session_state (streamlit#6640) Add column configuration API for `st.dataframe` and `st.data_editor` (streamlit#6598) Migrate datetime column formatting from date-fns to momentJS (streamlit#6702) ...

lukasmasuch added 3 commits May 3, 2023 03:51

Update vega-lite frontend dependency

4994c65

Pin altair version

85d5950

Remove usage of vega-lite v4

da526f3

lukasmasuch commented May 3, 2023

View reviewed changes

lib/setup.py Outdated Show resolved Hide resolved

lukasmasuch mentioned this pull request May 3, 2023

Support Altair 5 #6215

Closed

5 tasks

lukasmasuch changed the title ~~Add support for Altair 5~~ [WIP] Add support for Altair 5 May 3, 2023

lukasmasuch added 3 commits May 3, 2023 17:49

Fix tests

c7f54f1

Use alt.Chart instead

f3a1a5a

Fix unit tests

56d5745

lukasmasuch added the security-assessment-completed Security assessment has been completed for PR label May 3, 2023

lukasmasuch added 5 commits May 4, 2023 00:01

Update dependency to support

e7aa001

Update notices file

a5f981e

Pin lower version to 4.0

368dd5b

Remove outdated snapshots

7120194

Update snapshots

cf01fed

binste reviewed May 5, 2023

View reviewed changes

lib/tests/streamlit/runtime/legacy_caching/hashing_test.py Outdated Show resolved Hide resolved

binste reviewed May 5, 2023

View reviewed changes

lib/tests/streamlit/runtime/legacy_caching/hashing_test.py Outdated Show resolved Hide resolved

binste reviewed May 5, 2023

View reviewed changes

lib/streamlit/type_util.py Outdated Show resolved Hide resolved

lukasmasuch and others added 5 commits May 15, 2023 20:59

Apply suggestions from code review

95f7ea2

Co-authored-by: Stefan Binder <binder_stefan@outlook.com>

Merge remote-tracking branch 'remote/develop' into feature/altair-5-s…

f8ca10e

…upport

Merge branch 'feature/altair-5-support' of https://github.com/streaml…

fbdf9d5

…it/streamlit into feature/altair-5-support

Move altair to lazy loading

6b75a26

Update frontend dependencies

1e8b1ad

lukasmasuch changed the title ~~[WIP] Add support for Altair 5~~ Add support for Altair 5 May 15, 2023

lukasmasuch marked this pull request as ready for review May 15, 2023 20:08

lukasmasuch requested review from AnOctopus, kmcgrady, tconkling and vdonato as code owners May 15, 2023 20:08

lukasmasuch added 6 commits May 15, 2023 22:12

Update lockfile

3518853

Remove unneeded check

df451a3

Remove not needed snapshots

3c6e0ce

Activate none theme when default theme is activated

8d74d73

Add comment

64036df

Merge remote-tracking branch 'remote/develop' into feature/altair-5-s…

f09c9d9

…upport

kmcgrady reviewed May 15, 2023

View reviewed changes

lukasmasuch commented May 15, 2023

View reviewed changes

tconkling approved these changes May 18, 2023

View reviewed changes

lukasmasuch added 2 commits May 19, 2023 02:28

Use new syntax

2a60336

Merge remote-tracking branch 'remote/develop' into feature/altair-5-s…

e4d535f

…upport

binste reviewed May 19, 2023

View reviewed changes

lib/streamlit/elements/arrow_altair.py Outdated Show resolved Hide resolved

lukasmasuch added 3 commits May 23, 2023 16:20

Merge remote-tracking branch 'remote/develop' into feature/altair-5-s…

fd6b0a9

…upport

Update vega lite dependency

75fd987

Use context manager for deactivation theme

dcfaec9

lukasmasuch merged commit b2e4859 into develop May 23, 2023

lukasmasuch mentioned this pull request May 23, 2023

Streamlit startup time could be reduced from 1s to 400ms #6066

Closed

7 tasks

djhoese mentioned this pull request Jun 9, 2023

Altair 5 issues UW-Madison-DataScience/dataviz-workshop-example#1

Closed

natsukium mentioned this pull request Jun 28, 2023

python310Packages.altair: 4.2.2 -> 5.0.1 NixOS/nixpkgs#237915

Merged

12 tasks

vdonato deleted the feature/altair-5-support branch November 1, 2023 23:58

		@@ -1,29 +0,0 @@
		# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022)

Add support for Altair 5 #6618

Add support for Altair 5 #6618

Uh oh!

Conversation

lukasmasuch commented May 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📚 Context

🧪 Testing Done

🌐 References

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

binste commented May 9, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lukasmasuch May 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tconkling left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lukasmasuch May 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lukasmasuch commented May 19, 2023

Uh oh!

lukasmasuch commented May 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

binste commented May 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

lukasmasuch commented May 23, 2023

Uh oh!

binste commented May 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

lukasmasuch commented May 3, 2023 •

edited

Loading

lukasmasuch May 15, 2023 •

edited

Loading

tconkling left a comment •

edited

Loading

lukasmasuch May 19, 2023 •

edited

Loading

lukasmasuch commented May 19, 2023 •

edited

Loading

binste commented May 19, 2023 •

edited

Loading

binste commented May 24, 2023 •

edited

Loading