Support Guild Onboarding #9260

bijij · 2023-02-25T06:02:46Z

Summary

This pull request implements support for the guild onboarding configuration.

Checklist

If code changes were made then they have been tested.
- I have updated the documentation to reflect the changes.
This PR fixes an issue.
This PR adds something new (e.g. new method or parameters).
This PR is a breaking change (e.g. methods or parameters removed/renamed)
This PR is not a code change (e.g. documentation, README, ...)

discord/onboarding.py

Co-authored-by: numbermaniac <5206120+numbermaniac@users.noreply.github.com>

discord/onboarding.py

Co-authored-by: numbermaniac <5206120+numbermaniac@users.noreply.github.com>

Puncher1 · 2023-03-31T21:11:25Z

A few fields are missing, which I get:

"enable_default_channels": true,
"enable_onboarding_prompts": true,
"onboarding_prompts_seen": {},
"onboarding_responses_seen": {},
"responses": []

This would belong to Onboarding

Puncher1 · 2023-04-13T08:45:33Z

The guild features could be added to this PR too:

GUILD_ONBOARDING_EVER_ENABLED
GUILD_SERVER_GUIDE
GUILD_ONBOARDING
GUILD_ONBOARDING_HAS_PROMPTS

Also the audit log events: discord/discord-api-docs#6041

Rapptz

Probably add support for the audit log stuff as well.

discord/guild.py

discord/onboarding.py

discord/guild.py

Puncher1 · 2023-10-12T19:28:03Z

The fields of the prompt option have changed: discord/discord-api-docs#6479

Looks like the emoji isn't implemented at all for editing yet.

Puncher1

Consistency

discord/http.py

discord/guild.py

Co-Authored-By: Andrin <65789180+Puncher1@users.noreply.github.com>

Puncher1 · 2024-05-16T15:55:34Z

The name of some audit log actions have changed and 2 new actions have been added, see discord/discord-api-docs#6041

I think it doesn't make sense to change the name of the server guide actions too, because the description kept the same and so the current names are more meaningful.

DA-344

Just some comments

DA-344 · 2024-05-29T14:24:47Z

discord/types/onboarding.py

+class Onboarding(TypedDict):
+    guild_id: Snowflake
+    prompts: list[Prompt]
+    default_channel_ids: list[Snowflake]


Suggested change

default_channel_ids: list[Snowflake]

default_channel_ids: List[Snowflake]

DA-344 · 2024-05-29T14:24:50Z

discord/types/onboarding.py

+
+class Onboarding(TypedDict):
+    guild_id: Snowflake
+    prompts: list[Prompt]


Suggested change

prompts: list[Prompt]

prompts: List[Prompt]

DA-344 · 2024-05-29T14:24:51Z

discord/types/onboarding.py

+
+class Prompt(TypedDict):
+    id: Snowflake
+    options: list[PromptOption]


Suggested change

options: list[PromptOption]

options: List[PromptOption]

DA-344 · 2024-05-29T14:24:53Z

discord/types/onboarding.py

+class PromptOption(TypedDict):
+    id: Snowflake
+    channel_ids: list[Snowflake]
+    role_ids: list[Snowflake]


Suggested change

role_ids: list[Snowflake]

role_ids: List[Snowflake]

DA-344 · 2024-05-29T14:24:53Z

discord/types/onboarding.py

+
+class PromptOption(TypedDict):
+    id: Snowflake
+    channel_ids: list[Snowflake]


Suggested change

channel_ids: list[Snowflake]

channel_ids: List[Snowflake]

DA-344 · 2024-05-29T14:24:55Z

discord/types/onboarding.py

+
+from __future__ import annotations
+
+from typing import Literal, Optional, TypedDict


Suggested change

from typing import Literal, Optional, TypedDict

from typing import Literal, Optional, TypedDict, List

DA-344 · 2024-05-29T14:25:03Z

discord/onboarding.py

+    def __init__(
+        self,
+        title: str,
+        emoji: Union[Emoji, PartialEmoji, str],


Docstring marks this as optional.

Suggested change

emoji: Union[Emoji, PartialEmoji, str],

emoji: Optional[Union[Emoji, PartialEmoji, str]],

DA-344 · 2024-05-29T14:25:05Z

discord/onboarding.py

+    ) -> None:
+        self.title: str = title
+        self.description: Optional[str] = description
+        self.emoji: Union[PartialEmoji, Emoji, str] = emoji


This should be parsing strs into PartialEmojis.

Suggested change

self.emoji: Union[PartialEmoji, Emoji, str] = emoji

self.emoji: Optional[Union[PartialEmoji, Emoji]] = PartialEmoji.from_str(emoji) if isinstance(emoji, str) else emoji

DA-344 · 2024-05-29T14:25:09Z

discord/onboarding.py

+        self.channel_ids: Set[int] = set(channel_ids or [])
+        self.role_ids: Set[int] = set(role_ids or [])
+
+    def to_dict(self, *, id: int = MISSING) -> PromptOptionPayload:


This should also be updated for the change, using self.emoji._to_partial then handling the rest

DA-344 · 2024-05-29T14:25:11Z

discord/onboarding.py

+            }
+
+        return {
+            'id': id or os.urandom(16).hex(),


Wouldn't this be always MISSING when no value is passed🤔? Shouldn't this be a id if id is not MISSING else os.urandom(16).hex()?

bijij added 2 commits February 25, 2023 16:02

Begin implementaton of guild onboarding configuration support

20f14b8

Add missing newline at eof in guild.py

3fd0c25

bijij changed the title ~~Begin implementaton of guild onboarding configuration support~~ Support Guild Onboarding Feb 25, 2023

Note that emoji can be Null

d051807

Rapptz reviewed Feb 27, 2023

View reviewed changes

discord/onboarding.py Outdated Show resolved Hide resolved

numbermaniac reviewed Feb 27, 2023

View reviewed changes

discord/onboarding.py Outdated Show resolved Hide resolved

Update discord/onboarding.py

87c7a2a

Co-authored-by: numbermaniac <5206120+numbermaniac@users.noreply.github.com>

numbermaniac reviewed Feb 27, 2023

View reviewed changes

discord/onboarding.py Outdated Show resolved Hide resolved

Update discord/onboarding.py

074b05f

Co-authored-by: numbermaniac <5206120+numbermaniac@users.noreply.github.com>

bijij added 2 commits April 1, 2023 22:09

Merge branch 'master' into feature/guild_onboarding

5307f1a

Rename State.get_reaction_emoji

d3fe6d6

bijij marked this pull request as ready for review April 1, 2023 12:12

Bump version

f21c903

Rapptz requested changes Apr 18, 2023

View reviewed changes

discord/guild.py Outdated Show resolved Hide resolved

discord/onboarding.py Outdated Show resolved Hide resolved

discord/guild.py Outdated Show resolved Hide resolved

bijij added 3 commits April 18, 2023 21:47

Address review comments

e8462df

Add Onboarding audit log data

e8019f9

Merge branch 'master' into feature/guild_onboarding

a850138

Rapptz added the pending PR implements an in-progress or explicitly unreleased Discord feature label Apr 18, 2023

bijij added 3 commits July 2, 2023 01:29

Merge branch 'master' into feature/guild_onboarding

b213863

Update versions, fix docs

689cc85

Fix PromptOption roles property

a9ed9ef

bijij requested a review from Rapptz July 1, 2023 15:41

bijij added 6 commits July 2, 2023 03:05

Add support for modifying onboarding, mode

1b29dd3

Remove types import

cf27b27

Resolve circular import

786b153

Fix spacing

96778d3

run black

b0a281a

Fix underline on prompt option

28fc9f0

Fix prompt ID code

025d099

Puncher1 reviewed Oct 12, 2023

View reviewed changes

discord/http.py Outdated Show resolved Hide resolved

discord/guild.py Outdated Show resolved Hide resolved

bijij and others added 3 commits November 10, 2023 00:06

Merge branch 'master' into feature/guild_onboarding

a0db097

Update guild.py

b805441

Co-Authored-By: Andrin <65789180+Puncher1@users.noreply.github.com>

Move to the dumbest emoji payload I've ever seen

001dc93

bijij requested a review from Puncher1 November 9, 2023 14:20

DA-344 reviewed May 29, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Guild Onboarding #9260

Support Guild Onboarding #9260

bijij commented Feb 25, 2023

Puncher1 commented Mar 31, 2023

Puncher1 commented Apr 13, 2023

Rapptz left a comment

Puncher1 commented Oct 12, 2023

Puncher1 left a comment

Puncher1 commented May 16, 2024

DA-344 left a comment

DA-344 May 29, 2024

DA-344 May 29, 2024

DA-344 May 29, 2024

DA-344 May 29, 2024

DA-344 May 29, 2024

DA-344 May 29, 2024

DA-344 May 29, 2024

DA-344 May 29, 2024

DA-344 May 29, 2024

DA-344 May 29, 2024

	default_channel_ids: list[Snowflake]
	default_channel_ids: List[Snowflake]


		from __future__ import annotations

		from typing import Literal, Optional, TypedDict

	emoji: Union[Emoji, PartialEmoji, str],
	emoji: Optional[Union[Emoji, PartialEmoji, str]],

	self.emoji: Union[PartialEmoji, Emoji, str] = emoji
	self.emoji: Optional[Union[PartialEmoji, Emoji]] = PartialEmoji.from_str(emoji) if isinstance(emoji, str) else emoji

Support Guild Onboarding #9260

Are you sure you want to change the base?

Support Guild Onboarding #9260

Conversation

bijij commented Feb 25, 2023

Summary

Checklist

Puncher1 commented Mar 31, 2023

Puncher1 commented Apr 13, 2023

Rapptz left a comment

Choose a reason for hiding this comment

Puncher1 commented Oct 12, 2023

Puncher1 left a comment

Choose a reason for hiding this comment

Puncher1 commented May 16, 2024

DA-344 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment