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
|
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/pylint-dev/pylint/blob/main/LICENSE
# Copyright (c) https://github.com/pylint-dev/pylint/blob/main/CONTRIBUTORS.txt
"""Unit tests for utils functions in :mod:`pylint.extensions._check_docs_utils`."""
from __future__ import annotations
import astroid
import pytest
from astroid import nodes
from pylint.extensions import _check_docs_utils as utils
@pytest.mark.parametrize(
"string,count",
[("abc", 0), ("", 0), (" abc", 2), ("\n abc", 0), (" \n abc", 3)],
)
def test_space_indentation(string: str, count: int) -> None:
"""Test for pylint_plugin.ParamDocChecker."""
assert utils.space_indentation(string) == count
@pytest.mark.parametrize(
"raise_node,expected",
[
(
astroid.extract_node(
"""
def my_func():
raise NotImplementedError #@
"""
),
{"NotImplementedError"},
),
(
astroid.extract_node(
"""
def my_func():
raise NotImplementedError("Not implemented!") #@
"""
),
{"NotImplementedError"},
),
(
astroid.extract_node(
"""
def my_func():
try:
fake_func()
except RuntimeError:
raise #@
"""
),
{"RuntimeError"},
),
(
astroid.extract_node(
"""
def my_func():
try:
fake_func()
except RuntimeError:
if another_func():
raise #@
"""
),
{"RuntimeError"},
),
(
astroid.extract_node(
"""
def my_func():
try:
fake_func()
except RuntimeError:
try:
another_func()
raise #@
except NameError:
pass
"""
),
{"RuntimeError"},
),
(
astroid.extract_node(
"""
def my_func():
try:
fake_func()
except RuntimeError:
try:
another_func()
except NameError:
raise #@
"""
),
{"NameError"},
),
(
astroid.extract_node(
"""
def my_func():
try:
fake_func()
except:
raise #@
"""
),
set(),
),
(
astroid.extract_node(
"""
def my_func():
try:
fake_func()
except (RuntimeError, ValueError):
raise #@
"""
),
{"RuntimeError", "ValueError"},
),
(
astroid.extract_node(
"""
import not_a_module
def my_func():
try:
fake_func()
except not_a_module.Error:
raise #@
"""
),
set(),
),
],
)
def test_exception(raise_node: nodes.NodeNG, expected: set[str]) -> None:
found_nodes = utils.possible_exc_types(raise_node)
for node in found_nodes:
assert isinstance(node, astroid.nodes.ClassDef)
assert {node.name for node in found_nodes} == expected
def test_possible_exc_types_raising_potential_none() -> None:
raise_node = astroid.extract_node(
"""
def a():
return
raise a() #@
"""
)
assert utils.possible_exc_types(raise_node) == set()
|