pandas.describe_option#

pandas.describe_option(pat, _print_desc=False) = <pandas._config.config.CallableDynamicDoc object>#

打印一个或多个已注册选项的说明。

调用时不带参数，以获取所有已注册选项的列表。

可用选项：

计算。 [use_bottleneck, use_numba, use_numexpr]
展示。 [chop_threshold, colheader_justify, column_space, date_dayfirst, date_yearfirst, encoding, expand_frame_repr, float_format]
Display.html。 [border, table_schema, use_mathjax]
display.[large_repr]
展示。 Latex 。 [escape, longtable, multicolumn, multicolumn_format, multirow, repr]
展示。 [max_categories, max_columns, max_colwidth, max_dir_items, max_info_columns, max_info_rows, max_rows, max_seq_items, memory_usage, min_rows, multi_sparse, notebook_repr_html, pprint_nest_depth, precision, show_dimensions]
显示。独码。 [ambiguous_as_wide, east_asian_width]
display.[width]
IO.EXCEL.ODS。 [读者，作家]
Io.excel.xls。 [读者，作家]
io.excel.xlsb.[reader]
Io.excel.xlsm. [读者，作家]
Io.excel.xlsx。 [读者，作家]
Io.hdf。 [default_format, dropna_table]
io.parquet.[engine]
io.sql.[engine]
模式。 [chained_assignment, data_manager, sim_interactive, string_storage, use_inf_as_na, use_inf_as_null]
plotting.[backend]
plotting.matplotlib.[register_converters]
样式.Format。 [decimal, escape, formatter, na_rep, precision, thousands]
styler.html.[mathjax]
Styer.LaTeX。 [environment, hrules, multicol_align, multirow_align]
样式器。 [encoding, max_columns, max_elements, max_rows, repr]
斯泰勒斯派塞。 [列，索引]

参数

pat应力: 正则表达式模式。所有匹配的关键字都将显示其描述。
_print_desc布尔值，默认为True: 如果为True(默认)，则说明将打印到标准输出。否则，描述将以Unicode字符串形式返回(用于测试)。

退货

无默认情况下，描述为Unicode字符串if_print_desc
是假的

注意事项

请参考 User Guide 了解更多信息。

可用的选项及其说明：

compute.use_bottleneck布尔尔

Use the bottleneck library to accelerate if it is installed, the default is True Valid values: False,True [default: True] [currently: True]

compute.use_numba布尔尔

Use the numba engine option for select operations if it is installed, the default is False Valid values: False,True [default: False] [currently: False]

compute.use_numexpr布尔尔

Use the numexpr library to accelerate computation if it is installed, the default is True Valid values: False,True [default: True] [currently: True]

display.chop_threshold浮动或无

if set to a float value, all float values smaller then the given threshold will be displayed as exactly 0 by repr and friends. [default: None] [currently: None]

display.colheader_justify‘Left’/‘Right’

Controls the justification of column headers. used by DataFrameFormatter. [default: right] [currently: right]

Display.Column_space没有可用的描述。

[default: 12] [currently: 12]

display.date_dayfirst布尔值

When True, prints and parses dates with the day first, eg 20/01/2005 [default: False] [currently: False]

display.date_yearfirst布尔值

When True, prints and parses dates with the year first, eg 2005/01/20 [default: False] [currently: False]

display.encoding字符串/Unicode

Defaults to the detected encoding of the console. Specifies the encoding to be used for strings returned by to_string, these are generally strings meant to be displayed on the console. [default: utf-8] [currently: utf8]

display.expand_frame_repr布尔值

Whether to print out the full DataFrame repr for wide DataFrames across multiple lines, max_columns is still respected, but the output will wrap-around across multiple "pages" if its width exceeds display.width. [default: True] [currently: True]

display.float_format可调用

The callable should accept a floating point number and return a string with the desired format of the number. This is used in some places like SeriesFormatter. See formats.format.EngFormatter for an example. [default: None] [currently: None]

display.html.border集成

A border=value attribute is inserted in the <table> tag for the DataFrame HTML repr. [default: 1] [currently: 1]

display.html.table_schema布尔值

Whether to publish a Table Schema representation for frontends that support it. (default: False) [default: False] [currently: False]

display.html.use_mathjax布尔值

When True, Jupyter notebook will process table contents using MathJax, rendering mathematical expressions enclosed by the dollar symbol. (default: True) [default: True] [currently: True]

display.large_repr‘截断’/‘信息’

For DataFrames exceeding max_rows/max_cols, the repr (and HTML repr) can show a truncated table (the default from 0.13), or switch to the view from df.info() (the behaviour in earlier versions of pandas). [default: truncate] [currently: truncate]

display.latex.escape布尔尔

This specifies if the to_latex method of a Dataframe uses escapes special characters. Valid values: False,True [default: True] [currently: True]

Display.latex.Longtable：bool

This specifies if the to_latex method of a Dataframe uses the longtable format. Valid values: False,True [default: False] [currently: False]

display.latex.multicolumn布尔尔

This specifies if the to_latex method of a Dataframe uses multicolumns to pretty-print MultiIndex columns. Valid values: False,True [default: True] [currently: True]

display.latex.multicolumn_format布尔尔

This specifies if the to_latex method of a Dataframe uses multicolumns to pretty-print MultiIndex columns. Valid values: False,True [default: l] [currently: l]

display.latex.multirow布尔尔

This specifies if the to_latex method of a Dataframe uses multirows to pretty-print MultiIndex rows. Valid values: False,True [default: False] [currently: False]

display.latex.repr布尔值

Whether to produce a latex DataFrame representation for jupyter environments that support it. (default: False) [default: False] [currently: False]

display.max_categories集成

This sets the maximum number of categories pandas should output when printing out a Categorical or a Series of dtype "category". [default: 8] [currently: 8]

display.max_columns集成

如果超过最大值，则切换到截断视图。取决于 large_repr ，对象要么集中截断，要么打印为摘要视图。“无”值表示无限。

In case python/IPython is running in a terminal and large_repr equals 'truncate' this can be set to 0 and pandas will auto-detect the width of the terminal and print a truncated object which fits the screen width. The IPython notebook, IPython qtconsole, or IDLE do not run in a terminal and hence it is not possible to do correct auto-detection. [default: 0] [currently: 0]

display.max_colwidth整型或无

The maximum width in characters of a column in the repr of a pandas data structure. When the column overflows, a "..." placeholder is embedded in the output. A 'None' value means unlimited. [default: 50] [currently: 50]

display.max_dir_items集成

将添加到的项数 dir(...) 。“无”值表示无限。因为dir是缓存的，所以在删除或添加列之前，更改此选项不会立即影响已有的数据帧。

This is for instance used to suggest columns from a dataframe to tab completion. [default: 100] [currently: 100]

display.max_info_columns集成

max_info_columns is used in DataFrame.info method to decide if per column information will be printed. [default: 100] [currently: 100]

display.max_info_rows整型或无

df.info() will usually show null-counts for each column. For large frames this can be quite slow. max_info_rows and max_info_cols limit this null check only to frames with smaller dimensions than specified. [default: 1690785] [currently: 1690785]

display.max_rows集成

如果超过max_row，则切换到截断视图。取决于 large_repr ，对象要么集中截断，要么打印为摘要视图。“无”值表示无限。

In case python/IPython is running in a terminal and large_repr equals 'truncate' this can be set to 0 and pandas will auto-detect the height of the terminal and print a truncated object which fits the screen height. The IPython notebook, IPython qtconsole, or IDLE do not run in a terminal and hence it is not possible to do correct auto-detection. [default: 60] [currently: 15]

display.max_seq_items整型或无

当漂亮地打印一个长序列时，就不会再有了 max_seq_items 将被打印出来。如果省略这些项目，则会加上“……”来表示。添加到结果字符串。

If set to None, the number of items to be printed is unlimited. [default: 100] [currently: 100]

display.memory_usage布尔、字符串或无

This specifies if the memory usage of a DataFrame should be displayed when df.info() is called. Valid values True,False,'deep' [default: True] [currently: True]

display.min_rows集成

The numbers of rows to show in a truncated view (when max_rows is exceeded). Ignored when max_rows is set to None or 0. When set to None, follows the value of max_rows. [default: 10] [currently: 10]

display.multi_sparse布尔值

"sparsify" MultiIndex display (don't display repeated elements in outer levels within groups) [default: True] [currently: True]

display.notebook_repr_html布尔值

When True, IPython notebook will use html representation for pandas objects (if it is available). [default: True] [currently: True]

display.pprint_nest_depth集成

Controls the number of nested levels to process when pretty-printing [default: 3] [currently: 3]

display.precision集成

Floating point output precision in terms of number of places after the decimal, for regular formatting as well as scientific notation. Similar to precision in numpy.set_printoptions(). [default: 6] [currently: 6]

display.show_dimensions布尔值或“截断”

Whether to print out dimensions at the end of DataFrame repr. If 'truncate' is specified, only print out the dimensions if the frame is truncated (e.g. not display all rows and/or columns) [default: truncate] [currently: truncate]

display.unicode.ambiguous_as_wide布尔值

Whether to use the Unicode East Asian Width to calculate the display text width. Enabling this may affect to the performance (default: False) [default: False] [currently: False]

display.unicode.east_asian_width布尔值

Whether to use the Unicode East Asian Width to calculate the display text width. Enabling this may affect to the performance (default: False) [default: False] [currently: False]

display.width集成

Width of the display in characters. In case python/IPython is running in a terminal this can be set to None and pandas will correctly auto-detect the width. Note that the IPython notebook, IPython qtconsole, or IDLE do not run in a terminal and hence it is not possible to correctly detect the width. [default: 80] [currently: 80]

io.excel.ods.reader字符串

The default Excel reader engine for 'ods' files. Available options: auto, odf. [default: auto] [currently: auto]

io.excel.ods.writer字符串

The default Excel writer engine for 'ods' files. Available options: auto, odf. [default: auto] [currently: auto]

io.excel.xls.reader字符串

The default Excel reader engine for 'xls' files. Available options: auto, xlrd. [default: auto] [currently: auto]

io.excel.xls.writer字符串

The default Excel writer engine for 'xls' files. Available options: auto, xlwt. [default: auto] [currently: auto] (Deprecated, use `` instead.)

io.excel.xlsb.reader字符串

The default Excel reader engine for 'xlsb' files. Available options: auto, pyxlsb. [default: auto] [currently: auto]

io.excel.xlsm.reader字符串

The default Excel reader engine for 'xlsm' files. Available options: auto, xlrd, openpyxl. [default: auto] [currently: auto]

io.excel.xlsm.writer字符串

The default Excel writer engine for 'xlsm' files. Available options: auto, openpyxl. [default: auto] [currently: auto]

io.excel.xlsx.reader字符串

The default Excel reader engine for 'xlsx' files. Available options: auto, xlrd, openpyxl. [default: auto] [currently: auto]

io.excel.xlsx.writer字符串

The default Excel writer engine for 'xlsx' files. Available options: auto, openpyxl, xlsxwriter. [default: auto] [currently: auto]

io.hdf.default_format格式化

default format writing format, if None, then put will default to 'fixed' and append will default to 'table' [default: None] [currently: None]

io.hdf.dropna_table布尔值

drop ALL nan rows when appending to a table [default: False] [currently: False]

io.parquet.engine字符串

The default parquet reader/writer engine. Available options: 'auto', 'pyarrow', 'fastparquet', the default is 'auto' [default: auto] [currently: auto]

io.sql.engine字符串

The default sql reader/writer engine. Available options: 'auto', 'sqlalchemy', the default is 'auto' [default: auto] [currently: auto]

mode.chained_assignment字符串

Raise an exception, warn, or no action if trying to use chained assignment, The default is warn [default: warn] [currently: warn]

mode.data_manager字符串

Internal data manager type; can be "block" or "array". Defaults to "block", unless overridden by the 'PANDAS_DATA_MANAGER' environment variable (needs to be set before pandas is imported). [default: block] [currently: block]

mode.sim_interactive布尔值

Whether to simulate interactive mode for purposes of testing [default: False] [currently: False]

mode.string_storage字符串

The default storage for StringDtype. [default: python] [currently: python]

mode.use_inf_as_na布尔值

True means treat None, NaN, INF, -INF as NA (old way), False means None and NaN are null, but INF, -INF are not NA (new way). [default: False] [currently: False]

mode.use_inf_as_null布尔值

use_inf_as_null had been deprecated and will be removed in a future version. Use use_inf_as_na instead. [default: False] [currently: False] (Deprecated, use mode.use_inf_as_na instead.)

plotting.backend应力

The plotting backend to use. The default value is "matplotlib", the backend provided with pandas. Other backends can be specified by providing the name of the module that implements the backend. [default: matplotlib] [currently: matplotlib]

plotting.matplotlib.register_converters布尔或‘AUTO’。

Whether to register converters with matplotlib's units registry for dates, times, datetimes, and Periods. Toggling to False will remove the converters, restoring any converters that pandas overwrote. [default: auto] [currently: auto]

styler.format.decimal应力

The character representation for the decimal separator for floats and complex. [default: .] [currently: .]

styler.format.escape字符串，可选

Whether to escape certain characters according to the given context; html or latex. [default: None] [currently: None]

styler.format.formatter字符串、可调用、DICT、可选

A formatter object to be used as default within Styler.format. [default: None] [currently: None]

styler.format.na_rep字符串，可选

The string representation for values identified as missing. [default: None] [currently: None]

styler.format.precision集成

The precision for floats and complex numbers. [default: 6] [currently: 6]

styler.format.thousands字符串，可选

The character representation for thousands separator for floats, int and complex. [default: None] [currently: None]

styler.html.mathjax布尔尔

If False will render special CSS classes to table attributes that indicate Mathjax will not be used in Jupyter Notebook. [default: True] [currently: True]

styler.latex.environment应力

The environment to replace \begin{table}. If "longtable" is used results in a specific longtable environment format. [default: None] [currently: None]

styler.latex.hrules布尔尔

Whether to add horizontal rules on top and bottom and below the headers. [default: False] [currently: False]

styler.latex.multicol_align{“r”，“c”，“l”，“naive-l”，“naive-r”}

The specifier for horizontal alignment of sparsified LaTeX multicolumns. Pipe decorators can also be added to non-naive values to draw vertical rules, e.g. "|r" will draw a rule on the left side of right aligned merged cells. [default: r] [currently: r]

styler.latex.multirow_align{“c”，“t”，“b”}

The specifier for vertical alignment of sparsified LaTeX multirows. [default: c] [currently: c]

styler.render.encoding应力

The encoding used for output HTML and LaTeX files. [default: utf-8] [currently: utf-8]

styler.render.max_columns整型，可选

The maximum number of columns that will be rendered. May still be reduced to satsify max_elements, which takes precedence. [default: None] [currently: None]

styler.render.max_elements集成

The maximum number of data-cell (<td>) elements that will be rendered before trimming will occur over columns, rows or both if needed. [default: 262144] [currently: 262144]

styler.render.max_rows整型，可选

The maximum number of rows that will be rendered. May still be reduced to satsify max_elements, which takes precedence. [default: None] [currently: None]

styler.render.repr应力

Determine which output to use in Jupyter Notebook in {"html", "latex"}. [default: html] [currently: html]

styler.sparse.columns布尔尔

Whether to sparsify the display of hierarchical columns. Setting to False will display each explicit level element in a hierarchical key for each column. [default: True] [currently: True]

styler.sparse.index布尔尔

Whether to sparsify the display of a hierarchical index. Setting to False will display each explicit level element in a hierarchical key for each row. [default: True] [currently: True]

选项和设置

pandas.reset_option