Skip to content

Commit e6e1987

Browse files
authored
DOC: Update variables a and b to names consistent with comment documentation (pandas-dev#60526)
* DOC: Fix title capitalization in documentation file * DOC: Fix title capitalization in documentation files * Update variables a and b to names consistent with comment documentation
1 parent 05f7ef9 commit e6e1987

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

pandas/core/computation/expressions.py

+35-35
Original file line numberDiff line numberDiff line change
@@ -65,23 +65,23 @@ def set_numexpr_threads(n=None) -> None:
6565
ne.set_num_threads(n)
6666

6767

68-
def _evaluate_standard(op, op_str, a, b):
68+
def _evaluate_standard(op, op_str, left_op, right_op):
6969
"""
7070
Standard evaluation.
7171
"""
7272
if _TEST_MODE:
7373
_store_test_result(False)
74-
return op(a, b)
74+
return op(left_op, right_op)
7575

7676

77-
def _can_use_numexpr(op, op_str, a, b, dtype_check) -> bool:
78-
"""return a boolean if we WILL be using numexpr"""
77+
def _can_use_numexpr(op, op_str, left_op, right_op, dtype_check) -> bool:
78+
"""return left_op boolean if we WILL be using numexpr"""
7979
if op_str is not None:
8080
# required min elements (otherwise we are adding overhead)
81-
if a.size > _MIN_ELEMENTS:
81+
if left_op.size > _MIN_ELEMENTS:
8282
# check for dtype compatibility
8383
dtypes: set[str] = set()
84-
for o in [a, b]:
84+
for o in [left_op, right_op]:
8585
# ndarray and Series Case
8686
if hasattr(o, "dtype"):
8787
dtypes |= {o.dtype.name}
@@ -93,43 +93,43 @@ def _can_use_numexpr(op, op_str, a, b, dtype_check) -> bool:
9393
return False
9494

9595

96-
def _evaluate_numexpr(op, op_str, a, b):
96+
def _evaluate_numexpr(op, op_str, left_op, right_op):
9797
result = None
9898

99-
if _can_use_numexpr(op, op_str, a, b, "evaluate"):
99+
if _can_use_numexpr(op, op_str, left_op, right_op, "evaluate"):
100100
is_reversed = op.__name__.strip("_").startswith("r")
101101
if is_reversed:
102102
# we were originally called by a reversed op method
103-
a, b = b, a
103+
left_op, right_op = right_op, left_op
104104

105-
a_value = a
106-
b_value = b
105+
left_value = left_op
106+
right_value = right_op
107107

108108
try:
109109
result = ne.evaluate(
110-
f"a_value {op_str} b_value",
111-
local_dict={"a_value": a_value, "b_value": b_value},
110+
f"left_value {op_str} right_value",
111+
local_dict={"left_value": left_value, "right_value": right_op},
112112
casting="safe",
113113
)
114114
except TypeError:
115115
# numexpr raises eg for array ** array with integers
116116
# (https://github.com/pydata/numexpr/issues/379)
117117
pass
118118
except NotImplementedError:
119-
if _bool_arith_fallback(op_str, a, b):
119+
if _bool_arith_fallback(op_str, left_op, right_op):
120120
pass
121121
else:
122122
raise
123123

124124
if is_reversed:
125125
# reverse order to original for fallback
126-
a, b = b, a
126+
left_op, right_op = right_op, left_op
127127

128128
if _TEST_MODE:
129129
_store_test_result(result is not None)
130130

131131
if result is None:
132-
result = _evaluate_standard(op, op_str, a, b)
132+
result = _evaluate_standard(op, op_str, left_op, right_op)
133133

134134
return result
135135

@@ -170,24 +170,24 @@ def _evaluate_numexpr(op, op_str, a, b):
170170
}
171171

172172

173-
def _where_standard(cond, a, b):
173+
def _where_standard(cond, left_op, right_op):
174174
# Caller is responsible for extracting ndarray if necessary
175-
return np.where(cond, a, b)
175+
return np.where(cond, left_op, right_op)
176176

177177

178-
def _where_numexpr(cond, a, b):
178+
def _where_numexpr(cond, left_op, right_op):
179179
# Caller is responsible for extracting ndarray if necessary
180180
result = None
181181

182-
if _can_use_numexpr(None, "where", a, b, "where"):
182+
if _can_use_numexpr(None, "where", left_op, right_op, "where"):
183183
result = ne.evaluate(
184184
"where(cond_value, a_value, b_value)",
185-
local_dict={"cond_value": cond, "a_value": a, "b_value": b},
185+
local_dict={"cond_value": cond, "a_value": left_op, "b_value": right_op},
186186
casting="safe",
187187
)
188188

189189
if result is None:
190-
result = _where_standard(cond, a, b)
190+
result = _where_standard(cond, left_op, right_op)
191191

192192
return result
193193

@@ -206,13 +206,13 @@ def _has_bool_dtype(x):
206206
_BOOL_OP_UNSUPPORTED = {"+": "|", "*": "&", "-": "^"}
207207

208208

209-
def _bool_arith_fallback(op_str, a, b) -> bool:
209+
def _bool_arith_fallback(op_str, left_op, right_op) -> bool:
210210
"""
211211
Check if we should fallback to the python `_evaluate_standard` in case
212212
of an unsupported operation by numexpr, which is the case for some
213213
boolean ops.
214214
"""
215-
if _has_bool_dtype(a) and _has_bool_dtype(b):
215+
if _has_bool_dtype(left_op) and _has_bool_dtype(right_op):
216216
if op_str in _BOOL_OP_UNSUPPORTED:
217217
warnings.warn(
218218
f"evaluating in Python space because the {op_str!r} "
@@ -224,40 +224,40 @@ def _bool_arith_fallback(op_str, a, b) -> bool:
224224
return False
225225

226226

227-
def evaluate(op, a, b, use_numexpr: bool = True):
227+
def evaluate(op, left_op, right_op, use_numexpr: bool = True):
228228
"""
229-
Evaluate and return the expression of the op on a and b.
229+
Evaluate and return the expression of the op on left_op and right_op.
230230
231231
Parameters
232232
----------
233233
op : the actual operand
234-
a : left operand
235-
b : right operand
234+
left_op : left operand
235+
right_op : right operand
236236
use_numexpr : bool, default True
237237
Whether to try to use numexpr.
238238
"""
239239
op_str = _op_str_mapping[op]
240240
if op_str is not None:
241241
if use_numexpr:
242242
# error: "None" not callable
243-
return _evaluate(op, op_str, a, b) # type: ignore[misc]
244-
return _evaluate_standard(op, op_str, a, b)
243+
return _evaluate(op, op_str, left_op, right_op) # type: ignore[misc]
244+
return _evaluate_standard(op, op_str, left_op, right_op)
245245

246246

247-
def where(cond, a, b, use_numexpr: bool = True):
247+
def where(cond, left_op, right_op, use_numexpr: bool = True):
248248
"""
249-
Evaluate the where condition cond on a and b.
249+
Evaluate the where condition cond on left_op and right_op.
250250
251251
Parameters
252252
----------
253253
cond : np.ndarray[bool]
254-
a : return if cond is True
255-
b : return if cond is False
254+
left_op : return if cond is True
255+
right_op : return if cond is False
256256
use_numexpr : bool, default True
257257
Whether to try to use numexpr.
258258
"""
259259
assert _where is not None
260-
return _where(cond, a, b) if use_numexpr else _where_standard(cond, a, b)
260+
return _where(cond, left_op, right_op) if use_numexpr else _where_standard(cond, left_op, right_op)
261261

262262

263263
def set_test_mode(v: bool = True) -> None:

0 commit comments

Comments
 (0)