Skip to content

refactoring python code for alias loader #9235

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

refactoring python code for alias loader #9235

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
71 changes: 29 additions & 42 deletions awscli/alias.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@
# language governing permissions and limitations under the License.
import logging
import os
import shlex
import re
import subprocess
from concurrent.futures import ThreadPoolExecutor

from botocore.configloader import raw_config_parse

Expand Down Expand Up @@ -42,21 +43,24 @@ def __init__(
"""
self._filename = alias_filename
self._aliases = None
self._last_modified = None

def _build_aliases(self):
self._aliases = self._load_aliases()
self._cleanup_alias_values(self._aliases.get('toplevel', {}))

def _load_aliases(self):
if os.path.exists(self._filename):
last_modified = os.path.getmtime(self._filename)
if self._last_modified == last_modified:
return self._aliases
self._last_modified = last_modified
return raw_config_parse(self._filename, parse_subsections=False)
return {'toplevel': {}}

def _cleanup_alias_values(self, aliases):
for alias in aliases:
# Beginning and end line separators should not be included
# in the internal representation of the alias value.
aliases[alias] = aliases[alias].strip()
aliases.update({alias: value.strip() for alias, value in aliases.items()})


def get_aliases(self):
if self._aliases is None:
Expand All @@ -78,29 +82,19 @@ def __init__(self, session, alias_loader):
self._alias_loader = alias_loader

def inject_aliases(self, command_table, parser):
for (
alias_name,
alias_value,
) in self._alias_loader.get_aliases().items():
if alias_value.startswith('!'):
alias_cmd = ExternalAliasCommand(alias_name, alias_value)
else:
service_alias_cmd_args = [
alias_name,
alias_value,
self._session,
command_table,
parser,
]
# If the alias name matches something already in the
# command table provide the command it is about
# to clobber as a possible reference that it will
# need to proxy to.
if alias_name in command_table:
service_alias_cmd_args.append(command_table[alias_name])
alias_cmd = ServiceAliasCommand(*service_alias_cmd_args)
command_table[alias_name] = alias_cmd

aliases = self._alias_loader.get_aliases()
if not aliases:
return
with ThreadPoolExecutor() as executor:
def add_alias(alias):
alias_name, alias_value = alias
if alias_value.startswith('!'):
command_table[alias_name] = ExternalAliasCommand(alias_name, alias_value)
else:
command_table[alias_name] = ServiceAliasCommand(
alias_name, alias_value, self._session, command_table, parser
)
executor.map(add_alias, aliases.items())

class BaseAliasCommand(CLICommand):
_UNDOCUMENTED = True
Expand Down Expand Up @@ -180,9 +174,7 @@ def __init__(

def __call__(self, args, parsed_globals):
alias_args = self._get_alias_args()
parsed_alias_args, remaining = self._parser.parse_known_args(
alias_args
)
parsed_alias_args, remaining = self._parser.parse_known_args(alias_args)
self._update_parsed_globals(parsed_alias_args, parsed_globals)
# Take any of the remaining arguments that were not parsed out and
# prepend them to the remaining args provided to the alias.
Expand Down Expand Up @@ -212,13 +204,12 @@ def __call__(self, args, parsed_globals):

def _get_alias_args(self):
try:
alias_args = shlex.split(self._alias_value)
alias_args = re.split(r'\s+', self._alias_value.strip())
except ValueError as e:
raise InvalidAliasException(
f'Value of alias "{self._alias_name}" could not be parsed. '
f'Received error: {e} when parsing:\n{self._alias_value}'
)

alias_args = [arg.strip(os.linesep) for arg in alias_args]
LOG.debug(
'Expanded subcommand alias %r with value: %r to: %r',
Expand All @@ -239,8 +230,7 @@ def _update_parsed_globals(self, parsed_alias_args, parsed_globals):
# and passing those onto subsequent commands.
emit_top_level_args_parsed_event(self._session, parsed_alias_args)
for param_name in global_params_to_update:
updated_param_value = getattr(parsed_alias_args, param_name)
setattr(parsed_globals, param_name, updated_param_value)
setattr(parsed_globals, param_name, getattr(parsed_alias_args, param_name))

def _get_global_parameters_to_update(self, parsed_alias_args):
# Retrieve a list of global parameters that the newly parsed args
Expand All @@ -260,8 +250,7 @@ def _get_global_parameters_to_update(self, parsed_alias_args):
f'"{self._alias_name}" which is not support in '
'subcommand aliases.'
)
else:
global_params_to_update.append(parsed_param)
global_params_to_update.append(parsed_param)
return global_params_to_update


Expand All @@ -283,18 +272,16 @@ def __init__(self, alias_name, alias_value, invoker=subprocess.call):
:param invoker: Callable to run arguments of external alias. The
signature should match that of ``subprocess.call``
"""
self._alias_name = alias_name
self._alias_value = alias_value
super().__init__(alias_name, alias_value)
self._invoker = invoker

def __call__(self, args, parsed_globals):
command_components = [self._alias_value[1:]]
command_components.extend(compat_shell_quote(a) for a in args)
command = ' '.join(command_components)
LOG.debug(
'Using external alias %r with value: %r to run: %r',
self._alias_name,
self._alias_value,
command,
command_components,
)
return self._invoker(command, shell=True)
return self._invoker(command_components)