Python 获取命令行参数的方法

1. 简介

在很多情况下，我们需要通过命令行来运行 Python 脚本，并且还需要传递一些参数给脚本。本文将介绍几种获取命令行参数的方法，以及它们的使用场景和优缺点。

2. sys 模块

sys 是 Python 内置的一个模块，其中包含了一些与 Python 解释器和运行环境相关的函数和变量。其中，sys.argv 变量可以用于获取命令行参数。

2.1 使用方法

sys.argv 变量是一个字符串列表，其中的每个元素都是一个命令行参数。第一个元素是脚本名称本身，其余元素为传递给脚本的参数。假设我们有一个名为 script.py 的脚本，执行命令行 python script.py arg1 arg2 arg3，那么 sys.argv 的值将为 ['script.py', 'arg1', 'arg2', 'arg3']。

以下是一个使用 sys.argv 的示例代码：

import sys

# 获取命令行参数
args = sys.argv

# 打印脚本名称
print("脚本名称:", args[0])

# 打印传递的参数
print("参数1:", args[1])
print("参数2:", args[2])
print("参数3:", args[3])

运行上述代码，输出结果如下：

脚本名称: script.py
参数1: arg1
参数2: arg2
参数3: arg3

2.2 优缺点

使用 sys.argv 获取命令行参数的优点是简单易用，无需额外安装模块。缺点是代码较为繁琐，需要手动处理参数列表。另外，如果需要处理大量复杂的命令行参数，sys.argv 的使用会变得不够方便。

3. argparse 模块

argparse 是 Python 标准库中的一个模块，专门用于解析命令行参数。它可以自动生成帮助信息，并支持复杂的命令行参数定义。

3.1 安装

argparse 是 Python 标准库中的一部分，无需额外安装。

3.2 使用方法

以下是一个使用 argparse 的示例代码：

import argparse

# 创建 ArgumentParser 对象
parser = argparse.ArgumentParser(description='这是一个命令行参数解析示例。')

# 添加位置参数
parser.add_argument('arg1', type=int, help='第一个位置参数')
parser.add_argument('arg2', help='第二个位置参数')

# 添加可选参数
parser.add_argument('-o', '--optional', help='可选参数')

# 解析命令行参数
args = parser.parse_args()

# 打印位置参数
print("位置参数1:", args.arg1)
print("位置参数2:", args.arg2)

# 打印可选参数
if args.optional:
    print("可选参数:", args.optional)

运行上述代码，可以通过命令行传递参数给脚本：

python script.py 10 value -o optional_value

输出结果如下：

位置参数1: 10
位置参数2: value
可选参数: optional_value

3.3 优缺点

使用 argparse 解析命令行参数的优点是可以自动生成帮助信息，支持复杂的命令行参数定义。缺点是相比较于 sys.argv 使用起来稍微复杂一些，并且需要额外了解 argparse 的使用方法。

4. fire 模块

fire 是一个第三方模块，它可以将任何 Python 函数转化为命令行接口。它提供了一种更简洁和便捷的方式来解析命令行参数。

4.1 安装

可以通过 pip 安装 fire：

pip install fire

4.2 使用方法

以下是一个使用 fire 的示例代码：

import fire

class MyScript(object):
    def __init__(self):
        pass

    def script(self, arg1, arg2, arg3=None):
        """这是一个命令行参数解析示例。"""
        print("参数1:", arg1)
        print("参数2:", arg2)
        if arg3:
            print("参数3:", arg3)

if __name__ == '__main__':
    fire.Fire(MyScript)

运行上述代码，可以通过命令行传递参数给脚本：

python script.py script value1 value2 --arg3 value3

输出结果如下：

参数1: value1
参数2: value2
参数3: value3

4.3 优缺点

使用 fire 解析命令行参数的优点是简洁易用，无需定义 argparse 对象和解析过程。缺点是它的使用方式较为特殊，需要了解并遵循 fire 模块的规范。

5. 其他方法

除了以上介绍的方法之外，还有其他一些第三方模块可以用于解析命令行参数，例如 click、docopt、getopt 等等。这些模块都有自己的特点和使用方式，可以根据实际需求选择合适的模块进行使用。

6. 总结

本文介绍了几种获取命令行参数的方法，其中包括了 Python 内置的 sys 模块和标准库中的 argparse 模块，还介绍了第三方模块 fire。不同的方法有不同的使用场景和优缺点，可以根据实际需求选择合适的方法来解析命令行参数。无论使用哪种方法，都可以在脚本中方便地获取和处理命令行参数。