148 lines
4.4 KiB
Python
148 lines
4.4 KiB
Python
# Copyright 2020 The HuggingFace Team. All rights reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
"""Contains commands to authenticate to the Hugging Face Hub and interact with your repositories.
|
|
|
|
Usage:
|
|
# login and save token locally.
|
|
hf auth login --token=hf_*** --add-to-git-credential
|
|
|
|
# switch between tokens
|
|
hf auth switch
|
|
|
|
# list all tokens
|
|
hf auth list
|
|
|
|
# logout from all tokens
|
|
hf auth logout
|
|
|
|
# check which account you are logged in as
|
|
hf auth whoami
|
|
"""
|
|
|
|
from typing import Annotated, Optional
|
|
|
|
import typer
|
|
|
|
from huggingface_hub.constants import ENDPOINT
|
|
from huggingface_hub.errors import HfHubHTTPError
|
|
from huggingface_hub.hf_api import whoami
|
|
|
|
from .._login import auth_list, auth_switch, login, logout
|
|
from ..utils import ANSI, get_stored_tokens, get_token, logging
|
|
from ._cli_utils import TokenOpt, typer_factory
|
|
|
|
|
|
logger = logging.get_logger(__name__)
|
|
|
|
|
|
auth_cli = typer_factory(help="Manage authentication (login, logout, etc.).")
|
|
|
|
|
|
@auth_cli.command("login", help="Login using a token from huggingface.co/settings/tokens")
|
|
def auth_login(
|
|
token: TokenOpt = None,
|
|
add_to_git_credential: Annotated[
|
|
bool,
|
|
typer.Option(
|
|
help="Save to git credential helper. Useful only if you plan to run git commands directly.",
|
|
),
|
|
] = False,
|
|
) -> None:
|
|
login(token=token, add_to_git_credential=add_to_git_credential)
|
|
|
|
|
|
@auth_cli.command("logout", help="Logout from a specific token")
|
|
def auth_logout(
|
|
token_name: Annotated[
|
|
Optional[str],
|
|
typer.Option(
|
|
help="Name of token to logout",
|
|
),
|
|
] = None,
|
|
) -> None:
|
|
logout(token_name=token_name)
|
|
|
|
|
|
def _select_token_name() -> Optional[str]:
|
|
token_names = list(get_stored_tokens().keys())
|
|
|
|
if not token_names:
|
|
logger.error("No stored tokens found. Please login first.")
|
|
return None
|
|
|
|
print("Available stored tokens:")
|
|
for i, token_name in enumerate(token_names, 1):
|
|
print(f"{i}. {token_name}")
|
|
while True:
|
|
try:
|
|
choice = input("Enter the number of the token to switch to (or 'q' to quit): ")
|
|
if choice.lower() == "q":
|
|
return None
|
|
index = int(choice) - 1
|
|
if 0 <= index < len(token_names):
|
|
return token_names[index]
|
|
else:
|
|
print("Invalid selection. Please try again.")
|
|
except ValueError:
|
|
print("Invalid input. Please enter a number or 'q' to quit.")
|
|
|
|
|
|
@auth_cli.command("switch", help="Switch between access tokens")
|
|
def auth_switch_cmd(
|
|
token_name: Annotated[
|
|
Optional[str],
|
|
typer.Option(
|
|
help="Name of the token to switch to",
|
|
),
|
|
] = None,
|
|
add_to_git_credential: Annotated[
|
|
bool,
|
|
typer.Option(
|
|
help="Save to git credential helper. Useful only if you plan to run git commands directly.",
|
|
),
|
|
] = False,
|
|
) -> None:
|
|
if token_name is None:
|
|
token_name = _select_token_name()
|
|
if token_name is None:
|
|
print("No token name provided. Aborting.")
|
|
raise typer.Exit()
|
|
auth_switch(token_name, add_to_git_credential=add_to_git_credential)
|
|
|
|
|
|
@auth_cli.command("list", help="List all stored access tokens")
|
|
def auth_list_cmd() -> None:
|
|
auth_list()
|
|
|
|
|
|
@auth_cli.command("whoami", help="Find out which huggingface.co account you are logged in as.")
|
|
def auth_whoami() -> None:
|
|
token = get_token()
|
|
if token is None:
|
|
print("Not logged in")
|
|
raise typer.Exit()
|
|
try:
|
|
info = whoami(token)
|
|
print(ANSI.bold("user: "), info["name"])
|
|
orgs = [org["name"] for org in info["orgs"]]
|
|
if orgs:
|
|
print(ANSI.bold("orgs: "), ",".join(orgs))
|
|
|
|
if ENDPOINT != "https://huggingface.co":
|
|
print(f"Authenticated through private endpoint: {ENDPOINT}")
|
|
except HfHubHTTPError as e:
|
|
print(e)
|
|
print(ANSI.red(e.response.text))
|
|
raise typer.Exit(code=1)
|