Merge pull request #19 from ClementJ18/develop

v0.4.3 release

Author: ClementJ18

docs/source/changelog.rst

@@ -8,6 +8,19 @@ The page attempt to keep a clear list of breaking/non-breaking changes and new f
    :local:
    :backlinks: none
 
+v0.4.3
+-------
+
+New Features
+#############
+* `Platform` object has been split into `GamePlatform`, `ModPlatform` and `ModFilePlatform` to better reflect the API models
+* New `Mod.platforms` attribute
+* `Game.platforms`is now a `List[GamePlatform]`, different class but same attributes
+
+Bugs Fixed
+###########
+* `Modfile.platforms` fixed, now a `List[ModFilePlatforms]` with correct attributes
+
 v0.4.2
 -------
 
@@ -76,4 +89,3 @@ Removed Features
 * Many of exceptions have been removed, the library now uses the base exception for most errors
 * Removed the account links support, looking into a better implementation
 * Many removed endpoints have had their method also removed
-* 

docs/source/conf.py

@@ -27,7 +27,7 @@
 # The short X.Y version
 version = ""
 # The full version, including alpha/beta/rc tags
-release = "0.4.2"
+release = "0.4.3"
 
 
 # -- General configuration ---------------------------------------------------

modio/__init__.py

@@ -7,4 +7,4 @@
 from .enums import *
 from .errors import *
 
-__version__ = "0.4.2"
+__version__ = "0.4.3"

modio/client.py

@@ -74,7 +74,7 @@ async def async_enforce_ratelimit(self):
 
     def _error_check(self, resp, request_json):
         """Updates the rate-limit attributes and check validity of the request."""
-        self.retry_after = resp.headers.get("retry-after", 0)
+        self.retry_after = int(resp.headers.get("retry-after", "0"))
         code = getattr(resp, "status_code", getattr(resp, "status", None))
 
         if code == 204:
@@ -124,12 +124,12 @@ def _post(self, resp):
         except requests.JSONDecodeError:
             resp_json = {}
 
-        try: 
+        try:
             data = self._error_check(resp, resp_json)
         except modioException as e:
             if e.code == 429:
                 self.enforce_ratelimit()
-            
+
             raise e
 
         return data
@@ -165,13 +165,12 @@ async def _async_post(self, resp):
         except aiohttp.ContentTypeError:
             resp_json = {}
 
-
-        try: 
+        try:
             data = self._error_check(resp, resp_json)
         except modioException as e:
             if e.code == 429:
                 await self.async_enforce_ratelimit()
-            
+
             raise e
 
         return data

modio/entities.py

@@ -4,7 +4,7 @@
 from .mixins import OwnerMixin, RatingMixin, ReportMixin, StatsMixin
 from .errors import modioException
 from .utils import concat_docs, _convert_date
-from .enums import EventType, RatingType, TargetPlatform, VirusStatus
+from .enums import EventType, RatingType, TargetPlatform, VirusStatus, ModFilePlatformStatus
 
 
 class Message:
@@ -299,7 +299,7 @@ class ModFile(OwnerMixin):
     game_id : int
         ID of the game of the mod this file belongs to. Can be None if this file
         was returned from the me/modfiles endpoint.
-    platforms : List[Platform]
+    platforms : List[ModFilePlatform]
         List of platforms this file is avalaible on.
     """
 
@@ -323,7 +323,7 @@ def __init__(self, **attrs):
         self.url = download["binary_url"]
         self.date_expires = _convert_date(download.pop("date_expires"))
         self.game_id = attrs.pop("game_id", None)
-        self.platforms = [Platform(**platform) for platform in attrs.pop("platforms")]
+        self.platforms = [ModFilePlatform(**platform) for platform in attrs.pop("platforms")]
         self.connection = attrs.pop("connection")
 
     def __repr__(self):
@@ -436,8 +436,15 @@ def __init__(self, **attrs):
         self.images = [Image(**image) for image in attrs.pop("images", [])]
 
 
-class Platform:
-    """A platform
+class BasePlatform:
+    """Base class for a platform."""
+
+    def __init__(self, **attrs):
+        self.platform = TargetPlatform[attrs.pop("platform")]
+
+
+class GamePlatform(BasePlatform):
+    """The platform for a game.
 
     Attributes
     ----------
@@ -450,11 +457,43 @@ class Platform:
     """
 
     def __init__(self, **attrs):
-        self.platform = TargetPlatform[attrs.pop("platform")]
+        super().__init__(**attrs)
         self.label = attrs.pop("label")
         self.moderated = attrs.pop("moderated")
 
 
+class ModPlatform(BasePlatform):
+    """The platform for a mod
+
+    Attributes
+    ------------
+    platform : TargetPlatform
+        The platform
+    modfile_live : int
+        The ID of the modfile currently live for that platform.
+    """
+
+    def __init__(self, **attrs):
+        super().__init__(**attrs)
+        self.modfile_live = attrs.pop("modfile_live")
+
+
+class ModFilePlatform:
+    """The platform for a mod file
+
+    Attributes
+    -----------
+    platform : TargetPlatform
+        The platform
+    status : ModFilePlatformStatus
+        The status of the modfile for the corresponding platform.
+    """
+
+    def __init__(self, **attrs):
+        super().__init__(**attrs)
+        self.status = ModFilePlatformStatus(attrs.pop("status"))
+
+
 class TagOption:
     """Represents a game tag gropup, a category of tags from which a
     mod may pick one or more.

modio/enums.py

@@ -45,6 +45,19 @@ class Status(enum.Enum):
     deleted = 3
 
 
+class ModFilePlatformStatus:
+    """Status of a modfile for the specific platform.
+
+    0 : Pending
+    1 : Accepted
+    2 : Denied
+    """
+
+    pending = 0
+    accepted = 1
+    denied = 2
+
+
 class Presentation(enum.Enum):
     """
     0 : Display mods for that game in a grid on mod.io

modio/game.py

@@ -3,7 +3,7 @@
 from typing import List, Literal, Optional
 
 from .mod import Mod
-from .entities import Event, Image, Message, GameStats, ModStats, Platform, TagOption, User
+from .entities import Event, Image, Message, GameStats, ModStats, GamePlatform, TagOption, User
 from .objects import Filter, NewMod, Pagination, Returned
 from .utils import _convert_date, find
 from .enums import APIAccess, Community, Curation, MaturityOptions, Presentation, Revenue, Status, Submission
@@ -73,7 +73,7 @@ class Game(ReportMixin, OwnerMixin):
     other_urls : Dict[str, str]
         A dictionnary of labels and urls for
         the game
-    platforms : List[Platform]
+    platforms : List[GamePlatform]
         Platforms this games supports
     """
 
@@ -113,7 +113,7 @@ def __init__(self, **attrs):
         self.stats = None
         # self.theme = Theme(**attrs.pop("theme"))
         self.other_urls = {value["label"]: value["url"] for value in attrs.pop("other_urls")}
-        self.platforms = [Platform(**platform) for platform in attrs.pop("platforms")]
+        self.platforms = [GamePlatform(**platform) for platform in attrs.pop("platforms")]
 
         _submitter = attrs.pop("submitted_by", {})
         if _submitter:

modio/mixins.py

@@ -111,7 +111,7 @@ async def async_delete(self):
 class OwnerMixin:
     """Mixin containing get owner methods."""
 
-    def get_owner(self) -> 'entities.User':
+    def get_owner(self) -> "entities.User":
         """Get the original submitter of the resource.
 
         |coro|
@@ -126,7 +126,7 @@ def get_owner(self) -> 'entities.User':
         )
         return entities.User(connection=self.connection, **user)
 
-    async def async_get_owner(self) -> 'entities.User':
+    async def async_get_owner(self) -> "entities.User":
         user = await self.connection.async_post_request(
             "/general/ownership", data={"resource_type": self._resource_type, "resource_id": self.id}
         )