Use namedtuples for bestmove

CHANGELOG.rst

@@ -15,6 +15,9 @@ Up for the next release
   The `result` property and `wait()` have been removed in favor of a
   synchronously waiting `result()` method.
 
+* The result of the `stop` and `go` UCI commands are now named tuples (instead
+  of just normal tuples).
+
 New in v0.7.0
 -------------
 

README.rst

@@ -229,13 +229,13 @@ Features
       >>> board = chess.Bitboard("1k1r4/pp1b1R2/3q2pp/4p3/2B5/4Q3/PPP2B2/2K5 b - - 0 1")
       >>> engine.position(board)
       >>> engine.go(movetime=2000) # Gets tuple of bestmove and pondermove.
-      (Move.from_uci('d6d1'), Move.from_uci('c1d1'))
+      Bestmove(bestmove=Move.from_uci('d6d1'), pondermove=Move.from_uci('c1d1'))
 
       >>> # Synchronous communication, but search in background.
       >>> engine.go(infinite=True)
       >>> time.sleep(2)
       >>> engine.stop()
-      (Move.from_uci('d6d1'), Move.from_uci('c1d1'))
+      Bestmove(bestmove=Move.from_uci('d6d1'), pondermove=Move.from_uci('c1d1'))
 
       >>> # Asynchronous mode.
       >>> def callback(command):
@@ -246,7 +246,7 @@ Features
       >>> command.done()
       False
       >>> command.result()
-      (Move.from_uci('d6d1'), Move.from_uci('c1d1'))
+      Bestmove(bestmove=Move.from_uci('d6d1'), pondermove=Move.from_uci('c1d1'))
       >>> command.done()
       True
 

chess/uci.py

@@ -49,6 +49,11 @@ class Score(collections.namedtuple("Score", ["cp", "mate", "lowerbound", "upperb
     pass
 
 
+class Bestmove(collections.namedtuple("Bestmove", ["bestmove", "pondermove"])):
+    """A bestmove and pondermove sent by an UCI engine."""
+    pass
+
+
 class OptionMap(collections.MutableMapping):
     def __init__(self, data=None, **kwargs):
         self._store = dict()
@@ -494,7 +499,7 @@ def execute(self, engine):
             self.set_result(None)
         else:
             engine.bestmove_received.wait()
-            self.set_result((engine.bestmove, engine.ponder))
+            self.set_result(Bestmove(engine.bestmove, engine.ponder))
 
 
 class StopCommand(Command):
@@ -511,7 +516,7 @@ def execute(self, engine):
         engine.readyok.wait()
 
         engine.bestmove_received.wait(STOP_TIMEOUT)
-        self.set_result((engine.bestmove, engine.ponder))
+        self.set_result(Bestmove(engine.bestmove, engine.ponder))
 
 
 class PonderhitCommand(IsReadyCommand):

docs/uci.rst

@@ -57,7 +57,7 @@ By default all operations are executed synchronously and their result is
 returned. For example
 
 >>> engine.go(movetime=2000)
-(Move.from_uci('e2e4'), None)
+Bestmove(bestmove=Move.from_uci('e2e4'), pondermove=None)
 
 will take about 2000 milliseconds. All UCI commands have an optional
 *async_callback* argument. They will then immediately return information about
@@ -67,7 +67,7 @@ the command and continue.
 >>> command.done()
 False
 >>> command.result() # Synchronously wait for the command to finish
-(Move.from_uci('e2e4'), None)
+Bestmove(bestmove=Move.from_uci('e2e4'), pondermove=None)
 >>> command.done()
 True