fix: various fixes for embeds (#841)

* feat: add convert_type

* fix: use convert_type to allow passing in objects for fields

* fix: add fields for EmbedImageStruct

* fix: properly typehint embed-related objects

Author: AstreaTSS

interactions/api/models/attrs_utils.py

@@ -157,6 +157,15 @@ def inner_convert_dict(dict):
     return inner_convert_dict
 
 
+def convert_type(type_: type):
+    """A helper function to convert an input to a specified type."""
+
+    def inner_convert_object(value):
+        return value if isinstance(value, type_) else type_(value)
+
+    return inner_convert_object
+
+
 define_defaults = dict(kw_only=True, eq=False, init=False, on_setattr=attrs.setters.NO_OP)
 
 
@@ -175,6 +184,8 @@ def field(
     **kwargs,
 ):
     if converter is not None:
+        if isinstance(converter, type):
+            converter = convert_type(converter)
         converter = attrs.converters.optional(converter)
 
     metadata = kwargs.get("metadata", {})

interactions/api/models/attrs_utils.pyi

@@ -1,5 +1,5 @@
 from functools import wraps
-from typing import Any, Callable, Dict, List, Optional, Tuple, TypeVar, Union
+from typing import Any, Callable, Dict, List, Optional, Tuple, TypeVar, Union, Type
 
 import attrs
 
@@ -55,6 +55,9 @@ def convert_list(converter: Callable[[_T], _P]) -> Callable[[List[_T]], List[_P]
 def convert_int(converter: Callable[[int], _T]) -> Callable[[Any], _T]:
     """A helper function to pass an int to the converter, e.x. for Enums"""
 
+def convert_type(object: Type[_T]) -> Callable[[Any], _T]:
+    """A helper function to convert an input to a specified type."""
+
 def convert_dict(
     key_converter: Optional[Callable[[Any], _T]] = None,
     value_converter: Optional[Callable[[Any], _P]] = None,

interactions/api/models/message.py

@@ -279,6 +279,11 @@ class EmbedImageStruct(DictSerializerMixin):
     :ivar Optional[int] width?: Width of the object.
     """
 
+    url: str = field()
+    proxy_url: Optional[str] = field(default=None)
+    height: Optional[int] = field(default=None)
+    width: Optional[int] = field(default=None)
+
     def __setattr__(self, key, value) -> None:
         super().__setattr__(key, value)
         if key != "_json" and (key not in self._json or value != self._json.get(key)):

interactions/api/models/message.pyi

@@ -96,51 +96,55 @@ class Emoji(ClientSerializerMixin):
 
 @define()
 class EmbedImageStruct(DictSerializerMixin):
+    url: str
+    proxy_url: Optional[str] = None
+    height: Optional[int] = None
+    width: Optional[int] = None
     def __setattr__(self, key, value) -> None: ...
 
 @define()
 class EmbedProvider(DictSerializerMixin):
-    name: Optional[str]
-    url: Optional[str]
+    name: Optional[str] = None
+    url: Optional[str] = None
     def __setattr__(self, key, value) -> None: ...
 
 @define()
 class EmbedAuthor(DictSerializerMixin):
     name: str
-    url: Optional[str]
-    icon_url: Optional[str]
-    proxy_icon_url: Optional[str]
+    url: Optional[str] = None
+    icon_url: Optional[str] = None
+    proxy_icon_url: Optional[str] = None
     def __setattr__(self, key, value) -> None: ...
 
 @define()
 class EmbedFooter(DictSerializerMixin):
     text: str
-    icon_url: Optional[str]
-    proxy_icon_url: Optional[str]
+    icon_url: Optional[str] = None
+    proxy_icon_url: Optional[str] = None
     def __setattr__(self, key, value) -> None: ...
 
 @define()
 class EmbedField(DictSerializerMixin):
     name: str
-    inline: Optional[bool]
+    inline: Optional[bool] = None
     value: str
     def __setattr__(self, key, value) -> None: ...
 
 @define()
 class Embed(DictSerializerMixin):
-    title: Optional[str]
-    type: Optional[str]
-    description: Optional[str]
-    url: Optional[str]
-    timestamp: Optional[datetime]
-    color: Optional[int]
-    footer: Optional[EmbedFooter]
-    image: Optional[EmbedImageStruct]
-    thumbnail: Optional[EmbedImageStruct]
-    video: Optional[EmbedImageStruct]
-    provider: Optional[EmbedProvider]
-    author: Optional[EmbedAuthor]
-    fields: Optional[List[EmbedField]]
+    title: Optional[str] = None
+    type: Optional[str] = None
+    description: Optional[str] = None
+    url: Optional[str] = None
+    timestamp: Optional[datetime] = None
+    color: Optional[int] = None
+    footer: Optional[EmbedFooter] = None
+    image: Optional[EmbedImageStruct] = None
+    thumbnail: Optional[EmbedImageStruct] = None
+    video: Optional[EmbedImageStruct] = None
+    provider: Optional[EmbedProvider] = None
+    author: Optional[EmbedAuthor] = None
+    fields: Optional[List[EmbedField]] = None
     def __setattr__(self, key, value) -> None: ...
     def add_field(self, name: str, value: str, inline: Optional[bool] = ...) -> None: ...
     def clear_fields(self) -> None: ...