o
vZhJO @ s d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlm Z ddl
m Z dd l m
Z
mZmZmZmZmZmZmZmZ dd
lmZmZmZmZmZm Z m Z dd l m Z m Z e!e"Z#d Z$e d
ddde d
d d4dddddee% de&de&de&ddf
ddZ'd4dee% ddfd d Z(d5de%de&ddfd d Z)d6d d!Z*e d
ddde d
dddd"de&de&ddfd#d$Z+d%Z,d&Z-d'Z.e d
ddde d
dddd"de&de&ddfd(d)Z/de%de&ddfd*d+Z0de%ddfd,d-Z1de%de&ddfd.d/Z2de&fd0d1Z3d6d2d3Z4dS )7z&Contains methods to log in to the Hub. N)getpass)Path)Optional ) constants)ANSI) capture_output get_tokenis_google_colab is_notebooklist_credential_helpersloggingrun_subprocessset_git_credentialunset_git_credential)_get_token_by_name_get_token_from_environment_get_token_from_file _get_token_from_google_colab_save_stored_tokens _save_tokenget_stored_tokens)_deprecate_arguments_deprecate_positional_argsa<
_| _| _| _| _|_|_| _|_|_| _|_|_| _| _| _|_|_| _|_|_|_| _|_| _|_|_| _|_|_|_|
_| _| _| _| _| _| _| _|_| _| _| _| _| _| _| _|
_|_|_|_| _| _| _| _|_| _| _|_| _| _| _| _| _| _|_| _|_|_| _|_|_|_| _| _|_|_|
_| _| _| _| _| _| _| _| _| _| _|_| _| _| _| _| _| _| _|
_| _| _|_| _|_|_| _|_|_| _|_|_| _| _| _|_|_| _| _| _| _|_|_| _|_|_|_|
z1.0write_permissionzuFine-grained tokens added complexity to the permissions, making it irrelevant to check if a token has 'write' access.)versionZdeprecated_argsZcustom_message)r FT)add_to_git_credential new_sessionr tokenr r returnc C sH | dur|s t d t| |d dS t r t|d dS t|d dS )au Login the machine to access the Hub.
The `token` is persisted in cache and set as a git credential. Once done, the machine
is logged in and the access token will be available across all `huggingface_hub`
components. If `token` is not provided, it will be prompted to the user either with
a widget (in a notebook) or via the terminal.
To log in from outside of a script, one can also use `huggingface-cli login` which is
a cli command that wraps [`login`].
[`login`] is a drop-in replacement method for [`notebook_login`] as it wraps and
extends its capabilities.
When the token is not passed, [`login`] will automatically detect if the script runs
in a notebook or not. However, this detection might not be accurate due to the
variety of notebooks that exists nowadays. If that is the case, you can always force
the UI by using [`notebook_login`] or [`interpreter_login`].
Args:
token (`str`, *optional*):
User access token to generate from https://huggingface.co/settings/token.
add_to_git_credential (`bool`, defaults to `False`):
If `True`, token will be set as git credential. If no git credential helper
is configured, a warning will be displayed to the user. If `token` is `None`,
the value of `add_to_git_credential` is ignored and will be prompted again
to the end user.
new_session (`bool`, defaults to `True`):
If `True`, will request a token even if one is already saved on the machine.
write_permission (`bool`):
Ignored and deprecated argument.
Raises:
[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError)
If an organization token is passed. Only personal account tokens are valid
to log in.
[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError)
If token is invalid.
[`ImportError`](https://docs.python.org/3/library/exceptions.html#ImportError)
If running in a notebook but `ipywidgets` is not installed.
NzThe token has not been saved to the git credentials helper. Pass `add_to_git_credential=True` in this function directly or `--add-to-git-credential` if using via `huggingface-cli` if you want to set the git credential as well.r )r )loggerinfo_loginr notebook_logininterpreter_login)r r r r r& E/var/www/auris/lib/python3.10/site-packages/huggingface_hub/_login.pylogin: s <r(
token_namec C s t du rt std dS | s1tjtjfD ]}zt| W q t y* Y qw t
d n
t | t
d| d t t
durJtdt durStddS )a Logout the machine from the Hub.
Token is deleted from the machine and removed from git credential.
Args:
token_name (`str`, *optional*):
Name of the access token to logout from. If `None`, will logout from all saved access tokens.
Raises:
[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError):
If the access token name is not found.
NzNot logged in!z/Successfully logged out from all access tokens.z+Successfully logged out from access token: .zYou are automatically logged in using a Google Colab secret.
To log out, you must unset the `HF_TOKEN` secret in your Colab settings.zToken has been deleted from your machine but you are still logged in.
To log out, you must clear out both `HF_TOKEN` and `HUGGING_FACE_HUB_TOKEN` environment variables.)r r r! warningr
HF_TOKEN_PATHHF_STORED_TOKENS_PATHr unlinkFileNotFoundErrorr" _logout_from_tokenr r EnvironmentErrorr )r) file_pathr& r& r' logout s.
r3 c C sh t | }|std| dtj t| | td| t }|dur0||kr2td dS dS dS )a{ Switch to a different access token.
Args:
token_name (`str`):
Name of the access token to switch to.
add_to_git_credential (`bool`, defaults to `False`):
If `True`, token will be set as git credential. If no git credential helper
is configured, a warning will be displayed to the user. If `token` is `None`,
the value of `add_to_git_credential` is ignored and will be prompted again
to the end user.
Raises:
[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError):
If the access token name is not found.
z
Access token not found in z The current active token is: NzfThe environment variable `HF_TOKEN` is set and will override the access token you've just switched to.) r
ValueErrorr r- _set_active_tokenr! r" r r+ )r) r r Ztoken_from_environmentr& r& r' auth_switch s
r7 c C s( t } | s td dS t }d}| D ] }| ||kr |}qttdtdd | D d }td| dd d td
|d d d | D ]3}| |d
}|d
krd|dd d|dd n|}||krldnd}t| d| d|| qIt rt
d dS |du rt
d dS dS )z List all stored access tokens.zNo access tokens found.Nr c s s | ]}t |V qd S N)len).0r r& r& r' s z auth_list.. z {: z***** z {: 
Immediately click login after typing your password or
it might be stored in plain text in this notebook file. ap
Copy a token from your Hugging Face
tokens page and paste it below.
Immediately click login after copying
your token or it might be stored in plain text in this notebook file. z
Pro Tip: If you don't already have one, you can create a dedicated
'notebooks' token with 'write' access, that you can then easily reuse for all
notebooks. c s zddl m ddlm} W n ty tdw | s(t dur(td dS jdddd d
}j d d j
d
dd j dd }j
t |
tg|d| fdd}|| dS )a+
Displays a widget to log in to the HF website and store the token.
This is equivalent to [`login`] without passing a token when run in a notebook.
[`notebook_login`] is useful if you want to force the use of the notebook widget
instead of a prompt in the terminal.
For more details, see [`login`].
Args:
new_session (`bool`, defaults to `True`):
If `True`, will request a token even if one is already saved on the machine.
write_permission (`bool`):
Ignored and deprecated argument.
r N)displayzThe `notebook_login` function can only be used in a notebook (Jupyter or Colab) and you need the `ipywidgets` module: `pip install ipywidgets`.rL Zflexcolumncenterz50%)rR Z flex_flowZ align_itemswidthzToken:) descriptionTrO )valuerV ZLogin)Zlayoutc
s j } j }d_ dg_z t }t||d W d n1 s%w Y | }W n tyE } z
t|}W Y d}~nd}~ww fdd|dD _dS )z#Event handler for the login button. z
Connecting...r Nc s g | ] }| r |qS r& )stripLabel)r: line)widgetsr& r'
s z=notebook_login..login_token_event..
) rW rZ childrenr r# getvalue Exceptionstrsplit)tr r ZcapturedmessageerrorZgit_checkbox_widgetZlogin_token_widgetZ token_widgetr\ r& r' login_token_eventr s z)notebook_login..login_token_event)Zipywidgets.widgetsr\ IPython.displayrR ImportErrorr r! r" ZLayoutZPasswordZCheckboxZButtonZVBoxHTML NOTEBOOK_LOGIN_TOKEN_HTML_START NOTEBOOK_LOGIN_TOKEN_HTML_ENDZon_click)r r rR Z
box_layoutZtoken_finish_buttonrh r& rg r' r$ = s6
r$ c C s ddl m} | drtd|| }|d d d }td| d |d d d
}t| |d t||d td
t rGt d d S td| d d S )Nr )whoamiZapi_orgzDYou must use your personal account token, not an organization token.authZ accessTokenZrolez Token is valid (permission: ).Z displayName)r r) )r) r zLogin successful.zNote: Environment variable`HF_TOKEN` is set and is the current active token independently from the token you've just configured.z The current active token is: ``)
Zhf_apirn
startswithr5 r! r" r r6 r r+ )r r rn Z
token_infoZ
permissionr) r& r& r' r# s
r# c C s^ t }|r | |vr dS || }t| |t kr-td| d ttjj dd dS dS )a Logout from a specific access token.
Args:
token_name (`str`):
The name of the access token to logout from.
Raises:
[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError):
If the access token name is not found.
NzActive token 'z' has been deleted.T)
missing_ok)
r popr r r! r+ r r r, r. )r) Z
stored_tokensr r& r& r' r0 s
r0 c C s t | }|std| dtj |r/t r*t| tdddt d nt
d t tj }|j
jddd || td
tj d S ) z|Set the active access token.
Args:
token_name (`str`):
The name of the token to set as active.
zToken r4 zCYour token has been saved in your configured git credential helpersz (,rp z2Token has not been saved to git credential helper.T)parentsexist_okz Your token has been saved to N)r r5 r r- $_is_git_credential_helper_configuredr r! r" joinr r+ r r, parentmkdir
write_text)r) r r pathr& r& r' r6 s
r6 c C s8 t } t| dkr dS t rt dS ttd dS )zCheck if a git credential helper is configured.
Warns user if not the case (except for Google Colab where "store" is set by default
by `huggingface_hub`).
r Ta Cannot authenticate through git-credential as no helper is defined on your machine.
You might have to re-authenticate when pushing to the Hugging Face Hub.
Run the following command in your terminal in case you want to set the 'store' credential helper as default.
git config --global credential.helper store
Read https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage for more details.F)r r9 r
,_set_store_as_git_credential_helper_globallyrF r red)helpersr& r& r' rx s rx c
C s4 zt d W dS tjy } zt| jd} ~ ww )a Set globally the credential.helper to `store`.
To be used only in Google Colab as we assume the user doesn't care about the git
credential config. It is the only particular case where we don't want to display the
warning message in [`notebook_login()`].
Related:
- https://github.com/huggingface/huggingface_hub/issues/1043
- https://github.com/huggingface/huggingface_hub/issues/1051
- https://git-scm.com/docs/git-credential-store
z+git config --global credential.helper storeN)r
subprocessCalledProcessErrorr1 stderr)excr& r& r' r~ s
r~ r8 )F)r N)5__doc__rQ r r pathlibr typingr rX r Zcommands._cli_utilsr utilsr r r
r r r
r r r Z utils._authr r r r r r r Zutils._deprecationr r Z
get_logger__name__r! rP rb boolr( r3 r7 rK r% Z NOTEBOOK_LOGIN_PASSWORD_HTMLrl rm r$ r# r0 r6 rx r~ r& r& r& r' s
,$
E*
)"."H