File: test_console.py

package info (click to toggle)
python-cyclopts 3.12.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,288 kB
  • sloc: python: 11,445; makefile: 24
file content (75 lines) | stat: -rw-r--r-- 2,118 bytes parent folder | download | duplicates (2)
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
from contextlib import suppress

import pytest

from cyclopts import App, CycloptsError
from cyclopts.exceptions import UnusedCliTokensError


@pytest.fixture
def subapp(app):
    app.command(subapp := App(name="foo"))
    return subapp


@pytest.mark.parametrize("cmd", ["foo --help", "foo invalid-command"])
def test_root_console(app, mocker, cmd):
    app.console = mocker.MagicMock()

    with suppress(CycloptsError):
        app(cmd, exit_on_error=False)

    app.console.print.assert_called()


@pytest.mark.parametrize("cmd", ["foo --help", "foo invalid-command"])
def test_root_console_subapp(app, subapp, mocker, cmd):
    """Check if root console is properly resolved (subapp.console not specified)."""
    app.console = mocker.MagicMock()

    with suppress(CycloptsError):
        app(cmd, exit_on_error=False)

    app.console.print.assert_called()


@pytest.mark.parametrize("cmd", ["foo --help", "foo invalid-command"])
def test_root_subapp_console(app, subapp, mocker, cmd):
    """Check if subapp console is properly resolved (NOT app.console)."""
    app.console = mocker.MagicMock()
    subapp.console = mocker.MagicMock()

    with suppress(CycloptsError):
        app(cmd, exit_on_error=False)

    app.console.print.assert_not_called()
    subapp.console.print.assert_called()


@pytest.mark.parametrize("cmd", ["foo --help", "foo invalid-command"])
def test_root_subapp_arg_console(app, subapp, mocker, cmd):
    """Explicitly provided console should be used."""
    console = mocker.MagicMock()
    app.console = mocker.MagicMock()
    subapp.console = mocker.MagicMock()

    with suppress(CycloptsError):
        app(cmd, console=console, exit_on_error=False)

    console.print.assert_called()
    app.console.print.assert_not_called()
    subapp.console.print.assert_not_called()


def test_console_populated_issue_103(app):
    """Ensures console is populated for an UnusedCliTokensError.

    https://github.com/BrianPugh/cyclopts/issues/103
    """

    @app.command
    def foo():
        pass

    with pytest.raises(UnusedCliTokensError):
        app("foo bar", exit_on_error=False)