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
5"""Astroid hooks for numpy ndarray class."""
6
7from __future__ import annotations
8
9from astroid import nodes
10from astroid.brain.brain_numpy_utils import (
11 numpy_supports_type_hints,
12 numpy_version_2_or_later,
13)
14from astroid.builder import extract_node
15from astroid.context import InferenceContext
16from astroid.inference_tip import inference_tip
17from astroid.manager import AstroidManager
18
19
20def infer_numpy_ndarray(node, context: InferenceContext | None = None):
21 ndarray = """
22 class ndarray(object):
23 def __init__(self, shape, dtype=float, buffer=None, offset=0,
24 strides=None, order=None):
25 self.T = numpy.ndarray([0, 0])
26 self.base = None
27 self.ctypes = None
28 self.data = None
29 self.dtype = None
30 self.flags = None
31 # Should be a numpy.flatiter instance but not available for now
32 # Putting an array instead so that iteration and indexing are authorized
33 self.flat = np.ndarray([0, 0])
34 self.imag = np.ndarray([0, 0])
35 self.itemsize = None
36 self.nbytes = None
37 self.ndim = None
38 self.real = np.ndarray([0, 0])
39 self.shape = numpy.ndarray([0, 0])
40 self.size = None
41 self.strides = None
42
43 def __abs__(self): return numpy.ndarray([0, 0])
44 def __add__(self, value): return numpy.ndarray([0, 0])
45 def __and__(self, value): return numpy.ndarray([0, 0])
46 def __array__(self, dtype=None): return numpy.ndarray([0, 0])
47 def __array_wrap__(self, obj): return numpy.ndarray([0, 0])
48 def __contains__(self, key): return True
49 def __copy__(self): return numpy.ndarray([0, 0])
50 def __deepcopy__(self, memo): return numpy.ndarray([0, 0])
51 def __divmod__(self, value): return (numpy.ndarray([0, 0]), numpy.ndarray([0, 0]))
52 def __eq__(self, value): return numpy.ndarray([0, 0])
53 def __float__(self): return 0.
54 def __floordiv__(self): return numpy.ndarray([0, 0])
55 def __ge__(self, value): return numpy.ndarray([0, 0])
56 def __getitem__(self, key): return uninferable
57 def __gt__(self, value): return numpy.ndarray([0, 0])
58 def __iadd__(self, value): return numpy.ndarray([0, 0])
59 def __iand__(self, value): return numpy.ndarray([0, 0])
60 def __ifloordiv__(self, value): return numpy.ndarray([0, 0])
61 def __ilshift__(self, value): return numpy.ndarray([0, 0])
62 def __imod__(self, value): return numpy.ndarray([0, 0])
63 def __imul__(self, value): return numpy.ndarray([0, 0])
64 def __int__(self): return 0
65 def __invert__(self): return numpy.ndarray([0, 0])
66 def __ior__(self, value): return numpy.ndarray([0, 0])
67 def __ipow__(self, value): return numpy.ndarray([0, 0])
68 def __irshift__(self, value): return numpy.ndarray([0, 0])
69 def __isub__(self, value): return numpy.ndarray([0, 0])
70 def __itruediv__(self, value): return numpy.ndarray([0, 0])
71 def __ixor__(self, value): return numpy.ndarray([0, 0])
72 def __le__(self, value): return numpy.ndarray([0, 0])
73 def __len__(self): return 1
74 def __lshift__(self, value): return numpy.ndarray([0, 0])
75 def __lt__(self, value): return numpy.ndarray([0, 0])
76 def __matmul__(self, value): return numpy.ndarray([0, 0])
77 def __mod__(self, value): return numpy.ndarray([0, 0])
78 def __mul__(self, value): return numpy.ndarray([0, 0])
79 def __ne__(self, value): return numpy.ndarray([0, 0])
80 def __neg__(self): return numpy.ndarray([0, 0])
81 def __or__(self, value): return numpy.ndarray([0, 0])
82 def __pos__(self): return numpy.ndarray([0, 0])
83 def __pow__(self): return numpy.ndarray([0, 0])
84 def __repr__(self): return str()
85 def __rshift__(self): return numpy.ndarray([0, 0])
86 def __setitem__(self, key, value): return uninferable
87 def __str__(self): return str()
88 def __sub__(self, value): return numpy.ndarray([0, 0])
89 def __truediv__(self, value): return numpy.ndarray([0, 0])
90 def __xor__(self, value): return numpy.ndarray([0, 0])
91 def all(self, axis=None, out=None, keepdims=False): return np.ndarray([0, 0])
92 def any(self, axis=None, out=None, keepdims=False): return np.ndarray([0, 0])
93 def argmax(self, axis=None, out=None): return np.ndarray([0, 0])
94 def argmin(self, axis=None, out=None): return np.ndarray([0, 0])
95 def argpartition(self, kth, axis=-1, kind='introselect', order=None): return np.ndarray([0, 0])
96 def argsort(self, axis=-1, kind='quicksort', order=None): return np.ndarray([0, 0])
97 def astype(self, dtype, order='K', casting='unsafe', subok=True, copy=True): return np.ndarray([0, 0])
98 def byteswap(self, inplace=False): return np.ndarray([0, 0])
99 def choose(self, choices, out=None, mode='raise'): return np.ndarray([0, 0])
100 def clip(self, min=None, max=None, out=None): return np.ndarray([0, 0])
101 def compress(self, condition, axis=None, out=None): return np.ndarray([0, 0])
102 def conj(self): return np.ndarray([0, 0])
103 def conjugate(self): return np.ndarray([0, 0])
104 def copy(self, order='C'): return np.ndarray([0, 0])
105 def cumprod(self, axis=None, dtype=None, out=None): return np.ndarray([0, 0])
106 def cumsum(self, axis=None, dtype=None, out=None): return np.ndarray([0, 0])
107 def diagonal(self, offset=0, axis1=0, axis2=1): return np.ndarray([0, 0])
108 def dot(self, b, out=None): return np.ndarray([0, 0])
109 def dump(self, file): return None
110 def dumps(self): return str()
111 def fill(self, value): return None
112 def flatten(self, order='C'): return np.ndarray([0, 0])
113 def getfield(self, dtype, offset=0): return np.ndarray([0, 0])
114 def item(self, *args): return uninferable
115 def itemset(self, *args): return None
116 def max(self, axis=None, out=None): return np.ndarray([0, 0])
117 def mean(self, axis=None, dtype=None, out=None, keepdims=False): return np.ndarray([0, 0])
118 def min(self, axis=None, out=None, keepdims=False): return np.ndarray([0, 0])
119 def newbyteorder(self, new_order='S'): return np.ndarray([0, 0])
120 def nonzero(self): return (1,)
121 def partition(self, kth, axis=-1, kind='introselect', order=None): return None
122 def prod(self, axis=None, dtype=None, out=None, keepdims=False): return np.ndarray([0, 0])
123 def ptp(self, axis=None, out=None): return np.ndarray([0, 0])
124 def put(self, indices, values, mode='raise'): return None
125 def ravel(self, order='C'): return np.ndarray([0, 0])
126 def repeat(self, repeats, axis=None): return np.ndarray([0, 0])
127 def reshape(self, shape, order='C'): return np.ndarray([0, 0])
128 def resize(self, new_shape, refcheck=True): return None
129 def round(self, decimals=0, out=None): return np.ndarray([0, 0])
130 def searchsorted(self, v, side='left', sorter=None): return np.ndarray([0, 0])
131 def setfield(self, val, dtype, offset=0): return None
132 def setflags(self, write=None, align=None, uic=None): return None
133 def sort(self, axis=-1, kind='quicksort', order=None): return None
134 def squeeze(self, axis=None): return np.ndarray([0, 0])
135 def std(self, axis=None, dtype=None, out=None, ddof=0, keepdims=False): return np.ndarray([0, 0])
136 def sum(self, axis=None, dtype=None, out=None, keepdims=False): return np.ndarray([0, 0])
137 def swapaxes(self, axis1, axis2): return np.ndarray([0, 0])
138 def take(self, indices, axis=None, out=None, mode='raise'): return np.ndarray([0, 0])
139 def tobytes(self, order='C'): return b''
140 def tofile(self, fid, sep="", format="%s"): return None
141 def tolist(self, ): return []
142 def tostring(self, order='C'): return b''
143 def trace(self, offset=0, axis1=0, axis2=1, dtype=None, out=None): return np.ndarray([0, 0])
144 def transpose(self, *axes): return np.ndarray([0, 0])
145 def var(self, axis=None, dtype=None, out=None, ddof=0, keepdims=False): return np.ndarray([0, 0])
146 def view(self, dtype=None, type=None): return np.ndarray([0, 0])
147 """
148 if numpy_supports_type_hints():
149 ndarray += """
150 @classmethod
151 def __class_getitem__(cls, value):
152 return cls
153 """
154 if numpy_version_2_or_later():
155 # Members added in NumPy 2.0.
156 ndarray += """
157 mT = numpy.ndarray([0, 0])
158 device = str()
159 def to_device(self, device): return np.ndarray([0, 0])
160 """
161 node = extract_node(ndarray)
162 return node.infer(context=context)
163
164
165def _looks_like_numpy_ndarray(node: nodes.Attribute) -> bool:
166 return node.attrname == "ndarray"
167
168
169def register(manager: AstroidManager) -> None:
170 manager.register_transform(
171 nodes.Attribute,
172 inference_tip(infer_numpy_ndarray),
173 _looks_like_numpy_ndarray,
174 )