mirror of
https://git.savannah.gnu.org/git/emacs/org-mode.git
synced 2024-08-25 02:02:52 +00:00
* lisp/ob-python.el (org-babel-python-initiate-session-by-key): Wait for first prompt for pre-existing python processes. Document behavior for pre-existing python processes. (org-babel-python-initiate-session): Document behavior for pre-existing python processes. * testing/lisp/test-ob-python.el (test-ob-python/session-with-existing-inferior-python): New test for working with existing python processes.
354 lines
10 KiB
EmacsLisp
354 lines
10 KiB
EmacsLisp
;;; test-ob-python.el --- tests for ob-python.el -*- lexical-binding: t; -*-
|
|
|
|
;; 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")
|
|
(require 'ob-core)
|
|
(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 ()
|
|
;; Disable the test on older Emacs as built-in python.el sometimes
|
|
;; fail to initialize session.
|
|
(skip-unless (version<= "28" emacs-version))
|
|
(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 ()
|
|
;; Disable the test on older Emacs as built-in python.el sometimes
|
|
;; fail to initialize session.
|
|
(skip-unless (version<= "28" emacs-version))
|
|
(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 ()
|
|
;; Disable the test on older Emacs as built-in python.el sometimes
|
|
;; fail to initialize session.
|
|
(skip-unless (version<= "28" emacs-version))
|
|
(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 ()
|
|
;; Disable the test on older Emacs as built-in python.el sometimes
|
|
;; fail to initialize session.
|
|
(skip-unless (version<= "28" emacs-version))
|
|
(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 ()
|
|
;; Disable the test on older Emacs as built-in python.el sometimes
|
|
;; fail to initialize session.
|
|
(skip-unless (version<= "28" emacs-version))
|
|
(let ((result
|
|
(org-test-with-temp-text "#+begin_src python :session :results value
|
|
_ = 'failure'
|
|
'success'
|
|
#+end_src"
|
|
(org-babel-execute-src-block))))
|
|
(should (equal "success" result))))
|
|
|
|
(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 ()
|
|
;; Disable the test on older Emacs as built-in python.el sometimes
|
|
;; fail to initialize session.
|
|
(skip-unless (version<= "28" emacs-version))
|
|
(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 ()
|
|
;; Disable the test on older Emacs as built-in python.el sometimes
|
|
;; fail to initialize session.
|
|
(skip-unless (version<= "28" emacs-version))
|
|
(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 ()
|
|
;; Disable the test on older Emacs as built-in python.el sometimes
|
|
;; fail to initialize session.
|
|
(skip-unless (version<= "28" emacs-version))
|
|
(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 ()
|
|
;; Disable the test on older Emacs as built-in python.el sometimes
|
|
;; fail to initialize session.
|
|
(skip-unless (version<= "28" emacs-version))
|
|
(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)))))))
|
|
|
|
(ert-deftest test-ob-python/async-local-python-shell ()
|
|
;; Disable the test on older Emacs as built-in python.el sometimes
|
|
;; fail to initialize session.
|
|
(skip-unless (version<= "28" emacs-version))
|
|
(when-let ((buf (get-buffer "*Python*")))
|
|
(let (kill-buffer-query-functions)
|
|
(kill-buffer buf)))
|
|
(org-test-with-temp-text-in-file
|
|
"# -*- python-shell-buffer-name: \"Python 3\" -*-
|
|
<point>#+begin_src python :session \"*Python 3*\" :async yes
|
|
1
|
|
#+end_src"
|
|
(should (org-babel-execute-src-block))))
|
|
|
|
(ert-deftest test-ob-python/session-restart ()
|
|
;; Disable the test on older Emacs as built-in python.el sometimes
|
|
;; fail to initialize session.
|
|
(skip-unless (version<= "28" emacs-version))
|
|
(should
|
|
(equal "success"
|
|
(progn
|
|
(org-test-with-temp-text "#+begin_src python :session :results output
|
|
print('start')
|
|
#+end_src"
|
|
(org-babel-execute-src-block))
|
|
(let ((proc (python-shell-get-process)))
|
|
(python-shell-send-string "exit()")
|
|
(while (accept-process-output proc)))
|
|
(org-test-with-temp-text "#+begin_src python :session :results output
|
|
print('success')
|
|
#+end_src"
|
|
(org-babel-execute-src-block))))))
|
|
|
|
(ert-deftest test-ob-python/session-with-existing-inferior-python ()
|
|
;; Disable the test on older Emacs as built-in python.el sometimes
|
|
;; fail to initialize session.
|
|
(skip-unless (version<= "28" emacs-version))
|
|
(let ((session-name
|
|
"test-ob-python/session-with-existing-inferior-python"))
|
|
(let ((python-shell-buffer-name session-name))
|
|
(run-python))
|
|
(unwind-protect
|
|
(should (equal "success"
|
|
(org-test-with-temp-text
|
|
(format "#+begin_src python :session %s :results value
|
|
'success'
|
|
#+end_src"
|
|
session-name)
|
|
(org-babel-execute-src-block))))
|
|
(let (kill-buffer-hook kill-buffer-query-functions)
|
|
(kill-buffer (format "*%s*" session-name))))))
|
|
|
|
(provide 'test-ob-python)
|
|
|
|
;;; test-ob-python.el ends here
|