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 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
|
# Licensed under the LGPL: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html
# For details: https://github.com/pylint-dev/astroid/blob/main/LICENSE
# Copyright (c) https://github.com/pylint-dev/astroid/blob/main/CONTRIBUTORS.txt
from __future__ import annotations
import contextlib
import unittest
from collections.abc import Callable, Iterator
from typing import Any
import pytest
import astroid
from astroid import extract_node, nodes
from astroid.const import PY312_PLUS
from astroid.exceptions import InferenceError
from astroid.manager import AstroidManager
from astroid.util import Uninferable, UninferableBase
@contextlib.contextmanager
def _add_transform(
manager: AstroidManager,
node: type,
transform: Callable,
predicate: Any | None = None,
) -> Iterator:
manager.register_transform(node, transform, predicate)
try:
yield
finally:
manager.unregister_transform(node, transform, predicate)
class ProtocolTests(unittest.TestCase):
def assertConstNodesEqual(
self, nodes_list_expected: list[int], nodes_list_got: list[nodes.Const]
) -> None:
self.assertEqual(len(nodes_list_expected), len(nodes_list_got))
for node in nodes_list_got:
self.assertIsInstance(node, nodes.Const)
for node, expected_value in zip(nodes_list_got, nodes_list_expected):
self.assertEqual(expected_value, node.value)
def assertNameNodesEqual(
self, nodes_list_expected: list[str], nodes_list_got: list[nodes.Name]
) -> None:
self.assertEqual(len(nodes_list_expected), len(nodes_list_got))
for node in nodes_list_got:
self.assertIsInstance(node, nodes.Name)
for node, expected_name in zip(nodes_list_got, nodes_list_expected):
self.assertEqual(expected_name, node.name)
def test_assigned_stmts_simple_for(self) -> None:
assign_stmts = extract_node(
"""
for a in (1, 2, 3): #@
pass
for b in range(3): #@
pass
"""
)
for1_assnode = next(assign_stmts[0].nodes_of_class(nodes.AssignName))
assigned = list(for1_assnode.assigned_stmts())
self.assertConstNodesEqual([1, 2, 3], assigned)
for2_assnode = next(assign_stmts[1].nodes_of_class(nodes.AssignName))
self.assertRaises(InferenceError, list, for2_assnode.assigned_stmts())
def test_assigned_stmts_nested_for_tuple(self) -> None:
assign_stmts = extract_node(
"""
for a, (b, c) in [(1, (2, 3))]: #@
pass
"""
)
assign_nodes = assign_stmts.nodes_of_class(nodes.AssignName)
for1_assnode = next(assign_nodes)
assigned = list(for1_assnode.assigned_stmts())
self.assertConstNodesEqual([1], assigned)
for2_assnode = next(assign_nodes)
assigned2 = list(for2_assnode.assigned_stmts())
self.assertConstNodesEqual([2], assigned2)
def test_assigned_stmts_nested_for_dict(self) -> None:
assign_stmts = extract_node(
"""
for a, (b, c) in {1: ("a", str), 2: ("b", bytes)}.items(): #@
pass
"""
)
assign_nodes = assign_stmts.nodes_of_class(nodes.AssignName)
# assigned: [1, 2]
for1_assnode = next(assign_nodes)
assigned = list(for1_assnode.assigned_stmts())
self.assertConstNodesEqual([1, 2], assigned)
# assigned2: ["a", "b"]
for2_assnode = next(assign_nodes)
assigned2 = list(for2_assnode.assigned_stmts())
self.assertConstNodesEqual(["a", "b"], assigned2)
# assigned3: [str, bytes]
for3_assnode = next(assign_nodes)
assigned3 = list(for3_assnode.assigned_stmts())
self.assertNameNodesEqual(["str", "bytes"], assigned3)
def test_assigned_stmts_starred_for(self) -> None:
assign_stmts = extract_node(
"""
for *a, b in ((1, 2, 3), (4, 5, 6, 7)): #@
pass
"""
)
for1_starred = next(assign_stmts.nodes_of_class(nodes.Starred))
assigned = next(for1_starred.assigned_stmts())
assert isinstance(assigned, nodes.List)
assert assigned.as_string() == "[1, 2]"
def _get_starred_stmts(self, code: str) -> list | UninferableBase:
assign_stmt = extract_node(f"{code} #@")
starred = next(assign_stmt.nodes_of_class(nodes.Starred))
return next(starred.assigned_stmts())
def _helper_starred_expected_const(self, code: str, expected: list[int]) -> None:
stmts = self._get_starred_stmts(code)
self.assertIsInstance(stmts, nodes.List)
stmts = stmts.elts
self.assertConstNodesEqual(expected, stmts)
def _helper_starred_expected(self, code: str, expected: UninferableBase) -> None:
stmts = self._get_starred_stmts(code)
self.assertEqual(expected, stmts)
def _helper_starred_inference_error(self, code: str) -> None:
assign_stmt = extract_node(f"{code} #@")
starred = next(assign_stmt.nodes_of_class(nodes.Starred))
self.assertRaises(InferenceError, list, starred.assigned_stmts())
def test_assigned_stmts_starred_assnames(self) -> None:
self._helper_starred_expected_const("a, *b = (1, 2, 3, 4) #@", [2, 3, 4])
self._helper_starred_expected_const("*a, b = (1, 2, 3) #@", [1, 2])
self._helper_starred_expected_const("a, *b, c = (1, 2, 3, 4, 5) #@", [2, 3, 4])
self._helper_starred_expected_const("a, *b = (1, 2) #@", [2])
self._helper_starred_expected_const("*b, a = (1, 2) #@", [1])
self._helper_starred_expected_const("[*b] = (1, 2) #@", [1, 2])
def test_assigned_stmts_starred_yes(self) -> None:
# Not something iterable and known
self._helper_starred_expected("a, *b = range(3) #@", Uninferable)
# Not something inferable
self._helper_starred_expected("a, *b = balou() #@", Uninferable)
# In function, unknown.
self._helper_starred_expected(
"""
def test(arg):
head, *tail = arg #@""",
Uninferable,
)
# These cases aren't worth supporting.
self._helper_starred_expected(
"a, (*b, c), d = (1, (2, 3, 4), 5) #@", Uninferable
)
def test_assigned_stmts_starred_inside_call(self) -> None:
"""Regression test for https://github.com/pylint-dev/pylint/issues/6372."""
code = "string_twos = ''.join(str(*y) for _, *y in [[1, 2], [1, 2]]) #@"
stmt = extract_node(code)
starred = next(stmt.nodes_of_class(nodes.Starred))
starred_stmts = starred.assigned_stmts()
self.assertIs(next(starred_stmts), Uninferable)
# Generator exhausted after one call
with self.assertRaises(StopIteration):
next(starred_stmts)
def test_assign_stmts_starred_fails(self) -> None:
# Too many starred
self._helper_starred_inference_error("a, *b, *c = (1, 2, 3) #@")
# This could be solved properly, but it complicates needlessly the
# code for assigned_stmts, without offering real benefit.
self._helper_starred_inference_error(
"(*a, b), (c, *d) = (1, 2, 3), (4, 5, 6) #@"
)
def test_assigned_stmts_assignments(self) -> None:
assign_stmts = extract_node(
"""
c = a #@
d, e = b, c #@
"""
)
simple_assnode = next(assign_stmts[0].nodes_of_class(nodes.AssignName))
assigned = list(simple_assnode.assigned_stmts())
self.assertNameNodesEqual(["a"], assigned)
assnames = assign_stmts[1].nodes_of_class(nodes.AssignName)
simple_mul_assnode_1 = next(assnames)
assigned = list(simple_mul_assnode_1.assigned_stmts())
self.assertNameNodesEqual(["b"], assigned)
simple_mul_assnode_2 = next(assnames)
assigned = list(simple_mul_assnode_2.assigned_stmts())
self.assertNameNodesEqual(["c"], assigned)
def test_assigned_stmts_annassignments(self) -> None:
annassign_stmts = extract_node(
"""
a: str = "abc" #@
b: str #@
"""
)
simple_annassign_node = next(
annassign_stmts[0].nodes_of_class(nodes.AssignName)
)
assigned = list(simple_annassign_node.assigned_stmts())
self.assertEqual(1, len(assigned))
self.assertIsInstance(assigned[0], nodes.Const)
self.assertEqual(assigned[0].value, "abc")
empty_annassign_node = next(annassign_stmts[1].nodes_of_class(nodes.AssignName))
assigned = list(empty_annassign_node.assigned_stmts())
self.assertEqual(1, len(assigned))
self.assertIs(assigned[0], Uninferable)
def test_sequence_assigned_stmts_not_accepting_empty_node(self) -> None:
def transform(node: nodes.Assign) -> None:
node.root().locals["__all__"] = [node.value]
manager = astroid.MANAGER
with _add_transform(manager, nodes.Assign, transform):
module = astroid.parse(
"""
__all__ = ['a']
"""
)
module.wildcard_import_names()
def test_not_passing_uninferable_in_seq_inference(self) -> None:
class Visitor:
def visit(self, node: nodes.Assign | nodes.BinOp | nodes.List) -> Any:
for child in node.get_children():
child.accept(self)
visit_module = visit
visit_assign = visit
visit_binop = visit
visit_list = visit
visit_const = visit
visit_name = visit
def visit_assignname(self, node: nodes.AssignName) -> None:
for _ in node.infer():
pass
parsed = extract_node(
"""
a = []
x = [a*2, a]*2*2
"""
)
parsed.accept(Visitor())
@staticmethod
def test_uninferable_exponents() -> None:
"""Attempting to calculate the result is prohibitively expensive."""
parsed = extract_node("15 ** 20220609")
assert parsed.inferred() == [Uninferable]
# Test a pathological case (more realistic: None as naive inference result)
parsed = extract_node("None ** 2")
assert parsed.inferred() == [Uninferable]
@staticmethod
def test_uninferable_list_multiplication() -> None:
"""Attempting to calculate the result is prohibitively expensive."""
parsed = extract_node("[0] * 123456789")
element = parsed.inferred()[0].elts[0]
assert element.value is Uninferable
@staticmethod
def test_uninferable_list_multiplication_with_multiple_operands() -> None:
"""Attempting to calculate the result is prohibitively expensive."""
parsed = extract_node("[0] * 825 * 16547118")
element = parsed.inferred()[0].elts[0]
assert element.value is Uninferable
@staticmethod
def test_list_multiplication_with_empty_list_and_overflowing_multiplier() -> None:
parsed = extract_node("[] * 1163845194457646539560")
assert parsed.inferred()[0].elts == []
@staticmethod
def test_list_multiplication_with_zero_multiplier() -> None:
parsed = extract_node("[0] * 0")
assert parsed.inferred()[0].elts == []
@staticmethod
def test_list_multiplication_with_negative_overflowing_multiplier() -> None:
parsed = extract_node("[0] * -9223372036854775809")
assert parsed.inferred()[0].elts == []
def test_named_expr_inference() -> None:
code = """
if (a := 2) == 2:
a #@
# Test a function call
def test():
return 24
if (a := test()):
a #@
# Normal assignments in sequences
{ (a:= 4) } #@
[ (a:= 5) ] #@
# Something more complicated
def test(value=(p := 24)): return p
[ y:= test()] #@
# Priority assignment
(x := 1, 2)
x #@
"""
ast_nodes = extract_node(code)
assert isinstance(ast_nodes, list)
node = next(ast_nodes[0].infer())
assert isinstance(node, nodes.Const)
assert node.value == 2
node = next(ast_nodes[1].infer())
assert isinstance(node, nodes.Const)
assert node.value == 24
node = next(ast_nodes[2].infer())
assert isinstance(node, nodes.Set)
assert isinstance(node.elts[0], nodes.Const)
assert node.elts[0].value == 4
node = next(ast_nodes[3].infer())
assert isinstance(node, nodes.List)
assert isinstance(node.elts[0], nodes.Const)
assert node.elts[0].value == 5
node = next(ast_nodes[4].infer())
assert isinstance(node, nodes.List)
assert isinstance(node.elts[0], nodes.Const)
assert node.elts[0].value == 24
node = next(ast_nodes[5].infer())
assert isinstance(node, nodes.Const)
assert node.value == 1
class TestPatternMatching:
@staticmethod
def test_assigned_stmts_match_mapping():
"""Assigned_stmts for MatchMapping not yet implemented.
Test the result is 'Uninferable' and no exception is raised.
"""
assign_stmts = extract_node(
"""
var = {1: "Hello", 2: "World"}
match var:
case {**rest}: #@
pass
"""
)
match_mapping: nodes.MatchMapping = assign_stmts.pattern # type: ignore[union-attr]
assert match_mapping.rest
assigned = next(match_mapping.rest.assigned_stmts())
assert assigned == Uninferable
@staticmethod
def test_assigned_stmts_match_star():
"""Assigned_stmts for MatchStar not yet implemented.
Test the result is 'Uninferable' and no exception is raised.
"""
assign_stmts = extract_node(
"""
var = (0, 1, 2)
match var:
case (0, 1, *rest): #@
pass
"""
)
match_sequence: nodes.MatchSequence = assign_stmts.pattern # type: ignore[union-attr]
match_star = match_sequence.patterns[2]
assert isinstance(match_star, nodes.MatchStar) and match_star.name
assigned = next(match_star.name.assigned_stmts())
assert assigned == Uninferable
@staticmethod
def test_assigned_stmts_match_as():
"""Assigned_stmts for MatchAs only implemented for the most basic case (y)."""
assign_stmts = extract_node(
"""
var = 42
match var: #@
case 2 | x: #@
pass
case (1, 2) as y: #@
pass
case z: #@
pass
"""
)
subject: nodes.Const = assign_stmts[0].subject # type: ignore[index,union-attr]
match_or: nodes.MatchOr = assign_stmts[1].pattern # type: ignore[index,union-attr]
match_as_with_pattern: nodes.MatchAs = assign_stmts[2].pattern # type: ignore[index,union-attr]
match_as: nodes.MatchAs = assign_stmts[3].pattern # type: ignore[index,union-attr]
match_or_1 = match_or.patterns[1]
assert isinstance(match_or_1, nodes.MatchAs) and match_or_1.name
assigned_match_or_1 = next(match_or_1.name.assigned_stmts())
assert assigned_match_or_1 == Uninferable
assert match_as_with_pattern.name and match_as_with_pattern.pattern
assigned_match_as_pattern = next(match_as_with_pattern.name.assigned_stmts())
assert assigned_match_as_pattern == Uninferable
assert match_as.name
assigned_match_as = next(match_as.name.assigned_stmts())
assert assigned_match_as == subject
@pytest.mark.skipif(not PY312_PLUS, reason="Generic typing syntax requires python 3.12")
class TestGenericTypeSyntax:
@staticmethod
def test_assigned_stmts_type_var():
"""The result is 'Uninferable' and no exception is raised."""
assign_stmts = extract_node("type Point[T] = tuple[float, float]")
type_var: nodes.TypeVar = assign_stmts.type_params[0]
assigned = next(type_var.name.assigned_stmts())
# Hack so inference doesn't fail when evaluating __class_getitem__
# Revert if it's causing issues.
assert isinstance(assigned, nodes.Const)
assert assigned.value is None
@staticmethod
def test_assigned_stmts_type_var_tuple():
"""The result is 'Uninferable' and no exception is raised."""
assign_stmts = extract_node("type Alias[*Ts] = tuple[*Ts]")
type_var_tuple: nodes.TypeVarTuple = assign_stmts.type_params[0]
assigned = next(type_var_tuple.name.assigned_stmts())
# Hack so inference doesn't fail when evaluating __class_getitem__
# Revert if it's causing issues.
assert isinstance(assigned, nodes.Const)
assert assigned.value is None
@staticmethod
def test_assigned_stmts_param_spec():
"""The result is 'Uninferable' and no exception is raised."""
assign_stmts = extract_node("type Alias[**P] = Callable[P, int]")
param_spec: nodes.ParamSpec = assign_stmts.type_params[0]
assigned = next(param_spec.name.assigned_stmts())
# Hack so inference doesn't fail when evaluating __class_getitem__
# Revert if it's causing issues.
assert isinstance(assigned, nodes.Const)
assert assigned.value is None
|