lisp/ob-python.el

   1 ;;; ob-python.el --- org-babel functions for python evaluation
   2
   3 ;; Copyright (C) 2009-2011  Free Software Foundation
   4
   5 ;; Author: Eric Schulte, Dan Davison
   6 ;; Keywords: literate programming, reproducible research
   7 ;; Homepage: http://orgmode.org
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;; Org-Babel support for evaluating python source code.
  27
  28 ;;; Code:
  29 (require 'ob)
  30 (require 'ob-ref)
  31 (require 'ob-comint)
  32 (require 'ob-eval)
  33 (eval-when-compile (require 'cl))
  34
  35 (declare-function org-remove-indentation "org" )
  36 (declare-function py-shell "ext:python-mode" (&optional argprompt))
  37 (declare-function py-toggle-shells "ext:python-mode" (arg))
  38 (declare-function run-python "ext:python" (&optional cmd noshow new))
  39
  40 (defvar org-babel-tangle-lang-exts)
  41 (add-to-list 'org-babel-tangle-lang-exts '("python" . "py"))
  42
  43 (defvar org-babel-default-header-args:python '())
  44
  45 (defvar org-babel-python-command "python"
  46   "Name of command for executing python code.")
  47
  48 (defvar org-babel-python-mode (if (featurep 'xemacs) 'python-mode 'python)
  49   "Preferred python mode for use in running python interactively.
  50 This will typically be either 'python or 'python-mode.")
  51
  52 (defvar org-src-preserve-indentation)
  53
  54 (defun org-babel-execute:python (body params)
  55   "Execute a block of Python code with Babel.
  56 This function is called by `org-babel-execute-src-block'."
  57   (let* ((session (org-babel-python-initiate-session
  58                    (cdr (assoc :session params))))
  59          (result-params (cdr (assoc :result-params params)))
  60          (result-type (cdr (assoc :result-type params)))
  61          (return-val (when (and (eq result-type 'value) (not session))
  62                        (cdr (assoc :return params))))
  63          (preamble (cdr (assoc :preamble params)))
  64          (full-body
  65           (org-babel-expand-body:generic
  66            (concat body (if return-val (format "return %s" return-val) ""))
  67            params (org-babel-variable-assignments:python params)))
  68          (result (org-babel-python-evaluate
  69                   session full-body result-type result-params preamble)))
  70     (org-babel-reassemble-table
  71      result
  72      (org-babel-pick-name (cdr (assoc :colname-names params))
  73                           (cdr (assoc :colnames params)))
  74      (org-babel-pick-name (cdr (assoc :rowname-names params))
  75                           (cdr (assoc :rownames params))))))
  76
  77 (defun org-babel-prep-session:python (session params)
  78   "Prepare SESSION according to the header arguments in PARAMS.
  79 VARS contains resolved variable references"
  80   (let* ((session (org-babel-python-initiate-session session))
  81          (var-lines
  82           (org-babel-variable-assignments:python params)))
  83     (org-babel-comint-in-buffer session
  84       (mapc (lambda (var)
  85               (end-of-line 1) (insert var) (comint-send-input)
  86               (org-babel-comint-wait-for-output session)) var-lines))
  87     session))
  88
  89 (defun org-babel-load-session:python (session body params)
  90   "Load BODY into SESSION."
  91   (save-window-excursion
  92     (let ((buffer (org-babel-prep-session:python session params)))
  93       (with-current-buffer buffer
  94         (goto-char (process-mark (get-buffer-process (current-buffer))))
  95         (insert (org-babel-chomp body)))
  96       buffer)))
  97
  98 ;; helper functions
  99
 100 (defun org-babel-variable-assignments:python (params)
 101   "Return list of python statements assigning the block's variables"
 102   (mapcar
 103    (lambda (pair)
 104      (format "%s=%s"
 105              (car pair)
 106              (org-babel-python-var-to-python (cdr pair))))
 107    (mapcar #'cdr (org-babel-get-header params :var))))
 108
 109 (defun org-babel-python-var-to-python (var)
 110   "Convert an elisp value to a python variable.
 111 Convert an elisp value, VAR, into a string of python source code
 112 specifying a variable of the same value."
 113   (if (listp var)
 114       (concat "[" (mapconcat #'org-babel-python-var-to-python var ", ") "]")
 115     (if (equal var 'hline)
 116         "None"
 117       (format
 118        (if (and (stringp var) (string-match "[\n\r]" var)) "\"\"%S\"\"" "%S")
 119        var))))
 120
 121 (defun org-babel-python-table-or-string (results)
 122   "Convert RESULTS into an appropriate elisp value.
 123 If the results look like a list or tuple, then convert them into an
 124 Emacs-lisp table, otherwise return the results as a string."
 125   (org-babel-script-escape results))
 126
 127 (defvar org-babel-python-buffers '((:default . nil)))
 128
 129 (defun org-babel-python-session-buffer (session)
 130   "Return the buffer associated with SESSION."
 131   (cdr (assoc session org-babel-python-buffers)))
 132
 133 (defvar py-default-interpreter)
 134 (defun org-babel-python-initiate-session-by-key (&optional session)
 135   "Initiate a python session.
 136 If there is not a current inferior-process-buffer in SESSION
 137 then create.  Return the initialized session."
 138   (require org-babel-python-mode)
 139   (save-window-excursion
 140     (let* ((session (if session (intern session) :default))
 141            (python-buffer (org-babel-python-session-buffer session)))
 142       (cond
 143        ((and (eq 'python org-babel-python-mode)
 144              (fboundp 'run-python)) ; python.el
 145         (run-python))
 146        ((and (eq 'python-mode org-babel-python-mode)
 147              (fboundp 'py-shell)) ; python-mode.el
 148         ;; Make sure that py-which-bufname is initialized, as otherwise
 149         ;; it will be overwritten the first time a Python buffer is
 150         ;; created.
 151         (py-toggle-shells py-default-interpreter)
 152         ;; `py-shell' creates a buffer whose name is the value of
 153         ;; `py-which-bufname' with '*'s at the beginning and end
 154         (let* ((bufname (if (and python-buffer (buffer-live-p python-buffer))
 155                             (replace-regexp-in-string ;; zap surrounding *
 156                              "^\\*\\([^*]+\\)\\*$" "\\1" python-buffer)
 157                           (concat "Python-" (symbol-name session))))
 158                (py-which-bufname bufname))
 159           (py-shell)
 160           (setq python-buffer (concat "*" bufname "*"))))
 161        (t
 162         (error "No function available for running an inferior python.")))
 163       (setq org-babel-python-buffers
 164             (cons (cons session python-buffer)
 165                   (assq-delete-all session org-babel-python-buffers)))
 166       session)))
 167
 168 (defun org-babel-python-initiate-session (&optional session params)
 169   "Create a session named SESSION according to PARAMS."
 170   (unless (string= session "none")
 171     (org-babel-python-session-buffer
 172      (org-babel-python-initiate-session-by-key session))))
 173
 174 (defvar org-babel-python-eoe-indicator "'org_babel_python_eoe'"
 175   "A string to indicate that evaluation has completed.")
 176 (defvar org-babel-python-wrapper-method
 177   "
 178 def main():
 179 %s
 180
 181 open('%s', 'w').write( str(main()) )")
 182 (defvar org-babel-python-pp-wrapper-method
 183   "
 184 import pprint
 185 def main():
 186 %s
 187
 188 open('%s', 'w').write( pprint.pformat(main()) )")
 189
 190 (defun org-babel-python-evaluate
 191   (session body &optional result-type result-params preamble)
 192   "Evaluate BODY as python code."
 193   (if session
 194       (org-babel-python-evaluate-session
 195        session body result-type result-params)
 196     (org-babel-python-evaluate-external-process
 197      body result-type result-params preamble)))
 198
 199 (defun org-babel-python-evaluate-external-process
 200   (body &optional result-type result-params preamble)
 201   "Evaluate BODY in external python process.
 202 If RESULT-TYPE equals 'output then return standard output as a
 203 string. If RESULT-TYPE equals 'value then return the value of the
 204 last statement in BODY, as elisp."
 205   ((lambda (raw)
 206      (if (or (member "code" result-params)
 207              (member "pp" result-params)
 208              (and (member "output" result-params)
 209                   (not (member "table" result-params))))
 210          raw
 211        (org-babel-python-table-or-string (org-babel-trim raw))))
 212    (case result-type
 213      (output (org-babel-eval org-babel-python-command
 214                              (concat (if preamble (concat preamble "\n") "")
 215                                      body)))
 216      (value (let ((tmp-file (org-babel-temp-file "python-")))
 217               (org-babel-eval
 218                org-babel-python-command
 219                (concat
 220                 (if preamble (concat preamble "\n") "")
 221                 (format
 222                  (if (member "pp" result-params)
 223                      org-babel-python-pp-wrapper-method
 224                    org-babel-python-wrapper-method)
 225                  (mapconcat
 226                   (lambda (line) (format "\t%s" line))
 227                   (split-string
 228                    (org-remove-indentation
 229                     (org-babel-trim body))
 230                    "[\r\n]") "\n")
 231                  (org-babel-process-file-name tmp-file 'noquote))))
 232               (org-babel-eval-read-file tmp-file))))))
 233
 234 (defun org-babel-python-evaluate-session
 235   (session body &optional result-type result-params)
 236   "Pass BODY to the Python process in SESSION.
 237 If RESULT-TYPE equals 'output then return standard output as a
 238 string. If RESULT-TYPE equals 'value then return the value of the
 239 last statement in BODY, as elisp."
 240   (flet ((send-wait () (comint-send-input nil t) (sleep-for 0 5))
 241          (dump-last-value
 242           (tmp-file pp)
 243           (mapc
 244            (lambda (statement) (insert statement) (send-wait))
 245            (if pp
 246                (list
 247                 "import pprint"
 248                 (format "open('%s', 'w').write(pprint.pformat(_))"
 249                         (org-babel-process-file-name tmp-file 'noquote)))
 250              (list (format "open('%s', 'w').write(str(_))"
 251                            (org-babel-process-file-name tmp-file 'noquote))))))
 252          (input-body (body)
 253                      (mapc (lambda (line) (insert line) (send-wait))
 254                            (split-string body "[\r\n]"))
 255                      (send-wait)))
 256     ((lambda (results)
 257        (unless (string= (substring org-babel-python-eoe-indicator 1 -1) results)
 258          (if (or (member "code" result-params)
 259                  (member "pp" result-params)
 260                  (and (member "output" result-params)
 261                       (not (member "table" result-params))))
 262              results
 263            (org-babel-python-table-or-string results))))
 264      (case result-type
 265        (output
 266         (mapconcat
 267          #'org-babel-trim
 268          (butlast
 269           (org-babel-comint-with-output
 270               (session org-babel-python-eoe-indicator t body)
 271             (input-body body)
 272             (send-wait) (send-wait)
 273             (insert org-babel-python-eoe-indicator)
 274             (send-wait))
 275           2) "\n"))
 276        (value
 277         (let ((tmp-file (org-babel-temp-file "python-")))
 278           (org-babel-comint-with-output
 279               (session org-babel-python-eoe-indicator nil body)
 280             (let ((comint-process-echoes nil))
 281               (input-body body)
 282               (dump-last-value tmp-file (member "pp" result-params))
 283               (send-wait) (send-wait)
 284               (insert org-babel-python-eoe-indicator)
 285               (send-wait)))
 286           (org-babel-eval-read-file tmp-file)))))))
 287
 288 (defun org-babel-python-read-string (string)
 289   "Strip 's from around python string"
 290   (if (string-match "^'\\([^\000]+\\)'$" string)
 291       (match-string 1 string)
 292     string))
 293
 294 (provide 'ob-python)
 295
 296
 297
 298 ;;; ob-python.el ends here