python-命令行，参数解析，日志管理框架（cmd,argparse,logging模块）

青旅半醒 2022-11-28 00:50 284阅读 0赞

**目录**

框架

代码

lady\_killer.py

cli.py

hello.py

log.py

constants.py

Linux中展示

总结

参考

--------------------

前段时间的某篇文章中，提及到了参数解析，说学了之后进行分享，最近忙了一阵子，有时间就写了一个简单的框架，适合在Mac或Linux上运行的工具等，有参考sqlmap和一些官方文档。

# 框架 #

![20200819172118532.PNG][] 框架结构

*  lady\_killer.py 调用cli
 *  cli.py 继承Cmd模块，使用argparse模块进行参数解析，调用hello进行测试
 *  hello.py 一些简单的输出，调用log进行日志模块的测试
 *  log.py  继承logging模块，进行日志管理
 *  constans.py 常量，也可理解为配置文件

# 代码 #

## lady\_killer.py ##

"""
    --coding:utf-8--
    @File: lady_killer.py
    @Author:frank yu
    @DateTime: 2020.08.19 15:38
    @Contact: frankyu112058@gmail.com
    @Description:main file
    """
    from cli import Cli
    
    
    def start():
        cli = Cli()
        cli.cmdloop()
    
    
    def main():
        start()
    
    
    if __name__ == "__main__":
        main()

## cli.py ##

"""
    --coding:utf-8--
    @File: cli.py
    @Author:frank yu
    @DateTime: 2020.08.19 15:46
    @Contact: frankyu112058@gmail.com
    @Description:module to combine and Cmd and argparse
    """
    import argparse
    import sys
    from cmd import Cmd
    
    from hello import Hello
    
    
    class Cli(Cmd):
        def __init__(self):
            """
            function: __init__
            :return: None
            """
            title = \
                '''
            +++                +++++        ++++++++++++    ++++       ++++    
            +++               +++ +++       +++++++++++++      +++   +++
            +++              +++   +++      +++        +++        +++
            +++             +++++++++++     +++        +++        +++
            +++++++++++    +++       +++    +++++++++++++         +++
            +++++++++++   +++         +++   +++++++++++           +++
            
            Welcome to LADY, a Command and Logging Frame made by lady_killer9(https://blog.csdn.net/lady_killer9)
            version 1.0.0
            use hello -h/--help to show options
            Hit '<ctrl-c>' or 'exit' to shutdown LADY.
                '''
            display = "\033[1;36;40m{}\033[0m".format(title)
            self.do_clear(None)
            print(display)
            Cmd.__init__(self)
            self.prompt = 'lady_killer>'
    
        def emptyline(self):
            """
            Called when an empty line is entered in response to the prompt.
            If this method is not overridden, it repeats the last nonempty
            command entered.
            """
            return
    
        def do_hello(self, cmd):
            """
            function:run hello module to test program
            :param cmd: command from console
            :return: None
            """
            commond = cmd.split()
            # print(commond)
            parse = argparse.ArgumentParser(description='Process some integers.')
            parse.prog = "hello"
            parse.usage = parse.prog + " -l [-d] [-i] [-w] [-e] [-c]"
            parse.add_argument('-d', '--debug', type=str, default="this is debug message",
                               help="print message with logging.DEBUG")
            parse.add_argument('-i', '--info', type=str, default="this is info message",
                               help="print message with logging.INFO")
            parse.add_argument('-w', '--warning', type=str, default="this is warning message",
                               help="print message with logging.WARN")
            parse.add_argument('-e', '--error', type=str, default="this is error message",
                               help="print message with logging.ERROR")
            parse.add_argument('-c', '--critical', type=str, default="this is critical message",
                               help="print message with logging.CRITICAL")
            parse.add_argument('-l', type=str, choices=["debug", "info", "warn", "error", "critical"],
                               help="set log level(debug info warn error critical)")
            args = parse.parse_args(commond)
            # print(args)
            kwargs = dict()
            kwargs['d_info'] = args.debug
            kwargs['i_info'] = args.info
            kwargs['w_info'] = args.warning
            kwargs['e_info'] = args.error
            kwargs['c_info'] = args.critical
            kwargs['l'] = args.l
            hello = Hello()
            hello.set_log(**kwargs)
            hello.debug(**kwargs)
            hello.info(**kwargs)
            hello.warning(**kwargs)
            hello.error(**kwargs)
            hello.critical(**kwargs)
    
        def do_exit(self, msg):
            """
            function: close the cmd
            :param msg: param about service to stop
            :return: None
            """
            print('Bye!!!')
            sys.exit(0)
    
        def do_clear(self, msg):
            """
            function: clear screen
            """
            print("\033c")

继承Cmd模块，使用argparse模块进行参数解析（空格分隔），输出标题，添加exit,clear,hello三条命令，hello中添加部分参数

## hello.py ##

"""
    --coding:utf-8--
    @File: hello.py
    @Author:frank yu
    @DateTime: 2020.08.19 16:02
    @Contact: frankyu112058@gmail.com
    @Description:this is module for test
    """
    from log import *
    
    log = Log()
    
    
    class Hello:
        def __init__(self):
            pass
    
        def debug(self, **kwargs):
            info = kwargs.get('d_info')
            log.log_show_store(info, logging.DEBUG)
    
        def info(self, **kwargs):
            info = kwargs.get('i_info')
            log.log_show_store(info, logging.INFO)
    
        def warning(self, **kwargs):
            info = kwargs.get('w_info')
            log.log_show_store(info, logging.WARN)
    
        def error(self, **kwargs):
            info = kwargs.get('e_info')
            log.log_show_store(info, logging.ERROR)
    
        def critical(self, **kwargs):
            info = kwargs.get('c_info')
            log.log_show_store(info, logging.CRITICAL)
    
        def set_log(self, **kwargs):
            level = kwargs.get('l')
            # print(level)
            if level == "debug":
                log.logger.setLevel(logging.DEBUG)
            elif level == "info":
                log.logger.setLevel(logging.INFO)
            elif level == "warn":
                log.logger.setLevel(logging.WARN)
            elif level == "error":
                log.logger.setLevel(logging.ERROR)
            elif level == "critical":
                log.logger.setLevel(logging.CRITICAL)
            else:
                log.log_show("please input -l", logging.CRITICAL)
                exit(0)

## log.py ##

"""
    --coding:utf-8--
    @File: log.py.py
    @Author:frank yu
    @DateTime: 2020.08.19 15:22
    @Contact: frankyu112058@gmail.com
    @Description:log module
    """
    import logging
    import os
    import random
    import sys
    import threading
    import time
    from shutil import copyfile
    from constants import *
    from colorlog import ColoredFormatter
    
    
    class Log:
        def __init__(self, log_dir=LOG_DIR):
            """
            function:init create log file, judge if log file is too bigger
            :param log_dir: directory of logs
            """
            log_path = log_dir + "/log"
            if not os.path.exists(log_dir):
                os.mkdir(log_dir)
                os.chmod(log_dir, 0o777)
            if not os.path.exists(log_path):
                f = open(log_path, mode='w', encoding='utf-8')
                f.close()
                os.chmod(log_path, 0o777)
            # if log file is more than 1MB, copy to a file and clear log file
            if os.path.getsize(log_path) / 1048576 > 1:
                print(os.path.getsize(log_path))
                copyfile(log_path, log_dir + "/log" + str(time.time()).replace(".", ""))
                with open(log_path, 'w') as f:
                    f.truncate()
                    f.close()
            self.logger_format = logging.Formatter('%(asctime)s - %(levelname)s: %(message)s')
            self.c_logger_format = ColoredFormatter(fmt='%(log_color)s%(asctime)s' \
                                                        ' - %(log_color)s%(levelname)s: %(log_color)s%(message)s',
                                                    reset=True,
                                                    secondary_log_colors={},
                                                    style='%'
                                                    )
            self.logger = logging.getLogger(str(random.random()))
            self.logger.handlers.clear()
            self.logger.setLevel(logging.DEBUG)
    
            self.filehandler = logging.FileHandler(log_path, mode='a')
            self.filehandler.setLevel(logging.DEBUG)
            self.filehandler.setFormatter(self.logger_format)
    
            self.stdouthandler = logging.StreamHandler(sys.stdout)
            self.stdouthandler.setLevel(logging.DEBUG)
            self.stdouthandler.setFormatter(self.c_logger_format)
    
            self.logger.addHandler(self.stdouthandler)
            self.logger.addHandler(self.filehandler)
    
            self.__lock = threading.Lock()
    
        def log_show_store(self, msg, level):
            """
            function: show logs on screen and store logs
            to log file
    
            :param msg:message of log
            :param level:level of log
    
            return: None
            """
            self.__lock.acquire()
            self.logger.addHandler(self.stdouthandler)
            self.logger.addHandler(self.filehandler)
            self.__log(msg=msg, level=level)
            self.__lock.release()
    
        def __log(self, msg=None, level=logging.INFO):
            if level == logging.DEBUG:
                self.logger.debug(msg)
            elif level == logging.INFO:
                self.logger.info(msg)
            elif level == logging.WARNING:
                self.logger.warning(msg)
            elif level == logging.ERROR:
                self.logger.error(msg)
            elif level == logging.CRITICAL:
                self.logger.critical(msg)
    
        def log_show(self, msg, level):
            """
            function:show msg on the screen
            :param msg:message of log
            :param level: level of log
            """
            self.__lock.acquire()
            self.logger.removeHandler(self.filehandler)
            self.logger.addHandler(self.stdouthandler)
            self.__log(msg, level=level)
            self.logger.removeHandler(self.stdouthandler)
            self.logger.addHandler(self.filehandler)
            self.__lock.release()

继承logging，一个仅进行控制台输出（没必要保存的信息调用这个），一个控制台输出并保存到日志。

## constants.py ##

"""
    --coding:utf-8--
    @File: constants.py
    @Author:frank yu
    @DateTime: 2020.08.19 16:16
    @Contact: frankyu112058@gmail.com
    @Description: file to save contents
    """
    LOG_DIR = 'logs'

# Linux中展示 #

cd frame
    python lady_killer.py

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhZHlfa2lsbGVyOQ_size_16_color_FFFFFF_t_70][] 选项

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhZHlfa2lsbGVyOQ_size_16_color_FFFFFF_t_70 1][] 示例

# 总结 #

命令行参数解析空格分隔，分为-和--两种，例如，-l使用args.l来获取,--debug使用args.debug获取

日志提供了日志存储，日志分文件，日志输出至控制台，彩色日志

开发时，修改输出的标题、命令行解析的lady\_killer>、添加自己的主功能模块xxx,在cli中使用do\_xxx来添加参数并调用即可。

码云：[https://gitee.com/frankyu365/frame.git][https_gitee.com_frankyu365_frame.git]

# 参考 #

[`cmd` \--- 支持面向行的命令解释器][cmd_ _---]

[`argparse` \--- 命令行选项、参数和子命令解析器][argparse_ _---]

[`logging` \--- Python 的日志记录工具][logging_ _--- Python]

[`logging.config` \--- 日志记录配置][logging.config_ _---]

[`logging.handlers` \--- 日志处理][logging.handlers_ _---]

[python-colorlog][]

更多python相关内容：[【python总结】python学习框架梳理][python_python]

本人b站账号:[lady\_killer9][lady_killer9]

有问题请下方评论，转载请注明出处，并附有原文链接，谢谢！如有侵权，请及时联系。如果您感觉有所收获，自愿打赏，可选择支付宝18833895206（小于），您的支持是我不断更新的动力。

[20200819172118532.PNG]: /images/20221124/4f6991be4ffe408dbb747125c2f0e421.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhZHlfa2lsbGVyOQ_size_16_color_FFFFFF_t_70]: /images/20221124/397a934a26f646eb88ae289b3684e741.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhZHlfa2lsbGVyOQ_size_16_color_FFFFFF_t_70 1]: /images/20221124/94b60257a8fc42bfbb84a040861ba934.png
[https_gitee.com_frankyu365_frame.git]: https://gitee.com/frankyu365/frame.git
[cmd_ _---]: https://docs.python.org/zh-cn/3/library/cmd.html
[argparse_ _---]: https://docs.python.org/zh-cn/3/library/argparse.html
[logging_ _--- Python]: https://docs.python.org/zh-cn/3/library/logging.html
[logging.config_ _---]: https://docs.python.org/zh-cn/3/library/logging.config.html
[logging.handlers_ _---]: https://docs.python.org/zh-cn/3/library/logging.handlers.html
[python-colorlog]: https://github.com/borntyping/python-colorlog
[python_python]: https://blog.csdn.net/lady_killer9/article/details/108763489
[lady_killer9]: https://space.bilibili.com/374432302