change: make --show-sensitive-info work with click

show-sensitive-info is now shared between all commands
even if the argument was added to a last command.

Author: peterdragun

espefuse/cli_util.py

@@ -128,7 +128,19 @@ def _process_args_for_args(self, state: ParsingState) -> None:
         state.rargs = []
 
 
+class EfuseContext(click.RichContext):
+    @property
+    def show_sensitive_info(self) -> bool:
+        self.ensure_object(dict)
+        value: bool = self.obj.get("show_sensitive_info", False)
+        if not value:
+            log.print("Sensitive data will be hidden (see --show-sensitive-info)")
+        return value
+
+
 class ChainingCommand(click.RichCommand, click.Command):
+    context_class = EfuseContext
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
@@ -190,6 +202,7 @@ class Group(EsptoolGroup):
     }
 
     command_class = ChainingCommand
+    context_class = EfuseContext
 
     @staticmethod
     def _split_to_groups(args: list[str]) -> tuple[list[list[str]], list[str]]:

espefuse/efuse/base_operations.py

@@ -143,13 +143,10 @@ def callback(ctx: click.Context, param: click.Parameter, value: str):
 
 
 def add_show_sensitive_info_option(function: Callable):
-    # TODO: originally this parameter worked for all commands even if it was
-    # specified for a one of them
     def callback(ctx: click.Context, param: click.Parameter, value: bool):
-        if value or ctx.obj.get("debug"):
+        if value or ctx.obj.get("debug") or ctx.obj.get("show_sensitive_info", False):
             value = True
-        else:
-            print("Sensitive data will be hidden (see --show-sensitive-info)")
+        ctx.obj["show_sensitive_info"] = value
         return value
 
     return click.option(
@@ -158,6 +155,7 @@ def callback(ctx: click.Context, param: click.Parameter, value: bool):
         "Enabled if --debug is used.",
         is_flag=True,
         callback=callback,
+        expose_value=True,  # ensure that callback is called even if option is not used
     )(function)
 
 

espefuse/efuse/esp32/operations.py

@@ -52,8 +52,12 @@ def add_cli_commands(self, cli: click.Group):
         )
         @add_force_write_always
         @add_show_sensitive_info_option
-        def burn_key_cli(block_keyfile, no_protect_key, show_sensitive_info, **kwargs):
+        @click.pass_context
+        def burn_key_cli(
+            ctx, block_keyfile, no_protect_key, show_sensitive_info, **kwargs
+        ):
             block, keyfile = zip(*block_keyfile)
+            show_sensitive_info = ctx.show_sensitive_info
             self.burn_key(block, keyfile, no_protect_key, show_sensitive_info)
 
         @cli.command(
@@ -74,6 +78,7 @@ def burn_key_cli(block_keyfile, no_protect_key, show_sensitive_info, **kwargs):
         def burn_key_digest_cli(
             ctx, keyfile, no_protect_key, show_sensitive_info, **kwargs
         ):
+            kwargs["show_sensitive_info"] = ctx.show_sensitive_info
             self.burn_key_digest(
                 ctx.obj["esp"], keyfile, no_protect_key, show_sensitive_info
             )

espefuse/efuse/esp32c2/operations.py

@@ -55,10 +55,12 @@ def add_cli_commands(self, cli: click.Group):
         @protect_options
         @add_force_write_always
         @add_show_sensitive_info_option
-        def burn_key_cli(**kwargs):
+        @click.pass_context
+        def burn_key_cli(ctx, **kwargs):
             """Burn the key block with the specified name"""
             block, keyfile, keypurpose = zip(*kwargs.pop("block_keyfile_keypurpose"))
             kwargs.pop("force_write_always")
+            kwargs["show_sensitive_info"] = ctx.show_sensitive_info
             self.burn_key(block, keyfile, keypurpose, **kwargs)
 
         @cli.command(
@@ -71,8 +73,10 @@ def burn_key_cli(**kwargs):
         @protect_options
         @add_force_write_always
         @add_show_sensitive_info_option
-        def burn_key_digest_cli(**kwargs):
+        @click.pass_context
+        def burn_key_digest_cli(ctx, **kwargs):
             kwargs.pop("force_write_always")
+            kwargs["show_sensitive_info"] = ctx.show_sensitive_info
             self.burn_key_digest(**kwargs)
 
     ###################################### Commands ######################################

espefuse/efuse/esp32c3/operations.py

@@ -56,9 +56,11 @@ def add_cli_commands(self, cli: click.Group):
         @protect_options
         @add_force_write_always
         @add_show_sensitive_info_option
-        def burn_key_cli(**kwargs):
+        @click.pass_context
+        def burn_key_cli(ctx, **kwargs):
             block, keyfile, keypurpose = zip(*kwargs.pop("block_keyfile_keypurpose"))
             kwargs.pop("force_write_always")
+            kwargs["show_sensitive_info"] = ctx.show_sensitive_info
             self.burn_key(block, keyfile, keypurpose, **kwargs)
 
         @cli.command(
@@ -86,9 +88,11 @@ def burn_key_cli(**kwargs):
         @protect_options
         @add_force_write_always
         @add_show_sensitive_info_option
-        def burn_key_digest_cli(**kwargs):
+        @click.pass_context
+        def burn_key_digest_cli(ctx, **kwargs):
             block, keyfile, keypurpose = zip(*kwargs.pop("block_keyfile_keypurpose"))
             kwargs.pop("force_write_always")
+            kwargs["show_sensitive_info"] = ctx.show_sensitive_info
             self.burn_key_digest(block, keyfile, keypurpose, **kwargs)
 
     ###################################### Commands ######################################

espefuse/efuse/esp32c5/operations.py

@@ -55,9 +55,11 @@ def add_cli_commands(self, cli: click.Group):
         @protect_options
         @add_force_write_always
         @add_show_sensitive_info_option
-        def burn_key_cli(**kwargs):
+        @click.pass_context
+        def burn_key_cli(ctx, **kwargs):
             kwargs.pop("force_write_always")
             block, keyfile, keypurpose = zip(*kwargs.pop("block_keyfile_keypurpose"))
+            kwargs["show_sensitive_info"] = ctx.show_sensitive_info
             self.burn_key(block, keyfile, keypurpose, **kwargs)
 
         @cli.command(
@@ -85,9 +87,11 @@ def burn_key_cli(**kwargs):
         @protect_options
         @add_force_write_always
         @add_show_sensitive_info_option
-        def burn_key_digest_cli(**kwargs):
+        @click.pass_context
+        def burn_key_digest_cli(ctx, **kwargs):
             kwargs.pop("force_write_always")
             block, keyfile, keypurpose = zip(*kwargs.pop("block_keyfile_keypurpose"))
+            kwargs["show_sensitive_info"] = ctx.show_sensitive_info
             self.burn_key_digest(block, keyfile, keypurpose, **kwargs)
 
     ###################################### Commands ######################################

espefuse/efuse/esp32c6/operations.py

@@ -54,9 +54,11 @@ def add_cli_commands(self, cli: click.Group):
         @protect_options
         @add_force_write_always
         @add_show_sensitive_info_option
-        def burn_key_cli(**kwargs):
+        @click.pass_context
+        def burn_key_cli(ctx, **kwargs):
             kwargs.pop("force_write_always")
             block, keyfile, keypurpose = zip(*kwargs.pop("block_keyfile_keypurpose"))
+            kwargs["show_sensitive_info"] = ctx.show_sensitive_info
             self.burn_key(block, keyfile, keypurpose, **kwargs)
 
         @cli.command(
@@ -84,9 +86,11 @@ def burn_key_cli(**kwargs):
         @protect_options
         @add_force_write_always
         @add_show_sensitive_info_option
-        def burn_key_digest_cli(**kwargs):
+        @click.pass_context
+        def burn_key_digest_cli(ctx, **kwargs):
             kwargs.pop("force_write_always")
             block, keyfile, keypurpose = zip(*kwargs.pop("block_keyfile_keypurpose"))
+            kwargs["show_sensitive_info"] = ctx.show_sensitive_info
             self.burn_key_digest(block, keyfile, keypurpose, **kwargs)
 
     ###################################### Commands ######################################

espefuse/efuse/esp32c61/operations.py

@@ -56,9 +56,11 @@ def add_cli_commands(self, cli: click.Group):
         @protect_options
         @add_force_write_always
         @add_show_sensitive_info_option
-        def burn_key_cli(**kwargs):
+        @click.pass_context
+        def burn_key_cli(ctx, **kwargs):
             kwargs.pop("force_write_always")
             block, keyfile, keypurpose = zip(*kwargs.pop("block_keyfile_keypurpose"))
+            kwargs["show_sensitive_info"] = ctx.show_sensitive_info
             self.burn_key(block, keyfile, keypurpose, **kwargs)
 
         @cli.command(
@@ -86,9 +88,11 @@ def burn_key_cli(**kwargs):
         @protect_options
         @add_force_write_always
         @add_show_sensitive_info_option
-        def burn_key_digest_cli(**kwargs):
+        @click.pass_context
+        def burn_key_digest_cli(ctx, **kwargs):
             kwargs.pop("force_write_always")
             block, keyfile, keypurpose = zip(*kwargs.pop("block_keyfile_keypurpose"))
+            kwargs["show_sensitive_info"] = ctx.show_sensitive_info
             self.burn_key_digest(block, keyfile, keypurpose, **kwargs)
 
     ###################################### Commands ######################################

espefuse/efuse/esp32h2/operations.py

@@ -54,9 +54,11 @@ def add_cli_commands(self, cli: click.Group):
         @protect_options
         @add_force_write_always
         @add_show_sensitive_info_option
-        def burn_key_cli(**kwargs):
+        @click.pass_context
+        def burn_key_cli(ctx, **kwargs):
             kwargs.pop("force_write_always")
             block, keyfile, keypurpose = zip(*kwargs.pop("block_keyfile_keypurpose"))
+            kwargs["show_sensitive_info"] = ctx.show_sensitive_info
             self.burn_key(block, keyfile, keypurpose, **kwargs)
 
         @cli.command(
@@ -84,9 +86,11 @@ def burn_key_cli(**kwargs):
         @protect_options
         @add_force_write_always
         @add_show_sensitive_info_option
-        def burn_key_digest_cli(**kwargs):
+        @click.pass_context
+        def burn_key_digest_cli(ctx, **kwargs):
             kwargs.pop("force_write_always")
             block, keyfile, keypurpose = zip(*kwargs.pop("block_keyfile_keypurpose"))
+            kwargs["show_sensitive_info"] = ctx.show_sensitive_info
             self.burn_key_digest(block, keyfile, keypurpose, **kwargs)
 
     ###################################### Commands ######################################

espefuse/efuse/esp32h21/operations.py

@@ -54,9 +54,11 @@ def add_cli_commands(self, cli: click.Group):
         @protect_options
         @add_force_write_always
         @add_show_sensitive_info_option
-        def burn_key_cli(**kwargs):
+        @click.pass_context
+        def burn_key_cli(ctx, **kwargs):
             kwargs.pop("force_write_always")
             block, keyfile, keypurpose = zip(*kwargs.pop("block_keyfile_keypurpose"))
+            kwargs["show_sensitive_info"] = ctx.show_sensitive_info
             self.burn_key(block, keyfile, keypurpose, **kwargs)
 
         @cli.command(
@@ -84,9 +86,11 @@ def burn_key_cli(**kwargs):
         @protect_options
         @add_force_write_always
         @add_show_sensitive_info_option
-        def burn_key_digest_cli(**kwargs):
+        @click.pass_context
+        def burn_key_digest_cli(ctx, **kwargs):
             kwargs.pop("force_write_always")
             block, keyfile, keypurpose = zip(*kwargs.pop("block_keyfile_keypurpose"))
+            kwargs["show_sensitive_info"] = ctx.show_sensitive_info
             self.burn_key_digest(block, keyfile, keypurpose, **kwargs)
 
     ###################################### Commands ######################################