mirror of
https://git.savannah.gnu.org/git/emacs/org-mode.git
synced 2024-08-22 08:48:30 +00:00
Adds functionality to ob-comint.el to implement async session eval on a per-language basis. Adds a reference implementation for ob-python. * lisp/ob-comint.el (org-babel-comint-with-output): Remove comment. (org-babel-comint-async-indicator, org-babel-comint-async-buffers, org-babel-comint-async-file-callback, org-babel-comint-async-chunk-callback, org-babel-comint-async-dangling): Add buffer-local variables used for async comint evaluation. (org-babel-comint-use-async): Add function to determine whether block should be evaluated asynchronously. (org-babel-comint-async-filter): Add filter function to attach to comint-output-filter-functions for babel async eval. (org-babel-comint-async-register): Add function to setup buffer variables and hooks for session eval. (org-babel-comint-async-delete-dangling-and-eval): Add helper function for async session eval. * lisp/ob-python.el (org-babel-execute:python): Check for async header argument. (org-babel-python-evaluate): Check whether to use async evaluation. (org-babel-python-async-indicator): Add constant for indicating the start/end of async evaluations. (org-babel-python-async-evaluate-session): Add function for Python async eval. * testing/lisp/test-ob-python.el (test-ob-python/async-simple-session-output): Unit test for Python async session eval. (test-ob-python/async-named-output): Unit test that Python async eval can replace named output. (test-ob-python/async-output-drawer): Unit test that Python async eval works with drawer results.
274 lines
6.9 KiB
EmacsLisp
274 lines
6.9 KiB
EmacsLisp
;;; test-ob-python.el --- tests for ob-python.el
|
|
|
|
;; Copyright (c) 2011-2014, 2019 Eric Schulte
|
|
;; Authors: Eric Schulte
|
|
|
|
;; This file is not part of GNU Emacs.
|
|
|
|
;; This program is free software; you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published by
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
;; (at your option) any later version.
|
|
|
|
;; This program is distributed in the hope that it will be useful,
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
;; GNU General Public License for more details.
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
;;; Code:
|
|
(org-test-for-executable "python")
|
|
(unless (featurep 'ob-python)
|
|
(signal 'missing-test-dependency "Support for Python code blocks"))
|
|
|
|
(ert-deftest test-ob-python/colnames-yes-header-argument ()
|
|
(should
|
|
(equal '(("col") hline ("a") ("b"))
|
|
(org-test-with-temp-text "#+name: eg
|
|
| col |
|
|
|-----|
|
|
| a |
|
|
| b |
|
|
|
|
#+header: :colnames yes
|
|
#+header: :var x = eg
|
|
<point>#+begin_src python
|
|
return x
|
|
#+end_src"
|
|
(org-babel-execute-src-block)))))
|
|
|
|
(ert-deftest test-ob-python/colnames-yes-header-argument-again ()
|
|
(should
|
|
(equal '(("a") hline ("b*") ("c*"))
|
|
(org-test-with-temp-text "#+name: less-cols
|
|
| a |
|
|
|---|
|
|
| b |
|
|
| c |
|
|
|
|
#+header: :colnames yes
|
|
<point>#+begin_src python :var tab=less-cols
|
|
return [[val + '*' for val in row] for row in tab]
|
|
#+end_src"
|
|
(org-babel-execute-src-block)))))
|
|
|
|
(ert-deftest test-ob-python/colnames-nil-header-argument ()
|
|
(should
|
|
(equal '(("col") hline ("a") ("b"))
|
|
(org-test-with-temp-text "#+name: eg
|
|
| col |
|
|
|-----|
|
|
| a |
|
|
| b |
|
|
|
|
#+header: :colnames nil
|
|
#+header: :var x = eg
|
|
<point>#+begin_src python
|
|
return x
|
|
#+end_src"
|
|
(org-babel-execute-src-block)))))
|
|
|
|
(ert-deftest test-ob-python/colnames-no-header-argument-again ()
|
|
(should
|
|
(equal '(("a*") ("b*") ("c*"))
|
|
(org-test-with-temp-text "#+name: less-cols
|
|
| a |
|
|
|---|
|
|
| b |
|
|
| c |
|
|
|
|
#+header: :colnames no
|
|
<point>#+begin_src python :var tab=less-cols
|
|
return [[val + '*' for val in row] for row in tab]
|
|
#+end_src"
|
|
(org-babel-execute-src-block)))))
|
|
|
|
(ert-deftest test-ob-python/colnames-no-header-argument ()
|
|
(should
|
|
(equal '(("col") ("a") ("b"))
|
|
(org-test-with-temp-text "#+name: eg
|
|
| col |
|
|
|-----|
|
|
| a |
|
|
| b |
|
|
|
|
#+header: :colnames no
|
|
#+header: :var x = eg
|
|
<point>#+begin_src python
|
|
return x
|
|
#+end_src"
|
|
(org-babel-execute-src-block)))))
|
|
|
|
(ert-deftest test-ob-python/session-multiline ()
|
|
(should
|
|
(equal "20"
|
|
(org-test-with-temp-text "#+begin_src python :session :results output
|
|
foo = 0
|
|
for _ in range(10):
|
|
foo += 1
|
|
|
|
foo += 1
|
|
|
|
print(foo)
|
|
#+end_src"
|
|
(org-babel-execute-src-block)))))
|
|
|
|
(ert-deftest test-ob-python/insert-necessary-blank-line-when-sending-code-to-interpreter ()
|
|
(should
|
|
(equal 2 (org-test-with-temp-text "#+begin_src python :session :results value
|
|
if True:
|
|
1
|
|
2
|
|
#+end_src"
|
|
;; Previously, while adding `:session' to a normal code
|
|
;; block, also need to add extra blank lines to end
|
|
;; indent block or indicate logical sections. Now, the
|
|
;; `org-babel-python-evaluate-session' can do it
|
|
;; automatically:
|
|
;;
|
|
;; >>> if True:
|
|
;; >>> 1
|
|
;; >>> <insert_blank_line_here>
|
|
;; >>> 2
|
|
(org-babel-execute-maybe)
|
|
(org-babel-execute-src-block)))))
|
|
|
|
(ert-deftest test-ob-python/if-else-block ()
|
|
(should
|
|
(equal "success" (org-test-with-temp-text "#+begin_src python :session :results value
|
|
value = 'failure'
|
|
if False:
|
|
pass
|
|
else:
|
|
value = 'success'
|
|
value
|
|
#+end_src"
|
|
(org-babel-execute-src-block)))))
|
|
|
|
(ert-deftest test-ob-python/indent-block-with-blank-lines ()
|
|
(should
|
|
(equal 20
|
|
(org-test-with-temp-text "#+begin_src python :session :results value
|
|
foo = 0
|
|
for i in range(10):
|
|
foo += 1
|
|
|
|
foo += 1
|
|
|
|
foo
|
|
#+end_src"
|
|
(org-babel-execute-src-block)))))
|
|
|
|
(ert-deftest test-ob-python/assign-underscore ()
|
|
(should
|
|
(equal "success"
|
|
(org-test-with-temp-text "#+begin_src python :session :results value
|
|
_ = 'failure'
|
|
'success'
|
|
#+end_src"
|
|
(org-babel-execute-src-block)))))
|
|
|
|
(ert-deftest test-ob-python/multiline-var ()
|
|
(should
|
|
(equal "a\nb\nc"
|
|
(org-test-with-temp-text "#+begin_src python :var text=\"a\\nb\\nc\"
|
|
return text
|
|
#+end_src"
|
|
(org-babel-execute-src-block)))))
|
|
|
|
(ert-deftest test-ob-python/multiline-str ()
|
|
(should
|
|
(equal "a\nb\nc"
|
|
(org-test-with-temp-text "#+begin_src python
|
|
text=\"a\\nb\\nc\"
|
|
return text
|
|
#+end_src"
|
|
(org-babel-execute-src-block)))))
|
|
|
|
(ert-deftest test-ob-python/header-var-assignment ()
|
|
(should
|
|
(equal "success"
|
|
(org-test-with-temp-text "#+begin_src python :var text=\"failure\"
|
|
text
|
|
text=\"success\"
|
|
return text
|
|
#+end_src"
|
|
(org-babel-execute-src-block)))))
|
|
|
|
(ert-deftest test-ob-python/session-value-sleep ()
|
|
(should
|
|
(equal "success"
|
|
(org-test-with-temp-text "#+begin_src python :session :results value
|
|
import time
|
|
time.sleep(.1)
|
|
'success'
|
|
#+end_src"
|
|
(org-babel-execute-src-block)))))
|
|
|
|
(ert-deftest test-ob-python/async-simple-session-output ()
|
|
(let ((org-babel-temporary-directory temporary-file-directory)
|
|
(org-confirm-babel-evaluate nil))
|
|
(org-test-with-temp-text
|
|
"#+begin_src python :session :async yes :results output
|
|
import time
|
|
time.sleep(.1)
|
|
print('Yep!')
|
|
#+end_src\n"
|
|
(should (let ((expected "Yep!"))
|
|
(and (not (string= expected (org-babel-execute-src-block)))
|
|
(string= expected
|
|
(progn
|
|
(sleep-for 0 200)
|
|
(goto-char (org-babel-where-is-src-block-result))
|
|
(org-babel-read-result)))))))))
|
|
|
|
(ert-deftest test-ob-python/async-named-output ()
|
|
(let (org-confirm-babel-evaluate
|
|
(org-babel-temporary-directory temporary-file-directory)
|
|
(src-block "#+begin_src python :async :session :results output
|
|
print(\"Yep!\")
|
|
#+end_src")
|
|
(results-before "
|
|
|
|
#+NAME: foobar
|
|
#+RESULTS:
|
|
: Nope!")
|
|
(results-after "
|
|
|
|
#+NAME: foobar
|
|
#+RESULTS:
|
|
: Yep!
|
|
"))
|
|
(org-test-with-temp-text
|
|
(concat src-block results-before)
|
|
(should (progn (org-babel-execute-src-block)
|
|
(sleep-for 0 200)
|
|
(string= (concat src-block results-after)
|
|
(buffer-string)))))))
|
|
|
|
(ert-deftest test-ob-python/async-output-drawer ()
|
|
(let (org-confirm-babel-evaluate
|
|
(org-babel-temporary-directory temporary-file-directory)
|
|
(src-block "#+begin_src python :async :session :results output drawer
|
|
print(list(range(3)))
|
|
#+end_src")
|
|
(result "
|
|
|
|
#+RESULTS:
|
|
:results:
|
|
[0, 1, 2]
|
|
:end:
|
|
"))
|
|
(org-test-with-temp-text
|
|
src-block
|
|
(should (progn (org-babel-execute-src-block)
|
|
(sleep-for 0 200)
|
|
(string= (concat src-block result)
|
|
(buffer-string)))))))
|
|
|
|
(provide 'test-ob-python)
|
|
|
|
;;; test-ob-python.el ends here
|