Python脚本传参 -h --help

2024-04-19 20:20
文章标签 python 脚本 help 传参

本文主要是介绍Python脚本传参 -h --help,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

弄清脚本传参,你就不用纠结那么多让你困扰的 - 或 – 参数了,你也可以在你的脚本中写一些让别人一头雾水的 – 参数了。

命名变量传参

如果你想要在传递参数时给它们命名,以便在Python脚本中更容易地识别和使用这些参数,你通常会使用命令行解析库,比如argparseargparse库允许你定义参数的名称、类型、是否必需等,并提供了友好的帮助信息。

下面是一个使用argparse的示例,该示例允许你通过命令行传递命名参数:

script.py

import argparsedef main():parser = argparse.ArgumentParser(description='Process some integers.')parser.add_argument('--name', type=str, help='Your name')parser.add_argument('--age', type=int, help='Your age')args = parser.parse_args()print(f"Name: {args.name}")print(f"Age: {args.age}")if __name__ == '__main__':main()

在Bash中,你可以这样运行这个脚本并传递命名参数:

python script.py --name John --age 30

输出将会是:

Name: John
Age: 30

如果你想要一个更简洁的方式来处理没有命名参数的简单情况,你仍然可以使用sys.argv,但是你可以通过约定来指定参数的顺序或格式。例如,你可以约定第一个参数是名字,第二个参数是年龄:

script.py (使用sys.argv和约定)

import sysdef main():if len(sys.argv) < 3:print("Usage: python script.py <name> <age>")sys.exit(1)name = sys.argv[1]age = sys.argv[2]print(f"Name: {name}")print(f"Age: {age}")if __name__ == '__main__':main()

然后在Bash中运行:

python script.py John 30

输出同样是:

Name: John
Age: 30

请注意,使用sys.argv时,所有的参数都是字符串类型,如果需要其他类型(如整数或浮点数),你需要手动进行转换。而在使用argparse时,参数的类型会在解析时自动转换。

文件传参

如果您想通过命令行参数传入文件,您可以使用 argparse 库的 type=argparse.FileType 功能来自动打开文件。这样,您就不需要手动打开文件了,argparse 会为您处理。

下面是一个示例,展示了如何修改您的代码以接受一个文件作为参数,并读取该文件的内容:

import argparsedef main():parser = argparse.ArgumentParser(description='Process a file.')# 使用 argparse.FileType('r') 来自动打开文件以进行读取parser.add_argument('--file', type=argparse.FileType('r'), help='Path to the file you want to read')parser.add_argument('--name', type=str, help='Your name')parser.add_argument('--age', type=int, help='Your age')args = parser.parse_args()# 由于我们使用了 argparse.FileType,args.file 现在是一个打开的文件对象file_content = args.file.read()  # 读取文件内容args.file.close()  # 关闭文件,尽管在脚本结束时它通常会自动关闭,但显式关闭是一个好习惯print(f"Name: {args.name}")print(f"Age: {args.age}")print(f"File content:\n{file_content}")if __name__ == '__main__':main()

当您运行这个脚本并传入一个文件时,您应该这样做:

python your_script.py --name "John Doe" --age 30 --file path_to_your_file.txt

这里的 path_to_your_file.txt 是您想要读取的文件的路径。argparse 会打开这个文件,并且 args.file 将是一个打开的文件对象,您可以直接从中读取内容。注意,如果文件不存在或者没有读取权限,argparse 会抛出异常。

注意:当您使用 argparse.FileType 时,argparse 会在解析完参数后立即打开文件,这意味着如果您需要额外的错误处理或者不想立即读取文件,那么可能需要采用不同的策略,例如仅接收文件路径作为字符串,然后在需要的时候手动打开文件。

配置文件传参config(.ini、yaml)

处理配置文件(通常是以某种格式存储的键值对或结构化数据的文件,如INI、YAML、JSON等)通常不是通过命令行参数直接传递文件内容来完成的。相反,您会传递配置文件的路径作为命令行参数,然后在您的脚本中读取和处理该文件。

以下是一个示例,展示如何使用 argparse 来接受一个配置文件路径,并使用Python的内置库来读取INI格式的配置文件:

import argparse
import configparserdef main():parser = argparse.ArgumentParser(description='Process a configuration file.')parser.add_argument('--config', type=str, help='Path to the configuration file')args = parser.parse_args()# 使用configparser读取INI格式的配置文件config = configparser.ConfigParser()config.read(args.config)# 读取具体的配置项name = config.get('DEFAULT', 'name')age = config.getint('DEFAULT', 'age')# 打印读取到的配置信息print(f"Name: {name}")print(f"Age: {age}")if __name__ == '__main__':main()

在这个例子中,假设您的配置文件(比如config.ini)看起来像这样:

[DEFAULT]
name = John Doe
age = 30

当您运行脚本时,您需要传递配置文件的路径:

python your_script.py --config path_to_your_config.ini

configparser 会读取这个文件,并允许您通过 get 方法(以及针对特定数据类型的 getint, getfloat, getboolean 等方法)来访问配置中的值。

如果您的配置文件是YAML或JSON格式,您可以使用 PyYAMLjson 库来解析它们。这些库提供了类似的方法来读取和处理配置文件。

请确保您已经安装了必要的库(如 PyYAML),如果需要的话,可以使用 pip 来安装它们:

pip install pyyaml

然后,您可以根据配置文件的格式选择适当的解析方法。例如,对于YAML配置文件,您可以这样做:

import argparse
import yamldef main():parser = argparse.ArgumentParser(description='Process a YAML configuration file.')parser.add_argument('--config', type=str, help='Path to the YAML configuration file')args = parser.parse_args()# 使用yaml库读取YAML格式的配置文件with open(args.config, 'r') as file:config = yaml.safe_load(file)# 读取具体的配置项name = config['name']age = config['age']# 打印读取到的配置信息print(f"Name: {name}")print(f"Age: {age}")if __name__ == '__main__':main()

确保您的YAML配置文件(比如config.yaml)格式正确:

name: John Doe
age: 30

然后,您可以通过命令行传递YAML配置文件的路径来运行脚本:

python your_script.py --config path_to_your_config.yaml

这篇关于Python脚本传参 -h --help的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/918415

相关文章

golang程序打包成脚本部署到Linux系统方式

《golang程序打包成脚本部署到Linux系统方式》Golang程序通过本地编译(设置GOOS为linux生成无后缀二进制文件),上传至Linux服务器后赋权执行,使用nohup命令实现后台运行,完... 目录本地编译golang程序上传Golang二进制文件到linux服务器总结本地编译Golang程序

Python通用唯一标识符模块uuid使用案例详解

《Python通用唯一标识符模块uuid使用案例详解》Pythonuuid模块用于生成128位全局唯一标识符,支持UUID1-5版本,适用于分布式系统、数据库主键等场景,需注意隐私、碰撞概率及存储优... 目录简介核心功能1. UUID版本2. UUID属性3. 命名空间使用场景1. 生成唯一标识符2. 数

Python办公自动化实战之打造智能邮件发送工具

《Python办公自动化实战之打造智能邮件发送工具》在数字化办公场景中,邮件自动化是提升工作效率的关键技能,本文将演示如何使用Python的smtplib和email库构建一个支持图文混排,多附件,多... 目录前言一、基础配置:搭建邮件发送框架1.1 邮箱服务准备1.2 核心库导入1.3 基础发送函数二、

Python包管理工具pip的升级指南

《Python包管理工具pip的升级指南》本文全面探讨Python包管理工具pip的升级策略,从基础升级方法到高级技巧,涵盖不同操作系统环境下的最佳实践,我们将深入分析pip的工作原理,介绍多种升级方... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

基于Python实现一个图片拆分工具

《基于Python实现一个图片拆分工具》这篇文章主要为大家详细介绍了如何基于Python实现一个图片拆分工具,可以根据需要的行数和列数进行拆分,感兴趣的小伙伴可以跟随小编一起学习一下... 简单介绍先自己选择输入的图片,默认是输出到项目文件夹中,可以自己选择其他的文件夹,选择需要拆分的行数和列数,可以通过

Python中反转字符串的常见方法小结

《Python中反转字符串的常见方法小结》在Python中,字符串对象没有内置的反转方法,然而,在实际开发中,我们经常会遇到需要反转字符串的场景,比如处理回文字符串、文本加密等,因此,掌握如何在Pyt... 目录python中反转字符串的方法技术背景实现步骤1. 使用切片2. 使用 reversed() 函

Python中将嵌套列表扁平化的多种实现方法

《Python中将嵌套列表扁平化的多种实现方法》在Python编程中,我们常常会遇到需要将嵌套列表(即列表中包含列表)转换为一个一维的扁平列表的需求,本文将给大家介绍了多种实现这一目标的方法,需要的朋... 目录python中将嵌套列表扁平化的方法技术背景实现步骤1. 使用嵌套列表推导式2. 使用itert

使用Docker构建Python Flask程序的详细教程

《使用Docker构建PythonFlask程序的详细教程》在当今的软件开发领域,容器化技术正变得越来越流行,而Docker无疑是其中的佼佼者,本文我们就来聊聊如何使用Docker构建一个简单的Py... 目录引言一、准备工作二、创建 Flask 应用程序三、创建 dockerfile四、构建 Docker

Python使用vllm处理多模态数据的预处理技巧

《Python使用vllm处理多模态数据的预处理技巧》本文深入探讨了在Python环境下使用vLLM处理多模态数据的预处理技巧,我们将从基础概念出发,详细讲解文本、图像、音频等多模态数据的预处理方法,... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Python使用pip工具实现包自动更新的多种方法

《Python使用pip工具实现包自动更新的多种方法》本文深入探讨了使用Python的pip工具实现包自动更新的各种方法和技术,我们将从基础概念开始,逐步介绍手动更新方法、自动化脚本编写、结合CI/C... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核