consolidated functions

Signed-off-by: Zen <[email protected]>

Author: desultory

src/zenlib/util/__init__.py

@@ -5,11 +5,11 @@
 from .update_init import update_init
 from .walk_dict import walk_dict
 from .check_dict import check_dict
-from .init_logger import init_logger
-from .process_args import process_args
-from .init_argparser import init_argparser
-from .get_args_n_logger import get_args_n_logger
-from .get_kwargs_from_args import get_kwargs_from_args
+from .main_funcs import init_logger
+from .main_funcs import process_args
+from .main_funcs import init_argparser
+from .main_funcs import get_args_n_logger
+from .main_funcs import get_kwargs_from_args
 
 __all__ = ['handle_plural', 'NoDupFlatList', 'pretty_print', 'replace_file_line',
            'update_init', 'walk_dict', 'check_dict', 'init_logger', 'process_args',

src/zenlib/util/get_args_n_logger.py

@@ -0,0 +1,104 @@
+"""
+Functions to help with the main()
+"""
+
+
+def get_kwargs_from_args(args, logger=None, base_kwargs={}):
+    """ Get kwargs from argparser args """
+    kwargs = base_kwargs.copy()
+    if logger is not None:
+        kwargs['logger'] = logger
+
+    for arg in vars(args):
+        value = getattr(args, arg)
+        if value is None or value is False:
+            continue
+
+        kwargs[arg] = value
+    return kwargs
+
+
+def init_logger(name=None):
+    """ Initialize the logger with a name"""
+    from logging import getLogger
+    name = name or __name__
+    return getLogger(name)
+
+
+def init_argparser(prog=None, description=None):
+    """ Initialize an argparser with common options. """
+    from argparse import ArgumentParser
+
+    argparser = ArgumentParser(prog=prog, description=description)
+    argparser.add_argument('-d', '--debug', action='store_true', help='Debug mode.')
+    argparser.add_argument('-dd', '--verbose', action='store_true', help='Verbose debug mode.')
+    argparser.add_argument('-v', '--version', action='store_true', help='Print the version and exit.')
+    argparser.add_argument('--log-file', type=str, help='Log file path.')
+    argparser.add_argument('--log-level', type=str, help='Log level.')
+    argparser.add_argument('--log-time', action='store_true', help='Log timestamps.')
+    argparser.add_argument('--no-log-color', action='store_true', help='Disable log color.')
+
+    return argparser
+
+
+def process_args(argparser, logger=None):
+    """ Process argparser args, optionally configuring a logger. """
+    from logging import Formatter
+    from zenlib.logging import ColorLognameFormatter
+    args = argparser.parse_args()
+    if args.version:
+        package = argparser.prog
+        from importlib.metadata import version
+        print(f"{package} {version(package)}")
+        exit(0)
+
+    if logger:
+        if args.log_level is not None:
+            log_level = int(args.log_level)
+        elif args.verbose:
+            log_level = 5
+        elif args.debug:
+            log_level = 10
+        else:
+            log_level = 20
+        logger.setLevel(log_level)
+
+        format_str = '%(asctime)s | ' if args.log_time else ''
+        if log_level < 20:
+            format_str += '%(levelname)s | %(name)-42s | %(message)s'
+        else:
+            format_str += '%(levelname)s | %(message)s'
+        formatter = ColorLognameFormatter(format_str) if not args.no_log_color else Formatter(format_str)
+
+        # Add the formatter to the first handler, or add a new handler
+        for handler in logger.handlers:
+            handler.setFormatter(formatter)
+            break
+        else:
+            from logging import StreamHandler, FileHandler
+            handler = StreamHandler() if args.log_file is None else FileHandler(args.log_file)
+            handler.setFormatter(formatter)
+            logger.addHandler(handler)
+
+    return args
+
+
+def get_args_n_logger(package, description: str, arguments=[], get_kwargs=False):
+    """ Takes a package name and description
+    If arguments are passed, they are added to argparser.
+    If get_kwargs is set to True a kwarg dict will be returned.
+    If not, returns the parsed args and logger.
+    """
+    argparser = init_argparser(prog=package, description=description)
+    logger = init_logger(package)
+
+    for arg in arguments:
+        dest = arg.pop('flags')
+        argparser.add_argument(*dest, **arg)
+
+    args = process_args(argparser, logger=logger)
+
+    if get_kwargs:
+        return get_kwargs_from_args(args, logger=logger)
+
+    return args, logger