Update the clash of code functionalities

Author: takos22

codingame/clash_of_code/__init__.py

@@ -1,6 +1,7 @@
-from .clash_of_code import ClashOfCode, Solution, TestCaseResult
+from .clash_of_code import ClashOfCode
 from .player import Player
-from .question import Contribution, Question, TestCase
+from .question import Contribution, Question, TestCase, TestCaseResult
+from .solution import Solution
 
 __all__ = (
     "ClashOfCode",

codingame/clash_of_code/clash_of_code.py

@@ -8,43 +8,13 @@
 from ..types.clash_of_code import LanguageIds, Mode, Modes
 from ..utils import minified_players_to_players, to_datetime
 from .player import Player
-from .question import Question
+from .question import Question, TestCaseResult
+from .solution import Solution
 
 if TYPE_CHECKING:
     from ..state import ConnectionState
 
-__all__ = ("ClashOfCode", "Solution", "TestCaseResult")
-
-
-class TestCaseResult(BaseObject):
-    success: bool
-    found: str
-    expected: str
-
-    __slots__ = ("success", "found", "expected")
-
-    def __init__(self, state: "ConnectionState", data: dict):
-        self.success = data["comparison"]["success"]
-        self.found = (
-            data["output"] if self.success else data["comparison"]["success"]
-        )
-        self.expected = (
-            data["output"] if self.success else data["comparison"]["success"]
-        )
-
-        super().__init__(state)
-
-
-class Solution(BaseObject):
-    __slots__ = ()
-
-    def __init__(self, state: "ConnectionState", data: dict):
-        ...
-
-        super().__init__(state)
-
-    def share(self):
-        ...
+__all__ = ("ClashOfCode",)
 
 
 class ClashOfCode(BaseObject):
@@ -456,7 +426,9 @@ async def _get_question():
                         )
                     )
                     self._question = Question(
-                        self._state, test_session["currentQuestion"]["question"]
+                        self._state,
+                        self,
+                        test_session["currentQuestion"]["question"],
                     )
 
                 if refetch:
@@ -480,7 +452,9 @@ def _get_question():
                         )
                     )
                     self._question = Question(
-                        self._state, test_session["currentQuestion"]["question"]
+                        self._state,
+                        self,
+                        test_session["currentQuestion"]["question"],
                     )
 
                 if refetch:
@@ -532,15 +506,19 @@ async def _play_test_cases():
                 if not self._question:
                     await self.get_question()
 
-                all_indexes = [tc.index for tc in self._question.test_cases]
                 results = {}
-                for index in all_indexes:
-                    if indexes and index not in indexes:
+                for test_case in self._question.test_cases:
+                    if indexes and test_case.index not in indexes:
                         continue
                     result = await self._state.http.play_test_session_by_handle(
-                        self._test_session_handle, language_id, code, index
+                        self._test_session_handle,
+                        language_id,
+                        code,
+                        test_case.index,
+                    )
+                    results[test_case.index] = TestCaseResult(
+                        self._state, self, test_case, result
                     )
-                    results[index] = TestCaseResult(self._state, result)
 
                 if refetch:
                     await self.fetch()
@@ -553,15 +531,19 @@ def _play_test_cases():
                 if not self._question:
                     self.get_question()
 
-                all_indexes = [tc.index for tc in self._question.test_cases]
                 results = {}
-                for index in all_indexes:
-                    if indexes and index not in indexes:
+                for test_case in self._question.test_cases:
+                    if indexes and test_case.index not in indexes:
                         continue
                     result = self._state.http.play_test_session_by_handle(
-                        self._test_session_handle, language_id, code, index
+                        self._test_session_handle,
+                        language_id,
+                        code,
+                        test_case.index,
+                    )
+                    results[test_case.index] = TestCaseResult(
+                        self._state, self, test_case, result
                     )
-                    results[index] = TestCaseResult(self._state, result)
 
                 if refetch:
                     self.fetch()
@@ -620,7 +602,7 @@ async def _submit():
                 if refetch:
                     await self.fetch()
 
-                return Solution(self._state, solution)
+                return Solution(self._state, self, solution)
 
         else:
 
@@ -638,6 +620,6 @@ def _submit():
                 if refetch:
                     self.fetch()
 
-                return Solution(self._state, solution)
+                return Solution(self._state, self, solution)
 
         return _submit()

codingame/clash_of_code/player.py

@@ -2,7 +2,9 @@
 from typing import TYPE_CHECKING, Optional
 
 from ..abc import BaseUser
+from ..exceptions import LoginRequired
 from ..types.clash_of_code import LanguageId, PlayerStatus
+from .solution import Solution
 
 if TYPE_CHECKING:
     from ..state import ConnectionState
@@ -72,9 +74,9 @@ class Player(BaseUser):
             Only available when the Clash of Code's mode is ``SHORTEST``.
 
         solution_shared: Optional :class:`bool`
-            Whether the Player shared his code.
+            Whether the Player shared their code.
 
-        submission_id: Optional :class:`int`
+        solution_id: Optional :class:`int`
             ID of the player's submission.
     """
 
@@ -95,7 +97,7 @@ class Player(BaseUser):
     score: Optional[int]
     code_length: Optional[int]
     solution_shared: Optional[bool]
-    submission_id: Optional[int]
+    solution_id: Optional[int]
 
     __slots__ = (
         "clash_of_code",
@@ -110,6 +112,7 @@ class Player(BaseUser):
         "score",
         "code_length",
         "solution_shared",
+        "solution_id",
         "submission_id",
         "test_session_status",
         "test_session_handle",
@@ -118,12 +121,12 @@ class Player(BaseUser):
     def __init__(
         self,
         state: "ConnectionState",
-        coc: "ClashOfCode",
+        clash_of_code: "ClashOfCode",
         started: bool,
         finished: bool,
         data: dict,
     ):
-        self.clash_of_code: "ClashOfCode" = coc
+        self.clash_of_code: "ClashOfCode" = clash_of_code
 
         self.public_handle = data.get("codingamerHandle")
         self.id = data["codingamerId"]
@@ -148,7 +151,9 @@ def __init__(
         self.score = data.get("score")
         self.code_length = data.get("criterion")
         self.solution_shared = data.get("solutionShared")
-        self.submission_id = data.get("submissionId")
+        self.solution_id = data.get("submissionId")
+        # TODO decprecate Player.submission_id
+        self.submission_id = self.solution_id
 
         self.test_session_status = data.get("testSessionStatus")
         self.test_session_handle = data.get("testSessionHandle")
@@ -161,3 +166,28 @@ def __repr__(self) -> str:
             "position={0.position!r} rank={0.rank!r} duration={0.duration!r} "
             "score={0.score!r} language_id={0.language_id!r}>".format(self)
         )
+
+    def get_solution(self) -> Solution:
+        if not self._state.logged_in:
+            raise LoginRequired()
+
+        if not self.solution_shared:
+            raise ValueError()  # TODO raise better error
+
+        if self._state.is_async:
+
+            async def _get_solution():
+                solution = await self._state.http.get_solution_by_id(
+                    self._state.codingamer.id, self.solution_id
+                )
+                return Solution(self._state, self.clash_of_code, solution)
+
+        else:
+
+            def _get_solution():
+                solution = self._state.http.get_solution_by_id(
+                    self._state.codingamer.id, self.solution_id
+                )
+                return Solution(self._state, self.clash_of_code, solution)
+
+        return _get_solution()