bigframes.pandas.DataFrame.to_string#

DataFrame.to_string(buf=None, columns: Sequence[str] | None = None, col_space=None, header: bool | Sequence[str] = True, index: bool = True, na_rep: str = 'NaN', formatters=None, float_format=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, *, allow_large_results: bool | None = None) → str | None[source]#

Render a DataFrame to a console-friendly tabular output.

Examples:

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

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.

• header (bool or sequence, 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. The result of this function must be a unicode string.

• 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.

• min_rows (int, optional) The number of rows to display in the console in a truncated repr (when number of rows is above max_rows).

• 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.

• max_colwidth (int, optional) Max width to truncate each column in characters. By default, no limit.

• encoding (str, default "utf-8") Set character encoding.

• allow_large_results (bool, default None) If not None, overrides the global setting to allow or disallow large query results over the default size limit of 10 GB.

Returns:

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

Return type:

str or None