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

Parameters

buf : str, Path or StringIO-like, optional, default None

Buffer to write to. If None, the output is returned as a string.

columns : sequence, optional, default None

The subset of columns to write. Writes all columns by default.

col_space : int, list or dict of int, optional

The minimum width of each column. If a list of ints is given every integers corresponds with one column. If a dict is given, the key references the column, while the value defines the space to use..

header : bool or sequence of str, optional

Write out the column names. If a list of strings is given, it is assumed to be aliases for the column names.

index : bool, optional, default True

Whether to print index (row) labels.

na_rep : str, optional, default 'NaN'

String representation of NaN to use.

formatters : list, tuple or dict of one-param. functions, optional

Formatter functions to apply to columns' elements by position or name. The result of each function must be a unicode string. List/tuple must be of length equal to the number of columns.

float_format : one-parameter function, optional, default None

Formatter function to apply to columns' elements if they are floats. This function must return a unicode string and will be applied only to the non- NaN elements, with NaN being handled by na_rep .

versionchanged

sparsify : bool, optional, default True

Set to False for a DataFrame with a hierarchical index to print every multiindex key at each row.

index_names : bool, optional, default True

Prints the names of the indexes.

justify : str, default None

How to justify the column labels. If None uses the option from the print configuration (controlled by set_option), 'right' out of the box. Valid values are

• left

• right

• center

• justify

• justify-all

• start

• end

• inherit

• match-parent

• initial

• unset.

max_rows : int, optional

Maximum number of rows to display in the console.

max_cols : int, optional

Maximum number of columns to display in the console.

show_dimensions : bool, default False

Display DataFrame dimensions (number of rows by number of columns).

decimal : str, default '.'

Character recognized as decimal separator, e.g. ',' in Europe.

line_width : int, optional

Width to wrap a line in characters.

min_rows : int, optional

The number of rows to display in the console in a truncated repr (when number of rows is above :None:None:`max_rows`).

max_colwidth : int, optional

Max width to truncate each column in characters. By default, no limit.

versionadded

encoding : str, default "utf-8"

Set character encoding.

versionadded

Returns

str or None

If buf is None, returns the result as a string. Otherwise returns None.

Render a DataFrame to a console-friendly tabular output.

See Also

to_html

Convert DataFrame to HTML.

Examples

This example is valid syntax, but we were not able to check execution

>>> d = {'col1': [1, 2, 3], 'col2': [4, 5, 6]}
... df = pd.DataFrame(d)
... print(df.to_string())
   col1  col2
0     1     4
1     2     5
2     3     6

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

pandas.io.formats.format.get_dataframe_repr_params pandas.core.generic.NDFrame.to_latex pandas.core.frame.DataFrame.to_html

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them

---

File: /pandas/core/frame.py#1107
type: <class 'function'>
Commit: