Improve whoami() error messages by specifying token source #2814
Conversation
src/huggingface_hub/hf_api.py
Outdated
| if effective_token == _get_token_from_google_colab(): | ||
| error_message += ( | ||
| " The token from Google Colab vault is invalid. " | ||
| "Please run `huggingface-cli login` in your Colab notebook to update it." |
There was a problem hiding this comment.
| "Please run `huggingface-cli login` in your Colab notebook to update it." | |
| "Please update it from the UI." |
added suggestion Co-authored-by: Lucain <lucainp@gmail.com>
src/huggingface_hub/hf_api.py
Outdated
| @@ -1616,37 +1616,54 @@ def run_as_future(self, fn: Callable[..., R], *args, **kwargs) -> Future[R]: | |||
| return self._thread_pool.submit(fn, *args, **kwargs) | |||
|
|
|||
| @validate_hf_hub_args | |||
| from huggingface_hub.utils._auth import _get_token_from_google_colab, _get_token_from_environment, _get_token_from_file | |||
There was a problem hiding this comment.
can you move this line to the imports section ? And run make style + make quality locally to make sure the code styling aligns with the standard of this repo.
src/huggingface_hub/hf_api.py
Outdated
| @@ -1614,39 +1614,50 @@ def run_as_future(self, fn: Callable[..., R], *args, **kwargs) -> Future[R]: | |||
| self._thread_pool = ThreadPoolExecutor(max_workers=1) | |||
| self._thread_pool | |||
| return self._thread_pool.submit(fn, *args, **kwargs) | |||
|
|
|||
|
|
|||
| from huggingface_hub.utils._auth import _get_token_from_google_colab, _get_token_from_environment, _get_token_from_file | |||
There was a problem hiding this comment.
must be moved to the import section (around
huggingface_hub/src/huggingface_hub/hf_api.py
Line 127 in d959b4f
There was a problem hiding this comment.
just did the changes
|
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. |
|
(sorry for the mess, should be good now 😬) |
|
Thanks it was wonderful seeing the informative guideline throughout . Can you suggest any other doable issue for me ? I am very new all this but I feel excited using huggingface library and want to contribute to it . |
|
Hi @aniketqw thanks for your proposition! Actually at the moment we don't have many "good first issues" to contribute to (see here). Maybe you'd like to play with #1065 for instance ? (ie. adding one option to the |
|
hi @Wauplin , thanks for the guidance I will try to see #1065 ,I understood the gist of it . I will try to see what I can do. Can you please provide me with some reliable sources that I can refer to for guidance on solving this problem? I will get back to you hopefully with my solution on the other issue. Thanks once again. |
|
@aniketqw here is a PR adding the |
This PR enhances the error messages in
whoami()by indicating the source of the invalid token. Currently, when authentication fails, users receive a generic error message regardless of where their token came from (parameter, environment variable, file, or Colab). This can be confusing, especially in cases where an outdatedHF_TOKENenvironment variable takes precedence over a valid token file.Changes:
_get_token_source()helper to detect token origin_get_token_error_message()to generate source-specific messageswhoami()to use these helpers for error handlingExample improvements:
huggingface-cli login."huggingface-cli loginto update it."huggingface-cli loginin your Colab notebook to update it."This change is backward compatible and only affects error messages.
Fixes #2809