import click 用于装饰某些函数以使该函数能从命令行获取执行参数；还可以获取参数执行文档

最新推荐文章于 2025-06-02 09:05:39 发布
最新推荐文章于 2025-06-02 09:05:39 发布
阅读量520 收藏
点赞数
分类专栏： python模块 教程
本文介绍如何使用Python库Click创建命令行接口(CLI)，包括装饰器、参数处理、彩色输出等功能，让CLI开发变得简单直观。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

原文出处：http://funhacks.net/2016/12/20/click/

本篇只是转载

Click 的使用大致有两个步骤：

  1. 使用 @click.command() 装饰一个函数，使之成为命令行接口；
  2. 使用 @click.option() 等装饰函数，为其添加命令行选项等。

定义一个函数，如果使用@click.command()来装饰则会让这个函数通过命令行中所给的的参数进行赋值、计算；

如果再使用@click.option()来装饰则可以给函数参数在命令行中的名称，以及默认值

import click
@click.command()
@click.option('--count', default=1, help='Number of greetings.')
@click.option('--name', prompt='Your name', help='The person to greet.')
def hello(count, name):
    """Simple program that greets NAME for a total of COUNT times."""
    for x in range(count):
        click.echo('Hello %s!' % name)
if __name__ == '__main__':
    hello()

在上面的例子中，函数 hello 有两个参数：count 和 name，它们的值从命令行中获取。

  • @click.command() 使函数 hello 成为命令行接口；
  • @click.option 的第一个参数指定了命令行选项的名称，可以看到，count 的默认值是 1；
  • 使用 click.echo 进行输出是为了获得更好的兼容性，因为 print 在 Python2 和 Python3 的用法有些差别。

看看执行情况：

$ python hello.py
Your name: Ethan           # 这里会显示 'Your name: '(对应代码中的 prompt)，接受用户输入
Hello Ethan!
$ python hello.py --help   # click 帮我们自动生成了 `--help` 用法
Usage: hello.py [OPTIONS]
  Simple program that greets NAME for a total of COUNT times.
Options:
  --count INTEGER  Number of greetings.
  --name TEXT      The person to greet.
  --help           Show this message and exit.
$ python hello.py --count 3 --name Ethan    # 指定 count 和 name 的值
Hello Ethan!
Hello Ethan!
Hello Ethan!
$ python hello.py --count=3 --name=Ethan    # 也可以使用 `=`，和上面等价
Hello Ethan!
Hello Ethan!
Hello Ethan!
$ python hello.py --name=Ethan              # 没有指定 count，默认值是 1
Hello Ethan!

click.option

option 最基本的用法就是通过指定命令行选项的名称，从命令行读取参数值，再将其传递给函数。在上面的例子，我们看到，除了设置命令行选项的名称，我们还会指定默认值，help 说明等，option 常用的设置参数如下：

  • default: 设置命令行参数的默认值
  • help: 参数说明
  • type: 参数类型，可以是 string, int, float 等
  • prompt: 当在命令行中没有输入相应的参数时，会根据 prompt 提示用户输入
  • nargs: 指定命令行参数接收的值的个数

下面，我们再看看相关的例子。

import click
@click.command()
@click.option('--rate', type=float, help='rate')   # 指定 rate 是 float 类型
def show(rate):
    click.echo('rate: %s' % rate)
if __name__ == '__main__':
    show()

执行情况：

$ python click_type.py --rate 1
rate: 1.0
$ python click_type.py --rate 0.66
rate: 0.66

可选值

在某些情况下，一个参数的值只能是某些可选的值，如果用户输入了其他值，我们应该提示用户输入正确的值。在这种情况下，我们可以通过 click.Choice() 来限定：

import click
@click.command()
@click.option('--gender', type=click.Choice(['man', 'woman']))    # 限定值
def choose(gender):
    click.echo('gender: %s' % gender)
if __name__ == '__main__':
    choose()

多值参数

有时，一个参数需要接收多个值。option 支持设置固定长度的参数值，通过 nargs 指定。

看看例子就明白了：

import click
@click.command()
@click.option('--center', nargs=2, type=float, help='center of the circle')
@click.option('--radius', type=float, help='radius of the circle')
def circle(center, radius):
    click.echo('center: %s, radius: %s' % (center, radius))
if __name__ == '__main__':
    circle()

在上面的例子中，option 指定了两个参数：center 和 radius，其中，center 表示二维平面上一个圆的圆心坐标，接收两个值，以元组的形式将值传递给函数，而 radius 表示圆的半径。

执行情况：

$ python click_multi_values.py --center 3 4 --radius 10
center: (3.0, 4.0), radius: 10.0
$ python click_multi_values.py --center 3 4 5 --radius 10
Usage: click_multi_values.py [OPTIONS]
Error: Got unexpected extra argument (5)

输入密码

有时，在输入密码的时候，我们希望能隐藏显示。option 提供了两个参数来设置密码的输入：hide_input 和 confirmation_promt，其中，hide_input 用于隐藏输入，confirmation_promt 用于重复输入。

看看例子：

import click
@click.command()
@click.option('--password', prompt=True, hide_input=True, confirmation_prompt=True)
def input_password(password):
    click.echo('password: %s' % password)
if __name__ == '__main__':
    input_password()

执行情况：

$ python click_password.py
Password:                         # 不会显示密码
Repeat for confirmation:          # 重复一遍
password: 666666

由于上面的写法有点繁琐，click 也提供了一种快捷的方式，通过使用 @click.password_option()，上面的代码可以简写成：

import click
@click.command()
@click.password_option()
def input_password(password):
    click.echo('password: %s' % password)
if __name__ == '__main__':
    input_password()

click.argument

我们除了使用 @click.option 来添加可选参数，还会经常使用 @click.argument 来添加固定参数。它的使用和 option 类似，但支持的功能比 option 少。

入门使用

下面是一个简单的例子：

import click
@click.command()
@click.argument('coordinates')
def show(coordinates):
    click.echo('coordinates: %s' % coordinates)
if __name__ == '__main__':
    show()
$ python click_argument.py                     # 错误，缺少参数 coordinates
Usage: click_argument.py [OPTIONS] COORDINATES
Error: Missing argument "coordinates".
$ python click_argument.py --help              # argument 指定的参数在 help 中没有显示
Usage: click_argument.py [OPTIONS] COORDINATES
Options:
  --help  Show this message and exit.
$ python click_argument.py --coordinates 10    # 错误用法，这是 option 参数的用法
Error: no such option: --coordinates
$ python click_argument.py 10                  # 正确，直接输入值即可
coordinates: 10

多个 argument

我们再来看看多个 argument 的例子：

import click
@click.command()
@click.argument('x')
@click.argument('y')
@click.argument('z')
def show(x, y, z):
    click.echo('x: %s, y: %s, z:%s' % (x, y, z))
if __name__ == '__main__':
    show()

执行情况 ：

$ python click_argument.py 10 20 30
x: 10, y: 20, z:30
$ python click_argument.py 10
Usage: click_argument.py [OPTIONS] X Y Z
Error: Missing argument "y".
$ python click_argument.py 10 20
Usage: click_argument.py [OPTIONS] X Y Z
Error: Missing argument "z".
$ python click_argument.py 10 20 30 40
Usage: click_argument.py [OPTIONS] X Y Z
Error: Got unexpected extra argument (40)

不定参数

argument 还有另外一种常见的用法，就是接收不定量的参数，让我们看看例子：

import click
@click.command()
@click.argument('src', nargs=-1)
@click.argument('dst', nargs=1)
def move(src, dst):
    click.echo('move %s to %s' % (src, dst))
if __name__ == '__main__':
    move()

其中，nargs=-1 表明参数 src 接收不定量的参数值，参数值会以 tuple 的形式传入函数。如果 nargs 大于等于 1，表示接收 nargs 个参数值，上面的例子中，dst 接收一个参数值。

让我们看看执行情况：

$ python click_argument.py file1 trash    # src=('file1',)  dst='trash'
move (u'file1',) to trash
$ python click_argument.py file1 file2 file3 trash   # src=('file1', 'file2', 'file3')  dst='trash'
move (u'file1', u'file2', u'file3') to trash

彩色输出

在前面的例子中，我们使用 click.echo 进行输出，如果配合 colorama 这个模块，我们可以使用 click.secho 进行彩色输出，在使用之前，使用 pip 安装 colorama：

 

$ pip install colorama

import click
@click.command()
@click.option('--name', help='The person to greet.')
def hello(name):
    click.secho('Hello %s!' % name, fg='red', underline=True)
    click.secho('Hello %s!' % name, fg='yellow', bg='black')
if __name__ == '__main__':
    hello()

其中:

  • fg 表示前景颜色（即字体颜色），可选值有：BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE 等；
  • bg 表示背景颜色，可选值有：BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE 等；
  • underline 表示下划线，可选的样式还有：dim=True，bold=True 等；

小结

  • 使用 click.command() 装饰一个函数，使其成为命令行接口。
  • 使用 click.option() 添加可选参数，支持设置固定长度的参数值。
  • 使用 click.argument() 添加固定参数，支持设置不定长度的参数值。
python click模块option
日常博客
05-31 1044
1 2 3 4 import click @click.command() @click.option('--count', default=1, help='Number of greetings.') @click.option('--name', prompt='Your name', help='The person to greet.') def hello(count, name): """Simple program that greets...
python 命令行神器
ronon77的专栏
02-15 603
       命令行神器 Click Click Click 是用 Python 写的一个第三方模块，用于快速创建命令行。我们知道，Python 内置了一个 Argparse 的标准库用于创建命令行，但使用起来有些繁琐，Click 相比于 Argparse，就好比 requests 相比于 urllib。 快速使用 Click 的使用大致有两个步骤： 使用 @click.com...
Click项目深度解析：命令行选项的灵活配置指南
最新发布
gitblog_00441的博客
06-02 400
Click项目深度解析：命令行选项的灵活配置指南 引言 在命令行工具开发中，选项(Options)是增强程序交互性的重要元素。Click作为Python生态中优秀的命令行工具开发框架，提供了强大而灵活的选项配置能力。本文将深入探讨Click项目中各种选项的使用方法和最佳实践。 基础选项配置 基本语法 Click通过@click.option()装饰器为命令添加选项。最基本的选项配置需要指定选项名称...
click option/argument参数详解（click.option()和click.argument()）
liuqinhou的博客
08-05 996
首先定义了一个add()函数，通过click.command()将add()函数装饰成一个命令接口，这样可以直接在命令行上通过“python 文件名.py ”的形式直接调用add()函数，再通过click.option()为add()函数添加选项“--name”，此选项即可通过命令行输入的形式传给add()函数。当然也可以直接在命令行中输入。callback=print_version，表示当命令行中出现--version时，不在执行click既定的命令流程，转而执行print_version()函数。
click option
Claroja
07-03 306
https://click.palletsprojects.com/en/7.x/options/ Name Your Options A name is chosen in the following order If a name is not prefixed, it is used as the Python argument name and not treated as an option name on the command line. If there is at least on
python_click.option()使用
热门推荐
十一姐的博客
08-19 1万+
click官方文档 click官方文档 click的option详细使用 click.command()：将该方法变成一个命令行工具 click.option()：通过指定命令行选项的名称，从命令行读取参数值，再将其传递给函数。 click.option(’–count’, default=1,prompt=‘Your name’,type=int,nargs=1,help=‘Number of...
python用于获取x坐标的函数_通过Python，如何获取鼠标在屏幕上的X、Y轴坐标点
weixin_32721919的博客
02-04 4065
最近在开发基于模拟器的微信自动添加好友工具时，需要获取模拟器中相应按钮，在当前屏幕中的X、Y轴坐标点。先前都是通过“Ctrl+Alt+A”截屏的方式 获取。如下图红框部分所示：由于需要做成通用工具，而且截屏的方式不易操作。所以想通过直接获取鼠标在屏幕中的X、Y坐标点的方式来处理，这样就可以把工作做成傻瓜式，方便操作。获取鼠标的实时位置(X、Y周坐标)主要使用Python的pyautogui第三方库...
python命令行工具Click快速掌握
01-20
Click 只要很少的代码就可以优雅地创造一个命令行工具，它致力于将创建命令行工具的过程变的快速而有趣。 百闻不如一试 安装 pip install Click 使用 创建 click_demo.py ，写一个最简单的函数 import click @...
Python 命令行参数化的几种方式
python122_的博客
04-24 1341
上面通过实例讲解了实现 Python 命令行参数常见的 4 种方式对于一些简单自用且不那么正规的场景，个人觉得可以考虑用 sys.argv 模块快速构建命令行参数；而对一些参数多、面向用户的正式生产环境，建议利用 argparse 模块或 click 依赖来创建命令行参数。
Python应用开发——30天学习Streamlit Python包进行APP的构建（16）：执行流程
此星光明博客
07-16 2026
默认情况下，Streamlit 应用程序会完全执行脚本，但我们允许在应用程序中使用某些功能来处理控制流。
click Arguments
Claroja
07-03 438
https://click.palletsprojects.com/en/7.x/arguments/ Arguments类似 options,但他的位置是固定的 Basic Arguments @click.command() @click.argument('filename') def touch(filename): """Print FILENAME.""" click.echo(filename) Variadic Arguments @click.command() @cli
@click.option
⛄
11-09 783
命令行程序 第一个参数指定了命令行选项的名称 default: 设置命令行参数的默认值 help: 参数说明 type: 参数类型，可以是 string, int, float 等 prompt: 当在命令行中没有输入相应的参数时，会根据 prompt 提示用户输入 nargs: 指定命令行参数接收的值的个数 metavar：如何在帮助页面表示值 ...
Python 命令行之旅：深入 click 之选项篇
HelloGitHub 的博客
11-19 1369
作者：HelloGitHub-Prodesire涉及的示例代码，已同步更新到HelloGitHub-Team 仓库[1]击本文最下方的“阅读原文”即可获取一、前言在上一篇文章中，我们介绍了 click 中的“参数”，本文将继续深入了解 click，着重讲解它的“选项”。本系列文章默认使用 Python 3 作为解释器进行讲解。 若你仍在使用 Python 2，请注意两者之间语法和库的使用差异哦~...
Python 命令行工具 -- click
a0100034930的专栏
01-04 6780
看到一个 Python 的命令行工具 - click，很方便，因此记录下，官方主页：http://click.pocoo.org/3/ 支持： 命令的任意嵌套 自动生成帮助信息 支持在运行时子命令的延迟加载 安装方法是使用 pip： pip install click 下面一小段代码是其官方主页的例子，贴出来下： import click @click.command(
【计算机编程语言-Python3】命令行输入参数的高级玩法-click模块
AI云极的博客
12-29 1813
【计算机编程语言-Python3】命令行输入参数的高级玩法-click模块
python包之click
xueyu188的博客
12-07 1106
click包其实是一个命令行执行的包，也是现在项目脚本执行的时候需要的,所以简单的做个总结。
Python 使用Click自定义命令行参数
一碗烈酒的博客
11-20 4001
安装： pip install click 使用： @click.command() @click.option("--num", default=1, prompt="input run nums:", help="print times") @click.option("--name", default="None", prompt="input your name:", help="name") def demos(num, name): for i in range(num):
Python Click 学习笔记（转）
weixin_34389926的博客
06-10 467
原文链接：Python Click 学习笔记 Click 是 Flask 的团队 pallets 开发的优秀开源项目，它为命令行工具的开发封装了大量方法，使开发者只需要专注于功能实现。恰好我最近在开发的一个小工具需要在命令行环境下操作，就写个学习笔记。 国际惯例，先来一段 “Hello World” 程序（假定已经安装了 Click 包）。 # hello.py import click @cl...
SDIO协议读写SD卡之卡识别模式介绍
ba_wang_mao的专栏
09-08 1851
前言 SD卡的工作模式分为两类，分别为卡识别模式和数据传输模式，在SD卡上电或者主机发出复位命令之后的默认工作模式为卡识别模式。本文主要对卡识别模式进行介绍。 命令简介 在利用SDIO协议进行SD卡驱动开发中，与SPI协议驱动串行Flash类似，也是利用各种不同的命令实现对SD卡的控制。此处进行一个大致的阐述。 命令数量 在SDIO协议中，一共有64个命令，且每个命令的长度均为48-Bits。另外，命令的格式都是固定的，都以0作为起始位，以1作为结束位，唯一不同的便是中间部分的内容，包括传输方向、
python 通过命令行执行代码内不同函数
03-08
<think>好的，我现在需要帮助用户解决如何在Python中通过命令行调用代码文件内的不同函数的问题。首先，我需要理解用户的具体需求。用户可能有一个Python脚本，里面定义了多个函数，他们想通过命令行指定运行其中的某一个函数，而不需要每次都修改代码。这种情况在自动化任务或者脚本工具中很常见，用户希望提高效率，灵活调用不同的功能。 接下来，我要考虑几种常见的方法来实现这个功能。首先想到的是使用命令行参数解析库，比如argparse，这是Python标准库中的模块，适合处理复杂的命令行参数。另外，用户可能也会用到sys.argv来直接获取参数，但这种方法对于简单的情况可能足够，但对于多个函数和参数的情况，argparse会更方便。 另外，如果用户希望更灵活地调用函数，可能需要用到第三方库如click或者fire。这些库可以简化命令行工具的创建，特别是fire，它能够自动生成命令行接口，无需大量配置。不过用户可能需要安装这些库，所以需要提醒他们安装步骤。 然后，我需要考虑用户可能的实际应用场景。比如，用户可能有一个数据处理脚本，里面有数据清洗、分析和可视化的不同函数，他们希望通过命令行参数选择执行哪一个步骤。这种情况下，使用argparse来定义不同的子命令或者参数会比较合适。 接下来，我需要确保给出的示例代码正确且易于理解。比如，使用argparse的例子需要展示如何解析参数并调用对应的函数。同时，要提醒用户需要在脚本中添加if __name__ == "__main__":块，这样在直接运行脚本时才会执行相应的逻辑，而在被导入时不会。 另外，用户可能需要传递参数给函数，所以在示例中要展示如何处理带参数的函数调用。例如，如果函数需要两个数字相加，如何在命令行中传递这两个数字，并将它们转换为正确的类型（如整数或浮点数）。 还要注意错误处理，比如当用户输入的函数不存在时，脚本应该给出友好的提示，而不是抛出异常。这在示例代码中可以通过检查函数名是否在全局变量中存在来实现。 另外，可能需要提到其他方法，比如使用装饰器或者第三方库，但重点放在标准库的方法上，因为用户可能更倾向于不需要额外安装的解决方案。不过，如果第三方库能极大简化操作，也应该简要介绍，让用户知道有更多选择。 最后，需要生成相关问题，帮助用户扩展知识。比如如何传递参数、处理多个函数、使用第三方库等。这些问题应该覆盖用户可能遇到的后续疑问，引导他们深入学习。 总结一下，回答的结构应该是先介绍基本方法（如sys.argv和argparse），然后给出示例代码，再提到其他可选方案（如click和fire），最后生成相关问题。同时，确保所有代码示例符合语法，正确使用命令行参数解析，并提醒用户注意事项，比如函数的存在性检查和参数转换。</think>在Python中通过命令行调用脚本内的特定函数，可通过以下三种方法实现： ### 方法一：基础参数解析（sys.argv） 使用`sys.argv`读取命令行参数并执行对应函数： ```python import sys def func1(): print("执行函数1") def func2(): print("执行函数2") if __name__ == "__main__": if len(sys.argv) < 2: print("请指定函数名") else: func_name = sys.argv[1] if func_name == "func1": func1() elif func_name == "func2": func2() else: print("无效函数名") ``` 调用示例： ```bash python script.py func1 ``` ### 方法二：高级参数处理（argparse） 使用标准库`argparse`创建带参数解析的命令行接口： ```python import argparse def add(x, y): print(f"结果：{x + y}") def greet(name): print(f"你好，{name}!") if __name__ == "__main__": parser = argparse.ArgumentParser() subparsers = parser.add_subparsers(dest='command') # 加法函数 add_parser = subparsers.add_parser('add') add_parser.add_argument('x', type=float) add_parser.add_argument('y', type=float) # 问候函数 greet_parser = subparsers.add_parser('greet') greet_parser.add_argument('name') args = parser.parse_args() if args.command == 'add': add(args.x, args.y) elif args.command == 'greet': greet(args.name) ``` 调用示例： ```bash python script.py add 3 5 python script.py greet 张三 ``` ### 方法三：使用第三方库（Fire） 通过Google开源的`fire`库自动生成CLI： ```python import fire def process_data(input_file, output_file): print(f"处理{input_file} -> {output_file}") def generate_report(format='csv'): print(f"生成{format}格式报告") if __name__ == "__main__": fire.Fire({ 'process': process_data, 'report': generate_report }) ``` 调用示例： ```bash python script.py process input.txt output.txt python script.py report --format=json ``` ### 注意事项 1. **参数类型转换**：命令行参数默认为字符串，需显式转换为`int`/`float` 2. **错误处理**：建议添加`try-except`块捕获参数错误 3. **帮助文档**：使用argparse时会自动生成`--help`文档 4. **环境隔离**：通过`if __name__ == "__main__":`保证模块化调用安全
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值