Re: Extraneous output from Python code blocks using :session option

[Kyle Meyer <kyle@kyleam.com>]

[-- Attachment #1: Type: text/plain, Size: 593 bytes --]

Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:
> Hello,
>
> Kyle Meyer <kyle@kyleam.com> writes:
>
>> I've attached two patches.  The first one is a proposed way to deal with
>> the indentation issues in sessions.  It is very similar to what
>> python.el does for multiline input (use a temporary file and then
>> execute that from the shell).  The second is an update of my previous
>> patch to remove shell prompt characters that are leaking into the
>> output.
>
> Thank you.
>
> I'll just comment about code, not functionality.

Thanks for your comments.  I've attached updated patches.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-ob-python.el-Allow-indented-code-in-sessions.patch --]
[-- Type: text/x-diff, Size: 2593 bytes --]

From 41aae465038fd789fe92611ecf1fae7e9d08ab5b Mon Sep 17 00:00:00 2001
From: Kyle Meyer <kyle@kyleam.com>
Date: Fri, 13 Mar 2015 02:45:04 -0400
Subject: [PATCH 1/2] ob-python.el: Allow indented code in sessions

* lisp/ob-python.el (org-babel-python-evaluate-session): Recognize
indented code in session and treat it differently to avoid syntax
errors.

For session blocks with results set to 'output', go through an
intermediate file when there is indented code to prevent
indentation-related errors when sending code to the Python shell.  For
session blocks with results set to 'value', issue an user-error.
These (usually) would have resulted in a syntax error in the shell
anyway, and the '_' variable can't be used to get the last value here
(as it is for non-indented code) because it isn't set when executing
the code through a file.
---
 lisp/ob-python.el | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/lisp/ob-python.el b/lisp/ob-python.el
index dd3cc66..0dc74ca 100644
--- a/lisp/ob-python.el
+++ b/lisp/ob-python.el
@@ -238,6 +238,14 @@ (defconst org-babel-python-pp-wrapper-method
 
 open('%s', 'w').write( pprint.pformat(main()) )")
 
+(defconst org-babel-python-indented-lines-session-method
+  (concat "fname= '%s'; fh = open(fname); "
+	  "exec(compile(fh.read(), fname, 'exec')); "
+	  "fh.close()")
+  "Single line to execute indented Python code in session.
+%s will be formatted with the file name of the file containing
+the code.")
+
 (defun org-babel-python-evaluate
   (session body &optional result-type result-params preamble)
   "Evaluate BODY as Python code."
@@ -303,6 +311,13 @@ (defun org-babel-python-evaluate-session
 		       (mapc (lambda (line) (insert line) (funcall send-wait))
 			     (split-string body "[\r\n]"))
 		       (funcall send-wait)))
+	 (indented-p (org-string-match-p "^[ \t]" body))
+	 (body (if indented-p
+		   (let ((tmp-file (org-babel-temp-file "python-")))
+		     (with-temp-file tmp-file (insert body))
+		     (format org-babel-python-indented-lines-session-method
+			     tmp-file))
+		 body))
          (results
           (case result-type
             (output
@@ -317,6 +332,8 @@ (defun org-babel-python-evaluate-session
                  (funcall send-wait))
                2) "\n"))
             (value
+	     (when indented-p
+	       (user-error "Value output limited to unindented lines with session"))
              (let ((tmp-file (org-babel-temp-file "python-")))
                (org-babel-comint-with-output
                    (session org-babel-python-eoe-indicator nil body)
-- 
2.3.1


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0002-ob-python.el-Strip-leading-session-characters.patch --]
[-- Type: text/x-diff, Size: 2161 bytes --]

From 28b6a003e4ae1dbb1474350203444e76df9e8572 Mon Sep 17 00:00:00 2001
From: Kyle Meyer <kyle@kyleam.com>
Date: Fri, 13 Mar 2015 02:46:38 -0400
Subject: [PATCH 2/2] ob-python.el: Strip leading session characters

* lisp/ob-python.el (org-babel-python-evaluate-session): Strip extra leading
  "..." and ">>>" from session output.
---
 lisp/ob-python.el | 30 ++++++++++++++++++++----------
 1 file changed, 20 insertions(+), 10 deletions(-)

diff --git a/lisp/ob-python.el b/lisp/ob-python.el
index 0dc74ca..e976d9c 100644
--- a/lisp/ob-python.el
+++ b/lisp/ob-python.el
@@ -321,16 +321,17 @@ (defun org-babel-python-evaluate-session
          (results
           (case result-type
             (output
-             (mapconcat
-              #'org-babel-trim
-              (butlast
-               (org-babel-comint-with-output
-                   (session org-babel-python-eoe-indicator t body)
-                 (funcall input-body body)
-                 (funcall send-wait) (funcall send-wait)
-                 (insert org-babel-python-eoe-indicator)
-                 (funcall send-wait))
-               2) "\n"))
+	     (org-babel-python--strip-session-chars
+	      (mapconcat
+	       #'org-babel-chomp
+	       (butlast
+		(org-babel-comint-with-output
+		    (session org-babel-python-eoe-indicator t body)
+		  (funcall input-body body)
+		  (funcall send-wait) (funcall send-wait)
+		  (insert org-babel-python-eoe-indicator)
+		  (funcall send-wait))
+		2) "\n")))
             (value
 	     (when indented-p
 	       (user-error "Value output limited to unindented lines with session"))
@@ -356,6 +357,15 @@ (defun org-babel-python-read-string (string)
       (match-string 1 string)
     string))
 
+(defun org-babel-python--strip-session-chars (string)
+  "Remove leading '>>>' and '...' from STRING.
+`org-babel-comint-with-output' splits the Python session output
+by `comint-prompt-regexp' (which includes '>>>' and '...'), but,
+in some situations, these still make it through at the start of
+the output string."
+  (replace-regexp-in-string "\\`\\s-*\n\\(>>> \\|\\.\\.\\. \\)*" ""
+			    string))
+
 (provide 'ob-python)
 
 
-- 
2.3.1


[-- Attachment #4: Type: text/plain, Size: 9 bytes --]


--
Kyle