[PATCH] gdb/docs: add parentheses in Python examples using print

[PATCH] gdb/docs: add parentheses in Python examples using print

[Marco Barisione]

This makes the examples work both in Python 2 and 3.

gdb/doc/ChangeLog:

	* python.texi: Add parentheses to print statements/functions.
---
 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 0f776f54768..da81906d03d 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -559,7 +559,7 @@ rather recognizes it when thrown from user Python code.  Example:
 >    argv = gdb.string_to_argv (args)
 >    if len (argv) != 0:
 >      raise gdb.GdbError ("hello-world takes no arguments")
->    print "Hello, World!"
+>    print ("Hello, World!")
 >HelloWorld ()
 >end
 (gdb) hello-world 42
@@ -3100,8 +3100,8 @@ Here is an example:
 
 @smallexample
 def exit_handler (event):
-    print "event type: exit"
-    print "exit code: %d" % (event.exit_code)
+    print ("event type: exit")
+    print ("exit code: %d" % (event.exit_code))
 
 gdb.events.exited.connect (exit_handler)
 @end smallexample
@@ -3921,7 +3921,7 @@ class HelloWorld (gdb.Command):
     super (HelloWorld, self).__init__ ("hello-world", gdb.COMMAND_USER)
 
   def invoke (self, arg, from_tty):
-    print "Hello, World!"
+    print ("Hello, World!")
 
 HelloWorld ()
 @end smallexample
@@ -4309,7 +4309,7 @@ def clear_objfiles_handler(event):
     event.progspace.expensive_computation = None
 def expensive(symbol):
     """A mock routine to perform an "expensive" computation on symbol."""
-    print "Computing the answer to the ultimate question ..."
+    print ("Computing the answer to the ultimate question ...")
     return 42
 def new_objfile_handler(event):
     objfile = event.new_objfile
@@ -4654,7 +4654,7 @@ versions.  Using it, you could write:
 reason = gdb.selected_frame().unwind_stop_reason ()
 reason_str =  gdb.frame_stop_reason_string (reason)
 if reason >=  gdb.FRAME_UNWIND_FIRST_ERROR:
-    print "An error occured: %s" % reason_str
+    print ("An error occured: %s" % reason_str)
 @end smallexample
 @end table
 
@@ -5295,7 +5295,7 @@ example illustrating iterating over a line table.
 symtab = gdb.selected_frame().find_sal().symtab
 linetable = symtab.linetable()
 for line in linetable:
-   print "Line: "+str(line.line)+" Address: "+hex(line.pc)
+   print ("Line: "+str(line.line)+" Address: "+hex(line.pc))
 @end smallexample
 
 This will have the following output:
@@ -5618,11 +5618,11 @@ method:
 @smallexample
 class MyFinishBreakpoint (gdb.FinishBreakpoint)
     def stop (self):
-        print "normal finish"
+        print ("normal finish")
         return True
     
     def out_of_scope ():
-        print "abnormal finish"
+        print ("abnormal finish")
 @end smallexample 
 @end defun
 
-- 
2.28.0

Re: [PATCH] gdb/docs: add parentheses in Python examples using print

[Eli Zaretskii]

> Date: Fri,  8 Jan 2021 09:29:35 +0000
> From: Marco Barisione via Gdb-patches <gdb-patches@sourceware.org>
> 
> This makes the examples work both in Python 2 and 3.
> 
> gdb/doc/ChangeLog:
> 
> 	* python.texi: Add parentheses to print statements/functions.

I'm okay with the changes, assuming that some Python person says it's
indeed correct from Python POV.

Thanks.

Re: [PATCH] gdb/docs: add parentheses in Python examples using print

[Andrew Burgess]

* Eli Zaretskii via Gdb-patches <gdb-patches@sourceware.org> [2021-01-08 12:22:59 +0200]:

> > Date: Fri,  8 Jan 2021 09:29:35 +0000
> > From: Marco Barisione via Gdb-patches <gdb-patches@sourceware.org>
> > 
> > This makes the examples work both in Python 2 and 3.
> > 
> > gdb/doc/ChangeLog:
> > 
> > 	* python.texi: Add parentheses to print statements/functions.
> 
> I'm okay with the changes, assuming that some Python person says it's
> indeed correct from Python POV.

I'm no Python expert, but can confirm the updated code should work in
Python 2 and 3, while the original is 2 only.

This seems like a good change to me.

Thanks,
Andrew

[PING][PATCH] gdb/docs: add parentheses in Python examples using print

[Marco Barisione]

Ping.

On Fri, 8 Jan 2021 at 09:29, Marco Barisione <mbarisione@undo.io> wrote:
>
> This makes the examples work both in Python 2 and 3.
>
> gdb/doc/ChangeLog:
>
>         * python.texi: Add parentheses to print statements/functions.
> ---
>  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 0f776f54768..da81906d03d 100644
> --- a/gdb/doc/python.texi
> +++ b/gdb/doc/python.texi
> @@ -559,7 +559,7 @@ rather recognizes it when thrown from user Python code.  Example:
>  >    argv = gdb.string_to_argv (args)
>  >    if len (argv) != 0:
>  >      raise gdb.GdbError ("hello-world takes no arguments")
> ->    print "Hello, World!"
> +>    print ("Hello, World!")
>  >HelloWorld ()
>  >end
>  (gdb) hello-world 42
> @@ -3100,8 +3100,8 @@ Here is an example:
>
>  @smallexample
>  def exit_handler (event):
> -    print "event type: exit"
> -    print "exit code: %d" % (event.exit_code)
> +    print ("event type: exit")
> +    print ("exit code: %d" % (event.exit_code))
>
>  gdb.events.exited.connect (exit_handler)
>  @end smallexample
> @@ -3921,7 +3921,7 @@ class HelloWorld (gdb.Command):
>      super (HelloWorld, self).__init__ ("hello-world", gdb.COMMAND_USER)
>
>    def invoke (self, arg, from_tty):
> -    print "Hello, World!"
> +    print ("Hello, World!")
>
>  HelloWorld ()
>  @end smallexample
> @@ -4309,7 +4309,7 @@ def clear_objfiles_handler(event):
>      event.progspace.expensive_computation = None
>  def expensive(symbol):
>      """A mock routine to perform an "expensive" computation on symbol."""
> -    print "Computing the answer to the ultimate question ..."
> +    print ("Computing the answer to the ultimate question ...")
>      return 42
>  def new_objfile_handler(event):
>      objfile = event.new_objfile
> @@ -4654,7 +4654,7 @@ versions.  Using it, you could write:
>  reason = gdb.selected_frame().unwind_stop_reason ()
>  reason_str =  gdb.frame_stop_reason_string (reason)
>  if reason >=  gdb.FRAME_UNWIND_FIRST_ERROR:
> -    print "An error occured: %s" % reason_str
> +    print ("An error occured: %s" % reason_str)
>  @end smallexample
>  @end table
>
> @@ -5295,7 +5295,7 @@ example illustrating iterating over a line table.
>  symtab = gdb.selected_frame().find_sal().symtab
>  linetable = symtab.linetable()
>  for line in linetable:
> -   print "Line: "+str(line.line)+" Address: "+hex(line.pc)
> +   print ("Line: "+str(line.line)+" Address: "+hex(line.pc))
>  @end smallexample
>
>  This will have the following output:
> @@ -5618,11 +5618,11 @@ method:
>  @smallexample
>  class MyFinishBreakpoint (gdb.FinishBreakpoint)
>      def stop (self):
> -        print "normal finish"
> +        print ("normal finish")
>          return True
>
>      def out_of_scope ():
> -        print "abnormal finish"
> +        print ("abnormal finish")
>  @end smallexample
>  @end defun
>
> --
> 2.28.0
>

Re: [PING][PATCH] gdb/docs: add parentheses in Python examples using print

[Simon Marchi]

I think we were just missing for someone to push the patch, so I did it.

Simon

On 2021-01-25 9:07 a.m., Marco Barisione via Gdb-patches wrote:
> Ping.
> 
> On Fri, 8 Jan 2021 at 09:29, Marco Barisione <mbarisione@undo.io> wrote:
>>
>> This makes the examples work both in Python 2 and 3.
>>
>> gdb/doc/ChangeLog:
>>
>>         * python.texi: Add parentheses to print statements/functions.
>> ---
>>  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 0f776f54768..da81906d03d 100644
>> --- a/gdb/doc/python.texi
>> +++ b/gdb/doc/python.texi
>> @@ -559,7 +559,7 @@ rather recognizes it when thrown from user Python code.  Example:
>>  >    argv = gdb.string_to_argv (args)
>>  >    if len (argv) != 0:
>>  >      raise gdb.GdbError ("hello-world takes no arguments")
>> ->    print "Hello, World!"
>> +>    print ("Hello, World!")
>>  >HelloWorld ()
>>  >end
>>  (gdb) hello-world 42
>> @@ -3100,8 +3100,8 @@ Here is an example:
>>
>>  @smallexample
>>  def exit_handler (event):
>> -    print "event type: exit"
>> -    print "exit code: %d" % (event.exit_code)
>> +    print ("event type: exit")
>> +    print ("exit code: %d" % (event.exit_code))
>>
>>  gdb.events.exited.connect (exit_handler)
>>  @end smallexample
>> @@ -3921,7 +3921,7 @@ class HelloWorld (gdb.Command):
>>      super (HelloWorld, self).__init__ ("hello-world", gdb.COMMAND_USER)
>>
>>    def invoke (self, arg, from_tty):
>> -    print "Hello, World!"
>> +    print ("Hello, World!")
>>
>>  HelloWorld ()
>>  @end smallexample
>> @@ -4309,7 +4309,7 @@ def clear_objfiles_handler(event):
>>      event.progspace.expensive_computation = None
>>  def expensive(symbol):
>>      """A mock routine to perform an "expensive" computation on symbol."""
>> -    print "Computing the answer to the ultimate question ..."
>> +    print ("Computing the answer to the ultimate question ...")
>>      return 42
>>  def new_objfile_handler(event):
>>      objfile = event.new_objfile
>> @@ -4654,7 +4654,7 @@ versions.  Using it, you could write:
>>  reason = gdb.selected_frame().unwind_stop_reason ()
>>  reason_str =  gdb.frame_stop_reason_string (reason)
>>  if reason >=  gdb.FRAME_UNWIND_FIRST_ERROR:
>> -    print "An error occured: %s" % reason_str
>> +    print ("An error occured: %s" % reason_str)
>>  @end smallexample
>>  @end table
>>
>> @@ -5295,7 +5295,7 @@ example illustrating iterating over a line table.
>>  symtab = gdb.selected_frame().find_sal().symtab
>>  linetable = symtab.linetable()
>>  for line in linetable:
>> -   print "Line: "+str(line.line)+" Address: "+hex(line.pc)
>> +   print ("Line: "+str(line.line)+" Address: "+hex(line.pc))
>>  @end smallexample
>>
>>  This will have the following output:
>> @@ -5618,11 +5618,11 @@ method:
>>  @smallexample
>>  class MyFinishBreakpoint (gdb.FinishBreakpoint)
>>      def stop (self):
>> -        print "normal finish"
>> +        print ("normal finish")
>>          return True
>>
>>      def out_of_scope ():
>> -        print "abnormal finish"
>> +        print ("abnormal finish")
>>  @end smallexample
>>  @end defun
>>
>> --
>> 2.28.0
>>

Re: [PING][PATCH] gdb/docs: add parentheses in Python examples using print

[Eli Zaretskii]

> Date: Mon, 25 Jan 2021 14:07:44 +0000
> From: Marco Barisione via Gdb-patches <gdb-patches@sourceware.org>
> 
> Ping.

AFAIU, this patch was already approved.

Re: [PING][PATCH] gdb/docs: add parentheses in Python examples using print

[Marco Barisione]

On 25 Jan 2021, at 15:41, Eli Zaretskii <eliz@gnu.org> wrote:
>> Date: Mon, 25 Jan 2021 14:07:44 +0000
>> From: Marco Barisione via Gdb-patches <gdb-patches@sourceware.org>
>> 
>> Ping.
> 
> AFAIU, this patch was already approved.

Sorry! You said you were waiting for some Python person and Andrew said
"I'm no Python expert” so I wrongly assumed you were still waiting for
more feedback.

-- 
Marco Barisione