Extend st.navigation functionality to support various page input types #10358

ashm-dev · 2025-02-07T11:16:42Z

Describe your changes

Added

Support for string file paths as page inputs
Support for functions as page inputs
New utility function convert_to_streamlit_page for converting various input types to StreamlitPage
Extended documentation with new usage examples

Changed

Updated st.navigation interface to accept mixed input types
Improved typing for navigation function parameters
Extended unit tests to cover new use cases

Documentation

Added detailed examples for various input types
Updated parameter descriptions
Added examples for working with stateful widgets

GitHub Issue Link (if applicable)

Closes #10069

Testing Plan

The necessary tests have already been added

Contribution License Agreement

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

kmcgrady

Hey @ashm-dev Thanks for the PR. Let me double check with @jrieke on whether we want to support direct strings here. I see how this can be simpler, but I also see this as obfuscating the API at the possibilities.

EDIT: Ah I see @jrieke wrote the issue, so I bet he agrees. I'll double check and give this a review.

jrieke · 2025-02-11T01:18:20Z

This is awesome, thanks so much @ashm-dev! I actually started a similar PR a while ago (#10074) but didn't get around to finish it up, so happy to let you take it across the finish line ;) Only had a brief look at the PR but my 2 cts:

Let's to also support pathlib.Path objects in addition to strings pointing to paths. We do that everywhere else in the API too and should be very easy to add.
For the docstring changes, please also get approval from @sfc-gh-dmatthews. Might also make sense to get them into a separate PR, so we can merge this one faster but will let y'all figure this out! Feel free to also take a look at my PR for inspiration on how to describe the possible formats for defining pages.

@kmcgrady when this is merged, you can also close my PR.

ashm-dev · 2025-02-11T10:01:35Z

Got it, thank you for such feedback!

Then I just add the ability to work with pathlib.Path, I add tests for this and add docstring documentation)

sfc-gh-dmatthews · 2025-02-11T22:39:37Z

I can change the docstrings in a followup PR since I'll need to change a bit.

Although I'm already planning on implementing support for Notes and Raises, we don't use those yet so I'll reformat that information. (Otherwise, it can have unintended consequences for the docstring parser or docs site.) I'm planning on comprehensively documenting raised exceptions, but since no other public command has this yet, I'm inclined to leave it out until I take a pass at getting some basic coverage across the board for consistency. The examples section needs to keep its embedded apps and header labels, so I'll need to rework the examples and make sure the apps are consistent. Since that will take me a little time, I'll just do a followup to make it easy. 😃

ashm-dev · 2025-02-11T22:54:19Z

@sfc-gh-dmatthews Ok got it, should I fix it in the current version, or is this PR already accepted, and you will update it yourself in the next one?

sfc-gh-dmatthews · 2025-02-13T04:02:29Z

@ashm-dev I can update it in the next PR.

… inputs

ashm-dev · 2025-02-14T14:38:45Z

When will my PR be merged?

kmcgrady · 2025-02-17T16:36:28Z

Hey @ashm-dev I will review this today and hopefully it will be close. I can expect it to be merged this week. Our cutoff is set for Wednesday Feb 26th in the evening (Pacific Time), so we have plenty of time :-)

kmcgrady

Everything looks great. Just some small comments (and making sure the checks all pass), and we can get this merged.

kmcgrady · 2025-02-18T03:29:23Z

lib/streamlit/commands/navigation.py

+
+    if callable(page_input):
+        # Convert function to StreamlitPage
+        return Page(page_input)


For these, we want to use StreamlitPage, not Page. Page is annotated to assume it's an st call where StreamlitPage is the underlying function.

kmcgrady · 2025-02-18T03:33:32Z

lib/streamlit/commands/navigation.py

+
+    raise StreamlitAPIException(
+        f"Invalid page type: {type(page_input)}. Must be either a string path, "
+        "a callable function, or a StreamlitPage object."


Probably should call this st.Page object since this is what users would be seeing.

I call the object by its name in docs. st.Page isn't a class; it's a command to create an instance of a class. So st.Page is a command you call; StreamlitPage is the object you get from it.

I followed the same logic, but once they said update, I redid it)

I'll defer to Debbie here since she's our docs expert. If StreamlitPage makes the most sense, we can leave it as is (and sorry for the thrash)

kmcgrady · 2025-02-18T23:02:06Z

Looking at the tests failing tests. I think you need to:

Run precommit. This would be running pre-commit run --all-files in the directory, which I think should work. If not, you may need to just read the suggested changes.
Looks like Python tests just need that pre-commit run to format the python files and it will continue (assuming the tests pass)

ashm-dev · 2025-02-19T05:58:44Z

@kmcgrady Yes, there was a minor error in types and formatting, I fixed it, now I hope everything goes as it should)

package.json

kmcgrady · 2025-02-19T15:51:57Z

package-lock.json

Looks like this was created by mistake and committed. Should remove that

kmcgrady

Homestretch. Looks like there were some files erroneously added. Can you remove them? I think the only thing is to remove references to Page in favor of StreamlitPage

lib/streamlit/commands/navigation.py

kmcgrady · 2025-02-20T15:54:30Z

Thanks @ashm-dev !

jrieke · 2025-02-20T16:06:38Z

Awesome, thanks for adding this @ashm-dev! ❤️

ashm-dev force-pushed the feature-10069 branch 3 times, most recently from 610b6f0 to 450e343 Compare February 8, 2025 12:13

kmcgrady self-requested a review February 10, 2025 19:04

kmcgrady self-assigned this Feb 10, 2025

kmcgrady reviewed Feb 11, 2025

View reviewed changes

ashm-dev force-pushed the feature-10069 branch 2 times, most recently from 8138940 to 3eadc2a Compare February 11, 2025 21:12

ashm-dev requested a review from kmcgrady February 11, 2025 21:12

ashm-dev force-pushed the feature-10069 branch from 3eadc2a to e2b2781 Compare February 11, 2025 22:54

ashm-dev added 2 commits February 13, 2025 11:00

Enhance Navigation API: Add support for strings and functions as page…

4795113

… inputs

Add pathlib.Path support in navigation

065898a

ashm-dev force-pushed the feature-10069 branch from e2b2781 to 065898a Compare February 13, 2025 08:00

Merge branch 'develop' into feature-10069

7effb4c

kmcgrady reviewed Feb 18, 2025

View reviewed changes

ashm-dev added 2 commits February 18, 2025 14:13

Merge branch 'streamlit:develop' into feature-10069

8bbc9b2

Update navigation.py

1f08a3e

ashm-dev requested a review from kmcgrady February 18, 2025 11:14

ashm-dev added 3 commits February 18, 2025 16:13

Merge branch 'develop' into feature-10069

fbf4a11

Merge branch 'develop' into feature-10069

e34f580

Merge branch 'develop' into feature-10069

0c2f375

kmcgrady added security-assessment-completed Security assessment has been completed for PR change:feature PR contains new feature or enhancement implementation labels Feb 18, 2025

kmcgrady added the impact:users PR changes affect end users label Feb 18, 2025

ashm-dev added 3 commits February 19, 2025 08:26

Merge branch 'develop' into feature-10069

9f0e3d7

fix: ruff formating

8b82092

mypy fix

65c722c

ashm-dev added 2 commits February 19, 2025 11:48

Merge branch 'develop' into feature-10069

105e7a2

Merge branch 'develop' into feature-10069

f2098e0

kmcgrady reviewed Feb 19, 2025

View reviewed changes

package.json Outdated Show resolved Hide resolved

kmcgrady reviewed Feb 19, 2025

View reviewed changes

kmcgrady reviewed Feb 20, 2025

View reviewed changes

lib/streamlit/commands/navigation.py Outdated Show resolved Hide resolved

lib/streamlit/commands/navigation.py Outdated Show resolved Hide resolved

lib/streamlit/commands/navigation.py Outdated Show resolved Hide resolved

fix

020ff67

ashm-dev requested review from kmcgrady and sfc-gh-dmatthews February 20, 2025 00:32

Merge branch 'develop' into feature-10069

c91322b

kmcgrady approved these changes Feb 20, 2025

View reviewed changes

kmcgrady merged commit 6fc6d44 into streamlit:develop Feb 20, 2025
31 checks passed

ashm-dev deleted the feature-10069 branch February 20, 2025 15:56

jrieke mentioned this pull request Feb 20, 2025

[WIP] Make st.navigation accept functions or file paths instead of st.Page #10074

Closed

Extend st.navigation functionality to support various page input types #10358

Extend st.navigation functionality to support various page input types #10358

Uh oh!

Conversation

ashm-dev commented Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe your changes

Added

Changed

Documentation

GitHub Issue Link (if applicable)

Testing Plan

Uh oh!

kmcgrady 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!

jrieke commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ashm-dev commented Feb 11, 2025

Uh oh!

sfc-gh-dmatthews commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ashm-dev commented Feb 11, 2025

Uh oh!

sfc-gh-dmatthews commented Feb 13, 2025

Uh oh!

ashm-dev commented Feb 14, 2025

Uh oh!

kmcgrady commented Feb 17, 2025

Uh oh!

kmcgrady 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!

kmcgrady Feb 18, 2025

Choose a reason for hiding this comment

Uh oh!

kmcgrady Feb 18, 2025

Choose a reason for hiding this comment

Uh oh!

sfc-gh-dmatthews Feb 18, 2025

Choose a reason for hiding this comment

Uh oh!

ashm-dev Feb 18, 2025

Choose a reason for hiding this comment

Uh oh!

kmcgrady Feb 18, 2025

Choose a reason for hiding this comment

Uh oh!

kmcgrady commented Feb 18, 2025

Uh oh!

ashm-dev commented Feb 19, 2025

Uh oh!

Uh oh!

kmcgrady Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

ashm-dev Feb 20, 2025

Choose a reason for hiding this comment

Uh oh!

kmcgrady 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kmcgrady commented Feb 20, 2025

Uh oh!

jrieke commented Feb 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

ashm-dev commented Feb 7, 2025 •

edited

Loading

kmcgrady left a comment •

edited

Loading

jrieke commented Feb 11, 2025 •

edited

Loading

sfc-gh-dmatthews commented Feb 11, 2025 •

edited

Loading

kmcgrady left a comment •

edited

Loading

kmcgrady left a comment •

edited

Loading