FilesExpand file tree

 master

/

kernelmanagerabc.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

226 lines (159 loc) · 5.01 KB

 master

/

kernelmanagerabc.py

Copy path

Top

File metadata and controls

• Code
• Blame

226 lines (159 loc) · 5.01 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

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

"""Abstract base classes for kernel manager and channels."""

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

# Copyright (C) 2013 The IPython Development Team

#

# Distributed under the terms of the BSD License. The full license is in

# the file COPYING, distributed as part of this software.

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

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

# Imports

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

# Standard library imports.

import abc

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

# Channels

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

class ChannelABC(object):

"""A base class for all channel ABCs."""

__metaclass__ = abc.ABCMeta

@abc.abstractmethod

def start(self):

pass

@abc.abstractmethod

def stop(self):

pass

@abc.abstractmethod

def is_alive(self):

pass

class ShellChannelABC(ChannelABC):

"""ShellChannel ABC.

The docstrings for this class can be found in the base implementation:

`IPython.kernel.kernelmanager.ShellChannel`

"""

@abc.abstractproperty

def allow_stdin(self):

pass

@abc.abstractmethod

def execute(self, code, silent=False, store_history=True,

user_variables=None, user_expressions=None, allow_stdin=None):

pass

@abc.abstractmethod

def complete(self, text, line, cursor_pos, block=None):

pass

@abc.abstractmethod

def object_info(self, oname, detail_level=0):

pass

@abc.abstractmethod

def history(self, raw=True, output=False, hist_access_type='range', **kwargs):

pass

@abc.abstractmethod

def kernel_info(self):

pass

@abc.abstractmethod

def shutdown(self, restart=False):

pass

class IOPubChannelABC(ChannelABC):

"""IOPubChannel ABC.

The docstrings for this class can be found in the base implementation:

`IPython.kernel.kernelmanager.IOPubChannel`

"""

@abc.abstractmethod

def flush(self, timeout=1.0):

pass

class StdInChannelABC(ChannelABC):

"""StdInChannel ABC.

The docstrings for this class can be found in the base implementation:

`IPython.kernel.kernelmanager.StdInChannel`

"""

@abc.abstractmethod

def input(self, string):

pass

class HBChannelABC(ChannelABC):

"""HBChannel ABC.

The docstrings for this class can be found in the base implementation:

`IPython.kernel.kernelmanager.HBChannel`

"""

@abc.abstractproperty

def time_to_dead(self):

pass

@abc.abstractmethod

def pause(self):

pass

@abc.abstractmethod

def unpause(self):

pass

@abc.abstractmethod

def is_beating(self):

pass

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

# Main kernel manager class

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

class KernelManagerABC(object):

"""KernelManager ABC.

The docstrings for this class can be found in the base implementation:

`IPython.kernel.kernelmanager.KernelManager`

"""

__metaclass__ = abc.ABCMeta

@abc.abstractproperty

def kernel(self):

pass

@abc.abstractproperty

def shell_channel_class(self):

pass

@abc.abstractproperty

def iopub_channel_class(self):

pass

@abc.abstractproperty

def hb_channel_class(self):

pass

@abc.abstractproperty

def stdin_channel_class(self):

pass

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

# Channel management methods

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

@abc.abstractmethod

def start_channels(self, shell=True, iopub=True, stdin=True, hb=True):

pass

@abc.abstractmethod

def stop_channels(self):

pass

@abc.abstractproperty

def channels_running(self):

pass

@abc.abstractproperty

def shell_channel(self):

pass

@abc.abstractproperty

def iopub_channel(self):

pass

@abc.abstractproperty

def stdin_channel(self):

pass

@abc.abstractproperty

def hb_channel(self):

pass

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

# Kernel management

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

@abc.abstractmethod

def start_kernel(self, **kw):

pass

@abc.abstractmethod

def shutdown_kernel(self, now=False, restart=False):

pass

@abc.abstractmethod

def restart_kernel(self, now=False, **kw):

pass

@abc.abstractproperty

def has_kernel(self):

pass

@abc.abstractmethod

def interrupt_kernel(self):

pass

@abc.abstractmethod

def signal_kernel(self, signum):

pass

@abc.abstractproperty

def is_alive(self):

pass