Skip to content

TYP: improve typing for DataFrame.to_string #44426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 18, 2021
Merged

TYP: improve typing for DataFrame.to_string #44426

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
89610c6
TYP: improve typing for type DataFrame.to_string
topper-123 Nov 13, 2021
2345c7d
small cleanups
topper-123 Nov 13, 2021
0debdb6
ellipsis as default
topper-123 Nov 15, 2021
a483e9c
correct typing for col_space
topper-123 Nov 16, 2021
9dc078f
correct typing for col_space, II
topper-123 Nov 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 54 additions & 6 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -989,15 +989,13 @@ def __repr__(self) -> str:
"""
Return a string representation for a particular DataFrame.
"""
buf = StringIO("")
if self._info_repr():
buf = StringIO()
self.info(buf=buf)
return buf.getvalue()

repr_params = fmt.get_dataframe_repr_params()
self.to_string(buf=buf, **repr_params)

return buf.getvalue()
return self.to_string(**repr_params)

def _repr_html_(self) -> str | None:
"""
Expand All @@ -1006,7 +1004,7 @@ def _repr_html_(self) -> str | None:
Mainly for IPython notebook.
"""
if self._info_repr():
buf = StringIO("")
buf = StringIO()
self.info(buf=buf)
# need to escape the <class>, should be the first line.
val = buf.getvalue().replace("<", r"&lt;", 1)
Expand Down Expand Up @@ -1043,6 +1041,56 @@ def _repr_html_(self) -> str | None:
else:
return None

@overload
def to_string(
self,
buf: None = ...,
columns: Sequence[str] | None = ...,
col_space: int | list[int] | dict[Hashable, int] | None = ...,
header: bool | Sequence[str] = ...,
index: bool = ...,
na_rep: str = ...,
formatters: fmt.FormattersType | None = ...,
float_format: fmt.FloatFormatType | None = ...,
sparsify: bool | None = ...,
index_names: bool = ...,
justify: str | None = ...,
max_rows: int | None = ...,
max_cols: int | None = ...,
show_dimensions: bool = ...,
decimal: str = ...,
line_width: int | None = ...,
min_rows: int | None = ...,
max_colwidth: int | None = ...,
encoding: str | None = ...,
) -> str:
...

@overload
def to_string(
self,
buf: FilePathOrBuffer[str],
columns: Sequence[str] | None = ...,
col_space: int | list[int] | dict[Hashable, int] | None = ...,
header: bool | Sequence[str] = ...,
index: bool = ...,
na_rep: str = ...,
formatters: fmt.FormattersType | None = ...,
float_format: fmt.FloatFormatType | None = ...,
sparsify: bool | None = ...,
index_names: bool = ...,
justify: str | None = ...,
max_rows: int | None = ...,
max_cols: int | None = ...,
show_dimensions: bool = ...,
decimal: str = ...,
line_width: int | None = ...,
min_rows: int | None = ...,
max_colwidth: int | None = ...,
encoding: str | None = ...,
) -> None:
...

@Substitution(
header_type="bool or sequence of strings",
header="Write out the column names. If a list of strings "
Expand All @@ -1058,7 +1106,7 @@ def to_string(
self,
buf: FilePathOrBuffer[str] | None = None,
columns: Sequence[str] | None = None,
col_space: int | None = None,
col_space: int | list[int] | dict[Hashable, int] | None = None,
header: bool | Sequence[str] = True,
index: bool = True,
na_rep: str = "NaN",
Expand Down