click python cli 开发包

朱雀 2023-10-06 20:02 75阅读 0赞

python click 包是一个方便的cli 开发包，我们可以用来开发强大的cli 应用

> 使用venv 进行环境准备，示例代码来自官方

### venv 环境准备 ###

python3 -m venv demoapp

### 安装 ###

pip install click

### 基本使用 ###

*  代码
    
    > cli.py

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 _ in range(count):
            click.echo("Hello, %s!" % name)
    
    if __name__ == '__main__':
        hello()

*  运行

python cli.py

效果

python cli.py 
    Your name: dalong
    Hello, dalong!

### 制作一个pip 包 ###

> 制作pip 包可以方便进行我们的代码分发,还是使用venv 进行环境的准备

*  项目结构

├── README.md
    ├── cli
    │ └── __init__.py
    └── setup.py

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAMTAyNOWwj-elng_size_20_color_FFFFFF_t_70_g_se_x_16][]

*  代码说明  
    cli/**init**.py 核心代码

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 _ in range(count):
            click.echo("Hello, %s!" % name)
    
    if __name__ == '__main__':
        hello()

setup.py pip 包配置

import setuptools
    with open("README.md", "r") as fh:
        long_description = fh.read()
    
    setuptools.setup(
        name="dalongrong_cli-demo",
        version="0.0.1",
        author="dalongrong",
        author_email="1141591465@qq.com",
        description="a simple cli project",
        long_description=long_description,
        install_requires=['click'],
        long_description_content_type="text/markdown",
        url="https://github.com/rongfengliang/click-cli-demo.git",
        packages=setuptools.find_packages(),
        classifiers=[
            "Programming Language :: Python :: 3",
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
        ],
        entry_points={
            'console_scripts': [
                'dalongcli=cli:hello',
            ],
        }
    )

*  本地安装测试

pip install .

cli 使用命令

dalongcli --name dalong --count 3

效果

Hello, dalong!
    Hello, dalong!
    Hello, dalong!

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAMTAyNOWwj-elng_size_20_color_FFFFFF_t_70_g_se_x_16 1][]

*  说明  
    比较好的方法是push 到pip 私服（企业内部），或者push 到公共pip 仓库，方便大家都使用，具体的可以参考 [自定义pip 开发][pip]

### 参考资料 ###

[https://github.com/pallets/click][https_github.com_pallets_click]  
[Welcome to Click — Click Documentation (7.x)][Welcome to Click _ Click Documentation _7.x]  
[自定义pip 包开发简单说明 - 荣锋亮 - 博客园][pip]  
[https://github.com/rongfengliang/click-cli-demo][https_github.com_rongfengliang_click-cli-demo]  
[Packaging and distributing projects — Python Packaging User Guide][Packaging and distributing projects _ Python Packaging User Guide]

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAMTAyNOWwj-elng_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/528a72d4e351459c918efe3a27af126d.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBAMTAyNOWwj-elng==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAMTAyNOWwj-elng_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/ab5d3528ce354aecaf732ed0af767e44.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBAMTAyNOWwj-elng==,size_20,color_FFFFFF,t_70,g_se,x_16
[pip]: https://www.cnblogs.com/rongfengliang/p/10219292.html
[https_github.com_pallets_click]: https://github.com/pallets/click
[Welcome to Click _ Click Documentation _7.x]: https://click.palletsprojects.com/en/7.x/
[https_github.com_rongfengliang_click-cli-demo]: https://github.com/rongfengliang/click-cli-demo
[Packaging and distributing projects _ Python Packaging User Guide]: https://packaging.python.org/guides/distributing-packages-using-setuptools/#install-requires