Skip to content

Revise docstrings #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johndoknjas merged 5 commits into from
Feb 8, 2026
Merged

Revise docstrings #173

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9106fb4
Remove `UCI_ShowWDL` as a user-facing parameter.
johndoknjas Feb 8, 2026
8452785
Remove parentheses.
johndoknjas Feb 8, 2026
579a614
Revise some docstrings so that the popups in vscode are formatted nicer.
johndoknjas Feb 8, 2026
125a987
Format with ruff.
johndoknjas Feb 8, 2026
09d6500
Merge remote-tracking branch 'upstream/master' into revise-docstrings
johndoknjas Feb 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 36 additions & 63 deletions stockfish/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,11 +144,7 @@ def set_debug_view(self, activate: bool) -> None:
self._debug_view = activate

def get_engine_parameters(self) -> dict[str, str | int | bool]:
"""Returns the current engine parameters being used.

Returns:
A deep copy of the dictionary storing the current engine parameters.
"""
"""Returns a deep copy of the dictionary storing the current engine parameters."""
return self._parameters.to_dict()

def get_parameters(self):
Expand Down Expand Up @@ -344,9 +340,6 @@ def set_fen_position(self, fen_position: str) -> None:
fen_position:
FEN string of board position.

Returns:
`None`

Example:
>>> stockfish.set_fen_position("1nb1k1n1/pppppppp/8/6r1/5bqK/6r1/8/8 w - - 2 2")
"""
Expand Down Expand Up @@ -405,29 +398,30 @@ def get_board_visual(self, perspective_white: bool = True) -> str:
perspective of white. `True` indicates White's perspective.

Returns:
A visual representation of the chessboard in the current position.

For example:
```
+---+---+---+---+---+---+---+---+
| r | n | b | q | k | b | n | r | 8
+---+---+---+---+---+---+---+---+
| p | p | p | p | p | p | p | p | 7
+---+---+---+---+---+---+---+---+
| | | | | | | | | 6
+---+---+---+---+---+---+---+---+
| | | | | | | | | 5
+---+---+---+---+---+---+---+---+
| | | | | | | | | 4
+---+---+---+---+---+---+---+---+
| | | | | | | | | 3
+---+---+---+---+---+---+---+---+
| P | P | P | P | P | P | P | P | 2
+---+---+---+---+---+---+---+---+
| R | N | B | Q | K | B | N | R | 1
+---+---+---+---+---+---+---+---+
a b c d e f g h
```
str:
A visual representation of the chessboard in the current position.

For example:
```
+---+---+---+---+---+---+---+---+
| r | n | b | q | k | b | n | r | 8
+---+---+---+---+---+---+---+---+
| p | p | p | p | p | p | p | p | 7
+---+---+---+---+---+---+---+---+
| | | | | | | | | 6
+---+---+---+---+---+---+---+---+
| | | | | | | | | 5
+---+---+---+---+---+---+---+---+
| | | | | | | | | 4
+---+---+---+---+---+---+---+---+
| | | | | | | | | 3
+---+---+---+---+---+---+---+---+
| P | P | P | P | P | P | P | P | 2
+---+---+---+---+---+---+---+---+
| R | N | B | Q | K | B | N | R | 1
+---+---+---+---+---+---+---+---+
a b c d e f g h
```
"""
self._put("d")
board_rep_lines: list[str] = []
Expand Down Expand Up @@ -461,11 +455,9 @@ def get_board_visual(self, perspective_white: bool = True) -> str:
return board_rep

def get_fen_position(self) -> str:
"""Returns the current board position in Forsyth-Edwards notation (FEN).

Returns:
A string of the current board position in Forsyth-Edwards notation (FEN).
For example: `rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1`
"""
Returns a string of the current board position in Forsyth-Edwards notation (FEN).
For example: `rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1`
"""
self._put("d")
while True:
Expand Down Expand Up @@ -577,17 +569,13 @@ def get_turn_perspective(self) -> bool:
def get_best_move(
self, wtime: int | None = None, btime: int | None = None
) -> str | None:
"""Returns the best move in the current position on the board.
"""Returns a string of the best move in pure algebraic coordinate notation, or None if it's a mate now.

If both `wtime` and `btime` aren't provided, the current depth is used for the search.

Args:
wtime:
Time for white player in milliseconds.
btime:
Time for black player in milliseconds.
`wtime`: Time for white player in milliseconds.

Returns:
A string of the best move in pure algebraic coordinate notation, or `None` if it's a mate now.
`btime`: Time for black player in milliseconds.

Example:
>>> move = stockfish.get_best_move(wtime=1000, btime=1000)
Expand All @@ -599,14 +587,7 @@ def get_best_move(
return self._get_best_move_from_sf_popen_process()

def get_best_move_time(self, time: int = 1000) -> str | None:
"""Returns the best move in the current position after a determined time.

Args:
time:
Time for Stockfish to determine the best move (milliseconds).

Returns:
A string of a move in pure algebraic coordinate notation, or `None` if it's a mate now.
"""Returns a string of the best move in the current position after a determined search time (milliseconds).

Example:
>>> move = stockfish.get_best_move_time(1000)
Expand Down Expand Up @@ -676,10 +657,7 @@ def _is_fen_syntax_valid(fen: str) -> bool:
return True

def is_fen_valid(self, fen: str) -> bool:
"""Checks if the FEN string is valid.

Returns:
`True` if valid, `False` otherwise.
"""Returns whether the FEN string is (likely) valid.

Example:
>>> is_valid = stockfish.is_fen_valid("rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1")
Expand Down Expand Up @@ -707,14 +685,9 @@ def is_fen_valid(self, fen: str) -> bool:
# temp_sf object goes out of scope, but calling it explicitly guarantees this will happen.

def is_move_correct(self, move_value: str) -> bool:
"""Checks if the passed in move is legal.
"""Returns if the passed in move is legal.

Args:
move_value:
New move value in pure algebraic coordinate notation.

Returns:
`True` if the new move is legal, otherwise `False`.
`move_value`: new move value in pure algebraic coordinate notation.

Example:
>>> is_correct = stockfish.is_move_correct("f4f5")
Expand Down
Loading