test_util.py

import pytest

from nltk.util import everygrams, usage


def test_usage_with_self(capsys):
    class MyClass:
        def kwargs(self, a=1):
            ...

        def no_args(self):
            ...

        def pos_args(self, a, b):
            ...

        def pos_args_and_kwargs(self, a, b, c=1):
            ...

    usage(MyClass)

    captured = capsys.readouterr()
    assert captured.out == (
        "MyClass supports the following operations:\n"
        "  - self.kwargs(a=1)\n"
        "  - self.no_args()\n"
        "  - self.pos_args(a, b)\n"
        "  - self.pos_args_and_kwargs(a, b, c=1)\n"
    )


def test_usage_with_cls(capsys):
    class MyClass:
        @classmethod
        def clsmethod(cls):
            ...

        @classmethod
        def clsmethod_with_args(cls, a, b, c=1):
            ...

    usage(MyClass)

    captured = capsys.readouterr()
    assert captured.out == (
        "MyClass supports the following operations:\n"
        "  - cls.clsmethod()\n"
        "  - cls.clsmethod_with_args(a, b, c=1)\n"
    )


def test_usage_on_builtin():
    # just check the func passes, since
    # builtins change each python version
    usage(dict)


@pytest.fixture
def everygram_input():
    """Form test data for tests."""
    return iter(["a", "b", "c"])


def test_everygrams_without_padding(everygram_input):
    expected_output = [
        ("a",),
        ("a", "b"),
        ("a", "b", "c"),
        ("b",),
        ("b", "c"),
        ("c",),
    ]
    output = list(everygrams(everygram_input))
    assert output == expected_output


def test_everygrams_max_len(everygram_input):
    expected_output = [
        ("a",),
        ("a", "b"),
        ("b",),
        ("b", "c"),
        ("c",),
    ]
    output = list(everygrams(everygram_input, max_len=2))
    assert output == expected_output


def test_everygrams_min_len(everygram_input):
    expected_output = [
        ("a", "b"),
        ("a", "b", "c"),
        ("b", "c"),
    ]
    output = list(everygrams(everygram_input, min_len=2))
    assert output == expected_output


def test_everygrams_pad_right(everygram_input):
    expected_output = [
        ("a",),
        ("a", "b"),
        ("a", "b", "c"),
        ("b",),
        ("b", "c"),
        ("b", "c", None),
        ("c",),
        ("c", None),
        ("c", None, None),
        (None,),
        (None, None),
        (None,),
    ]
    output = list(everygrams(everygram_input, max_len=3, pad_right=True))
    assert output == expected_output


def test_everygrams_pad_left(everygram_input):
    expected_output = [
        (None,),
        (None, None),
        (None, None, "a"),
        (None,),
        (None, "a"),
        (None, "a", "b"),
        ("a",),
        ("a", "b"),
        ("a", "b", "c"),
        ("b",),
        ("b", "c"),
        ("c",),
    ]
    output = list(everygrams(everygram_input, max_len=3, pad_left=True))
    assert output == expected_output