fix(python): Change method op type hints to match dunder op type hints #18448
Conversation
ts826848
requested review from
ritchie46,
c-peters,
alexander-beedie,
MarcoGorelli and
reswqa
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #18448 +/- ##
==========================================
- Coverage 80.21% 80.19% -0.02%
==========================================
Files 1523 1527 +4
Lines 210096 210341 +245
Branches 2432 2430 -2
==========================================
+ Hits 168526 168693 +167
- Misses 41014 41094 +80
+ Partials 556 554 -2 ☔ View full report in Codecov by Sentry. |
|
Whoops, looks like I forgot to run the pre-commit locally so I didn't catch the type errors before creating the PR. My mistake :/ Not sure what the best approach is for dealing with the mypy error. I also notice the second argument to |
Type hints for operators were refined in pola-rs#13635 [0], but the refinements were generally not propagated to the method equivalents (pow() being the sole exception). This can result in equivalent expressions being treated differently by type checkers, especially if stricter settings are used that discourage/disallow the use of Any. This commit changes the type hints for the method equivalents to match those for the operators. This should ensure resulting types are consistent regardless of whether one uses infix operators or their method equivalents. This also has the side benefit of making the documentation a bit more consistent as the type hint more closely matches the stated type of the argument in the docstring. Not entirely sure whether the type: ignore hints are necessary or whether there's some alternative formulation which doesn't require them. I believe the override should be sound in this instance since the expr.or_(expr, ...) should be equivalent to expr | expr | ..., and the type signature for or_() was changed to be the same as for __bitor__ (and a similar argument applies to and_()/__bitand__). [0]: pola-rs@1c417e4
ts826848
force-pushed
the
op-method-equivalent-type-hints
branch
from
f842b15
to
604988d
Compare
Type hints for operators were refined in #13635 0, but the refinements were generally not propagated to the method equivalents (pow() being the sole exception). This can result in equivalent expressions being treated differently by type checkers, especially if stricter settings are used that discourage/disallow the use of Any.
This commit changes the type hints for the method equivalents to match those for the operators. This should ensure resulting types are consistent regardless of whether one uses infix operators or their method equivalents.
This also has the side benefit of making the documentation a bit more consistent as the type hint more closely matches the stated type of the argument in the docstring.