跳转到主要内容

在click中启用类似git的*did-you-mean*功能

项目描述

Latest version released on PyPi Build status of the master branch Package license

在click中启用类似git的did-you-mean功能。

它非常简单

import click
from click_didyoumean import DYMGroup

@click.group(cls=DYMGroup)
def cli():
    ...

Demo

用法

使用pip安装此扩展

pip install click-didyoumean

为您的cli使用特定的did-you-mean group

import click
from click_didyoumean import DYMGroup

@click.group(cls=DYMGroup)
def cli():
    pass

@cli.command()
def foo():
    pass

@cli.command()
def bar():
    pass

@cli.command()
def barrr():
    pass

if __name__ == "__main__":
    cli()

或者在CommandCollection中使用它

import click
from click_didyoumean import DYMCommandCollection

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

@cli1.command()
def foo():
    pass

@cli1.command()
def bar():
    pass

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

@cli2.command()
def barrr():
    pass

cli = DYMCommandCollection(sources=[cli1, cli2])

if __name__ == "__main__":
    cli()

更改配置

对于DYMGroupDYMCommandCollection有两种配置

参数

类型

默认值

描述

max_suggestions

int

3

最大did-you-mean建议数

cutoff

float

0.5

得分至少不低于该相似度水平的可能性将被忽略。

示例

@cli.group(cls=DYMGroup, max_suggestions=2, cutoff=0.7)
def cli():
    pass

... or ...

cli = DYMCommandCollection(sources=[cli1, cli2], max_suggestions=2, cutoff=0.7)

项目详情


下载文件

下载适合您的平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码分布

click_didyoumean-0.3.1.tar.gz (3.1 kB 查看哈希值)

上传时间

构建分布

click_didyoumean-0.3.1-py3-none-any.whl (3.6 kB 查看哈希值)

上传时间: Python 3

由以下支持