FilesExpand file tree

 master

/

displaypub.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

116 lines (91 loc) · 4 KB

 master

/

displaypub.py

Copy path

Top

File metadata and controls

• Code
• Blame

116 lines (91 loc) · 4 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

"""An interface for publishing rich data to frontends.

There are two components of the display system:

* Display formatters, which take a Python object and compute the

representation of the object in various formats (text, HTML, SVG, etc.).

* The display publisher that is used to send the representation data to the

various frontends.

This module defines the logic display publishing. The display publisher uses

the ``display_data`` message type that is defined in the IPython messaging

spec.

"""

# Copyright (c) IPython Development Team.

# Distributed under the terms of the Modified BSD License.

from __future__ import print_function

from traitlets.config.configurable import Configurable

from IPython.utils import io

from traitlets import List

# This used to be defined here - it is imported for backwards compatibility

from .display import publish_display_data

#-----------------------------------------------------------------------------

# Main payload class

#-----------------------------------------------------------------------------

class DisplayPublisher(Configurable):

"""A traited class that publishes display data to frontends.

Instances of this class are created by the main IPython object and should

be accessed there.

"""

def _validate_data(self, data, metadata=None):

"""Validate the display data.

Parameters

----------

data : dict

The formata data dictionary.

metadata : dict

Any metadata for the data.

"""

if not isinstance(data, dict):

raise TypeError('data must be a dict, got: %r' % data)

if metadata is not None:

if not isinstance(metadata, dict):

raise TypeError('metadata must be a dict, got: %r' % data)

def publish(self, data, metadata=None, source=None):

"""Publish data and metadata to all frontends.

See the ``display_data`` message in the messaging documentation for

more details about this message type.

The following MIME types are currently implemented:

* text/plain

* text/html

* text/markdown

* text/latex

* application/json

* application/javascript

* image/png

* image/jpeg

* image/svg+xml

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. Metadata specific to each mime-type can be specified

in the metadata dict with the same mime-type keys as

the data itself.

source : str, deprecated

Unused.

"""

# The default is to simply write the plain text data using io.stdout.

if 'text/plain' in data:

print(data['text/plain'], file=io.stdout)

def clear_output(self, wait=False):

"""Clear the output of the cell receiving output."""

print('\033[2K\r', file=io.stdout, end='')

io.stdout.flush()

print('\033[2K\r', file=io.stderr, end='')

io.stderr.flush()

class CapturingDisplayPublisher(DisplayPublisher):

"""A DisplayPublisher that stores"""

outputs = List()

def publish(self, data, metadata=None, source=None):

self.outputs.append((data, metadata))

def clear_output(self, wait=False):

super(CapturingDisplayPublisher, self).clear_output(wait)

# empty the list, *do not* reassign a new list

del self.outputs[:]