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批量转换图片为PDF

《详解如何通过Python批量转换图片为PDF》:本文主要介绍如何基于Python+Tkinter开发的图片批量转PDF工具,可以支持批量添加图片,拖拽等操作,感兴趣的小伙伴可以参考一下... 目录1. 概述2. 功能亮点2.1 主要功能2.2 界面设计3. 使用指南3.1 运行环境3.2 使用步骤4. 核

Python 安装和配置flask, flask_cors的图文教程

《Python安装和配置flask,flask_cors的图文教程》:本文主要介绍Python安装和配置flask,flask_cors的图文教程,本文通过图文并茂的形式给大家介绍的非常详细,... 目录一.python安装:二,配置环境变量,三:检查Python安装和环境变量,四:安装flask和flas

使用Python自建轻量级的HTTP调试工具

《使用Python自建轻量级的HTTP调试工具》这篇文章主要为大家详细介绍了如何使用Python自建一个轻量级的HTTP调试工具,文中的示例代码讲解详细,感兴趣的小伙伴可以参考一下... 目录一、为什么需要自建工具二、核心功能设计三、技术选型四、分步实现五、进阶优化技巧六、使用示例七、性能对比八、扩展方向建

基于Python打造一个可视化FTP服务器

《基于Python打造一个可视化FTP服务器》在日常办公和团队协作中,文件共享是一个不可或缺的需求,所以本文将使用Python+Tkinter+pyftpdlib开发一款可视化FTP服务器,有需要的小... 目录1. 概述2. 功能介绍3. 如何使用4. 代码解析5. 运行效果6.相关源码7. 总结与展望1

使用Python实现一键隐藏屏幕并锁定输入

《使用Python实现一键隐藏屏幕并锁定输入》本文主要介绍了使用Python编写一个一键隐藏屏幕并锁定输入的黑科技程序,能够在指定热键触发后立即遮挡屏幕,并禁止一切键盘鼠标输入,这样就再也不用担心自己... 目录1. 概述2. 功能亮点3.代码实现4.使用方法5. 展示效果6. 代码优化与拓展7. 总结1.

使用Python开发一个简单的本地图片服务器

《使用Python开发一个简单的本地图片服务器》本文介绍了如何结合wxPython构建的图形用户界面GUI和Python内建的Web服务器功能,在本地网络中搭建一个私人的,即开即用的网页相册,文中的示... 目录项目目标核心技术栈代码深度解析完整代码工作流程主要功能与优势潜在改进与思考运行结果总结你是否曾经

Python基础文件操作方法超详细讲解(详解版)

《Python基础文件操作方法超详细讲解(详解版)》文件就是操作系统为用户或应用程序提供的一个读写硬盘的虚拟单位,文件的核心操作就是读和写,:本文主要介绍Python基础文件操作方法超详细讲解的相... 目录一、文件操作1. 文件打开与关闭1.1 打开文件1.2 关闭文件2. 访问模式及说明二、文件读写1.

Python将博客内容html导出为Markdown格式

《Python将博客内容html导出为Markdown格式》Python将博客内容html导出为Markdown格式,通过博客url地址抓取文章,分析并提取出文章标题和内容,将内容构建成html,再转... 目录一、为什么要搞?二、准备如何搞?三、说搞咱就搞!抓取文章提取内容构建html转存markdown

Python获取中国节假日数据记录入JSON文件

《Python获取中国节假日数据记录入JSON文件》项目系统内置的日历应用为了提升用户体验,特别设置了在调休日期显示“休”的UI图标功能,那么问题是这些调休数据从哪里来呢?我尝试一种更为智能的方法:P... 目录节假日数据获取存入jsON文件节假日数据读取封装完整代码项目系统内置的日历应用为了提升用户体验,

微信公众号脚本-获取热搜自动新建草稿并发布文章

《微信公众号脚本-获取热搜自动新建草稿并发布文章》本来想写一个自动化发布微信公众号的小绿书的脚本,但是微信公众号官网没有小绿书的接口,那就写一个获取热搜微信普通文章的脚本吧,:本文主要介绍微信公众... 目录介绍思路前期准备环境要求获取接口token获取热搜获取热搜数据下载热搜图片给图片加上标题文字上传图片