bug#58713: 29.0.50; Completion/ElDoc/FFAP interferes with a running Python program

bug#58713: 29.0.50; Completion/ElDoc/FFAP interferes with a running Python program

[kobarity]

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

Hi,

When a Python program is sent to the Python Shell buffer using
`python-shell-send-buffer' or similar functions, it is run
asynchronously.  So it is possible to invoke Completion/ElDoc/FFAP in
the Python buffer while the program is running.  However, it leads to
several problems:

1. emacs -Q
2. Open the following Python file.

#+begin_src python
import time

for i in range(10):
    print(i)
    time.sleep(1)
#+end_src

3. C-u -1 M-x eldoc-mode (Disable ElDoc mode.)
4. C-c C-p (M-x run-python)
5. C-x o (Back to the Python mode buffer)
6. M-> (M-x end-of-buffer)
7. C-c C-c (M-x python-shell-send-buffer)
8. While the program is running, type "t".
9. C-M-i (M-x completion-at-point)

Output from the program will no longer be displayed and the Python
buffer cannot be manipulated until the program is completed or the
completion is canceled with C-g.

Similar problems occur with ElDoc/FFAP.

These problems are caused by the fact that
`python-shell-send-string-no-output' used by these features replaces
the process-filter.  So I think it is appropriate to disable
Completion/ElDoc/FFAP while a program is running.

Attached is a patch to disable Completion/ElDoc/FFAP when a proper
prompt is not received in the Python Shell buffer.

Best Regards,

--

In GNU Emacs 29.0.50 (build 7, x86_64-pc-linux-gnu, X toolkit, cairo
 version 1.16.0, Xaw scroll bars) of 2022-10-15 built on ubuntu
Repository revision: a06c54209499c3885c13a8d3eba7798ab3f0d688
Repository branch: master
System Description: Ubuntu 22.04.1 LTS

Configured using:
 'configure --without-libgmp'

Configured features:
ACL CAIRO FREETYPE GIF GLIB GNUTLS GSETTINGS HARFBUZZ JPEG LIBSELINUX
LIBXML2 MODULES NOTIFY INOTIFY PDUMPER PNG SECCOMP SOUND SQLITE3 THREADS
TIFF TOOLKIT_SCROLL_BARS X11 XDBE XIM XPM LUCID ZLIB

Important settings:
  value of $LANG: en_US.UTF-8
  locale-coding-system: utf-8-unix

Major mode: Python

Minor modes in effect:
  tooltip-mode: t
  global-eldoc-mode: t
  eldoc-mode: t
  show-paren-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  tool-bar-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  line-number-mode: t
  transient-mark-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t

Load-path shadows:
None found.

Features:
(shadow sort mail-extr emacsbug message mailcap yank-media puny dired
dired-loaddefs rfc822 mml mml-sec password-cache epa derived epg rfc6068
epg-config gnus-util text-property-search time-date mm-decode mm-bodies
mm-encode mail-parse rfc2231 mailabbrev gmm-utils mailheader sendmail
rfc2047 rfc2045 ietf-drums mm-util mail-prsvr mail-utils vc-hg vc-git
diff-mode vc-bzr vc-src vc-sccs vc-svn vc-cvs vc-rcs log-view easy-mmode
pcvs-util vc vc-dispatcher python json subr-x map project comint
ansi-osc ring cl-loaddefs cl-lib ansi-color term/screen term/xterm xterm
byte-opt gv bytecomp byte-compile cconv rmc iso-transl tooltip eldoc
paren electric uniquify ediff-hook vc-hooks lisp-float-type elisp-mode
mwheel term/x-win x-win term/common-win x-dnd tool-bar dnd fontset image
regexp-opt fringe tabulated-list replace newcomment text-mode lisp-mode
prog-mode register page tab-bar menu-bar rfn-eshadow isearch easymenu
timer select scroll-bar mouse jit-lock font-lock syntax font-core
term/tty-colors frame minibuffer nadvice seq simple cl-generic
indonesian philippine cham georgian utf-8-lang misc-lang vietnamese
tibetan thai tai-viet lao korean japanese eucjp-ms cp51932 hebrew greek
romanian slovak czech european ethiopic indian cyrillic chinese
composite emoji-zwj charscript charprop case-table epa-hook
jka-cmpr-hook help abbrev obarray oclosure cl-preloaded button loaddefs
faces cus-face macroexp files window text-properties overlay sha1 md5
base64 format env code-pages mule custom widget keymap
hashtable-print-readable backquote threads inotify dynamic-setting
system-font-setting font-render-setting cairo x-toolkit x multi-tty
make-network-process emacs)

Memory information:
((conses 16 66940 7163)
 (symbols 48 8205 0)
 (strings 32 23930 1490)
 (string-bytes 1 694497)
 (vectors 16 13452)
 (vector-slots 8 155649 7354)
 (floats 8 31 357)
 (intervals 56 229 0)
 (buffers 1000 12))

[-- Attachment #2: 0001-Disable-completion-ElDoc-FFAP-when-Python-program-is.patch --]
[-- Type: application/octet-stream, Size: 6546 bytes --]

From 21ab8249e22a46b704840d1ddd2699c50e8aadf8 Mon Sep 17 00:00:00 2001
From: kobarity <kobarity@gmail.com>
Date: Sat, 22 Oct 2022 21:36:15 +0900
Subject: [PATCH] Disable completion/ElDoc/FFAP when Python program is running

* lisp/progmodes/python.el (python-completion-at-point)
(python-ffap-module-path, python-eldoc--get-doc-at-point): Add check
using `python-util-comint-end-of-output-p'.
(python-util-comint-end-of-output-p): New function.
* test/lisp/progmodes/python-tests.el (python-tests-shell-wait-for-prompt):
Use `python-util-comint-end-of-output-p'.
(python-completion-at-point-while-running-1)
(python-ffap-module-path-1)
(python-ffap-module-path-while-running-1)
(python-eldoc--get-doc-at-point-1)
(python-eldoc--get-doc-at-point-while-running-1): New tests.
---
 lisp/progmodes/python.el            | 17 ++++++-
 test/lisp/progmodes/python-tests.el | 71 +++++++++++++++++++++++++++--
 2 files changed, 82 insertions(+), 6 deletions(-)

diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el
index 1119589423..cec0d54a44 100644
--- a/lisp/progmodes/python.el
+++ b/lisp/progmodes/python.el
@@ -4375,7 +4375,9 @@ python-completion-at-point
 `python-shell-send-buffer' from time to time so context in
 inferior Python process is updated properly."
   (let ((process (python-shell-get-process)))
-    (when process
+    (when (and process
+               (python-shell-with-shell-buffer
+                 (python-util-comint-end-of-output-p)))
       (python-shell-completion-at-point process))))
 
 (define-obsolete-function-alias
@@ -4800,6 +4802,8 @@ python-ffap-setup-code
 (defun python-ffap-module-path (module)
   "Function for `ffap-alist' to return path for MODULE."
   (when-let ((process (python-shell-get-process))
+             (ready (python-shell-with-shell-buffer
+                      (python-util-comint-end-of-output-p)))
              (module-file
               (python-shell-send-string-no-output
                (format "%s\nprint(__FFAP_get_module_path(%s))"
@@ -4918,7 +4922,9 @@ python-eldoc--get-doc-at-point
 returns will be used.  If not FORCE-PROCESS is passed what
 `python-shell-get-process' returns is used."
   (let ((process (or force-process (python-shell-get-process))))
-    (when process
+    (when (and process
+               (python-shell-with-shell-buffer
+                 (python-util-comint-end-of-output-p)))
       (let* ((input (or force-input
                         (python-eldoc--get-symbol-at-point)))
              (docstring
@@ -5664,6 +5670,13 @@ python-util-comint-last-prompt
          comint-last-prompt)
         (t nil)))
 
+(defun python-util-comint-end-of-output-p ()
+  "Return non-nil if the last prompt matches input prompt."
+  (when-let ((prompt (python-util-comint-last-prompt)))
+    (python-shell-comint-end-of-output-p
+     (buffer-substring-no-properties
+      (car prompt) (cdr prompt)))))
+
 (defun python-util-forward-comment (&optional direction)
   "Python mode specific version of `forward-comment'.
 Optional argument DIRECTION defines the direction to move to."
diff --git a/test/lisp/progmodes/python-tests.el b/test/lisp/progmodes/python-tests.el
index 81c9217c62..8330525394 100644
--- a/test/lisp/progmodes/python-tests.el
+++ b/test/lisp/progmodes/python-tests.el
@@ -46,10 +46,7 @@ python-tests-with-temp-buffer
 (defun python-tests-shell-wait-for-prompt ()
   "Wait for the prompt in the shell buffer."
   (python-shell-with-shell-buffer
-    (while (not (if-let ((prompt (python-util-comint-last-prompt)))
-                    (python-shell-comint-end-of-output-p
-                     (buffer-substring-no-properties
-                      (car prompt) (cdr prompt)))))
+    (while (not (python-util-comint-end-of-output-p))
       (sit-for 0.1))))
 
 (defmacro python-tests-with-temp-buffer-with-shell (contents &rest body)
@@ -4478,6 +4475,21 @@ python-completion-at-point-pdb-1
      (insert "u")
      (should-not (nth 2 (python-completion-at-point))))))
 
+(ert-deftest python-completion-at-point-while-running-1 ()
+  "Should not try to complete when a program is running in the Shell buffer."
+  (skip-unless (executable-find python-tests-shell-interpreter))
+  (python-tests-with-temp-buffer-with-shell
+   "
+import time
+
+time.sleep(3)
+"
+   (let ((inhibit-message t))
+     (python-shell-send-buffer)
+     (goto-char (point-max))
+     (insert "time.")
+     (should-not (with-timeout (1 t) (completion-at-point))))))
+
 (ert-deftest python-completion-at-point-native-1 ()
   (skip-unless (executable-find python-tests-shell-interpreter))
   (python-tests-with-temp-buffer-with-shell
@@ -4552,6 +4564,31 @@ python-completion-at-point-native-with-eldoc-1
 \f
 ;;; FFAP
 
+(ert-deftest python-ffap-module-path-1 ()
+  (skip-unless (executable-find python-tests-shell-interpreter))
+  (python-tests-with-temp-buffer-with-shell
+   "
+import abc
+"
+   (let ((inhibit-message t))
+     (python-shell-send-buffer)
+     (python-tests-shell-wait-for-prompt)
+     (should (file-exists-p (python-ffap-module-path "abc"))))))
+
+(ert-deftest python-ffap-module-path-while-running-1 ()
+  "Should not get module path when a program is running in the Shell buffer."
+  (skip-unless (executable-find python-tests-shell-interpreter))
+  (python-tests-with-temp-buffer-with-shell
+   "
+import abc
+import time
+
+time.sleep(3)
+"
+   (let ((inhibit-message t))
+     (python-shell-send-buffer)
+     (should-not (with-timeout (1 t) (python-ffap-module-path "abc"))))))
+
 \f
 ;;; Code check
 
@@ -4615,6 +4652,32 @@ python-eldoc--get-symbol-at-point-4
    (should (string= (python-eldoc--get-symbol-at-point)
                     "some_symbol"))))
 
+(ert-deftest python-eldoc--get-doc-at-point-1 ()
+  (skip-unless (executable-find python-tests-shell-interpreter))
+  (python-tests-with-temp-buffer-with-shell
+   "
+import time
+"
+   (let ((inhibit-message t))
+     (python-shell-send-buffer)
+     (python-tests-shell-wait-for-prompt)
+     (python-tests-look-at "time")
+     (should (python-eldoc--get-doc-at-point)))))
+
+(ert-deftest python-eldoc--get-doc-at-point-while-running-1 ()
+  "Should not get documentation when a program is running in the Shell buffer."
+  (skip-unless (executable-find python-tests-shell-interpreter))
+  (python-tests-with-temp-buffer-with-shell
+   "
+import time
+
+time.sleep(3)
+"
+   (let ((inhibit-message t))
+     (python-shell-send-buffer)
+     (python-tests-look-at "time")
+     (should-not (with-timeout (1 t) (python-eldoc--get-doc-at-point))))))
+
 \f
 ;;; Imenu
 
-- 
2.34.1

bug#58713: 29.0.50; Completion/ElDoc/FFAP interferes with a running Python program

[Eli Zaretskii]

> Date: Sat, 22 Oct 2022 21:45:09 +0900
> From: kobarity <kobarity@gmail.com>
> 
> When a Python program is sent to the Python Shell buffer using
> `python-shell-send-buffer' or similar functions, it is run
> asynchronously.  So it is possible to invoke Completion/ElDoc/FFAP in
> the Python buffer while the program is running.  However, it leads to
> several problems:
> 
> 1. emacs -Q
> 2. Open the following Python file.
> 
> #+begin_src python
> import time
> 
> for i in range(10):
>     print(i)
>     time.sleep(1)
> #+end_src
> 
> 3. C-u -1 M-x eldoc-mode (Disable ElDoc mode.)
> 4. C-c C-p (M-x run-python)
> 5. C-x o (Back to the Python mode buffer)
> 6. M-> (M-x end-of-buffer)
> 7. C-c C-c (M-x python-shell-send-buffer)
> 8. While the program is running, type "t".
> 9. C-M-i (M-x completion-at-point)
> 
> Output from the program will no longer be displayed and the Python
> buffer cannot be manipulated until the program is completed or the
> completion is canceled with C-g.
> 
> Similar problems occur with ElDoc/FFAP.
> 
> These problems are caused by the fact that
> `python-shell-send-string-no-output' used by these features replaces
> the process-filter.  So I think it is appropriate to disable
> Completion/ElDoc/FFAP while a program is running.
> 
> Attached is a patch to disable Completion/ElDoc/FFAP when a proper
> prompt is not received in the Python Shell buffer.

Thanks, installed.