Skip to content

Commit fa12a2e

Browse files
authored
Merge pull request #483 from kevin-bates/refactor-gateway-km
Refactor gateway kernel management to achieve a degree of consistency
2 parents a0135ca + f4ba1ce commit fa12a2e

File tree

6 files changed

+810
-464
lines changed

6 files changed

+810
-464
lines changed

docs/source/other/full-config.rst

+13-13
Original file line numberDiff line numberDiff line change
@@ -1178,19 +1178,19 @@ NotebookNotary.store_factory : Callable
11781178
A callable returning the storage backend for notebook signatures.
11791179
The default uses an SQLite database.
11801180

1181-
GatewayKernelManager.allow_tracebacks : Bool
1181+
GatewayMappingKernelManager.allow_tracebacks : Bool
11821182
Default: ``True``
11831183

11841184
Whether to send tracebacks to clients on exceptions.
11851185

1186-
GatewayKernelManager.allowed_message_types : List
1186+
GatewayMappingKernelManager.allowed_message_types : List
11871187
Default: ``[]``
11881188

11891189
White list of allowed kernel message types.
11901190
When the list is empty, all message types are allowed.
11911191

11921192

1193-
GatewayKernelManager.buffer_offline_messages : Bool
1193+
GatewayMappingKernelManager.buffer_offline_messages : Bool
11941194
Default: ``True``
11951195

11961196
Whether messages from kernels whose frontends have disconnected should be buffered in-memory.
@@ -1202,36 +1202,36 @@ GatewayKernelManager.buffer_offline_messages : Bool
12021202
no frontends are connected.
12031203

12041204

1205-
GatewayKernelManager.cull_busy : Bool
1205+
GatewayMappingKernelManager.cull_busy : Bool
12061206
Default: ``False``
12071207

12081208
Whether to consider culling kernels which are busy.
12091209
Only effective if cull_idle_timeout > 0.
12101210

1211-
GatewayKernelManager.cull_connected : Bool
1211+
GatewayMappingKernelManager.cull_connected : Bool
12121212
Default: ``False``
12131213

12141214
Whether to consider culling kernels which have one or more connections.
12151215
Only effective if cull_idle_timeout > 0.
12161216

1217-
GatewayKernelManager.cull_idle_timeout : Int
1217+
GatewayMappingKernelManager.cull_idle_timeout : Int
12181218
Default: ``0``
12191219

12201220
Timeout (in seconds) after which a kernel is considered idle and ready to be culled.
12211221
Values of 0 or lower disable culling. Very short timeouts may result in kernels being culled
12221222
for users with poor network connections.
12231223

1224-
GatewayKernelManager.cull_interval : Int
1224+
GatewayMappingKernelManager.cull_interval : Int
12251225
Default: ``300``
12261226

12271227
The interval (in seconds) on which to check for idle kernels exceeding the cull timeout value.
12281228

1229-
GatewayKernelManager.default_kernel_name : Unicode
1229+
GatewayMappingKernelManager.default_kernel_name : Unicode
12301230
Default: ``'python3'``
12311231

12321232
The name of the default kernel to start
12331233

1234-
GatewayKernelManager.kernel_info_timeout : Float
1234+
GatewayMappingKernelManager.kernel_info_timeout : Float
12351235
Default: ``60``
12361236

12371237
Timeout for giving up on a kernel (in seconds).
@@ -1244,24 +1244,24 @@ GatewayKernelManager.kernel_info_timeout : Float
12441244
and the ZMQChannelsHandler (which handles the startup).
12451245

12461246

1247-
GatewayKernelManager.kernel_manager_class : DottedObjectName
1247+
GatewayMappingKernelManager.kernel_manager_class : DottedObjectName
12481248
Default: ``'jupyter_client.ioloop.IOLoopKernelManager'``
12491249

12501250
The kernel manager class. This is configurable to allow
12511251
subclassing of the KernelManager for customized behavior.
12521252

12531253

1254-
GatewayKernelManager.root_dir : Unicode
1254+
GatewayMappingKernelManager.root_dir : Unicode
12551255
Default: ``''``
12561256

12571257
No description
12581258

1259-
GatewayKernelManager.shared_context : Bool
1259+
GatewayMappingKernelManager.shared_context : Bool
12601260
Default: ``True``
12611261

12621262
Share a single zmq.Context to talk to all my kernels
12631263

1264-
GatewayKernelManager.traceback_replacement_message : Unicode
1264+
GatewayMappingKernelManager.traceback_replacement_message : Unicode
12651265
Default: ``'An exception occurred at runtime, which is not shown due to ...``
12661266

12671267
Message to print when allow_tracebacks is False, and an exception occurs

0 commit comments

Comments
 (0)