-
-
Notifications
You must be signed in to change notification settings - Fork 530
/
engine.py
2938 lines (2376 loc) · 115 KB
/
engine.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# This file is part of the python-chess library.
# Copyright (C) 2012-2021 Niklas Fiekas <niklas.fiekas@backscattering.de>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
import abc
import asyncio
import collections
import concurrent.futures
import contextlib
import copy
import dataclasses
import enum
import logging
import math
import warnings
import shlex
import subprocess
import sys
import threading
import time
import typing
import os
import re
import chess
from chess import Color
from types import TracebackType
from typing import Any, Callable, Coroutine, Deque, Dict, Generator, Generic, Iterable, Iterator, List, Mapping, MutableMapping, Optional, Tuple, Type, TypeVar, Union
try:
from typing import Literal
_WdlModel = Literal["sf", "sf15", "sf14", "sf12", "lichess"]
except ImportError:
# Before Python 3.8.
_WdlModel = str # type: ignore
T = TypeVar("T")
ProtocolT = TypeVar("ProtocolT", bound="Protocol")
ConfigValue = Union[str, int, bool, None]
ConfigMapping = Mapping[str, ConfigValue]
LOGGER = logging.getLogger(__name__)
MANAGED_OPTIONS = ["uci_chess960", "uci_variant", "multipv", "ponder"]
class EventLoopPolicy(asyncio.AbstractEventLoopPolicy):
"""
An event loop policy for thread-local event loops and child watchers.
Ensures each event loop is capable of spawning and watching subprocesses,
even when not running on the main thread.
Windows: Uses :class:`~asyncio.ProactorEventLoop`.
Unix: Uses :class:`~asyncio.SelectorEventLoop`. If available,
:class:`~asyncio.PidfdChildWatcher` is used to detect subprocess
termination (Python 3.9+ on Linux 5.3+). Otherwise, the default child
watcher is used on the main thread and relatively slow eager polling
is used on all other threads.
"""
class _Local(threading.local):
loop: Optional[asyncio.AbstractEventLoop] = None
set_called = False
watcher: Optional[asyncio.AbstractChildWatcher] = None
def __init__(self) -> None:
self._local = self._Local()
def get_event_loop(self) -> asyncio.AbstractEventLoop:
if self._local.loop is None and not self._local.set_called and threading.current_thread() is threading.main_thread():
self.set_event_loop(self.new_event_loop())
if self._local.loop is None:
raise RuntimeError(f"no current event loop in thread {threading.current_thread().name!r}")
return self._local.loop
def set_event_loop(self, loop: Optional[asyncio.AbstractEventLoop]) -> None:
assert loop is None or isinstance(loop, asyncio.AbstractEventLoop)
self._local.set_called = True
self._local.loop = loop
if self._local.watcher is not None:
self._local.watcher.attach_loop(loop)
def new_event_loop(self) -> asyncio.AbstractEventLoop:
return asyncio.ProactorEventLoop() if sys.platform == "win32" else asyncio.SelectorEventLoop() # type: ignore
def get_child_watcher(self) -> asyncio.AbstractChildWatcher:
if self._local.watcher is None:
self._local.watcher = self._init_watcher()
self._local.watcher.attach_loop(self._local.loop)
return self._local.watcher
def set_child_watcher(self, watcher: Optional[asyncio.AbstractChildWatcher]) -> None:
assert watcher is None or isinstance(watcher, asyncio.AbstractChildWatcher)
if self._local.watcher is not None:
self._local.watcher.close()
self._local.watcher = watcher
def _init_watcher(self) -> asyncio.AbstractChildWatcher:
if sys.platform == "win32":
raise NotImplementedError
try:
os.close(os.pidfd_open(os.getpid()))
watcher: asyncio.AbstractChildWatcher = asyncio.PidfdChildWatcher()
LOGGER.debug("Using PidfdChildWatcher")
return watcher
except (AttributeError, OSError):
# Before Python 3.9 or before Linux 5.3 or the syscall is not
# permitted.
pass
if threading.current_thread() is threading.main_thread():
try:
watcher = asyncio.ThreadedChildWatcher()
LOGGER.debug("Using ThreadedChildWatcher")
return watcher
except AttributeError:
# Before Python 3.8.
LOGGER.debug("Using SafeChildWatcher")
return asyncio.SafeChildWatcher()
class PollingChildWatcher(asyncio.SafeChildWatcher):
_loop: Optional[asyncio.AbstractEventLoop]
_callbacks: Dict[int, Any]
def __init__(self) -> None:
super().__init__()
self._poll_handle: Optional[asyncio.Handle] = None
self._poll_delay = 0.001
def attach_loop(self, loop: Optional[asyncio.AbstractEventLoop]) -> None:
assert loop is None or isinstance(loop, asyncio.AbstractEventLoop)
if self._loop is not None and loop is None and self._callbacks:
warnings.warn("A loop is being detached from a child watcher with pending handlers", RuntimeWarning)
if self._poll_handle is not None:
self._poll_handle.cancel()
self._loop = loop
if self._loop is not None:
self._poll_handle = self._loop.call_soon(self._poll)
self._do_waitpid_all() # type: ignore
def _poll(self) -> None:
if self._loop:
self._do_waitpid_all() # type: ignore
self._poll_delay = min(self._poll_delay * 2, 1.0)
self._poll_handle = self._loop.call_later(self._poll_delay, self._poll)
LOGGER.debug("Using PollingChildWatcher")
return PollingChildWatcher()
def run_in_background(coroutine: Callable[[concurrent.futures.Future[T]], Coroutine[Any, Any, None]], *, name: Optional[str] = None, debug: bool = False, _policy_lock: threading.Lock = threading.Lock()) -> T:
"""
Runs ``coroutine(future)`` in a new event loop on a background thread.
Blocks on *future* and returns the result as soon as it is resolved.
The coroutine and all remaining tasks continue running in the background
until complete.
Note: This installs a :class:`chess.engine.EventLoopPolicy` for the entire
process.
"""
assert asyncio.iscoroutinefunction(coroutine)
with _policy_lock:
if not isinstance(asyncio.get_event_loop_policy(), EventLoopPolicy):
asyncio.set_event_loop_policy(EventLoopPolicy())
future: concurrent.futures.Future[T] = concurrent.futures.Future()
def background() -> None:
try:
asyncio.run(coroutine(future))
future.cancel()
except Exception as exc:
future.set_exception(exc)
threading.Thread(target=background, name=name).start()
return future.result()
class EngineError(RuntimeError):
"""Runtime error caused by a misbehaving engine or incorrect usage."""
class EngineTerminatedError(EngineError):
"""The engine process exited unexpectedly."""
class AnalysisComplete(Exception):
"""
Raised when analysis is complete, all information has been consumed, but
further information was requested.
"""
@dataclasses.dataclass(frozen=True)
class Option:
"""Information about an available engine option."""
name: str
"""The name of the option."""
type: str
"""
The type of the option.
+--------+-----+------+------------------------------------------------+
| type | UCI | CECP | value |
+========+=====+======+================================================+
| check | X | X | ``True`` or ``False`` |
+--------+-----+------+------------------------------------------------+
| spin | X | X | integer, between *min* and *max* |
+--------+-----+------+------------------------------------------------+
| combo | X | X | string, one of *var* |
+--------+-----+------+------------------------------------------------+
| button | X | X | ``None`` |
+--------+-----+------+------------------------------------------------+
| reset | | X | ``None`` |
+--------+-----+------+------------------------------------------------+
| save | | X | ``None`` |
+--------+-----+------+------------------------------------------------+
| string | X | X | string without line breaks |
+--------+-----+------+------------------------------------------------+
| file | | X | string, interpreted as the path to a file |
+--------+-----+------+------------------------------------------------+
| path | | X | string, interpreted as the path to a directory |
+--------+-----+------+------------------------------------------------+
"""
default: ConfigValue
"""The default value of the option."""
min: Optional[int]
"""The minimum integer value of a *spin* option."""
max: Optional[int]
"""The maximum integer value of a *spin* option."""
var: Optional[List[str]]
"""A list of allowed string values for a *combo* option."""
def parse(self, value: ConfigValue) -> ConfigValue:
if self.type == "check":
return value and value != "false"
elif self.type == "spin":
try:
value = int(value) # type: ignore
except ValueError:
raise EngineError(f"expected integer for spin option {self.name!r}, got: {value!r}")
if self.min is not None and value < self.min:
raise EngineError(f"expected value for option {self.name!r} to be at least {self.min}, got: {value}")
if self.max is not None and self.max < value:
raise EngineError(f"expected value for option {self.name!r} to be at most {self.max}, got: {value}")
return value
elif self.type == "combo":
value = str(value)
if value not in (self.var or []):
raise EngineError("invalid value for combo option {!r}, got: {} (available: {})".format(self.name, value, ", ".join(self.var) if self.var else "-"))
return value
elif self.type in ["button", "reset", "save"]:
return None
elif self.type in ["string", "file", "path"]:
value = str(value)
if "\n" in value or "\r" in value:
raise EngineError(f"invalid line-break in string option {self.name!r}: {value!r}")
return value
else:
raise EngineError(f"unknown option type: {self.type!r}")
def is_managed(self) -> bool:
"""
Some options are managed automatically: ``UCI_Chess960``,
``UCI_Variant``, ``MultiPV``, ``Ponder``.
"""
return self.name.lower() in MANAGED_OPTIONS
@dataclasses.dataclass
class Limit:
"""Search-termination condition."""
time: Optional[float] = None
"""Search exactly *time* seconds."""
depth: Optional[int] = None
"""Search *depth* ply only."""
nodes: Optional[int] = None
"""Search only a limited number of *nodes*."""
mate: Optional[int] = None
"""Search for a mate in *mate* moves."""
white_clock: Optional[float] = None
"""Time in seconds remaining for White."""
black_clock: Optional[float] = None
"""Time in seconds remaining for Black."""
white_inc: Optional[float] = None
"""Fisher increment for White, in seconds."""
black_inc: Optional[float] = None
"""Fisher increment for Black, in seconds."""
remaining_moves: Optional[int] = None
"""
Number of moves to the next time control. If this is not set, but
*white_clock* and *black_clock* are, then it is sudden death.
"""
def __repr__(self) -> str:
# Like default __repr__, but without None values.
return "{}({})".format(
type(self).__name__,
", ".join("{}={!r}".format(attr, getattr(self, attr))
for attr in ["time", "depth", "nodes", "mate", "white_clock", "black_clock", "white_inc", "black_inc", "remaining_moves"]
if getattr(self, attr) is not None))
try:
class InfoDict(typing.TypedDict, total=False):
"""
Dictionary of aggregated information sent by the engine.
Commonly used keys are: ``score`` (a :class:`~chess.engine.PovScore`),
``pv`` (a list of :class:`~chess.Move` objects), ``depth``,
``seldepth``, ``time`` (in seconds), ``nodes``, ``nps``, ``multipv``
(``1`` for the mainline).
Others: ``tbhits``, ``currmove``, ``currmovenumber``, ``hashfull``,
``cpuload``, ``refutation``, ``currline``, ``ebf`` (effective branching factor),
``wdl`` (a :class:`~chess.engine.PovWdl`), and ``string``.
"""
score: PovScore
pv: List[chess.Move]
depth: int
seldepth: int
time: float
nodes: int
nps: int
tbhits: int
multipv: int
currmove: chess.Move
currmovenumber: int
hashfull: int
cpuload: int
refutation: Dict[chess.Move, List[chess.Move]]
currline: Dict[int, List[chess.Move]]
ebf: float
wdl: PovWdl
string: str
except AttributeError:
# Before Python 3.8.
InfoDict = dict # type: ignore
class PlayResult:
"""Returned by :func:`chess.engine.Protocol.play()`."""
move: Optional[chess.Move]
"""The best move according to the engine, or ``None``."""
ponder: Optional[chess.Move]
"""The response that the engine expects after *move*, or ``None``."""
info: InfoDict
"""
A dictionary of extra :class:`information <chess.engine.InfoDict>`
sent by the engine, if selected with the *info* argument of
:func:`~chess.engine.Protocol.play()`.
"""
draw_offered: bool
"""Whether the engine offered a draw before moving."""
resigned: bool
"""Whether the engine resigned."""
def __init__(self,
move: Optional[chess.Move],
ponder: Optional[chess.Move],
info: Optional[InfoDict] = None,
*,
draw_offered: bool = False,
resigned: bool = False) -> None:
self.move = move
self.ponder = ponder
self.info = info or {}
self.draw_offered = draw_offered
self.resigned = resigned
def __repr__(self) -> str:
return "<{} at {:#x} (move={}, ponder={}, info={}, draw_offered={}, resigned={})>".format(
type(self).__name__, id(self), self.move, self.ponder, self.info,
self.draw_offered, self.resigned)
class Info(enum.IntFlag):
"""Used to filter information sent by the chess engine."""
NONE = 0
BASIC = 1
SCORE = 2
PV = 4
REFUTATION = 8
CURRLINE = 16
ALL = BASIC | SCORE | PV | REFUTATION | CURRLINE
INFO_NONE = Info.NONE
INFO_BASIC = Info.BASIC
INFO_SCORE = Info.SCORE
INFO_PV = Info.PV
INFO_REFUTATION = Info.REFUTATION
INFO_CURRLINE = Info.CURRLINE
INFO_ALL = Info.ALL
class PovScore:
"""A relative :class:`~chess.engine.Score` and the point of view."""
relative: Score
"""The relative :class:`~chess.engine.Score`."""
turn: Color
"""The point of view (``chess.WHITE`` or ``chess.BLACK``)."""
def __init__(self, relative: Score, turn: Color) -> None:
self.relative = relative
self.turn = turn
def white(self) -> Score:
"""Gets the score from White's point of view."""
return self.pov(chess.WHITE)
def black(self) -> Score:
"""Gets the score from Black's point of view."""
return self.pov(chess.BLACK)
def pov(self, color: Color) -> Score:
"""Gets the score from the point of view of the given *color*."""
return self.relative if self.turn == color else -self.relative
def is_mate(self) -> bool:
"""Tests if this is a mate score."""
return self.relative.is_mate()
def wdl(self, *, model: _WdlModel = "sf", ply: int = 30) -> PovWdl:
"""See :func:`~chess.engine.Score.wdl()`."""
return PovWdl(self.relative.wdl(), self.turn)
def __repr__(self) -> str:
return "PovScore({!r}, {})".format(self.relative, "WHITE" if self.turn else "BLACK")
def __eq__(self, other: object) -> bool:
if isinstance(other, PovScore):
return self.white() == other.white()
else:
return NotImplemented
class Score(abc.ABC):
"""
Evaluation of a position.
The score can be :class:`~chess.engine.Cp` (centi-pawns),
:class:`~chess.engine.Mate` or :py:data:`~chess.engine.MateGiven`.
A positive value indicates an advantage.
There is a total order defined on centi-pawn and mate scores.
>>> from chess.engine import Cp, Mate, MateGiven
>>>
>>> Mate(-0) < Mate(-1) < Cp(-50) < Cp(200) < Mate(4) < Mate(1) < MateGiven
True
Scores can be negated to change the point of view:
>>> -Cp(20)
Cp(-20)
>>> -Mate(-4)
Mate(+4)
>>> -Mate(0)
MateGiven
"""
@typing.overload
def score(self, *, mate_score: int) -> int: ...
@typing.overload
def score(self, *, mate_score: Optional[int] = None) -> Optional[int]: ...
@abc.abstractmethod
def score(self, *, mate_score: Optional[int] = None) -> Optional[int]:
"""
Returns the centi-pawn score as an integer or ``None``.
You can optionally pass a large value to convert mate scores to
centi-pawn scores.
>>> Cp(-300).score()
-300
>>> Mate(5).score() is None
True
>>> Mate(5).score(mate_score=100000)
99995
"""
@abc.abstractmethod
def mate(self) -> Optional[int]:
"""
Returns the number of plies to mate, negative if we are getting
mated, or ``None``.
.. warning::
This conflates ``Mate(0)`` (we lost) and ``MateGiven``
(we won) to ``0``.
"""
def is_mate(self) -> bool:
"""Tests if this is a mate score."""
return self.mate() is not None
@abc.abstractmethod
def wdl(self, *, model: _WdlModel = "sf", ply: int = 30) -> Wdl:
"""
Returns statistics for the expected outcome of this game, based on
a *model*, given that this score is reached at *ply*.
Scores have a total order, but it makes little sense to compute
the difference between two scores. For example, going from
``Cp(-100)`` to ``Cp(+100)`` is much more significant than going
from ``Cp(+300)`` to ``Cp(+500)``. It is better to compute differences
of the expectation values for the outcome of the game (based on winning
chances and drawing chances).
>>> Cp(100).wdl().expectation() - Cp(-100).wdl().expectation() # doctest: +ELLIPSIS
0.379...
>>> Cp(500).wdl().expectation() - Cp(300).wdl().expectation() # doctest: +ELLIPSIS
0.015...
:param model:
* ``sf``, the WDL model used by the latest Stockfish
(currently ``sf15``).
* ``sf15``, the WDL model used by Stockfish 15.
* ``sf14``, the WDL model used by Stockfish 14.
* ``sf12``, the WDL model used by Stockfish 12.
* ``lichess``, the win rate model used by Lichess.
Does not use *ply*, and does not consider drawing chances.
:param ply: The number of half-moves played since the starting
position. Models may scale scores slightly differently based on
this. Defaults to middle game.
"""
@abc.abstractmethod
def __neg__(self) -> Score:
...
@abc.abstractmethod
def __pos__(self) -> Score:
...
@abc.abstractmethod
def __abs__(self) -> Score:
...
def _score_tuple(self) -> Tuple[bool, bool, bool, int, Optional[int]]:
mate = self.mate()
return (
isinstance(self, MateGivenType),
mate is not None and mate > 0,
mate is None,
-(mate or 0),
self.score(),
)
def __eq__(self, other: object) -> bool:
if isinstance(other, Score):
return self._score_tuple() == other._score_tuple()
else:
return NotImplemented
def __lt__(self, other: object) -> bool:
if isinstance(other, Score):
return self._score_tuple() < other._score_tuple()
else:
return NotImplemented
def __le__(self, other: object) -> bool:
if isinstance(other, Score):
return self._score_tuple() <= other._score_tuple()
else:
return NotImplemented
def __gt__(self, other: object) -> bool:
if isinstance(other, Score):
return self._score_tuple() > other._score_tuple()
else:
return NotImplemented
def __ge__(self, other: object) -> bool:
if isinstance(other, Score):
return self._score_tuple() >= other._score_tuple()
else:
return NotImplemented
def _sf15_wins(cp: int, *, ply: int) -> int:
# https://github.com/official-stockfish/Stockfish/blob/sf_15/src/uci.cpp#L200-L220
m = min(240, max(ply, 0)) / 64
a = (((-1.17202460e-1 * m + 5.94729104e-1) * m + 1.12065546e+1) * m) + 1.22606222e+2
b = (((-1.79066759 * m + 11.30759193) * m + -17.43677612) * m) + 36.47147479
x = min(2000, max(cp, -2000))
return int(0.5 + 1000 / (1 + math.exp((a - x) / b)))
def _sf14_wins(cp: int, *, ply: int) -> int:
# https://github.com/official-stockfish/Stockfish/blob/sf_14/src/uci.cpp#L200-L220
m = min(240, max(ply, 0)) / 64
a = (((-3.68389304 * m + 30.07065921) * m + -60.52878723) * m) + 149.53378557
b = (((-2.01818570 * m + 15.85685038) * m + -29.83452023) * m) + 47.59078827
x = min(2000, max(cp, -2000))
return int(0.5 + 1000 / (1 + math.exp((a - x) / b)))
def _sf12_wins(cp: int, *, ply: int) -> int:
# https://github.com/official-stockfish/Stockfish/blob/sf_12/src/uci.cpp#L198-L218
m = min(240, max(ply, 0)) / 64
a = (((-8.24404295 * m + 64.23892342) * m + -95.73056462) * m) + 153.86478679
b = (((-3.37154371 * m + 28.44489198) * m + -56.67657741) * m) + 72.05858751
x = min(1000, max(cp, -1000))
return int(0.5 + 1000 / (1 + math.exp((a - x) / b)))
def _lichess_raw_wins(cp: int) -> int:
return round(1000 / (1 + math.exp(-0.004 * cp)))
class Cp(Score):
"""Centi-pawn score."""
def __init__(self, cp: int) -> None:
self.cp = cp
def mate(self) -> None:
return None
def score(self, *, mate_score: Optional[int] = None) -> int:
return self.cp
def wdl(self, *, model: _WdlModel = "sf", ply: int = 30) -> Wdl:
if model == "lichess":
wins = _lichess_raw_wins(max(-1000, min(self.cp, 1000)))
losses = 1000 - wins
elif model == "sf12":
wins = _sf12_wins(self.cp, ply=ply)
losses = _sf12_wins(-self.cp, ply=ply)
elif model == "sf14":
wins = _sf14_wins(self.cp, ply=ply)
losses = _sf14_wins(-self.cp, ply=ply)
else:
wins = _sf15_wins(self.cp, ply=ply)
losses = _sf15_wins(-self.cp, ply=ply)
draws = 1000 - wins - losses
return Wdl(wins, draws, losses)
def __str__(self) -> str:
return f"+{self.cp:d}" if self.cp > 0 else str(self.cp)
def __repr__(self) -> str:
return f"Cp({self})"
def __neg__(self) -> Cp:
return Cp(-self.cp)
def __pos__(self) -> Cp:
return Cp(self.cp)
def __abs__(self) -> Cp:
return Cp(abs(self.cp))
class Mate(Score):
"""Mate score."""
def __init__(self, moves: int) -> None:
self.moves = moves
def mate(self) -> int:
return self.moves
@typing.overload
def score(self, *, mate_score: int) -> int: ...
@typing.overload
def score(self, *, mate_score: Optional[int] = None) -> Optional[int]: ...
def score(self, *, mate_score: Optional[int] = None) -> Optional[int]:
if mate_score is None:
return None
elif self.moves > 0:
return mate_score - self.moves
else:
return -mate_score - self.moves
def wdl(self, *, model: _WdlModel = "sf", ply: int = 30) -> Wdl:
if model == "lichess":
cp = (21 - min(10, abs(self.moves))) * 100
wins = _lichess_raw_wins(cp)
return Wdl(wins, 0, 1000 - wins) if self.moves > 0 else Wdl(1000 - wins, 0, wins)
else:
return Wdl(1000, 0, 0) if self.moves > 0 else Wdl(0, 0, 1000)
def __str__(self) -> str:
return f"#+{self.moves}" if self.moves > 0 else f"#-{abs(self.moves)}"
def __repr__(self) -> str:
return "Mate({})".format(str(self).lstrip("#"))
def __neg__(self) -> Union[MateGivenType, Mate]:
return MateGiven if not self.moves else Mate(-self.moves)
def __pos__(self) -> Mate:
return Mate(self.moves)
def __abs__(self) -> Union[MateGivenType, Mate]:
return MateGiven if not self.moves else Mate(abs(self.moves))
class MateGivenType(Score):
"""Winning mate score, equivalent to ``-Mate(0)``."""
def mate(self) -> int:
return 0
@typing.overload
def score(self, *, mate_score: int) -> int: ...
@typing.overload
def score(self, *, mate_score: Optional[int] = None) -> Optional[int]: ...
def score(self, *, mate_score: Optional[int] = None) -> Optional[int]:
return mate_score
def wdl(self, *, model: _WdlModel = "sf", ply: int = 30) -> Wdl:
return Wdl(1000, 0, 0)
def __neg__(self) -> Mate:
return Mate(0)
def __pos__(self) -> MateGivenType:
return self
def __abs__(self) -> MateGivenType:
return self
def __repr__(self) -> str:
return "MateGiven"
def __str__(self) -> str:
return "#+0"
MateGiven = MateGivenType()
class PovWdl:
"""
Relative :class:`win/draw/loss statistics <chess.engine.Wdl>` and the point
of view.
.. deprecated:: 1.2
Behaves like a tuple
``(wdl.relative.wins, wdl.relative.draws, wdl.relative.losses)``
for backwards compatibility. But it is recommended to use the provided
fields and methods instead.
"""
relative: Wdl
"""The relative :class:`~chess.engine.Wdl`."""
turn: Color
"""The point of view (``chess.WHITE`` or ``chess.BLACK``)."""
def __init__(self, relative: Wdl, turn: Color) -> None:
self.relative = relative
self.turn = turn
def white(self) -> Wdl:
"""Gets the :class:`~chess.engine.Wdl` from White's point of view."""
return self.pov(chess.WHITE)
def black(self) -> Wdl:
"""Gets the :class:`~chess.engine.Wdl` from Black's point of view."""
return self.pov(chess.BLACK)
def pov(self, color: Color) -> Wdl:
"""
Gets the :class:`~chess.engine.Wdl` from the point of view of the given
*color*.
"""
return self.relative if self.turn == color else -self.relative
def __bool__(self) -> bool:
return bool(self.relative)
def __repr__(self) -> str:
return "PovWdl({!r}, {})".format(self.relative, "WHITE" if self.turn else "BLACK")
# Unfortunately in python-chess v1.1.0, info["wdl"] was a simple tuple
# of the relative permille values, so we have to support __iter__,
# __len__, __getitem__, and equality comparisons with other tuples.
# Never mind the ordering, because that's not a sensible operation, anyway.
def __iter__(self) -> Iterator[int]:
yield self.relative.wins
yield self.relative.draws
yield self.relative.losses
def __len__(self) -> int:
return 3
def __getitem__(self, idx: int) -> int:
return (self.relative.wins, self.relative.draws, self.relative.losses)[idx]
def __eq__(self, other: object) -> bool:
if isinstance(other, PovWdl):
return self.white() == other.white()
elif isinstance(other, tuple):
return (self.relative.wins, self.relative.draws, self.relative.losses) == other
else:
return NotImplemented
@dataclasses.dataclass
class Wdl:
"""Win/draw/loss statistics."""
wins: int
"""The number of wins."""
draws: int
"""The number of draws."""
losses: int
"""The number of losses."""
def total(self) -> int:
"""
Returns the total number of games. Usually, ``wdl`` reported by engines
is scaled to 1000 games.
"""
return self.wins + self.draws + self.losses
def winning_chance(self) -> float:
"""Returns the relative frequency of wins."""
return self.wins / self.total()
def drawing_chance(self) -> float:
"""Returns the relative frequency of draws."""
return self.draws / self.total()
def losing_chance(self) -> float:
"""Returns the relative frequency of losses."""
return self.losses / self.total()
def expectation(self) -> float:
"""
Returns the expectation value, where a win is valued 1, a draw is
valued 0.5, and a loss is valued 0.
"""
return (self.wins + 0.5 * self.draws) / self.total()
def __bool__(self) -> bool:
return bool(self.total())
def __iter__(self) -> Iterator[int]:
yield self.wins
yield self.draws
yield self.losses
def __reversed__(self) -> Iterator[int]:
yield self.losses
yield self.draws
yield self.wins
def __pos__(self) -> Wdl:
return self
def __neg__(self) -> Wdl:
return Wdl(self.losses, self.draws, self.wins)
class MockTransport(asyncio.SubprocessTransport, asyncio.WriteTransport):
def __init__(self, protocol: Protocol) -> None:
super().__init__()
self.protocol = protocol
self.expectations: Deque[Tuple[str, List[str]]] = collections.deque()
self.expected_pings = 0
self.stdin_buffer = bytearray()
self.protocol.connection_made(self)
def expect(self, expectation: str, responses: List[str] = []) -> None:
self.expectations.append((expectation, responses))
def expect_ping(self) -> None:
self.expected_pings += 1
def assert_done(self) -> None:
assert not self.expectations, f"pending expectations: {self.expectations}"
def get_pipe_transport(self, fd: int) -> Optional[asyncio.BaseTransport]:
assert fd == 0, f"expected 0 for stdin, got {fd}"
return self
def write(self, data: bytes) -> None:
self.stdin_buffer.extend(data)
while b"\n" in self.stdin_buffer:
line_bytes, self.stdin_buffer = self.stdin_buffer.split(b"\n", 1)
line = line_bytes.decode("utf-8")
if line.startswith("ping ") and self.expected_pings:
self.expected_pings -= 1
self.protocol.pipe_data_received(1, (line.replace("ping ", "pong ") + "\n").encode("utf-8"))
else:
assert self.expectations, f"unexpected: {line!r}"
expectation, responses = self.expectations.popleft()
assert expectation == line, f"expected {expectation}, got: {line}"
if responses:
self.protocol.pipe_data_received(1, "\n".join(responses + [""]).encode("utf-8"))
def get_pid(self) -> int:
return id(self)
def get_returncode(self) -> Optional[int]:
return None if self.expectations else 0
class Protocol(asyncio.SubprocessProtocol, metaclass=abc.ABCMeta):
"""Protocol for communicating with a chess engine process."""
options: MutableMapping[str, Option]
"""Dictionary of available options."""
id: Dict[str, str]
"""
Dictionary of information about the engine. Common keys are ``name``
and ``author``.
"""
returncode: asyncio.Future[int]
"""Future: Exit code of the process."""
def __init__(self: ProtocolT) -> None:
self.loop = asyncio.get_running_loop()
self.transport: Optional[asyncio.SubprocessTransport] = None
self.buffer = {
1: bytearray(), # stdout
2: bytearray(), # stderr
}
self.command: Optional[BaseCommand[ProtocolT, Any]] = None
self.next_command: Optional[BaseCommand[ProtocolT, Any]] = None
self.initialized = False
self.returncode: asyncio.Future[int] = asyncio.Future()
def connection_made(self, transport: asyncio.BaseTransport) -> None:
# SubprocessTransport expected, but not checked to allow duck typing.
self.transport = transport # type: ignore
LOGGER.debug("%s: Connection made", self)
def connection_lost(self: ProtocolT, exc: Optional[Exception]) -> None:
assert self.transport is not None
code = self.transport.get_returncode()
assert code is not None, "connect lost, but got no returncode"
LOGGER.debug("%s: Connection lost (exit code: %d, error: %s)", self, code, exc)
# Terminate commands.
if self.command is not None:
self.command._engine_terminated(self, code)
self.command = None
if self.next_command is not None:
self.next_command._engine_terminated(self, code)