[PATCH] - Adapt to Python-3 print syntax

[PATCH] - Adapt to Python-3 print syntax

[Jeremy Bryant]

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

This change adapts doc examples to Python 3 so they work on current
installations.

python.texi uses a mixture of Python 3 and Python 2 print syntax, the
latter having been sunsetted several years ago.

Adding Eli as "Responsible Maintainer" for documentation.
Also adding Simon Marchi who from recent commits may have an interest in this
part of GDB and may have comments or suggestions.

Perhaps this patch falls under "The Obvious Fix Rule".
The patch is provided inline for critique and also as attachment.
If I have missed any conventions please state so.



[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-doc-python.texi-Adapt-to-Python-3-print-syntax.patch --]
[-- Type: text/x-diff, Size: 2635 bytes --]

From b9c89565ee4bf3dafe383dda3d2ff752ffa7b01f Mon Sep 17 00:00:00 2001
From: Jeremy Bryant <jb@jeremybryant.net>
Date: Tue, 14 Oct 2025 22:55:39 +0100
Subject: [PATCH] * doc/python.texi : Adapt to Python 3 print syntax

This change adapts the print syntax to Python 3.
The documentation examples will then work on current installations.
Python 2 was sunsetted in January 2020.
---
 gdb/doc/python.texi | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index ed113173667..4238b04d155 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -76,7 +76,7 @@ If given an argument, the @code{python} command will evaluate the
 argument as a Python command.  For example:
 
 @smallexample
-(@value{GDBP}) python print 23
+(@value{GDBP}) python print(23)
 23
 @end smallexample
 
@@ -88,7 +88,7 @@ containing @code{end}.  For example:
 
 @smallexample
 (@value{GDBP}) python
->print 23
+>print(23)
 >end
 23
 @end smallexample
@@ -756,7 +756,7 @@ depends on @code{set python print-stack} (@pxref{Python Commands}).
 Example:
 
 @smallexample
-(@value{GDBP}) python print foo
+(@value{GDBP}) python print(foo)
 Traceback (most recent call last):
   File "<string>", line 1, in <module>
 NameError: name 'foo' is not defined
@@ -4652,7 +4652,7 @@ Arguments are separated by spaces and may be quoted.
 Example:
 
 @smallexample
-print gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\"")
+print (gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\""))
 ['1', '2 "3', '4 "5', "6 '7"]
 @end smallexample
 
@@ -5981,7 +5981,7 @@ Two @code{gdb.Frame} objects can be compared for equality with the @code{==}
 operator, like:
 
 @smallexample
-(@value{GDBP}) python print gdb.newest_frame() == gdb.selected_frame ()
+(@value{GDBP}) python print (gdb.newest_frame() == gdb.selected_frame ())
 True
 @end smallexample
 
@@ -9129,7 +9129,7 @@ Then in gdb:
 (gdb) start
 (gdb) python import gdb.types
 (gdb) python foo_ref = gdb.parse_and_eval("foo_ref")
-(gdb) python print gdb.types.get_basic_type(foo_ref.type)
+(gdb) python print (gdb.types.get_basic_type(foo_ref.type))
 int
 @end smallexample
 
@@ -9162,9 +9162,9 @@ Then in @value{GDBN}:
 @smallexample
 (@value{GDBP}) python import gdb.types
 (@value{GDBP}) python struct_a = gdb.lookup_type("struct A")
-(@value{GDBP}) python print struct_a.keys ()
+(@value{GDBP}) python print (struct_a.keys ())
 @{['a', '']@}
-(@value{GDBP}) python print [k for k,v in gdb.types.deep_items(struct_a)]
+(@value{GDBP}) python print ([k for k,v in gdb.types.deep_items(struct_a)])
 @{['a', 'b0', 'b1']@}
 @end smallexample
 
-- 
2.47.2


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: Adapt to Python 3 print syntax --]
[-- Type: text/x-diff, Size: 2635 bytes --]

From b9c89565ee4bf3dafe383dda3d2ff752ffa7b01f Mon Sep 17 00:00:00 2001
From: Jeremy Bryant <jb@jeremybryant.net>
Date: Tue, 14 Oct 2025 22:55:39 +0100
Subject: [PATCH] * doc/python.texi : Adapt to Python 3 print syntax

This change adapts the print syntax to Python 3.
The documentation examples will then work on current installations.
Python 2 was sunsetted in January 2020.
---
 gdb/doc/python.texi | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index ed113173667..4238b04d155 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -76,7 +76,7 @@ If given an argument, the @code{python} command will evaluate the
 argument as a Python command.  For example:
 
 @smallexample
-(@value{GDBP}) python print 23
+(@value{GDBP}) python print(23)
 23
 @end smallexample
 
@@ -88,7 +88,7 @@ containing @code{end}.  For example:
 
 @smallexample
 (@value{GDBP}) python
->print 23
+>print(23)
 >end
 23
 @end smallexample
@@ -756,7 +756,7 @@ depends on @code{set python print-stack} (@pxref{Python Commands}).
 Example:
 
 @smallexample
-(@value{GDBP}) python print foo
+(@value{GDBP}) python print(foo)
 Traceback (most recent call last):
   File "<string>", line 1, in <module>
 NameError: name 'foo' is not defined
@@ -4652,7 +4652,7 @@ Arguments are separated by spaces and may be quoted.
 Example:
 
 @smallexample
-print gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\"")
+print (gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\""))
 ['1', '2 "3', '4 "5', "6 '7"]
 @end smallexample
 
@@ -5981,7 +5981,7 @@ Two @code{gdb.Frame} objects can be compared for equality with the @code{==}
 operator, like:
 
 @smallexample
-(@value{GDBP}) python print gdb.newest_frame() == gdb.selected_frame ()
+(@value{GDBP}) python print (gdb.newest_frame() == gdb.selected_frame ())
 True
 @end smallexample
 
@@ -9129,7 +9129,7 @@ Then in gdb:
 (gdb) start
 (gdb) python import gdb.types
 (gdb) python foo_ref = gdb.parse_and_eval("foo_ref")
-(gdb) python print gdb.types.get_basic_type(foo_ref.type)
+(gdb) python print (gdb.types.get_basic_type(foo_ref.type))
 int
 @end smallexample
 
@@ -9162,9 +9162,9 @@ Then in @value{GDBN}:
 @smallexample
 (@value{GDBP}) python import gdb.types
 (@value{GDBP}) python struct_a = gdb.lookup_type("struct A")
-(@value{GDBP}) python print struct_a.keys ()
+(@value{GDBP}) python print (struct_a.keys ())
 @{['a', '']@}
-(@value{GDBP}) python print [k for k,v in gdb.types.deep_items(struct_a)]
+(@value{GDBP}) python print ([k for k,v in gdb.types.deep_items(struct_a)])
 @{['a', 'b0', 'b1']@}
 @end smallexample
 
-- 
2.47.2

Re: [PATCH] - Adapt to Python-3 print syntax

[Eli Zaretskii]

> From: Jeremy Bryant <jb@jeremybryant.net>
> Cc: Simon Marchi <simon.marchi@polymtl.ca>, Simon Marchi <simark@simark.ca>,
>  Eli Zaretskii <eliz@gnu.org>
> Date: Tue, 14 Oct 2025 23:14:27 +0100
> 
> This change adapts doc examples to Python 3 so they work on current
> installations.
> 
> python.texi uses a mixture of Python 3 and Python 2 print syntax, the
> latter having been sunsetted several years ago.
> 
> Adding Eli as "Responsible Maintainer" for documentation.
> Also adding Simon Marchi who from recent commits may have an interest in this
> part of GDB and may have comments or suggestions.
> 
> Perhaps this patch falls under "The Obvious Fix Rule".
> The patch is provided inline for critique and also as attachment.
> If I have missed any conventions please state so.

Thanks for CC'ing me, but this is not a documentation issue.  This is
about what syntax to show and document, so it's something that the
other maintainers need to decide.

Re: [PATCH] - Adapt to Python-3 print syntax

[Tom Tromey]

>>>>> "Jeremy" == Jeremy Bryant <jb@jeremybryant.net> writes:

Jeremy> This change adapts doc examples to Python 3 so they work on current
Jeremy> installations.

Jeremy> python.texi uses a mixture of Python 3 and Python 2 print syntax, the
Jeremy> latter having been sunsetted several years ago.

This looks reasonable but:

Jeremy> -(@value{GDBP}) python print 23
Jeremy> +(@value{GDBP}) python print(23)

Here there's no space after the "print" -- which is standard Python
style, so seems fine; but...

Jeremy> -print gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\"")
Jeremy> +print (gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\""))

... here there's no space.  There were a few like this and I wondered
why the discrepancy.

Tom

[PATCH v2] - Adapt to Python-3 print syntax

[Jeremy Bryant]

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

Tom Tromey <tom@tromey.com> writes:

>>>>>> "Jeremy" == Jeremy Bryant <jb@jeremybryant.net> writes:
>
> Jeremy> This change adapts doc examples to Python 3 so they work on current
> Jeremy> installations.
>
> Jeremy> python.texi uses a mixture of Python 3 and Python 2 print syntax, the
> Jeremy> latter having been sunsetted several years ago.
>
> This looks reasonable but:
>
> Jeremy> -(@value{GDBP}) python print 23
> Jeremy> +(@value{GDBP}) python print(23)
>
> Here there's no space after the "print" -- which is standard Python
> style, so seems fine; but...
>
> Jeremy> -print gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\"")
> Jeremy> +print (gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\""))
>
> ... here there's no space.  There were a few like this and I wondered
> why the discrepancy.
>
> Tom

Thanks Tom, I've corrected the discrepancy and now all changes are
consistent.  See revised patch v2 inline below for critique and attached
for completeness.
In the course of this, I've also removed a pre-existing extraneous space.

WDYT?



[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-doc-python.texi-Adapt-to-Python-3-print-syntax.patch --]
[-- Type: text/x-diff, Size: 2944 bytes --]

From 94dde31def1f9ce943819857a7205b3557276d33 Mon Sep 17 00:00:00 2001
From: Jeremy Bryant <jb@jeremybryant.net>
Date: Tue, 14 Oct 2025 22:55:39 +0100
Subject: [PATCH] * doc/python.texi : Adapt to Python 3 print syntax

This change adapts the print syntax to Python 3.
The documentation examples will then work on current installations.
Python 2 was sunsetted in January 2020.
---
 gdb/doc/python.texi | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index ed113173667..9df2c58f210 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -76,7 +76,7 @@ If given an argument, the @code{python} command will evaluate the
 argument as a Python command.  For example:
 
 @smallexample
-(@value{GDBP}) python print 23
+(@value{GDBP}) python print(23)
 23
 @end smallexample
 
@@ -88,7 +88,7 @@ containing @code{end}.  For example:
 
 @smallexample
 (@value{GDBP}) python
->print 23
+>print(23)
 >end
 23
 @end smallexample
@@ -756,7 +756,7 @@ depends on @code{set python print-stack} (@pxref{Python Commands}).
 Example:
 
 @smallexample
-(@value{GDBP}) python print foo
+(@value{GDBP}) python print(foo)
 Traceback (most recent call last):
   File "<string>", line 1, in <module>
 NameError: name 'foo' is not defined
@@ -1945,7 +1945,7 @@ settings.  During a @code{print} or other operation, the values will
 reflect any flags that are temporarily in effect.
 
 @smallexample
-(gdb) python print (gdb.print_options ()['max_elements'])
+(gdb) python print(gdb.print_options ()['max_elements'])
 200
 @end smallexample
 @end defun
@@ -4652,7 +4652,7 @@ Arguments are separated by spaces and may be quoted.
 Example:
 
 @smallexample
-print gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\"")
+print(gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\""))
 ['1', '2 "3', '4 "5', "6 '7"]
 @end smallexample
 
@@ -5981,7 +5981,7 @@ Two @code{gdb.Frame} objects can be compared for equality with the @code{==}
 operator, like:
 
 @smallexample
-(@value{GDBP}) python print gdb.newest_frame() == gdb.selected_frame ()
+(@value{GDBP}) python print(gdb.newest_frame() == gdb.selected_frame ())
 True
 @end smallexample
 
@@ -9129,7 +9129,7 @@ Then in gdb:
 (gdb) start
 (gdb) python import gdb.types
 (gdb) python foo_ref = gdb.parse_and_eval("foo_ref")
-(gdb) python print gdb.types.get_basic_type(foo_ref.type)
+(gdb) python print(gdb.types.get_basic_type(foo_ref.type))
 int
 @end smallexample
 
@@ -9162,9 +9162,9 @@ Then in @value{GDBN}:
 @smallexample
 (@value{GDBP}) python import gdb.types
 (@value{GDBP}) python struct_a = gdb.lookup_type("struct A")
-(@value{GDBP}) python print struct_a.keys ()
+(@value{GDBP}) python print(struct_a.keys ())
 @{['a', '']@}
-(@value{GDBP}) python print [k for k,v in gdb.types.deep_items(struct_a)]
+(@value{GDBP}) python print([k for k,v in gdb.types.deep_items(struct_a)])
 @{['a', 'b0', 'b1']@}
 @end smallexample
 
-- 
2.47.2


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0001-doc-python.texi-Adapt-to-Python-3-print-syntax.patch --]
[-- Type: text/x-diff, Size: 2944 bytes --]

From 94dde31def1f9ce943819857a7205b3557276d33 Mon Sep 17 00:00:00 2001
From: Jeremy Bryant <jb@jeremybryant.net>
Date: Tue, 14 Oct 2025 22:55:39 +0100
Subject: [PATCH] * doc/python.texi : Adapt to Python 3 print syntax

This change adapts the print syntax to Python 3.
The documentation examples will then work on current installations.
Python 2 was sunsetted in January 2020.
---
 gdb/doc/python.texi | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index ed113173667..9df2c58f210 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -76,7 +76,7 @@ If given an argument, the @code{python} command will evaluate the
 argument as a Python command.  For example:
 
 @smallexample
-(@value{GDBP}) python print 23
+(@value{GDBP}) python print(23)
 23
 @end smallexample
 
@@ -88,7 +88,7 @@ containing @code{end}.  For example:
 
 @smallexample
 (@value{GDBP}) python
->print 23
+>print(23)
 >end
 23
 @end smallexample
@@ -756,7 +756,7 @@ depends on @code{set python print-stack} (@pxref{Python Commands}).
 Example:
 
 @smallexample
-(@value{GDBP}) python print foo
+(@value{GDBP}) python print(foo)
 Traceback (most recent call last):
   File "<string>", line 1, in <module>
 NameError: name 'foo' is not defined
@@ -1945,7 +1945,7 @@ settings.  During a @code{print} or other operation, the values will
 reflect any flags that are temporarily in effect.
 
 @smallexample
-(gdb) python print (gdb.print_options ()['max_elements'])
+(gdb) python print(gdb.print_options ()['max_elements'])
 200
 @end smallexample
 @end defun
@@ -4652,7 +4652,7 @@ Arguments are separated by spaces and may be quoted.
 Example:
 
 @smallexample
-print gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\"")
+print(gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\""))
 ['1', '2 "3', '4 "5', "6 '7"]
 @end smallexample
 
@@ -5981,7 +5981,7 @@ Two @code{gdb.Frame} objects can be compared for equality with the @code{==}
 operator, like:
 
 @smallexample
-(@value{GDBP}) python print gdb.newest_frame() == gdb.selected_frame ()
+(@value{GDBP}) python print(gdb.newest_frame() == gdb.selected_frame ())
 True
 @end smallexample
 
@@ -9129,7 +9129,7 @@ Then in gdb:
 (gdb) start
 (gdb) python import gdb.types
 (gdb) python foo_ref = gdb.parse_and_eval("foo_ref")
-(gdb) python print gdb.types.get_basic_type(foo_ref.type)
+(gdb) python print(gdb.types.get_basic_type(foo_ref.type))
 int
 @end smallexample
 
@@ -9162,9 +9162,9 @@ Then in @value{GDBN}:
 @smallexample
 (@value{GDBP}) python import gdb.types
 (@value{GDBP}) python struct_a = gdb.lookup_type("struct A")
-(@value{GDBP}) python print struct_a.keys ()
+(@value{GDBP}) python print(struct_a.keys ())
 @{['a', '']@}
-(@value{GDBP}) python print [k for k,v in gdb.types.deep_items(struct_a)]
+(@value{GDBP}) python print([k for k,v in gdb.types.deep_items(struct_a)])
 @{['a', 'b0', 'b1']@}
 @end smallexample
 
-- 
2.47.2

Re: [PATCH v2] - Adapt to Python-3 print syntax

[Tom Tromey]

Jeremy> Thanks Tom, I've corrected the discrepancy and now all changes are
Jeremy> consistent.  See revised patch v2 inline below for critique and attached
Jeremy> for completeness.
Jeremy> In the course of this, I've also removed a pre-existing extraneous space.

Jeremy> WDYT?

Looks good, thank you.
Approved-By: Tom Tromey <tom@tromey.com>

Tom

Ready for Write After Approval - Re: [PATCH v2] - Adapt to Python-3 print syntax

[Jeremy Bryant]

Tom Tromey <tom@tromey.com> writes:

> Jeremy> Thanks Tom, I've corrected the discrepancy and now all changes are
> Jeremy> consistent.  See revised patch v2 inline below for critique and attached
> Jeremy> for completeness.
> Jeremy> In the course of this, I've also removed a pre-existing extraneous space.
>
> Jeremy> WDYT?
>
> Looks good, thank you.
> Approved-By: Tom Tromey <tom@tromey.com>
>
> Tom

Thanks Tom.

I see the patch is not yet committed.

Would someone on the "Write After Approval" list please commit the
patch?


Thanks in advance
Jeremy 


PS:
I'm not sure about the etiquette for following-up but presumably it's
soon after approval so the patch is still applicable to master.

The guidance here says one week for patch review only
https://sourceware.org/gdb/wiki/ContributionChecklist

Re: Ready for Write After Approval - Re: [PATCH v2] - Adapt to Python-3 print syntax

[Eli Zaretskii]

> From: Jeremy Bryant <jb@jeremybryant.net>
> Cc: GDB Patches <gdb-patches@sourceware.org>,  Simon Marchi
>  <simon.marchi@polymtl.ca>,  Simon Marchi <simark@simark.ca>,  Eli
>  Zaretskii <eliz@gnu.org>
> Date: Thu, 16 Oct 2025 21:04:24 +0100
> 
> Tom Tromey <tom@tromey.com> writes:
> 
> > Jeremy> Thanks Tom, I've corrected the discrepancy and now all changes are
> > Jeremy> consistent.  See revised patch v2 inline below for critique and attached
> > Jeremy> for completeness.
> > Jeremy> In the course of this, I've also removed a pre-existing extraneous space.
> >
> > Jeremy> WDYT?
> >
> > Looks good, thank you.
> > Approved-By: Tom Tromey <tom@tromey.com>
> >
> > Tom
> 
> Thanks Tom.
> 
> I see the patch is not yet committed.
> 
> Would someone on the "Write After Approval" list please commit the
> patch?

I think you expect too much from the GDB maintenance processes.  One
day is nowhere near enough to ping about approved-but-not-committed
changes.

Contributor guidelines - Re: Ready for Write After Approval - Re: [PATCH v2] - Adapt to Python-3 print syntax

[Jeremy Bryant]

Eli Zaretskii <eliz@gnu.org> writes:
>> > Looks good, thank you.
>> > Approved-By: Tom Tromey <tom@tromey.com>
>> >
>> > Tom
>> 
>> Thanks Tom.
>> 
>> I see the patch is not yet committed.
>> 
>> Would someone on the "Write After Approval" list please commit the
>> patch?
>


> I think you expect too much from the GDB maintenance processes.  One
> day is nowhere near enough to ping about approved-but-not-committed
> changes.

Eli, bringing back the second-part, truncated, of my message:-

"
PS:
I'm not sure about the etiquette for following-up but presumably it's
soon after approval so the patch is still applicable to master.

The guidance here says one week for patch review only
https://sourceware.org/gdb/wiki/ContributionChecklist
"


Perhaps my request wasn't worded properly.  What is a typical wait time
that is appropriate?

To edit the file at
https://sourceware.org/gdb/wiki/ContributionChecklist,
do we submit ideas or patches here or in some other way?

Re: Contributor guidelines - Re: Ready for Write After Approval - Re: [PATCH v2] - Adapt to Python-3 print syntax

[Eli Zaretskii]

> From: Jeremy Bryant <jb@jeremybryant.net>
> Cc: tom@tromey.com,  gdb-patches@sourceware.org
> Date: Sun, 19 Oct 2025 20:16:06 +0100
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> > I think you expect too much from the GDB maintenance processes.  One
> > day is nowhere near enough to ping about approved-but-not-committed
> > changes.
> 
> Eli, bringing back the second-part, truncated, of my message:-
> 
> "
> PS:
> I'm not sure about the etiquette for following-up but presumably it's
> soon after approval so the patch is still applicable to master.
> 
> The guidance here says one week for patch review only
> https://sourceware.org/gdb/wiki/ContributionChecklist
> "
> 
> 
> Perhaps my request wasn't worded properly.  What is a typical wait time
> that is appropriate?

A week at least, IME.

> To edit the file at
> https://sourceware.org/gdb/wiki/ContributionChecklist,
> do we submit ideas or patches here or in some other way?

I don't know, sorry.

Re: Ready for Write After Approval - Re: [PATCH v2] - Adapt to Python-3 print syntax

[Tom Tromey]

Jeremy> Would someone on the "Write After Approval" list please commit the
Jeremy> patch?

I've done it.

'b4 shazam' didn't recognize the patch because you attached it rather
than 'git send-email'ing it.  I wonder if you could switch to the latter
if you plan to send more patches.

Tom

Thank you - Re: Ready for Write After Approval - Re: [PATCH v2] - Adapt to Python-3 print syntax

[Jeremy Bryant]

Tom Tromey <tom@tromey.com> writes:

> Jeremy> Would someone on the "Write After Approval" list please commit the
> Jeremy> patch?
>
> I've done it.
>
> 'b4 shazam' didn't recognize the patch because you attached it rather
> than 'git send-email'ing it.  I wonder if you could switch to the latter
> if you plan to send more patches.
>
> Tom

Thanks Tom for the patience.
My apologies, I thought my current workflow was equivalent to this, but
it seems I need to follow the contributor guidelines more closely.