^hv2SrSSKJr SSKrSSKrSSKr/SQrSr"SS5r\"5r S\ 4SS.S jjr S r SSSSSS S S .S jr Sr "SS\5rSSjrg)zGTop-level display functions for displaying object in different formats.)b2a_hexN)display clear_outputpublish_display_dataupdate_display DisplayHandlec[U[5(a[U[5(dU$UR5H"up#[UR U5U5X'M$ U$)z_Like update, but merges sub-dicts instead of clobbering at the top level. Updates d1 in-place ) isinstancedictitems_mergeget)d1d2keyvalues X/home/james-whalen/.local/lib/python3.13/site-packages/IPython/core/display_functions.pyr r sO b$  z"d';'; hhj e,! Ic\rSrSrSrSrg) _Sentinel%cg)Nz selfs r__repr___Sentinel.__repr__&srrN)__name__ __module__ __qualname____firstlineno__r__static_attributes__rrrrr%srr) transientc SSKJn U[La[R"S[ SS9 UR 5RnU(aX4S'UR"S UUS.UD6 g) aPublish data and metadata to all frontends. See the ``display_data`` message in the messaging documentation for more details about this message type. Keys of data and metadata can be any mime-type. Parameters ---------- data : dict A dictionary having keys that are valid MIME types (like 'text/plain' or 'image/svg+xml') and values that are the data for that MIME type. The data itself must be a JSON'able data structure. Minimally all data should have the 'text/plain' data, which can be displayed by all frontends. If more than the plain text is given, it is up to the frontend to decide which representation to use. metadata : dict A dictionary for metadata related to the data. This can contain arbitrary key, value pairs that frontends can use to interpret the data. mime-type keys matching those in data can be used to specify metadata about particular representations. source : str, deprecated Unused. transient : dict, keyword-only A dictionary of transient data, such as display_id. rInteractiveShellzThe `source` parameter emit a deprecation warning since IPython 8.0, it had no effects for a long time and will be removed in future versions.) stacklevelr#datametadataNr) IPython.core.interactiveshellr& _sentinelwarningswarnDeprecationWarninginstance display_pubpublish)r*r+sourcer#kwargsr&r2s rrr-sn<? Y  .   #++-99K '{  rc^[[R"S55RS5$)z*Generate a new random text id with urandomascii)rosurandomdecoderrr_new_idr<ds 2::b> " ) )' 22rF)includeexcluder+r# display_idrawclearcXSSKJn U R5(d [U6 gUc0nUc0nU(aUSLa [ 5nXCS'UR S5(aSU;a [ S5eU(aX8S'U(d U(a0/nSnU(d$U R5RRn U(a [SS 9 UHJn U(a[S XS .UD6 MW "XUS 9upU (dM+U(a [X5 [S XS .UD6 ML U(a [U5$g) aJDisplay a Python object in all frontends. By default all representations will be computed and sent to the frontends. Frontends can decide which representation is used and how. In terminal IPython this will be similar to using :func:`print`, for use in richer frontends see Jupyter notebook examples with rich display logic. Parameters ---------- *objs : object The Python objects to display. raw : bool, optional Are the objects to be displayed already mimetype-keyed dicts of raw display data, or Python objects that need to be formatted before display? [default: False] include : list, tuple or set, 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, tuple or set, optional A list of format type strings (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. metadata : dict, optional A dictionary of metadata to associate with the output. mime-type keys in this dictionary will be associated with the individual representation formats, if they exist. transient : dict, optional A dictionary of transient data to associate with the output. Data in this dict should not be persisted to files (e.g. notebooks). display_id : str, bool optional Set an id for the display. This id can be used for updating this display area later via update_display. If given as `True`, generate a new `display_id` clear : bool, optional Should the output area be cleared before displaying anything? If True, this will wait for additional output before clearing. [default: False] **kwargs : additional keyword-args, optional Additional keyword-arguments are passed through to the display publisher. Returns ------- handle: DisplayHandle Returns a handle on updatable displays for use with :func:`update_display`, if `display_id` is given. Returns :any:`None` if no `display_id` is given (default). Examples -------- >>> class Json(object): ... def __init__(self, json): ... self.json = json ... def _repr_pretty_(self, pp, cycle): ... import json ... pp.text(json.dumps(self.json, indent=2)) ... def __repr__(self): ... return str(self.json) ... >>> d = Json({1:2, 3: {4:5}}) >>> print(d) {1: 2, 3: {4: 5}} >>> display(d) { "1": 2, "3": { "4": 5 } } >>> def int_formatter(integer, pp, cycle): ... pp.text('I'*integer) >>> plain = get_ipython().display_formatter.formatters['text/plain'] >>> plain.for_type(int, int_formatter) >>> display(7-5) II >>> del plain.type_printers[int] >>> display(7-5) 2 See Also -------- :func:`update_display` Notes ----- In Python, objects can declare their textual representation using the `__repr__` method. IPython expands on this idea and allows objects to declare other, rich representations including: - HTML - JSON - PNG - JPEG - SVG - LaTeX A single object can declare some or all of these representations; all are handled by IPython's display system. The main idea of the first approach is that you have to implement special display methods when you define your class, one for each representation you want to use. Here is a list of the names of the special methods and the values they must return: - `_repr_html_`: return raw HTML as a string, or a tuple (see below). - `_repr_json_`: return a JSONable dict, or a tuple (see below). - `_repr_jpeg_`: return raw JPEG data, or a tuple (see below). - `_repr_png_`: return raw PNG data, or a tuple (see below). - `_repr_svg_`: return raw SVG data as a string, or a tuple (see below). - `_repr_latex_`: return LaTeX commands in a string surrounded by "$", or a tuple (see below). - `_repr_mimebundle_`: return a full mimebundle containing the mapping from all mimetypes to data. Use this for any mime-type not listed above. The above functions may also return the object's metadata alonside the data. If the metadata is available, the functions will return a tuple containing the data and metadata, in that order. If there is no metadata available, then the functions will return the data only. When you are directly writing your own classes, you can adapt them for display in IPython by following the above approach. But in practice, you often need to work with existing classes that you can't easily modify. You can refer to the documentation on integrating with the display system in order to register custom formatters for already existing types (:ref:`integrating_rich_display`). .. versionadded:: 5.4 display available without import .. versionadded:: 6.1 display available without import Since IPython 5.4 and 6.1 :func:`display` is automatically made available to the user without import. If you are using display in a document that might be used in a pure python context or with older version of IPython, use the following import at the top of your file:: from IPython.display import display rr%NTr?updatez&display_id required for update_displayr#)waitr))r=r>r)r,r& initializedprintr<r TypeErrorr1display_formatterformatrrr r)r=r>r+r#r?r@rAobjsr5r&rIobj format_dictmd_dicts rrrisx?  ' ' ) ) t     J",, zz( I =@AA'{ Jt !**,>>EE $  Gc G G#)##P Kw) Nk Nv NZ((rc *SUS'[U4SU0UD6 g)zUpdate an existing display by id Parameters ---------- obj The object with which to update the display display_id : keyword-only The id of the display to update See Also -------- :func:`display` TrCr?N)r)rKr?r5s rrr7s F8 C1J1&1rc4\rSrSrSrS SjrSrSrSrSr g) riIzA handle on an updatable display Call `.update(obj)` to display a new object. Call `.display(obj`) to add a new instance of this display, and update existing instances. See Also -------- :func:`display`, :func:`update_display` Nc*Uc [5nXlgN)r<r?)rr?s r__init__DisplayHandle.__init__Xs   J$rcTSURR<SUR<S3$)N) __class__rr?rs rrDisplayHandle.__repr__]s'+~~'>'>PPrc 4[U4SUR0UD6 g)zMake a new display with my id, updating existing instances. Parameters ---------- obj object to display **kwargs additional keyword arguments passed to display r?N)rr?rrKr5s rrDisplayHandle.display`s ::6:rc 4[U4SUR0UD6 g)zUpdate existing displays with my id Parameters ---------- obj object to display **kwargs additional keyword arguments passed to update_display r?N)rr?rZs rrCDisplayHandle.updatels sAtA&Ar)r?rQ) rrr r!__doc__rRrrrCr"rrrrrIs % Q ; Brrc.SSKJn UR5(a*UR5RR U5 g[ SSS9 [RR5 [ SSS9 [RR5 g)zClear the output of the current cell receiving output. Parameters ---------- wait : bool [default: false] Wait to clear the output until new output is available to replace it.rr%z )endN) r,r&rEr1r2rrFsysstdoutflushstderr)rDr&s rrrysg?##%%!!#//<risM   ` " K  48<4n3    J)\2$-BF-B`r