From: kobarity <kobarity@gmail.com>
To: 58389@debbugs.gnu.org
Subject: bug#58389: 29.0.50; Python completion fails under certain conditions
Date: Sun, 09 Oct 2022 15:58:11 +0900 [thread overview]
Message-ID: <eke7h70d8ovw.wl-kobarity@gmail.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 5153 bytes --]
Hi,
Completion in Python mode buffer fails under certain conditions:
- non-native completion is used,
- ElDoc mode is used, or
- FFAP is used.
Here is how to reproduce the problem of non-native completion:
1. emacs -Q
2. Open the following Python file.
#+begin_src python
import sys
#+end_src
3. Use M-x customize-variable to disable
python-shell-completion-native-enable
4. C-u -1 M-x eldoc-mode (Disable ElDoc mode)
5. C-c C-p (M-x run-python)
6. C-x o (Back to the Python mode buffer)
7. C-c C-c (M-x python-shell-send-buffer)
8. C-n (M-x next-line)
9. Type "sys."
10. C-M-i (M-x completion-at-point)
11. Completions are shown in *Completions* buffer.
12. Type "e"
13. C-M-i (M-x completion-at-point)
14. "No match" is shown in the minibuffer.
This does not happen when native completion is enabled and ElDoc mode
is disabled.
The following steps show the problem of ElDoc mode:
1. emacs -Q
2. Open the following Python file.
#+begin_src python
import sys
#+end_src
3. Make sure that ElDoc mode is enabled.
4. C-c C-p (M-x run-python)
5. Make sure that "Shell native completion is enabled." is shown in
the minibuffer.
6. C-x o (Back to the Python mode buffer)
7. C-c C-c (M-x python-shell-send-buffer)
8. C-n (M-x next-line)
9. Type "sys."
10. Wait for 1-2 seconds to make sure ElDoc function is run by the
idle timer.
11. C-M-i (M-x completion-at-point)
12. "No match" is shown in the minibuffer.
The problem with FFAP can be reproduced with similar steps.
The direct cause of these problems is that
`python-util-comint-last-prompt' returns nil, which is not supposed in
`python-shell-completion-at-point'.
`python-util-comint-last-prompt' is a wrapper to return
`comint-last-prompt'. `comint-last-prompt' is initialized to nil in
`comint-snapshot-last-prompt' and is set in `comint-output-filter'.
However, `python-shell-send-string-no-output' which is used by the
features mentioned above temporarily changes the `process-filter' to
redirect the output. This causes `comint-output-filter' to not be
called and `comint-last-prompt' to remain nil.
I think `comint-snapshot-last-prompt' should not be called as long as
`comint-output-filter' is not called and the Inferior Python Shell
buffer is not changed. Attached is a patch to fix this issue.
Best Regards,
--
In GNU Emacs 29.0.50 (build 5, x86_64-pc-linux-gnu, X toolkit, cairo
version 1.16.0, Xaw scroll bars) of 2022-10-09 built on ubuntu
Repository revision: 9d47364634f96b2f2651a7f3942f8f87b920f02d
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: Lisp Interaction
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
indent-tabs-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 subr-x mm-decode
mm-bodies mm-encode mail-parse rfc2231 mailabbrev gmm-utils mailheader
cl-loaddefs cl-lib sendmail rfc2047 rfc2045 ietf-drums mm-util
mail-prsvr mail-utils 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 46148 9345)
(symbols 48 5790 0)
(strings 32 15049 1660)
(string-bytes 1 427012)
(vectors 16 8356)
(vector-slots 8 105418 10463)
(floats 8 24 349)
(intervals 56 216 0)
(buffers 1000 11))
[-- Attachment #2: 0001-Fix-Python-completion-failure-under-certain-conditio.patch --]
[-- Type: application/octet-stream, Size: 5239 bytes --]
From 6bd4d7fdf16cda18a921c2b63221fc2aac84fb8c Mon Sep 17 00:00:00 2001
From: kobarity <kobarity@gmail.com>
Date: Sun, 9 Oct 2022 15:39:52 +0900
Subject: [PATCH] Fix Python completion failure under certain conditions
* lisp/progmodes/python.el (python-shell-send-string-no-output):
Invalidate `comint-snapshot-last-prompt'.
* test/lisp/progmodes/python-tests.el (python-tests-shell-wait-for-prompt):
New helper function.
(python-tests-with-temp-buffer-with-shell): New helper macro.
(python-shell-completion-1, python-shell-completion-native-1)
(python-shell-completion-native-with-ffap-1)
(python-shell-completion-native-with-eldoc-1): New tests.
---
lisp/progmodes/python.el | 2 +
test/lisp/progmodes/python-tests.el | 90 +++++++++++++++++++++++++++++
2 files changed, 92 insertions(+)
diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el
index 80c5b31b6e..9f29eb417e 100644
--- a/lisp/progmodes/python.el
+++ b/lisp/progmodes/python.el
@@ -3417,6 +3417,8 @@ python-shell-send-string-no-output
(lambda (_proc str)
(with-current-buffer (process-buffer process)
(python-shell-output-filter str))))
+ ((symbol-function 'comint-snapshot-last-prompt)
+ #'ignore)
(python-shell-output-filter-in-progress t)
(inhibit-quit t))
(or
diff --git a/test/lisp/progmodes/python-tests.el b/test/lisp/progmodes/python-tests.el
index fdaedb5fd7..eed9c18ede 100644
--- a/test/lisp/progmodes/python-tests.el
+++ b/test/lisp/progmodes/python-tests.el
@@ -43,6 +43,34 @@ python-tests-with-temp-buffer
(goto-char (point-min))
,@body)))
+(defun python-tests-shell-wait-for-prompt ()
+ "Wait for the prompt in the shell buffer."
+ (with-current-buffer (python-shell-get-buffer)
+ (while (not (python-util-comint-last-prompt))
+ (sit-for 0.1))))
+
+(defmacro python-tests-with-temp-buffer-with-shell (contents &rest body)
+ "Create a `python-mode' enabled temp buffer with CONTENTS and `run-python'.
+BODY is code to be executed within the temp buffer. Point is
+always located at the beginning of buffer. Native completion is
+turned off. Shell buffer will be killed on exit."
+ (declare (indent 1) (debug t))
+ `(with-temp-buffer
+ (let ((python-indent-guess-indent-offset nil)
+ (python-shell-completion-native-enable nil))
+ (python-mode)
+ (unwind-protect
+ (progn
+ (run-python nil t)
+ (insert ,contents)
+ (goto-char (point-min))
+ (python-tests-shell-wait-for-prompt)
+ ,@body)
+ (when (python-shell-get-buffer)
+ (python-shell-with-shell-buffer
+ (let (kill-buffer-hook kill-buffer-query-functions)
+ (kill-buffer))))))))
+
(defmacro python-tests-with-temp-file (contents &rest body)
"Create a `python-mode' enabled file with CONTENTS.
BODY is code to be executed within the temp buffer. Point is
@@ -4365,6 +4393,68 @@ python-shell-completion-native-interpreter-disabled-p-1
(python-shell-interpreter "/some/path/to/bin/pypy"))
(should (python-shell-completion-native-interpreter-disabled-p))))
+(ert-deftest python-shell-completion-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)
+ (goto-char (point-max))
+ (insert "abc.")
+ (should (completion-at-point))
+ (insert "A")
+ (should (completion-at-point)))))
+
+(ert-deftest python-shell-completion-native-1 ()
+ (skip-unless (executable-find python-tests-shell-interpreter))
+ (python-tests-with-temp-buffer-with-shell
+ "
+import abc
+"
+ (let ((inhibit-message t))
+ (python-shell-completion-native-turn-on)
+ (python-shell-send-buffer)
+ (python-tests-shell-wait-for-prompt)
+ (goto-char (point-max))
+ (insert "abc.")
+ (should (completion-at-point))
+ (insert "A")
+ (should (completion-at-point)))))
+
+(ert-deftest python-shell-completion-native-with-ffap-1 ()
+ (skip-unless (executable-find python-tests-shell-interpreter))
+ (python-tests-with-temp-buffer-with-shell
+ "
+import abc
+"
+ (let ((inhibit-message t))
+ (python-shell-completion-native-turn-on)
+ (python-shell-send-buffer)
+ (python-tests-shell-wait-for-prompt)
+ (goto-char (point-max))
+ (insert "abc.")
+ ;; This is called when FFAP is enabled and a find-file function is called.
+ (python-ffap-module-path "abc.")
+ (should (completion-at-point)))))
+
+(ert-deftest python-shell-completion-native-with-eldoc-1 ()
+ (skip-unless (executable-find python-tests-shell-interpreter))
+ (python-tests-with-temp-buffer-with-shell
+ "
+import abc
+"
+ (let ((inhibit-message t))
+ (python-shell-completion-native-turn-on)
+ (python-shell-send-buffer)
+ (python-tests-shell-wait-for-prompt)
+ (goto-char (point-max))
+ (insert "abc.")
+ ;; This is called by idle-timer when ElDoc is enabled.
+ (python-eldoc-function)
+ (should (completion-at-point)))))
\f
--
2.34.1
next reply other threads:[~2022-10-09 6:58 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-10-09 6:58 kobarity [this message]
2022-10-09 11:23 ` bug#58389: 29.0.50; Python completion fails under certain conditions kobarity
2022-10-10 13:29 ` kobarity
2022-10-11 0:29 ` Lars Ingebrigtsen
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.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=eke7h70d8ovw.wl-kobarity@gmail.com \
--to=kobarity@gmail.com \
--cc=58389@debbugs.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.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).