forked from Azure/azure-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Removed now defunct 'unexpected parameters' parameter for all comma…
…nd handlers - Fixed up storage account/key/connection string parameter combinations where they were accidentally set to always be required when they in fact are part of mutually exclusive parameter sets. We need to handle this better in the future - Renamed 'options' to 'arguments' in our command table. - Fixed up resource group alias (from --rg to -g) - Refactored application/session/configuration/command loading. The command package is now responsible for loading submodules. Renamed session to configuration and made it responsible for knowing what hints to give to the command modules in order to load the right set of modules. Moved event registreation and raising from what was previously the session object to the application object. - Moved transforming of returned SDK objects from Output to the Application module and made output only responsible for figuring out which formatter to use
- Loading branch information
Showing
21 changed files
with
220 additions
and
432 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| applicationinsights==0.10.0 | ||
| argcomplete==1.1.0 | ||
| azure==2.0.0rc1 | ||
| jmespath | ||
| mock==1.3.0 | ||
|
|
||
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,75 +1,133 @@ | ||
| from collections import defaultdict | ||
| from datetime import datetime | ||
| import sys | ||
| import re | ||
| import argparse | ||
| import logging | ||
| from enum import Enum | ||
| from .parser import AzCliCommandParser | ||
| import argcomplete | ||
| import logging | ||
| from ._event_dispatcher import EventDispatcher | ||
| import azure.cli.extensions | ||
|
|
||
| class Session(EventDispatcher): | ||
| """The session object tracks session specific data such | ||
| as output formats, log settings as well as providing an | ||
| event dispatch mechanism that allows us to make modifications | ||
| during the execution of a command | ||
| class Configuration(object): # pylint: disable=too-few-public-methods | ||
| """The configuration object tracks session specific data such | ||
| as output formats, available commands etc. | ||
| """ | ||
| def __init__(self): | ||
| super(Session, self).__init__() | ||
| def __init__(self, argv=None): | ||
| self.argv = argv or sys.argv | ||
| self.log = logging.getLogger('az') | ||
| self.output_format = 'list' | ||
|
|
||
| def get_command_table(self): | ||
| import azure.cli.commands as commands | ||
|
|
||
| # Find the first noun on the command line and only load commands from that | ||
| # module to improve startup time. | ||
| for a in self.argv: | ||
| if not a.startswith('-'): | ||
| return commands.get_command_table(a) | ||
|
|
||
| # No noun found, so load all commands. | ||
| return commands.get_command_table() | ||
|
|
||
| class Application(object): | ||
|
|
||
| def __init__(self, session=None): | ||
| self.session = session or Session() | ||
| TRANSFORM_RESULT = 'Application.TransformResults' | ||
| FILTER_RESULT = 'Application.FilterResults' | ||
| GLOBAL_PARSER_CREATED = 'GlobalParser.Created' | ||
| COMMAND_PARSER_CREATED = 'CommandParser.Created' | ||
| COMMAND_PARSER_LOADED = 'CommandParser.Loaded' | ||
| COMMAND_PARSER_PARSED = 'CommandParser.Parsed' | ||
|
|
||
| def __init__(self, configuration=None): | ||
| self._event_handlers = defaultdict(lambda: []) | ||
| self.configuration = configuration or Configuration() | ||
|
|
||
| # Register presence of and handlers for global parameters | ||
| self.session.register('GlobalParser.Created', self._register_builtin_arguments) | ||
| self.session.register('CommandParser.Parsed', self._handle_builtin_arguments) | ||
| self.register(self.GLOBAL_PARSER_CREATED, Application._register_builtin_arguments) | ||
| self.register(self.COMMAND_PARSER_LOADED, Application._enable_autocomplete) | ||
| self.register(self.COMMAND_PARSER_PARSED, self._handle_builtin_arguments) | ||
|
|
||
| # Let other extensions make their presence known | ||
| azure.cli.extensions.register_extensions(self) | ||
|
|
||
| self.global_parser = AzCliCommandParser(prog='az', add_help=False) | ||
| self.session.raise_event('GlobalParser.Created', self.global_parser) | ||
| self.raise_event(self.GLOBAL_PARSER_CREATED, self.global_parser) | ||
|
|
||
| self.parser = AzCliCommandParser(prog='az', parents=[self.global_parser]) | ||
| self.session.raise_event('CommandParser.Created', self.parser) | ||
|
|
||
| def load_commands(self, argv): | ||
| import azure.cli.commands as commands | ||
|
|
||
| # Find the first noun on the command line and only load commands from that | ||
| # module to improve startup time. | ||
| for a in argv: | ||
| if not a.startswith('-'): | ||
| commands.add_to_parser(self.parser, self.session, a) | ||
| break | ||
| else: | ||
| # No noun found, so load all commands. | ||
| commands.add_to_parser(self.parser, self.session) | ||
| self.raise_event(self.COMMAND_PARSER_CREATED, self.parser) | ||
|
|
||
| self.session.raise_event('CommandParser.Loaded', self.parser) | ||
| argcomplete.autocomplete(self.parser) | ||
| def load_commands(self): | ||
| self.parser.load_command_table(self.configuration.get_command_table()) | ||
| self.raise_event(self.COMMAND_PARSER_LOADED, self.parser) | ||
|
|
||
| def execute(self, argv): | ||
| args = self.parser.parse_args(argv) | ||
| self.session.raise_event('CommandParser.Parsed', args) | ||
| self.raise_event(self.COMMAND_PARSER_PARSED, args) | ||
|
|
||
| # Consider - we are using any args that start with an underscore (_) as 'private' | ||
| # arguments and remove them from the arguments that we pass to the actual function. | ||
| # This does not feel quite right. | ||
| params = dict([(key, value) | ||
| for key, value in args.__dict__.items() if not key.startswith('_')]) | ||
| result = args.func(params, {}) # TODO: Unexpected parameters passed in? | ||
| return result | ||
| result = args.func(params) | ||
|
|
||
| result = self.todict(result) | ||
| event_data = {'result': result} | ||
| self.raise_event(self.TRANSFORM_RESULT, event_data) | ||
| self.raise_event(self.FILTER_RESULT, event_data) | ||
| return event_data['result'] | ||
|
|
||
| def raise_event(self, name, event_data): | ||
| '''Raise the event `name`. | ||
| ''' | ||
| for func in self._event_handlers[name]: | ||
| func(event_data) | ||
|
|
||
| def register(self, name, handler): | ||
| '''Register a callable that will be called when the | ||
| event `name` is raised. | ||
| param: name: The name of the event | ||
| param: handler: Function that takes two parameters; | ||
| name: name of the event raised | ||
| event_data: `dict` with event specific data. | ||
| ''' | ||
| self._event_handlers[name].append(handler) | ||
|
|
||
| def _register_builtin_arguments(self, name, parser): | ||
| KEYS_CAMELCASE_PATTERN = re.compile('(?!^)_([a-zA-Z])') | ||
| def todict(self, obj): #pylint: disable=too-many-return-statements | ||
|
|
||
| def to_camelcase(s): | ||
| return re.sub(Application.KEYS_CAMELCASE_PATTERN, lambda x: x.group(1).upper(), s) | ||
|
|
||
| if isinstance(obj, dict): | ||
| return {k: self.todict(v) for (k, v) in obj.items()} | ||
| elif isinstance(obj, list): | ||
| return [self.todict(a) for a in obj] | ||
| elif isinstance(obj, Enum): | ||
| return obj.value | ||
| elif isinstance(obj, datetime): | ||
| return obj.isoformat() | ||
| elif hasattr(obj, '_asdict'): | ||
| return self.todict(obj._asdict()) | ||
| elif hasattr(obj, '__dict__'): | ||
| return dict([(to_camelcase(k), self.todict(v)) | ||
| for k, v in obj.__dict__.items() | ||
| if not callable(v) and not k.startswith('_')]) | ||
| else: | ||
| return obj | ||
|
|
||
| @staticmethod | ||
| def _enable_autocomplete(parser): | ||
| import argcomplete | ||
| argcomplete.autocomplete(parser) | ||
|
|
||
| @staticmethod | ||
| def _register_builtin_arguments(parser): | ||
| parser.add_argument('--subscription', dest='_subscription_id', help=argparse.SUPPRESS) | ||
| parser.add_argument('--output', '-o', dest='_output_format', choices=['list', 'json']) | ||
|
|
||
| def _handle_builtin_arguments(self, name, args): | ||
| try: | ||
| self.session.output_format = args._output_format #pylint: disable=protected-access | ||
| del args._output_format | ||
| except Exception: | ||
| pass | ||
| parser.add_argument('--output', '-o', dest='_output_format', choices=['list', 'json'], | ||
| help=argparse.SUPPRESS) | ||
|
|
||
| def _handle_builtin_arguments(self, args): | ||
| self.configuration.output_format = args._output_format #pylint: disable=protected-access | ||
| del args._output_format |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.