Skip to content

{Core} Change help example hook #12431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jiasli merged 11 commits into from
Mar 6, 2020
Merged

{Core} Change help example hook #12431

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
7d11c49
Remove EUII information from az find telemetry
mirdaki-ms Jan 27, 2020
037c98d
Merge remote-tracking branch 'upstream/dev' into dev
mirdaki-ms Feb 25, 2020
13557e8
Merge remote-tracking branch 'upstream/dev' into dev
mirdaki-ms Feb 28, 2020
a1b71b1
Working version of new example replacement
mirdaki-ms Mar 2, 2020
e6784f8
Update hook method to be simpler
mirdaki-ms Mar 3, 2020
f8ed94b
Removed old hook
mirdaki-ms Mar 3, 2020
e6a7220
Style fix
mirdaki-ms Mar 3, 2020
ac226a0
Update the hook to take and use the built in examples
mirdaki-ms Mar 4, 2020
eabdcbb
Switch to custom implementation of `show_help`
mirdaki-ms Mar 4, 2020
c3dae5e
Better signature
mirdaki-ms Mar 6, 2020
af72048
Update by reference
mirdaki-ms Mar 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions src/azure-cli-core/azure/cli/core/_help.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ def _print_examples(help_file):
from colorama import Style
indent = 0
_print_indent('Examples', indent)
for e in AzCliHelp.example_provider(help_file):
for e in help_file.examples:
indent = 1
_print_indent(u'{0}'.format(e.short_summary), indent)
indent = 2
Expand Down Expand Up @@ -147,10 +147,21 @@ def new_normalize_text(s):
self._register_help_loaders()
self._name_to_content = {}

# override
def show_help(self, cli_name, nouns, parser, is_group):
self.update_loaders_with_help_file_contents(nouns)
super(AzCliHelp, self).show_help(cli_name, nouns, parser, is_group)

import colorama
colorama.init(autoreset=True)
delimiters = ' '.join(nouns)
help_file = self.command_help_cls(self, delimiters, parser) if not is_group \
else self.group_help_cls(self, delimiters, parser)
help_file.load(parser)
if not nouns:
help_file.command = ''
else:
AzCliHelp.update_examples(help_file)
self._print_detailed_help(cli_name, help_file)

print(SURVEY_PROMPT)

def _register_help_loaders(self):
Expand Down Expand Up @@ -192,8 +203,8 @@ def update_loaders_with_help_file_contents(self, nouns):

# This method is meant to be a hook that can be overridden by an extension or module.
@staticmethod
def example_provider(help_file):
return help_file.examples
def update_examples(help_file):
pass


class CliHelpFile(KnackHelpFile):
Expand Down