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 |
|
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 |
|
echo(d)
See penvm.kernels.core.server.Echo.
Source code in penvm/src/kernels/penvm/kernels/core/client.py
42 43 44 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
machine_disable_debug()
See penvm.kernels.core.server.MachineDisableDebug.
Source code in penvm/src/kernels/penvm/kernels/core/client.py
114 115 116 117 |
|
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 |
|
machine_enable_debug()
See penvm.kernels.core.server.MachineEnableDebug.
Source code in penvm/src/kernels/penvm/kernels/core/client.py
126 127 128 129 |
|
machine_get_features()
See penvm.kernels.core.server.MachineGetFeatures.
Source code in penvm/src/kernels/penvm/kernels/core/client.py
131 132 133 |
|
machine_get_state()
See penvm.kernels.core.server.MachineGetState.
Source code in penvm/src/kernels/penvm/kernels/core/client.py
135 136 137 |
|
machine_list_kernels()
See penvm.kernels.core.server.MachineListKernels.
Source code in penvm/src/kernels/penvm/kernels/core/client.py
139 140 141 |
|
machine_list_sessions()
See penvm.kernels.core.server.MachineListSessions.
Source code in penvm/src/kernels/penvm/kernels/core/client.py
143 144 145 |
|
machine_shutdown()
See penvm.kernels.core.server.MachineShutdown.
Source code in penvm/src/kernels/penvm/kernels/core/client.py
147 148 149 |
|
machine_snapshot()
See penvm.kernels.core.server.MachineSnapshot.
Source code in penvm/src/kernels/penvm/kernels/core/client.py
151 152 153 |
|
machine_step_debug()
See penvm.kernels.core.server.MachineStepDebug.
Source code in penvm/src/kernels/penvm/kernels/core/client.py
155 156 157 158 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
run(ctxt, req)
Shut down machine.
Source code in penvm/src/kernels/penvm/kernels/core/server.py
699 700 701 702 703 |
|
MachineSnapshot
Bases: 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.
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 |
|
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 |
|
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 |
|
run(ctxt, req)
Run operation.
Source code in penvm/src/kernels/penvm/kernels/core/server.py
709 710 711 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|