feat(message): add helper methods to Embed (#531)

* feat Embed: Added Embed Methods

* ci: correct from checks.

* Added docstrings and fixed method parameters

* ci: correct from checks.

* Added -> None to each methods

* fixed merge issue

* ci: correct from checks.

* Added int specification at remove_field()

Co-authored-by: = <=>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: Bastien1533

.pre-commit-config.yaml

@@ -1,59 +1,59 @@
-repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
-    hooks:
-    - id: requirements-txt-fixer
-      name: Requirements
-      types: [file]
-      exclude_types: ['image']
-    - id: debug-statements
-      name: Debugging
-      language: python
-      types: [file, python]
-      exclude_types: ['image']
-    - id: trailing-whitespace
-      name: Trailing Whitespace
-      language: python
-      types: [file]
-      exclude_types: ['image']
-    - id: end-of-file-fixer
-      name: EOF Newlines
-      language: python
-      types: [file]
-      exclude_types: ['image']
-    - id: check-yaml
-      name: YAML Structure
-      language: python
-    - id: check-toml
-      name: TOML Structure
-    - id: check-merge-conflict
-      name: Merge Conflicts
-  - repo: https://github.com/psf/black
-    rev: 22.1.0
-    hooks:
-    - id: black
-      name: Black Formatting
-      language: python
-      types: [file, python]
-      args: [--line-length=100]
-  - repo: https://github.com/PyCQA/flake8
-    rev: 4.0.1
-    hooks:
-    - id: flake8
-      name: flake8 Formatting
-      language: python
-      types: [file, python]
-      args: [--max-line-length=100, --ignore=E203 E301 E302 E501 E402 E704 W503 W504]
-  - repo: https://github.com/pycqa/isort
-    rev: 5.10.1
-    hooks:
-      - id: isort
-        name: isort Formatting
-        language: python
-        types: [file, python]
-ci:
-  autoupdate_branch: "unstable"
-  autofix_prs: true
-  autoupdate_commit_msg: "ci: weekly check."
-  autoupdate_schedule: weekly
-  autofix_commit_msg: "ci: correct from checks."
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+    - id: requirements-txt-fixer
+      name: Requirements
+      types: [file]
+      exclude_types: ['image']
+    - id: debug-statements
+      name: Debugging
+      language: python
+      types: [file, python]
+      exclude_types: ['image']
+    - id: trailing-whitespace
+      name: Trailing Whitespace
+      language: python
+      types: [file]
+      exclude_types: ['image']
+    - id: end-of-file-fixer
+      name: EOF Newlines
+      language: python
+      types: [file]
+      exclude_types: ['image']
+    - id: check-yaml
+      name: YAML Structure
+      language: python
+    - id: check-toml
+      name: TOML Structure
+    - id: check-merge-conflict
+      name: Merge Conflicts
+  - repo: https://github.com/psf/black
+    rev: 22.1.0
+    hooks:
+    - id: black
+      name: Black Formatting
+      language: python
+      types: [file, python]
+      args: [--line-length=100]
+  - repo: https://github.com/PyCQA/flake8
+    rev: 4.0.1
+    hooks:
+    - id: flake8
+      name: flake8 Formatting
+      language: python
+      types: [file, python]
+      args: [--max-line-length=100, --ignore=E203 E301 E302 E501 E402 E704 W503 W504]
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        name: isort Formatting
+        language: python
+        types: [file, python]
+ci:
+  autoupdate_branch: "unstable"
+  autofix_prs: true
+  autoupdate_commit_msg: "ci: weekly check."
+  autoupdate_schedule: weekly
+  autofix_commit_msg: "ci: correct from checks."

interactions/api/models/message.py

@@ -902,11 +902,195 @@ def __init__(self, **kwargs):
         if self.footer:
             self._json.update({"footer": self.footer._json})
 
-        if self.video:
-            self._json.update({"video": self.video._json})
+    def add_field(self, name: str, value: str, inline: Optional[bool] = False) -> None:
+        """
+        Adds a field to the embed
+
+        :param name: The name of the field
+        :type name: str
+        :param value: The value of the field
+        :type value: str
+        :param inline?: if the field is in the same line as the previous one
+        :type inline?: Optional[bool]
+        """
+
+        if self.fields is None:
+            self.fields = []
+
+        self.fields.append(EmbedField(name=name, value=value, inline=inline))
+        self._json.update({"fields": [field._json for field in self.fields]})
+
+    def clear_fields(self) -> None:
+        """
+        Clears all the fields of the embed
+        """
+
+        self.fields = []
+        self._json.update({"fields": []})
+
+    def insert_field_at(
+        self, index: int, name: str = None, value: str = None, inline: Optional[bool] = False
+    ) -> None:
+        """
+        Inserts a field in the embed at the specified index
+
+        :param index: The new field's index
+        :type index: int
+        :param name: The name of the field
+        :type name: str
+        :param value: The value of the field
+        :type value: str
+        :param inline?: if the field is in the same line as the previous one
+        :type inline?: Optional[bool]
+        """
+
+        try:
+            self.fields.insert(index, EmbedField(name=name, value=value, inline=inline))
+
+        except AttributeError:
+            self.fields = [EmbedField(name=name, value=value, inline=inline)]
+
+        self._json.update({"fields": [field._json for field in self.fields]})
+
+    def set_field_at(
+        self, index: int, name: str, value: str, inline: Optional[bool] = False
+    ) -> None:
+        """
+        Overwrites the field in the embed at the specified index
+
+        :param index: The new field's index
+        :type index: int
+        :param name: The name of the field
+        :type name: str
+        :param value: The value of the field
+        :type value: str
+        :param inline?: if the field is in the same line as the previous one
+        :type inline?: Optional[bool]
+        """
+
+        try:
+            self.fields[index] = EmbedField(name=name, value=value, inline=inline)
+            self._json.update({"fields": [field._json for field in self.fields]})
+
+        except AttributeError:
+            raise AttributeError("No fields found in Embed")
+
+        except IndexError:
+            raise IndexError("No fields at this index")
+
+    def remove_field(self, index: int) -> None:
+        """
+        Remove field at the specified index
+
+        :param index: The new field's index
+        :type index: int
+        """
+
+        try:
+            self.fields.pop(index)
+            self._json.update({"fields": [field._json for field in self.fields]})
+
+        except AttributeError:
+            raise AttributeError("No fields found in Embed")
+
+        except IndexError:
+            raise IndexError("Field not Found at index")
+
+    def remove_author(self) -> None:
+        """
+        Removes the embed's author
+        """
+
+        try:
+            del self.author
+            self._json.update({"author": None})
+        except AttributeError:
+            pass
+
+    def set_author(
+        self,
+        name: str,
+        url: Optional[str] = None,
+        icon_url: Optional[str] = None,
+        proxy_icon_url: Optional[str] = None,
+    ) -> None:
+        """
+        Sets the embed's author
+
+        :param name: The name of the author
+        :type name: str
+        :param url?: Url of author
+        :type url?: Optional[str]
+        :param icon_url?: Url of author icon (only supports http(s) and attachments)
+        :type icon_url?: Optional[str]
+        :param proxy_icon_url?: A proxied url of author icon
+        :type proxy_icon_url?: Optional[str]
+        """
+
+        self.author = EmbedAuthor(
+            name=name, url=url, icon_url=icon_url, proxy_icon_url=proxy_icon_url
+        )
+        self._json.update({"author": self.author._json})
 
-        if self.image:
-            self._json.update({"image": self.image._json})
+    def set_footer(
+        self, text: str, icon_url: Optional[str] = None, proxy_icon_url: Optional[str] = None
+    ) -> None:
+        """
+        Sets the embed's footer
+
+        :param text: The text of the footer
+        :type text: str
+        :param icon_url?: Url of footer icon (only supports http(s) and attachments)
+        :type icon_url?: Optional[str]
+        :param proxy_icon_url?: A proxied url of footer icon
+        :type proxy_icon_url?: Optional[str]
+        """
+
+        self.footer = EmbedFooter(text=text, icon_url=icon_url, proxy_icon_url=proxy_icon_url)
+        self._json.update({"footer": self.footer._json})
+
+    def set_image(
+        self,
+        url: str,
+        proxy_url: Optional[str] = None,
+        height: Optional[int] = None,
+        width: Optional[int] = None,
+    ) -> None:
+        """
+        Sets the embed's image
+
+        :param url: Url of the image
+        :type url: str
+        :param proxy_url?: A proxied url of the image
+        :type proxy_url?: Optional[str]
+        :param height?: The image's height
+        :type height?: Optional[int]
+        :param width?: The image's width
+        :type width?: Optional[int]
+        """
+
+        self.image = EmbedImageStruct(url=url, proxy_url=proxy_url, height=height, width=width)
+        self._json.update({"image": self.image._json})
+
+    def set_thumbnail(
+        self,
+        url: str,
+        proxy_url: Optional[str] = None,
+        height: int = None,
+        width: Optional[str] = None,
+    ) -> None:
+        """
+        Sets the embed's thumbnail
+
+        :param url: Url of the thumbnail
+        :type url: str
+        :param proxy_url?: A proxied url of the thumbnail
+        :type proxy_url?: Optional[str]
+        :param height?: The thumbnail's height
+        :type height?: Optional[int]
+        :param width?: The thumbnail's width
+        :type width?: Optional[int]
+        """
 
-        if self.thumbnail:
-            self._json.update({"thumbnail": self.thumbnail._json})
+        self.thumbnail = EmbedImageStruct(url=url, proxy_url=proxy_url, height=height, width=width)
+        self._json.update({"thumbnail": self.thumbnail._json})

interactions/api/models/message.pyi

@@ -244,3 +244,13 @@ class Embed(DictSerializerMixin):
     author: Optional[EmbedAuthor]
     fields: Optional[List[EmbedField]]
     def __init__(self, **kwargs): ...
+    def add_field(self, name: str, value: str, inline: Optional[bool] = False) -> None: ...
+    def clear_fields(self) -> None: ...
+    def insert_field_at(self, index: int,  name: str, value: str, inline: Optional[bool] = False) -> None: ...
+    def set_field_at(self, index: int, name: str, value: str, inline: Optional[bool] = False) -> None: ...
+    def remove_field(self, index: int) -> None: ...
+    def remove_author(self) -> None: ...
+    def set_author(self, name: str, url: Optional[str] = None, icon_url: Optional[str] = None, proxy_icon_url: Optional[str] = None) -> None: ...
+    def set_footer(self, text: str, icon_url: Optional[str] = None, proxy_icon_url: Optional[str] = None) -> None: ...
+    def set_image(self, url: str, proxy_url: Optional[str] = None, height: Optional[int] = None, width: Optional[int] = None) -> None: ...
+    def set_thumbnail(self, url: str, proxy_url: Optional[str] = None, height: Optional[int] = None, width: Optional[int] = None) -> None: ...