argparse 项目使用教程

argparse 项目使用教程

argparse A slimline C++ class for parsing command-line arguments, with an interface similar to python's class of the same name 项目地址: https://gitcode.com/gh_mirrors/argpa/argparse

1. 项目目录结构及介绍

argparse/
├── LICENSE
├── README.md
└── argparse.hpp

• LICENSE: 项目的许可证文件，采用BSD-3-Clause许可证。
• README.md: 项目的说明文件，包含项目的基本介绍、使用示例和编译说明。
• argparse.hpp: 项目的主要源文件，包含ArgumentParser类的定义和实现。

2. 项目启动文件介绍

项目的主要启动文件是argparse.hpp。该文件定义了一个名为ArgumentParser的C++类，用于解析命令行参数。ArgumentParser类的接口类似于Python中的同名类，提供了简单易用的命令行参数解析功能。

主要功能

• addArgument(): 添加命令行参数，支持短名称和长名称，以及固定数量和可变数量的输入。
• addFinalArgument(): 添加一个未命名的最终参数，通常用于收集所有剩余的输入。
• parse(): 解析命令行参数，如果格式不正确则抛出异常。
• retrieve(): 获取解析后的参数值，支持类型转换。
• usage(): 生成并打印使用说明。

示例代码

#include "argparse.hpp"

int main(int argc, const char** argv) {
    // 创建一个新的ArgumentParser
    ArgumentParser parser;

    // 添加一些参数
    parser.addArgument("-a");
    parser.addArgument("-b");
    parser.addArgument("-c", "--cactus", 1);
    parser.addArgument("-o", "--optional");
    parser.addArgument("-r", "--required", 1, true);
    parser.addArgument("--five", 5);
    parser.addArgument("--atleast", '+');
    parser.addArgument("--any", '*');
    parser.addFinalArgument("output");

    // 解析命令行参数
    parser.parse(argc, argv);

    // 获取参数值
    int cactus = parser.retrieve<int>("cactus");
    return cactus;
}

3. 项目配置文件介绍

项目没有独立的配置文件。所有的配置和参数解析逻辑都在argparse.hpp文件中实现。用户可以通过命令行参数来配置程序的行为。

参数配置示例

假设我们有一个程序example，可以通过以下命令行参数进行配置：

./example --required 123 -a -b --cactus 456 --five 1 2 3 4 5 --atleast 7 --any 8 9 output.txt

• --required: 必需参数，值为123。
• -a 和 -b: 可选参数，没有值。
• --cactus: 固定数量参数，值为456。
• --five: 固定数量参数，值为1 2 3 4 5。
• --atleast: 可变数量参数，至少需要一个值，值为7。
• --any: 可变数量参数，可以有零个或多个值，值为8 9。
• output: 未命名最终参数，值为output.txt。

通过这种方式，用户可以灵活地配置程序的行为。

argparse A slimline C++ class for parsing command-line arguments, with an interface similar to python's class of the same name 项目地址: https://gitcode.com/gh_mirrors/argpa/argparse