Add helpers to handle OAuth in a FastAPI app #2684
Open
+696
−5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
hanouticelina
approved these changes
Dec 3, 2024
There was a problem hiding this comment.
thanks a lot @Wauplin for the detailed code comments and the test suite ❤️ i guess this will be ready to merge after adding the documentation and fixing the test. also, let's open a PR in Gradio to remove the duplicated code after the release!
| The org's profile picture URL. OpenID Connect field. | ||
| is_enterprise (`bool`): | ||
| Whether the org is an enterprise org. Hugging Face field. | ||
| can_pay (`Optional[bool]`, *optional*): |
There was a problem hiding this comment.
Suggested change
| can_pay (`Optional[bool]`, *optional*): | |
| can_pay (`bool`, *optional*): |
same for the other optional attributes in this dataclass and OAuthUserInfo dataclass
| from starlette.middleware.sessions import SessionMiddleware | ||
| except ImportError as e: | ||
| raise ImportError( | ||
| "Cannot initialize OAuth to due a missing library. Please run `pip install huggingface_hub[oauth]` or add " |
There was a problem hiding this comment.
(nit)
Suggested change
| "Cannot initialize OAuth to due a missing library. Please run `pip install huggingface_hub[oauth]` or add " | |
| "Cannot initialize OAuth due to a missing library. Please run `pip install huggingface_hub[oauth]` or add " |
Comment on lines
+65
to
+67
| # Little hack for the tests to work | ||
| # On staging, the redirect_url can be only "http://localhost:3000". Here I'm simply mocking the URL to work and | ||
| # remove any query parameters from the URL. In the test after the Hub call, we will replace back the URL with the |
Comment on lines
+161
to
+162
| def test_get_mocked_oauth_info(): | ||
| oauth_info = _get_mocked_oauth_info() |
There was a problem hiding this comment.
Suggested change
| def test_get_mocked_oauth_info(): | |
| oauth_info = _get_mocked_oauth_info() | |
| def test_get_mocked_oauth_info(monkeypatch): | |
| monkeypatch.setenv("HF_TOKEN", TOKEN) | |
| oauth_info = _get_mocked_oauth_info() | |
This should fix the failing test. Alternatively, one can patch the get_token() function
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR imports the code to handle OAuth in gradio to
huggingface_hub. Goal is to make it available for non-Gradio apps (say autotrain-advanced for instance @abhishekkrthakur).I also added tests to make sure the workflow still works correctly. Thanks @coyotte508 for huggingface/huggingface.js#1050 and advices :)
Missing parts:
I have flagged this feature as "experimental" to be able to introduce breaking changes in the future.
Note that for now, the integration only works for Spaces integrations but the same codebase could be tweaked to handle any kind of websites. That's lower priority though (the JS integration is much better for that).
Demo: https://huggingface.co/spaces/Wauplin/fastapi-oauth