目录

一、主要功能和用途

二、核心类和方法

三、总结

四、argparse模块示例

---

Jenkins定时构建自动化(一)：Jenkins下载安装配置-CSDN博客

Jenkins定时构建自动化(二)：Jenkins的定时构建-CSDN博客

Jenkins定时构建自动化(三)：手动+定时构建执行本地+运行代码不需要传参-CSDN博客

注：下面这段内容如果无法理解没关系，后期可以慢慢学习，无法理解直接看下面的实例就好，照搬使用不耽误。

        argparse 是 Python 标准库中用于解析命令行参数和生成帮助信息的模块。它可以帮助开发者轻松地编写用户友好的命令行界面，处理用户输入的参数，并提供详细的帮助文档。

一、主要功能和用途

• 定义参数：

        使用 argparse.ArgumentParser 类来创建一个参数解析器对象。

        通过调用 add_argument 方法添加各种命令行参数及其属性，例如参数名称、类型、是否必需、帮助信息等。

• 解析和验证参数：

        调用解析器的 parse_args 方法来解析命令行参数。

        argparse 会自动处理参数类型转换和验证，如果参数不符合预期的类型或选项，会生成错误消息。

• 生成帮助信息：

        自动根据 add_argument 方法的设置生成帮助信息，包括参数的描述、使用示例等。

        通过在命令行输入 -h 或 --help 可以显示生成的帮助信息，帮助用户了解如何使用程序和参数。

二、核心类和方法

•  argparse.ArgumentParser：

        这是参数解析器的核心类。通过创建该类的实例来定义命令行参数。

        可以指定程序的描述信息、帮助信息等。

• add_argument 方法：

        add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])：

        name or flags：参数名称或选项。

        action：参数动作，例如存储值或统计参数出现次数。

        nargs：参数的个数，例如可接受多个值。

        const：某些动作和 nargs 之外需要的常数。

        default：如果未传递此参数，则使用的值。

        type：要转换的命令行参数的类型。

        choices：可接受的值的列表或范围。

        required：是否必须提供此参数。

        help：关于参数的简短描述。

        metavar：在帮助文本中使用的参数名称。

        dest：要存储结果的属性名称。

三、总结

        argparse 模块为 Python 程序提供了强大的命令行参数处理功能，能够有效地管理用户输入，提供友好的用户界面和错误处理，是开发命令行工具和脚本的重要工具之一。通过合理使用 argparse，可以使得程序更易于使用和维护，同时提高用户体验。

四、argparse模块示例

import os
import argparse


class Jenkins_Database:
    def __init__(self):
        self.connection = None

    def jenkins_run_data(self):
        """
        jenkins运行数据
        :return:
        """
        parser = argparse.ArgumentParser(description='Process some parameters.')
        parser.add_argument('--parameter_1', type=str, required=True, help='参数1')  # 字符串  str
        parser.add_argument('--parameter_2', type=int, required=True, help='参数2')  # 整型    int
        parser.add_argument('--parameter_3', type=str, required=True, help='参数3')
        parser.add_argument('--parameter_4', type=int, required=True, help='参数4')
        args = parser.parse_args()

        # 拼接成 values_data 字典
        data = {
            '参数1': args.parameter_1,
            '参数2': args.parameter_2,
            '参数3': args.parameter_3,
            '参数4': args.parameter_4,
        }
        return values_data
        
if __name__ == "__main__":
    jenkins_db = Jenkins_Database()  # 创建 Jenkins_Database 的实例
    values_data = jenkins_db.jenkins_run_data()  # 通过实例调用方法