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
|
"""Test nodes utilities."""
from __future__ import annotations
import logging
from ast import PyCF_ONLY_AST
import pytest
from griffe import Expr, ExprName, module_vtree, relative_to_absolute, temporary_visited_module
syntax_examples = [
# Operations.
"b + c",
"b - c",
"b * c",
"b / c",
"b // c",
"b ** c",
"b ^ c",
"b & c",
"b | c",
"b @ c",
"b % c",
"b >> c",
"b << c",
# Unary operations.
"+b",
"-b",
"~b",
# Comparisons.
"b == c",
"b >= c",
"b > c",
"b <= c",
"b < c",
"b != c",
# Boolean logic.
"b and c",
"b or c",
"not b",
# Identify.
"b is c",
"b is not c",
# Membership.
"b in c",
"b not in c",
# Calls.
"call()",
"call(something)",
"call(something=something)",
# Strings.
"f'a {round(key, 2)} {z}'",
# Slices.
"o[x]",
"o[x, y]",
"o[x:y]",
"o[x:y, z]",
"o[x, y(z)]",
# Walrus operator.
"a if (a := b) else c",
# Starred.
"a(*b, **c)",
# Structs.
"(a, b, c)",
"{a, b, c}",
"{a: b, c: d}",
"[a, b, c]",
# Yields.
"yield",
"yield a",
"yield from a",
# Lambdas.
"lambda a: a",
"lambda a, b: a",
"lambda *a, **b: a",
"lambda a, b=0: a",
"lambda a, /, b, c: a",
"lambda a, *, b, c: a",
"lambda a, /, b, *, c: a",
]
@pytest.mark.parametrize(
("code", "path", "is_package", "expected"),
[
("from . import b", "a", False, "a.b"),
("from . import b", "a", True, "a.b"),
("from . import c", "a.b", False, "a.c"),
("from . import c", "a.b", True, "a.b.c"),
("from . import d", "a.b.c", False, "a.b.d"),
("from .c import d", "a", False, "a.c.d"),
("from .c import d", "a.b", False, "a.c.d"),
("from .b import c", "a.b", True, "a.b.b.c"),
("from .. import e", "a.c.d.i", False, "a.c.e"),
("from ..d import e", "a.c.d.i", False, "a.c.d.e"),
("from ... import f", "a.c.d.i", False, "a.f"),
("from ...b import f", "a.c.d.i", False, "a.b.f"),
("from ...c.d import e", "a.c.d.i", False, "a.c.d.e"),
("from .c import *", "a", False, "a.c.*"),
("from .c import *", "a.b", False, "a.c.*"),
("from .b import *", "a.b", True, "a.b.b.*"),
("from .. import *", "a.c.d.i", False, "a.c.*"),
("from ..d import *", "a.c.d.i", False, "a.c.d.*"),
("from ... import *", "a.c.d.i", False, "a.*"),
("from ...b import *", "a.c.d.i", False, "a.b.*"),
("from ...c.d import *", "a.c.d.i", False, "a.c.d.*"),
],
)
def test_relative_to_absolute_imports(code: str, path: str, is_package: bool, expected: str) -> None:
"""Check if relative imports are correctly converted to absolute ones.
Parameters:
code: The parametrized module code.
path: The parametrized module path.
is_package: Whether the module is a package (or subpackage) (parametrized).
expected: The parametrized expected absolute path.
"""
node = compile(code, mode="exec", filename="<>", flags=PyCF_ONLY_AST).body[0] # type: ignore[attr-defined]
module = module_vtree(path, leaf_package=is_package, return_leaf=True)
for name in node.names:
assert relative_to_absolute(node, name, module) == expected
def test_multipart_imports() -> None:
"""Assert that a multipart path like `a.b.c` imported as `x` points to the right target."""
with temporary_visited_module(
"""
import pkg.b.c
import pkg.b.c as alias
""",
) as module:
pkg = module["pkg"]
alias = module["alias"]
assert pkg.target_path == "pkg"
assert alias.target_path == "pkg.b.c"
@pytest.mark.parametrize(
"expression",
[
"A",
"A.B",
"A[B]",
"A.B[C.D]",
"~A",
"A | B",
"A[[B, C], D]",
"A(b=c, d=1)",
"A[-1, +2.3]",
"A[B, C.D(e='syntax error')]",
],
)
def test_building_annotations_from_nodes(expression: str) -> None:
"""Test building annotations from AST nodes.
Parameters:
expression: An expression (parametrized).
"""
class_defs = "\n\n".join(f"class {letter}: ..." for letter in "ABCD")
with temporary_visited_module(f"{class_defs}\n\nx: {expression}\ny: {expression} = 0") as module:
assert "x" in module.members
assert "y" in module.members
assert str(module["x"].annotation) == expression
assert str(module["y"].annotation) == expression
@pytest.mark.parametrize("code", syntax_examples)
def test_building_expressions_from_nodes(code: str) -> None:
"""Test building annotations from AST nodes.
Parameters:
code: An expression (parametrized).
"""
with temporary_visited_module(f"__z__ = {code}") as module:
assert "__z__" in module.members
# Make space after comma non-significant.
value = str(module["__z__"].value).replace(", ", ",")
assert value == code.replace(", ", ",")
@pytest.mark.parametrize(
("code", "has_name"),
[
("import typing\nclass A: ...\na: typing.Literal['A']", False),
("from typing import Literal\nclass A: ...\na: Literal['A']", False),
("import typing_extensions\nclass A: ...\na: typing.Literal['A']", False),
("from typing_extensions import Literal\nclass A: ...\na: Literal['A']", False),
("from mod import A\na: 'A'", True),
("from mod import A\na: list['A']", True),
],
)
def test_forward_references(code: str, has_name: bool) -> None:
"""Check that we support forward references (type names as strings).
Parameters:
code: Parametrized code.
has_name: Whether the annotation should contain a Name rather than a string.
"""
with temporary_visited_module(code) as module:
annotation = list(module["a"].annotation.iterate(flat=True))
if has_name:
assert any(isinstance(item, ExprName) and item.name == "A" for item in annotation)
assert all(not (isinstance(item, str) and item == "A") for item in annotation)
else:
assert "'A'" in annotation
assert all(not (isinstance(item, ExprName) and item.name == "A") for item in annotation)
@pytest.mark.parametrize(
"default",
[
"1",
"'test_string'",
"dict(key=1)",
"{'key': 1}",
"DEFAULT_VALUE",
"None",
],
)
def test_default_value_from_nodes(default: str) -> None:
"""Test getting default value from AST nodes.
Parameters:
default: A default value (parametrized).
"""
module_defs = f"def f(x={default}):\n return x"
with temporary_visited_module(module_defs) as module:
assert "f" in module.members
params = module.members["f"].parameters # type: ignore[union-attr]
assert len(params) == 1
assert str(params[0].default) == default
# https://github.com/mkdocstrings/griffe/issues/159
def test_parsing_complex_string_annotations() -> None:
"""Test parsing of complex, stringified annotations."""
with temporary_visited_module(
"""
class ArgsKwargs:
def __init__(self, args: 'tuple[Any, ...]', kwargs: 'dict[str, Any] | None' = None) -> None:
...
@property
def args(self) -> 'tuple[Any, ...]':
...
@property
def kwargs(self) -> 'dict[str, Any] | None':
...
""",
) as module:
init_args_annotation = module["ArgsKwargs.__init__"].parameters["args"].annotation
assert isinstance(init_args_annotation, Expr)
assert init_args_annotation.is_tuple
kwargs_return_annotation = module["ArgsKwargs.kwargs"].annotation
assert isinstance(kwargs_return_annotation, Expr)
def test_parsing_dynamic_base_classes(caplog: pytest.LogCaptureFixture) -> None:
"""Assert parsing dynamic base classes does not trigger errors.
Parameters:
caplog: Pytest fixture to capture logs.
"""
with (
caplog.at_level(logging.ERROR),
temporary_visited_module(
"""
from collections import namedtuple
class Thing(namedtuple('Thing', 'attr1 attr2')):
...
""",
),
):
pass
assert not caplog.records
|