mirror of
https://git.savannah.gnu.org/git/emacs/org-mode.git
synced 2024-11-26 07:33:39 +00:00
58f1dbccf8
Also remove blank lines before the ";;; org*el ends here" declarations. Having a "Version" header forced us to update every file when releasing a new version of Org; it also forced us to update every file when merging Org with Emacs trunk, thus cluttering the diffs between the previously merged version and the new one with useless information. Glenn Morris suggested this in emacs-devel: http://lists.gnu.org/archive/html/emacs-devel/2011-08/msg00322.html
299 lines
10 KiB
EmacsLisp
299 lines
10 KiB
EmacsLisp
;;; ob-python.el --- org-babel functions for python evaluation
|
|
|
|
;; Copyright (C) 2009-2011 Free Software Foundation
|
|
|
|
;; Author: Eric Schulte, Dan Davison
|
|
;; Keywords: literate programming, reproducible research
|
|
;; Homepage: http://orgmode.org
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
;; GNU Emacs 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.
|
|
|
|
;; GNU Emacs 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;; Org-Babel support for evaluating python source code.
|
|
|
|
;;; Code:
|
|
(require 'ob)
|
|
(require 'ob-ref)
|
|
(require 'ob-comint)
|
|
(require 'ob-eval)
|
|
(eval-when-compile (require 'cl))
|
|
|
|
(declare-function org-remove-indentation "org" )
|
|
(declare-function py-shell "ext:python-mode" (&optional argprompt))
|
|
(declare-function py-toggle-shells "ext:python-mode" (arg))
|
|
(declare-function run-python "ext:python" (&optional cmd noshow new))
|
|
|
|
(defvar org-babel-tangle-lang-exts)
|
|
(add-to-list 'org-babel-tangle-lang-exts '("python" . "py"))
|
|
|
|
(defvar org-babel-default-header-args:python '())
|
|
|
|
(defvar org-babel-python-command "python"
|
|
"Name of command for executing python code.")
|
|
|
|
(defvar org-babel-python-mode (if (featurep 'xemacs) 'python-mode 'python)
|
|
"Preferred python mode for use in running python interactively.
|
|
This will typically be either 'python or 'python-mode.")
|
|
|
|
(defvar org-src-preserve-indentation)
|
|
|
|
(defun org-babel-execute:python (body params)
|
|
"Execute a block of Python code with Babel.
|
|
This function is called by `org-babel-execute-src-block'."
|
|
(let* ((session (org-babel-python-initiate-session
|
|
(cdr (assoc :session params))))
|
|
(result-params (cdr (assoc :result-params params)))
|
|
(result-type (cdr (assoc :result-type params)))
|
|
(return-val (when (and (eq result-type 'value) (not session))
|
|
(cdr (assoc :return params))))
|
|
(preamble (cdr (assoc :preamble params)))
|
|
(full-body
|
|
(org-babel-expand-body:generic
|
|
(concat body (if return-val (format "return %s" return-val) ""))
|
|
params (org-babel-variable-assignments:python params)))
|
|
(result (org-babel-python-evaluate
|
|
session full-body result-type result-params preamble)))
|
|
(org-babel-reassemble-table
|
|
result
|
|
(org-babel-pick-name (cdr (assoc :colname-names params))
|
|
(cdr (assoc :colnames params)))
|
|
(org-babel-pick-name (cdr (assoc :rowname-names params))
|
|
(cdr (assoc :rownames params))))))
|
|
|
|
(defun org-babel-prep-session:python (session params)
|
|
"Prepare SESSION according to the header arguments in PARAMS.
|
|
VARS contains resolved variable references"
|
|
(let* ((session (org-babel-python-initiate-session session))
|
|
(var-lines
|
|
(org-babel-variable-assignments:python params)))
|
|
(org-babel-comint-in-buffer session
|
|
(mapc (lambda (var)
|
|
(end-of-line 1) (insert var) (comint-send-input)
|
|
(org-babel-comint-wait-for-output session)) var-lines))
|
|
session))
|
|
|
|
(defun org-babel-load-session:python (session body params)
|
|
"Load BODY into SESSION."
|
|
(save-window-excursion
|
|
(let ((buffer (org-babel-prep-session:python session params)))
|
|
(with-current-buffer buffer
|
|
(goto-char (process-mark (get-buffer-process (current-buffer))))
|
|
(insert (org-babel-chomp body)))
|
|
buffer)))
|
|
|
|
;; helper functions
|
|
|
|
(defun org-babel-variable-assignments:python (params)
|
|
"Return list of python statements assigning the block's variables"
|
|
(mapcar
|
|
(lambda (pair)
|
|
(format "%s=%s"
|
|
(car pair)
|
|
(org-babel-python-var-to-python (cdr pair))))
|
|
(mapcar #'cdr (org-babel-get-header params :var))))
|
|
|
|
(defun org-babel-python-var-to-python (var)
|
|
"Convert an elisp value to a python variable.
|
|
Convert an elisp value, VAR, into a string of python source code
|
|
specifying a variable of the same value."
|
|
(if (listp var)
|
|
(concat "[" (mapconcat #'org-babel-python-var-to-python var ", ") "]")
|
|
(if (equal var 'hline)
|
|
"None"
|
|
(format
|
|
(if (and (stringp var) (string-match "[\n\r]" var)) "\"\"%S\"\"" "%S")
|
|
var))))
|
|
|
|
(defun org-babel-python-table-or-string (results)
|
|
"Convert RESULTS into an appropriate elisp value.
|
|
If the results look like a list or tuple, then convert them into an
|
|
Emacs-lisp table, otherwise return the results as a string."
|
|
(org-babel-script-escape results))
|
|
|
|
(defvar org-babel-python-buffers '((:default . nil)))
|
|
|
|
(defun org-babel-python-session-buffer (session)
|
|
"Return the buffer associated with SESSION."
|
|
(cdr (assoc session org-babel-python-buffers)))
|
|
|
|
(defvar py-default-interpreter)
|
|
(defun org-babel-python-initiate-session-by-key (&optional session)
|
|
"Initiate a python session.
|
|
If there is not a current inferior-process-buffer in SESSION
|
|
then create. Return the initialized session."
|
|
(require org-babel-python-mode)
|
|
(save-window-excursion
|
|
(let* ((session (if session (intern session) :default))
|
|
(python-buffer (org-babel-python-session-buffer session)))
|
|
(cond
|
|
((and (eq 'python org-babel-python-mode)
|
|
(fboundp 'run-python)) ; python.el
|
|
(run-python))
|
|
((and (eq 'python-mode org-babel-python-mode)
|
|
(fboundp 'py-shell)) ; python-mode.el
|
|
;; Make sure that py-which-bufname is initialized, as otherwise
|
|
;; it will be overwritten the first time a Python buffer is
|
|
;; created.
|
|
(py-toggle-shells py-default-interpreter)
|
|
;; `py-shell' creates a buffer whose name is the value of
|
|
;; `py-which-bufname' with '*'s at the beginning and end
|
|
(let* ((bufname (if (and python-buffer (buffer-live-p python-buffer))
|
|
(replace-regexp-in-string ;; zap surrounding *
|
|
"^\\*\\([^*]+\\)\\*$" "\\1" python-buffer)
|
|
(concat "Python-" (symbol-name session))))
|
|
(py-which-bufname bufname))
|
|
(py-shell)
|
|
(setq python-buffer (concat "*" bufname "*"))))
|
|
(t
|
|
(error "No function available for running an inferior python.")))
|
|
(setq org-babel-python-buffers
|
|
(cons (cons session python-buffer)
|
|
(assq-delete-all session org-babel-python-buffers)))
|
|
session)))
|
|
|
|
(defun org-babel-python-initiate-session (&optional session params)
|
|
"Create a session named SESSION according to PARAMS."
|
|
(unless (string= session "none")
|
|
(org-babel-python-session-buffer
|
|
(org-babel-python-initiate-session-by-key session))))
|
|
|
|
(defvar org-babel-python-eoe-indicator "'org_babel_python_eoe'"
|
|
"A string to indicate that evaluation has completed.")
|
|
(defvar org-babel-python-wrapper-method
|
|
"
|
|
def main():
|
|
%s
|
|
|
|
open('%s', 'w').write( str(main()) )")
|
|
(defvar org-babel-python-pp-wrapper-method
|
|
"
|
|
import pprint
|
|
def main():
|
|
%s
|
|
|
|
open('%s', 'w').write( pprint.pformat(main()) )")
|
|
|
|
(defun org-babel-python-evaluate
|
|
(session body &optional result-type result-params preamble)
|
|
"Evaluate BODY as python code."
|
|
(if session
|
|
(org-babel-python-evaluate-session
|
|
session body result-type result-params)
|
|
(org-babel-python-evaluate-external-process
|
|
body result-type result-params preamble)))
|
|
|
|
(defun org-babel-python-evaluate-external-process
|
|
(body &optional result-type result-params preamble)
|
|
"Evaluate BODY in external python process.
|
|
If RESULT-TYPE equals 'output then return standard output as a
|
|
string. If RESULT-TYPE equals 'value then return the value of the
|
|
last statement in BODY, as elisp."
|
|
((lambda (raw)
|
|
(if (or (member "code" result-params)
|
|
(member "pp" result-params)
|
|
(and (member "output" result-params)
|
|
(not (member "table" result-params))))
|
|
raw
|
|
(org-babel-python-table-or-string (org-babel-trim raw))))
|
|
(case result-type
|
|
(output (org-babel-eval org-babel-python-command
|
|
(concat (if preamble (concat preamble "\n") "")
|
|
body)))
|
|
(value (let ((tmp-file (org-babel-temp-file "python-")))
|
|
(org-babel-eval
|
|
org-babel-python-command
|
|
(concat
|
|
(if preamble (concat preamble "\n") "")
|
|
(format
|
|
(if (member "pp" result-params)
|
|
org-babel-python-pp-wrapper-method
|
|
org-babel-python-wrapper-method)
|
|
(mapconcat
|
|
(lambda (line) (format "\t%s" line))
|
|
(split-string
|
|
(org-remove-indentation
|
|
(org-babel-trim body))
|
|
"[\r\n]") "\n")
|
|
(org-babel-process-file-name tmp-file 'noquote))))
|
|
(org-babel-eval-read-file tmp-file))))))
|
|
|
|
(defun org-babel-python-evaluate-session
|
|
(session body &optional result-type result-params)
|
|
"Pass BODY to the Python process in SESSION.
|
|
If RESULT-TYPE equals 'output then return standard output as a
|
|
string. If RESULT-TYPE equals 'value then return the value of the
|
|
last statement in BODY, as elisp."
|
|
(flet ((send-wait () (comint-send-input nil t) (sleep-for 0 5))
|
|
(dump-last-value
|
|
(tmp-file pp)
|
|
(mapc
|
|
(lambda (statement) (insert statement) (send-wait))
|
|
(if pp
|
|
(list
|
|
"import pprint"
|
|
(format "open('%s', 'w').write(pprint.pformat(_))"
|
|
(org-babel-process-file-name tmp-file 'noquote)))
|
|
(list (format "open('%s', 'w').write(str(_))"
|
|
(org-babel-process-file-name tmp-file 'noquote))))))
|
|
(input-body (body)
|
|
(mapc (lambda (line) (insert line) (send-wait))
|
|
(split-string body "[\r\n]"))
|
|
(send-wait)))
|
|
((lambda (results)
|
|
(unless (string= (substring org-babel-python-eoe-indicator 1 -1) results)
|
|
(if (or (member "code" result-params)
|
|
(member "pp" result-params)
|
|
(and (member "output" result-params)
|
|
(not (member "table" result-params))))
|
|
results
|
|
(org-babel-python-table-or-string results))))
|
|
(case result-type
|
|
(output
|
|
(mapconcat
|
|
#'org-babel-trim
|
|
(butlast
|
|
(org-babel-comint-with-output
|
|
(session org-babel-python-eoe-indicator t body)
|
|
(input-body body)
|
|
(send-wait) (send-wait)
|
|
(insert org-babel-python-eoe-indicator)
|
|
(send-wait))
|
|
2) "\n"))
|
|
(value
|
|
(let ((tmp-file (org-babel-temp-file "python-")))
|
|
(org-babel-comint-with-output
|
|
(session org-babel-python-eoe-indicator nil body)
|
|
(let ((comint-process-echoes nil))
|
|
(input-body body)
|
|
(dump-last-value tmp-file (member "pp" result-params))
|
|
(send-wait) (send-wait)
|
|
(insert org-babel-python-eoe-indicator)
|
|
(send-wait)))
|
|
(org-babel-eval-read-file tmp-file)))))))
|
|
|
|
(defun org-babel-python-read-string (string)
|
|
"Strip 's from around python string"
|
|
(if (string-match "^'\\([^\000]+\\)'$" string)
|
|
(match-string 1 string)
|
|
string))
|
|
|
|
(provide 'ob-python)
|
|
|
|
|
|
|
|
;;; ob-python.el ends here
|