Add AllowedMentions helpers and update docs (#73)

README.md

@@ -118,9 +118,10 @@ session parameter supported by ``aiohttp``.
 Specify default mention behaviour for all outgoing messages when constructing the client:
 
 ```python
+from disagreement.models import AllowedMentions
 client = disagreement.Client(
     token=token,
-    allowed_mentions={"parse": [], "replied_user": False},
+    allowed_mentions=AllowedMentions.none().to_dict(),
 )
 ```
 

disagreement/models.py

@@ -624,14 +624,31 @@ class File:
         self.data = data
 
 
-class AllowedMentions:
+class AllowedMentions:
     """Represents allowed mentions for a message or interaction response."""
 
-    def __init__(self, data: Dict[str, Any]):
+    def __init__(self, data: Dict[str, Any]):
-        self.parse: List[str] = data.get("parse", [])
+        self.parse: List[str] = data.get("parse", [])
-        self.roles: List[str] = data.get("roles", [])
+        self.roles: List[str] = data.get("roles", [])
-        self.users: List[str] = data.get("users", [])
+        self.users: List[str] = data.get("users", [])
-        self.replied_user: bool = data.get("replied_user", False)
+        self.replied_user: bool = data.get("replied_user", False)
+
+    @classmethod
+    def all(cls) -> "AllowedMentions":
+        """Return an instance allowing all mention types."""
+
+        return cls(
+            {
+                "parse": ["users", "roles", "everyone"],
+                "replied_user": True,
+            }
+        )
+
+    @classmethod
+    def none(cls) -> "AllowedMentions":
+        """Return an instance disallowing all mentions."""
+
+        return cls({"parse": [], "replied_user": False})
 
     def to_dict(self) -> Dict[str, Any]:
         payload: Dict[str, Any] = {"parse": self.parse}

docs/introduction.md

@@ -118,15 +118,19 @@ session parameter supported by ``aiohttp``.
 Specify default mention behaviour for all outgoing messages when constructing the client:
 
 ```python
+from disagreement.models import AllowedMentions
 client = disagreement.Client(
     token=token,
-    allowed_mentions={"parse": [], "replied_user": False},
+    allowed_mentions=AllowedMentions.none().to_dict(),
 )
 ```
 
 This dictionary is used whenever ``send_message`` is called without an explicit
 ``allowed_mentions`` argument.
 
+The :class:`AllowedMentions` class offers ``none()`` and ``all()`` helpers for
+quickly generating these configurations.
+
 ### Defining Subcommands with `AppCommandGroup`
 
 ```python

docs/mentions.md

@@ -8,15 +8,20 @@ Use the ``allowed_mentions`` parameter of :class:`disagreement.Client` to set a
 default for all messages:
 
 ```python
+from disagreement.models import AllowedMentions
 client = disagreement.Client(
     token="YOUR_TOKEN",
-    allowed_mentions={"parse": [], "replied_user": False},
+    allowed_mentions=AllowedMentions.none().to_dict(),
 )
 ```
 
 When ``Client.send_message`` is called without an explicit ``allowed_mentions``
 argument this value will be used.
 
+``AllowedMentions`` also provides the convenience methods
+``AllowedMentions.none()`` and ``AllowedMentions.all()`` to quickly create
+common configurations.
+
 ## Next Steps
 
 - [Commands](commands.md)