GNU bug report logs - #71083
[PATCH] ; Enhance the "python-shell-send-block" for convenience

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 71083 in the body.
You can then email your comments to 71083 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Lin Sun <sunlin7.mail <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] ; Enhance the "python-shell-send-block" for convenience
Date: Mon, 20 May 2024 20:28:17 +0000

[Message part 1 (text/plain, inline)]

Hi,

This patch tries to make `python-shell-send-block' more convenient.

I had added the function `python-shell-send-block'  twenty days ago in
bug#70609, it will send code block with header by default, and a
prefix "C-u" to call the function will send block without header.

And I received some feedback that sending a block without a header
should be a more used one.

Many python blocks begin with "if condition", and users may want to
send the block without its condition header to try different condition
branches.

So this patch will make sending block without header to be the default
behavior, and a prefix "C-u" will make the function to send block with
header.

Please help review this minor change. Thanks

[0001-Enhance-the-python-shell-send-block-for-convenience.patch (text/x-patch, attachment)]

Message #8 received at 71083 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lin Sun <sunlin7.mail <at> gmail.com>, kobarity <kobarity <at> gmail.com>
Cc: 71083 <at> debbugs.gnu.org
Subject: Re: bug#71083: [PATCH] ;
 Enhance the "python-shell-send-block" for convenience
Date: Sat, 25 May 2024 11:03:49 +0300

Any comments on the proposed patch?

> From: Lin Sun <sunlin7.mail <at> gmail.com>
> Date: Mon, 20 May 2024 20:28:17 +0000
> 
> This patch tries to make `python-shell-send-block' more convenient.
> 
> I had added the function `python-shell-send-block'  twenty days ago in
> bug#70609, it will send code block with header by default, and a
> prefix "C-u" to call the function will send block without header.
> 
> And I received some feedback that sending a block without a header
> should be a more used one.
> 
> Many python blocks begin with "if condition", and users may want to
> send the block without its condition header to try different condition
> branches.
> 
> So this patch will make sending block without header to be the default
> behavior, and a prefix "C-u" will make the function to send block with
> header.
> 
> Please help review this minor change. Thanks
> 
> 
> From 7eefbf3e4de925c211e483a809d0f8d94e8d17f0 Mon Sep 17 00:00:00 2001
> From: Lin Sun <sunlin7 <at> hotmail.com>
> Date: Mon, 20 May 2024 06:55:31 +0000
> Subject: [PATCH] ; Enhance the "python-shell-send-block" for convenience
> 
> * lisp/progmodes/python.el (python-shell-send-block):
>   The "python-shell-send-block" will send block without header defaultly.
> * lisp/progmodes/python.el: Update test case.
> ---
>  lisp/progmodes/python.el            | 4 ++--
>  test/lisp/progmodes/python-tests.el | 4 ++--
>  2 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el
> index 7f28f583543..9ec198da79a 100644
> --- a/lisp/progmodes/python.el
> +++ b/lisp/progmodes/python.el
> @@ -4149,14 +4149,14 @@ interactively."
>    "Send the block at point to inferior Python process.
>  The block is delimited by `python-nav-beginning-of-block' and
>  `python-nav-end-of-block'.  If optional argument ARG is non-nil
> -(interactively, the prefix argument), send the block body without
> +(interactively, the prefix argument), send the block body with
>  its header.  If optional argument MSG is non-nil, force display
>  of a user-friendly message if there's no process running; this
>  always happens interactively."
>    (interactive (list current-prefix-arg t))
>    (let ((beg (save-excursion
>                 (when (python-nav-beginning-of-block)
> -                 (if (null arg)
> +                 (if arg
>                       (beginning-of-line)
>                     (python-nav-end-of-statement)
>                     (beginning-of-line 2)))
> diff --git a/test/lisp/progmodes/python-tests.el b/test/lisp/progmodes/python-tests.el
> index f50797953c3..803008db8a3 100644
> --- a/test/lisp/progmodes/python-tests.el
> +++ b/test/lisp/progmodes/python-tests.el
> @@ -7476,7 +7476,7 @@ print('current 3')"
>      (goto-char (point-min))
>      (should-error (python-shell-send-block) :type 'user-error)
>      (forward-line)
> -    (python-shell-send-block)
> +    (python-shell-send-block t) ;; send block with header
>      (python-tests-shell-wait-for-prompt)
>      (python-shell-with-shell-buffer
>        (goto-char (point-min))
> @@ -7485,7 +7485,7 @@ print('current 3')"
>        (should (re-search-forward "current 2" nil t))
>        (should-not (re-search-forward "current 3" nil t)))
>      (forward-line)
> -    (python-shell-send-block t) ;; send block body only
> +    (python-shell-send-block) ;; send block body only
>      (python-tests-shell-wait-for-prompt)
>      (python-shell-with-shell-buffer
>        ;; should only 1 line output from the block body
> -- 
> 2.20.5
> 

Message #11 received at 71083 <at> debbugs.gnu.org (full text, mbox):

From: kobarity <kobarity <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 71083 <at> debbugs.gnu.org, Lin Sun <sunlin7.mail <at> gmail.com>
Subject: Re: bug#71083: [PATCH] ;
 Enhance the "python-shell-send-block" for convenience
Date: Sat, 25 May 2024 17:49:30 +0900

Eli Zaretskii wrote:
> Any comments on the proposed patch?
> 
> > From: Lin Sun <sunlin7.mail <at> gmail.com>
> > Date: Mon, 20 May 2024 20:28:17 +0000
> > 
> > This patch tries to make `python-shell-send-block' more convenient.
> > 
> > I had added the function `python-shell-send-block'  twenty days ago in
> > bug#70609, it will send code block with header by default, and a
> > prefix "C-u" to call the function will send block without header.
> > 
> > And I received some feedback that sending a block without a header
> > should be a more used one.
> > 
> > Many python blocks begin with "if condition", and users may want to
> > send the block without its condition header to try different condition
> > branches.
> > 
> > So this patch will make sending block without header to be the default
> > behavior, and a prefix "C-u" will make the function to send block with
> > header.
> > 
> > Please help review this minor change. Thanks
> > 
> > 
> > From 7eefbf3e4de925c211e483a809d0f8d94e8d17f0 Mon Sep 17 00:00:00 2001
> > From: Lin Sun <sunlin7 <at> hotmail.com>
> > Date: Mon, 20 May 2024 06:55:31 +0000
> > Subject: [PATCH] ; Enhance the "python-shell-send-block" for convenience
> > 
> > * lisp/progmodes/python.el (python-shell-send-block):
> >   The "python-shell-send-block" will send block without header defaultly.
> > * lisp/progmodes/python.el: Update test case.
> > ---
> >  lisp/progmodes/python.el            | 4 ++--
> >  test/lisp/progmodes/python-tests.el | 4 ++--
> >  2 files changed, 4 insertions(+), 4 deletions(-)
> > 
> > diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el
> > index 7f28f583543..9ec198da79a 100644
> > --- a/lisp/progmodes/python.el
> > +++ b/lisp/progmodes/python.el
> > @@ -4149,14 +4149,14 @@ interactively."
> >    "Send the block at point to inferior Python process.
> >  The block is delimited by `python-nav-beginning-of-block' and
> >  `python-nav-end-of-block'.  If optional argument ARG is non-nil
> > -(interactively, the prefix argument), send the block body without
> > +(interactively, the prefix argument), send the block body with
> >  its header.  If optional argument MSG is non-nil, force display
> >  of a user-friendly message if there's no process running; this
> >  always happens interactively."
> >    (interactive (list current-prefix-arg t))
> >    (let ((beg (save-excursion
> >                 (when (python-nav-beginning-of-block)
> > -                 (if (null arg)
> > +                 (if arg
> >                       (beginning-of-line)
> >                     (python-nav-end-of-statement)
> >                     (beginning-of-line 2)))
> > diff --git a/test/lisp/progmodes/python-tests.el b/test/lisp/progmodes/python-tests.el
> > index f50797953c3..803008db8a3 100644
> > --- a/test/lisp/progmodes/python-tests.el
> > +++ b/test/lisp/progmodes/python-tests.el
> > @@ -7476,7 +7476,7 @@ print('current 3')"
> >      (goto-char (point-min))
> >      (should-error (python-shell-send-block) :type 'user-error)
> >      (forward-line)
> > -    (python-shell-send-block)
> > +    (python-shell-send-block t) ;; send block with header
> >      (python-tests-shell-wait-for-prompt)
> >      (python-shell-with-shell-buffer
> >        (goto-char (point-min))
> > @@ -7485,7 +7485,7 @@ print('current 3')"
> >        (should (re-search-forward "current 2" nil t))
> >        (should-not (re-search-forward "current 3" nil t)))
> >      (forward-line)
> > -    (python-shell-send-block t) ;; send block body only
> > +    (python-shell-send-block) ;; send block body only
> >      (python-tests-shell-wait-for-prompt)
> >      (python-shell-with-shell-buffer
> >        ;; should only 1 line output from the block body
> > -- 
> > 2.20.5
> > 

As for the default behavior of `python-shell-send-block' I am fine
with either.

"send block without header defaultly." in the commit message would be
better for "send block without header by default."

I noticed two Flymake diagnostics regarding `python-shell-send-block'.

- Open parenthesis in column 0 should be escaped
- Error messages should *not* end with a period

It would be nice to resolve them.

Message #14 received at 71083 <at> debbugs.gnu.org (full text, mbox):

From: Lin Sun <sunlin7.mail <at> gmail.com>
To: kobarity <kobarity <at> gmail.com>
Cc: 71083 <at> debbugs.gnu.org, Eli Zaretskii <eliz <at> gnu.org>
Subject: Re: bug#71083: [PATCH] ;
 Enhance the "python-shell-send-block" for convenience
Date: Sat, 25 May 2024 15:57:51 +0000

[Message part 1 (text/plain, inline)]

On Sat, May 25, 2024 at 8:49 AM kobarity <kobarity <at> gmail.com> wrote:
> Eli Zaretskii wrote:
> > Any comments on the proposed patch?
> >
> > > From: Lin Sun <sunlin7.mail <at> gmail.com>
> > > Date: Mon, 20 May 2024 20:28:17 +0000
> > >
> > > This patch tries to make `python-shell-send-block' more convenient.
> > >
> > > I had added the function `python-shell-send-block'  twenty days ago in
> > > bug#70609, it will send code block with header by default, and a
> > > prefix "C-u" to call the function will send block without header.
> > >
> > > And I received some feedback that sending a block without a header
> > > should be a more used one.
> > >
> > > Many python blocks begin with "if condition", and users may want to
> > > send the block without its condition header to try different condition
> > > branches.
> > >
> > > So this patch will make sending block without header to be the default
> > > behavior, and a prefix "C-u" will make the function to send block with
> > > header.
> > >
> > > Please help review this minor change. Thanks
> > >
> > >
> > > From 7eefbf3e4de925c211e483a809d0f8d94e8d17f0 Mon Sep 17 00:00:00 2001
> > > From: Lin Sun <sunlin7 <at> hotmail.com>
> > > Date: Mon, 20 May 2024 06:55:31 +0000
> > > Subject: [PATCH] ; Enhance the "python-shell-send-block" for convenience
> > >
> > > * lisp/progmodes/python.el (python-shell-send-block):
> > >   The "python-shell-send-block" will send block without header defaultly.
> > > * lisp/progmodes/python.el: Update test case.
> > > ---
> > >  lisp/progmodes/python.el            | 4 ++--
> > >  test/lisp/progmodes/python-tests.el | 4 ++--
> > >  2 files changed, 4 insertions(+), 4 deletions(-)
> > >
> > > diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el
> > > index 7f28f583543..9ec198da79a 100644
> > > --- a/lisp/progmodes/python.el
> > > +++ b/lisp/progmodes/python.el
> > > @@ -4149,14 +4149,14 @@ interactively."
> > >    "Send the block at point to inferior Python process.
> > >  The block is delimited by `python-nav-beginning-of-block' and
> > >  `python-nav-end-of-block'.  If optional argument ARG is non-nil
> > > -(interactively, the prefix argument), send the block body without
> > > +(interactively, the prefix argument), send the block body with
> > >  its header.  If optional argument MSG is non-nil, force display
> > >  of a user-friendly message if there's no process running; this
> > >  always happens interactively."
> > >    (interactive (list current-prefix-arg t))
> > >    (let ((beg (save-excursion
> > >                 (when (python-nav-beginning-of-block)
> > > -                 (if (null arg)
> > > +                 (if arg
> > >                       (beginning-of-line)
> > >                     (python-nav-end-of-statement)
> > >                     (beginning-of-line 2)))
> > > diff --git a/test/lisp/progmodes/python-tests.el b/test/lisp/progmodes/python-tests.el
> > > index f50797953c3..803008db8a3 100644
> > > --- a/test/lisp/progmodes/python-tests.el
> > > +++ b/test/lisp/progmodes/python-tests.el
> > > @@ -7476,7 +7476,7 @@ print('current 3')"
> > >      (goto-char (point-min))
> > >      (should-error (python-shell-send-block) :type 'user-error)
> > >      (forward-line)
> > > -    (python-shell-send-block)
> > > +    (python-shell-send-block t) ;; send block with header
> > >      (python-tests-shell-wait-for-prompt)
> > >      (python-shell-with-shell-buffer
> > >        (goto-char (point-min))
> > > @@ -7485,7 +7485,7 @@ print('current 3')"
> > >        (should (re-search-forward "current 2" nil t))
> > >        (should-not (re-search-forward "current 3" nil t)))
> > >      (forward-line)
> > > -    (python-shell-send-block t) ;; send block body only
> > > +    (python-shell-send-block) ;; send block body only
> > >      (python-tests-shell-wait-for-prompt)
> > >      (python-shell-with-shell-buffer
> > >        ;; should only 1 line output from the block body
> > > --
> > > 2.20.5
> > >
>
> As for the default behavior of `python-shell-send-block' I am fine
> with either.
>
> "send block without header defaultly." in the commit message would be
> better for "send block without header by default."
>
> I noticed two Flymake diagnostics regarding `python-shell-send-block'.
>
> - Open parenthesis in column 0 should be escaped
> - Error messages should *not* end with a period
>
> It would be nice to resolve them.
Hi kobarity,

Thank you for the comment, you're right. I had fixed the flymake
diagnostics and the commit message.

Please help review again. Thanks.

[0001-Enhance-the-python-shell-send-block-for-convenience.patch (text/x-patch, attachment)]

Message #17 received at 71083 <at> debbugs.gnu.org (full text, mbox):

From: kobarity <kobarity <at> gmail.com>
To: Lin Sun <sunlin7.mail <at> gmail.com>
Cc: 71083 <at> debbugs.gnu.org, Eli Zaretskii <eliz <at> gnu.org>
Subject: Re: bug#71083: [PATCH] ;
 Enhance the "python-shell-send-block" for convenience
Date: Sun, 26 May 2024 09:35:49 +0900

Lin Sun wrote:
> On Sat, May 25, 2024 at 8:49 AM kobarity <kobarity <at> gmail.com> wrote:
> > Eli Zaretskii wrote:
> > > Any comments on the proposed patch?
> > >
> > > > From: Lin Sun <sunlin7.mail <at> gmail.com>
> > > > Date: Mon, 20 May 2024 20:28:17 +0000
> > > >
> > > > This patch tries to make `python-shell-send-block' more convenient.
> > > >
> > > > I had added the function `python-shell-send-block'  twenty days ago in
> > > > bug#70609, it will send code block with header by default, and a
> > > > prefix "C-u" to call the function will send block without header.
> > > >
> > > > And I received some feedback that sending a block without a header
> > > > should be a more used one.
> > > >
> > > > Many python blocks begin with "if condition", and users may want to
> > > > send the block without its condition header to try different condition
> > > > branches.
> > > >
> > > > So this patch will make sending block without header to be the default
> > > > behavior, and a prefix "C-u" will make the function to send block with
> > > > header.
> > > >
> > > > Please help review this minor change. Thanks
> > > >
> > > >
> > > > From 7eefbf3e4de925c211e483a809d0f8d94e8d17f0 Mon Sep 17 00:00:00 2001
> > > > From: Lin Sun <sunlin7 <at> hotmail.com>
> > > > Date: Mon, 20 May 2024 06:55:31 +0000
> > > > Subject: [PATCH] ; Enhance the "python-shell-send-block" for convenience
> > > >
> > > > * lisp/progmodes/python.el (python-shell-send-block):
> > > >   The "python-shell-send-block" will send block without header defaultly.
> > > > * lisp/progmodes/python.el: Update test case.
> > > > ---
> > > >  lisp/progmodes/python.el            | 4 ++--
> > > >  test/lisp/progmodes/python-tests.el | 4 ++--
> > > >  2 files changed, 4 insertions(+), 4 deletions(-)
> > > >
> > > > diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el
> > > > index 7f28f583543..9ec198da79a 100644
> > > > --- a/lisp/progmodes/python.el
> > > > +++ b/lisp/progmodes/python.el
> > > > @@ -4149,14 +4149,14 @@ interactively."
> > > >    "Send the block at point to inferior Python process.
> > > >  The block is delimited by `python-nav-beginning-of-block' and
> > > >  `python-nav-end-of-block'.  If optional argument ARG is non-nil
> > > > -(interactively, the prefix argument), send the block body without
> > > > +(interactively, the prefix argument), send the block body with
> > > >  its header.  If optional argument MSG is non-nil, force display
> > > >  of a user-friendly message if there's no process running; this
> > > >  always happens interactively."
> > > >    (interactive (list current-prefix-arg t))
> > > >    (let ((beg (save-excursion
> > > >                 (when (python-nav-beginning-of-block)
> > > > -                 (if (null arg)
> > > > +                 (if arg
> > > >                       (beginning-of-line)
> > > >                     (python-nav-end-of-statement)
> > > >                     (beginning-of-line 2)))
> > > > diff --git a/test/lisp/progmodes/python-tests.el b/test/lisp/progmodes/python-tests.el
> > > > index f50797953c3..803008db8a3 100644
> > > > --- a/test/lisp/progmodes/python-tests.el
> > > > +++ b/test/lisp/progmodes/python-tests.el
> > > > @@ -7476,7 +7476,7 @@ print('current 3')"
> > > >      (goto-char (point-min))
> > > >      (should-error (python-shell-send-block) :type 'user-error)
> > > >      (forward-line)
> > > > -    (python-shell-send-block)
> > > > +    (python-shell-send-block t) ;; send block with header
> > > >      (python-tests-shell-wait-for-prompt)
> > > >      (python-shell-with-shell-buffer
> > > >        (goto-char (point-min))
> > > > @@ -7485,7 +7485,7 @@ print('current 3')"
> > > >        (should (re-search-forward "current 2" nil t))
> > > >        (should-not (re-search-forward "current 3" nil t)))
> > > >      (forward-line)
> > > > -    (python-shell-send-block t) ;; send block body only
> > > > +    (python-shell-send-block) ;; send block body only
> > > >      (python-tests-shell-wait-for-prompt)
> > > >      (python-shell-with-shell-buffer
> > > >        ;; should only 1 line output from the block body
> > > > --
> > > > 2.20.5
> > > >
> >
> > As for the default behavior of `python-shell-send-block' I am fine
> > with either.
> >
> > "send block without header defaultly." in the commit message would be
> > better for "send block without header by default."
> >
> > I noticed two Flymake diagnostics regarding `python-shell-send-block'.
> >
> > - Open parenthesis in column 0 should be escaped
> > - Error messages should *not* end with a period
> >
> > It would be nice to resolve them.
> Hi kobarity,
> 
> Thank you for the comment, you're right. I had fixed the flymake
> diagnostics and the commit message.
> 
> Please help review again. Thanks.

Thanks, it looks good to me.

Message #22 received at 71083-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lin Sun <sunlin7.mail <at> gmail.com>
Cc: 71083-done <at> debbugs.gnu.org, kobarity <at> gmail.com
Subject: Re: bug#71083: [PATCH] ;
 Enhance the "python-shell-send-block" for convenience
Date: Sun, 26 May 2024 11:30:56 +0300

> From: Lin Sun <sunlin7.mail <at> gmail.com>
> Date: Sat, 25 May 2024 15:57:51 +0000
> Cc: Eli Zaretskii <eliz <at> gnu.org>, 71083 <at> debbugs.gnu.org
> 
> Thank you for the comment, you're right. I had fixed the flymake
> diagnostics and the commit message.
> 
> Please help review again. Thanks.

Thanks, installed, and closing the bug.

Please in the future try to follow our conventions for commit log
messages more closely:

  . quote symbols 'like this'
  . wrap lines at column 63
  . ensure correct file names
  . mention test names in patches in test/ files
  . mention the bug number, if known

You can see how I reformatted your commit log message this time, to
understand better the above conventions.

Message #25 received at 71083-done <at> debbugs.gnu.org (full text, mbox):

From: Lin Sun <sunlin7.mail <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 71083-done <at> debbugs.gnu.org, kobarity <at> gmail.com
Subject: Re: bug#71083: [PATCH] ;
 Enhance the "python-shell-send-block" for convenience
Date: Sun, 26 May 2024 18:41:28 +0000

On Sun, May 26, 2024 at 8:31 AM Eli Zaretskii <eliz <at> gnu.org> wrote:
>
> > From: Lin Sun <sunlin7.mail <at> gmail.com>
> > Date: Sat, 25 May 2024 15:57:51 +0000
> > Cc: Eli Zaretskii <eliz <at> gnu.org>, 71083 <at> debbugs.gnu.org
> >
> > Thank you for the comment, you're right. I had fixed the flymake
> > diagnostics and the commit message.
> >
> > Please help review again. Thanks.
>
> Thanks, installed, and closing the bug.
>
> Please in the future try to follow our conventions for commit log
> messages more closely:
>
>   . quote symbols 'like this'
>   . wrap lines at column 63
>   . ensure correct file names
>   . mention test names in patches in test/ files
>   . mention the bug number, if known
>
> You can see how I reformatted your commit log message this time, to
> understand better the above conventions.
Thank you for your comments, and I checked your listed points and the
commit message, also readed the CONTRIBUTE document, will follow the
points. Appreciate !

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.