emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
blob e3c6a40096aa0099a96a4e4f462fe1e5863f8b93 10557 bytes (raw)
name: testing/lisp/test-ob-python.el 	 # note: path name is non-authoritative(*)

  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
 
;;; 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

debug log:

solving e3c6a4009 ...
found e3c6a4009 in https://git.savannah.gnu.org/cgit/emacs/org-mode.git

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).