Merge pull request #30 from takos22/1.4.x

[RELEASE] 1.4.3

Author: takos22

.github/workflows/lint-test.yml

@@ -17,7 +17,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9, '3.10']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
 
     steps:
     - uses: actions/checkout@v3

.readthedocs.yml

@@ -0,0 +1,21 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: docs/requirements.txt

CHANGELOG.rst

@@ -7,6 +7,29 @@ The format is based on
 `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`__, and this project
 adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`__.
 
+Version 1.4.3 (2024-02-21)
+--------------------------
+
+Changed
+*******
+
+- Every `datetime.date <https://docs.python.org/library/datetime.html#datetime.date>`__ is now timezone aware, using the CodinGame
+  timezone (UTC).
+- `ClashOfCode.creation_time <https://codingame.readthedocs.io/en/latest/api.html#codingame.ClashOfCode.creation_time>`__ can be ``None`` because of an API change
+  by CodinGame.
+
+Fixed
+*****
+
+- `KeyError <https://docs.python.org/library/exceptions.html#KeyError>`__ was raised when using `Client.get_clash_of_code <https://codingame.readthedocs.io/en/latest/api.html#codingame.Client.get_clash_of_code>`__ because
+  of an API change by CodinGame.
+  
+Removed
+*******
+
+- Removed support for python 3.7 as it has reached its end of life. For more
+  information, see `PEP 537 <https://peps.python.org/pep-0537/#lifespan>`__.
+
 Version 1.4.2 (2023-04-14)
 --------------------------
 
@@ -66,7 +89,7 @@ Changed
 Removed
 *******
 
-- Removed `Notification._raw`.
+- Removed ``Notification._raw``.
 
 Version 1.2.4 (2022-06-17)
 --------------------------

README.rst

@@ -29,7 +29,7 @@ Pythonic wrapper for the undocumented `CodinGame <https://www.codingame.com/>`_
 Installation
 ------------
 
-**Python 3.7 or higher is required.**
+**Python 3.8 or higher is required.**
 
 Install ``codingame`` with pip:
 

codingame/__init__.py

@@ -11,11 +11,11 @@
     "VersionInfo", major=int, minor=int, micro=int, releaselevel=str, serial=int
 )
 
-version_info = VersionInfo(major=1, minor=4, micro=2, releaselevel="", serial=0)
+version_info = VersionInfo(major=1, minor=4, micro=3, releaselevel="", serial=0)
 
 __title__ = "codingame"
 __author__ = "takos22"
-__version__ = "1.4.2"
+__version__ = "1.4.3"
 
 from .clash_of_code import ClashOfCode, Player
 from .client import Client

codingame/clash_of_code.py

@@ -56,8 +56,9 @@ class ClashOfCode(BaseObject):
         mode: Optional :class:`str`
             The mode of the Clash of Code.
 
-        creation_time: :class:`~datetime.datetime`
+        creation_time: Optional :class:`~datetime.datetime`
             Creation time of the Clash of Code.
+            Doesn't always exist.
 
         start_time: :class:`~datetime.datetime`
             Start time of the Clash of Code. If the Clash of Code hasn't started
@@ -86,7 +87,7 @@ class ClashOfCode(BaseObject):
     started: bool
     finished: bool
     mode: Optional[Mode]
-    creation_time: datetime
+    creation_time: Optional[datetime]
     start_time: datetime
     end_time: Optional[datetime]
     time_before_start: timedelta
@@ -117,7 +118,7 @@ def __init__(self, state: "ConnectionState", data: ClashOfCodeDict):
         self.join_url = (
             f"https://www.codingame.com/clashofcode/clash/{self.public_handle}"
         )
-        self.public = data["publicClash"]
+        self.public = data.get("type", "PUBLIC") == "PUBLIC"
         self.min_players = data["nbPlayersMin"]
         self.max_players = data["nbPlayersMax"]
         self.modes = data.get("modes")
@@ -127,8 +128,8 @@ def __init__(self, state: "ConnectionState", data: ClashOfCodeDict):
         self.finished = data["finished"]
         self.mode = data.get("mode")
 
-        self.creation_time = to_datetime(data["creationTime"])
-        self.start_time = to_datetime(data["startTime"])
+        self.creation_time = to_datetime(data.get("creationTime"))
+        self.start_time = to_datetime(data["startTimestamp"])
         self.end_time = to_datetime(data.get("endTime"))
 
         self.time_before_start = timedelta(milliseconds=data["msBeforeStart"])

codingame/types/clash_of_code.py

@@ -4,12 +4,7 @@
 Typings for the `ClashOfCode/` endpoints of the CodinGame API.
 """
 
-from typing import List, Optional
-
-try:
-    from typing import Literal, TypedDict
-except ImportError:
-    from typing_extensions import Literal, TypedDict
+from typing import List, Literal, Optional, TypedDict
 
 __all__ = (
     "ClashOfCode",

codingame/types/codingamer.py

@@ -4,12 +4,7 @@
 Typings for the `CodinGamer/` endpoints of the CodinGame API.
 """
 
-from typing import Dict, List, Optional
-
-try:
-    from typing import Literal, TypedDict
-except ImportError:
-    from typing_extensions import Literal, TypedDict
+from typing import Dict, List, Literal, Optional, TypedDict
 
 __all__ = (
     "PartialCodinGamer",

codingame/utils.py

@@ -1,6 +1,6 @@
 import re
 import typing
-from datetime import datetime
+from datetime import datetime, timezone
 
 from .exceptions import LoginRequired
 
@@ -102,8 +102,8 @@ def validate_leaderboard_group(group: str, logged_in: bool) -> str:
 
 def to_datetime(data: typing.Optional[typing.Union[int, str]]) -> datetime:
     if isinstance(data, int):
-        return datetime.utcfromtimestamp(data / 1000.0)
-    elif isinstance(data, str):
+        return datetime.fromtimestamp(data / 1000.0, timezone.utc)
+    elif isinstance(data, str):  # pragma: no cover
         try:
             return datetime.strptime(data, DT_FORMAT_1)
         except ValueError:

dev-requirements.txt

@@ -1,13 +1,12 @@
-autoflake~=1.4
+autoflake~=2.3
 black~=22.6
-doc8~=0.9
-flake8~=3.9
-importlib-metadata~=4.13
-isort~=5.8
-pytest~=6.2
+doc8~=1.1
+flake8~=7.0
+isort~=5.13
+pytest~=7.4
 pytest-asyncio~=0.16.0
-pytest-cov~=2.12
+pytest-cov~=4.1
 pytest-mock~=3.6
-python-dotenv~=0.17.1
-requests
-twine
+python-dotenv~=1.0
+setuptools~=69.1
+twine~=5.0