python的click命令行cli工具使用

 更新时间:2026年04月05日 09:42:24   作者:一方_self  
本文主要介绍了使用Python的click库将函数转换为命令行工具的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

💡 关于通过简单的代码就能让一个python文件中的函数变成一个cli命令行工具。

安装

pip install click

简单使用

1、创建文件

创建一个hello.py文件,代码如下:

import click
@click.command()
def hi():    
    click.echo("Hello, World!")
    
if __name__ == '__main__':
    hi()

2、执行

如果使用@click.command()的话,那么只能有一个命令,这里我们就要用到@click.group(),声明一个组后就可以使用多个命令了,如:

import click

# 1. 声明一个组
@click.group()
def cli():    
    """附件管理工具 - 支持搜索、删除等操作"""    
    pass# 
    
2. 将命令挂载到组上(使用 @cli.command 而不是 @click.command)
@cli.command()
@click.option('--name', help='文件夹名称')
def create(name):    
    """新建一个案例文件夹"""    
    click.echo(f"正在创建文件夹: {name}")
    
@cli.command()
@click.argument('keyword')
    def search(keyword):    
        """搜索指定的附件"""    
        click.echo(f"正在搜索关键字: {keyword}")

# 3. 运行组
if __name__ == '__main__':    
    cli()

如果不加命令名称运行:

默认打印命令介绍。

此时就需要指定命令名运行了:

此时我没有加参数运行,结果打印的文件夹名为None,加一个名称再打印:

OK!可以正常拿到参数值了。

到此这篇关于python的click命令行cli工具使用的文章就介绍到这了,更多相关python cli工具内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • python输入多行的方法总结

    python输入多行的方法总结

    Python中的Input()函数在输入时,遇到回车符,那么一次输入就结束了,这不能满足输入多行文本并且行数也不确定的情形,当然输入空行也是允许的,本文给大家总结了python输入多行的方法,需要的朋友可以参考下
    2024-04-04
  • python+opencv实现动态物体识别

    python+opencv实现动态物体识别

    这篇文章主要为大家详细介绍了python+opencv实现动态物体识别,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-01-01
  • python使用urllib模块和pyquery实现阿里巴巴排名查询

    python使用urllib模块和pyquery实现阿里巴巴排名查询

    这篇文章主要介绍了python库urllib及pyquery基本东西的应用,实现阿里巴巴关键词排名的查询,其中涉及到urllib代理的设置,pyquery对html文档的解析
    2014-01-01
  • Python实现CAN报文转换工具教程

    Python实现CAN报文转换工具教程

    这篇文章主要介绍了Python实现CAN报文转换工具教程,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-05-05
  • 使用graphics.py实现2048小游戏

    使用graphics.py实现2048小游戏

    本文给大家分享的是使用Python实现2048小游戏的源码,非QT实现的哦,推荐给大家,有需要的小伙伴参考下吧。
    2015-03-03
  • pyqt5 使用label控件实时显示时间的实例

    pyqt5 使用label控件实时显示时间的实例

    今天小编就为大家分享一篇pyqt5 使用label控件实时显示时间的实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-06-06
  • 详解Python中的Dict

    详解Python中的Dict

    这篇文章主要为大家介绍了Python中的Dict,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2021-12-12
  • Pytest使用fixture实现token共享的方法

    Pytest使用fixture实现token共享的方法

    同学们在做pytest接口自动化时,会遇到一个场景就是不同的测试用例需要有一个登录的前置步骤,登录完成后会获取到token,用于之后的代码中,本文给大家介绍Pytest使用fixture实现token共享的方法,感兴趣的朋友一起看看吧
    2023-11-11
  • 从源码到Docker全方位解析Python项目打包完整指南

    从源码到Docker全方位解析Python项目打包完整指南

    在实际开发中,将Python项目打包成可部署的格式是一个至关重要的环节,本文将全面介绍Python项目的各种打包方式,从基础的分发打包到现代化的Docker容器化部署,希望对大家有所帮助
    2025-11-11
  • python使用urllib2模块获取gravatar头像实例

    python使用urllib2模块获取gravatar头像实例

    python使用urllib2模块获取gravatar头像的实例,大家参考使用吧
    2013-12-12

最新评论