如何将ctx(Context)传递给CliRunner?

时间:2016-11-05 21:25:05

标签: python python-click

CliRunner列出了无法在documentation中提供上下文的参数。

以下内容应符合最低工作范例。 真正的问题有点不同。 可以通过将单击修饰函数移动到其自己的测试覆盖功能中来解决。然后点击功能几乎无用。

import click
from click.testing import CliRunner

class Config():
    def __init__(self):
        self.value = 651

@click.command()
@click.pass_context
def print_numberinfo(ctx):
    if not hasattr(ctx.obj, 'value'):
        ctx.obj = Config()
    click.echo(ctx.obj.value)

def test_print_numberinfo():
    ctx = click.Context(print_numberinfo, obj = Config())
    ctx.obj.value = 777
    runner = CliRunner()
    # how do I pass ctx to runner.invoke?
    result = runner.invoke(print_numberinfo)
    assert result.output == str(ctx.obj.value) + '\n'

2 个答案:

答案 0 :(得分:4)

您可以直接将Config个实例作为关键字参数obj传递给runner.invoke

import click
from click.testing import CliRunner

class Config():
    def __init__(self):
        self.value = 651

@click.command()
@click.pass_obj
def print_numberinfo(obj):
    if not hasattr(obj, 'value'):
        obj = Config()
    click.echo(obj.value)

def test_print_numberinfo():
    obj = Config()
    obj.value = 777
    runner = CliRunner()
    # how do I pass ctx to runner.invoke?
    result = runner.invoke(print_numberinfo, obj=obj)
    assert result.output == str(obj.value) + '\n'

答案 1 :(得分:0)

对于只想制作context.obj的人来说,其工作方式类似于从命令行调用:

CliRunner().invoke(commands.cli, ['sayhello'], catch_exceptions=False)

第一个参数应该是click的根组,然后可以将要调用的命令传递给第二个参数(即sayhello)。


commands.py的样子:

# !/usr/bin/env python
# coding: utf-8
import click


@click.group()
@click.pass_context
def cli(ctx):
    ctx.obj = {
        'foo': 'bar'
    }


@cli.command()
@click.pass_context
def sayehello(ctx):
    click.echo('hello!' + ctx.obj)


感谢geowurster提供解决方案。