Option to return more info from Stockfish in .get_top_moves()

[knutole]

In certain use-cases it is nice to get more information from .get_top_moves(), like WDL, selective depth, nodes, etc.

One use-case for this is when evaluating full games. If you want both top moves for n lines, and the WDL, you'd have to run the evaluation multiple times. Also, there is currently no way of getting info like nodes, time, nps, etc.

# unchanged 
moves = stockfish.get_top_moves(2)
print(moves)
# [
#   {   
#     'Centipawn': None,
#     'Mate': 1,
#     'Move': 'e1e8'
#   },
#   {
#     'Centipawn': None,
#     'Mate': 2,
#     'Move': 'c8e8'
#   }
# ]

# unchanged
moves = stockfish.get_top_moves(2, include_info=False)
print(moves)
# [
#   {   
#     'Centipawn': None,
#     'Mate': 1,
#     'Move': 'e1e8'
#   },
#   {
#     'Centipawn': None,
#     'Mate': 2,
#     'Move': 'c8e8'
#   }
# ]

# returns more info
moves = stockfish.get_top_moves(2, include_info=True)
print(moves)
# [
#   {   
#     'Centipawn': None,
#     'Mate': 1,
#     'Move': 'e1e8',
#     'MultiPVLine': '1',
#     'N/s': '10255014',
#     'Nodes': '5096742',
#     'SelectiveDepth': '2',
#     'Time': '497',
#     'WDL': '1000 0 0'
#   },
#   {
#     'Centipawn': None,
#     'Mate': 2,
#     'Move': 'c8e8',
#     'MultiPVLine': '2',
#     'N/s': '10255014',
#     'Nodes': '5096742',
#     'SelectiveDepth': '4',
#     'Time': '497',
#     'WDL': '1000 0 0'
#   }
# ]

[github-actions]

Coverage report

The coverage rate went from 86% to 87% ⬆️
The branch rate is 79%.

85% of new lines are covered.

Diff Coverage details (click to unfold)

stockfish/models.py

86% of new lines are covered (87% of the complete file).

Missing lines: 601

[kieferro]

Thank you for your contribution to the project.

This project is no longer maintained in this repo but on this fork. (More information about this can be found here).

We are in the process of transferring the PRs to the fork one by one. Your two PRs (this and #116) would be next. That's why we would be very happy if you could close your two PRs on this repo and open them again for the fork. We will then review and merge them. Thanks.

[kieferro]

Hi @knutole. I just wanted to check back and see how things are. If you currently don't have the time/possibility to reopen the PR in the other repo, that's no problem at all. But please just let us know so we can plan. We wanted to merge your PRs first so we don't get any conflicts and we are currently still waiting with the other PRs. But as I said, if it's not a good fit for you right now, just let us know. I don't want to rush you or make you extra work.
Thank you very much

[knutole]

Hi @knutole. I just wanted to check back and see how things are. If you currently don't have the time/possibility to reopen the PR in the other repo, that's no problem at all. But please just let us know so we can plan. We wanted to merge your PRs first so we don't get any conflicts and we are currently still waiting with the other PRs. But as I said, if it's not a good fit for you right now, just let us know. I don't want to rush you or make you extra work. Thank you very much

Hi @kieferro. Nice to see the project being maintained. I have moved the two PR's to the new repo. 👍

[knutole]

Closed by py-stockfish#16