{ } Raw JSON

bundles / IPython 9.17.0 / IPython / lib / display / FileLinks / _get_display_formatter

function

IPython.lib.display:FileLinks._get_display_formatter

source: /dev/ipython/IPython/lib/display.py:522

Signature

def _get_display_formatter(self, dirname_output_format, fname_output_format, fp_format, fp_cleaner = None, escape_names = False)

Summary

generate built-in formatter function

Extended Summary

this is used to define both the notebook and terminal built-in

formatters as they only differ by some wrapper text for each entry

dirname_output_format: string to use for formatting directory

names, dirname will be substituted for a single "%s" which must appear in this string

fname_output_format: string to use for formatting file names,

if a single "%s" appears in the string, fname will be substituted if two "%s" appear in the string, the path to fname will be substituted for the first and fname will be substituted for the second

fp_format: string to use for formatting filepaths, must contain

exactly two "%s" and the dirname will be substituted for the first and fname will be substituted for the second

escape_names: whether directory and file names must be HTML-escaped

before being substituted, as they are for the notebook formatter

Aliases

  • IPython.display.FileLinks._get_display_formatter