clean up option defaults

Author: carl-adams-planet

src/planet_auth_utils/commands/cli/options.py

@@ -24,8 +24,7 @@
 
 
 # TODO: make default, hidden, required params for everyone.  Fix monkey patching, if needed
-# TODO: sort members
-def opt_api_key() -> _click_option_decorator_type:
+def opt_api_key(default=None) -> _click_option_decorator_type:
     """
     Click option for specifying an API key
     """
@@ -36,7 +35,7 @@ def decorator(function) -> _click_option_decorator_type:
             type=str,
             envvar=EnvironmentVariables.AUTH_API_KEY,
             help="Specify an API key.",
-            default=None,
+            default=default,
             show_envvar=True,
             show_default=True,
         )(function)
@@ -45,7 +44,7 @@ def decorator(function) -> _click_option_decorator_type:
     return decorator
 
 
-def opt_audience(required=False) -> _click_option_decorator_type:
+def opt_audience(default=None, required=False) -> _click_option_decorator_type:
     """
     Click option for specifying an OAuth token audience for the
     planet_auth package's click commands.
@@ -60,7 +59,7 @@ def decorator(function) -> _click_option_decorator_type:
             help="Token audiences.  Specify multiple options to set"
             " multiple audiences.  When set via environment variable, audiences"
             " should be white space delimited.",
-            default=None,
+            default=default,
             show_envvar=True,
             show_default=True,
             required=required,
@@ -70,7 +69,7 @@ def decorator(function) -> _click_option_decorator_type:
     return decorator
 
 
-def opt_client_id() -> _click_option_decorator_type:
+def opt_client_id(default=None) -> _click_option_decorator_type:
     """
     Click option for specifying an OAuth client ID.
     """
@@ -81,7 +80,7 @@ def decorator(function) -> _click_option_decorator_type:
             type=str,
             envvar=EnvironmentVariables.AUTH_CLIENT_ID,
             help="Specify the OAuth client ID.",
-            default=None,
+            default=default,
             show_envvar=True,
             show_default=True,
         )(function)
@@ -90,7 +89,7 @@ def decorator(function) -> _click_option_decorator_type:
     return decorator
 
 
-def opt_client_secret() -> _click_option_decorator_type:
+def opt_client_secret(default=None) -> _click_option_decorator_type:
     """
     Click option for specifying an OAuth client secret.
     """
@@ -101,7 +100,7 @@ def decorator(function) -> _click_option_decorator_type:
             type=str,
             envvar=EnvironmentVariables.AUTH_CLIENT_SECRET,
             help="Specify the OAuth client Secret.",
-            default=None,
+            default=default,
             show_envvar=True,
             show_default=True,
         )(function)
@@ -110,7 +109,7 @@ def decorator(function) -> _click_option_decorator_type:
     return decorator
 
 
-def opt_extra() -> _click_option_decorator_type:
+def opt_extra(default=None) -> _click_option_decorator_type:
     """
     Click option for specifying extra options.
     """
@@ -126,7 +125,7 @@ def decorator(function) -> _click_option_decorator_type:
             " multiple extra options.  The format of an option is <key>=<value>."
             " When set via environment variable, values should be delimited by"
             " whitespace.",
-            default=None,
+            default=default,
             show_envvar=True,
             show_default=True,
         )(function)
@@ -135,7 +134,7 @@ def decorator(function) -> _click_option_decorator_type:
     return decorator
 
 
-def opt_human_readable() -> _click_option_decorator_type:
+def opt_human_readable(default=False) -> _click_option_decorator_type:
     """
     Click option to toggle raw / human-readable formatting.
     """
@@ -145,15 +144,15 @@ def decorator(function) -> _click_option_decorator_type:
             "--human-readable/--no-human-readable",
             "-H",
             help="Reformat fields to be human readable.",
-            default=False,
+            default=default,
             show_default=True,
         )(function)
         return function
 
     return decorator
 
 
-def opt_issuer(required=False) -> _click_option_decorator_type:
+def opt_issuer(default=None, required=False) -> _click_option_decorator_type:
     """
     Click option for specifying an OAuth token issuer for the
     planet_auth package's click commands.
@@ -165,7 +164,7 @@ def decorator(function) -> _click_option_decorator_type:
             type=str,
             envvar=EnvironmentVariables.AUTH_ISSUER,
             help="Token issuer.",
-            default=None,
+            default=default,
             show_envvar=False,
             show_default=False,
             required=required,
@@ -175,7 +174,7 @@ def decorator(function) -> _click_option_decorator_type:
     return decorator
 
 
-def opt_loglevel() -> _click_option_decorator_type:
+def opt_loglevel(default="INFO") -> _click_option_decorator_type:
     """
     Click option for specifying a log level.
     """
@@ -187,7 +186,7 @@ def decorator(function) -> _click_option_decorator_type:
             envvar=EnvironmentVariables.AUTH_LOGLEVEL,
             help="Set the log level.",
             type=click.Choice(["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"], case_sensitive=False),
-            default="INFO",
+            default=default,
             show_envvar=True,
             show_default=True,
         )(function)
@@ -196,7 +195,7 @@ def decorator(function) -> _click_option_decorator_type:
     return decorator
 
 
-def opt_long() -> _click_option_decorator_type:
+def opt_long(default=False) -> _click_option_decorator_type:
     """
     Click option specifying that long or more detailed output should be produced.
     """
@@ -207,15 +206,15 @@ def decorator(function) -> _click_option_decorator_type:
             "--long",
             help="Longer, more detailed output",
             is_flag=True,
-            default=False,
+            default=default,
             show_default=True,
         )(function)
         return function
 
     return decorator
 
 
-def opt_open_browser() -> _click_option_decorator_type:
+def opt_open_browser(default=True) -> _click_option_decorator_type:
     """
     Click option for specifying whether or not opening a browser is permitted
     for the planet_auth package's click commands.
@@ -225,7 +224,7 @@ def decorator(function) -> _click_option_decorator_type:
         function = click.option(
             "--open-browser/--no-open-browser",
             help="Allow/Suppress the automatic opening of a browser window.",
-            default=True,
+            default=default,
             show_default=True,
         )(function)
         return function
@@ -260,7 +259,7 @@ def decorator(function) -> _click_option_decorator_type:
 #         I generally think user IO belongs with the app, and not the the library, but since the
 #         lib also handles things like browser interaction this is not entirely easy to abstract
 #         away.
-def opt_password(hidden=True) -> _click_option_decorator_type:
+def opt_password(default=None, hidden=True) -> _click_option_decorator_type:
     """
     Click option for specifying a password for the
     planet_auth package's click commands.
@@ -272,7 +271,7 @@ def decorator(function) -> _click_option_decorator_type:
             type=str,
             envvar=EnvironmentVariables.AUTH_PASSWORD,
             help="Password used for authentication.  May not be used by all authentication mechanisms.",
-            default=None,
+            default=default,
             show_envvar=True,
             show_default=True,
             hidden=hidden,  # Primarily used by legacy auth.  OAuth2 is preferred, wherein we do not handle username/password.
@@ -311,7 +310,7 @@ def decorator(function) -> _click_option_decorator_type:
     return decorator
 
 
-def opt_project() -> _click_option_decorator_type:
+def opt_project(default=None) -> _click_option_decorator_type:
     """
     Click option for specifying a project ID.
     """
@@ -324,7 +323,7 @@ def decorator(function) -> _click_option_decorator_type:
             # envvar=EnvironmentVariables.AUTH_PROJECT,
             help="Project ID to use when performing authentication.  When present, this option will be"
             " appended to authorization requests.  Not all implementations understand this option.",
-            default=None,
+            default=default,
             show_envvar=True,
             show_default=True,
         )(function)
@@ -333,7 +332,7 @@ def decorator(function) -> _click_option_decorator_type:
     return decorator
 
 
-def opt_qr_code() -> _click_option_decorator_type:
+def opt_qr_code(default=False) -> _click_option_decorator_type:
     """
     Click option for specifying whether a QR code should be displayed.
     """
@@ -342,15 +341,15 @@ def decorator(function) -> _click_option_decorator_type:
         function = click.option(
             "--show-qr-code/--no-show-qr-code",
             help="Control whether a QR code is displayed for the user.",
-            default=False,
+            default=default,
             show_default=True,
         )(function)
         return function
 
     return decorator
 
 
-def opt_refresh() -> _click_option_decorator_type:
+def opt_refresh(default=True) -> _click_option_decorator_type:
     """
     Click option specifying a refresh should be attempted if applicable.
     """
@@ -359,15 +358,15 @@ def decorator(function) -> _click_option_decorator_type:
         function = click.option(
             "--refresh/--no-refresh",
             help="Automatically perform a credential refresh if required.",
-            default=True,
+            default=default,
             show_default=True,
         )(function)
         return function
 
     return decorator
 
 
-def opt_token() -> _click_option_decorator_type:
+def opt_token(default=None) -> _click_option_decorator_type:
     """
     Click option for specifying a token literal.
     """
@@ -376,6 +375,7 @@ def decorator(function) -> _click_option_decorator_type:
         function = click.option(
             "--token",
             help="Token string.",
+            default=default,
             type=str,
             # envvar=EnvironmentVariables.AUTH_TOKEN,
             show_envvar=False,
@@ -386,7 +386,7 @@ def decorator(function) -> _click_option_decorator_type:
     return decorator
 
 
-def opt_scope() -> _click_option_decorator_type:
+def opt_scope(default=None) -> _click_option_decorator_type:
     """
     Click option for specifying an OAuth token scope for the
     planet_auth package's click commands.
@@ -402,7 +402,7 @@ def decorator(function) -> _click_option_decorator_type:
             " multiple scopes.  When set via environment variable, scopes"
             " should be white space delimited.  Default value is determined"
             " by the selected auth profile.",
-            default=None,
+            default=default,
             show_envvar=True,
             show_default=True,
         )(function)
@@ -411,7 +411,7 @@ def decorator(function) -> _click_option_decorator_type:
     return decorator
 
 
-def opt_sops() -> _click_option_decorator_type:
+def opt_sops(default=False) -> _click_option_decorator_type:
     """
     Click option specifying that SOPS should be used.
     """
@@ -421,15 +421,15 @@ def decorator(function) -> _click_option_decorator_type:
             "--sops/--no-sops",
             help="Use sops when creating new files where applicable."
             " The environment must be configured for SOPS to work by default.",
-            default=False,
+            default=default,
             show_default=True,
         )(function)
         return function
 
     return decorator
 
 
-def opt_token_file() -> _click_option_decorator_type:
+def opt_token_file(default=None) -> _click_option_decorator_type:
     """
     Click option for specifying a token file location for the
     planet_auth package's click commands.
@@ -441,7 +441,7 @@ def decorator(function) -> _click_option_decorator_type:
             type=click.Path(exists=True, file_okay=True, readable=True, path_type=pathlib.Path),
             envvar=EnvironmentVariables.AUTH_TOKEN_FILE,
             help="File containing a token.",
-            default=None,
+            default=default,
             show_envvar=False,
             show_default=True,
         )(function)
@@ -450,7 +450,7 @@ def decorator(function) -> _click_option_decorator_type:
     return decorator
 
 
-def opt_username(hidden=True) -> _click_option_decorator_type:
+def opt_username(default=None, hidden=True) -> _click_option_decorator_type:
     """
     Click option for specifying a username for the
     planet_auth package's click commands.
@@ -463,7 +463,7 @@ def decorator(function) -> _click_option_decorator_type:
             type=str,
             envvar=EnvironmentVariables.AUTH_USERNAME,
             help="Username used for authentication.  May not be used by all authentication mechanisms.",
-            default=None,
+            default=default,
             show_envvar=True,
             show_default=True,
             hidden=hidden,  # Primarily used by legacy auth.  OAuth2 is preferred, wherein we do not handle username/password.
@@ -473,7 +473,7 @@ def decorator(function) -> _click_option_decorator_type:
     return decorator
 
 
-def opt_yes_no() -> _click_option_decorator_type:
+def opt_yes_no(default=None) -> _click_option_decorator_type:
     """
     Click option to bypass prompts with a yes or no selection.
     """
@@ -483,7 +483,7 @@ def decorator(function) -> _click_option_decorator_type:
             "--yes/--no",
             "-y/-n",
             help='Skip user prompts with a "yes" or "no" selection',
-            default=None,
+            default=default,
             show_default=True,
         )(function)
         return function