annotate jupyter_c_kernel/kernel.py @ 33:f842dabb75d7

wip
author Brendan Rius <brendan@omixy.com>
date Sat, 30 Apr 2016 21:45:41 +0100
parents ee3ac764f5f0
children b5bc8483ac3e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
33
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
1 from threading import Thread
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
2
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
3 import time
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
4 from ipykernel.kernelbase import Kernel
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
5 import subprocess
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
6 import tempfile
2
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
7 import os
33
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
8 from Queue import Queue, Empty
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
9
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
10
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
11 class CKernel(Kernel):
20
696cc0775abb Change package name
Brendan Rius <brendan@omixy.com>
parents: 9
diff changeset
12 implementation = 'jupyter_c_kernel'
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
13 implementation_version = '1.0'
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
14 language = 'c'
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
15 language_version = 'C11'
2
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
16 language_info = {'name': 'c',
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
17 'mimetype': 'text/plain',
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
18 'file_extension': 'c'}
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
19 banner = "C kernel.\n" \
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
20 "Uses gcc, compiles in C11, and creates source code files and executables in temporary folder.\n"
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
21
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
22 def __init__(self, *args, **kwargs):
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
23 super(CKernel, self).__init__(*args, **kwargs)
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
24 self.files = []
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
25
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
26 def cleanup_files(self):
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
27 """Remove all the temporary files created by the kernel"""
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
28 for file in self.files:
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
29 os.remove(file)
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
30
2
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
31 def new_temp_file(self, **kwargs):
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
32 """Create a new temp file to be deleted when the kernel shuts down"""
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
33 # We don't want the file to be deleted when closed, but only when the kernel stops
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
34 kwargs['delete'] = False
9
101e99452042 Dockerized project :)
Brendan Rius <brendan@omixy.com>
parents: 7
diff changeset
35 kwargs['mode'] = 'w'
2
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
36 file = tempfile.NamedTemporaryFile(**kwargs)
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
37 self.files.append(file.name)
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
38 return file
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
39
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
40 @staticmethod
33
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
41 def launch_process(cmd):
2
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
42 """Execute a command and returns the return code, stdout and stderr"""
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
43 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
33
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
44
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
45 stdout_queue = Queue()
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
46 stdout_thread = Thread(target=CKernel.enqueue_output, args=(p.stdout, stdout_queue))
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
47 stdout_thread.daemon = True
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
48 stdout_thread.start()
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
49
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
50 stderr_queue = Queue()
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
51 stderr_thread = Thread(target=CKernel.enqueue_output, args=(p.stderr, stderr_queue))
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
52 stderr_thread.daemon = True
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
53 stderr_thread.start()
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
54
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
55 return p, stdout_queue, stderr_queue
2
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
56
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
57 @staticmethod
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
58 def compile_with_gcc(source_filename, binary_filename):
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
59 args = ['gcc', source_filename, '-std=c11', '-o', binary_filename]
33
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
60 return CKernel.launch_process(args)
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
61
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
62 @staticmethod
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
63 def enqueue_output(out, queue):
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
64 for line in iter(out.readline, b''):
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
65 queue.put(line)
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
66 out.close()
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
67
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
68 def do_execute(self, code, silent, store_history=True,
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
69 user_expressions=None, allow_stdin=False):
33
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
70 a = raw_input()
2
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
71 with self.new_temp_file(suffix='.c') as source_file:
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
72 source_file.write(code)
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
73 source_file.flush()
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
74 with self.new_temp_file(suffix='.out') as binary_file:
33
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
75 p, stdout_queue, stderr_queue = self.compile_with_gcc(source_file.name, binary_file.name)
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
76 while p.poll() is None:
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
77 self.log.error("Waiting for compilation to end")
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
78 try:
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
79 stdout = stdout_queue.get_nowait()
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
80 except Empty:
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
81 self.log.error("stdout empty")
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
82 else:
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
83 self.log.error("stdout contains: {}".format(stdout))
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
84 self.send_response(self.iopub_socket, 'stream', {'name': 'stdout', 'text': stdout})
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
85 try:
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
86 stderr = stderr_queue.get_nowait()
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
87 except Empty:
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
88 self.log.error("stderr empty")
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
89 else:
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
90 self.log.error("stderr contains: {}".format(stderr))
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
91 self.send_response(self.iopub_socket, 'stream', {'name': 'stderr', 'text': stderr})
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
92
33
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
93 if p.returncode != 0: # Compilation failed
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
94 stream_content = {'name': 'stderr',
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
95 'text': "[C kernel] GCC exited with code {}, the executable will not be executed".format(
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
96 p.returncode)}
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
97 self.send_response(self.iopub_socket, 'stream', stream_content)
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
98 return {'status': 'ok', 'execution_count': self.execution_count, 'payload': [],
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
99 'user_expressions': {}}
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
100
33
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
101 p, stdout_queue, stderr_queue = CKernel.launch_process([binary_file.name])
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
102 while p.poll() is None:
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
103 self.log.error("Waiting for execution to end")
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
104 try:
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
105 stdout = stdout_queue.get_nowait()
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
106 except Empty:
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
107 self.log.error("stdout empty")
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
108 else:
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
109 self.log.error("stdout contains: {}".format(stdout))
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
110 self.send_response(self.iopub_socket, 'stream', {'name': 'stdout', 'text': stdout})
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
111 try:
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
112 stderr = stderr_queue.get_nowait()
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
113 except Empty:
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
114 self.log.error("stderr empty")
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
115 else:
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
116 self.log.error("stderr contains: {}".format(stderr))
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
117 self.send_response(self.iopub_socket, 'stream', {'name': 'stderr', 'text': stderr})
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
118
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
119 if p.returncode != 0:
Brendan Rius <brendan@omixy.com>
parents: 29
diff changeset
120 stderr_queue += "[C kernel] Executable exited with code {}".format(p.returncode)
2
b46b2e5b6c08 Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
121 return {'status': 'ok', 'execution_count': self.execution_count, 'payload': [], 'user_expressions': {}}
7
aa54c85303b6 Remove temporary files when shutting down the kernel
Brendan Rius <brendan@omixy.com>
parents: 4
diff changeset
122
aa54c85303b6 Remove temporary files when shutting down the kernel
Brendan Rius <brendan@omixy.com>
parents: 4
diff changeset
123 def do_shutdown(self, restart):
aa54c85303b6 Remove temporary files when shutting down the kernel
Brendan Rius <brendan@omixy.com>
parents: 4
diff changeset
124 """Cleanup the created source code files and executables when shutting down the kernel"""
aa54c85303b6 Remove temporary files when shutting down the kernel
Brendan Rius <brendan@omixy.com>
parents: 4
diff changeset
125 self.cleanup_files()