Implement Stage Instances #1725

null-domain · 2023-09-28T15:01:19Z

Summary

This PR aims to finish the work made by @ashwinvin in #695, including rebasing on the most recent hikari version (at the time of writing) and bringing tests up to scratch.

Hopefully I haven't missed anything, I only had a few hours to look at this.

Checklist

I have run nox and all the pipelines have passed.
- With the exception of the docs pipeline, but that isn't anything to do with me 👀
I have made unittests according to the code I have added/modified/deleted.

Related issues

Closes #695
Closes #602

null-domain · 2023-09-29T08:18:45Z

discord/discord-api-docs#5687 was merged last night so I'm gonna keep this as a draft until I get a moment to add this in. I have it committed locally but haven't had the chance to test yet.

davfsa

Thanks for taking over this PR!

hikari/stage_instances.py

hikari/impl/rest.py

tests/hikari/test_stage_instances.py

tests/hikari/events/test_stage_events.py

hikari/api/rest.py

davfsa

LGTM, just a nitpick :)

hikari/impl/entity_factory.py

hikari/stage_instances.py

add stubs fix linting make names more consistent. started adding tests change stage_id to id rename stage_instance_events to stage_events. add helpful functions and modify abc thing rename and fix linting fix bugs + add tests for event manager add tests for stage events and fix some bugs add tests for stage_instance fix linting add tests and fix small bugs

Just brought it up to date with the current version (at time of writing)

`guild_scheduled_event_id` was recently merged into DAPI docs. `send_start_notification` was added to Create Stage Instance some time ago, so I added that in too.

Co-authored-by: davfsa <davfsa@gmail.com> Signed-off-by: nulldomain <git@nulldoma.in>

hikari/api/rest.py

hikari/internal/routes.py

Co-authored-by: davfsa <davfsa@gmail.com> Signed-off-by: nulldomain <git@nulldoma.in>

davfsa · 2024-01-21T09:40:15Z

@FasterSpeeding please review when you can :)

null-domain · 2024-04-10T11:31:58Z

@FasterSpeeding Can you review please?

FasterSpeeding · 2024-04-13T17:10:22Z

hikari/events/stage_events.py

+
+    @property
+    @abc.abstractmethod
+    def stage_instance_id(self) -> snowflakes.Snowflake:


This is a small thing but this property could just be a solid implementation which returns self.stage_instance.id, there's not really any good reason for it to be abstract since it's the same implementation each time.

FasterSpeeding · 2024-04-13T17:11:03Z

hikari/events/stage_events.py

+    @property
+    def app(self) -> traits.RESTAware:
+        # <<inherited docstring from Event>>.
+        return self.stage_instance.app


These app property implementations could be moved to StageInstanceEvent since it's the same implementation each time anyways

FasterSpeeding · 2024-04-13T17:13:33Z

hikari/impl/entity_factory.py

+        guild_scheduled_event_id = (
+            snowflakes.Snowflake(payload["guild_scheduled_event_id"]) if payload["guild_scheduled_event_id"] else None
+        )


Suggested change

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

Would make this a bit cleaner

FasterSpeeding · 2024-04-13T17:15:23Z

hikari/stage_instances.py

+        Returns
+        -------
+        hikari.channels.GuildStageChannel
+            The guild stage channel where this stage instance was created.


The Returns section here needs to be updated to reflect that the return type is optional

FasterSpeeding · 2024-04-13T17:15:51Z

Asides from those few small things LGTM

beagold · 2024-04-14T08:35:42Z

hikari/events/stage_events.py

+# -*- coding: utf-8 -*-
+# cython: language_level=3
+# Copyright (c) 2020 Nekokatt
+# Copyright (c) 2021 davfsa


Suggested change

# Copyright (c) 2021 davfsa

# Copyright (c) 2021-present davfsa

beagold · 2024-04-14T08:36:04Z

hikari/stage_instances.py

+# -*- coding: utf-8 -*-
+# cython: language_level=3
+# Copyright (c) 2020 Nekokatt
+# Copyright (c) 2021 davfsa


Suggested change

# Copyright (c) 2021 davfsa

# Copyright (c) 2021-present davfsa

davfsa added the enhancement New feature or request label Sep 28, 2023

davfsa requested a review from FasterSpeeding September 28, 2023 15:02

This comment was marked as outdated.

Sign in to view

davfsa mentioned this pull request Sep 28, 2023

Implement Stage instances #695

Closed

2 tasks

null-domain force-pushed the feat/stage-instances branch 2 times, most recently from 8425260 to fb4e40d Compare September 29, 2023 07:18

null-domain marked this pull request as draft September 29, 2023 08:17

null-domain marked this pull request as ready for review October 2, 2023 09:32

davfsa requested changes Oct 3, 2023

View reviewed changes

null-domain force-pushed the feat/stage-instances branch from cbaa523 to 683f9dd Compare October 4, 2023 09:30

null-domain requested a review from davfsa October 4, 2023 09:37

davfsa reviewed Oct 5, 2023

View reviewed changes

hikari/impl/entity_factory.py Outdated Show resolved Hide resolved

davfsa reviewed Oct 28, 2023

View reviewed changes

hikari/stage_instances.py Show resolved Hide resolved

hikari/stage_instances.py Show resolved Hide resolved

hikari/stage_instances.py Show resolved Hide resolved

ashwinvin and others added 16 commits November 2, 2023 09:23

Rebased and improved

67996b8

Just brought it up to date with the current version (at time of writing)

Fix failing test

f5704cc

Don't cry, towncrier

ddef5a2

Add missing attributes to Stage instances

d99b5d5

`guild_scheduled_event_id` was recently merged into DAPI docs. `send_start_notification` was added to Create Stage Instance some time ago, so I added that in too.

Don't use spec_set in stageinstance mock app test

f7fd4d5

Co-authored-by: davfsa <davfsa@gmail.com> Signed-off-by: nulldomain <git@nulldoma.in>

Update tests/hikari/events/test_stage_events.py

1a77a6a

Co-authored-by: davfsa <davfsa@gmail.com> Signed-off-by: nulldomain <git@nulldoma.in>

Remove deprecated stage instance privacy level

f42191a

Lowercase *every instance of "stage instance"

f2e78d6

Triple quote docstring

ff65fb6

Cast guild_scheduled_event_id to snowflake

36ce0b9

Move note about UnauthorizedError to the right place

b8ec2c1

Turns out g_s_e_id is always in the payload, just set as None

d4f114a

Correct info/raised exc about non-existent stage instance

ef7ed23

Remove unused imports, black changes

7aed3d3

Fix failing tests, remove remaining refs to deprecated attribute

3bfaf63

null-domain and others added 4 commits November 2, 2023 09:23

guild_scheduled_event_id should be None instead of UNDEFINED

e666ed5

Remove unused import

594c3a6

Extract guild_scheduled_event_id to its own variable

cbd64c9

Add missing tests

e2f4b43

null-domain force-pushed the feat/stage-instances branch from 7ee021d to e2f4b43 Compare November 2, 2023 09:23

null-domain requested a review from davfsa November 2, 2023 09:27

null-domain added 2 commits November 3, 2023 09:05

Merge branch 'master' into feat/stage-instances

6692e38

Merge branch 'master' into feat/stage-instances

423302d

davfsa reviewed Dec 7, 2023

View reviewed changes

hikari/api/rest.py Outdated Show resolved Hide resolved

hikari/api/rest.py Outdated Show resolved Hide resolved

hikari/internal/routes.py Show resolved Hide resolved

null-domain and others added 3 commits December 7, 2023 08:57

Update hikari/internal/routes.py

a6dd630

Co-authored-by: davfsa <davfsa@gmail.com> Signed-off-by: nulldomain <git@nulldoma.in>

Update hikari/api/rest.py

0358720

Co-authored-by: davfsa <davfsa@gmail.com> Signed-off-by: nulldomain <git@nulldoma.in>

Update hikari/api/rest.py

144f93d

Co-authored-by: davfsa <davfsa@gmail.com> Signed-off-by: nulldomain <git@nulldoma.in>

null-domain requested a review from davfsa December 7, 2023 08:58

davfsa approved these changes Dec 7, 2023

View reviewed changes

Merge branch 'master' into feat/stage-instances

257e387

FasterSpeeding reviewed Apr 13, 2024

View reviewed changes

beagold reviewed Apr 14, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Stage Instances #1725

Implement Stage Instances #1725

null-domain commented Sep 28, 2023

This comment was marked as outdated.

null-domain commented Sep 29, 2023

davfsa left a comment

davfsa left a comment

davfsa commented Jan 21, 2024

null-domain commented Apr 10, 2024

FasterSpeeding Apr 13, 2024

FasterSpeeding Apr 13, 2024 •

edited

FasterSpeeding Apr 13, 2024

FasterSpeeding Apr 13, 2024

FasterSpeeding commented Apr 13, 2024

beagold Apr 14, 2024

beagold Apr 14, 2024

	# Copyright (c) 2021 davfsa
	# Copyright (c) 2021-present davfsa

Implement Stage Instances #1725

Are you sure you want to change the base?

Implement Stage Instances #1725

Conversation

null-domain commented Sep 28, 2023

Summary

Checklist

Related issues

This comment was marked as outdated.

null-domain commented Sep 29, 2023

davfsa left a comment

Choose a reason for hiding this comment

davfsa left a comment

Choose a reason for hiding this comment

davfsa commented Jan 21, 2024

null-domain commented Apr 10, 2024

FasterSpeeding Apr 13, 2024

Choose a reason for hiding this comment

FasterSpeeding Apr 13, 2024 • edited

Choose a reason for hiding this comment

FasterSpeeding Apr 13, 2024

Choose a reason for hiding this comment

FasterSpeeding Apr 13, 2024

Choose a reason for hiding this comment

FasterSpeeding commented Apr 13, 2024

beagold Apr 14, 2024

Choose a reason for hiding this comment

beagold Apr 14, 2024

Choose a reason for hiding this comment

FasterSpeeding Apr 13, 2024 •

edited