From: Liu Hui <liuhui1610@gmail.com>
To: Ihor Radchenko <yantar92@posteo.net>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH] ob-python: support header argument `:results file graphics'
Date: Mon, 3 Jul 2023 18:40:16 +0800 [thread overview]
Message-ID: <CAOQTW-Oh=2_0qKAFrawMJqWQk+ZWWfx0m08YvLoVypWZdyhauQ@mail.gmail.com> (raw)
In-Reply-To: <877crh8htb.fsf@localhost>
[-- Attachment #1: Type: text/plain, Size: 1626 bytes --]
Ihor Radchenko <yantar92@posteo.net> 于2023年7月3日周一 17:28写道:
> This might be a useful feature, but it will break the existing
> conventions, if used as in the patch. Currently, the above combination
> of :file and :results is treated as the following:
>
> ‘graphics’
> When used along with ‘file’ type, the result is a link to the file
> specified in ‘:file’ header argument. However, unlike plain ‘file’
> type, code block output is not written to the disk. The block is
> expected to generate the file by its side-effects only, as in the
> following example:
>
> #+begin_src shell :results file link :file "org-mode-unicorn.svg"
> wget -c "https://orgmode.org/resources/img/org-mode-unicorn.svg"
> #+end_src
>
> #+RESULTS:
> [[file:org-mode-unicorn.svg]]
>
> If ‘:file’ header argument is omitted, interpret source block
> result as the file path.
I have updated the patch and ‘:file’ header argument can be omitted
now, e.g.
#+begin_src python :results graphics file
import matplotlib.pyplot as plt
plt.plot([1,2,3,4,5])
plt.savefig('test.png')
return 'test.png'
#+end_src
In this case, `graphics' can be removed too.
> What if the user wants to use, for example, pyplot instead of
> matplotlib?
pyplot is a module of matplotlib. If you mean users want to use other
graphics libraries, they may advise `org-babel-python-save-graphics'
if they want to use `graphics' in the header argument. If necessary,
ob-python may support such libraries too.
[-- Attachment #2: 0001-ob-python-support-header-argument-results-file-graph.patch --]
[-- Type: text/x-patch, Size: 2360 bytes --]
From 8ea69d66552ee0217b7f5c8089b91424b92c3b5a Mon Sep 17 00:00:00 2001
From: Liu Hui <liuhui1610@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 | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/lisp/ob-python.el b/lisp/ob-python.el
index 0e0539d7a..6ee52313c 100644
--- a/lisp/ob-python.el
+++ b/lisp/ob-python.el
@@ -72,6 +72,9 @@ (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)
+ (ignore-errors
+ (org-babel-graphical-output-file params))))
(return-val (when (eq result-type 'value)
(cdr (assq :return params))))
(preamble (cdr (assq :preamble params)))
@@ -81,6 +84,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 +154,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
next prev parent reply other threads:[~2023-07-03 10:41 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-03 4:31 [PATCH] ob-python: support header argument `:results file graphics' Liu Hui
2023-07-03 9:28 ` Ihor Radchenko
2023-07-03 10:40 ` Liu Hui [this message]
2023-07-03 11:41 ` Ihor Radchenko
2023-07-03 13:23 ` Liu Hui
2023-07-04 11:29 ` Ihor Radchenko
2023-07-05 5:23 ` Jack Kamm
2023-07-05 11:05 ` Ihor Radchenko
2023-07-06 2:49 ` Jack Kamm
2023-07-07 10:53 ` Ihor Radchenko
2023-07-08 13:55 ` Jack Kamm
2023-07-09 9:12 ` Ihor Radchenko
2023-07-12 5:10 ` Jack Kamm
2023-07-12 8:38 ` Ihor Radchenko
2023-07-14 2:47 ` Jack Kamm
2023-07-05 8:09 ` Liu Hui
2023-07-05 4:55 ` Jack Kamm
2023-07-07 10:56 ` Ihor Radchenko
2023-07-05 5:13 ` Jack Kamm
2023-07-05 8:11 ` Liu Hui
2023-07-06 3:49 ` Jack Kamm
2023-07-06 9:54 ` Liu Hui
2023-07-08 13:59 ` Jack Kamm
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAOQTW-Oh=2_0qKAFrawMJqWQk+ZWWfx0m08YvLoVypWZdyhauQ@mail.gmail.com' \
--to=liuhui1610@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=yantar92@posteo.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).