File: test_alias.py

package info (click to toggle)
ipython 9.8.0-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 8,624 kB
  • sloc: python: 45,268; sh: 317; makefile: 168
file content (68 lines) | stat: -rw-r--r-- 1,988 bytes parent folder | download
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
from IPython.utils.capture import capture_output

import pytest


def test_alias_lifecycle():
    name = "test_alias1"
    cmd = 'echo "Hello"'
    am = _ip.alias_manager
    am.clear_aliases()
    am.define_alias(name, cmd)
    assert am.is_alias(name)
    assert am.retrieve_alias(name) == cmd
    assert (name, cmd) in am.aliases

    # Test running the alias
    orig_system = _ip.system
    result = []
    _ip.system = result.append
    try:
        _ip.run_cell("%{}".format(name))
        result = [c.strip() for c in result]
        assert result == [cmd]
    finally:
        _ip.system = orig_system

    # Test removing the alias
    am.undefine_alias(name)
    assert not am.is_alias(name)
    with pytest.raises(ValueError):
        am.retrieve_alias(name)
    assert (name, cmd) not in am.aliases


def test_alias_args_error():
    """Error expanding with wrong number of arguments"""
    _ip.alias_manager.define_alias("parts", "echo first %s second %s")
    # capture stderr:
    with capture_output() as cap:
        _ip.run_cell("parts 1")

    assert cap.stderr.split(":")[0] == "UsageError"


def test_alias_args_commented():
    """Check that alias correctly ignores 'commented out' args"""
    _ip.run_line_magic("alias", "commentarg echo this is %%s a commented out arg")

    with capture_output() as cap:
        _ip.run_cell("commentarg")

    # strip() is for pytest compat; testing via iptest patch IPython shell
    # in testing.globalipapp and replace the system call which messed up the
    # \r\n
    assert cap.stdout.strip() == "this is %s a commented out arg"


def test_alias_args_commented_nargs():
    """Check that alias correctly counts args, excluding those commented out"""
    am = _ip.alias_manager
    alias_name = "comargcount"
    cmd = "echo this is %%s a commented out arg and this is not %s"

    am.define_alias(alias_name, cmd)
    assert am.is_alias(alias_name)

    thealias = am.get_alias(alias_name)
    assert thealias.nargs == 1