You are viewing an older version (9.3.0). Go to latest (9.13.0)
{ } Raw JSON

bundles / IPython 9.3.0 / IPython / core / formatters / format_display_data

function

IPython.core.formatters:format_display_data

source: /IPython/core/formatters.py :1057

Signature

def   format_display_data ( obj include = None exclude = None )

Summary

Return a format data dict for an object.

Extended Summary

By default all format types will be computed.

Parameters

obj : object

The Python object whose format data will be computed.

Returns

format_dict : dict

A dictionary of key/value pairs, one or each format that was generated for the object. The keys are the format types, which will usually be MIME type strings and the values and JSON'able data structure containing the raw data for the representation in that format.

include : list or tuple, optional

A list of format type strings (MIME types) to include in the format data dict. If this is set only the format types included in this list will be computed.

exclude : list or tuple, optional

A list of format type string (MIME types) to exclude in the format data dict. If this is set all format types will be computed, except for those included in this argument.

Aliases

  • IPython.core.formatters.format_display_data