feat: Implement GUILD_AUDIT_LOG_ENTRY_CREATE event

Author: mccoderpy

discord/audit_logs.py

@@ -188,6 +188,7 @@ def _handle_role(self, first, second, entry, elem):
 
         setattr(second, 'roles', data)
 
+
 class AuditLogEntry(Hashable):
     r"""Represents an Audit Log entry.
 

discord/enums.py

@@ -23,6 +23,7 @@
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 """
+from __future__ import annotations
 
 import types
 from typing import Union, Any, Type
@@ -79,22 +80,22 @@
 )
 
 
-def _create_value_cls(name):
+def _create_value_cls(name) -> Type[tuple]:
     cls = namedtuple(f'_EnumValue_' + name, 'name value')
     cls.__repr__ = lambda self: '<%s.%s: %r>' % (name, self.name, self.value)
     cls.__str__ = lambda self: '%s.%s' % (name, self.name)
 
     def __getattribute__(self, n) -> Union[bool, Any]:
+        # With this you can use something like some_channel.type.text to check if it is of this type
+        # It is similar to "some_channel.type == ChannelType.text"
         if n in dir(cls):
             return super(cls, self).__getattribute__(n)
         else:
             if n in self._actual_enum_cls_.__members__:
                 return self.name == n
             else:
                 raise AttributeError(f'{self.__class__.__name__} has no attribute {n}.')
-
-    # With this you can use something like some_channel.type.text to check if it is of this type
-    # It is similar to "some_channel.type == ChannelType.text"
+            
     cls.__getattribute__ = __getattribute__
     return cls
 
@@ -104,7 +105,7 @@ def _is_descriptor(obj):
 
 
 class EnumMeta(type):
-    def __new__(cls, name, bases, attrs):
+    def __new__(mcs, name, bases, attrs):
         value_mapping = {}
         member_mapping = {}
         member_names = []
@@ -127,45 +128,44 @@ def __new__(cls, name, bases, attrs):
             try:
                 new_value = value_mapping[value]
             except KeyError:
-                new_value = value_cls(name=key, value=value)
+                new_value = value_cls(name=key, value=value)  # type: ignore
                 value_mapping[value] = new_value
                 member_names.append(key)
 
             member_mapping[key] = new_value
             attrs[key] = new_value
 
-
         attrs['_enum_value_map_'] = value_mapping
         attrs['_enum_member_map_'] = member_mapping
         attrs['_enum_member_names_'] = member_names
-        actual_cls = super().__new__(cls, name, bases, attrs)
+        actual_cls = super().__new__(mcs, name, bases, attrs)
         value_cls._actual_enum_cls_ = actual_cls
         return actual_cls
 
     def __iter__(cls):
-        return (cls._enum_member_map_[name] for name in cls._enum_member_names_)
+        return (cls._enum_member_map_[name] for name in cls._enum_member_names_)  # type: ignore
 
     def __reversed__(cls):
-        return (cls._enum_member_map_[name] for name in reversed(cls._enum_member_names_))
+        return (cls._enum_member_map_[name] for name in reversed(cls._enum_member_names_))  # type: ignore
 
     def __len__(cls):
-        return len(cls._enum_member_names_)
+        return len(cls._enum_member_names_)  # type: ignore
 
     def __repr__(cls):
         return '<enum %r>' % cls.__name__
 
     @property
     def __members__(cls):
-        return types.MappingProxyType(cls._enum_member_map_)
+        return types.MappingProxyType(cls._enum_member_map_)  # type: ignore
 
     def __call__(cls, value):
         try:
-            return cls._enum_value_map_[value]
+            return cls._enum_value_map_[value]  # type: ignore
         except (KeyError, TypeError):
             raise ValueError("%r is not a valid %s" % (value, cls.__name__))
 
     def __getitem__(cls, key):
-        return cls._enum_member_map_[key]
+        return cls._enum_member_map_[key]  # type: ignore
 
     def __setattr__(cls, name, value):
         raise TypeError('Enums are immutable.')
@@ -177,7 +177,7 @@ def __instancecheck__(self, instance):
         # isinstance(x, Y)
         # -> __instancecheck__(Y, x)
         try:
-            return instance._actual_enum_cls_ is self
+            return instance._actual_enum_cls_ is self  # type: ignore
         except AttributeError:
             return False
 
@@ -186,7 +186,7 @@ class Enum(metaclass=EnumMeta):
     @classmethod
     def try_value(cls, value):
         try:
-            return cls._enum_value_map_[value]
+            return cls._enum_value_map_[value]  # type: ignore
         except (KeyError, TypeError):
             return value
 

discord/state.py

@@ -41,6 +41,7 @@
 
 from .guild import Guild
 from .activity import BaseActivity
+from .audit_logs import AuditLogEntry
 from .scheduled_event import GuildScheduledEvent
 from .user import User, ClientUser
 from .emoji import Emoji
@@ -1330,7 +1331,15 @@ def parse_auto_moderation_action_execution(self, data):
             self.dispatch('automod_action', payload)
         else:
             log.debug('AUTO_MODERATION_ACTION_EXECUTION referencing an unknown guild ID: %s. Discarding.', data['guild_id'])
-
+    
+    def parse_guild_audit_log_entry_create(self, data):
+        guild = self._get_guild(int(data['guild_id']))
+        if guild is not None:
+            entry = AuditLogEntry(guild=guild, data=data, users=self._users)
+            self.dispatch('audit_log_entry_create', guild, entry)
+        else:
+            log.debug('GUILD_AUDIT_LOG_ENTRY_CREATE referencing an unknown guild ID: %s. Discarding.', data['guild_id'])
+    
     def _get_reaction_user(self, channel, user_id):
         if isinstance(channel, TextChannel):
             return channel.guild.get_member(user_id)

docs/api.rst

@@ -303,6 +303,20 @@ to handle it, which defaults to print a traceback and ignoring the exception.
     :param exception: The exception that was raised
     :type exception: :class:`Exception`
 
+.. function:: on_audit_log_entry_create(guild, entry)
+
+    Called whenever a guild audit log entry is created.
+
+    .. note::
+        This event is only sent to bots with the :attr:`~Permissions.view_audit_log` permission.
+
+    .. versionadded:: 2.0
+
+    :param guild: The guild that the audit log entry was created in.
+    :type guild: :class:`Guild`
+    :param entry: The audit log entry that was created.
+    :type entry: :class:`AuditLogEntry`
+
 .. function:: on_socket_raw_receive(msg)
 
     Called whenever a message is received from the WebSocket, before