Skip to content

Update experimental-user.md #794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 15, 2023
Merged

Update experimental-user.md #794

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions content/library/api/personalization/experimental-user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ st.write(st.experimental_user['email'])
st.write(st.experimental_user.email)
```

The above outputs either `None` or the logged-in user's email or test@localhost.com, depending on where the app is running. Read further to learn about `st.experimental_user`'s context-dependent behavior.
The above outputs either `None` or the logged-in user's email or test@example.com, depending on where the app is running. Read further to learn about `st.experimental_user`'s context-dependent behavior.

### Updates and modifications

Expand Down Expand Up @@ -105,11 +105,11 @@ This value of this field is empty in a public Streamlit Community Cloud app to p

#### **Local development**

When developing locally, `st.experimental_user.email` returns test@localhost.com. We don't return `None` to make it easier to locally test this functionality. For example:
When developing locally, `st.experimental_user.email` returns test@example.com. We don't return `None` to make it easier to locally test this functionality. For example:

```python
st.experimental_user.email
# Returns: test@localhost.com
# Returns: test@example.com
```

#### **App deployed on a 3rd party cloud provider**
Expand All @@ -118,7 +118,7 @@ When deploying an app on a 3rd party cloud provider (e.g. Amazon EC2, Heroku, et

```python
st.experimental_user.email # On a 3rd party cloud provider
# Returns: test@localhost.com
# Returns: test@example.com
```

### Examples
Expand Down Expand Up @@ -166,5 +166,5 @@ if st.experimental_user.email:
### Caveats and limitations

- `st.experimental_user` is **read-only**. You cannot update or modify its value. Doing so will throw a `StreamlitAPIException`.
- A valid email is returned only if the user is logged in to Streamlit Community Cloud and the app is private. Else, `None` or test@localhost.com is returned.
- A valid email is returned only if the user is logged in to Streamlit Community Cloud and the app is private. Else, `None` or test@example.com is returned.
- This is an experimental feature. Experimental features and their APIs may change or be removed at any time. To learn more, click [here](/library/advanced-features/prerelease#experimental-features).