Address PR comments and fix flake8 errors

Author: tandemdude

hikari/api/event_factory.py

@@ -1422,9 +1422,9 @@ def deserialize_stage_instance_create_event(
 
         Parameters
         ----------
-        shard : hikari.api.shard.GatewayShard
+        shard
             The shard that emitted this event.
-        payload : hikari.internal.data_binding.JSONObject
+        payload
             The dict payload to parse.
 
         Returns
@@ -1434,21 +1434,21 @@ def deserialize_stage_instance_create_event(
         """
 
     @abc.abstractmethod
-    def deserialize_stage_instance_edit_event(
+    def deserialize_stage_instance_update_event(
         self, shard: gateway_shard.GatewayShard, payload: data_binding.JSONObject
-    ) -> stage_events.StageInstanceEditEvent:
+    ) -> stage_events.StageInstanceUpdateEvent:
         """Parse a raw payload from Discord into a stage instance update event object.
 
         Parameters
         ----------
-        shard : hikari.api.shard.GatewayShard
+        shard
             The shard that emitted this event.
-        payload : hikari.internal.data_binding.JSONObject
+        payload
             The dict payload to parse.
 
         Returns
         -------
-        hikari.events.voice_events.StageInstanceEditEvent
+        hikari.events.voice_events.StageInstanceUpdateEvent
             The parsed stage instance update event object.
         """
 
@@ -1460,9 +1460,9 @@ def deserialize_stage_instance_delete_event(
 
         Parameters
         ----------
-        shard : hikari.api.shard.GatewayShard
+        shard
             The shard that emitted this event.
-        payload : hikari.internal.data_binding.JSONObject
+        payload
             The dict payload to parse.
 
         Returns

hikari/events/stage_events.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # cython: language_level=3
 # Copyright (c) 2020 Nekokatt
-# Copyright (c) 2021 davfsa
+# Copyright (c) 2021-present davfsa
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -48,15 +48,9 @@ class StageInstanceEvent(shard_events.ShardEvent, abc.ABC):
     __slots__: typing.Sequence[str] = ()
 
     @property
-    @abc.abstractmethod
-    def stage_instance_id(self) -> snowflakes.Snowflake:
-        """ID of the stage instance that this event relates to.
-
-        Returns
-        -------
-        hikari.snowflakes.Snowflake
-            The ID of the stage instance that this event relates to.
-        """
+    def app(self) -> traits.RESTAware:
+        # <<inherited docstring from Event>>.
+        return self.stage_instance.app
 
     @property
     @abc.abstractmethod
@@ -69,6 +63,17 @@ def stage_instance(self) -> StageInstance:
             The stage instance that this event relates to.
         """
 
+    @property
+    def stage_instance_id(self) -> snowflakes.Snowflake:
+        """ID of the stage instance that this event relates to.
+
+        Returns
+        -------
+        hikari.snowflakes.Snowflake
+            The ID of the stage instance that this event relates to.
+        """
+        return self.stage_instance.id
+
 
 @attrs_extensions.with_copy
 @attr.define(kw_only=True, weakref_slot=False)
@@ -82,37 +87,18 @@ class StageInstanceCreateEvent(StageInstanceEvent):
     stage_instance: StageInstance = attr.field()
     """The stage instance that was created."""
 
-    @property
-    def app(self) -> traits.RESTAware:
-        # <<inherited docstring from Event>>.
-        return self.stage_instance.app
-
-    @property
-    def stage_instance_id(self) -> snowflakes.Snowflake:
-        # <<inherited docstring from StageInstanceEvent>>.
-        return self.stage_instance.id
-
 
 @attrs_extensions.with_copy
 @attr.define(kw_only=True, weakref_slot=False)
 @base_events.requires_intents(intents.Intents.GUILDS)
-class StageInstanceEditEvent(StageInstanceEvent):
-    """Event fired when a stage instance is edited."""
+class StageInstanceUpdateEvent(StageInstanceEvent):
+    """Event fired when a stage instance is updated."""
 
     shard: gateway_shard.GatewayShard = attr.field(metadata={attrs_extensions.SKIP_DEEP_COPY: True})
     # <<inherited docstring from ShardEvent>>.
 
     stage_instance: StageInstance = attr.field()
-    """The stage instance that was edited."""
-
-    @property
-    def app(self) -> traits.RESTAware:
-        # <<inherited docstring from Event>>.
-        return self.stage_instance.app
-
-    @property
-    def stage_instance_id(self) -> snowflakes.Snowflake:
-        return self.stage_instance.id
+    """The stage instance that was updated."""
 
 
 @attrs_extensions.with_copy
@@ -126,12 +112,3 @@ class StageInstanceDeleteEvent(StageInstanceEvent):
 
     stage_instance: StageInstance = attr.field()
     """The stage instance that was deleted."""
-
-    @property
-    def app(self) -> traits.RESTAware:
-        # <<inherited docstring from Event>>.
-        return self.stage_instance.app
-
-    @property
-    def stage_instance_id(self) -> snowflakes.Snowflake:
-        return self.stage_instance.id

hikari/impl/entity_factory.py

@@ -1472,9 +1472,8 @@ def deserialize_guild_private_thread(
         )
 
     def deserialize_stage_instance(self, payload: data_binding.JSONObject) -> stage_instances.StageInstance:
-        guild_scheduled_event_id = (
-            snowflakes.Snowflake(payload["guild_scheduled_event_id"]) if payload["guild_scheduled_event_id"] else None
-        )
+        raw_event_id = payload["guild_scheduled_event_id"]
+        guild_scheduled_event_id = snowflakes.Snowflake(raw_event_id) if raw_event_id else None
 
         return stage_instances.StageInstance(
             app=self._app,

hikari/impl/event_factory.py

@@ -967,10 +967,10 @@ def deserialize_stage_instance_create_event(
             shard=shard, stage_instance=self._app.entity_factory.deserialize_stage_instance(payload)
         )
 
-    def deserialize_stage_instance_edit_event(
+    def deserialize_stage_instance_update_event(
         self, shard: gateway_shard.GatewayShard, payload: data_binding.JSONObject
-    ) -> stage_events.StageInstanceEditEvent:
-        return stage_events.StageInstanceEditEvent(
+    ) -> stage_events.StageInstanceUpdateEvent:
+        return stage_events.StageInstanceUpdateEvent(
             shard=shard, stage_instance=self._app.entity_factory.deserialize_stage_instance(payload)
         )
 

hikari/impl/event_manager.py

@@ -48,6 +48,7 @@
 from hikari.events import role_events
 from hikari.events import scheduled_events
 from hikari.events import shard_events
+from hikari.events import stage_events
 from hikari.events import typing_events
 from hikari.events import user_events
 from hikari.events import voice_events
@@ -889,18 +890,20 @@ async def on_entitlement_update(self, shard: gateway_shard.GatewayShard, payload
         """See https://discord.com/developers/docs/topics/gateway-events#entitlement-update for more info."""
         await self.dispatch(self._event_factory.deserialize_entitlement_update_event(shard, payload))
 
+    @event_manager_base.filtered(stage_events.StageInstanceCreateEvent)
     async def on_stage_instance_create(
         self, shard: gateway_shard.GatewayShard, payload: data_binding.JSONObject
     ) -> None:
         await self.dispatch(self._event_factory.deserialize_stage_instance_create_event(shard, payload))
 
+    @event_manager_base.filtered(stage_events.StageInstanceUpdateEvent)
     async def on_stage_instance_update(
         self, shard: gateway_shard.GatewayShard, payload: data_binding.JSONObject
     ) -> None:
-        await self.dispatch(self._event_factory.deserialize_stage_instance_edit_event(shard, payload))
+        await self.dispatch(self._event_factory.deserialize_stage_instance_update_event(shard, payload))
 
+    @event_manager_base.filtered(stage_events.StageInstanceDeleteEvent)
     async def on_stage_instance_delete(
         self, shard: gateway_shard.GatewayShard, payload: data_binding.JSONObject
     ) -> None:
         await self.dispatch(self._event_factory.deserialize_stage_instance_delete_event(shard, payload))
-# TODO

hikari/stage_instances.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # cython: language_level=3
 # Copyright (c) 2020 Nekokatt
-# Copyright (c) 2021 davfsa
+# Copyright (c) 2021-present davfsa
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -75,7 +75,7 @@ def get_channel(self) -> typing.Optional[channels.GuildStageChannel]:
 
         Returns
         -------
-        hikari.channels.GuildStageChannel
+        typing.Optional[hikari.channels.GuildStageChannel]
             The guild stage channel where this stage instance was created.
         """
         if not isinstance(self.app, traits.CacheAware):

tests/hikari/events/test_stage_events.py

@@ -28,7 +28,7 @@
 
 
 class TestStageInstanceCreateEvent:
-    @pytest.fixture()
+    @pytest.fixture
     def event(self):
         return stage_events.StageInstanceCreateEvent(shard=object(), stage_instance=mock.Mock())
 
@@ -40,10 +40,10 @@ def test_stage_instance_id_property(self, event):
         assert event.stage_instance_id == 1234
 
 
-class TestStageInstanceEditEvent:
-    @pytest.fixture()
+class TestStageInstanceUpdateEvent:
+    @pytest.fixture
     def event(self):
-        return stage_events.StageInstanceEditEvent(
+        return stage_events.StageInstanceUpdateEvent(
             shard=object(), stage_instance=mock.Mock(stage_instances.StageInstance)
         )
 
@@ -56,7 +56,7 @@ def test_stage_instance_id_property(self, event):
 
 
 class TestStageInstanceDeleteEvent:
-    @pytest.fixture()
+    @pytest.fixture
     def event(self):
         return stage_events.StageInstanceDeleteEvent(
             shard=object(), stage_instance=mock.Mock(stage_instances.StageInstance)

tests/hikari/impl/test_entity_factory.py

@@ -7215,7 +7215,7 @@ def test_deserialize_sku(self, entity_factory_impl, sku_payload):
     # Stage instance models #
     #########################
 
-    @pytest.fixture()
+    @pytest.fixture
     def stage_instance_payload(self):
         return {
             "id": "840647391636226060",

tests/hikari/impl/test_event_factory.py

@@ -1540,7 +1540,7 @@ def test_deserialize_stage_instance_create_event(self, event_factory, mock_app,
         assert event.stage_instance_id == mock_app.entity_factory.deserialize_stage_instance.return_value.id
         assert event.stage_instance == mock_app.entity_factory.deserialize_stage_instance.return_value
 
-    def test_deserialize_stage_instance_edit_event(self, event_factory, mock_app, mock_shard):
+    def test_deserialize_stage_instance_update_event(self, event_factory, mock_app, mock_shard):
         mock_payload = {
             "id": "840647391636226060",
             "guild_id": "197038439483310086",
@@ -1549,8 +1549,8 @@ def test_deserialize_stage_instance_edit_event(self, event_factory, mock_app, mo
             "privacy_level": 2,
             "discoverable_disabled": True,
         }
-        event = event_factory.deserialize_stage_instance_edit_event(mock_shard, mock_payload)
-        assert isinstance(event, stage_events.StageInstanceEditEvent)
+        event = event_factory.deserialize_stage_instance_update_event(mock_shard, mock_payload)
+        assert isinstance(event, stage_events.StageInstanceUpdateEvent)
 
         assert event.shard is mock_shard
         assert event.app is event.stage_instance.app

tests/hikari/impl/test_event_manager.py

@@ -1693,7 +1693,7 @@ async def test_on_guild_audit_log_entry_create(
             event_factory.deserialize_audit_log_entry_create_event.return_value
         )
 
-    @pytest.mark.asyncio()
+    @pytest.mark.asyncio
     async def test_on_stage_instance_create(
         self,
         event_manager_impl: event_manager.EventManagerImpl,
@@ -1716,7 +1716,7 @@ async def test_on_stage_instance_create(
             event_factory.deserialize_stage_instance_create_event.return_value
         )
 
-    @pytest.mark.asyncio()
+    @pytest.mark.asyncio
     async def test_on_stage_instance_update(
         self,
         event_manager_impl: event_manager.EventManagerImpl,
@@ -1734,12 +1734,12 @@ async def test_on_stage_instance_update(
 
         await event_manager_impl.on_stage_instance_update(shard, payload)
 
-        event_factory.deserialize_stage_instance_edit_event.assert_called_once_with(shard, payload)
+        event_factory.deserialize_stage_instance_update_event.assert_called_once_with(shard, payload)
         event_manager_impl.dispatch.assert_awaited_once_with(
-            event_factory.deserialize_stage_instance_edit_event.return_value
+            event_factory.deserialize_stage_instance_update_event.return_value
         )
 
-    @pytest.mark.asyncio()
+    @pytest.mark.asyncio
     async def test_on_stage_instance_delete(
         self,
         event_manager_impl: event_manager.EventManagerImpl,

tests/hikari/test_stage_instances.py

@@ -28,13 +28,13 @@
 from hikari import stage_instances
 
 
-@pytest.fixture()
+@pytest.fixture
 def mock_app():
     return mock.Mock()
 
 
 class TestStageInstance:
-    @pytest.fixture()
+    @pytest.fixture
     def stage_instance(self, mock_app):
         return stage_instances.StageInstance(
             app=mock_app,
@@ -79,7 +79,7 @@ def test_get_channel_when_no_cache_trait(self, stage_instance):
 
         assert stage_instance.get_channel() is None
 
-    @pytest.mark.asyncio()
+    @pytest.mark.asyncio
     async def test_fetch_channel(self, stage_instance):
         mock_stage_channel = mock.Mock(channels.GuildStageChannel)
         stage_instance.app.rest.fetch_channel = mock.AsyncMock(return_value=mock_stage_channel)
@@ -99,14 +99,14 @@ def test_get_guild_when_no_cache_trait(self, stage_instance):
 
         assert stage_instance.get_guild() is None
 
-    @pytest.mark.asyncio()
+    @pytest.mark.asyncio
     async def test_fetch_guild(self, stage_instance):
         stage_instance.app.rest.fetch_guild = mock.AsyncMock()
 
         assert await stage_instance.fetch_guild() == stage_instance.app.rest.fetch_guild.return_value
         stage_instance.app.rest.fetch_guild.assert_awaited_once_with(420)
 
-    @pytest.mark.asyncio()
+    @pytest.mark.asyncio
     async def test_fetch_scheduled_event(self, stage_instance):
         stage_instance.app.rest.fetch_scheduled_event = mock.AsyncMock()