Skip to content

Core Kernel

penvm.kernels.core.client

Client-side interface to access the "core" kernel operations.

See penvm.kernels.core.server.

KernelClient

Bases: _KernelClient

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
 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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
class KernelClient(_KernelClient):
    name = "core"

    def connection_get_state(self, connectionid):
        """See [penvm.kernels.core.server.ConnectionGetState][]."""
        d = {
            "connection-id": connectionid,
        }
        return self.session.newput_request("connection-get-info", d)

    def echo(self, d):
        """See [penvm.kernels.core.server.Echo][]."""
        return self.session.newput_request("echo", d)

    def kernel_add(self, kernelname, kernelsrc):
        """See [penvm.kernels.core.server.KernelAdd][]."""
        d = {
            "kernel": kernelname,
            "source": kernelsrc,
        }
        return self.session.newput_request("kernel-add", d)

    def kernel_copy(self, src_kernelname, dst_kernelname):
        """See [penvm.kernels.core.server.KernelCopy][]."""
        d = {
            "src-kernel": src_kernelname,
            "dst-kernel": dst_kernelname,
        }
        return self.session.newput_request("kernel-copy", d)

    def kernel_drop(self, kernelname):
        """See [penvm.kernels.core.server.KernelDrop][]."""
        d = {
            "kernel": kernelname,
        }
        return self.session.newput_request("kernel-drop", d)

    def kernel_get_state(self, kernelname):
        """See [penvm.kernels.core.server.KernelGetState][]."""
        d = {
            "kernel": kernelname,
        }
        return self.session.newput_request("kernel-get-state", d)

    def kernel_list_ops(self, kernelname):
        """See [penvm.kernels.core.server.KernelListOps][]."""
        d = {
            "kernel": kernelname,
        }
        return self.session.newput_request("kernel-list-ops", d)

    def kernel_register_op(
        self,
        kernelname,
        opname,
        opclassname,
        code,
        code_key=None,
    ):
        """See [penvm.kernels.core.server.KernelRegisterOp][]."""
        d = {
            "code": code,
            "kernel": kernelname,
            "new-op": opname,
            "op-class": opclassname,
        }
        if code_key:
            d["code-key"] = code_key
        return self.session.newput_request("kernel-register-op", d)

    def kernel_unregister_op(
        self,
        kernelname,
        opname,
    ):
        """See [penvm.kernels.core.server.KernelUnregisterOp][]."""
        d = {
            "kernel": kernelname,
            "old-op": opname,
        }
        return self.session.newput_request("kernel-unregister-op", d)

    def machine_disable_debug(self):
        """See [penvm.kernels.core.server.MachineDisableDebug][]."""
        # TODO: should this force sessionid to "debug"?
        return self.session.newput_request("machine-enable-debug")

    def machine_drop_session(self, sessionid=None):
        """See [penvm.kernels.core.server.MachineDropSession][]."""
        d = {}
        if sessionid:
            d["session-id"] = sessionid
        return self.session.newput_request("machine-drop-session", d)

    def machine_enable_debug(self):
        """See [penvm.kernels.core.server.MachineEnableDebug][]."""
        # TODO: should this force sessionid to "debug"?
        return self.session.newput_request("machine-enable-debug")

    def machine_get_features(self):
        """See [penvm.kernels.core.server.MachineGetFeatures][]."""
        return self.session.newput_request("machine-get-features")

    def machine_get_state(self):
        """See [penvm.kernels.core.server.MachineGetState][]."""
        return self.session.newput_request("machine-get-state")

    def machine_list_kernels(self):
        """See [penvm.kernels.core.server.MachineListKernels][]."""
        return self.session.newput_request("machine-list-kernels")

    def machine_list_sessions(self):
        """See [penvm.kernels.core.server.MachineListSessions][]."""
        return self.session.newput_request("machine-list-sessions")

    def machine_shutdown(self):
        """See [penvm.kernels.core.server.MachineShutdown][]."""
        return self.session.newput_request("machine-shutdown")

    def machine_snapshot(self):
        """See [penvm.kernels.core.server.MachineSnapshot][]."""
        return self.session.newput_request("machine-snapshot")

    def machine_step_debug(self):
        """See [penvm.kernels.core.server.MachineStepDebug][]."""
        # TODO: should this force sessionid to "debug"?
        return self.session.newput_request("machine-step-debug")

    def session_drop_request(self, reqid, sessionid=None):
        """See [penvm.kernels.core.server.SessionDropRequest][]."""
        d = {
            "request-id": reqid,
        }
        if sessionid:
            d["session-id"] = sessionid
        return self.session.newput_request("session-drop-request", d)

    def session_get_message_state(self, msgid, msgqueue, sessionid=None):
        """See [penvm.kernels.core.server.SessionGetMessageState][]."""
        d = {
            "message-id": msgid,
            "message-queue": msgqueue,
        }
        if sessionid:
            d["session-id"] = sessionid
        return self.session.newput_request("session-get-message-state", d)

    def session_get_processor_state(self, sessionid=None):
        """See [penvm.kernels.core.server.SessionGetProcessorState][]."""
        d = {}
        if sessionid:
            d["session-id"] = sessionid
        return self.session.newput_request("session-get-processor-state", d)

    def session_get_state(self, sessionid=None):
        """See [penvm.kernels.core.server.SessionGetState][]."""
        d = {}
        if sessionid:
            d["session-id"] = sessionid
        return self.session.newput_request("session-get-state", d)

    def session_pin_session(self, sessionid=None):
        """See [penvm.kernels.core.server.SessionPinSession][]."""
        d = {}
        if sessionid:
            d["session-id"] = sessionid
        return self.session.newput_request("session-pin-session", d)

    def session_pop_omq(self, sessionid=None, count=1):
        """See [penvm.kernels.core.server.SessionPopOmq][]."""
        d = {
            "count": count,
        }
        if sessionid != None:
            d["session-id"] = sessionid
        return self.session.newput_request("session-pop-omq", d)

    def session_set_max_threads(self, nthreads, sessionid=None):
        """See [penvm.kernels.core.server.SessionSetMaxThreads][]."""
        d = {
            "nthreads": nthreads,
        }
        if sessionid:
            d["session-id"] = sessionid
        return self.session.newput_request("session-set-max-threads", d)

    def session_terminate_request(self, reqid, sessionid=None):
        """See [penvm.kernels.core.server.SessionTerminateRequest][]."""
        d = {
            "request-id": reqid,
        }
        if sessionid:
            d["session-id"] = sessionid
        return self.session.newput_request("session-terminate-request", d)

    def session_unpin_session(self, sessionid=None):
        """See [penvm.kernels.core.server.SessionUnpinSession][]."""
        d = {}
        if sessionid:
            d["session-id"] = sessionid
        return self.session.newput_request("session-unpin-session", d)

    def session_use_kernel(self, kernelname, sessionid=None):
        """See [penvm.kernels.core.server.SessionUseKernel][]."""
        d = {
            "kernel": kernelname,
        }
        if sessionid:
            d["session-id"] = sessionid
        return self.session.newput_request("session-use-kernel", d)

    def sleep(self, seconds):
        """See [penvm.kernels.core.server.Sleep][]."""
        d = {
            "seconds": seconds,
        }
        return self.session.newput_request("sleep", d)

connection_get_state(connectionid)

See penvm.kernels.core.server.ConnectionGetState.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
35
36
37
38
39
40
 
def connection_get_state(self, connectionid):
    """See [penvm.kernels.core.server.ConnectionGetState][]."""
    d = {
        "connection-id": connectionid,
    }
    return self.session.newput_request("connection-get-info", d)

echo(d)

See penvm.kernels.core.server.Echo.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
42
43
44
 
def echo(self, d):
    """See [penvm.kernels.core.server.Echo][]."""
    return self.session.newput_request("echo", d)

kernel_add(kernelname, kernelsrc)

See penvm.kernels.core.server.KernelAdd.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
46
47
48
49
50
51
52
 
def kernel_add(self, kernelname, kernelsrc):
    """See [penvm.kernels.core.server.KernelAdd][]."""
    d = {
        "kernel": kernelname,
        "source": kernelsrc,
    }
    return self.session.newput_request("kernel-add", d)

kernel_copy(src_kernelname, dst_kernelname)

See penvm.kernels.core.server.KernelCopy.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
54
55
56
57
58
59
60
 
def kernel_copy(self, src_kernelname, dst_kernelname):
    """See [penvm.kernels.core.server.KernelCopy][]."""
    d = {
        "src-kernel": src_kernelname,
        "dst-kernel": dst_kernelname,
    }
    return self.session.newput_request("kernel-copy", d)

kernel_drop(kernelname)

See penvm.kernels.core.server.KernelDrop.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
62
63
64
65
66
67
 
def kernel_drop(self, kernelname):
    """See [penvm.kernels.core.server.KernelDrop][]."""
    d = {
        "kernel": kernelname,
    }
    return self.session.newput_request("kernel-drop", d)

kernel_get_state(kernelname)

See penvm.kernels.core.server.KernelGetState.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
69
70
71
72
73
74
 
def kernel_get_state(self, kernelname):
    """See [penvm.kernels.core.server.KernelGetState][]."""
    d = {
        "kernel": kernelname,
    }
    return self.session.newput_request("kernel-get-state", d)

kernel_list_ops(kernelname)

See penvm.kernels.core.server.KernelListOps.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
76
77
78
79
80
81
 
def kernel_list_ops(self, kernelname):
    """See [penvm.kernels.core.server.KernelListOps][]."""
    d = {
        "kernel": kernelname,
    }
    return self.session.newput_request("kernel-list-ops", d)

kernel_register_op(kernelname, opname, opclassname, code, code_key=None)

See penvm.kernels.core.server.KernelRegisterOp.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
 
def kernel_register_op(
    self,
    kernelname,
    opname,
    opclassname,
    code,
    code_key=None,
):
    """See [penvm.kernels.core.server.KernelRegisterOp][]."""
    d = {
        "code": code,
        "kernel": kernelname,
        "new-op": opname,
        "op-class": opclassname,
    }
    if code_key:
        d["code-key"] = code_key
    return self.session.newput_request("kernel-register-op", d)

kernel_unregister_op(kernelname, opname)

See penvm.kernels.core.server.KernelUnregisterOp.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
102
103
104
105
106
107
108
109
110
111
112
 
def kernel_unregister_op(
    self,
    kernelname,
    opname,
):
    """See [penvm.kernels.core.server.KernelUnregisterOp][]."""
    d = {
        "kernel": kernelname,
        "old-op": opname,
    }
    return self.session.newput_request("kernel-unregister-op", d)

machine_disable_debug()

See penvm.kernels.core.server.MachineDisableDebug.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
114
115
116
117
 
def machine_disable_debug(self):
    """See [penvm.kernels.core.server.MachineDisableDebug][]."""
    # TODO: should this force sessionid to "debug"?
    return self.session.newput_request("machine-enable-debug")

machine_drop_session(sessionid=None)

See penvm.kernels.core.server.MachineDropSession.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
119
120
121
122
123
124
 
def machine_drop_session(self, sessionid=None):
    """See [penvm.kernels.core.server.MachineDropSession][]."""
    d = {}
    if sessionid:
        d["session-id"] = sessionid
    return self.session.newput_request("machine-drop-session", d)

machine_enable_debug()

See penvm.kernels.core.server.MachineEnableDebug.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
126
127
128
129
 
def machine_enable_debug(self):
    """See [penvm.kernels.core.server.MachineEnableDebug][]."""
    # TODO: should this force sessionid to "debug"?
    return self.session.newput_request("machine-enable-debug")

machine_get_features()

See penvm.kernels.core.server.MachineGetFeatures.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
131
132
133
 
def machine_get_features(self):
    """See [penvm.kernels.core.server.MachineGetFeatures][]."""
    return self.session.newput_request("machine-get-features")

machine_get_state()

See penvm.kernels.core.server.MachineGetState.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
135
136
137
 
def machine_get_state(self):
    """See [penvm.kernels.core.server.MachineGetState][]."""
    return self.session.newput_request("machine-get-state")

machine_list_kernels()

See penvm.kernels.core.server.MachineListKernels.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
139
140
141
 
def machine_list_kernels(self):
    """See [penvm.kernels.core.server.MachineListKernels][]."""
    return self.session.newput_request("machine-list-kernels")

machine_list_sessions()

See penvm.kernels.core.server.MachineListSessions.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
143
144
145
 
def machine_list_sessions(self):
    """See [penvm.kernels.core.server.MachineListSessions][]."""
    return self.session.newput_request("machine-list-sessions")

machine_shutdown()

See penvm.kernels.core.server.MachineShutdown.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
147
148
149
 
def machine_shutdown(self):
    """See [penvm.kernels.core.server.MachineShutdown][]."""
    return self.session.newput_request("machine-shutdown")

machine_snapshot()

See penvm.kernels.core.server.MachineSnapshot.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
151
152
153
 
def machine_snapshot(self):
    """See [penvm.kernels.core.server.MachineSnapshot][]."""
    return self.session.newput_request("machine-snapshot")

machine_step_debug()

See penvm.kernels.core.server.MachineStepDebug.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
155
156
157
158
 
def machine_step_debug(self):
    """See [penvm.kernels.core.server.MachineStepDebug][]."""
    # TODO: should this force sessionid to "debug"?
    return self.session.newput_request("machine-step-debug")

session_drop_request(reqid, sessionid=None)

See penvm.kernels.core.server.SessionDropRequest.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
160
161
162
163
164
165
166
167
 
def session_drop_request(self, reqid, sessionid=None):
    """See [penvm.kernels.core.server.SessionDropRequest][]."""
    d = {
        "request-id": reqid,
    }
    if sessionid:
        d["session-id"] = sessionid
    return self.session.newput_request("session-drop-request", d)

session_get_message_state(msgid, msgqueue, sessionid=None)

See penvm.kernels.core.server.SessionGetMessageState.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
169
170
171
172
173
174
175
176
177
 
def session_get_message_state(self, msgid, msgqueue, sessionid=None):
    """See [penvm.kernels.core.server.SessionGetMessageState][]."""
    d = {
        "message-id": msgid,
        "message-queue": msgqueue,
    }
    if sessionid:
        d["session-id"] = sessionid
    return self.session.newput_request("session-get-message-state", d)

session_get_processor_state(sessionid=None)

See penvm.kernels.core.server.SessionGetProcessorState.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
179
180
181
182
183
184
 
def session_get_processor_state(self, sessionid=None):
    """See [penvm.kernels.core.server.SessionGetProcessorState][]."""
    d = {}
    if sessionid:
        d["session-id"] = sessionid
    return self.session.newput_request("session-get-processor-state", d)

session_get_state(sessionid=None)

See penvm.kernels.core.server.SessionGetState.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
186
187
188
189
190
191
 
def session_get_state(self, sessionid=None):
    """See [penvm.kernels.core.server.SessionGetState][]."""
    d = {}
    if sessionid:
        d["session-id"] = sessionid
    return self.session.newput_request("session-get-state", d)

session_pin_session(sessionid=None)

See penvm.kernels.core.server.SessionPinSession.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
193
194
195
196
197
198
 
def session_pin_session(self, sessionid=None):
    """See [penvm.kernels.core.server.SessionPinSession][]."""
    d = {}
    if sessionid:
        d["session-id"] = sessionid
    return self.session.newput_request("session-pin-session", d)

session_pop_omq(sessionid=None, count=1)

See penvm.kernels.core.server.SessionPopOmq.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
200
201
202
203
204
205
206
207
 
def session_pop_omq(self, sessionid=None, count=1):
    """See [penvm.kernels.core.server.SessionPopOmq][]."""
    d = {
        "count": count,
    }
    if sessionid != None:
        d["session-id"] = sessionid
    return self.session.newput_request("session-pop-omq", d)

session_set_max_threads(nthreads, sessionid=None)

See penvm.kernels.core.server.SessionSetMaxThreads.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
209
210
211
212
213
214
215
216
 
def session_set_max_threads(self, nthreads, sessionid=None):
    """See [penvm.kernels.core.server.SessionSetMaxThreads][]."""
    d = {
        "nthreads": nthreads,
    }
    if sessionid:
        d["session-id"] = sessionid
    return self.session.newput_request("session-set-max-threads", d)

session_terminate_request(reqid, sessionid=None)

See penvm.kernels.core.server.SessionTerminateRequest.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
218
219
220
221
222
223
224
225
 
def session_terminate_request(self, reqid, sessionid=None):
    """See [penvm.kernels.core.server.SessionTerminateRequest][]."""
    d = {
        "request-id": reqid,
    }
    if sessionid:
        d["session-id"] = sessionid
    return self.session.newput_request("session-terminate-request", d)

session_unpin_session(sessionid=None)

See penvm.kernels.core.server.SessionUnpinSession.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
227
228
229
230
231
232
 
def session_unpin_session(self, sessionid=None):
    """See [penvm.kernels.core.server.SessionUnpinSession][]."""
    d = {}
    if sessionid:
        d["session-id"] = sessionid
    return self.session.newput_request("session-unpin-session", d)

session_use_kernel(kernelname, sessionid=None)

See penvm.kernels.core.server.SessionUseKernel.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
234
235
236
237
238
239
240
241
 
def session_use_kernel(self, kernelname, sessionid=None):
    """See [penvm.kernels.core.server.SessionUseKernel][]."""
    d = {
        "kernel": kernelname,
    }
    if sessionid:
        d["session-id"] = sessionid
    return self.session.newput_request("session-use-kernel", d)

sleep(seconds)

See penvm.kernels.core.server.Sleep.

Source code in penvm/src/kernels/penvm/kernels/core/client.py 
243
244
245
246
247
248
 
def sleep(self, seconds):
    """See [penvm.kernels.core.server.Sleep][]."""
    d = {
        "seconds": seconds,
    }
    return self.session.newput_request("sleep", d)

penvm.kernels.core.server

Server-side "core" kernel operations.

The core operations provide the necessary functionality on which to build others.

All kernel operations use messages to receive and replay. Convenience functions are available:

  • request: Request
  • response: Response, OkResponse, ErrorResponse

When a Request or Response is unused/empty, this is reflected in the respective attributes section.

Whereas only one Request possible, responses may be OkResponse or ErrorResponse. Both may be described to account for possible responses according to the situation.

The OkResponse indicates success and contains response information in its payload. The ErrorResponse indicates an error (or failure) and contains an error messsage in its payload (-message field).

ConnectionGetState

Bases: Op

Get connection info.

Request:

Name Type Description
connection-id str

Connection id.

OkResponse:

Name Type Description
connection-id str

Connection id.
initial-connection str

Is initial machine connection.
host str

Connection host name.
port int

Connection port.
peer-host str

Client/peer host name.
peer-port int

Client/peer port.
nimq int

Number of IMQ messages.
nomq int

Number of OMQ messages.

ErrorResponse:

Name Type Description
-

Error message.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
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
 
class ConnectionGetState(Op):
    """Get connection info.

    Attributes: Request:
        connection-id (str): Connection id.

    Attributes: OkResponse:
        connection-id (str): Connection id.
        initial-connection (str): Is initial machine connection.
        host (str): Connection host name.
        port (int): Connection port.
        peer-host (str): Client/peer host name.
        peer-port (int): Client/peer port.
        nimq (int): Number of IMQ messages.
        nomq (int): Number of OMQ messages.

    Attributes: ErrorResponse:
        -: Error message.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")
            connid = req.payload.get("connection-id")
            conn = ctxt.machine.connmgr.get(connid)

            if conn != None:
                return OkResponse(
                    payload=Payload(conn.state()),
                    refmsg=req,
                )
            else:
                raise Exception("bad connection")
        except Exception as e:
            self.logger.error(f"{e}")
            return ErrorResponse(
                "connection not found",
                refmsg=req,
            )

Echo

Bases: Op

Echo request payload.

Request:

Name Type Description
-

Unused.

OkResponse:

Name Type Description
-

Matches request payload.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
class Echo(Op):
    """Echo request payload.

    Attributes: Request:
        -: Unused.

    Attributes: OkResponse:
        -: Matches request payload.
    """

    def run(self, ctxt, req):
        try:
            resp = OkResponse(
                payload=req.payload,
                refmsg=req,
            )
            return resp
        except Exception as e:
            self.logger.error(f"{e}")

KernelAdd

Bases: Op

Add a new kernel.

Request:

Name Type Description
kernel str

Name of the kernel.
data str

Kernel file.

Response:

Name Type Description
-

None.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
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
 
class KernelAdd(Op):
    """Add a new kernel.

    Attributes: Request:
        kernel (str): Name of the kernel.
        data (str): Kernel file.

    Attributes: Response:
        -: None.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")
            kernel_name = req.payload.get("kernel")
            kernel_source = req.payload.get("source")

            if None in [kernel_name, kernel_source]:
                return

            try:
                with tempfile.NamedTemporaryFile() as f:
                    f.write(kernel_source.encode("utf-8"))
                    f.seek(0)
                    mod = SourceFileLoader("", f.name).load_module()
                ctxt.machine.kernelmgr.set(kernel_name, mod.Kernel())
                self.logger.info(f"completed ({kernel_name})")
            except Exception as e:
                self.logger.critical(f"EXCEPTION ({e})")
        except Exception as e:
            self.logger.error(f"{e}")

KernelCopy

Bases: Op

Make a copy of an existing kernel.

Request:

Name Type Description
dst-kernel str

Name of destination kernel.
src-kernel str

Name of source kernel.

Response:

Name Type Description
-

None.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
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
 
class KernelCopy(Op):
    """Make a copy of an existing kernel.

    Attributes: Request:
        dst-kernel (str): Name of destination kernel.
        src-kernel (str): Name of source kernel.

    Attributes: Response:
        -: None.
    """

    # TODO: what kind of return value if any?

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")
            src_kernelname = req.payload.get("src-kernel")
            dst_kernelname = req.payload.get("dst-kernel")
            if None in [src_kernelname, dst_kernelname]:
                return

            src_kernel = ctxt.machine.kernelmgr.get(src_kernelname)
            dst_kernel = src_kernel.copy()

            if None in [src_kernel, dst_kernel]:
                return

            ctxt.machine.kernelmgr.set(dst_kernelname, dst_kernel)
        except Exception as e:
            self.logger.error(f"{e}")

KernelDrop

Bases: Op

Drop an kernel. The "default" kernel cannot be dropped.

Request:

Name Type Description
kernel str

Name of kernel.
Attributes Response

-: None.

Source code in penvm/src/kernels/penvm/kernels/core/server.py 
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
class KernelDrop(Op):
    """Drop an kernel. The "default" kernel cannot be dropped.

    Attributes: Request:
        kernel (str): Name of kernel.

    Attributes Response:
        -: None.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")
            name = req.payload.get("kernel")
            ctxt.machine.kernelmgr.drop(name)
        except Exception as e:
            self.logger.error(f"{e}")

KernelGetState

Bases: Op

Get kernel info.

Request:

Name Type Description
kernel str

Kernel name.

OkResponse:

Name Type Description
bases list of str

List of base kernel names.
nops int

Number of operations.
ops list of str

List of operation names.
updated bool

If updated.

ErrorResponse:

Name Type Description
-

Error message.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
class KernelGetState(Op):
    """Get kernel info.

    Attributes: Request:
        kernel (str): Kernel name.

    Attributes: OkResponse:
        bases (list of str): List of base kernel names.
        nops (int): Number of operations.
        ops (list of str): List of operation names.
        updated (bool): If updated.

    Attributes: ErrorResponse:
        -: Error message.
    """

    def run(self, ctxt, req):
        try:
            kernelname = req.payload.get("kernel")
            kernel = ctxt.machine.kernelmgr.get(kernelname)
            return OkResponse(
                payload=Payload(kernel.state()),
                refmsg=req,
            )
        except Exception as e:
            self.logger.error(f"{e}")
            return ErrorResponse(
                "kernel not found",
                refmsg=req,
            )

KernelListOps

Bases: Op

List op names for kernel.

Request:

Name Type Description
kernel str

Kernel name.

OkResponse:

Name Type Description
names list of str

List of kernel operation names.

ErrorResponse:

Name Type Description
-

Error message.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
class KernelListOps(Op):
    """List op names for kernel.

    Attributes: Request:
        kernel (str): Kernel name.

    Attributes: OkResponse:
        names (list of str): List of kernel operation names.

    Attributes: ErrorResponse:
        -: Error message.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")
            kernelname = req.payload.get("kernel")
            if kernelname == None:
                return ErrorResponse(
                    f"kernel name not provided",
                    refmsg=req,
                )

            kernel = ctxt.machine.kernelmgr.get(kernelname)
            if kernel == None:
                return ErrorResponse(
                    f"kernel ({kernelname}) not found",
                    refmsg=req,
                )

            names = kernel.list()
            return OkResponse(
                payload=Payload({"names": names}),
                refmsg=req,
            )
        except Exception as e:
            self.logger.error(f"{e}")

KernelRegisterOp

Bases: Op

Register a new op for an kernel.

Request:

Name Type Description
kernel str

Kernel name.
new-op str

Op name.
op-class str

Op class name.
code str

Kernel class definition.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
class KernelRegisterOp(Op):
    """Register a new op for an kernel.

    Attributes: Request:
        kernel (str): Kernel name.
        new-op (str): Op name.
        op-class (str): Op class name.
        code (str): Kernel class definition.

    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")
            kernel_name = req.payload.get("kernel")
            opname = req.payload.get("new-op")
            opclassname = req.payload.get("op-class")
            code = req.payload.get("code")
            if code == None:
                code_key = req.payload.get("code-key")
                if code_key != None:
                    code = ctxt.machine.fkvstore.get(code_key)

            if None in [kernel_name, opname, opclassname, code]:
                self.logger.debug(
                    f"missing params ({kernel_name=} {opname=} {opclassname=} {code=}"
                )
                return

            kernel = ctxt.machine.kernelmgr.get(kernel_name)
            if kernel == None:
                self.logger.debug(f"cannot find kernel")
                return

            kernel.register_code(opname, opclassname, code)
        except Exception as e:
            self.logger.error(f"{e}")

KernelUnregisterOp

Bases: Op

Unregister an op for an kernel.

Source code in penvm/src/kernels/penvm/kernels/core/server.py 
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
class KernelUnregisterOp(Op):
    """Unregister an op for an kernel."""

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")
            kernel_name = req.payload.get("kernel")
            opname = req.payload.get("old-op")
            if None in [kernel_name, opname]:
                return
            kernel = ctxt.machine.kernelmgr.get(kernel_name)
            kernel.unregister(opname)
        except Exception as e:
            self.logger.error(f"{e}")

MachineDisableDebug

Bases: Op

Disable debug mode.

Request:

Name Type Description

Unused.

Response:

Name Type Description

None.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
class MachineDisableDebug(Op):
    """Disable debug mode.

    Attributes: Request:
        : Unused.

    Attributes: Response:
        : None.
    """

    def run(self, ctxt, req):
        try:
            ctxt.machine.set_debug(False)
        except Exception as e:
            self.logger.error(f"{e}")

MachineDropConnection

Bases: Op

Drop connection.

Request:

Name Type Description
connection-id

Sessionid for session processor. Defaults to sessionid of session running this op.

Response:

Name Type Description

None.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
class MachineDropConnection(Op):
    """Drop connection.

    Attributes: Request:
        connection-id: Sessionid for session processor. Defaults to
            sessionid of session running this op.

    Attributes: Response:
        : None.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")

            connid = re.payload.get("connection-id")
            conn = ctxt.machine.connmgr.get(connid)
            if conn:
                conn.close()
        except Exception as e:
            self.logger.error(f"{e}")

MachineDropSession

Bases: Op

Drop session.

Request:

Name Type Description
session-id

Sessionid for session processor. Defaults to sessionid of session running this op.

Response:

Name Type Description

None.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
class MachineDropSession(Op):
    """Drop session.

    Attributes: Request:
        session-id: Sessionid for session processor. Defaults to
            sessionid of session running this op.

    Attributes: Response:
        : None.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")

            reqid = req.header.get("id")
            sessionid = req.payload.get("session-id", req.header.get("session-id"))
            if sessionid == None:
                self.logger.warning("bad/missing session id")
                return

            session = ctxt.machine.pop_session(sessionid)
            if session == None:
                self.logger.warning(f"session not found for session id ({sessionid}")
                return

            self.logger.debug(f"dropping session ({sessionid}) reqid ({reqid}) ...")

            # clean up
            self.logger.debug(f"imq ({session.imq.values()}) omq ({session.omq.values()}) ...")
            self.logger.debug(f"freezing imq ...")
            session.imq.freeze(True)

            self.logger.debug(f"freezing omq ...")
            session.omq.freeze(True)

            self.logger.debug(f"clearing imq ...")
            session.imq.clear()

            self.logger.debug(f"clearing omq ...")
            session.omq.clear()

            self.logger.debug(f"imq ({session.imq.values()}) omq ({session.omq.values()}) ...")

            self.logger.debug(f"terminating request threads ({session.proc.active_count()})...")
            for _reqid in session.proc.get_thread_reqids():
                try:
                    if _reqid == reqid:
                        self.logger.debug(f"skip terminating reqid ({_reqid})")
                    else:
                        self.logger.debug(f"terminating reqid ({_reqid})")
                        session.proc.terminate_thread(_reqid)
                except Exception as e:
                    self.logger.debug(f"EXCEPTION ({e})")
        except Exception as e:
            self.logger.error(f"{e}")

MachineEnableDebug

Bases: Op

Disable debug mode.

Request:

Name Type Description

Unused.

Response:

Name Type Description

None.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
class MachineEnableDebug(Op):
    """Disable debug mode.

    Attributes: Request:
        : Unused.

    Attributes: Response:
        : None.
    """

    def run(self, ctxt, req):
        try:
            ctxt.machine.set_debug(True)
        except Exception as e:
            self.logger.error(f"{e}")

MachineGetFeatures

Bases: Op

Get and return machine features.

Features are settings which describe the environment and context that a machine runs with. E.g., the base language (i.e., python) and the version.

Request:

Name Type Description
-

Unused.

OkResponse:

Name Type Description
-

Dictionary of machine features.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
class MachineGetFeatures(Op):
    """Get and return machine features.

    Features are settings which describe the environment and context
    that a machine runs with. E.g., the base language (i.e., python)
    and the version.

    Attributes: Request:
        -: Unused.

    Attributes: OkResponse:
        -: Dictionary of machine features.
    """

    def run(self, ctxt, req):
        try:
            return OkResponse(
                payload=Payload(ctxt.machine.features()),
                refmsg=req,
            )
        except Exception as e:
            self.logger.error(f"{e}")
            return ErrorResponse(
                "machine not found",
                refmsg=req,
            )

MachineGetState

Bases: Op

Get and return machine state.

Request:

Name Type Description
-

Unused.

OkResponse:

Name Type Description

Dictionary of state.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
 
class MachineGetState(Op):
    """Get and return machine state.

    Attributes: Request:
        -: Unused.

    Attributes: OkResponse:
        : Dictionary of state.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")
            return OkResponse(
                payload=Payload(ctxt.machine.state()),
                refmsg=req,
            )
        except Exception as e:
            self.logger.error(f"{e}")
            return ErrorResponse(
                "machine not found",
                refmsg=req,
            )

MachineListConnections

Bases: Op

List machine connections.

Request:

Name Type Description
-

Unused.

OkResponse:

Name Type Description
names

List of connection ids.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
class MachineListConnections(Op):
    """List machine connections.

    Attributes: Request:
        -: Unused.

    Attributes: OkResponse:
        names: List of connection ids.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")
            connids = ctxt.machine.connmgr.list()
            return OkResponse(
                payload=Payload(
                    {
                        "names": list(connids),
                    }
                ),
                refmsg=req,
            )
        except Exception as e:
            self.logger.error(f"{e}")
            return ErrorResponse(
                f"{e}",
                refmsg=req,
            )

MachineListKernels

Bases: Op

List kernels by name registered with the machine.

Request:

Name Type Description
-

Unused.

OkResponse:

Name Type Description
names

List of kernel names.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
class MachineListKernels(Op):
    """List kernels by name registered with the machine.

    Attributes: Request:
        -: Unused.

    Attributes: OkResponse:
        names: List of kernel names.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")
            return OkResponse(
                payload=Payload(
                    {
                        "names": ctxt.machine.kernelmgr.list(),
                    }
                ),
                refmsg=req,
            )
        except Exception as e:
            self.logger.error(f"{e}")
            return ErrorResponse(
                f"{e}",
                refmsg=req,
            )

MachineListSessions

Bases: Op

List machine sessions.

Request:

Name Type Description
-

Unused.

OkResponse:

Name Type Description
names

List of session ids.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
class MachineListSessions(Op):
    """List machine sessions.

    Attributes: Request:
        -: Unused.

    Attributes: OkResponse:
        names: List of session ids.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")
            sessionids = ctxt.machine.sessmgr.list()
            return OkResponse(
                payload=Payload(
                    {
                        "names": list(sessionids),
                    },
                ),
                refmsg=req,
            )
        except Exception as e:
            self.logger.error(f"{e}")
            return ErrorResponse(
                f"{e}",
                refmsg=req,
            )

MachineShutdown

Bases: Op

Shut down the machine.

Request:

Name Type Description

Unused.

Response:

Name Type Description

None.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
class MachineShutdown(Op):
    """Shut down the machine.

    Attributes: Request:
        : Unused.

    Attributes: Response:
        : None.
    """

    def run(self, ctxt, req):
        """Shut down machine."""
        self.logger.debug("run")
        # TODO: can a reply be sent to ack? I think so!
        sys.exit(0)

run(ctxt, req)

Shut down machine.

Source code in penvm/src/kernels/penvm/kernels/core/server.py 
699
700
701
702
703
 
def run(self, ctxt, req):
    """Shut down machine."""
    self.logger.debug("run")
    # TODO: can a reply be sent to ack? I think so!
    sys.exit(0)

MachineSnapshot

Bases: Op

Snapshot machine state and return.

Snapshottable state taken from:

Request:

Name Type Description
-

Unused.

OkResponse:

Name Type Description
-

Dictionary of state.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
 
class MachineSnapshot(Op):
    """Snapshot machine state and return.

    Snapshottable state taken from:

    * Single: [penvm.kernels.core.server.MachineGetState][].
    * Single: [penvm.kernels.default.server.StoreGetState][].
    * For each: [penvm.kernels.core.server.ConnectionGetState][].
    * For each: [penvm.kernels.core.server.SessionGetState][].
    * For each: [penvm.kernels.core.server.KernelGetState][].

    Attributes: Request:
        -: Unused.

    Attributes: OkResponse:
        -: Dictionary of state.
    """

    def run(self, ctxt, req):
        try:
            # TODO: ensure this runs in a session with the required ops
            self.logger.debug("run")
            run_local = ctxt.session.proc.kernel.run_local
            payload = Payload()

            _req = Request()
            _resp = run_local("machine-get-state", ctxt, _req)
            self.logger.debug(f"{_resp=}")
            payload["machine"] = _resp.payload.dict(clean=True)

            _resp = run_local("store-get-state", ctxt, _req)
            self.logger.debug(f"{_resp=}")
            payload["store"] = _resp.payload.dict(clean=True)

            _req = Request()
            conns = payload["connections"] = {}
            for connid in ctxt.machine.connmgr.list():
                _req.payload["connection-id"] = connid
                _resp = run_local("connection-get-state", ctxt, _req)
                self.logger.debug(f"{_resp=}")
                conns[connid] = _resp.payload.dict(clean=True)

            _req = Request()
            sessions = payload["sessions"] = {}
            for sessid in ctxt.machine.sessmgr.list():
                _req.payload["session-id"] = sessid
                _resp = run_local("session-get-state", ctxt, _req)
                self.logger.debug(f"{_resp=}")
                sessions[sessid] = _resp.payload.dict(clean=True)

            _req = Request()
            kernels = payload["kernels"] = {}
            for name in ctxt.machine.kernelmgr.list():
                _req.payload["kernel"] = name
                _resp = run_local("kernel-get-state", ctxt, _req)
                self.logger.debug(f"{_resp=}")
                kernels[name] = _resp.payload.dict(clean=True)

            self.logger.debug(f"{payload=}")
            return OkResponse(
                payload=payload,
                refmsg=req,
            )
        except Exception as e:
            self.logger.error(f"{e}")
            return ErrorResponse(
                f"{e}",
                refmsg=req,
            )

MachineStepDebug

Bases: Op

Trigger step of debug.

Requires that debug is on.

See penvm.kernels.core.server.MachineEnableDebug and penvm.kernels.core.server.MachineDisableDebug.

Request:

Name Type Description
-

Unused.

OkResponse:

Name Type Description
-

None.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
class MachineStepDebug(Op):
    """Trigger step of debug.

    Requires that debug is on.

    See [penvm.kernels.core.server.MachineEnableDebug][] and
    [penvm.kernels.core.server.MachineDisableDebug][].

    Attributes: Request:
        -: Unused.

    Attributes: OkResponse:
        -: None.
    """

    def run(self, ctxt, req):
        try:
            ctxt.machine.step_debug()
        except Exception as e:
            self.logger.error(f"{e}")

SessionDropRequest

Bases: Op

Drop request from session IMQ.

Source code in penvm/src/kernels/penvm/kernels/core/server.py 
706
707
708
709
710
711
 
class SessionDropRequest(Op):
    """Drop request from session IMQ."""

    def run(self, ctxt, req):
        """Run operation."""
        pass

run(ctxt, req)

Run operation.

Source code in penvm/src/kernels/penvm/kernels/core/server.py 
709
710
711
 
def run(self, ctxt, req):
    """Run operation."""
    pass

SessionGetMessageState

Bases: Op

Get session message state (from message queue).

Request:

Name Type Description
session-id

Session id for session.
message-id

Message id of request held by session.
message-queue

One of "in" or "out".

Response:

Name Type Description
dict

Request state dictionary.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
 
class SessionGetMessageState(Op):
    """Get session message state (from message queue).

    Attributes: Request:
        session-id: Session id for session.
        message-id: Message id of request held by session.
        message-queue: One of "in" or "out".

    Attributes: Response:
        dict: Request state dictionary.
    """

    def run(self, ctxt, req):
        """Run operation."""

        try:
            self.logger.debug("run")
            sessionid = req.payload.get("session-id", req.header.get("session-id"))
            msgid = req.payload.get("message-id")
            msgqueue = req.payload.get("message-queue")

            sess = ctxt.machine.get_session(sessionid)

            if msgqueue == "in":
                mq = sess.imq
            elif msgqueue == "out":
                mq = sess.omq
            else:
                mq = None
            msg = mq.find(msgid)
            if msg == None:
                return ErrorResponse(
                    "message not found",
                    refmsg=req,
                )
            return OkResponse(payload=Payload(msg.state()))
        except Exception as e:
            self.logger.error(f"{e}")
            return ErrorResponse(
                "message not found",
                refmsg=req,
            )

run(ctxt, req)

Run operation.

Source code in penvm/src/kernels/penvm/kernels/core/server.py 
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
 
def run(self, ctxt, req):
    """Run operation."""

    try:
        self.logger.debug("run")
        sessionid = req.payload.get("session-id", req.header.get("session-id"))
        msgid = req.payload.get("message-id")
        msgqueue = req.payload.get("message-queue")

        sess = ctxt.machine.get_session(sessionid)

        if msgqueue == "in":
            mq = sess.imq
        elif msgqueue == "out":
            mq = sess.omq
        else:
            mq = None
        msg = mq.find(msgid)
        if msg == None:
            return ErrorResponse(
                "message not found",
                refmsg=req,
            )
        return OkResponse(payload=Payload(msg.state()))
    except Exception as e:
        self.logger.error(f"{e}")
        return ErrorResponse(
            "message not found",
            refmsg=req,
        )

SessionGetProcessorState

Bases: Op

Get session processor state.

Request:

Name Type Description
session-id

Session id for session.

Response:

Name Type Description
dict

Request state dictionary.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
class SessionGetProcessorState(Op):
    """Get session processor state.

    Attributes: Request:
        session-id: Session id for session.

    Attributes: Response:
        dict: Request state dictionary.
    """

    def run(self, ctxt, req):
        """Run operation."""

        try:
            self.logger.debug("run")

            sessionid = req.payload.get("session-id", req.header.get("session-id"))
            sess = ctxt.machine.get_session(sessionid)
            return OkResponse(payload=Payload(sess.proc.state()))
        except Exception as e:
            self.logger.error(f"{e}")
            return ErrorResponse(
                "session not found",
                refmsg=req,
            )

run(ctxt, req)

Run operation.

Source code in penvm/src/kernels/penvm/kernels/core/server.py 
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
def run(self, ctxt, req):
    """Run operation."""

    try:
        self.logger.debug("run")

        sessionid = req.payload.get("session-id", req.header.get("session-id"))
        sess = ctxt.machine.get_session(sessionid)
        return OkResponse(payload=Payload(sess.proc.state()))
    except Exception as e:
        self.logger.error(f"{e}")
        return ErrorResponse(
            "session not found",
            refmsg=req,
        )

SessionGetState

Bases: Op

Get session info.

Request:

Name Type Description
session-id

Session id for session.

OkResponse:

Name Type Description
-

Dictionary of state.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
class SessionGetState(Op):
    """Get session info.

    Attributes: Request:
        session-id: Session id for session.

    Attributes: OkResponse:
        -: Dictionary of state.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")

            sessionid = req.payload.get("session-id", req.header.get("session-id"))
            sess = ctxt.machine.get_session(sessionid)
            return OkResponse(
                payload=Payload(sess.state()),
                refmsg=req,
            )
        except Exception as e:
            self.logger.error(f"{e}")
            return ErrorResponse(
                "session not found",
                refmsg=req,
            )

SessionPinSession

Bases: Op

Pin session.

Request:

Name Type Description
session-id

Session id for session.

Response:

Name Type Description

None.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
class SessionPinSession(Op):
    """Pin session.

    Attributes: Request:
        session-id: Session id for session.

    Attributes: Response:
        : None.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")

            sessionid = req.payload.get("session-id", req.header.get("session-id"))
            sess = ctxt.machine.get_session(sessionid)
            sess.pin = True
        except Exception as e:
            self.logger.error(f"{e}")

SessionPopOmq

Bases: Op

Pop waiting message from session OMQ.

Request:

Name Type Description
count

Number of times to pop the OMQ. Blocking for values of >= 1. For 0, pop all values. Defaults to 1.
session-id

Override sessionid. Defaults to sessionid of session running this op.

Response:

Name Type Description

None.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
 
class SessionPopOmq(Op):
    """
    Pop waiting message from session OMQ.

    Attributes: Request:
        count: Number of times to pop the OMQ. Blocking for values
            of >= 1. For 0, pop all values. Defaults to 1.
        session-id: Override sessionid. Defaults to sessionid of
            session running this op.

    Attributes: Response:
        : None.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")
            sessionid = req.payload.get("session-id", req.header.get("session-id"))
            connectionid = req.header.get("connection-id")
            session = ctxt.machine.sessmgr.get(sessionid)

            count = req.payload.get("count", 1)
            if count >= 1:
                for _ in range(count):
                    resp = session.omq.pop()
                    resp.header["session-id"] = sessionid
                    resp.header["connection-id"] = connectionid
                    ctxt.machine.omq.put(resp)
            elif count == 0:
                while True:
                    resp = session.omq.pop(block=False)
                    if resp == None:
                        break

                    resp.header["session-id"] = sessionid
                    resp.header["connection-id"] = connectionid
                    ctxt.machine.omq.put(resp)
        except Exception as e:
            self.logger.error(f"{e}")

SessionSetMaxThreads

Bases: Op

Set max threads for session.

Source code in penvm/src/kernels/penvm/kernels/core/server.py 
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
class SessionSetMaxThreads(Op):
    """Set max threads for session."""

    def run(self, ctxt, req):
        try:
            sessionid = req.payload.get("session-id", req.header.get("session-id"))
            nthreads = req.payload.get("nthreads")

            if None in [nthreads, sessionid]:
                return
            if type(nthreads) != int:
                return

            session = ctxt.machine.get_session(sessionid)
            session.proc.set_max_threads(nthreads)
        except Exception as e:
            self.logger.error(f"{e}")

SessionTerminateRequest

Bases: Op

Terminate running request thread/task for session.

Request:

Name Type Description
reqid

Request id.
session-id

Session id for session processor.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
 
class SessionTerminateRequest(Op):
    """Terminate running request thread/task for session.

    Attributes: Request:
        reqid: Request id.
        session-id: Session id for session processor.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")

            reqid = req.payload.get("request-id")
            sessionid = req.payload.get("session-id", req.header.get("session-id"))
            self.logger.debug(f"^^^^^^^^ terminate payload {reqid=} {sessionid=}")

            if reqid == None:
                self.logger.warning("bad/missing request id")
                return

            if sessionid == None:
                self.logger.warning("bad/missing session id")
                return

            session = ctxt.machine.get_session(sessionid)
            if session == None:
                self.logger.warning(f"session not found for session id ({sessionid}")
                return

            session.proc.terminate_thread(reqid)
        except Exception as e:
            self.logger.error(f"{e}")

SessionUnpinSession

Bases: Op

Unpin session.

Request:

Name Type Description
session-id

Session id for session.

Response:

Name Type Description

None.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
 
class SessionUnpinSession(Op):
    """Unpin session.

    Attributes: Request:
        session-id: Session id for session.

    Attributes: Response:
        : None.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")

            sessionid = req.payload.get("session-id", req.header.get("session-id"))
            sess = ctxt.machine.get_session(sessionid)
            sess.pin = False
        except Exception as e:
            self.logger.error(f"{e}")

SessionUseKernel

Bases: Op

Set session to use an kernel.

Source code in penvm/src/kernels/penvm/kernels/core/server.py 
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
 
class SessionUseKernel(Op):
    """Set session to use an kernel."""

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")
            sessionid = req.payload.get("session-id", req.header.get("session-id"))
            kernel_name = req.payload.get("kernel")

            if None in [sessionid, kernel_name]:
                self.logger.warning(f"kernel and or sessionid not provided")
                return

            kernel = ctxt.machine.kernelmgr.get(kernel_name)
            if not kernel:
                self.logger.warning(f"kernel ({kernel_name}) not found")
                return

            sess = ctxt.machine.get_session(sessionid)
            sess.set_kernel(kernel)
            self.logger.state(f"session ({sessionid}) using kernel ({kernel_name})")
        except Exception as e:
            self.logger.error(f"{e}")

SessionUsekernel

Bases: Op

Update session to use a specific, previously registered kernel.

Source code in penvm/src/kernels/penvm/kernels/core/server.py 
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
 
class SessionUsekernel(Op):
    """Update session to use a specific, previously registered kernel."""

    def run(self, ctxt, req):
        try:
            sessionid = req.payload.get("session-id", req.header.get("session-id"))
            if sessionid == None:
                return
            session = ctxt.machine.get_session(sessionid)

            kernelname = req.payload.get("kernel")
            kernel = ctxt.machine.kernelmgr.get(kernelname)
            session.set_kernel(kernel)
        except Exception as e:
            self.logger.error(f"{e}")

Sleep

Bases: Op

Sleep.

Request:

Name Type Description
seconds

Number (int or float) of seconds to sleep.
check-interval

Number of seconds to between checks for an interrupt.
Source code in penvm/src/kernels/penvm/kernels/core/server.py 
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
class Sleep(Op):
    """Sleep.

    Attributes: Request:
        seconds: Number (int or float) of seconds to sleep.
        check-interval: Number of seconds to between checks for an
            interrupt.
    """

    def run(self, ctxt, req):
        try:
            self.logger.debug("run")

            seconds = req.payload.get("seconds")
            check_interval = req.payload.get("check-interval", 1)

            if type(seconds) not in [int, float] or seconds < 0:
                return
            if type(check_interval) not in [int, float] or seconds < 0:
                return

            while seconds > 0:
                time.sleep(min(seconds, check_interval))
                seconds -= check_interval
        except ThreadInterrupt as e:
            raise
        except Exception as e:
            self.logger.error(f"{e}")
            self.logger.warning(f"bad/missing sleep time ({seconds})")
You are on penvm.dev