如何通过多个命令组为Python Click设置控制台脚本的入口点?

时间:2019-01-08 08:01:48

标签: python command-line console setuptools python-click

鉴于我的foobar.py库已这样设置:

\foobar.py
\foobar
    \__init__.py
\setup.py

控制台脚本中的CLI层次结构:

foobar.py
    \cli
         \foo
             \kungfu
             \kungpow
         \bar
             \blacksheep
             \haveyouanywool

[代码]:

import click

CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])


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

@cli.group(context_settings=CONTEXT_SETTINGS)
def foo():
    pass

@cli.group(context_settings=CONTEXT_SETTINGS)
def bar():
    pass

@foo.command('kungfu')
def kungfu():
    print('bruise lee')

@foo.command('kungpow')
def kungpow():
    print('chosen one')

@bar.command('blacksheep')
def blacksheep():
    print('bah bah blacksheep')

@bar.command('haveyouanywool')
def haveyouanywool():
    print('have you any wool?')

如何在setup.py中设置条目?

有很多示例,但是它们仅显示单个入口点的单个命令,例如Entry Points in setup.py

但是是否甚至可以使用foobar.py点击脚本的结构来设置控制台脚本?

如果没有,我应该如何重组foobar.py中的命令?


对于上下文,我有一个sacremoses库的脚本:https://github.com/alvations/sacremoses/blob/cli/sacremoses.py

但是我不知道如何配置setup.py来正确安装sacremoses.py脚本:https://github.com/alvations/sacremoses/blob/cli/setup.py

1 个答案:

答案 0 :(得分:3)

要使入口点在您的示例中起作用,您需要:

entry_points='''
    [console_scripts]
    command_line_name=foobar:cli
''',

您所缺少的是对以下含义的理解:

command_line_name=foobar:cli

[console_scripts]

command_line_name=foobar:cli中有三件事:

  1. 命令行(command_line_name)中的脚本名称
  2. 点击命令处理程序所在的模块(foobar
  3. 该模块中的点击命令/组的名称(cli

setup.py

对于您的github示例,我建议:

from distutils.core import setup
import setuptools

console_scripts = """
[console_scripts]
sacremoses=sacremoses.cli:cli
"""

setup(
    name='sacremoses',
    packages=['sacremoses'],
    version='0.0.7',
    description='SacreMoses',
    long_description='LGPL MosesTokenizer in Python',
    author='',
    license='',
    package_data={'sacremoses': [
        'data/perluniprops/*.txt', 
        'data/nonbreaking_prefixes/nonbreaking_prefix.*'
    ]},
    url='https://github.com/alvations/sacremoses',
    keywords=[],
    classifiers=[],
    install_requires=['six', 'click', 'joblib', 'tqdm'],
    entry_points=console_scripts,
)

命令处理程序

在github存储库的引用分支中,没有cli.py文件。问题中的 [代码] 需要保存在sacremoses/cli.py中,然后与对setup.py的建议更改结合使用,一切正常。