Add a default_value_source property in HelpParameter (#202)

* Add a default_from property in HelpParameter * fix naming problem * update Configure to Config
microsoft · May 8, 2020 · fe3bf5d · fe3bf5d
1 parent 2e198ce
commit fe3bf5d
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 5 deletions.
diff --git a/knack/arguments.py b/knack/arguments.py
@@ -45,7 +45,7 @@ def update(self, other=None, **kwargs):
 class CLICommandArgument(object):
 
     NAMED_ARGUMENTS = ['options_list', 'validator', 'completer', 'arg_group', 'deprecate_info', 'preview_info',
-                       'experimental_info']
+                       'experimental_info', 'default_value_source']
 
     def __init__(self, dest=None, argtype=None, **kwargs):
         """An argument that has a specific destination parameter.

diff --git a/knack/commands.py b/knack/commands.py
@@ -99,6 +99,7 @@ def _resolve_default_value_from_config_file(self, arg, overrides):
             logger.info("Configured default '%s' for arg %s", config_value, arg.name)
             overrides.settings['default'] = DefaultStr(config_value)
             overrides.settings['required'] = False
+            overrides.settings['default_value_source'] = 'Config'
 
     def load_arguments(self):
         if self.arguments_loader:

diff --git a/knack/help.py b/knack/help.py
@@ -319,7 +319,8 @@ def _add_parameter_help(self, param):
             'name_source': normal_options,
             'deprecate_info': getattr(param, 'deprecate_info', None),
             'preview_info': getattr(param, 'preview_info', None),
-            'experimental_info': getattr(param, 'experimental_info', None)
+            'experimental_info': getattr(param, 'experimental_info', None),
+            'default_value_source': getattr(param, 'default_value_source', None)
         })
         self.parameters.append(HelpParameter(**param_kwargs))
 
@@ -342,8 +343,8 @@ def _load_from_data(self, data):
 
 class HelpParameter(HelpObject):  # pylint: disable=too-many-instance-attributes
 
-    def __init__(self, name_source, description, required, choices=None,
-                 default=None, group_name=None, deprecate_info=None, preview_info=None, experimental_info=None):
+    def __init__(self, name_source, description, required, choices=None, default=None, group_name=None,
+                 deprecate_info=None, preview_info=None, experimental_info=None, default_value_source=None):
         super(HelpParameter, self).__init__()
         self.name_source = name_source
         self.name = ' '.join(sorted(name_source))
@@ -358,6 +359,7 @@ def __init__(self, name_source, description, required, choices=None,
         self.deprecate_info = deprecate_info
         self.preview_info = preview_info
         self.experimental_info = experimental_info
+        self.default_value_source = default_value_source
 
     def update_from_data(self, data):
         if self.name != data.get('name'):

diff --git a/knack/parser.py b/knack/parser.py
@@ -27,7 +27,8 @@
     'required',
     'help',
     'metavar',
-    'action'
+    'action',
+    'default_value_source'
 ]
 
 
@@ -174,6 +175,7 @@ def load_command_table(self, command_loader):
                 param.deprecate_info = arg.deprecate_info
                 param.preview_info = arg.preview_info
                 param.experimental_info = arg.experimental_info
+                param.default_value_source = arg.default_value_source
             command_parser.set_defaults(
                 func=metadata,
                 command=command_name,