Use proper logging in auth module (#2604)

* use proper logging in auth module

* update command docstring

* change logging severity message from info -> warning

Author: hanouticelina

src/huggingface_hub/_login.py

@@ -15,7 +15,6 @@
 
 import os
 import subprocess
-import warnings
 from functools import partial
 from getpass import getpass
 from pathlib import Path
@@ -111,7 +110,7 @@ def login(
     """
     if token is not None:
         if not add_to_git_credential:
-            print(
+            logger.info(
                 "The 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 "
@@ -137,7 +136,7 @@ def logout(token_name: Optional[str] = None) -> None:
             If the access token name is not found.
     """
     if get_token() is None and not get_stored_tokens():  # No active token and no saved access tokens
-        print("Not logged in!")
+        logger.warning("Not logged in!")
         return
     if not token_name:
         # Delete all saved access tokens and token
@@ -146,10 +145,10 @@ def logout(token_name: Optional[str] = None) -> None:
                 Path(file_path).unlink()
             except FileNotFoundError:
                 pass
-        print("Successfully logged out from all access tokens.")
+        logger.info("Successfully logged out from all access tokens.")
     else:
         _logout_from_token(token_name)
-        print(f"Successfully logged out from access token: {token_name}.")
+        logger.info(f"Successfully logged out from access token: {token_name}.")
 
     unset_git_credential()
 
@@ -187,10 +186,10 @@ def auth_switch(token_name: str, add_to_git_credential: bool = False) -> None:
         raise ValueError(f"Access token {token_name} not found in {constants.HF_STORED_TOKENS_PATH}")
     # Write token to HF_TOKEN_PATH
     _set_active_token(token_name, add_to_git_credential)
-    print(f"The current active token is: {token_name}")
+    logger.info(f"The current active token is: {token_name}")
     token_from_environment = _get_token_from_environment()
     if token_from_environment is not None and token_from_environment != token:
-        warnings.warn(
+        logger.warning(
             "The environment variable `HF_TOKEN` is set and will override the access token you've just switched to."
         )
 
@@ -200,7 +199,7 @@ def auth_list() -> None:
     tokens = get_stored_tokens()
 
     if not tokens:
-        print("No access tokens found.")
+        logger.info("No access tokens found.")
         return
     # Find current token
     current_token = get_token()
@@ -222,11 +221,11 @@ def auth_list() -> None:
         print(f"{is_current} {{:<{max_offset}}}| {{:<15}}".format(token_name, masked_token))
 
     if _get_token_from_environment():
-        print(
+        logger.warning(
             "\nNote: Environment variable `HF_TOKEN` is set and is the current active token independently from the stored tokens listed above."
         )
     elif current_token_name is None:
-        print(
+        logger.warning(
             "\nNote: No active token is set and no environment variable `HF_TOKEN` is found. Use `huggingface-cli login` to log in."
         )
 
@@ -254,23 +253,25 @@ def interpreter_login(new_session: bool = True, write_permission: bool = False)
 
     """
     if not new_session and _current_token_okay(write_permission=write_permission):
-        print("User is already logged in.")
+        logger.info("User is already logged in.")
         return
 
     from .commands.delete_cache import _ask_for_confirmation_no_tui
 
     print(_HF_LOGO_ASCII)
     if get_token() is not None:
-        print(
+        logger.info(
             "    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."
         )
-        print("    Setting a new token will erase the existing one.")
+        logger.info("    Setting a new token will erase the existing one.")
 
-    print("    To log in, `huggingface_hub` requires a token generated from https://huggingface.co/settings/tokens .")
+    logger.info(
+        "    To log in, `huggingface_hub` requires a token generated from https://huggingface.co/settings/tokens ."
+    )
     if os.name == "nt":
-        print("Token can be pasted using 'Right-Click'.")
+        logger.info("Token can be pasted using 'Right-Click'.")
     token = getpass("Enter your token (input will not be visible): ")
     add_to_git_credential = _ask_for_confirmation_no_tui("Add token as git credential?")
 
@@ -330,7 +331,7 @@ def notebook_login(new_session: bool = True, write_permission: bool = False) ->
             " Colab) and you need the `ipywidgets` module: `pip install ipywidgets`."
         )
     if not new_session and _current_token_okay(write_permission=write_permission):
-        print("User is already logged in.")
+        logger.info("User is already logged in.")
         return
 
     box_layout = widgets.Layout(display="flex", flex_flow="column", align_items="center", width="50%")
@@ -400,20 +401,20 @@ def _login(
             "Token is valid but is 'read-only' and a 'write' token is required.\nPlease provide a new token with"
             " correct permission."
         )
-    print(f"Token is valid (permission: {permission}).")
+    logger.info(f"Token is valid (permission: {permission}).")
 
     token_name = token_info["auth"]["accessToken"]["displayName"]
     # Store token locally
     _save_token(token=token, token_name=token_name)
     # Set active token
     _set_active_token(token_name=token_name, add_to_git_credential=add_to_git_credential)
-    print("Login successful.")
+    logger.info("Login successful.")
     if _get_token_from_environment():
-        print(
+        logger.warning(
             "Note: Environment variable`HF_TOKEN` is set and is the current active token independently from the token you've just configured."
         )
     else:
-        print(f"The current active token is: `{token_name}`")
+        logger.info(f"The current active token is: `{token_name}`")
 
 
 def _logout_from_token(token_name: str) -> None:
@@ -435,7 +436,7 @@ def _logout_from_token(token_name: str) -> None:
     _save_stored_tokens(stored_tokens)
 
     if token == _get_token_from_file():
-        warnings.warn(f"Active token '{token_name}' has been deleted.")
+        logger.warning(f"Active token '{token_name}' has been deleted.")
         Path(constants.HF_TOKEN_PATH).unlink(missing_ok=True)
 
 
@@ -455,17 +456,17 @@ def _set_active_token(
     if add_to_git_credential:
         if _is_git_credential_helper_configured():
             set_git_credential(token)
-            print(
+            logger.info(
                 "Your token has been saved in your configured git credential helpers"
                 + f" ({','.join(list_credential_helpers())})."
             )
         else:
-            print("Token has not been saved to git credential helper.")
+            logger.warning("Token has not been saved to git credential helper.")
     # Write token to HF_TOKEN_PATH
     path = Path(constants.HF_TOKEN_PATH)
     path.parent.mkdir(parents=True, exist_ok=True)
     path.write_text(token)
-    print(f"Your token has been saved to {constants.HF_TOKEN_PATH}")
+    logger.info(f"Your token has been saved to {constants.HF_TOKEN_PATH}")
 
 
 def _current_token_okay(write_permission: bool = False):

src/huggingface_hub/commands/user.py

@@ -11,6 +11,29 @@
 # 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.
+    huggingface-cli login --token=hf_*** --add-to-git-credential
+
+    # switch between tokens
+    huggingface-cli auth switch
+
+    # list all tokens
+    huggingface-cli auth list
+
+    # logout from a specific token, if no token-name is provided, all tokens will be deleted from your machine.
+    huggingface-cli logout --token-name=your_token_name
+
+    # find out which huggingface.co account you are logged in as
+    huggingface-cli whoami
+
+    # create a new dataset repo on the Hub
+    huggingface-cli repo create mydataset --type=dataset
+
+"""
+
 import subprocess
 from argparse import _SubParsersAction
 from typing import Optional
@@ -126,6 +149,7 @@ def __init__(self, args):
 
 class LoginCommand(BaseUserCommand):
     def run(self):
+        logging.set_verbosity_info()
         login(
             token=self.args.token,
             add_to_git_credential=self.args.add_to_git_credential,
@@ -134,11 +158,13 @@ def run(self):
 
 class LogoutCommand(BaseUserCommand):
     def run(self):
+        logging.set_verbosity_info()
         logout(token_name=self.args.token_name)
 
 
 class AuthSwitchCommand(BaseUserCommand):
     def run(self):
+        logging.set_verbosity_info()
         token_name = self.args.token_name
         if token_name is None:
             token_name = self._select_token_name()
@@ -189,6 +215,7 @@ def _select_token_name_tui(self, token_names: list[str]) -> Optional[str]:
 
 class AuthListCommand(BaseUserCommand):
     def run(self):
+        logging.set_verbosity_info()
         auth_list()
 
 

src/huggingface_hub/utils/_auth.py

@@ -201,7 +201,7 @@ def _save_token(token: str, token_name: str) -> None:
     stored_tokens = get_stored_tokens()
     stored_tokens[token_name] = token
     _save_stored_tokens(stored_tokens)
-    print(f"The token `{token_name}` has been saved to {tokens_path}")
+    logger.info(f"The token `{token_name}` has been saved to {tokens_path}")
 
 
 def _clean_token(token: Optional[str]) -> Optional[str]: