1# Licensed under the LGPL: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html
2# For details: https://github.com/pylint-dev/astroid/blob/main/LICENSE
3# Copyright (c) https://github.com/pylint-dev/astroid/blob/main/CONTRIBUTORS.txt
4
5from __future__ import annotations
6
7import inspect
8import random
9
10from astroid import nodes
11from astroid.context import InferenceContext
12from astroid.exceptions import UseInferenceDefault
13from astroid.inference_tip import inference_tip
14from astroid.manager import AstroidManager
15from astroid.util import UninferableBase, safe_infer
16
17ACCEPTED_ITERABLES_FOR_SAMPLE = (nodes.List, nodes.Set, nodes.Tuple)
18
19
20def _clone_node_with_lineno(node, parent, lineno):
21 if isinstance(node, nodes.EvaluatedObject):
22 node = node.original
23 if not isinstance(node, nodes.NodeNG):
24 # Inferred objects, such as ``Instance``, are not source nodes: they
25 # cannot be rebuilt from constructor arguments, so pass them through
26 # untouched instead of attempting to clone them.
27 return node
28 cls = node.__class__
29 other_fields = node._other_fields
30 _astroid_fields = node._astroid_fields
31 candidate_init_params = {
32 "lineno": lineno,
33 "col_offset": node.col_offset,
34 "parent": parent,
35 "end_lineno": node.end_lineno,
36 "end_col_offset": node.end_col_offset,
37 }
38 postinit_params = {param: getattr(node, param) for param in _astroid_fields}
39
40 valid_init_params = set(inspect.signature(cls.__init__).parameters)
41 init_params = {
42 name: value
43 for name, value in candidate_init_params.items()
44 if name in valid_init_params
45 }
46 for param in other_fields:
47 if param in valid_init_params:
48 init_params[param] = getattr(node, param)
49
50 new_node = cls(**init_params)
51 if hasattr(node, "postinit") and _astroid_fields:
52 new_node.postinit(**postinit_params)
53
54 for param in other_fields:
55 if param not in valid_init_params:
56 setattr(new_node, param, getattr(node, param))
57 return new_node
58
59
60def infer_random_sample(node, context: InferenceContext | None = None):
61 if len(node.args) != 2:
62 raise UseInferenceDefault
63
64 inferred_length = safe_infer(node.args[1], context=context)
65 if not isinstance(inferred_length, nodes.Const):
66 raise UseInferenceDefault
67 if not isinstance(inferred_length.value, int):
68 raise UseInferenceDefault
69
70 inferred_sequence = safe_infer(node.args[0], context=context)
71 if not inferred_sequence:
72 raise UseInferenceDefault
73
74 if not isinstance(inferred_sequence, ACCEPTED_ITERABLES_FOR_SAMPLE):
75 raise UseInferenceDefault
76
77 if inferred_length.value > len(inferred_sequence.elts):
78 # In this case, this will raise a ValueError
79 raise UseInferenceDefault
80
81 if any(isinstance(elt, UninferableBase) for elt in inferred_sequence.elts):
82 raise UseInferenceDefault
83
84 try:
85 elts = random.sample(inferred_sequence.elts, inferred_length.value)
86 except ValueError as exc:
87 raise UseInferenceDefault from exc
88
89 new_node = nodes.List(
90 lineno=node.lineno,
91 col_offset=node.col_offset,
92 parent=node.scope(),
93 end_lineno=node.end_lineno,
94 end_col_offset=node.end_col_offset,
95 )
96 new_elts = [
97 _clone_node_with_lineno(elt, parent=new_node, lineno=new_node.lineno)
98 for elt in elts
99 ]
100 new_node.postinit(new_elts)
101 return iter((new_node,))
102
103
104def _looks_like_random_sample(node) -> bool:
105 func = node.func
106 if isinstance(func, nodes.Attribute):
107 return func.attrname == "sample"
108 if isinstance(func, nodes.Name):
109 return func.name == "sample"
110 return False
111
112
113def register(manager: AstroidManager) -> None:
114 manager.register_transform(
115 nodes.Call, inference_tip(infer_random_sample), _looks_like_random_sample
116 )