From: Ihor Radchenko <yantar92@posteo.net>
To: Alain.Cochard@unistra.fr
Cc: Org Mode List <emacs-orgmode@gnu.org>
Subject: [RFC] :var x=list-name should be resolved into simple lists (item1 item2 ...); not nested ((item1) (item2) ...) (was: 2 'echo' bash instructions produce a table)
Date: Tue, 15 Nov 2022 06:00:04 +0000 [thread overview]
Message-ID: <87tu30dafv.fsf@localhost> (raw)
In-Reply-To: <87pmdqfao4.fsf@localhost>
[-- Attachment #1: Type: text/plain, Size: 803 bytes --]
Ihor Radchenko <yantar92@posteo.net> writes:
>> In section 16.4 (Environment of a Code Block)
>>
>> A simple named list.
>>
>> #+NAME: example-list
>> - simple
>> - not
>> - nested
>> - list
>>
>> #+BEGIN_SRC emacs-lisp :var x=example-list
>> (print x)
>> #+END_SRC
>>
>> #+RESULTS:
>> | simple | list |
>>
>> But if I evaluate the code, I get
>>
>> #+RESULTS:
>> | simple | (unordered (not) (nested)) |
>> | list | |
>
> Confirmed. Need to look into this.
The attached is a fix for this discrepancy with the manual.
However, it looks like at least ob-java already tried to work around the
erroneous return value of org-babel-read-list.
Hence, we at least need to announce this fix in ORG-NEWS.
Or maybe there are other objections?
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-ob-core-Resolve-named-list-references-to-simple-list.patch --]
[-- Type: text/x-patch, Size: 5924 bytes --]
From cc1dbc5ca61d04e8a52598feb031e24102575f0d Mon Sep 17 00:00:00 2001
Message-Id: <cc1dbc5ca61d04e8a52598feb031e24102575f0d.1668491919.git.yantar92@posteo.net>
From: Ihor Radchenko <yantar92@posteo.net>
Date: Tue, 15 Nov 2022 13:52:04 +0800
Subject: [PATCH] ob-core: Resolve named list references to simple lists
* lisp/ob-core.el (org-babel-read-list): Return a simple list instead
of list of lists. Document this in the docstring.
* testing/lisp/test-ob-java.el (ob-java/read-return-list):
(ob-java/read-list-return-array):
(ob-java/read-return-list-with-package): Fix tests assuming previous
behavior.
* testing/lisp/test-ob.el (test-ob/simple-variable-resolution): Add
new tests.
* etc/ORG-NEWS (List references in source block variable assignments
are now proper lists): Document the change.
This commit fixes the broken promise in the manual section 16.4
Environment of a Code Block where the named references to lists should
be converted to simple lists consisting of the top-level items.
The inconsistency existed for a while and possibly lurked into some
third-party packages. So, announcement in NEWS is required.
Reported-by: Alain.Cochard@unistra.fr
Link: https://orgmode.org/list/87pmdqfao4.fsf@localhost
---
etc/ORG-NEWS | 34 ++++++++++++++++++++++++++++++++++
lisp/ob-core.el | 11 +++++++++--
testing/lisp/test-ob-java.el | 10 +++++-----
testing/lisp/test-ob.el | 26 +++++++++++++++++++++++---
4 files changed, 71 insertions(+), 10 deletions(-)
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 04b5be64a..4e23ac0e3 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -701,6 +701,40 @@ If you prefer to keep the keybinding, you can add it back to
(define-key org-mode-map (kbd "C-c SPC") #'org-table-blank-field)
#+end_src
+*** List references in source block variable assignments are now proper lists
+
+List representation of named lists is now converted to a simple list
+as promised by the manual section [[info:org#Environment of a Code Block][org#Environment of a Code Block]].
+Previously, it was converted to a list of lists.
+
+Before:
+
+#+begin_src org
+,#+NAME: example-list
+- simple
+ - not
+ - nested
+- list
+
+,#+BEGIN_SRC emacs-lisp :var x=example-list :results value
+(format "%S" x)
+,#+END_SRC
+
+,#+RESULTS:
+: (("simple" (unordered ("not") ("nested"))) ("list"))
+#+end_src
+
+After:
+
+#+begin_src org
+,#+BEGIN_SRC emacs-lisp :var x=example-list :results value
+(format "%S" x)
+,#+END_SRC
+
+,#+RESULTS:
+: ("simple" "list")
+#+end_src
+
** New features
*** New citation engine
diff --git a/lisp/ob-core.el b/lisp/ob-core.el
index 1259909a0..3a07c10d5 100644
--- a/lisp/ob-core.el
+++ b/lisp/ob-core.el
@@ -2239,8 +2239,15 @@ (defun org-babel-read-table ()
(org-table-to-lisp)))
(defun org-babel-read-list ()
- "Read the list at point into emacs-lisp."
- (mapcar (lambda (el) (org-babel-read el 'inhibit-lisp-eval))
+ "Read the list at point into emacs-lisp.
+
+Return the list of strings representing top level items:
+
+ (item1 item2 ...)
+
+Only consider top level items. See Info node `(org)Environment of \
+a Code Block'."
+ (mapcar (lambda (el) (org-babel-read (car el) 'inhibit-lisp-eval))
(cdr (org-list-to-lisp))))
(defvar org-link-types-re)
diff --git a/testing/lisp/test-ob-java.el b/testing/lisp/test-ob-java.el
index 07540ed74..65b7259d3 100644
--- a/testing/lisp/test-ob-java.el
+++ b/testing/lisp/test-ob-java.el
@@ -379,8 +379,8 @@ (ert-deftest ob-java/read-return-list ()
"#+begin_src java :dir 'nil :var a=java_list :results value silent
import java.util.List;
import java.util.Arrays;
-List<String> b = Arrays.asList(a.get(0).get(0),
- a.get(1).get(0));
+List<String> b = Arrays.asList(a.get(0),
+ a.get(1));
return b;
#+end_src
@@ -394,7 +394,7 @@ (ert-deftest ob-java/read-list-return-array ()
"Read a list and return an array."
(org-test-with-temp-text
"#+begin_src java :dir 'nil :var a=java_list :results value silent
-String[] b = {a.get(0).get(0), a.get(1).get(0)};
+String[] b = {a.get(0), a.get(1)};
return b;
#+end_src
@@ -411,8 +411,8 @@ (ert-deftest ob-java/read-return-list-with-package ()
package pkg;
import java.util.List;
import java.util.Arrays;
-List<String> b = Arrays.asList(a.get(0).get(0),
- a.get(1).get(0));
+List<String> b = Arrays.asList(a.get(0),
+ a.get(1));
return b;
#+end_src
diff --git a/testing/lisp/test-ob.el b/testing/lisp/test-ob.el
index 4beaecf7b..e4090d6d8 100644
--- a/testing/lisp/test-ob.el
+++ b/testing/lisp/test-ob.el
@@ -204,7 +204,27 @@ (ert-deftest test-ob/simple-variable-resolution ()
(forward-line 5)
(should (string= ": 4" (buffer-substring
(point-at-bol)
- (point-at-eol))))))
+ (point-at-eol)))))
+ ;; Test reading lists.
+ (org-test-with-temp-text-in-file "
+
+#+NAME: example-list
+- simple
+ - not
+ - nested
+- list
+
+<point>#+BEGIN_SRC emacs-lisp :var x=example-list
+(print x)
+#+END_SRC"
+
+ (should (equal '("simple" "list") (org-babel-execute-src-block)))
+ (forward-line 5)
+ (should (string=
+ "| simple | list |"
+ (buffer-substring
+ (point-at-bol)
+ (point-at-eol))))))
(ert-deftest test-ob/block-content-resolution ()
"Test block content resolution."
@@ -218,8 +238,8 @@ (ert-deftest test-ob/block-content-resolution ()
#+begin_src emacs-lisp :var four=four[]
(length (eval (car (read-from-string four))))
#+end_src"
- (org-babel-next-src-block 2)
- (should (= 4 (org-babel-execute-src-block)))))
+ (org-babel-next-src-block 2)
+ (should (= 4 (org-babel-execute-src-block)))))
(ert-deftest test-ob/cons-cell-as-variable ()
"Test that cons cell can be assigned as variable."
--
2.35.1
[-- Attachment #3: Type: text/plain, Size: 224 bytes --]
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
next prev parent reply other threads:[~2022-11-15 6:00 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-06 6:58 2 'echo' bash instructions produce a table Alain.Cochard
2022-11-07 2:31 ` Ihor Radchenko
2022-11-13 20:41 ` Alain.Cochard
2022-11-14 3:59 ` Ihor Radchenko
2022-11-15 6:00 ` Ihor Radchenko [this message]
2022-11-26 1:54 ` [RFC] :var x=list-name should be resolved into simple lists (item1 item2 ...); not nested ((item1) (item2) ...) (was: 2 'echo' bash instructions produce a table) Ihor Radchenko
2022-11-16 1:24 ` 2 'echo' bash instructions produce a table Ihor Radchenko
2022-11-21 9:04 ` Ihor Radchenko
2022-11-21 9:05 ` Ihor Radchenko
2022-11-16 16:35 ` Alain.Cochard
2022-11-19 12:28 ` Rudolf Adamkovič
2022-11-20 5:05 ` Ihor Radchenko
2022-11-22 8:16 ` Ihor Radchenko
2022-11-22 19:13 ` Alain.Cochard
2022-11-24 1:55 ` Ihor Radchenko
2022-11-22 8:31 ` [RFC] Backend vs. back-end (was: 2 'echo' bash instructions produce a table) Ihor Radchenko
2023-02-20 10:07 ` Ihor Radchenko
2023-02-20 14:54 ` Alain.Cochard
2023-04-06 9:57 ` Ihor Radchenko
2023-04-20 12:17 ` Ihor Radchenko
2023-04-06 23:43 ` Samuel Wales
2022-11-22 8:37 ` [BUG] Make source block auto-completion work for all the loaded babel backends " Ihor Radchenko
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=87tu30dafv.fsf@localhost \
--to=yantar92@posteo.net \
--cc=Alain.Cochard@unistra.fr \
--cc=emacs-orgmode@gnu.org \
/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).