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

Jeremy Bryant
2025-10-15T20:20:14Z

[-- 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