bug#63552: 29.0.91; M-x completion-predicate does not account for python-ts-mode

bug#63552: 29.0.91; M-x completion-predicate does not account for python-ts-mode

[Basil Contovounesios via Bug reports for GNU Emacs, the Swiss army knife of text editors]

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

Severity: minor
Tags: patch

At the time of https://bugs.gnu.org/57184 python-ts-mode did not yet
exist, so the completion-predicates added to python.el as part of that
report understandably assumed only python-mode exists.

Here's what that means in practice:

0. emacs -Q
1. (setq read-extended-command-predicate
         #'command-completion-default-include-p)
2. C-x C-e
3. M-x python-ts-mode RET
4. M-x python-sort TAB
   => [No match]

And yet python-sort-imports is present in the local map:

5. C-g
6. C-h f python-sort-imports RET
   => It is bound to C-c TAB s.

By contrast, in python-mode:

7. M-x python-mode RET
8. M-x python-sort TAB
   => Completes to python-sort-imports

The following patch fixes this by associating M-x completion with
python-base-mode rather than python-mode:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Fix-M-x-completion-predicate-under-python-ts-mode.patch --]
[-- Type: text/x-diff, Size: 3681 bytes --]

From e71f85ef40e99e8ebc65b7907c5d487d47b0a66f Mon Sep 17 00:00:00 2001
From: "Basil L. Contovounesios" <contovob@tcd.ie>
Date: Mon, 15 May 2023 16:28:56 +0100
Subject: [PATCH] Fix M-x completion-predicate under python-ts-mode

* lisp/progmodes/python.el:
(python-skeleton-define): Filter M-x completion based on
python-base-mode instead of python-mode.  This allows for
python-ts-mode as well.  Use command-modes as a shorthand for
completion-predicate.
(python--completion-predicate, python-shell--completion-predicate):
Remove accordingly; no longer used.
(python-define-auxiliary-skeleton): Prefer function-put over put.
---
 lisp/progmodes/python.el | 22 ++++++----------------
 1 file changed, 6 insertions(+), 16 deletions(-)

diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el
index bbabce80b4d..92ac84ff099 100644
--- a/lisp/progmodes/python.el
+++ b/lisp/progmodes/python.el
@@ -4964,11 +4964,6 @@ 'python-mode-skeleton-abbrev-table
                       (not (python-syntax-comment-or-string-p))
                       python-skeleton-autoinsert)))
 
-(defun python--completion-predicate (_ buffer)
-  (provided-mode-derived-p
-   (buffer-local-value 'major-mode buffer)
-   'python-mode))
-
 (defmacro python-skeleton-define (name doc &rest skel)
   "Define a `python-mode' skeleton using NAME DOC and SKEL.
 The skeleton will be bound to python-skeleton-NAME and will
@@ -4977,7 +4972,7 @@ python-skeleton-define
   (let* ((name (symbol-name name))
          (function-name (intern (concat "python-skeleton-" name))))
     `(progn
-       (put ',function-name 'completion-predicate #'python--completion-predicate)
+       (function-put ',function-name 'command-modes '(python-base-mode))
        (define-abbrev python-mode-skeleton-abbrev-table
          ,name "" ',function-name :system t)
        (setq python-skeleton-available
@@ -5004,7 +4999,7 @@ python-define-auxiliary-skeleton
             `(< ,(format "%s:" name) \n \n
                 > _ \n)))
     `(progn
-       (put ',function-name 'completion-predicate #'ignore)
+       (function-put ',function-name 'completion-predicate #'ignore)
        (define-skeleton ,function-name
          ,(or doc
               (format "Auxiliary skeleton for %s statement." name))
@@ -6752,7 +6747,7 @@ python-ts-mode
     (add-to-list 'interpreter-mode-alist '("python[0-9.]*" . python-ts-mode))))
 
 ;;; Completion predicates for M-x
-;; Commands that only make sense when editing Python code
+;; Commands that only make sense when editing Python code.
 (dolist (sym '(python-add-import
                python-check
                python-fill-paragraph
@@ -6786,12 +6781,7 @@ python-ts-mode
                python-shell-send-defun
                python-shell-send-statement
                python-sort-imports))
-  (put sym 'completion-predicate #'python--completion-predicate))
-
-(defun python-shell--completion-predicate (_ buffer)
-  (provided-mode-derived-p
-   (buffer-local-value 'major-mode buffer)
-   'python-mode 'inferior-python-mode))
+  (function-put sym 'command-modes '(python-base-mode)))
 
 ;; Commands that only make sense in the Python shell or when editing
 ;; Python code.
@@ -6806,8 +6796,8 @@ python-shell--completion-predicate
                python-shell-font-lock-turn-off
                python-shell-font-lock-turn-on
                python-shell-package-enable
-               python-shell-completion-complete-or-indent  ))
-  (put sym 'completion-predicate #'python-shell--completion-predicate))
+               python-shell-completion-complete-or-indent))
+  (function-put sym 'command-modes '(python-base-mode inferior-python-mode)))
 
 (provide 'python)
 
-- 
2.34.1


[-- Attachment #3: Type: text/plain, Size: 3359 bytes --]


WDYT?

Thanks,

-- 
Basil

In GNU Emacs 29.0.91 (build 1, x86_64-pc-linux-gnu, X toolkit, cairo
 version 1.16.0, Xaw3d scroll bars) of 2023-05-17 built on blc
Repository revision: b5bfd808c6b40f47fdef8eb9986bc3127ca63c12
Repository branch: wt/emacs-29
Windowing system distributor 'The X.Org Foundation', version 11.0.12101004
System Description: Ubuntu 22.04.2 LTS

Configured using:
 'configure CC=gcc-12 'CFLAGS=-Og -ggdb3' --prefix=/home/bic/.local
 --with-program-suffix=-29 --with-file-notification=yes --with-x
 --with-x-toolkit=lucid'

Configured features:
ACL CAIRO DBUS FREETYPE GIF GLIB GMP GNUTLS GPM GSETTINGS HARFBUZZ JPEG
JSON LCMS2 LIBOTF LIBSELINUX LIBSYSTEMD LIBXML2 M17N_FLT MODULES NOTIFY
INOTIFY PDUMPER PNG RSVG SECCOMP SOUND SQLITE3 THREADS TIFF
TOOLKIT_SCROLL_BARS TREE_SITTER WEBP X11 XAW3D XDBE XIM XINPUT2 XPM
LUCID ZLIB

Important settings:
  value of $LC_MONETARY: en_IE.UTF-8
  value of $LC_NUMERIC: en_IE.UTF-8
  value of $LC_TIME: en_IE.UTF-8
  value of $LANG: en_GB.UTF-8
  value of $XMODIFIERS: @im=ibus
  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 subr-x mm-decode
mm-bodies mm-encode mail-parse rfc2231 mailabbrev gmm-utils mailheader
sendmail rfc2047 rfc2045 ietf-drums mm-util mail-prsvr mail-utils python
rx project byte-opt gv bytecomp byte-compile pcase treesit cl-seq comint
ansi-osc ring cl-loaddefs cl-lib ansi-color rmc iso-transl tooltip cconv
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
theme-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 dbusbind inotify lcms2
dynamic-setting system-font-setting font-render-setting cairo x-toolkit
xinput2 x multi-tty make-network-process emacs)

Memory information:
((conses 16 55041 6025)
 (symbols 48 7135 0)
 (strings 32 20473 1599)
 (string-bytes 1 602759)
 (vectors 16 13421)
 (vector-slots 8 186939 9110)
 (floats 8 27 35)
 (intervals 56 274 0)
 (buffers 984 10))

bug#63552: 29.0.91; M-x completion-predicate does not account for python-ts-mode

[Eli Zaretskii]

> Cc: Augusto Stoffel <arstoffel@gmail.com>
> Date: Wed, 17 May 2023 12:54:56 +0100
> From:  Basil Contovounesios via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> 
> At the time of https://bugs.gnu.org/57184 python-ts-mode did not yet
> exist, so the completion-predicates added to python.el as part of that
> report understandably assumed only python-mode exists.
> 
> Here's what that means in practice:
> 
> 0. emacs -Q
> 1. (setq read-extended-command-predicate
>          #'command-completion-default-include-p)
> 2. C-x C-e
> 3. M-x python-ts-mode RET
> 4. M-x python-sort TAB
>    => [No match]
> 
> And yet python-sort-imports is present in the local map:
> 
> 5. C-g
> 6. C-h f python-sort-imports RET
>    => It is bound to C-c TAB s.
> 
> By contrast, in python-mode:
> 
> 7. M-x python-mode RET
> 8. M-x python-sort TAB
>    => Completes to python-sort-imports
> 
> The following patch fixes this by associating M-x completion with
> python-base-mode rather than python-mode:

Thanks.

We need to fix tis on the emacs-29 branch, so I wonder whether the fix
can be simpler?  After all, we just need to test one more major mode,
right?

If a simpler fix is less clean, we could install a simpler change on
emacs-29 and a cleaner one on master.

bug#63552: 29.0.91; M-x completion-predicate does not account for python-ts-mode

[Basil Contovounesios via Bug reports for GNU Emacs, the Swiss army knife of text editors]

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

Eli Zaretskii [2023-05-17 15:40 +0300] wrote:

> We need to fix tis on the emacs-29 branch, so I wonder whether the fix
> can be simpler?  After all, we just need to test one more major mode,
> right?

Right.  How's this for emacs-29:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Fix-M-x-completion-predicate-under-python-ts-mode.patch --]
[-- Type: text/x-diff, Size: 1392 bytes --]

From 07a1869671a7a7bd3a24bb3605f5b4bb88469405 Mon Sep 17 00:00:00 2001
From: "Basil L. Contovounesios" <contovob@tcd.ie>
Date: Wed, 17 May 2023 13:48:09 +0100
Subject: [PATCH] Fix M-x completion-predicate under python-ts-mode

* lisp/progmodes/python.el (python--completion-predicate)
(python-shell--completion-predicate): Filter M-x completion based on
python-base-mode instead of python-mode.  This allows for
python-ts-mode as well (bug#63552).
---
 lisp/progmodes/python.el | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el
index bbabce80b4d..f810f1e2164 100644
--- a/lisp/progmodes/python.el
+++ b/lisp/progmodes/python.el
@@ -4967,7 +4967,7 @@ 'python-mode-skeleton-abbrev-table
 (defun python--completion-predicate (_ buffer)
   (provided-mode-derived-p
    (buffer-local-value 'major-mode buffer)
-   'python-mode))
+   'python-base-mode))
 
 (defmacro python-skeleton-define (name doc &rest skel)
   "Define a `python-mode' skeleton using NAME DOC and SKEL.
@@ -6791,7 +6791,7 @@ python-ts-mode
 (defun python-shell--completion-predicate (_ buffer)
   (provided-mode-derived-p
    (buffer-local-value 'major-mode buffer)
-   'python-mode 'inferior-python-mode))
+   'python-base-mode 'inferior-python-mode))
 
 ;; Commands that only make sense in the Python shell or when editing
 ;; Python code.
-- 
2.34.1


[-- Attachment #3: Type: text/plain, Size: 167 bytes --]


> If a simpler fix is less clean, we could install a simpler change on
> emacs-29 and a cleaner one on master.

And this for master, once the patch above is merged:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #4: 0001-Simplify-python.el-completion-predicate.patch --]
[-- Type: text/x-diff, Size: 3579 bytes --]

From 17519e4dbdc1b90c6fb9d02297a00e1e30e7c3b0 Mon Sep 17 00:00:00 2001
From: "Basil L. Contovounesios" <contovob@tcd.ie>
Date: Wed, 17 May 2023 13:53:09 +0100
Subject: [PATCH] Simplify python.el completion-predicate

* lisp/progmodes/python.el:
(python-skeleton-define): Use command-modes as a shorthand for
completion-predicate (bug#63552).
(python--completion-predicate, python-shell--completion-predicate):
Remove accordingly; no longer used.
(python-define-auxiliary-skeleton): Prefer function-put over put.
---
 lisp/progmodes/python.el | 22 ++++++----------------
 1 file changed, 6 insertions(+), 16 deletions(-)

diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el
index 0ddce92b21e..4f57eda3cfc 100644
--- a/lisp/progmodes/python.el
+++ b/lisp/progmodes/python.el
@@ -5029,11 +5029,6 @@ 'python-mode-skeleton-abbrev-table
                       (not (python-syntax-comment-or-string-p))
                       python-skeleton-autoinsert)))
 
-(defun python--completion-predicate (_ buffer)
-  (provided-mode-derived-p
-   (buffer-local-value 'major-mode buffer)
-   'python-base-mode))
-
 (defmacro python-skeleton-define (name doc &rest skel)
   "Define a `python-mode' skeleton using NAME DOC and SKEL.
 The skeleton will be bound to python-skeleton-NAME and will
@@ -5042,7 +5037,7 @@ python-skeleton-define
   (let* ((name (symbol-name name))
          (function-name (intern (concat "python-skeleton-" name))))
     `(progn
-       (put ',function-name 'completion-predicate #'python--completion-predicate)
+       (function-put ',function-name 'command-modes '(python-base-mode))
        (define-abbrev python-mode-skeleton-abbrev-table
          ,name "" ',function-name :system t)
        (setq python-skeleton-available
@@ -5069,7 +5064,7 @@ python-define-auxiliary-skeleton
             `(< ,(format "%s:" name) \n \n
                 > _ \n)))
     `(progn
-       (put ',function-name 'completion-predicate #'ignore)
+       (function-put ',function-name 'completion-predicate #'ignore)
        (define-skeleton ,function-name
          ,(or doc
               (format "Auxiliary skeleton for %s statement." name))
@@ -6817,7 +6812,7 @@ python-ts-mode
     (add-to-list 'interpreter-mode-alist '("python[0-9.]*" . python-ts-mode))))
 
 ;;; Completion predicates for M-x
-;; Commands that only make sense when editing Python code
+;; Commands that only make sense when editing Python code.
 (dolist (sym '(python-add-import
                python-check
                python-fill-paragraph
@@ -6851,12 +6846,7 @@ python-ts-mode
                python-shell-send-defun
                python-shell-send-statement
                python-sort-imports))
-  (put sym 'completion-predicate #'python--completion-predicate))
-
-(defun python-shell--completion-predicate (_ buffer)
-  (provided-mode-derived-p
-   (buffer-local-value 'major-mode buffer)
-   'python-base-mode 'inferior-python-mode))
+  (function-put sym 'command-modes '(python-base-mode)))
 
 ;; Commands that only make sense in the Python shell or when editing
 ;; Python code.
@@ -6871,8 +6861,8 @@ python-shell--completion-predicate
                python-shell-font-lock-turn-off
                python-shell-font-lock-turn-on
                python-shell-package-enable
-               python-shell-completion-complete-or-indent  ))
-  (put sym 'completion-predicate #'python-shell--completion-predicate))
+               python-shell-completion-complete-or-indent))
+  (function-put sym 'command-modes '(python-base-mode inferior-python-mode)))
 
 (provide 'python)
 
-- 
2.34.1


[-- Attachment #5: Type: text/plain, Size: 20 bytes --]


Thanks,

-- 
Basil

bug#63552: 29.0.91; M-x completion-predicate does not account for python-ts-mode

[Eli Zaretskii]

> From: Basil Contovounesios <contovob@tcd.ie>
> Cc: 63552@debbugs.gnu.org,  arstoffel@gmail.com
> Date: Wed, 17 May 2023 13:59:48 +0100
> 
> Eli Zaretskii [2023-05-17 15:40 +0300] wrote:
> 
> > We need to fix tis on the emacs-29 branch, so I wonder whether the fix
> > can be simpler?  After all, we just need to test one more major mode,
> > right?
> 
> Right.  How's this for emacs-29:

Perfect, please install.

> And this for master, once the patch above is merged:

LGTM, thanks.

bug#63552: 29.0.91; M-x completion-predicate does not account for python-ts-mode

[Basil Contovounesios via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Eli Zaretskii [2023-05-17 09:33 -0400] wrote:

>> From: Basil Contovounesios <contovob@tcd.ie>
>> Cc: 63552@debbugs.gnu.org,  arstoffel@gmail.com
>> Date: Wed, 17 May 2023 13:59:48 +0100
>> 
>> Eli Zaretskii [2023-05-17 15:40 +0300] wrote:
>> 
>> > We need to fix tis on the emacs-29 branch, so I wonder whether the fix
>> > can be simpler?  After all, we just need to test one more major mode,
>> > right?
>> 
>> Right.  How's this for emacs-29:
>
> Perfect, please install.

Done:

Fix M-x completion-predicate under python-ts-mode
d879847cd4d 2023-05-17 15:14:09 +0100
https://git.sv.gnu.org/cgit/emacs.git/commit/?id=d879847cd4d

>> And this for master, once the patch above is merged:
>
> LGTM, thanks.

Thanks.  I'll wait until someone else merges emacs-29 into master first
since it's not easy for me to do so at the moment.

-- 
Basil

bug#63552: 29.0.91; M-x completion-predicate does not account for python-ts-mode

[Eli Zaretskii]

> From: Basil Contovounesios <contovob@tcd.ie>
> Cc: 63552@debbugs.gnu.org,  arstoffel@gmail.com
> Date: Wed, 17 May 2023 15:16:07 +0100
> 
> > LGTM, thanks.
> 
> Thanks.  I'll wait until someone else merges emacs-29 into master first
> since it's not easy for me to do so at the moment.

I've done the merge from emacs-29 to master now, so you can go ahead
with the changes on master.

bug#63552: 29.0.91; M-x completion-predicate does not account for python-ts-mode

[Basil Contovounesios via Bug reports for GNU Emacs, the Swiss army knife of text editors]

close 63552 29.1
quit

Eli Zaretskii [2023-05-18 07:55 -0400] wrote:

>> From: Basil Contovounesios <contovob@tcd.ie>
>> Cc: 63552@debbugs.gnu.org,  arstoffel@gmail.com
>> Date: Wed, 17 May 2023 15:16:07 +0100
>> 
>> Thanks.  I'll wait until someone else merges emacs-29 into master first
>> since it's not easy for me to do so at the moment.
>
> I've done the merge from emacs-29 to master now, so you can go ahead
> with the changes on master.

Great, thank you.  Done and closing:

Simplify python.el completion-predicate
d1404d3a119 2023-05-18 13:10:09 +0100
https://git.sv.gnu.org/cgit/emacs.git/commit/?id=d1404d3a119

-- 
Basil