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

相关文章

使用python生成固定格式序号的方法详解

《使用python生成固定格式序号的方法详解》这篇文章主要为大家详细介绍了如何使用python生成固定格式序号,文中的示例代码讲解详细,具有一定的借鉴价值,有需要的小伙伴可以参考一下... 目录生成结果验证完整生成代码扩展说明1. 保存到文本文件2. 转换为jsON格式3. 处理特殊序号格式(如带圈数字)4

Python版本信息获取方法详解与实战

《Python版本信息获取方法详解与实战》在Python开发中,获取Python版本号是调试、兼容性检查和版本控制的重要基础操作,本文详细介绍了如何使用sys和platform模块获取Python的主... 目录1. python版本号获取基础2. 使用sys模块获取版本信息2.1 sys模块概述2.1.1

一文详解Python如何开发游戏

《一文详解Python如何开发游戏》Python是一种非常流行的编程语言,也可以用来开发游戏模组,:本文主要介绍Python如何开发游戏的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、python简介二、Python 开发 2D 游戏的优劣势优势缺点三、Python 开发 3D

Python函数作用域与闭包举例深度解析

《Python函数作用域与闭包举例深度解析》Python函数的作用域规则和闭包是编程中的关键概念,它们决定了变量的访问和生命周期,:本文主要介绍Python函数作用域与闭包的相关资料,文中通过代码... 目录1. 基础作用域访问示例1:访问全局变量示例2:访问外层函数变量2. 闭包基础示例3:简单闭包示例4

Python实现字典转字符串的五种方法

《Python实现字典转字符串的五种方法》本文介绍了在Python中如何将字典数据结构转换为字符串格式的多种方法,首先可以通过内置的str()函数进行简单转换;其次利用ison.dumps()函数能够... 目录1、使用json模块的dumps方法:2、使用str方法:3、使用循环和字符串拼接:4、使用字符

Python版本与package版本兼容性检查方法总结

《Python版本与package版本兼容性检查方法总结》:本文主要介绍Python版本与package版本兼容性检查方法的相关资料,文中提供四种检查方法,分别是pip查询、conda管理、PyP... 目录引言为什么会出现兼容性问题方法一:用 pip 官方命令查询可用版本方法二:conda 管理包环境方法

基于Python开发Windows自动更新控制工具

《基于Python开发Windows自动更新控制工具》在当今数字化时代,操作系统更新已成为计算机维护的重要组成部分,本文介绍一款基于Python和PyQt5的Windows自动更新控制工具,有需要的可... 目录设计原理与技术实现系统架构概述数学建模工具界面完整代码实现技术深度分析多层级控制理论服务层控制注

pycharm跑python项目易出错的问题总结

《pycharm跑python项目易出错的问题总结》:本文主要介绍pycharm跑python项目易出错问题的相关资料,当你在PyCharm中运行Python程序时遇到报错,可以按照以下步骤进行排... 1. 一定不要在pycharm终端里面创建环境安装别人的项目子模块等,有可能出现的问题就是你不报错都安装

Python打包成exe常用的四种方法小结

《Python打包成exe常用的四种方法小结》本文主要介绍了Python打包成exe常用的四种方法,包括PyInstaller、cx_Freeze、Py2exe、Nuitka,文中通过示例代码介绍的非... 目录一.PyInstaller11.安装:2. PyInstaller常用参数下面是pyinstal

Python爬虫HTTPS使用requests,httpx,aiohttp实战中的证书异步等问题

《Python爬虫HTTPS使用requests,httpx,aiohttp实战中的证书异步等问题》在爬虫工程里,“HTTPS”是绕不开的话题,HTTPS为传输加密提供保护,同时也给爬虫带来证书校验、... 目录一、核心问题与优先级检查(先问三件事)二、基础示例:requests 与证书处理三、高并发选型: