-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathscimax-org-babel-ipython.el
1300 lines (1118 loc) · 49.8 KB
/
scimax-org-babel-ipython.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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
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
282
283
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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
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
557
558
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
586
587
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
616
617
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
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
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
756
757
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
783
784
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
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
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
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
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
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; scimax-org-babel-ipython.el --- Scimax enhancements to ob-ipython
;;; Commentary:
;;
;; This library expands the ob-ipython library a lot. Many functions are just
;; redefined in here, and many new functions are defined. Most notably this
;; provides asynchronous execution, inspection and completion. It also provides
;; better support for inline figures and the rich output of jupyter.
;;
;; Known limitations:
;; 1. You should not use session names that have a - in them.
;;
;; 2. Sometimes you have to `nuke-ipython' to restart.
;;
;; Customization variables
;;
;; If `org-babel-async-ipython' is non-nil the src blocks will be run
;; asynchrounously allowing you to work in emacs while the code runs. This mode
;; will create names for each code-block if they don't already have a name,
;; defaulting to a human readable name. The number of words in the name is
;; defined by `org-babel-ipython-name-length'. The function used to generate the
;; name is defined in `org-babel-ipython-name-generator'.
;;
;; I prefer a single kernel per org-buffer to prevent cross-talk between them.
;; You can turn this off using the variable `ob-ipython-buffer-unique-kernel'.
;;
;; Set `org-babel-ipython-debug ' to non-nil to get better debugging information
;; in the buffer *ob-ipython-log*.
;; Set `ob-ipython-number-on-exception' to non-nil to get line-number overlays
;; in src blocks when exceptions occur.
;;
;; Convenience commands:
;;
;; `org-babel-insert-block' will insert a new src block above the current point,
;; or below it with a prefix arg.
;;
;; `org-babel-split-src-block' will split the current block leaving point in the
;; upper block, or with a prefix arg in the lower block.
;;
;; `org-babel-execute-to-point' will execute all blocks up to the current point.
;; See also `org-babel-execute-ipython-buffer-to-point-async'
;; `org-babel-execute-ipython-buffer-async'
;; `ob-ipython-inspect' will open a buffer with documentation about the thing at point.
;;
;; `ob-ipython-signature-function' will show a message in the minibuffer about
;; the signature function.
;;
;; You should get completion of python code in the org buffer if
;; `org-babel-ipython-completion ' is set to non-nil.
;;
;; While a cell is running or queued, there will be a link in the results
;; section that you can click on to halt the execution or remove the cell from
;; the queue.
;;
;; To clear the queue use M-x `org-babel-async-ipython-clear-queue'.
;;
;; If you have difficulties try running `debug-ipython'.
(require 'ob-ipython)
(defcustom scimax-ipython-command "jupyter"
"Command to launch the jupyter kernel."
:group 'ob-ipython)
(defcustom ob-ipython-buffer-unique-kernel t
"If non-nil use a unique kernel for each buffer."
:group 'ob-ipython)
(defcustom org-babel-ipython-debug nil
"If non-nil, log messages."
:group 'ob-ipython)
(defcustom ob-ipython-number-on-exception t
"If non-nil add line numbers to src-blocks when there is an exception."
:group 'ob-ipython)
(defcustom org-babel-async-ipython t
"If non-nil run ipython asynchronously."
:group 'ob-ipython)
(defcustom ob-ipython-exception-results t
"If non-nil put the contents of the traceback buffer as results.")
(defcustom org-babel-ipython-completion t
"If non-nil enable completion in org-mode."
:group 'ob-ipython)
(defcustom org-babel-ipython-name-length 4
"Number of words to use in generating a name."
:group 'ob-ipython)
(defcustom org-babel-ipython-name-generator 'generate-human-readable-name
"Function to generate a name for a src block.
The default is the human-readable name generator
`generate-human-readable-name'. The function should generate a
name that is unique within the document. You might also like
`org-id-uuid'."
:group 'ob-ipython)
(defcustom org-babel-ipython-inline-image-dir "ipython-inline-images"
"Directory to store ipython generated images."
:group 'ob-ipython)
(make-variable-buffer-local 'org-babel-ipython-inline-image-dir)
;;; Code:
(add-to-list 'org-structure-template-alist
'("ip" "#+BEGIN_SRC ipython\n?\n#+END_SRC"
"<src lang=\"python\">\n?\n</src>"))
(setq org-babel-default-header-args:ipython
'((:results . "output replace drawer")
(:session . "ipython")
(:exports . "both")
(:cache . "no")
(:noweb . "no")
(:hlines . "no")
(:tangle . "no")
(:eval . "never-export")))
(defun scimax-install-ipython-lexer ()
"Install the IPython lexer for Pygments.
You need this to get syntax highlighting."
(interactive)
(unless (= 0
(shell-command
"python -c \"import pygments.lexers; pygments.lexers.get_lexer_by_name('ipython')\""))
(shell-command "pip install git+git://github.com/sanguineturtle/pygments-ipython-console")))
;;* Logging
(defun ob-ipython-log (msg &rest args)
(when org-babel-ipython-debug
(with-current-buffer (get-buffer-create "*ob-ipython-log*")
(org-mode)
(insert (format "ob-ipython: \n%s\n\n"
(apply 'format msg args))))))
;;* Commands like the jupyter notebook has
(defun org-babel-insert-block (&optional below)
"Insert a src block above the current point.
With prefix arg BELOW, insert it below the current point."
(interactive "P")
(cond
((and (org-in-src-block-p) below)
;; go to end, and insert block
(let* ((src (org-element-context))
(start (org-element-property :begin src))
(end (org-element-property :end src))
location)
(goto-char start)
(setq location (org-babel-where-is-src-block-result nil nil))
(if (not location)
(goto-char end)
(goto-char location)
(goto-char (org-element-property :end (org-element-context))))
(insert "\n#+BEGIN_SRC ipython
#+END_SRC\n\n")
(forward-line -3)))
((org-in-src-block-p)
;; goto begining and insert
(goto-char (org-element-property :begin (org-element-context)))
(insert "\n#+BEGIN_SRC ipython
#+END_SRC\n\n")
(forward-line -3))
(t
(beginning-of-line)
(insert "\n#+BEGIN_SRC ipython
#+END_SRC\n")
(forward-line -2))))
(defun org-babel-split-src-block (&optional below)
"Split the current src block.
With a prefix BELOW move point to lower block."
(interactive "P")
(let* ((el (org-element-context))
(language (org-element-property :language el))
(parameters (org-element-property :parameters el)))
(beginning-of-line)
(insert (format "#+END_SRC
#+BEGIN_SRC %s %s\n" language (or parameters "")))
(beginning-of-line)
(when (not below)
(org-babel-previous-src-block))))
(define-key org-mode-map (kbd "H--") #'org-babel-split-src-block)
;;* Enhancements to ob-ipython
;; overwrites the ob-python function to get jupyter instead of hard-coded
;; ipython.
(defun ob-ipython--kernel-repl-cmd (name)
(list scimax-ipython-command "console" "--existing" (format "emacs-%s.json" name)))
;; This allows unicode chars to be sent to the kernel
;; https://github.com/jkitchin/scimax/issues/67
(defun ob-ipython--execute-request (code name)
(let ((url-request-data (encode-coding-string code 'utf-8))
(url-request-method "POST"))
(with-current-buffer (url-retrieve-synchronously
(format "http://%s:%d/execute/%s"
ob-ipython-driver-hostname
ob-ipython-driver-port
name))
(if (>= (url-http-parse-response) 400)
(ob-ipython--dump-error (buffer-string))
(goto-char url-http-end-of-headers)
(let ((json-array-type 'list))
(json-read))))))
(defun ob-ipython-inline-image (b64-string)
"Write the B64-STRING to a file.
Returns an org-link to the file."
(let* ((f (md5 b64-string))
(d org-babel-ipython-inline-image-dir)
(tfile (concat d "/ob-ipython-" f ".png"))
(link (format "[[file:%s]]" tfile)))
(unless (file-directory-p d)
(make-directory d))
(ob-ipython--write-base64-string tfile b64-string)
link))
(defun ob-ipython--format-result (result result-type)
"Format a RESULT from an ipython cell.
Return RESULT-TYPE if specified. This comes from a header argument :ob-ipython-results"
(cl-flet ((format-result (type value)
(case type
('text/org (concat value "\n"))
('text/plain (concat value "\n"))
('text/html (format
"#+BEGIN_EXPORT HTML\n%s\n#+END_EXPORT\n"
value))
('text/latex (concat value "\n"))
('image/png (concat (ob-ipython-inline-image value) "\n"))))
(select-result-type (type result)
(if type
(--filter (eq (car it) (intern type)) result)
result)))
(->> result
(select-result-type result-type)
(--map (format-result (car it) (cdr it)))
(apply #'concat "\n"))))
;;* A better synchronous execute function
(defun ob-ipython-jump (buffer src-name N)
"Jump to BUFFER then the src-block with SRC-NAME to line N."
(pop-to-buffer buffer)
(org-babel-goto-named-src-block src-name)
(while (not (looking-at "#\\+BEGIN"))
(forward-line))
(forward-line N))
;; modified function to get better error feedback
(defun ob-ipython--create-traceback-buffer (traceback)
"Creates a traceback error when an exception occurs.
Sets up a local key to jump back to the Exception in the traceback buffer."
(let* ((src (org-element-context))
(buf (get-buffer-create "*ob-ipython-traceback*"))
(curwin (current-window-configuration))
(exc-buffer *org-babel-ipython-exception-buffer*)
N pos syntax-error-p)
(with-current-buffer buf
(special-mode)
(let ((inhibit-read-only t))
(erase-buffer)
(-each traceback
(lambda (line) (insert (format "%s\n" line))))
(ansi-color-apply-on-region (point-min) (point-max)))
(goto-char (point-min))
;; try to find a regular exception line number
(if (re-search-forward "-+> \\([0-9]+\\)" nil t)
(setq N (string-to-number (match-string 1)))
(setq N 0))
;; We may have had a SyntaxError. Let's check.
(goto-char (point-min))
(when (re-search-forward "SyntaxError:" nil t)
(setq syntax-error-p t)
(goto-char (point-min))
;; get the line number
(when (re-search-forward "File.*, line \\([0-9]+\\)" nil t)
(setq N (string-to-number (match-string 1)))
(when (re-search-forward "\\( +\\)^" nil t)
;; move point to be on the error
(backward-char)
;; It appears the line is indented 4 spaces, so we cop that off
(setq pos (- (length (match-string 1)) 4))))
(use-local-map (copy-keymap special-mode-map))
(setq header-line-format "Press j to jump to src block. q to bury this buffer. i to insert the traceback as results in the src block.")
(local-set-key "j" `(lambda ()
"Jump to the line in the src block that caused the exception."
(interactive)
(if (not org-babel-async-ipython)
(goto-char ,(org-element-property :begin src))
;; on an async cell
(ob-ipython-jump
*org-babel-ipython-exception-buffer*
(with-current-buffer *org-babel-ipython-exception-buffer*
(cdr (ob-ipython-get-running)))
,N))
(when ,syntax-error-p (forward-char ,pos))
(org-babel-async-ipython-clear-queue)
(when ob-ipython-number-on-exception
(number-line-src-block))))
(local-set-key "q" `(lambda ()
"Bury traceback buffer and jump to the line in the src block that caused the exception."
(interactive)
(bury-buffer)
;; (set-window-configuration ,curwin)
(if (not org-babel-async-ipython)
(goto-char ,(org-element-property :begin src))
;; on an async cell
(ob-ipython-jump
*org-babel-ipython-exception-buffer*
(with-current-buffer *org-babel-ipython-exception-buffer*
(cdr (ob-ipython-get-running)))
,N))
(when ,syntax-error-p (forward-char ,pos))
(org-babel-async-ipython-clear-queue)
(when ob-ipython-number-on-exception
(number-line-src-block))))
(local-set-key "i" `(lambda ()
"Insert the traceback as results in the src block that caused the exception."
(interactive)
(if (not org-babel-async-ipython)
(goto-char ,(org-element-property :begin src))
;; on an async cell
(let ((contents (buffer-string))
(buf (pop-to-buffer *org-babel-ipython-exception-buffer*))
(cell (ob-ipython-get-running)))
(org-babel-async-ipython-clear-queue)
(ob-ipython-jump buf (cdr cell) 1)
;; We linkify the exception lines
(org-babel-insert-result
(with-temp-buffer
(insert contents)
(goto-char (point-min))
(while (re-search-forward "-+> \\([0-9]+\\).*" nil t)
(replace-match
(format "[[elisp:(ob-ipython-jump \"%s\" \"%s\" %s)][%s]]"
(car cell)
(cdr cell)
(match-string 1)
(match-string 0))))
(buffer-string))
(assoc :result-params
(third (org-babel-get-src-block-info)))))))))
;; insert results or pop to the traceback buffer
(if ob-ipython-exception-results
;; Here we are inserting the traceback in the org-buffer
(let ((contents (with-current-buffer buf (buffer-string)))
(buf (pop-to-buffer *org-babel-ipython-exception-buffer*))
(cell (ob-ipython-get-running))
line pos)
(setq header-line-format (format "%s had an exception." (cdr cell)))
(ob-ipython-jump buf (cdr cell) 1)
(org-babel-async-ipython-clear-queue)
(org-babel-insert-result
(with-temp-buffer
(insert contents)
(goto-char (point-min))
(while (re-search-forward "-+> \\([0-9]+\\).*" nil t)
(replace-match
(format "[[elisp:(ob-ipython-jump \"%s\" \"%s\" %s)][%s]]"
(car cell)
(cdr cell)
(match-string 1)
(match-string 0))))
;; linkify a SyntaxError
(goto-char (point-min))
(when (re-search-forward "SyntaxError:" nil t)
(goto-char (point-min))
;; get the line number
(when (re-search-forward "File.*, line \\([0-9]+\\)" nil t)
(setq line (match-string 1))
(when (re-search-forward "\\( +\\)^" nil t)
;; It appears the line is indented 4 spaces, so we cop that off
(setq pos (- (length (match-string 1)) 4)))
;; I think we can just link the first line. I tried the code
;; line, but sometimes it has a bracket in it which can break
;; the link syntax.
(goto-char (point-min))
(setf (buffer-substring (line-beginning-position) (line-end-position))
(format
"[[elisp:(progn (ob-ipython-jump \"%s\" \"%s\" %s)(forward-char %s))][%s]]"
(car cell)
(cdr cell)
line
pos
(buffer-substring (line-beginning-position) (line-end-position))))))
(buffer-string))
;; these are the headers for the results of the block
(assoc :result-params
(third (org-babel-get-src-block-info)))))
;; We are not capturing results so this makes the traceback the current
;; buffer
(ob-ipython-log "Popping to %s" buf)
(pop-to-buffer buf)
(setq header-line-format (format "%s had an exception." (cdr (ob-ipython-get-running))))))))
(defun org-babel-execute:ipython (body params)
"Execute a block of IPython code with Babel.
This function is called by `org-babel-execute-src-block'."
(let* ((file (cdr (assoc :file params)))
(session (cdr (assoc :session params)))
(async (cdr (assoc :async params)))
(result-type (cdr (assoc :result-type params)))
results)
(org-babel-ipython-initiate-session session params)
;; Check the current results for inline images and delete the files.
(let ((location (org-babel-where-is-src-block-result))
current-results)
(when location
(save-excursion
(goto-char location)
(when (looking-at (concat org-babel-result-regexp ".*$"))
(setq results (buffer-substring-no-properties
location
(save-excursion
(forward-line 1) (org-babel-result-end)))))))
(with-temp-buffer
(insert (or results ""))
(goto-char (point-min))
(while (re-search-forward
"\\[\\[file:\\(ipython-inline-images/ob-ipython-.*?\\)\\]\\]" nil t)
(let ((f (match-string 1)))
(when (file-exists-p f)
(delete-file f))))))
(-when-let (ret (ob-ipython--eval
(ob-ipython--execute-request
(org-babel-expand-body:generic
(encode-coding-string body 'utf-8)
params (org-babel-variable-assignments:python params))
(ob-ipython--normalize-session session))))
(let ((result (cdr (assoc :result ret)))
(output (cdr (assoc :output ret))))
(if (eq result-type 'output)
(concat
output
(ob-ipython--format-result
result
(cdr (assoc :ob-ipython-results params))))
;; The result here is a value. We should still get inline images though.
(ob-ipython--create-stdout-buffer output)
(ob-ipython--format-result
result (cdr (assoc :ob-ipython-results params))))))))
(defun org-babel-execute-to-point ()
"Execute all the blocks up to and including the one point is on."
(interactive)
(let ((p (point)))
(save-excursion
(goto-char (point-min))
(while (and (org-babel-next-src-block) (< (point) p))
(org-babel-execute-src-block)))))
;;** fixing ob-ipython-inspect
(defun ob-ipython--inspect-request (code &optional pos detail)
"This function is used to inspect code at a position.
This can provide information about the type, etc."
(let ((url-request-data (json-encode `((code . ,code)
(pos . ,(or pos (length code)))
(detail . ,(or detail 0)))))
(url-request-method "POST"))
(with-current-buffer (url-retrieve-synchronously
(format "http://%s:%d/inspect/%s"
ob-ipython-driver-hostname
ob-ipython-driver-port
(org-babel-get-session)))
(if (>= (url-http-parse-response) 400)
(ob-ipython--dump-error (buffer-string))
(goto-char url-http-end-of-headers)
(let ((json-array-type 'list))
(json-read))))))
;; I edited this to get the position relative to the beginning of the block
(defun ob-ipython--inspect (buffer pos)
"Get the request result for an inspect of POS in BUFFER."
(let* ((code (with-current-buffer buffer
(buffer-substring-no-properties (point-min) (point-max))))
(resp (ob-ipython--inspect-request code pos 0))
(status (ob-ipython--extract-status resp)))
(if (string= "ok" status)
(ob-ipython--extract-result resp)
(error (ob-ipython--extract-error resp)))))
;; I added the narrow to block. It seems to work ok in the special edit window, and it also seems to work ok if we just narrow the block temporarily.
(defun ob-ipython-inspect (buffer pos)
"Ask a kernel for documentation on the thing at POS in BUFFER."
(interactive (list (current-buffer) (point)))
(save-restriction
;; Note you may be in a special edit buffer in which case it is not
;; necessary to narrow.
(when (org-in-ipython-block-p) (org-narrow-to-block))
(if (ob-ipython-get-running)
(message "The kernel is busy running %s. Try later." (cdr (ob-ipython-get-running)))
(-if-let (result (->> (ob-ipython--inspect buffer
(- pos (point-min)))
(assoc 'text/plain) cdr))
(ob-ipython--create-inspect-buffer result)
(message "No documentation was found.")))))
(define-key org-mode-map (kbd "M-.") #'ob-ipython-inspect)
;;* Eldoc integration
;; I had in mind to integrate this into eldoc, but it for now a standalone
;; function to get a minibuffer message.
;; Note you need my fork of ob-ipython for this to work.
(defun ob-ipython-signature-function (buffer pos)
"Show a signature of the function at point in the minibuffer."
(interactive (list (current-buffer) (point)))
(save-restriction
;; Note you may be in a special edit buffer in which case it is not
;; necessary to narrow.
(when (org-in-ipython-block-p) (org-narrow-to-block))
(-if-let (result (->> (ob-ipython--inspect buffer
(- pos (point-min)))
(assoc 'text/plain)
cdr))
(progn
(when (stringp result)
(setq result (ansi-color-apply result)))
(cond
((s-starts-with? "Signature:" result)
(message (car (split-string result "\n"))))
((s-starts-with? "Docstring:" result)
(message (s-join "\n" (-slice (split-string result "\n") 0 2))))
(t
(message (car (split-string result "\n"))))))
(message "Nothing found"))))
(define-key org-mode-map (kbd "C-1") #'ob-ipython-signature-function)
;;* Completion
;; This allows you to get completion from the ipython kernel.
(defun ob-ipython--complete-request (code &optional pos)
"Get completion candidates for the thing at POS from the kernel."
(let ((url-request-data (json-encode `((code . ,code)
(cursor_pos . ,(or pos (length code))))))
(url-request-method "POST"))
(with-current-buffer (url-retrieve-synchronously
(format "http://%s:%d/complete/%s"
ob-ipython-driver-hostname
ob-ipython-driver-port
(org-babel-get-session)))
(if (>= (url-http-parse-response) 400)
(ob-ipython--dump-error (buffer-string))
(goto-char url-http-end-of-headers)
(let ((json-array-type 'list))
(json-read))))))
(defun ob-ipython-complete ()
"Get completion candidates for the thing at point."
(if (ob-ipython-get-running)
(message "The kernel is busy running %s." (cdr (ob-ipython-get-running)))
(save-restriction
(when (org-in-ipython-block-p) (org-narrow-to-block))
(-if-let (result (->> (ob-ipython--complete-request
(buffer-substring-no-properties (point-min) (point-max))
(- (point) (point-min)))
car
(assoc 'content)))
(list
(cdr (assoc 'matches result))
(cdr (assoc 'cursor_start result))
(cdr (assoc 'cursor_end result)))))))
(defun ob-ipython-complete-ivy ()
"Use ivy to complete the thing at point."
(interactive)
(let* ((result (ob-ipython-complete))
(candidates (first result))
(origin (save-restriction
(org-narrow-to-block)
(point-min)))
(beg (+ origin (second result)))
(end (+ origin (third result))))
(ivy-read "Complete: " candidates
:action (lambda (candidate)
(with-ivy-window
(setf (buffer-substring beg end) candidate)
(forward-char (length candidate)))))))
(define-key org-mode-map (kbd "s-.") #'ob-ipython-complete-ivy)
(defvar ob-ipython-syntax-table
(make-syntax-table org-mode-syntax-table))
(modify-syntax-entry ?. "_." ob-ipython-syntax-table)
(modify-syntax-entry ?= ".=" ob-ipython-syntax-table)
(modify-syntax-entry ?' "|'" ob-ipython-syntax-table)
;; This is a company backend to get completion while typing in org-mode.
(defun ob-ipython-company-backend (command &optional arg &rest ignored)
(interactive (list 'interactive))
(if (and (not (ob-ipython-get-running))
(member (get-char-property (point) 'lang)
'("ipython" "python")))
(cl-case command
(interactive (company-begin-backend 'ob-ipython-company-backend))
(prefix (with-syntax-table ob-ipython-syntax-table
(when (looking-back "\\_<[a-zA-Z][a-zA-Z0-9._]*"
(line-beginning-position))
(match-string 0))))
(candidates (car (ob-ipython-complete)))
;; sorted => t if the list is already sorted
(sorted t)
;; duplicates => t if there could be duplicates
(duplicates nil)
(require-match 'never))
nil))
;;* Asynchronous ipython
(defun ob-ipython-get-kernel-name ()
"Get the kernel name for the current buffer."
(if-let (bf (buffer-file-name))
(md5 (expand-file-name bf))
"scratch"))
(defvar *org-babel-async-ipython-running-cell* (make-hash-table :test 'equal)
"A hash table of (kernel . (buffer . name)) of the current cell for each kernel.")
(defun ob-ipython-get-running ()
"Get current running cell."
(gethash (ob-ipython-get-kernel-name) *org-babel-async-ipython-running-cell*))
(defun ob-ipython-set-running-cell (cell)
"Set the current running CELL for this buffer."
(setf (gethash (ob-ipython-get-kernel-name) *org-babel-async-ipython-running-cell*)
cell))
(defvar *org-babel-async-ipython-queue* (make-hash-table :test 'equal)
"A hash table (kernel . (list (buffer . name))) for cells to run.")
(defun ob-ipython-queue ()
"Return current queue for buffer."
(gethash (ob-ipython-get-kernel-name) *org-babel-async-ipython-queue*))
(gv-define-setter ob-ipython-queue (val)
`(setf (gethash (ob-ipython-get-kernel-name) *org-babel-async-ipython-queue*)
,val))
(defun ob-ipython-queue-cell (cell)
"Add CELL to the buffer queue."
(setf (gethash (ob-ipython-get-kernel-name) *org-babel-async-ipython-queue*)
(append
(gethash (ob-ipython-get-kernel-name) *org-babel-async-ipython-queue*)
(list cell))))
(defun ob-ipython-remove-cell (cell)
"Remove CELL from this buffer queue."
(setf (gethash (ob-ipython-get-kernel-name) *org-babel-async-ipython-queue*)
(remove
cell
(gethash (ob-ipython-get-kernel-name) *org-babel-async-ipython-queue*))))
(defun ob-ipython-pop-queue ()
"Return the next item in the queue for this buffer."
(pop (gethash (ob-ipython-get-kernel-name) *org-babel-async-ipython-queue*)))
;; adapted from https://github.com/zacharyvoase/humanhash/blob/master/humanhash.py
(defvar org-babel-src-block-words
'("ack" "alabama" "alanine" "alaska" "alpha" "angel" "apart" "april"
"arizona" "arkansas" "artist" "asparagus" "aspen" "august" "autumn"
"avocado" "bacon" "bakerloo" "batman" "beer" "berlin" "beryllium"
"black" "blossom" "blue" "bluebird" "bravo" "bulldog" "burger"
"butter" "california" "carbon" "cardinal" "carolina" "carpet" "cat"
"ceiling" "charlie" "chicken" "coffee" "cola" "cold" "colorado"
"comet" "connecticut" "crazy" "cup" "dakota" "december" "delaware"
"delta" "diet" "don" "double" "early" "earth" "east" "echo"
"edward" "eight" "eighteen" "eleven" "emma" "enemy" "equal"
"fanta" "fifteen" "fig" "fillet" "finch" "fish" "five" "fix"
"floor" "florida" "football" "four" "fourteen" "foxtrot" "freddie"
"friend" "fruit" "gee" "georgia" "glucose" "golf" "green" "grey"
"hamper" "happy" "harry" "hawaii" "helium" "high" "hot" "hotel"
"hydrogen" "idaho" "illinois" "india" "indigo" "ink" "iowa"
"island" "item" "jersey" "jig" "johnny" "juliet" "july" "jupiter"
"kansas" "kentucky" "kilo" "king" "kitten" "lactose" "lake" "lamp"
"lemon" "leopard" "lima" "lion" "lithium" "london" "louisiana"
"low" "magazine" "magnesium" "maine" "mango" "march" "mars"
"maryland" "massachusetts" "may" "mexico" "michigan" "mike"
"minnesota" "mirror" "mississippi" "missouri" "mobile" "mockingbird"
"monkey" "montana" "moon" "mountain" "muppet" "music" "nebraska"
"neptune" "network" "nevada" "nine" "nineteen" "nitrogen" "north"
"november" "nuts" "october" "ohio" "oklahoma" "one" "orange"
"oranges" "oregon" "oscar" "oven" "oxygen" "papa" "paris" "pasta"
"pennsylvania" "pip" "pizza" "pluto" "potato" "princess" "purple"
"quebec" "queen" "quiet" "red" "river" "robert" "robin" "romeo"
"rugby" "sad" "salami" "saturn" "september" "seven" "seventeen"
"shade" "sierra" "single" "sink" "six" "sixteen" "skylark" "snake"
"social" "sodium" "solar" "south" "spaghetti" "speaker" "spring"
"stairway" "steak" "stream" "summer" "sweet" "table" "tango" "ten"
"tennessee" "tennis" "texas" "thirteen" "three" "timing" "triple"
"twelve" "twenty" "two" "uncle" "under" "uniform" "uranus" "utah"
"vegan" "venus" "vermont" "victor" "video" "violet" "virginia"
"washington" "west" "whiskey" "white" "william" "winner" "winter"
"wisconsin" "wolfram" "wyoming" "xray" "yankee" "yellow" "zebra"
"zulu")
"List of words to make readable names from.")
(defun generate-human-readable-name ()
"Generate a human readable name for a src block.
The name should be unique to the buffer."
(random t)
(let ((N (length org-babel-src-block-words))
(current-names (org-element-map (org-element-parse-buffer)
'src-block (lambda (el)
(org-element-property
:name el))))
result)
(catch 'name
(while t
(setq result (s-join
"-"
(loop for i from 0 below org-babel-ipython-name-length collect
(elt org-babel-src-block-words (random N)))))
(unless (member result current-names)
(throw 'name result))))))
(defun org-babel-get-name-create ()
"Get the name of a src block or add a name to the src block at point."
(let* ((elem (org-element-at-point))
(name (org-element-property :name elem)))
(or name
(let ((beg (org-element-property :begin elem))
(id (funcall org-babel-ipython-name-generator)))
(save-excursion
(goto-char beg)
(insert (format "#+NAME: %s\n" id)))
id))))
(defun org-babel-get-session ()
"Return current session.
I wrote this because params returns none instead of nil. But in
that case the process that ipython uses appears to be default."
(if-let (info (org-babel-get-src-block-info 'light))
(let* ((args (third info))
(session (cdr (assoc :session args))))
(if (and session
(stringp session)
(not (string= "none" session)))
session
"default"))
(error "Not on a src block")))
;;** async links
(org-link-set-parameters
"async-queued"
:follow (lambda (path)
(let* ((f (split-string path " " t))
(name (first f)))
(ob-ipython-remove-cell (cons (current-buffer) name)))
(save-excursion
(org-babel-previous-src-block)
(org-babel-remove-result)))
:face '(:foreground "red")
:help-echo "Queued")
(org-link-set-parameters
"async-running"
:follow (lambda (path)
(org-babel-goto-named-src-block path)
(nuke-ipython)
(save-excursion
(org-babel-previous-src-block)
(org-babel-remove-result))
(ob-ipython-set-running-cell nil)
(setf (ob-ipython-queue) nil))
:face '(:foreground "green4")
:help-echo "Click to kill kernel")
;;** src block text properties
(defun org-babel-src-block-get-property (property)
"Return the PROPERTY associated with the src block."
(save-excursion
(goto-char (org-element-property :begin (org-element-context)))
(ob-ipython-log "Text properties: %S" (text-properties-at (point)))
(get-text-property (point) property)))
(defun org-babel-src-block-put-property (property value)
"Add a text property to the src-block"
(save-excursion
(goto-char (org-element-property :begin (org-element-context)))
(put-text-property (line-beginning-position) (line-end-position) property value)))
;;** async queue functions
(defun org-babel-async-ipython-clear-queue ()
"Clear the queue and all pending results."
(interactive)
(loop for (buffer . name) in (ob-ipython-queue)
do
(save-window-excursion
(with-current-buffer buffer
(ob-ipython-log "Clearing %s in %s" name buffer)
(org-babel-goto-named-src-block name)
(org-babel-remove-result))))
(ob-ipython-set-running-cell nil)
(setf (gethash (ob-ipython-get-kernel-name) *org-babel-async-ipython-queue*) nil))
(defun org-babel-async-ipython-process-queue ()
"Run the next job in the queue."
(if-let ((not-running (not (ob-ipython-get-running)))
(cell (ob-ipython-pop-queue))
(buffer (car cell))
(name (cdr cell)))
(save-window-excursion
(with-current-buffer buffer
(org-babel-goto-named-src-block name)
(ob-ipython-set-running-cell cell)
(ob-ipython-log "Setting up %S to run." cell)
(let* ((running-link (format
"[[async-running: %s]]"
(org-babel-src-block-get-property 'org-babel-ipython-name)))
(info (org-babel-get-src-block-info))
(params (third info))
(body
(let ((coderef (nth 6 info))
(expand
(if (org-babel-noweb-p params :eval)
(org-babel-expand-noweb-references info)
(nth 1 info))))
(if (not coderef) expand
(replace-regexp-in-string
(org-src-coderef-regexp coderef) "" expand nil nil 1))))
(result-params (cdr (assoc :result-params params)))
(session (--when-let (cdr (assoc :session params))
(or (and (not (equal it "none")) it)
"default")))
(var-lines (org-babel-variable-assignments:python params))
(body (encode-coding-string
(org-babel-expand-body:generic
(org-remove-indentation body) params var-lines)
'utf-8)))
(ob-ipython--execute-request-asynchronously body session)
(org-babel-remove-result)
(org-babel-insert-result running-link result-params)
(ob-ipython--normalize-session session)
running-link)))
(ob-ipython-log "Cannot process a queue.
Running: %s
Queue: %s"
(ob-ipython-get-running)
(ob-ipython-queue))
nil))
;;** async execute functions
(defvar *org-babel-ipython-exception-buffer* nil
"Global var to store buffer an exception came from.")
(defun ob-ipython--execute-request-asynchronously (code kernel-name)
"This function makes an asynchronous request.
CODE is a string containing the code to execute.
NAME is the name of the kernel, usually \"default\".
A callback function replaces the results."
(let ((url-request-data (encode-coding-string code 'utf-8))
(url-request-method "POST")
(curbuf (current-buffer)))
(ob-ipython-log "Running %S\non kernel %s" code kernel-name)
(setq *org-babel-ipython-exception-buffer* nil)
(setq header-line-format (format "%s is running on %s" (cdr (ob-ipython-get-running)) kernel-name))
(url-retrieve
(format "http://%s:%d/execute/%s"
ob-ipython-driver-hostname
ob-ipython-driver-port
kernel-name)
;; the callback function
'ob-ipython--async-callback
;; current buffer this was called from
(list curbuf))))
(defun ob-ipython--async-callback (status &rest args)
"Callback function for `ob-ipython--execute-request-asynchronously'.
It replaces the output in the results."
(ob-ipython-log "Entering callback for %s" *org-babel-async-ipython-running-cell*)
(let* ((ret (ob-ipython--eval (if (>= (url-http-parse-response) 400)
(ob-ipython--dump-error (buffer-string))
(goto-char url-http-end-of-headers)
(ob-ipython-log "http request: %s"
(buffer-substring (point-min) (point-max)))
(let* ((json-array-type 'list)
(json (json-read)))
;; we will need this in the traceback buffer
(setq *org-babel-ipython-exception-buffer* (car args))
;; This means there was an exception.
(when (string= "error"
(cdr
(assoc 'msg_type (elt json 0))))
(with-current-buffer (car args)
(org-babel-goto-named-src-block
(cdr (ob-ipython-get-running)))
(org-babel-remove-result)))
json))))
;; If there are images, they will be in result
(result (cdr (assoc :result ret)))
;; If there is printed output, it will be in output
(output (cdr (assoc :output ret)))
info params result-params result-mime-type
current-cell name
(image-p nil)
(result-type))
(with-current-buffer (car args)
(setq current-cell (ob-ipython-get-running)
name (cdr current-cell))
(save-excursion
(org-babel-goto-named-src-block name)
(setq result-type (org-babel-src-block-get-property 'org-babel-ipython-result-type))
(org-babel-src-block-put-property 'org-babel-ipython-executed t)
(ob-ipython-log "Got a result-type of %s\n return from the kernel: %S" result-type ret)
(setq info (org-babel-get-src-block-info))
(setq params (third info))
(setq result-params (cdr (assoc :result-params params)))
(setq result-mime-type (cdr (assoc :ob-ipython-results params)))
(when result-mime-type
(setq result (-filter (lambda (e) (eq (car e) (intern result-mime-type))) result)))
(org-babel-remove-result)
(cond
((string= "output" result-type)
(let ((res (mapconcat
'identity
(-remove
'null
(list
(when (not (s-blank? output))