首页  >  文章  >  后端开发  >  Click 创造奇迹:简化您的 CLI 体验

Click 创造奇迹:简化您的 CLI 体验

Mary-Kate Olsen
Mary-Kate Olsen原创
2024-10-25 09:28:28202浏览

介绍

在这篇博客中,我们将深入探讨 Click 的迷人维度,这是一个 Python 库,可以简化您的 CLI 性能和覆盖范围。我们将讨论创建基本且紧凑的 CLI 所需的概念。这个博客将帮助您制作组织?为您的客户提供更好的 CLI?.

Wonders with Click: Streamline your CLI Experience

Click到底是什么?

点击是一个Python包?这有助于加快 CLI 实用程序的开发。与其他 Python 包相比,此包是开发命令行界面的更简单的选择。这是一个更好的选择,因为它需要最少的编码,并附带许多内置功能,简化开发功能。

掌握 Click 的基础知识

安装:

要安装,请单击运行以下命令。

pip install click

编码:

首先创建一个名为 main.py 的文件,然后使用您喜欢的代码编辑器/ide 打开该文件。现在引入以下代码片段来创建一个基本的 cli 工具?在 main.py

import click

@click.command()
def say_hello():
  click.echo("Hello Bob")

# runs when the file is run directly and not imported
if __name__ == "__main__": 
  say_hello()

这里我们使用 @click.command 装饰器为函数提供更多功能,使其适合 cli 命令(例如:Git 中的 commit、merge、init 等)。而click.echo是python打印函数的定制版本,适合click的需要。

有多个命令

import click

@click.group()
def cli():
  pass

@click.command()
@click.option('--name', prompt='Your name',
              help='The person to greet.')
def say_hello(name):
  click.echo(f'Hello {name}!')

@click.command()
@click.option('--name', prompt='Your name',
              help='The person to greet.')
def say_bye(name):
  click.echo(f'Goodbye {name}!')

@click.command()
@click.option('--num', prompt='Enter a number',type=int ,
              help='The person to greet.')
def give_square(num):
  click.echo(num*num)


# Registering the commands with the CLI
cli.add_command(say_hello)
cli.add_command(say_bye)
cli.add_command(give_square)


if __name__ == "__main__": 
  cli()

@click.option 装饰器将函数转换为能够获取可选值的命令。

要使用此片段在终端中运行以下命令,

python main.py say_hello --name=Kris

使用参数

import click

@click.command()
@click.argument('name')
def say_hello(name):
  click.echo(f"Hello {name}")

# runs when the file is run directly and not imported
if __name__ == "__main__": 
  say_hello()

@click.argument 装饰器将函数转换为一个命令,能够接受 cli 需要提供的参数。

要使用此代码片段在终端中运行以下命令,

python main.py bob

结论

Click 使得在 Python 中构建 命令行界面变得简单直观。它支持多个命令、选项和参数,它是一个功能强大的工具,可以从简单的用例扩展到复杂的用例。

简而言之:

  • 命令组允许您组织多个命令。
  • 命令定义您的 CLI 将执行的操作。
  • 选项和参数允许用户输入来自定义命令行为。

开始尝试使用 Click 来构建你的下一个 Python
项目并看看构建用户友好的 CLI 工具是多么容易!

以上是Click 创造奇迹:简化您的 CLI 体验的详细内容。更多信息请关注PHP中文网其他相关文章!

声明:
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn