Hi,
This patch adds graphics output support for ob-python via matplotlib.
Specifically, it allows to use header argument `:results file
graphics' as follows:
#+begin_src python :file "test.png" :results graphics file
import matplotlib.pyplot as plt
plt.plot([1,2,3,4,5])
#+end_src
The feature is described in the documentation as follows and has been
supported by ob-R, ob-julia, etc.
> ‘graphics’
> When used along with ‘file’ type, the result is a link to the file
> specified in ‘:file’ header argument.
From ee8d236310cd4bde4e33610b2b794022861fbd6a Mon Sep 17 00:00:00 2001
From: Liu Hui <liuhui1...@gmail.com>
Date: Mon, 3 Jul 2023 11:13:58 +0800
Subject: [PATCH] ob-python: support header argument `:results file graphics'
* lisp/ob-python.el (org-babel-execute:python): Save current figure to
file when the result type is `file graphics'.
(org-babel-python-save-graphics): New helper function to generate code
to save graphics.
---
lisp/ob-python.el | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/lisp/ob-python.el b/lisp/ob-python.el
index 0e0539d7a..9fae49a4d 100644
--- a/lisp/ob-python.el
+++ b/lisp/ob-python.el
@@ -72,6 +72,8 @@ (defun org-babel-execute:python (body params)
(cdr (assq :session params))))
(result-params (cdr (assq :result-params params)))
(result-type (cdr (assq :result-type params)))
+ (graphics-file (and (member "graphics" result-params)
+ (org-babel-graphical-output-file params)))
(return-val (when (eq result-type 'value)
(cdr (assq :return params))))
(preamble (cdr (assq :preamble params)))
@@ -81,6 +83,8 @@ (defun org-babel-execute:python (body params)
(org-babel-expand-body:generic
body params
(org-babel-variable-assignments:python params))
+ (when graphics-file
+ (org-babel-python-save-graphics graphics-file params))
(when return-val
(format (if session "\n%s" "\nreturn %s") return-val))))
(result (org-babel-python-evaluate
@@ -149,6 +153,21 @@ (defun org-babel-python-table-or-string (results)
res)
res)))
+(defun org-babel-python-save-graphics (out-file _)
+ "Return the code for saving graphics to `OUT-FILE'."
+ (format "
+try:
+ import matplotlib.pyplot
+ if len(matplotlib.pyplot.get_fignums()) > 0:
+ matplotlib.pyplot.gcf().savefig('%s')
+ else:
+ raise RuntimeError('No figure is found. You need to use matplotlib\
+ functions, such as plot and imshow, to produce the graphics.')
+except ModuleNotFoundError:
+ raise RuntimeError('ob-python depends on matplotlib for saving graphics')
+"
+ out-file))
+
(defvar org-babel-python-buffers '((:default . "*Python*")))
(defun org-babel-python-session-buffer (session)
--
2.25.1
