python 命令行编写

yzqdev大约 2 分钟

python 命令行编写

click

使用多个命令 https://zhuanlan.zhihu.com/p/444506577

本地执行

其中py是alias

function runPython {
   # param (
    #    [string] $file
   # )
    $env:PYTHONPATH=pwd
   # Write-Host $args -BackgroundColor Cyan
     & "$pwd\.venv\Scripts\python.exe"  $args
}

 py .\pytool\hello.py --count 3

我们横向对比下argparse、docopt、click 和 fire 库的各项功能和特点

from setuptools import setup
setup(
    name='py_tool',
    version='0.0.2',
    packages=[''],
    url='',
    license='MIT',
    author='yzqdev',
    author_email='',
    description='',
    install_requires=['click'],
    entry_points={
        'console_scripts': [
            'say = hello:main',
        ]
    }
)

install_requires 是安装的与依赖
entry_points console_scripts指的是命令行工具 say是生成的exe名字,hello是模块名称,main是方法名称

安装到scripts目录(安装到python安装目录的lib下)

python setup.py install

或者

pip install -e .

不是用setup.py

使用pyproject.toml

[build-system]
requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"
  
[project]
name = "my_package"
authors = [
    {name = "Josiah Carberry", email = "josiah_carberry@brown.edu"},
]
description = "My package description"
readme = "README.rst"
requires-python = ">=3.7"
  
keywords = ["one", "two"]
license = {text = "BSD-3-Clause"}
classifiers = [
    "Framework :: Django",
    "Programming Language :: Python :: 3",
]
dependencies = [
    "requests",
    'importlib-metadata; python_version<"3.8"',
]
dynamic = ["version"]
  
[project.optional-dependencies]
pdf = ["ReportLab>=1.2", "RXP"]
rest = ["docutils>=0.3", "pack ==1.1, ==1.3"]
  
[project.scripts]
my-script = "my_package.module:function"

https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html

使用pipx安装本地poetry包

poetry的pyproject.toml添加脚本

```python
[tool.poetry.scripts]
my-script = "my_package.log_revision:start"

项目目录如下

my_package
├── my_package
│   ├── __init__.py
│   └── log_revision.py
└── pyproject.toml

然后

poetry install
poetry run my-script
想要安装到本地可执行文件
pipx install .
更新代码之后重新部署
pipx install . --force
或者 
pipx upgrade my_package
 

然后可执行文件就是 my-script
卸载
pipx uninstall my_package
想要打包发布
poetry build
poetry publish

安装本地cli https://github.com/pypa/pipx/issues/216

如果找不到setuptools 就需要

poetry add setuptools

注意packages这个字段和下面的tool.poetry.scripts字段,poetry install会把script这个命令写进临时环境变量
如果找不到,请用powershell命令gcm python看下python所在位置,正确位置是当前目录的.venv/scripts/python.exe
如果位置不对,请运行./venv/scripts/activate让环境变量生效

[tool.poetry]
name = "py-libs"
version = "0.1.0"
description = ""
authors = ["yzqdev <yzqdev@outlook.com>"]
readme = "README.md"
packages = [{ include = "lib_cmd" }]
[tool.poetry.dependencies]
python = "^3.11"
pymysql = "^1.1.0"
dynaconf = "^3.2.3"
qrcode = "^7.4.2"
click = "^8.1.7"
colorama = "^0.4.6"
rich = "^13.6.0"
[tool.poetry.scripts]
pylib = "lib_cmd.main:main"
[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

main.py

分开是为了防止循环依赖

from lib_cmd.base_cmd import cli


def main():
    cli()

base_cmd.py

import click

from lib_cmd.cmd.http_cmd import http_cmd


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


@cli.command("root")
@click.option("--count", default=1, help="Number of greetings.")
@click.option("--name", prompt="Your name", help="The person to greet.")
def root_cli(count, name):
    """Simple program that greets NAME for a total of COUNT times."""
    for x in range(count):
        click.echo(f"Hello {name}!")


cli.add_command(http_cmd)

http_cmd.py

import click
import colorama
from click.core import Command
 
@click.group("http")
def http_cmd() -> Command:
    """
    初始化数据库

    """
    print("hello")
    pass


@http_cmd.command("drop")
def dropdb():
    """
    删除数据库
    :return:
    """
    click.echo("Dropped the database")

在命令行运行pylib就可以看到帮助命令

python 命令行编写

详情