mirror of
https://github.com/yawaflua/Flask-Discord.git
synced 2025-12-10 04:19:31 +02:00
Use DiscordModelsMeta class. Set ROUTE as required class attribute for bases. Add fetch_from_api classmethod which is shorthand to return the current model
This commit is contained in:
@@ -1,8 +1,22 @@
|
|||||||
from flask import current_app
|
from flask import current_app
|
||||||
from abc import ABC
|
from abc import ABCMeta, abstractmethod
|
||||||
|
|
||||||
|
|
||||||
class DiscordModelsBase(ABC):
|
class DiscordModelsMeta(ABCMeta):
|
||||||
|
|
||||||
|
ROUTE = str()
|
||||||
|
|
||||||
|
def __init__(cls, name, *args, **kwargs):
|
||||||
|
if not cls.ROUTE and name != "DiscordModelsBase":
|
||||||
|
raise NotImplementedError(f"ROUTE must be specified in a Discord model: {name}.")
|
||||||
|
super().__init__(name, *args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
|
class DiscordModelsBase(metaclass=DiscordModelsMeta):
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def __init__(self, payload):
|
||||||
|
self._payload = payload
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def _request(*args, **kwargs):
|
def _request(*args, **kwargs):
|
||||||
@@ -12,6 +26,11 @@ class DiscordModelsBase(ABC):
|
|||||||
"""
|
"""
|
||||||
return current_app.discord.request(*args, **kwargs)
|
return current_app.discord.request(*args, **kwargs)
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def fetch_from_api(cls):
|
||||||
|
"""A class method which returns instance of this model by implicitly making an API call to Discord."""
|
||||||
|
return cls(cls._request(cls.ROUTE))
|
||||||
|
|
||||||
def to_json(self):
|
def to_json(self):
|
||||||
"""A utility method which returns raw payload object as it was received from discord.
|
"""A utility method which returns raw payload object as it was received from discord.
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ from .base import DiscordModelsBase
|
|||||||
from .user import User
|
from .user import User
|
||||||
|
|
||||||
|
|
||||||
class Integration(DiscordModelsBase):
|
class Integration(object):
|
||||||
""""Class representing discord server integrations.
|
""""Class representing discord server integrations.
|
||||||
|
|
||||||
Attributes
|
Attributes
|
||||||
@@ -49,7 +49,7 @@ class Integration(DiscordModelsBase):
|
|||||||
self.synced_at = self._payload.get("synced_at")
|
self.synced_at = self._payload.get("synced_at")
|
||||||
|
|
||||||
|
|
||||||
class UserConnection(object):
|
class UserConnection(DiscordModelsBase):
|
||||||
"""Class representing connections in discord account of the user.
|
"""Class representing connections in discord account of the user.
|
||||||
|
|
||||||
Attributes
|
Attributes
|
||||||
@@ -78,8 +78,10 @@ class UserConnection(object):
|
|||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
ROUTE = "/users/@me/connections"
|
||||||
|
|
||||||
def __init__(self, payload):
|
def __init__(self, payload):
|
||||||
self._payload = payload
|
super().__init__(payload)
|
||||||
self.id = self._payload["id"]
|
self.id = self._payload["id"]
|
||||||
self.name = self._payload.get("name")
|
self.name = self._payload.get("name")
|
||||||
self.type = self._payload.get("type")
|
self.type = self._payload.get("type")
|
||||||
|
|||||||
@@ -21,8 +21,10 @@ class Guild(DiscordModelsBase):
|
|||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
ROUTE = "/users/@me/guilds"
|
||||||
|
|
||||||
def __init__(self, payload):
|
def __init__(self, payload):
|
||||||
self._payload = payload
|
super().__init__(payload)
|
||||||
self.id = int(self._payload["id"])
|
self.id = int(self._payload["id"])
|
||||||
self.name = self._payload["name"]
|
self.name = self._payload["name"]
|
||||||
self.icon_hash = self._payload.get("icon")
|
self.icon_hash = self._payload.get("icon")
|
||||||
|
|||||||
@@ -36,8 +36,10 @@ class User(DiscordModelsBase):
|
|||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
ROUTE = "/users/@me"
|
||||||
|
|
||||||
def __init__(self, payload):
|
def __init__(self, payload):
|
||||||
self._payload = payload
|
super().__init__(payload)
|
||||||
self.id = int(self._payload["id"])
|
self.id = int(self._payload["id"])
|
||||||
self.username = self._payload["username"]
|
self.username = self._payload["username"]
|
||||||
self.discriminator = self._payload["discriminator"]
|
self.discriminator = self._payload["discriminator"]
|
||||||
@@ -99,3 +101,4 @@ class User(DiscordModelsBase):
|
|||||||
|
|
||||||
class Bot(User):
|
class Bot(User):
|
||||||
"""Class representing the client user itself."""
|
"""Class representing the client user itself."""
|
||||||
|
# TODO: What is this?
|
||||||
|
|||||||
Reference in New Issue
Block a user