Mercurial > hg > Members > aka > jupyter_CbC_kernel
annotate jupyter_c_kernel/kernel.py @ 36:8acbab5a9f21
Remove stream buffering on stdout & stderr
| author | Louis 'Kureuil' Person <louis.person@epitech.eu> |
|---|---|
| date | Sat, 30 Apr 2016 23:48:19 +0200 |
| parents | e05900c7967e |
| children | aac47bc07111 |
| rev | line source |
|---|---|
| 34 | 1 from queue import Queue, Empty |
| 33 | 2 from threading import Thread |
| 3 | |
| 0 | 4 from ipykernel.kernelbase import Kernel |
| 5 import subprocess | |
| 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 |
|
36
8acbab5a9f21
Remove stream buffering on stdout & stderr
Louis 'Kureuil' Person <louis.person@epitech.eu>
parents:
35
diff
changeset
|
8 import os.path as path |
| 34 | 9 |
| 10 class JupyterSubprocess(subprocess.Popen): | |
| 11 def __init__(self, cmd, write_to_stdout, write_to_stderr): | |
| 12 self._write_to_stdout = write_to_stdout | |
| 13 self._write_to_stderr = write_to_stderr | |
| 14 | |
| 15 super().__init__(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE) | |
| 16 | |
| 17 self._stdout_queue = Queue() | |
| 18 self._stdout_thread = Thread(target=JupyterSubprocess._enqueue_output, args=(self.stdout, self._stdout_queue)) | |
| 19 self._stdout_thread.daemon = True | |
| 20 self._stdout_thread.start() | |
| 21 | |
| 22 self._stderr_queue = Queue() | |
| 23 self._stderr_thread = Thread(target=JupyterSubprocess._enqueue_output, args=(self.stderr, self._stderr_queue)) | |
| 24 self._stderr_thread.daemon = True | |
| 25 self._stderr_thread.start() | |
| 26 | |
| 27 @staticmethod | |
| 28 def _enqueue_output(contents, queue): | |
| 29 for line in iter(contents.readline, b''): | |
| 30 queue.put(line) | |
| 31 contents.close() | |
| 32 | |
| 35 | 33 def write_contents(self): |
| 34 | 34 try: |
| 35 stdout_contents = self._stdout_queue.get_nowait() | |
| 36 except Empty: | |
| 35 | 37 pass |
| 34 | 38 else: |
| 39 self._write_to_stdout(stdout_contents) | |
| 40 try: | |
| 41 stderr_contents = self._stderr_queue.get_nowait() | |
| 42 except Empty: | |
| 35 | 43 pass |
| 34 | 44 else: |
| 45 self._write_to_stderr(stderr_contents) | |
| 0 | 46 |
| 47 | |
| 48 class CKernel(Kernel): | |
| 20 | 49 implementation = 'jupyter_c_kernel' |
| 0 | 50 implementation_version = '1.0' |
| 51 language = 'c' | |
| 52 language_version = 'C11' | |
|
2
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
53 language_info = {'name': 'c', |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
54 'mimetype': 'text/plain', |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
55 'file_extension': 'c'} |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
56 banner = "C kernel.\n" \ |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
57 "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
|
58 |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
59 def __init__(self, *args, **kwargs): |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
60 super(CKernel, self).__init__(*args, **kwargs) |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
61 self.files = [] |
|
36
8acbab5a9f21
Remove stream buffering on stdout & stderr
Louis 'Kureuil' Person <louis.person@epitech.eu>
parents:
35
diff
changeset
|
62 mastertemp = tempfile.mkstemp(suffix='.out') |
|
8acbab5a9f21
Remove stream buffering on stdout & stderr
Louis 'Kureuil' Person <louis.person@epitech.eu>
parents:
35
diff
changeset
|
63 os.close(mastertemp[0]) |
|
8acbab5a9f21
Remove stream buffering on stdout & stderr
Louis 'Kureuil' Person <louis.person@epitech.eu>
parents:
35
diff
changeset
|
64 self.master_path = mastertemp[1] |
|
8acbab5a9f21
Remove stream buffering on stdout & stderr
Louis 'Kureuil' Person <louis.person@epitech.eu>
parents:
35
diff
changeset
|
65 filepath = path.join(path.dirname(path.realpath(__file__)), '..', 'resources', 'master.c') |
|
8acbab5a9f21
Remove stream buffering on stdout & stderr
Louis 'Kureuil' Person <louis.person@epitech.eu>
parents:
35
diff
changeset
|
66 subprocess.call(['gcc', filepath, '-std=c11', '-fPIC', '-shared', '-rdynamic', '-o', self.master_path]) |
|
2
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
67 |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
68 def cleanup_files(self): |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
69 """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
|
70 for file in self.files: |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
71 os.remove(file) |
|
36
8acbab5a9f21
Remove stream buffering on stdout & stderr
Louis 'Kureuil' Person <louis.person@epitech.eu>
parents:
35
diff
changeset
|
72 os.remove(self.master_path) |
| 0 | 73 |
|
2
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
74 def new_temp_file(self, **kwargs): |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
75 """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
|
76 # 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
|
77 kwargs['delete'] = False |
| 9 | 78 kwargs['mode'] = 'w' |
|
2
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
79 file = tempfile.NamedTemporaryFile(**kwargs) |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
80 self.files.append(file.name) |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
81 return file |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
82 |
| 34 | 83 def _write_to_stdout(self, contents): |
| 84 self.send_response(self.iopub_socket, 'stream', {'name': 'stdout', 'text': contents}) | |
| 33 | 85 |
| 34 | 86 def _write_to_stderr(self, contents): |
| 87 self.send_response(self.iopub_socket, 'stream', {'name': 'stderr', 'text': contents}) | |
| 33 | 88 |
| 34 | 89 def create_jupyter_subprocess(self, cmd): |
| 90 return JupyterSubprocess(cmd, | |
| 91 lambda contents: self._write_to_stdout(contents.decode()), | |
| 92 lambda contents: self._write_to_stderr(contents.decode())) | |
|
2
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
93 |
| 34 | 94 def compile_with_gcc(self, source_filename, binary_filename): |
|
36
8acbab5a9f21
Remove stream buffering on stdout & stderr
Louis 'Kureuil' Person <louis.person@epitech.eu>
parents:
35
diff
changeset
|
95 args = ['gcc', source_filename, '-std=c11', '-fPIC', '-shared', '-rdynamic', '-o', binary_filename] |
| 34 | 96 return self.create_jupyter_subprocess(args) |
| 0 | 97 |
| 98 def do_execute(self, code, silent, store_history=True, | |
| 99 user_expressions=None, allow_stdin=False): | |
|
2
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
100 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
|
101 source_file.write(code) |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
102 source_file.flush() |
|
b46b2e5b6c08
Improve error management by separating stdout and stderr
Brendan Rius <brendan@omixy.com>
parents:
0
diff
changeset
|
103 with self.new_temp_file(suffix='.out') as binary_file: |
| 34 | 104 p = self.compile_with_gcc(source_file.name, binary_file.name) |
| 33 | 105 while p.poll() is None: |
| 35 | 106 p.write_contents() |
| 107 p.write_contents() | |
| 33 | 108 if p.returncode != 0: # Compilation failed |
| 34 | 109 self._write_to_stderr( |
| 110 "[C kernel] GCC exited with code {}, the executable will not be executed".format( | |
| 111 p.returncode)) | |
| 33 | 112 return {'status': 'ok', 'execution_count': self.execution_count, 'payload': [], |
| 113 'user_expressions': {}} | |
| 0 | 114 |
|
36
8acbab5a9f21
Remove stream buffering on stdout & stderr
Louis 'Kureuil' Person <louis.person@epitech.eu>
parents:
35
diff
changeset
|
115 p = self.create_jupyter_subprocess([self.master_path, binary_file.name]) |
| 33 | 116 while p.poll() is None: |
| 35 | 117 p.write_contents() |
| 118 p.write_contents() | |
| 33 | 119 |
| 120 if p.returncode != 0: | |
| 34 | 121 self._write_to_stderr("[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
|
122 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
|
123 |
|
aa54c85303b6
Remove temporary files when shutting down the kernel
Brendan Rius <brendan@omixy.com>
parents:
4
diff
changeset
|
124 def do_shutdown(self, restart): |
|
aa54c85303b6
Remove temporary files when shutting down the kernel
Brendan Rius <brendan@omixy.com>
parents:
4
diff
changeset
|
125 """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
|
126 self.cleanup_files() |