Josh
2 years ago
7 changed files with 334 additions and 0 deletions
@ -0,0 +1,209 @@ |
|||
""" |
|||
The MIT License (MIT) |
|||
|
|||
Copyright (c) 2015-present Rapptz |
|||
|
|||
Permission is hereby granted, free of charge, to any person obtaining a |
|||
copy of this software and associated documentation files (the "Software"), |
|||
to deal in the Software without restriction, including without limitation |
|||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|||
and/or sell copies of the Software, and to permit persons to whom the |
|||
Software is furnished to do so, subject to the following conditions: |
|||
|
|||
The above copyright notice and this permission notice shall be included in |
|||
all copies or substantial portions of the Software. |
|||
|
|||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
|||
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
|||
DEALINGS IN THE SOFTWARE. |
|||
""" |
|||
|
|||
from __future__ import annotations |
|||
|
|||
from typing import TYPE_CHECKING, Optional, Set, List, Union |
|||
|
|||
from . import utils |
|||
from .enums import OnboardingPromptType, try_enum |
|||
from .utils import cached_slot_property |
|||
|
|||
__all__ = ('Onboarding', 'OnboardingPrompt', 'OnboardingPromptOption') |
|||
|
|||
|
|||
if TYPE_CHECKING: |
|||
from .abc import GuildChannel |
|||
from .emoji import Emoji |
|||
from .guild import Guild |
|||
from .partial_emoji import PartialEmoji |
|||
from .role import Role |
|||
from .state import ConnectionState |
|||
from .threads import Thread |
|||
from .types.onboarding import ( |
|||
Prompt as PromptPayload, |
|||
PromptOption as PromptOptionPayload, |
|||
Onboarding as OnboardingPayload, |
|||
) |
|||
|
|||
|
|||
class OnboardingPromptOption: |
|||
"""Represents an onboarding prompt option. |
|||
|
|||
.. versionadded:: 2.2 |
|||
|
|||
Attributes |
|||
----------- |
|||
id: :class:`int` |
|||
The ID of this prompt option. |
|||
guild: :class:`Guild` |
|||
The guild the onboarding prompt option is related to. |
|||
title: :class:`str` |
|||
The title of this prompt option. |
|||
description: Optional[:class:`str`] |
|||
The description of this prompt option. |
|||
emoji: Union[:class:`Emoji`, :class:`PartialEmoji`, :class:`str`] |
|||
The emoji tied to this option. May be a custom emoji, or a unicode emoji. |
|||
channel_ids: Set[:class:`int`] |
|||
The IDs of the channels that will be set visible if this option is selected. |
|||
role_ids: Set[:class:`int`] |
|||
The IDs of the roles given to the user if this option is selected |
|||
""" |
|||
|
|||
__slots__ = ( |
|||
'_state', |
|||
'_cs_channels', |
|||
'_cs_roles', |
|||
'guild', |
|||
'id', |
|||
'title', |
|||
'description', |
|||
'emoji', |
|||
'channel_ids', |
|||
'role_ids', |
|||
) |
|||
|
|||
def __init__(self, *, data: PromptOptionPayload, state: ConnectionState, guild: Guild) -> None: |
|||
self._state: ConnectionState = state |
|||
self.guild: Guild = guild |
|||
self.id: int = int(data['id']) |
|||
self.title: str = data['title'] |
|||
self.description: Optional[str] = data['description'] |
|||
self.emoji: Union[PartialEmoji, Emoji, str] = self._state.get_reaction_emoji(data['emoji']) |
|||
self.channel_ids: Set[int] = {int(channel_id) for channel_id in data['channel_ids']} |
|||
self.role_ids: Set[int] = {int(role_id) for role_id in data['role_ids']} |
|||
|
|||
def __repr__(self) -> str: |
|||
return f'<OnboardingPromptOption id={self.id} title={self.title}>' |
|||
|
|||
@cached_slot_property('_cs_channels') |
|||
def channels(self) -> List[Union[GuildChannel, Thread]]: |
|||
"""List[Union[:class:`abc.GuildChannel`, :class:`Thread`]]: The list of channels which will be set visible if this option is selected.""" |
|||
it = filter(None, map(self.guild._resolve_channel, self.channel_ids)) |
|||
return utils._unique(it) |
|||
|
|||
@cached_slot_property('_cs_roles') |
|||
def default_channels(self) -> List[Role]: |
|||
"""List[Union[:class:`abc.GuildChannel`, :class:`Thread`]]: The list of roles given to the user if this option is selected.""" |
|||
it = filter(None, map(self.guild.get_role, self.role_ids)) |
|||
return utils._unique(it) |
|||
|
|||
|
|||
class OnboardingPrompt: |
|||
"""Represents an onboarding prompt. |
|||
|
|||
.. versionadded:: 2.2 |
|||
|
|||
Attributes |
|||
----------- |
|||
id: :class:`int` |
|||
The ID of this prompt. |
|||
guild: :class:`Guild` |
|||
The guild the onboarding prompt is related to. |
|||
type: :class:`OnboardingPromptType` |
|||
The type of onboarding prompt. |
|||
title: :class:`str` |
|||
The title of this prompt. |
|||
options: List[:class:`OnboardingPromptOption`] |
|||
The list of options the user can select from. |
|||
single_select: :class:`bool` |
|||
Whether only one option can be selected. |
|||
required: :class:`bool` |
|||
Whether this prompt is required to complete the onboarding flow. |
|||
in_onboarding: :class:`bool` |
|||
Whether this prompt is part of the onboarding flow. |
|||
""" |
|||
|
|||
__slots__ = ( |
|||
'_state', |
|||
'guild', |
|||
'id', |
|||
'title', |
|||
'options', |
|||
'single_select', |
|||
'required', |
|||
'in_onboarding', |
|||
'type', |
|||
) |
|||
|
|||
def __init__(self, *, data: PromptPayload, state: ConnectionState, guild: Guild): |
|||
self._state: ConnectionState = state |
|||
self.guild: Guild = guild |
|||
self.id: int = int(data['id']) |
|||
self.title: str = data['title'] |
|||
self.options: List[OnboardingPromptOption] = [ |
|||
OnboardingPromptOption(data=option_data, state=state, guild=guild) for option_data in data['options'] |
|||
] |
|||
self.single_select: bool = data['single_select'] |
|||
self.required: bool = data['required'] |
|||
self.in_onboarding: bool = data['in_onboarding'] |
|||
self.type: OnboardingPromptType = try_enum(OnboardingPromptType, data['type']) |
|||
|
|||
def __repr__(self) -> str: |
|||
return f'<OnboardingPrompt id={self.id} title={self.title}, type={self.type}>' |
|||
|
|||
|
|||
class Onboarding: |
|||
"""Represents a guild's onboarding configuration. |
|||
|
|||
.. versionadded:: 2.2 |
|||
|
|||
Attributes |
|||
----------- |
|||
guild: :class:`Guild` |
|||
The guild the onboarding configuration is for. |
|||
prompts: List[:class:`OnboardingPrompt`] |
|||
The list of prompts shown during the onboarding and customize community flows. |
|||
default_channel_ids: Set[:class:`int`] |
|||
The IDs of the channels exposed to a new user by default. |
|||
enabled: :class:`bool`: |
|||
Whether onboarding is enabled in this guild. |
|||
""" |
|||
|
|||
__slots__ = ( |
|||
'_state', |
|||
'_cs_default_channels', |
|||
'guild', |
|||
'prompts', |
|||
'default_channel_ids', |
|||
'enabled', |
|||
) |
|||
|
|||
def __init__(self, *, data: OnboardingPayload, guild: Guild, state: ConnectionState) -> None: |
|||
self._state: ConnectionState = state |
|||
self.guild: Guild = guild |
|||
self.default_channel_ids: Set[int] = {int(channel_id) for channel_id in data['default_channel_ids']} |
|||
self.prompts: List[OnboardingPrompt] = [ |
|||
OnboardingPrompt(data=prompt_data, state=state, guild=guild) for prompt_data in data['prompts'] |
|||
] |
|||
self.enabled: bool = data['enabled'] |
|||
|
|||
def __repr__(self) -> str: |
|||
return f'<Onboarding guild={self.guild!r} enabled={self.enabled}>' |
|||
|
|||
@cached_slot_property('_cs_default_channels') |
|||
def default_channels(self) -> List[Union[GuildChannel, Thread]]: |
|||
"""List[Union[:class:`abc.GuildChannel`, :class:`Thread`]]: The list of channels exposed to a new user by default.""" |
|||
it = filter(None, map(self.guild._resolve_channel, self.default_channel_ids)) |
|||
return utils._unique(it) |
|||
@ -0,0 +1,59 @@ |
|||
""" |
|||
The MIT License (MIT) |
|||
|
|||
Copyright (c) 2015-present Rapptz |
|||
|
|||
Permission is hereby granted, free of charge, to any person obtaining a |
|||
copy of this software and associated documentation files (the "Software"), |
|||
to deal in the Software without restriction, including without limitation |
|||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|||
and/or sell copies of the Software, and to permit persons to whom the |
|||
Software is furnished to do so, subject to the following conditions: |
|||
|
|||
The above copyright notice and this permission notice shall be included in |
|||
all copies or substantial portions of the Software. |
|||
|
|||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
|||
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
|||
DEALINGS IN THE SOFTWARE. |
|||
""" |
|||
|
|||
from __future__ import annotations |
|||
|
|||
from typing import Literal, Optional, TypedDict |
|||
|
|||
from .emoji import Emoji |
|||
from .snowflake import Snowflake |
|||
|
|||
|
|||
PromptType = Literal[0, 1] |
|||
|
|||
|
|||
class PromptOption(TypedDict): |
|||
id: Snowflake |
|||
channel_ids: list[Snowflake] |
|||
role_ids: list[Snowflake] |
|||
emoji: Emoji |
|||
title: str |
|||
description: Optional[str] |
|||
|
|||
|
|||
class Prompt(TypedDict): |
|||
id: Snowflake |
|||
options: list[PromptOption] |
|||
title: str |
|||
single_select: bool |
|||
required: bool |
|||
in_onboarding: bool |
|||
type: PromptType |
|||
|
|||
|
|||
class Onboarding(TypedDict): |
|||
guild_id: Snowflake |
|||
prompts: list[Prompt] |
|||
default_channel_ids: list[Snowflake] |
|||
enabled: bool |
|||
Loading…
Reference in new issue