gdb/python: handle completion returning a non-sequence

GDB's Python API documentation for gdb.Command.complete() says:

  The 'complete' method can return several values:
     * If the return value is a sequence, the contents of the
       sequence are used as the completions.  It is up to 'complete'
       to ensure that the contents actually do complete the word.  A
       zero-length sequence is allowed, it means that there were no
       completions available.  Only string elements of the sequence
       are used; other elements in the sequence are ignored.

     * If the return value is one of the 'COMPLETE_' constants
       defined below, then the corresponding GDB-internal completion
       function is invoked, and its result is used.

     * All other results are treated as though there were no
       available completions.

So, returning a non-sequence, and non-integer from a complete method
should be fine; it should just be treated as though there are no
completions.

However, if I write a complete method that returns None, I see this
behaviour:

  (gdb) complete completefilenone x
  Python Exception <class 'TypeError'>: 'NoneType' object is not iterable
  warning: internal error: Unhandled Python exception
  (gdb)

Which is caused because we currently assume that anything that is not
an integer must be iterable, and we call PyObject_GetIter on it.  When
this call fails a Python exception is set, but instead of
clearing (and therefore ignoring) this exception as we do everywhere
else in the Python completion code, we instead just return with the
exception set.

In this commit I add a PySequence_Check call.  If this call returns
false (and we've already checked the integer case) then we can assume
there are no completion results.

I've added a test which checks returning a non-sequence.

Approved-By: Tom Tromey <tom@tromey.com>

2 files changed, 17 insertions, 0 deletions

diff --git a/gdb/testsuite/gdb.python/py-completion.exp b/gdb/testsuite/gdb.python/py-completion.exp
index 23f981e..89843c9 100644
--- a/gdb/testsuite/gdb.python/py-completion.exp
+++ b/gdb/testsuite/gdb.python/py-completion.exp
@@ -46,6 +46,11 @@ if { [readline_is_used] && ![is_remote host] } {
     # Just discarding whatever we typed.
     gdb_test " " ".*" "discard #[incr discard]"
 
+    # This should offer no suggestions - the complete() methods
+    # returns something that is neither an integer, or a sequence.
+    gdb_test_no_output "complete completefilenone ${testdir_complete}" \
+	"no suggestions given"
+
     # This is the problematic one.
     send_gdb "completefilemethod ${testdir_complete}\t"
     gdb_test_multiple "" "completefilemethod completion" {
diff --git a/gdb/testsuite/gdb.python/py-completion.py b/gdb/testsuite/gdb.python/py-completion.py
index abec069..61b6bef 100644
--- a/gdb/testsuite/gdb.python/py-completion.py
+++ b/gdb/testsuite/gdb.python/py-completion.py
@@ -28,6 +28,17 @@ class CompleteFileInit(gdb.Command):
         raise gdb.GdbError("not implemented")
 
 
+class CompleteFileNone(gdb.Command):
+    def __init__(self):
+        gdb.Command.__init__(self, "completefilenone", gdb.COMMAND_USER)
+
+    def invoke(self, argument, from_tty):
+        raise gdb.GdbError("not implemented")
+
+    def complete(self, text, word):
+        return None
+
+
 class CompleteFileMethod(gdb.Command):
     def __init__(self):
         gdb.Command.__init__(self, "completefilemethod", gdb.COMMAND_USER)
@@ -203,6 +214,7 @@ class CompleteLimit7(gdb.Command):
 
 
 CompleteFileInit()
+CompleteFileNone()
 CompleteFileMethod()
 CompleteFileCommandCond()
 CompleteLimit1()