U
9%e7 @ s6 d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlm Z ddl
m Z dd l m
Z
dd
lmZmZmZmZmZmZmZmZmZ eeZd%ee e e e dd
ddZ ddddZ d&e e ddddZ dZ dZ!dZ"d'e e ddddZ#d(ee e ddd d Z$d)e d d d Z%e dd!d"Z&ddd#d$Z'dS )*z%Contains methods to login to the Hub. N)partial)getpass)Optional )ANSI) _ask_for_confirmation_no_tuiget_token_permission) HfFoldercapture_outputis_google_colab is_notebooklist_credential_helpersloggingrun_subprocessset_git_credentialunset_git_credentialFT)tokenadd_to_git_credential new_sessionwrite_permissionreturnc C sH | dk r$|st d t| ||d n t r8t||d n t||d dS )a 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 login 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`, defaults to `False`):
If `True`, requires a token with write permission.
Raises:
[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError)
If an organization token is passed. Only personal account tokens are valid
to login.
[`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.
NzToken will not been saved to git credential helper. Pass `add_to_git_credential=True` if you want to set the git credential as well.r r )r r )print_loginr
notebook_logininterpreter_login)r r r r r U/var/www/html/Darija-Ai-API/env/lib/python3.8/site-packages/huggingface_hub/_login.pylogin( s 1r )r c C s6 t } | dkr td dS t t td dS )zmLogout the machine from the Hub.
Token is deleted from the machine and removed from git credential.
NzNot logged in!zSuccessfully logged out.)r
get_tokenr Z delete_tokenr )r r r r logoutg s r! )r r r c C sz | st |drtd dS td t dk r>td td td tjdkrXtd td
}td }t|||d dS )
aR
Displays a prompt to login to the HF website and store the token.
This is equivalent to [`login`] without passing a token when not run in a notebook.
[`interpreter_login`] is useful if you want to force the use of the terminal prompt
instead of a notebook widget.
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`, defaults to `False`):
If `True`, requires a token with write permission.
r User is already logged in.Na@
_| _| _| _| _|_|_| _|_|_| _|_|_| _| _| _|_|_| _|_|_|_| _|_| _|_|_| _|_|_|_|
_| _| _| _| _| _| _| _|_| _| _| _| _| _| _| _|
_|_|_|_| _| _| _| _|_| _| _|_| _| _| _| _| _| _|_| _|_|_| _|_|_|_| _| _|_|_|
_| _| _| _| _| _| _| _| _| _| _|_| _| _| _| _| _| _| _|
_| _| _|_| _|_|_| _|_|_| _|_|_| _| _| _|_|_| _| _| _| _|_|_| _|_|_|_|
z A token is already saved on your machine. Run `huggingface-cli whoami` to get more information or `huggingface-cli logout` if you want to log out.z4 Setting a new token will erase the existing one.zh To login, `huggingface_hub` requires a token generated from https://huggingface.co/settings/tokens .ntz(Token can be pasted using 'Right-Click'.zToken: Add token as git credential?)r r r ) _current_token_okayr r
r osnamer r r )r r r r r r r r z s
r 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 z ddl m ddlm} W n tk
r8 tdY nX | sTt|drTtd dS jddd d
d }jd d
j ddd j
dd
}j t
| tg|d| dtd fdd
}|t||d dS )aQ
Displays a widget to login 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`, defaults to `False`):
If `True`, requires a token with write permission.
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`.r" r# Zflexcolumncenterz50%)r) Z flex_flowZ align_itemswidthzToken:) descriptionTr% )valuer- ZLogin)ZlayoutFc
s j } j }d_ dg_z,t }t|||d W 5 Q R X | }W n* tk
rv } z t|}W 5 d}~X Y nX fdd|dD _dS )z
Event handler for the login button.
Args:
write_permission (`bool`, defaults to `False`):
If `True`, requires a token with write permission.
z
Connecting...r Nc s g | ]}| r |qS r )stripLabel).0line)widgetsr r
s z=notebook_login..login_token_event..
) r. r1 childrenr r getvalue Exceptionstrsplit)tr r r ZcapturedmessageerrorZgit_checkbox_widgetZlogin_token_widgetZ token_widgetr4 r r login_token_event s z)notebook_login..login_token_event)F)Zipywidgets.widgetsr4 IPython.displayr) ImportErrorr& r ZLayoutZPasswordZCheckboxZButtonZVBoxHTML NOTEBOOK_LOGIN_TOKEN_HTML_START NOTEBOOK_LOGIN_TOKEN_HTML_ENDboolZon_clickr )r r r) Z
box_layoutZtoken_finish_buttonr@ r r? r r s4
r )r r r r c C s | drtdt| }|d kr,tdn|r@|dkr@tdtd| d |rt rt| tdd d
t d ntd t | td tj
td
d S )NZapi_orgzDYou must use your personal account token, not an organization token.zInvalid token passed!writezvToken is valid but is 'read-only' and a 'write' token is required.
Please provide a new token with correct permission.z Token is valid (permission: z).zCYour token has been saved in your configured git credential helpersz (,z2Token has not been saved to git credential helper.z Your token has been saved to zLogin successful)
startswith
ValueErrorr r $_is_git_credential_helper_configuredr joinr r
Z
save_tokenZ
path_token)r r r
permissionr r r r
s,
r r" c C s" t }|dks| r |dkr dS dS )a Check if the current token is valid.
Args:
write_permission (`bool`, defaults to `False`):
If `True`, requires a token with write permission.
Returns:
`bool`: `True` if the current token is valid, `False` otherwise.
NrG FTr )r rM r r r r& * s
r& c C s8 t } t| dkrdS t r&t 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 lenr ,_set_store_as_git_credential_helper_globallyr r red)helpersr r r rK : s rK c
C s@ z t d W n. tjk
r: } zt| jW 5 d} ~ X Y nX dS )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
subprocessCalledProcessErrorEnvironmentErrorstderr)excr r r rO Y s rO )NFTF)TF)TF)F)F)(__doc__r' rR functoolsr r typingr Zcommands._cli_utilsr Zcommands.delete_cacher Zhf_apir utilsr
r r r
r r r r r Z
get_logger__name__loggerr: rF r r! r Z NOTEBOOK_LOGIN_PASSWORD_HTMLrD rE r r r& rK rO r r r r s> ,
?1N