Skip to content

Commit

Permalink
feat(ZNTA-2729): release RPM in Zanata_Team Repo
Browse files Browse the repository at this point in the history
  • Loading branch information
@definite
definite committed Sep 3, 2018
1 parent 9b525af commit 22c389c
Show file tree
Hide file tree
Showing 6 changed files with 665 additions and 80 deletions.
107 changes: 79 additions & 28 deletions ZanataArgParser.py
View file
Expand Up @@ -15,7 +15,7 @@
import re
import sys

from argparse import ArgumentParser, ArgumentError
from argparse import ArgumentParser, ArgumentError, RawDescriptionHelpFormatter
# Following are for mypy
from argparse import Action # noqa: F401 # pylint: disable=W0611
from argparse import Namespace # noqa: F401 # pylint: disable=W0611
Expand All @@ -30,16 +30,32 @@
sys.stderr.write("python typing module is not installed" + os.linesep)


class NoSuchMethodError(Exception):
"""Method does not exist
Args:
method_name (str): Name of the method
"""
def __init__(self, method_name):
super(NoSuchMethodError, self).__init__()
self.method_name = method_name

def __str__(self):
return "No such method: %s" % self.method_name


class ColoredFormatter(logging.Formatter):
"""Log colored formated
Inspired from KurtJacobson's colored_log.py"""
DEFAULT_COLOR = 37 # white
MAPPING = {
'DEBUG': DEFAULT_COLOR,
'INFO': 36, # cyan
'WARNING': 33, # yellow
'ERROR': 31, # red
'CRITICAL': 41} # white on red bg
# Background ASCII color
bg = os.getenv("LOGGING_BG_COLOR", 40) # Default black background

COLOR_MAPPING = {
'DEBUG': [os.getenv("LOGGING_DEBUG_COLOR", 37), bg], # white
'INFO': [os.getenv("LOGGING_INFO_COLOR", 36), bg], # cyan
'WARNING': [os.getenv("LOGGING_WARNING_COLOR", 33), bg], # yellow
'ERROR': [os.getenv("LOGGING_ERROR_COLOR", 31), bg], # red
'CRITICAL': [37, 41]} # white on red bg

PREFIX = '\033['
SUFFIX = '\033[0m'
Expand All @@ -48,19 +64,17 @@ def __init__(self, patern):
logging.Formatter.__init__(self, patern)

@staticmethod
def _color(color_id, content):
return "\033[%dm%s\033[0m" % (color_id, content)
def _color(colors, content):
return "\033[%d;%dm%s\033[0m" % (colors[0], colors[1], content)

def format(self, record):
color_id = ColoredFormatter.MAPPING.get(
record.levelname, ColoredFormatter.DEFAULT_COLOR)
record.levelname = ColoredFormatter._color(
color_id, record.levelname)
record.message = ColoredFormatter._color(
color_id, record.getMessage())
colors = ColoredFormatter.COLOR_MAPPING.get(
record.levelname, ColoredFormatter.COLOR_MAPPING['DEBUG'])
record.levelname = ColoredFormatter._color(colors, record.levelname)
record.message = ColoredFormatter._color(colors, record.getMessage())
if self.usesTime():
record.asctime = ColoredFormatter._color(
color_id, self.formatTime(record, self.datefmt))
colors, self.formatTime(record, self.datefmt))
try:
s = self._fmt % record.__dict__
except UnicodeDecodeError as e:
Expand Down Expand Up @@ -93,10 +107,30 @@ def format(self, record):


class ZanataArgParser(ArgumentParser):
"""Zanata Argument Parser"""
"""Zanata Argument Parser that support sub-commands and environment
Examples:
>>> import ZanataArgParser
>>> parser = ZanataArgParser.ZanataArgParser('my-prog')
>>> parser.add_common_argument('-b', '--branch', default='master')
>>> parser.add_sub_command('list', None, None)
>>> args = parser.parse_all(['list', '-b', 'release'])
>>> print(args.sub_command)
list
>>> print(args.branch)
release
>>> args2 = parser.parse_all(['list'])
>>> print(args2.branch)
master
"""

def __init__(self, *args, **kwargs):
# type: (Any, Any) -> None
super(ZanataArgParser, self).__init__(*args, **kwargs)
# Ignore mypy "ArgumentParser" gets multiple values for keyword
# argument "formatter_class"
# See https://github.com/python/mypy/issues/1028
super(ZanataArgParser, self).__init__(
*args, formatter_class=RawDescriptionHelpFormatter, **kwargs)
self.env_def = {} # type: Dict[str, dict]
self.parent_parser = ArgumentParser(add_help=False)
self.add_argument(
Expand All @@ -105,7 +139,7 @@ def __init__(self, *args, **kwargs):
help='Valid values: %s'
% 'DEBUG, INFO, WARNING, ERROR, CRITICAL, NONE')

self.sub_parsers = None
self.sub_parsers = None # type: _SubParsersAction
self.sub_command_obj_dict = {} # type: Dict[str, Any]

def add_common_argument(self, *args, **kwargs):
Expand All @@ -117,17 +151,15 @@ def add_common_argument(self, *args, **kwargs):
self.parent_parser.add_argument(*args, **kwargs)

def add_sub_command(self, name, arguments, obj=None, **kwargs):
# type: (str, List, Any, Any) -> ArgumentParser
# type: (str, List, Any, Any) -> None
"""Add a sub command
Args:
name (str): name of the sub-command
arguments (dict): argments to be passed to argparse.add_argument()
obj (Any, optional): Defaults to None. The sub_command is
a method of the obj.
Returns:
[type]: [description]
kwargs (Any, optional): other arguments for add_parser
"""
if not self.sub_parsers:
self.sub_parsers = self.add_subparsers(
Expand All @@ -153,7 +185,6 @@ def add_sub_command(self, name, arguments, obj=None, **kwargs):
else:
anonymous_parser.add_argument(*k.split())
anonymous_parser.set_defaults(sub_command=name)
return anonymous_parser

def add_env( # pylint: disable=too-many-arguments
self, env_name,
Expand Down Expand Up @@ -181,12 +212,12 @@ def add_env( # pylint: disable=too-many-arguments
'dest': dest,
'sub_commands': sub_commands}

def add_methods_as_subcommands(self, obj, name_pattern='.*'):
def add_methods_as_sub_commands(self, obj, name_pattern='.*'):
# type (Any, str) -> None
"""Add public methods as sub-commands
Args:
obj ([type]): Public methods of obj will be used
cls ([type]): Public methods of obj will be used
name_pattern (str, optional): Defaults to '.*'.
Method name should match the pattern.
"""
Expand All @@ -205,6 +236,11 @@ def add_methods_as_subcommands(self, obj, name_pattern='.*'):
if not inspect.ismethod(m_obj) and not inspect.isfunction(m_obj):
continue

if name == 'init_from_parsed_args':
# init_from_parsed_args initialize from parsed args.
# No need to be in sub-commands
continue

argspec = inspect.getargspec(m_obj)
sub_args = None
try:
Expand All @@ -229,7 +265,9 @@ def add_methods_as_subcommands(self, obj, name_pattern='.*'):
name,
sub_args,
obj,
help=obj.__doc__)
help=re.sub(
"\n.*$", "", m_obj.__doc__, flags=re.MULTILINE),
description=m_obj.__doc__)

def has_common_argument(self, option_string=None, dest=None):
# type: (str, str) -> bool
Expand Down Expand Up @@ -359,6 +397,13 @@ def run_sub_command(self, args=None):
"sub-command %s is not associated with any object" %
args.sub_command)
obj = self.sub_command_obj_dict[args.sub_command]
if inspect.isclass(obj):
cls = obj
if not hasattr(cls, 'init_from_parsed_args'):
raise NoSuchMethodError('init_from_parsed_args')
# New an object accordingto args
obj = getattr(cls, 'init_from_parsed_args')(args)

sub_cmd_obj = getattr(obj, args.sub_command)
argspec = inspect.getargspec(sub_cmd_obj)
arg_values = []
Expand All @@ -370,9 +415,15 @@ def run_sub_command(self, args=None):


if __name__ == '__main__':
if os.getenv("PY_DOCTEST", "0") == "1":
import doctest
test_result = doctest.testmod()
print(doctest.testmod(), file=sys.stderr)
sys.exit(0 if test_result.failed == 0 else 1)
print("Legend of log levels", file=sys.stderr)
ZanataArgParser('parser').parse_args(["-v", "DEBUG"])
logging.debug("debug")
logging.info("info")
logging.warning("warning")
logging.error("error")
logging.critical("critical")

0 comments on commit 22c389c

Please sign in to comment.