From ddd781d689be00d03c09d3291a1fcf9b1879d6cd Mon Sep 17 00:00:00 2001
From: johndoknjas <jdoknjas@sfu.ca>
Date: Thu, 22 Aug 2024 13:59:13 -0700
Subject: [PATCH] Update docstrings and return a deep copy in
 `get_engine_parameters`.

---
 README.md                      |  2 ++
 stockfish/models.py            |  6 +++---
 tests/stockfish/test_models.py | 10 ++++++++--
 3 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index e31a2b4..77efddd 100644
--- a/README.md
+++ b/README.md
@@ -293,6 +293,8 @@ stockfish.set_depth(15)
 
 ### Get the engine's current parameters
 
+Returns a deep copy of the dictionary storing the engine's current parameters.
+
 ```python
 stockfish.get_engine_parameters()
 ```
diff --git a/stockfish/models.py b/stockfish/models.py
index f937a35..05c8157 100644
--- a/stockfish/models.py
+++ b/stockfish/models.py
@@ -125,9 +125,9 @@ def get_engine_parameters(self) -> dict:
         """Returns the current engine parameters being used.
 
         Returns:
-            Dictionary of current Stockfish engine's parameters.
+            A deep copy of the dictionary storing the current engine parameters.
         """
-        return self._parameters
+        return copy.deepcopy(self._parameters)
 
     def get_parameters(self) -> dict:
         """Returns the current engine parameters being used. *Deprecated, see `get_engine_parameters()`*."""
@@ -145,7 +145,7 @@ def update_engine_parameters(self, parameters: Optional[dict]) -> None:
         Args:
             parameters:
                 Contains (key, value) pairs which will be used to update
-                the current Stockfish engine's parameters.
+                the Stockfish engine's current parameters.
 
         Returns:
             `None`
diff --git a/tests/stockfish/test_models.py b/tests/stockfish/test_models.py
index fbd5390..bc505eb 100644
--- a/tests/stockfish/test_models.py
+++ b/tests/stockfish/test_models.py
@@ -156,7 +156,7 @@ def test_set_fen_position_second_argument(self, stockfish: Stockfish):
         stockfish.set_fen_position(
             "rnbqk2r/pppp1ppp/3bpn2/4P3/3P4/2N5/PPP2PPP/R1BQKBNR b KQkq - 0 1", False
         )
-        assert stockfish.get_best_move() == "d6e7"
+        assert stockfish.get_best_move() in ("d6e7", "d6b4")
 
         stockfish.set_fen_position(
             "rnbqk2r/pppp1ppp/3bpn2/8/3PP3/2N5/PPP2PPP/R1BQKBNR w KQkq - 0 1", False
@@ -895,7 +895,7 @@ def test_get_wdl_stats(self, stockfish: Stockfish):
             wdl_stats = stockfish.get_wdl_stats()
             assert isinstance(wdl_stats, list)
             assert wdl_stats[1] > wdl_stats[0] * 7
-            assert abs(wdl_stats[0] - wdl_stats[2]) / wdl_stats[0] < 0.1
+            assert abs(wdl_stats[0] - wdl_stats[2]) / wdl_stats[0] < 0.15
 
             stockfish.set_fen_position(
                 "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1"
@@ -1238,3 +1238,9 @@ def test_pick(self, stockfish: Stockfish):
         assert stockfish._pick(line, "depth") == "10"
         assert stockfish._pick(line, "multipv") == "1"
         assert stockfish._pick(line, "wdl", 3) == "1000"
+
+    def test_get_engine_parameters(self, stockfish: Stockfish):
+        params = stockfish.get_engine_parameters()
+        params.update({"Skill Level": 10})
+        assert params["Skill Level"] == 10
+        assert stockfish._parameters["Skill Level"] == 20