Python Click 简单使用说明

Python Click库的来源:

Click是一个Python的命令行接口库,它由Alexandru Dutra和Ignacio Vergara于2010年创建。Click的目标是提供一种简单而灵活的方式来创建命令行应用程序。

常用参数说明:

  1. @click.command():这个装饰器用于定义一个新的命令。每个命令都需要一个函数作为其主体。

  2. .@click.option():这个装饰器用于定义命令行选项。

    1.name:选项的名称,必须以双短划线开头。
    2.default:选项的默认值。
    3.type:选项的类型。例如,int,float,path等。
    4.required:是否必须提供该选项。
    5.help:选项的帮助文本。
    6.callback:当选项被提供时调用的回调函数。

  3. @click.argument():这个装饰器用于定义命令行参数。

    1.name:参数的名称。
    2.type:参数的类型。
    3.required:是否必须提供该参数。
    4.help:参数的帮助文本。

  4. click.echo():用于在命令行中输出文本。

  5. click.get_current_context():返回当前上下文对象,可以用于访问当前命令的参数和选项

  6. click.Abort():引发一个中止异常,这将导致程序退出并显示错误消息。

  7. click.File():用于处理文件输入/输出。

  8. click.Path():用于处理路径选项或参数,它确保路径是有效的,并且可以自动创建目录

  9. click.Choice(choices):允许用户从一组预定义的值中选择一个选项

  10. click.Confirm(prompt=None, default=True, abort=False):用于确认操作是否应该继续进行。

  11. click.Password(prompt=‘Password:’, default=‘’, hide_input=True):用于接收密码输入,不会在命令行中显示输入的内容。

代码示例:

以下是一个简单的Click命令行应用的示例,它用于计算两个数字的和:


python
import click@click.command()
@click.option('--num1', type=int, default=0, help='First number')
@click.option('--num2', type=int, default=0, help='Second number')
@click.option('--sum', type=int, default=0, help='Sum of the two numbers')
def calculate(num1, num2, sum):if num1 + num2 == sum:click.echo('Numbers match!')else:click.echo(f'Numbers do not match! The sum is {num1 + num2}')if __name__ == '__main__':calculate()

stdout:

tiger@Super-Server:~/C++_Study$ python3 calculate.py --help
Usage: 1.py [OPTIONS]Options:--num1 INTEGER  First number--num2 INTEGER  Second number--sum INTEGER   Sum of the two numbers--help          Show this message and exit.

在这个示例中,我们定义了一个名为calculate的函数,它有三个选项:num1, num2, 和 sum。用户可以通过命令行提供这些选项的值,然后程序会检查两个数字的和是否与提供的值匹配,并输出相应的消息。

以下是一些更高级的Click应用示例,用于帮助你深入学习:

使用组(Groups):

import click
from click import Command, Group, echo@click.group()
@click.pass_context
def my_app(ctx):"""My Application"""ctx.obj = []@my_app.command()
@click.pass_context
def add(ctx):"""Add an item to the list"""item = click.prompt('Enter an item')ctx.obj.append(item)@my_app.command()
@click.pass_context
def display(ctx):"""Display the current list"""echo('Current list:')for item in ctx.obj:echo(item)if __name__ == '__main__':my_app()

使用回调函数(Callback Functions):

import clickdef handle_pre_command(ctx, args):"""回调函数,在命令执行前执行一些操作"""print("在命令执行前执行操作")return args@click.command()
@click.pass_context
def my_command(ctx):"""我的命令"""args = ctx.argshandle_pre_command(ctx, args)print("命令执行前")# 在这里执行一些操作...print("命令执行后")
if __name__ == '__main__':wait()

使用上下文参数(Contextual Parameters):

python
import click@click.command()
@click.option('--file', type=click.File('r'), default='-', help='Input file. Defaults to stdin.')
def cat(file):click.echo(file.read())
if __name__ == '__main__':cat()

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/223822.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

EasyCode代码生成模板

前言: EasyCode是 IDEA 开发的一个代码生成插件,主要通过自定义模板(基于velocity)来生成各种你想要的代码。相信大家都了解EasyCode是干嘛用的,下面是比较简约的一个生成模板,个人比较喜欢。 Controller …

Python从入门到精通六:Python数据容器

数据容器入门 为什么学习数据容器 思考一个问题:如果我想要在程序中,记录5名学生的信息,如姓名。 如何做呢? 学习数据容器,就是为了批量存储或批量使用多份数据 Python中的数据容器: 一种可以容纳多份…

ubuntu20.04设置开机自启动jar(依赖其他服务)

目的: 有的时候我们的项目是部署在物理机上给其他公司员工使用,对于他们来说操作越简单越好。所以我需要实现将我的jar部署在ubuntu上,实现开机自启。(我的项目依赖emqx服务)。 步骤: 切换到system目录 …

直播美颜SDK开发实战:从入门到精通

直播美颜SDK的应用已经成为许多直播平台和开发者关注的焦点。本文将带领读者深入探讨直播美颜SDK的开发实战,从入门到精通的过程。 1.引言 直播美颜SDK是一种集成了图像处理、人脸识别、滤镜算法等技术的开发工具包。通过使用该SDK,开发者能够为直播应…

单节点es 打开文件过多(too many open files)

今天重启es后,发现es服务是启动了,但是实时数据并未写入es数据库,查看日志发现,报错如下图 我看了下正在运行的es程序打开了多少文件(4274是es的pid) 然后再网上搜了很多,说是要调整linux的系统&#xff0c…

深度学习 Day14——P3天气识别

🍨 本文为🔗365天深度学习训练营 中的学习记录博客🍖 原作者:K同学啊 | 接辅导、项目定制 文章目录 前言1 我的环境2 代码实现与执行结果2.1 前期准备2.1.1 引入库2.1.2 设置GPU(如果设备上支持GPU就使用GPU,否则使用C…

2023 re:Invent使用 PartyRock 和 Amazon Bedrock 安全高效构建 AI 应用程序

前言 本篇文章授权活动官方亚马逊云科技文章转发、改写权,包括不限于在 亚马逊云科技开发者社区, 知乎,自媒体平台,第三方开发者媒体等亚马逊云科技官方渠道 “Your Data, Your AI, Your Future.(你的数据,你的AI&…

HarmonyOS保存应用数据

数据管理 1 概述 在移动互联网蓬勃发展的今天,移动应用给我们生活带来了极大的便利,这些便利的本质在于数据的互联互通。因此在应用的开发中数据存储占据了非常重要的位置,HarmonyOS应用开发也不例外。 本文将为您介绍HarmonyOS提供的数据管…

2.82【模块与包】

模块与包 什么是模块 模块就是已经构建好能够实现特定功能的代码的.py文件,在需要实现相应功能的时候可以直接调用该模块的函数或变量 模块化的好处 1.方便维护,代码定位准确 2.内部的变量,相互不影响,方便单个模块功能调试、…

统信UOS上图形化配置系统和应用代理

原文链接:统信UOS上图形化配置系统和应用代理 hello,大家好啊,今天我要给大家介绍的是在统信UOS操作系统上如何通过图形化界面配置系统代理和应用代理。在许多公司的内网环境中,直接访问互联网可能受到限制,但通常会提…

智慧工地源码:为施工企业提供专业落地的解决方案

智慧工地利用物联网、大数据、AI等核心技术,实时采集现场数据,自动分析,精准分析、智能决策、科学评价,形成一套数据驱动的新型管理模式。为施工企业提供生产提效、安全可控、成本节约的项目管理解决方案,提升项目部管…

关于linux 磁盘占用排查问题

1.关于磁盘 查看整体磁盘占用大小 df -h 2. 先排除mysql 数据大小 查询库的大小 SELECT table_schema AS "Database", ROUND(SUM(data_length index_length) / 1024 / 1024, 2) AS "Size (MB)" FROM information_schema.TABLES GROUP BY table_schema…

理解Mysql索引原理及特性

作为开发人员,碰到了执行时间较长的sql时,基本上大家都会说”加个索引吧”。但是索引是什么东西,索引有哪些特性,下面和大家简单讨论一下。 1 索引如何工作,是如何加快查询速度 索引就好比书本的目录,提高数…

【力扣】19. 删除链表的倒数第 N 个结点

19. 删除链表的倒数第 N 个结点 相比于昨天,感觉刷题越来越轻松了~ 我进步了! 以后刷题力度要加快了,因为我报了蓝桥杯!加油~ 法一:计算链表长度 思路: 首先用个函数来计算出该链表的长度,然…

C语言之⽂件操作

一为啥需要文件? 如果没有⽂件,我们写的程序的数据是存储在电脑的内存中,如果程序退出,内存回收,数据就丢失了,等再次运⾏程序,是看不到上次程序的数据的,如果要将数据进⾏持久化的保…

【个人版】SpringBoot下Spring-Security自定义落地篇【三】

背景: 前两篇文章将spring-security的设计架构、核心类、配置及构建过程基本过了一遍,其实很偏理论,如果对源码不感兴趣或项目使用不深,基本可以忽略,毕竟完全理解可能也不会用到,时间长也忘掉了。但是如果…

C语言->动态内存管理

系列文章目录 文章目录 前言 ✅作者简介:大家好,我是橘橙黄又青,一个想要与大家共同进步的男人😉😉 🍎个人主页:橘橙黄又青_C语言,函数,指针-CSDN博客 目的:学习malloc&#xff0c…

动手学深度学习-注意力机制

10.1注意力提示 自主性注意力机制 有意识的注意力机制。非自主性注意力机制 无意识的注意力机制。 小结: 人类的注意力是有限的,有价值和稀缺的资源。受试者使用非自主性和自主性提示有选择的引导注意力,前者基于突出性,后者则依赖于意识。…

Android多国语言翻译 国际化

语言目录详细对应关系 Arabic, Egypt (ar-rEG) —————————–阿拉伯语,埃及 Arabic, Israel (ar-rIL) ——————————-阿拉伯语,以色列 Bulgarian, Bulgaria (bg-rBG) ———————保加利亚语,保加利亚 Catalan, Spain (ca-r…

24年五年制专转本招生院校有可能发生变动

据悉,24年五年制专转本院校可能将发生改变,南京传媒学院有可能停止招生 将新增一所招生大学:南京航空航天大学金城学院 南京航空航天大学金城学院始建于1999年,是南京航空航天大学联合社会力量创办的独立学院。学校位于江苏省南京…