如何给python脚本传参

给Python脚本传参的方法有多种，常见的方法有使用sys.argv、使用argparse模块、使用第三方库如click。其中，使用argparse模块是最常见且功能强大的方法，它能够轻松地定义和解析命令行参数。下面将详细介绍如何使用argparse模块给Python脚本传参。

一、使用sys.argv

sys.argv是Python内置的sys模块中的一个列表，包含命令行参数。第一个元素是脚本名，后续元素是传入的参数。

import sys
def main():
    script_name = sys.argv[0]
    arg1 = sys.argv[1]
    arg2 = sys.argv[2]
    print(f"Script Name: {script_name}")
    print(f"Argument 1: {arg1}")
    print(f"Argument 2: {arg2}")
if __name__ == "__main__":
    main()

运行时传参：

python script.py arg1 arg2

二、使用argparse模块

argparse模块是Python标准库中的一个模块，用于解析命令行参数和选项。它提供了丰富的功能和友好的用户界面。

import argparse
def main():
    parser = argparse.ArgumentParser(description="Example script with arguments")
    parser.add_argument("arg1", type=int, help="First argument")
    parser.add_argument("arg2", type=str, help="Second argument")
    parser.add_argument("--optional", type=str, default="default_value", help="Optional argument")
    args = parser.parse_args()
    print(f"Argument 1: {args.arg1}")
    print(f"Argument 2: {args.arg2}")
    print(f"Optional Argument: {args.optional}")
if __name__ == "__main__":
    main()

运行时传参：

python script.py 10 hello --optional optional_value

三、使用第三方库click

click是一个用于创建命令行接口的第三方库，它提供了更高级和便捷的功能。

import click
@click.command()
@click.argument('arg1')
@click.argument('arg2')
@click.option('--optional', default='default_value', help='Optional argument')
def main(arg1, arg2, optional):
    print(f"Argument 1: {arg1}")
    print(f"Argument 2: {arg2}")
    print(f"Optional Argument: {optional}")
if __name__ == "__main__":
    main()

运行时传参：

python script.py 10 hello --optional optional_value

四、详细介绍argparse模块

1、创建ArgumentParser对象

首先，需要创建一个ArgumentParser对象，通常会在脚本的main函数中进行。

parser = argparse.ArgumentParser(description="Description of your script")

2、添加参数

使用add_argument方法为脚本定义参数。参数可以是位置参数或可选参数。

位置参数：

parser.add_argument("arg1", type=int, help="First argument")

可选参数：

parser.add_argument("--optional", type=str, default="default_value", help="Optional argument")

3、解析参数

调用parse_args方法解析命令行参数，返回一个包含参数的Namespace对象。

args = parser.parse_args()

4、使用参数

通过Namespace对象的属性访问参数。

print(f"Argument 1: {args.arg1}")
print(f"Optional Argument: {args.optional}")

五、示例：实现一个简单的计算器

下面是一个使用argparse实现的简单计算器脚本。它可以根据用户输入的操作符执行加、减、乘、除运算。

import argparse
def main():
    parser = argparse.ArgumentParser(description="Simple calculator")
    parser.add_argument("num1", type=float, help="First number")
    parser.add_argument("num2", type=float, help="Second number")
    parser.add_argument("operator", type=str, choices=["+", "-", "*", "/"], help="Operator")
    args = parser.parse_args()
    if args.operator == "+":
        result = args.num1 + args.num2
    elif args.operator == "-":
        result = args.num1 - args.num2
    elif args.operator == "*":
        result = args.num1 * args.num2
    elif args.operator == "/":
        result = args.num1 / args.num2
    print(f"Result: {result}")
if __name__ == "__main__":
    main()

运行时传参：

python calculator.py 10 5 +

六、总结

通过sys.argv、argparse模块和第三方库click，可以方便地给Python脚本传参。argparse模块由于其功能强大且使用简单，是处理命令行参数的首选方法。使用argparse模块时，首先创建ArgumentParser对象，然后添加参数，解析参数，最后使用参数。通过这种方式，可以轻松地为Python脚本添加命令行参数支持，提升脚本的灵活性和用户体验。