pincer.objects.app.interactions.Interaction.__post_init__() - Code Metrics - Inspection of "Implemented more command types" - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#141)

unknown

created 2021-10-11 15:29 UTC

Interaction.__post_init__() B

↳ Parent: pincer.objects.app.interactions

Complexity

Conditions

Size

Total Lines	58
Code Lines	44

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	44
dl	0
loc	58
rs	8.824
c	0
b	0
f	0
cc	4
nop	1

How to fix Long Method

# Copyright Pincer 2021-Present

# Full MIT License can be found in `LICENSE` at the project root.

from __future__ import annotations

from dataclasses import dataclass
from enum import IntEnum
from typing import Dict, TYPE_CHECKING

from asyncio import gather, iscoroutine

from .command import AppCommandInteractionDataOption, AppCommandOptionType
from .interaction_base import InteractionType
from ..app.select_menu import SelectOption
from ..guild.member import GuildMember
from ..message.context import MessageContext
from ..message.user_message import UserMessage
from ..user import User
from ...core.http import HTTPClient
from ...utils import APIObject, MISSING, Snowflake, convert

if TYPE_CHECKING:
    from ..guild.channel import Channel
    from ..guild.role import Role
    from ... import Client
    from ...utils import APINullable


class InteractionFlags(IntEnum):
    """
    :param EPHEMERAL:
        only the user receiving the message can see it
    """
    EPHEMERAL = 1 << 6


@dataclass
class ResolvedData(APIObject):
    """
    Represents a Discord Resolved Data structure

    :param users:
        Map of Snowflakes to user objects

    :param members:
        Map of Snowflakes to partial member objects

    :param roles:
        Map of Snowflakes to role objects

    :param channels:
        Map of Snowflakes to partial channel objects

    :param messages:
        Map of Snowflakes to partial message objects
    """
    users: APINullable[Dict[Snowflake, User]] = MISSING
    members: APINullable[Dict[Snowflake, GuildMember]] = MISSING
    roles: APINullable[Dict[Snowflake, Role]] = MISSING
    channels: APINullable[Dict[Snowflake, Channel]] = MISSING
    messages: APINullable[Dict[Snowflake, UserMessage]] = MISSING


@dataclass

class InteractionData(APIObject):
    """
    Represents a Discord Interaction Data structure

    :param id:
        the `ID` of the invoked command

    :param name:
        the `name` of the invoked command

    :param type:
        the `type` of the invoked command

    :param resolved:
        converted users + roles + channels

    :param options:
        the params + values from the user

    :param custom_id:
        the `custom_id` of the component

    :param component_type:
        the type of the component

    :param values:
        the values the user selected

    :param target_id:
        id of the user or message targeted by a user or message command
    """
    id: Snowflake
    name: str
    type: int

    resolved: APINullable[ResolvedData] = MISSING
    options: APINullable[AppCommandInteractionDataOption] = MISSING
    custom_id: APINullable[str] = MISSING
    component_type: APINullable[int] = MISSING
    values: APINullable[SelectOption] = MISSING
    target_id: APINullable[Snowflake] = MISSING

    def __post_init__(self):
        self.id = convert(self.id, Snowflake.from_string)
        self.resolved = convert(
            self.resolved,
            ResolvedData.from_dict,
            ResolvedData
        )
        self.options = convert(
            self.options,
            AppCommandInteractionDataOption.from_dict,
            AppCommandInteractionDataOption
        )
        self.values = convert(
            self.values,
            SelectOption.from_dict,
            SelectOption
        )
        self.target_id = convert(self.target_id, Snowflake.from_string)


@dataclass

class Interaction(APIObject):
    """
    Represents a Discord Interaction object

    :param _client:

    :param _http:

    :param id:
        id of the interaction

    :param application_id:
        id of the application this interaction is for

    :param type:
        the type of interaction

    :param data:
        the command data payload

    :param guild_id:
        the guild it was sent from

    :param channel_id:
        the channel it was sent from

    :param member:
        guild member data for the invoking user, including permissions

    :param user:
        user object for the invoking user, if invoked in a DM

    :param token:
        a continuation token for responding to the interaction

    :param version:
        read-only property, always `1`

    :param message:
        for components, the message they were attached to
    """

    _client: Client
    _http: HTTPClient

    id: Snowflake
    application_id: Snowflake
    type: InteractionType
    token: str

    version: int = 1
    data: APINullable[InteractionData] = MISSING
    guild_id: APINullable[Snowflake] = MISSING
    channel_id: APINullable[Snowflake] = MISSING
    member: APINullable[GuildMember] = MISSING
    user: APINullable[User] = MISSING
    message: APINullable[UserMessage] = MISSING

    def __post_init__(self):
        self.id = convert(self.id, Snowflake.from_string)
        self.application_id = convert(
            self.application_id, Snowflake.from_string
        )
        self.type = convert(self.type, InteractionType)
        self.data = convert(
            self.data,
            InteractionData.from_dict,
            InteractionData
        )
        self.guild_id = convert(self.guild_id, Snowflake.from_string)
        self.channel_id = convert(self.channel_id, Snowflake.from_string)

        self.member = convert(
            self.member,
            GuildMember.from_dict,
            GuildMember,
            client=self._client
        )

        self.user = convert(
            self.user,
            User.from_dict,
            User,
            client=self._client
        )

        self.message = convert(
            self.message,
            UserMessage.from_dict,
            UserMessage,
            client=self._client
        )

        self._convert_functions = {
            AppCommandOptionType.SUB_COMMAND: None,
            AppCommandOptionType.SUB_COMMAND_GROUP: None,

            AppCommandOptionType.STRING: str,
            AppCommandOptionType.INTEGER: int,
            AppCommandOptionType.BOOLEAN: bool,
            AppCommandOptionType.NUMBER: float,

            AppCommandOptionType.USER: lambda value:
                self._client.get_user(

                    convert(value, Snowflake.from_string)
                ),
            AppCommandOptionType.CHANNEL: lambda value:
                self._client.get_channel(

                    convert(value, Snowflake.from_string)
                ),
            AppCommandOptionType.ROLE: lambda value:
                self._client.get_role(

                    convert(self.guild_id, Snowflake.from_string),
                    convert(value, Snowflake.from_string)
                ),
            AppCommandOptionType.MENTIONABLE: None
        }

    async def build(self):
        """
        Sets the parameters in the interaction that need information from the
        discord API.
        """

        if not self.data.options:
            return

        await gather(
            *map(self.convert, self.data.options)
        )

    async def convert(self, option: AppCommandInteractionDataOption):
        """
        Sets an AppCommandInteractionDataOption value paramater to the payload
        type
        """

        converter = self._convert_functions.get(option.type)

        if not converter:
            raise NotImplementedError(
                f"Handling for AppCommandOptionType {option.type} is not "
                "implemented"
            )

        res = converter(option.value)

        if iscoroutine(res):
            option.value = await res
            return

        option.value = res

    def convert_to_message_context(self, command):

        return MessageContext(
            self.id,
            self.member or self.user,
            command,
            self.guild_id,
            self.channel_id
        )


1			# Copyright Pincer 2021-Present
			0 ignored issues – show introduced 2021-09-06 08:54 UTC by Report Bug Copy Issue Report Missing module docstring Loading history...
2			# Full MIT License can be found in `LICENSE` at the project root.
3
4			from __future__ import annotations
5
6			from dataclasses import dataclass
7			from enum import IntEnum
8			from typing import Dict, TYPE_CHECKING
9
10			from asyncio import gather, iscoroutine
11
12			from .command import AppCommandInteractionDataOption, AppCommandOptionType
13			from .interaction_base import InteractionType
14			from ..app.select_menu import SelectOption
15			from ..guild.member import GuildMember
16			from ..message.context import MessageContext
17			from ..message.user_message import UserMessage
18			from ..user import User
19			from ...core.http import HTTPClient
20			from ...utils import APIObject, MISSING, Snowflake, convert
21
22			if TYPE_CHECKING:
23			from ..guild.channel import Channel
24			from ..guild.role import Role
25			from ... import Client
26			from ...utils import APINullable
27
28
29			class InteractionFlags(IntEnum):
30			"""
31			:param EPHEMERAL:
32			only the user receiving the message can see it
33			"""
34			EPHEMERAL = 1 << 6
35
36
37			@dataclass
38			class ResolvedData(APIObject):
39			"""
40			Represents a Discord Resolved Data structure
41
42			:param users:
43			Map of Snowflakes to user objects
44
45			:param members:
46			Map of Snowflakes to partial member objects
47
48			:param roles:
49			Map of Snowflakes to role objects
50
51			:param channels:
52			Map of Snowflakes to partial channel objects
53
54			:param messages:
55			Map of Snowflakes to partial message objects
56			"""
57			users: APINullable[Dict[Snowflake, User]] = MISSING
58			members: APINullable[Dict[Snowflake, GuildMember]] = MISSING
59			roles: APINullable[Dict[Snowflake, Role]] = MISSING
60			channels: APINullable[Dict[Snowflake, Channel]] = MISSING
61			messages: APINullable[Dict[Snowflake, UserMessage]] = MISSING
62
63
64			@dataclass
			0 ignored issues – show best-practice introduced 2021-09-07 15:34 UTC by Report Bug Copy Issue Report Too many instance attributes (9/7) Loading history...
65			class InteractionData(APIObject):
66			"""
67			Represents a Discord Interaction Data structure
68
69			:param id:
70			the `ID` of the invoked command
71
72			:param name:
73			the `name` of the invoked command
74
75			:param type:
76			the `type` of the invoked command
77
78			:param resolved:
79			converted users + roles + channels
80
81			:param options:
82			the params + values from the user
83
84			:param custom_id:
85			the `custom_id` of the component
86
87			:param component_type:
88			the type of the component
89
90			:param values:
91			the values the user selected
92
93			:param target_id:
94			id of the user or message targeted by a user or message command
95			"""
96			id: Snowflake
97			name: str
98			type: int
99
100			resolved: APINullable[ResolvedData] = MISSING
101			options: APINullable[AppCommandInteractionDataOption] = MISSING
102			custom_id: APINullable[str] = MISSING
103			component_type: APINullable[int] = MISSING
104			values: APINullable[SelectOption] = MISSING
105			target_id: APINullable[Snowflake] = MISSING
106
107			def __post_init__(self):
108			self.id = convert(self.id, Snowflake.from_string)
109			self.resolved = convert(
110			self.resolved,
111			ResolvedData.from_dict,
112			ResolvedData
113			)
114			self.options = convert(
115			self.options,
116			AppCommandInteractionDataOption.from_dict,
117			AppCommandInteractionDataOption
118			)
119			self.values = convert(
120			self.values,
121			SelectOption.from_dict,
122			SelectOption
123			)
124			self.target_id = convert(self.target_id, Snowflake.from_string)
125
126
127			@dataclass
			0 ignored issues – show best-practice introduced 2021-10-10 23:37 UTC by Report Bug Copy Issue Report Too many instance attributes (14/7) Loading history...
128			class Interaction(APIObject):
129			"""
130			Represents a Discord Interaction object
131
132			:param _client:
133
134			:param _http:
135
136			:param id:
137			id of the interaction
138
139			:param application_id:
140			id of the application this interaction is for
141
142			:param type:
143			the type of interaction
144
145			:param data:
146			the command data payload
147
148			:param guild_id:
149			the guild it was sent from
150
151			:param channel_id:
152			the channel it was sent from
153
154			:param member:
155			guild member data for the invoking user, including permissions
156
157			:param user:
158			user object for the invoking user, if invoked in a DM
159
160			:param token:
161			a continuation token for responding to the interaction
162
163			:param version:
164			read-only property, always `1`
165
166			:param message:
167			for components, the message they were attached to
168			"""
169
170			_client: Client
171			_http: HTTPClient
172
173			id: Snowflake
174			application_id: Snowflake
175			type: InteractionType
176			token: str
177
178			version: int = 1
179			data: APINullable[InteractionData] = MISSING
180			guild_id: APINullable[Snowflake] = MISSING
181			channel_id: APINullable[Snowflake] = MISSING
182			member: APINullable[GuildMember] = MISSING
183			user: APINullable[User] = MISSING
184			message: APINullable[UserMessage] = MISSING
185
186			def __post_init__(self):
187			self.id = convert(self.id, Snowflake.from_string)
188			self.application_id = convert(
189			self.application_id, Snowflake.from_string
190			)
191			self.type = convert(self.type, InteractionType)
192			self.data = convert(
193			self.data,
194			InteractionData.from_dict,
195			InteractionData
196			)
197			self.guild_id = convert(self.guild_id, Snowflake.from_string)
198			self.channel_id = convert(self.channel_id, Snowflake.from_string)
199
200			self.member = convert(
201			self.member,
202			GuildMember.from_dict,
203			GuildMember,
204			client=self._client
205			)
206
207			self.user = convert(
208			self.user,
209			User.from_dict,
210			User,
211			client=self._client
212			)
213
214			self.message = convert(
215			self.message,
216			UserMessage.from_dict,
217			UserMessage,
218			client=self._client
219			)
220
221			self._convert_functions = {
222			AppCommandOptionType.SUB_COMMAND: None,
223			AppCommandOptionType.SUB_COMMAND_GROUP: None,
224
225			AppCommandOptionType.STRING: str,
226			AppCommandOptionType.INTEGER: int,
227			AppCommandOptionType.BOOLEAN: bool,
228			AppCommandOptionType.NUMBER: float,
229
230			AppCommandOptionType.USER: lambda value:
231			self._client.get_user(
			0 ignored issues – show Coding Style introduced 2021-10-10 15:19 UTC by Report Bug Copy Issue Report Wrong continued indentation (add 23 spaces). Loading history...
232			convert(value, Snowflake.from_string)
233			),
234			AppCommandOptionType.CHANNEL: lambda value:
235			self._client.get_channel(
			0 ignored issues – show Coding Style introduced 2021-10-10 15:19 UTC by Report Bug Copy Issue Report Wrong continued indentation (add 26 spaces). Loading history...
236			convert(value, Snowflake.from_string)
237			),
238			AppCommandOptionType.ROLE: lambda value:
239			self._client.get_role(
			0 ignored issues – show Coding Style introduced 2021-10-10 15:19 UTC by Report Bug Copy Issue Report Wrong continued indentation (add 23 spaces). Loading history...
240			convert(self.guild_id, Snowflake.from_string),
241			convert(value, Snowflake.from_string)
242			),
243			AppCommandOptionType.MENTIONABLE: None
244			}
245
246			async def build(self):
247			"""
248			Sets the parameters in the interaction that need information from the
249			discord API.
250			"""
251
252			if not self.data.options:
253			return
254
255			await gather(
256			*map(self.convert, self.data.options)
257			)
258
259			async def convert(self, option: AppCommandInteractionDataOption):
260			"""
261			Sets an AppCommandInteractionDataOption value paramater to the payload
262			type
263			"""
264
265			converter = self._convert_functions.get(option.type)
266
267			if not converter:
268			raise NotImplementedError(
269			f"Handling for AppCommandOptionType {option.type} is not "
270			"implemented"
271			)
272
273			res = converter(option.value)
274
275			if iscoroutine(res):
276			option.value = await res
277			return
278
279			option.value = res
280
281			def convert_to_message_context(self, command):
			0 ignored issues – show introduced 2021-09-26 12:43 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
282			return MessageContext(
283			self.id,
284			self.member or self.user,
285			command,
286			self.guild_id,
287			self.channel_id
288			)
289

Pincer-org / Pincer

Pull Request — main (#141)

Interaction.__post_init__() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like