1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
|
import logging
from contextlib import AbstractContextManager
from contextlib import asynccontextmanager
from contextlib import contextmanager
from types import TracebackType
import pytest
import asyncclick as click
from asyncclick import Context
from asyncclick import Option
from asyncclick import Parameter
from asyncclick.core import ParameterSource
from asyncclick.decorators import help_option
from asyncclick.decorators import pass_meta_key
def test_ensure_context_objects(runner):
class Foo:
def __init__(self):
self.title = "default"
pass_foo = click.make_pass_decorator(Foo, ensure=True)
@click.group()
@pass_foo
def cli(foo):
pass
@cli.command()
@pass_foo
def test(foo):
click.echo(foo.title)
result = runner.invoke(cli, ["test"])
assert not result.exception
assert result.output == "default\n"
def test_get_context_objects(runner):
class Foo:
def __init__(self):
self.title = "default"
pass_foo = click.make_pass_decorator(Foo, ensure=True)
@click.group()
@click.pass_context
def cli(ctx):
ctx.obj = Foo()
ctx.obj.title = "test"
@cli.command()
@pass_foo
def test(foo):
click.echo(foo.title)
result = runner.invoke(cli, ["test"])
assert not result.exception
assert result.output == "test\n"
def test_get_context_objects_no_ensuring(runner):
class Foo:
def __init__(self):
self.title = "default"
pass_foo = click.make_pass_decorator(Foo)
@click.group()
@click.pass_context
def cli(ctx):
ctx.obj = Foo()
ctx.obj.title = "test"
@cli.command()
@pass_foo
def test(foo):
click.echo(foo.title)
result = runner.invoke(cli, ["test"])
assert not result.exception
assert result.output == "test\n"
def test_get_context_objects_missing(runner):
class Foo:
pass
pass_foo = click.make_pass_decorator(Foo)
@click.group()
@click.pass_context
def cli(ctx):
pass
@cli.command()
@pass_foo
def test(foo):
click.echo(foo.title)
result = runner.invoke(cli, ["test"])
assert result.exception is not None
assert isinstance(result.exception, RuntimeError)
assert (
"Managed to invoke callback without a context object of type"
" 'Foo' existing" in str(result.exception)
)
def test_multi_enter(runner):
called = []
@click.command()
@click.pass_context
async def cli(ctx):
def callback():
called.append(True)
ctx.call_on_close(callback)
async with ctx:
pass
assert not called
result = runner.invoke(cli, [])
if result.exception:
raise result.exception
assert called == [True]
def test_global_context_object(runner):
@click.command()
@click.pass_context
def cli(ctx):
assert click.get_current_context() is ctx
ctx.obj = "FOOBAR"
assert click.get_current_context().obj == "FOOBAR"
assert click.get_current_context(silent=True) is None
runner.invoke(cli, [], catch_exceptions=False)
assert click.get_current_context(silent=True) is None
def test_context_meta(runner):
LANG_KEY = f"{__name__}.lang"
def set_language(value):
click.get_current_context().meta[LANG_KEY] = value
def get_language():
return click.get_current_context().meta.get(LANG_KEY, "en_US")
@click.command()
@click.pass_context
def cli(ctx):
assert get_language() == "en_US"
set_language("de_DE")
assert get_language() == "de_DE"
runner.invoke(cli, [], catch_exceptions=False)
def test_make_pass_meta_decorator(runner):
@click.group()
@click.pass_context
def cli(ctx):
ctx.meta["value"] = "good"
@cli.command()
@pass_meta_key("value")
def show(value):
return value
result = runner.invoke(cli, ["show"], standalone_mode=False)
assert result.return_value == "good"
def test_make_pass_meta_decorator_doc():
pass_value = pass_meta_key("value")
assert "the 'value' key from :attr:`click.Context.meta`" in pass_value.__doc__
pass_value = pass_meta_key("value", doc_description="the test value")
assert "passes the test value" in pass_value.__doc__
@pytest.mark.anyio
async def test_context_pushing():
rv = []
@click.command()
def cli():
pass
ctx = click.Context(cli)
@ctx.call_on_close
def test_callback():
rv.append(42)
async with ctx.scope(cleanup=False):
# Internal
assert ctx._depth == 2
assert rv == []
async with ctx.scope():
# Internal
assert ctx._depth == 1
assert rv == [42]
@pytest.mark.anyio
async def test_async_context_mgr():
@asynccontextmanager
async def manager():
val = [1]
yield val
val[0] = 0
@click.command()
def cli():
pass
ctx = click.Context(cli)
async with ctx.scope():
rv = await ctx.with_async_resource(manager())
assert rv[0] == 1, rv
# Internal
assert ctx._depth == 1
assert rv == [0], rv
@pytest.mark.anyio
async def test_context_mgr():
@contextmanager
def manager():
val = [1]
yield val
val[0] = 0
@click.command()
def cli():
pass
ctx = click.Context(cli)
async with ctx.scope():
rv = ctx.with_resource(manager())
assert rv[0] == 1, rv
# Internal
assert ctx._depth == 1
assert rv == [0], rv
def test_pass_obj(runner):
@click.group()
@click.pass_context
def cli(ctx):
ctx.obj = "test"
@cli.command()
@click.pass_obj
def test(obj):
click.echo(obj)
result = runner.invoke(cli, ["test"])
assert not result.exception
assert result.output == "test\n"
def test_close_before_pop(runner):
called = []
@click.command()
@click.pass_context
def cli(ctx):
ctx.obj = "test"
@ctx.call_on_close
def foo():
assert click.get_current_context().obj == "test"
called.append(True)
click.echo("aha!")
result = runner.invoke(cli, [])
assert not result.exception
assert result.output == "aha!\n"
assert called == [True]
@pytest.mark.anyio
async def test_close_before_exit(runner):
called = []
@click.command()
@click.pass_context
async def cli(ctx):
ctx.obj = "test"
@ctx.call_on_close
def foo():
assert click.get_current_context().obj == "test"
called.append(True)
await ctx.aexit()
click.echo("aha!")
result = runner.invoke(cli, [])
assert not result.exception
assert not result.output
assert called == [True]
@pytest.mark.anyio
async def test_aclose_before_exit(runner):
called = []
@click.command()
@click.pass_context
async def cli(ctx):
ctx.obj = "test"
@ctx.call_on_close
def foo():
assert click.get_current_context().obj == "test"
called.append(True)
await ctx.aexit()
click.echo("aha!")
result = runner.invoke(cli, [])
assert not result.exception
assert not result.output
assert called == [True]
@pytest.mark.parametrize(
("cli_args", "expect"),
[
pytest.param(
("--option-with-callback", "--force-exit"),
["ExitingOption", "NonExitingOption"],
id="natural_order",
),
pytest.param(
("--force-exit", "--option-with-callback"),
["ExitingOption"],
id="eagerness_precedence",
),
],
)
def test_multiple_eager_callbacks(runner, cli_args, expect):
"""Checks all callbacks are called on exit, even the nasty ones hidden within
callbacks.
Also checks the order in which they're called.
"""
# Keeps track of callback calls.
called = []
class NonExitingOption(Option):
def reset_state(self):
called.append(self.__class__.__name__)
def set_state(self, ctx: Context, param: Parameter, value: str) -> str:
ctx.call_on_close(self.reset_state)
return value
def __init__(self, *args, **kwargs) -> None:
kwargs.setdefault("expose_value", False)
kwargs.setdefault("callback", self.set_state)
super().__init__(*args, **kwargs)
class ExitingOption(NonExitingOption):
async def set_state(self, ctx: Context, param: Parameter, value: str) -> str:
value = super().set_state(ctx, param, value)
await ctx.aexit()
return value
@click.command()
@click.option("--option-with-callback", is_eager=True, cls=NonExitingOption)
@click.option("--force-exit", is_eager=True, cls=ExitingOption)
def cli():
click.echo("This will never be printed as we forced exit via --force-exit")
result = runner.invoke(cli, cli_args)
assert not result.exception
assert not result.output
assert called == expect
def test_no_state_leaks(runner):
"""Demonstrate state leaks with a specific case of the generic test above.
Use a logger as a real-world example of a common fixture which, due to its global
nature, can leak state if not clean-up properly in a callback.
"""
# Keeps track of callback calls.
called = []
class DebugLoggerOption(Option):
"""A custom option to set the name of the debug logger."""
logger_name: str
"""The ID of the logger to use."""
def reset_loggers(self):
"""Forces logger managed by the option to be reset to the default level."""
logger = logging.getLogger(self.logger_name)
logger.setLevel(logging.NOTSET)
# Logger has been properly reset to its initial state.
assert logger.level == logging.NOTSET
assert logger.getEffectiveLevel() == logging.WARNING
called.append(True)
def set_level(self, ctx: Context, param: Parameter, value: str) -> None:
"""Set the logger to DEBUG level."""
# Keep the logger name around so we can reset it later when winding down
# the option.
self.logger_name = value
# Get the global logger object.
logger = logging.getLogger(self.logger_name)
# Check pre-conditions: new logger is not set, but inherits its level from
# default <root> logger. That's the exact same state we are expecting our
# logger to be in after being messed with by the CLI.
assert logger.level == logging.NOTSET
assert logger.getEffectiveLevel() == logging.WARNING
logger.setLevel(logging.DEBUG)
ctx.call_on_close(self.reset_loggers)
return value
def __init__(self, *args, **kwargs) -> None:
kwargs.setdefault("callback", self.set_level)
super().__init__(*args, **kwargs)
@click.command()
@click.option("--debug-logger-name", is_eager=True, cls=DebugLoggerOption)
@help_option()
@click.pass_context
async def messing_with_logger(ctx, debug_logger_name):
# Introspect context to make sure logger name are aligned.
assert debug_logger_name == ctx.command.params[0].logger_name
logger = logging.getLogger(debug_logger_name)
# Logger's level has been properly set to DEBUG by DebugLoggerOption.
assert logger.level == logging.DEBUG
assert logger.getEffectiveLevel() == logging.DEBUG
logger.debug("Blah blah blah")
await ctx.aexit()
click.echo("This will never be printed as we exited early")
# Call the CLI to mess with the custom logger.
result = runner.invoke(
messing_with_logger, ["--debug-logger-name", "my_logger", "--help"]
)
assert called == [True]
# Check the custom logger has been reverted to it initial state by the option
# callback after being messed with by the CLI.
logger = logging.getLogger("my_logger")
assert logger.level == logging.NOTSET
assert logger.getEffectiveLevel() == logging.WARNING
assert not result.exception
assert result.output.startswith("Usage: messing-with-logger [OPTIONS]")
@pytest.mark.anyio
async def test_with_resource():
@contextmanager
def manager():
val = [1]
yield val
val[0] = 0
ctx = click.Context(click.Command("test"))
async with ctx.scope():
rv = ctx.with_resource(manager())
assert rv[0] == 1
assert rv == [0]
@pytest.mark.anyio
async def test_with_async_resource():
@asynccontextmanager
async def manager():
val = [1]
yield val
val[0] = 0
ctx = click.Context(click.Command("test"))
async with ctx.scope():
rv = await ctx.with_async_resource(manager())
assert rv[0] == 1
assert rv == [0]
@pytest.mark.anyio
async def test_with_resource_exception() -> None:
class TestContext(AbstractContextManager[list[int]]):
_handle_exception: bool
_base_val: int
val: list[int]
def __init__(self, base_val: int = 1, *, handle_exception: bool = True) -> None:
self._handle_exception = handle_exception
self._base_val = base_val
def __enter__(self) -> list[int]:
self.val = [self._base_val]
return self.val
def __exit__(
self,
exc_type: type[BaseException] | None,
exc_value: BaseException | None,
traceback: TracebackType | None,
) -> bool | None:
if not exc_type:
self.val[0] = self._base_val - 1
return None
self.val[0] = self._base_val + 1
return self._handle_exception
class TestException(Exception):
pass
ctx = click.Context(click.Command("test"))
base_val = 1
async with ctx.scope():
rv = ctx.with_resource(TestContext(base_val=base_val))
assert rv[0] == base_val
assert rv == [base_val - 1]
async with ctx.scope():
rv = ctx.with_resource(TestContext(base_val=base_val))
raise TestException()
assert rv == [base_val + 1]
with pytest.raises(TestException):
async with ctx.scope():
rv = ctx.with_resource(
TestContext(base_val=base_val, handle_exception=False)
)
raise TestException()
@pytest.mark.anyio
async def test_with_resource_nested_exception() -> None:
class TestContext(AbstractContextManager[list[int]]):
_handle_exception: bool
_base_val: int
val: list[int]
def __init__(self, base_val: int = 1, *, handle_exception: bool = True) -> None:
self._handle_exception = handle_exception
self._base_val = base_val
def __enter__(self) -> list[int]:
self.val = [self._base_val]
return self.val
def __exit__(
self,
exc_type: type[BaseException] | None,
exc_value: BaseException | None,
traceback: TracebackType | None,
) -> bool | None:
if not exc_type:
self.val[0] = self._base_val - 1
return None
self.val[0] = self._base_val + 1
return self._handle_exception
class TestException(Exception):
pass
ctx = click.Context(click.Command("test"))
base_val = 1
base_val_nested = 11
async with ctx.scope():
rv = ctx.with_resource(TestContext(base_val=base_val))
rv_nested = ctx.with_resource(TestContext(base_val=base_val_nested))
assert rv[0] == base_val
assert rv_nested[0] == base_val_nested
assert rv == [base_val - 1]
assert rv_nested == [base_val_nested - 1]
async with ctx.scope():
rv = ctx.with_resource(TestContext(base_val=base_val))
rv_nested = ctx.with_resource(TestContext(base_val=base_val_nested))
raise TestException()
# If one of the context "eats" the exceptions they will not be forwarded to other
# parts. This is due to how ExitStack unwinding works
assert rv_nested == [base_val_nested + 1]
assert rv == [base_val - 1]
async with ctx.scope():
rv = ctx.with_resource(TestContext(base_val=base_val))
rv_nested = ctx.with_resource(
TestContext(base_val=base_val_nested, handle_exception=False)
)
raise TestException()
assert rv_nested == [base_val_nested + 1]
assert rv == [base_val + 1]
with pytest.raises(TestException):
rv = ctx.with_resource(TestContext(base_val=base_val, handle_exception=False))
rv_nested = ctx.with_resource(
TestContext(base_val=base_val_nested, handle_exception=False)
)
raise TestException()
def test_make_pass_decorator_args(runner):
"""
Test to check that make_pass_decorator doesn't consume arguments based on
invocation order.
"""
class Foo:
title = "foocmd"
pass_foo = click.make_pass_decorator(Foo)
@click.group()
@click.pass_context
def cli(ctx):
ctx.obj = Foo()
@cli.command()
@click.pass_context
@pass_foo
def test1(foo, ctx):
click.echo(foo.title)
@cli.command()
@pass_foo
@click.pass_context
def test2(ctx, foo):
click.echo(foo.title)
result = runner.invoke(cli, ["test1"])
assert not result.exception
assert result.output == "foocmd\n"
result = runner.invoke(cli, ["test2"])
assert not result.exception
assert result.output == "foocmd\n"
def test_propagate_show_default_setting(runner):
"""A context's ``show_default`` setting defaults to the value from
the parent context.
"""
group = click.Group(
commands={
"sub": click.Command("sub", params=[click.Option(["-a"], default="a")]),
},
context_settings={"show_default": True},
)
result = runner.invoke(group, ["sub", "--help"])
assert "[default: a]" in result.output
@pytest.mark.anyio
async def test_exit_not_standalone():
@click.command()
@click.pass_context
async def cli(ctx):
await ctx.aexit(1)
assert await cli.main([], "test_exit_not_standalone", standalone_mode=False) == 1
@click.command()
@click.pass_context
async def cli(ctx):
await ctx.aexit(0)
assert await cli.main([], "test_exit_not_standalone", standalone_mode=False) == 0
@pytest.mark.parametrize(
("option_args", "invoke_args", "expect"),
[
pytest.param({}, {}, ParameterSource.DEFAULT, id="default"),
pytest.param(
{},
{"default_map": {"option": 1}},
ParameterSource.DEFAULT_MAP,
id="default_map",
),
pytest.param(
{},
{"args": ["-o", "1"]},
ParameterSource.COMMANDLINE,
id="commandline short",
),
pytest.param(
{},
{"args": ["--option", "1"]},
ParameterSource.COMMANDLINE,
id="commandline long",
),
pytest.param(
{},
{"auto_envvar_prefix": "TEST", "env": {"TEST_OPTION": "1"}},
ParameterSource.ENVIRONMENT,
id="environment auto",
),
pytest.param(
{"envvar": "NAME"},
{"env": {"NAME": "1"}},
ParameterSource.ENVIRONMENT,
id="environment manual",
),
],
)
def test_parameter_source(runner, option_args, invoke_args, expect):
@click.command()
@click.pass_context
@click.option("-o", "--option", default=1, **option_args)
def cli(ctx, option):
return ctx.get_parameter_source("option")
rv = runner.invoke(cli, standalone_mode=False, **invoke_args)
assert rv.return_value == expect
def test_propagate_opt_prefixes():
parent = click.Context(click.Command("test"))
parent._opt_prefixes = {"-", "--", "!"}
ctx = click.Context(click.Command("test2"), parent=parent)
assert ctx._opt_prefixes == {"-", "--", "!"}
|