GH730 allow str for float format to string #1200
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Dr-Irv
requested changes
Apr 25, 2025
tests/test_frame.py
Outdated
| def _formatter(x) -> str: | ||
| return f"{x:.2f}" | ||
|
|
||
| check(assert_type(df.to_string(), str), str) |
There was a problem hiding this comment.
you can delete this. It's the same as line 1707
tests/test_series.py
Outdated
| def _formatter(x) -> str: | ||
| return f"{x:.2f}" | ||
|
|
||
| check(assert_type(sr.to_string(), str), str) |
There was a problem hiding this comment.
delete - same as line 2942
tests/test_series.py
Outdated
| str, | ||
| ) | ||
| check(assert_type(sr.to_string(float_format="%.2f"), str), str) | ||
| check(assert_type(sr.to_string(float_format="%.2f"), str), str) |
pandas-stubs/core/frame.pyi
Outdated
| @@ -2311,7 +2314,7 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack): | |||
| index: _bool = ..., | |||
| na_rep: _str = ..., | |||
| formatters: FormattersType | None = ..., | |||
| float_format: Callable[[float], str] | None = ..., | |||
| float_format: FloatFormatType | Callable[[float], str] | None = ..., | |||
There was a problem hiding this comment.
FloatFormatType is too wide, as it includes any Callable.
Can you change FloatFormatType to use Callable[[float], str] instead of Callable in _typing.pyi, and then you don't need the Callable declaration here or elsewhere?
There was a problem hiding this comment.
I was going to suggest that indeed since we should collapse those two parts.
This is addressed.
loicdiridollou
force-pushed
the
gh730_float_format_to_string
branch
from
2716dd5 to
b910bdc
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
float_formatin.to_stringcan bestr#730assert_type()to assert the type of any return valueShould fix the issue, yet passing an
strtofloat_formatwill depend on the underlying type, for example for a float it will work totally fine but for numpy Float64 it won't work.So the typehints are correct to the extent that it also works at runtime.
Docs are not fixed yet, seems like the issue on the pandas repo is stale pandas-dev/pandas#53675