pincer.objects.message.user_message.UserMessage.__post_init__() - Code Metrics - Inspection of "✨ Guild registration, guild commands fix, command..." - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#158)

unknown

created 2021-10-22 14:24 UTC

pincer.objects.message.user_message.UserMessage.__post_init__() A

↳ Parent: Project

Complexity

Conditions

Size

Total Lines	43
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	34
dl	0
loc	43
rs	9.064
c	0
b	0
f	0
cc	1
nop	1

# 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, Enum
from typing import List, Optional, Union, TYPE_CHECKING

from ..._config import GatewayConfig
from ...utils.api_object import APIObject

from ...utils.types import MISSING

if TYPE_CHECKING:
    from ..app.application import Application
    from ..app.interaction_base import MessageInteraction
    from ..guild.channel import Channel, ChannelMention

    from ..guild.member import GuildMember
    from ..guild.role import Role
    from ..message.attachment import Attachment
    from ..message.component import MessageComponent
    from ..message.embed import Embed
    from ..message.reaction import Reaction
    from ..message.reference import MessageReference
    from ..message.sticker import StickerItem
    from ..user import User
    from ...utils.snowflake import Snowflake
    from ...utils.timestamp import Timestamp

    from ...utils import APINullable


class MessageActivityType(IntEnum):
    """
    The activity people can perform on a rich presence activity.

    Such an activity could for example be a spotify listen.
    """
    JOIN = 1
    SPECTATE = 2
    LISTEN = 3
    JOIN_REQUEST = 5


class MessageFlags(IntEnum):
    """
    Special message properties.

    :param CROSSPOSTED:
        the message has been published to subscribed
        channels (via Channel Following)

    :param IS_CROSSPOST:
        this message originated from a message
        in another channel (via Channel Following)

    :param SUPPRESS_EMBEDS:
        do not include any embeds when serializing this message

    :param SOURCE_MESSAGE_DELETED:
        the source message for this crosspost
        has been deleted (via Channel Following)

    :param URGENT:
        this message came from the urgent message system

    :param HAS_THREAD:
        this message has an associated thread,
        with the same id as the message

    :param EPHEMERAL:
        this message is only visible to the user
        who invoked the Interaction

    :param LOADING:
        this message is an Interaction
        Response and the bot is "thinking"
    """
    CROSSPOSTED = 1 << 0
    IS_CROSSPOST = 1 << 1
    SUPPRESS_EMBEDS = 1 << 2
    SOURCE_MESSAGE_DELETED = 1 << 3
    URGENT = 1 << 4
    HAS_THREAD = 1 << 5
    EPHEMERAL = 1 << 6
    LOADING = 1 << 7


class MessageType(IntEnum):
    """
    Represents the type of the message.
    """
    DEFAULT = 0
    RECIPIENT_ADD = 1
    RECIPIENT_REMOVE = 2
    CALL = 3
    CHANNEL_NAME_CHANGE = 4
    CHANNEL_ICON_CHANGE = 5
    CHANNEL_PINNED_MESSAGE = 6
    GUILD_MEMBER_JOIN = 7
    USER_PREMIUM_GUILD_SUBSCRIPTION = 8
    USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_1 = 9
    USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_2 = 10
    USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_3 = 11
    CHANNEL_FOLLOW_ADD = 12
    GUILD_DISCOVERY_DISQUALIFIED = 14
    GUILD_DISCOVERY_REQUALIFIED = 15
    GUILD_DISCOVERY_GRACE_PERIOD_INITIAL_WARNING = 16
    GUILD_DISCOVERY_GRACE_PERIOD_FINAL_WARNING = 17
    THREAD_CREATED = 18
    REPLY = 19
    APPLICATION_COMMAND = 20

    if GatewayConfig.version < 8:
        REPLY = 0
        APPLICATION_COMMAND = 0

    if GatewayConfig.version >= 9:
        THREAD_STARTER_MESSAGE = 21

    GUILD_INVITE_REMINDER = 22


@dataclass
class MessageActivity(APIObject):
    """
    Represents a Discord Message Activity object

    :param type:
        type of message activity

    :param party_id:
        party_id from a Rich Presence event
    """
    type: MessageActivityType
    party_id: APINullable[str] = MISSING


class AllowedMentionTypes(str, Enum):
    """
    The allowed mentions.

    :param ROLES:
        Controls role mentions

    :param USERS:
        Controls user mentions

    :param EVERYONE:
        Controls @everyone and @here mentions
    """
    ROLES = "roles"
    USERS = "user"
    EVERYONE = "everyone"


@dataclass

class UserMessage(APIObject):
    """
    Represents a message sent in a channel within Discord.

    :param id:
        id of the message

    :param channel_id:
        id of the channel the message was sent in

    :param guild_id:
        id of the guild the message was sent in

    :param author:
        the author of this message (not guaranteed to be a valid user)

    :param member:
        member properties for this message's author

    :param content:
        contents of the message

    :param timestamp:
        when this message was sent

    :param edited_timestamp:
        when this message was edited (or null if never)

    :param tts:
        whether this was a TTS message

    :param mention_everyone:
        whether this message mentions everyone

    :param mentions:
        users specifically mentioned in the message

    :param mention_roles:
        roles specifically mentioned in this message

    :param mention_channels:
        channels specifically mentioned in this message

    :param attachments:
        any attached files

    :param embeds:
        any embedded content

    :param reactions:
        reactions to the message

    :param nonce:
        user for validating a message was sent

    :param pinned:
        whether this message is pinned

    :param webhook_id:
        if the message is generated by a webhook,
        this is the webhook's id

    :param type:
        type of message

    :param activity:
        sent with Rich Presence-related chat embeds

    :param application:
        sent with Rich Presence-related chat embeds

    :param application_id:
        if the message is a response to an Interaction,
        this is the id of the interaction's application

    :param message_reference:
        data showing the source of a crosspost,
        channel follow add, pin, or reply message

    :param flags:
        message flags combined as a bitfield

    :param referenced_message:
        the message associated with the message_reference

    :param interaction:
        sent if the message is a response to an Interaction

    :param thread:
        the thread that was started from this message,
        includes thread member object

    :param components:
        sent if the message contains components like buttons,
        action rows, or other interactive components

    :param sticker_items:
        sent if the message contains stickers
    """
    id: Snowflake
    channel_id: Snowflake
    author: User
    content: str
    timestamp: Timestamp
    tts: bool
    mention_everyone: bool
    mentions: List[GuildMember]
    mention_roles: List[Role]
    attachments: List[Attachment]
    embeds: List[Embed]
    pinned: bool
    type: MessageType
    edited_timestamp: Optional[Timestamp] = None

    mention_channels: APINullable[List[ChannelMention]] = MISSING
    guild_id: APINullable[Snowflake] = MISSING
    member: APINullable[GuildMember] = MISSING
    reactions: APINullable[List[Reaction]] = MISSING
    nonce: APINullable[Union[int, str]] = MISSING
    webhook_id: APINullable[Snowflake] = MISSING
    activity: APINullable[MessageActivity] = MISSING
    application: APINullable[Application] = MISSING
    application_id: APINullable[Snowflake] = MISSING
    message_reference: APINullable[MessageReference] = MISSING
    flags: APINullable[MessageFlags] = MISSING
    referenced_message: APINullable[Optional[UserMessage]] = MISSING
    interaction: APINullable[MessageInteraction] = MISSING
    thread: APINullable[Channel] = MISSING
    components: APINullable[List[MessageComponent]] = MISSING
    sticker_items: APINullable[List[StickerItem]] = MISSING

    def __str__(self):
        return self.content


1			# Copyright Pincer 2021-Present
			0 ignored issues – show introduced 2021-09-10 13:25 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, Enum
8			from typing import List, Optional, Union, TYPE_CHECKING
9
10			from ..._config import GatewayConfig
11			from ...utils.api_object import APIObject
			0 ignored issues – show Bug introduced 2021-10-21 08:55 UTC by Report Bug Copy Issue Report The name `api_object` does not seem to exist in module `pincer.utils`. Loading history... introduced 2021-10-22 14:25 UTC by Report Bug Copy Issue Report Cannot import 'utils.api_object' due to syntax error 'invalid syntax (<unknown>, line 77)' Loading history...
12			from ...utils.types import MISSING
13
14			if TYPE_CHECKING:
15			from ..app.application import Application
16			from ..app.interaction_base import MessageInteraction
17			from ..guild.channel import Channel, ChannelMention
			0 ignored issues – show Bug introduced 2021-10-10 02:50 UTC by Report Bug Copy Issue Report The name `channel` does not seem to exist in module `pincer.objects.guild`. Loading history... introduced 2021-10-22 14:25 UTC by Report Bug Copy Issue Report Cannot import 'guild.channel' due to syntax error 'invalid syntax (<unknown>, line 235)' Loading history...
18			from ..guild.member import GuildMember
19			from ..guild.role import Role
20			from ..message.attachment import Attachment
21			from ..message.component import MessageComponent
22			from ..message.embed import Embed
23			from ..message.reaction import Reaction
24			from ..message.reference import MessageReference
25			from ..message.sticker import StickerItem
26			from ..user import User
27			from ...utils.snowflake import Snowflake
28			from ...utils.timestamp import Timestamp
			0 ignored issues – show Bug introduced 2021-10-03 12:24 UTC by Report Bug Copy Issue Report The name `timestamp` does not seem to exist in module `pincer.utils`. Loading history... introduced 2021-10-03 12:24 UTC by Report Bug Copy Issue Report Cannot import 'utils.timestamp' due to syntax error 'invalid syntax (<unknown>, line 70)' Loading history...
29			from ...utils import APINullable
30
31
32			class MessageActivityType(IntEnum):
33			"""
34			The activity people can perform on a rich presence activity.
35
36			Such an activity could for example be a spotify listen.
37			"""
38			JOIN = 1
39			SPECTATE = 2
40			LISTEN = 3
41			JOIN_REQUEST = 5
42
43
44			class MessageFlags(IntEnum):
45			"""
46			Special message properties.
47
48			:param CROSSPOSTED:
49			the message has been published to subscribed
50			channels (via Channel Following)
51
52			:param IS_CROSSPOST:
53			this message originated from a message
54			in another channel (via Channel Following)
55
56			:param SUPPRESS_EMBEDS:
57			do not include any embeds when serializing this message
58
59			:param SOURCE_MESSAGE_DELETED:
60			the source message for this crosspost
61			has been deleted (via Channel Following)
62
63			:param URGENT:
64			this message came from the urgent message system
65
66			:param HAS_THREAD:
67			this message has an associated thread,
68			with the same id as the message
69
70			:param EPHEMERAL:
71			this message is only visible to the user
72			who invoked the Interaction
73
74			:param LOADING:
75			this message is an Interaction
76			Response and the bot is "thinking"
77			"""
78			CROSSPOSTED = 1 << 0
79			IS_CROSSPOST = 1 << 1
80			SUPPRESS_EMBEDS = 1 << 2
81			SOURCE_MESSAGE_DELETED = 1 << 3
82			URGENT = 1 << 4
83			HAS_THREAD = 1 << 5
84			EPHEMERAL = 1 << 6
85			LOADING = 1 << 7
86
87
88			class MessageType(IntEnum):
89			"""
90			Represents the type of the message.
91			"""
92			DEFAULT = 0
93			RECIPIENT_ADD = 1
94			RECIPIENT_REMOVE = 2
95			CALL = 3
96			CHANNEL_NAME_CHANGE = 4
97			CHANNEL_ICON_CHANGE = 5
98			CHANNEL_PINNED_MESSAGE = 6
99			GUILD_MEMBER_JOIN = 7
100			USER_PREMIUM_GUILD_SUBSCRIPTION = 8
101			USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_1 = 9
102			USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_2 = 10
103			USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_3 = 11
104			CHANNEL_FOLLOW_ADD = 12
105			GUILD_DISCOVERY_DISQUALIFIED = 14
106			GUILD_DISCOVERY_REQUALIFIED = 15
107			GUILD_DISCOVERY_GRACE_PERIOD_INITIAL_WARNING = 16
108			GUILD_DISCOVERY_GRACE_PERIOD_FINAL_WARNING = 17
109			THREAD_CREATED = 18
110			REPLY = 19
111			APPLICATION_COMMAND = 20
112
113			if GatewayConfig.version < 8:
114			REPLY = 0
115			APPLICATION_COMMAND = 0
116
117			if GatewayConfig.version >= 9:
118			THREAD_STARTER_MESSAGE = 21
119
120			GUILD_INVITE_REMINDER = 22
121
122
123			@dataclass
124			class MessageActivity(APIObject):
125			"""
126			Represents a Discord Message Activity object
127
128			:param type:
129			type of message activity
130
131			:param party_id:
132			party_id from a Rich Presence event
133			"""
134			type: MessageActivityType
135			party_id: APINullable[str] = MISSING
136
137
138			class AllowedMentionTypes(str, Enum):
139			"""
140			The allowed mentions.
141
142			:param ROLES:
143			Controls role mentions
144
145			:param USERS:
146			Controls user mentions
147
148			:param EVERYONE:
149			Controls @everyone and @here mentions
150			"""
151			ROLES = "roles"
152			USERS = "user"
153			EVERYONE = "everyone"
154
155
156			@dataclass
			0 ignored issues – show best-practice introduced 2021-09-10 13:25 UTC by Report Bug Copy Issue Report Too many instance attributes (30/7) Loading history...
157			class UserMessage(APIObject):
158			"""
159			Represents a message sent in a channel within Discord.
160
161			:param id:
162			id of the message
163
164			:param channel_id:
165			id of the channel the message was sent in
166
167			:param guild_id:
168			id of the guild the message was sent in
169
170			:param author:
171			the author of this message (not guaranteed to be a valid user)
172
173			:param member:
174			member properties for this message's author
175
176			:param content:
177			contents of the message
178
179			:param timestamp:
180			when this message was sent
181
182			:param edited_timestamp:
183			when this message was edited (or null if never)
184
185			:param tts:
186			whether this was a TTS message
187
188			:param mention_everyone:
189			whether this message mentions everyone
190
191			:param mentions:
192			users specifically mentioned in the message
193
194			:param mention_roles:
195			roles specifically mentioned in this message
196
197			:param mention_channels:
198			channels specifically mentioned in this message
199
200			:param attachments:
201			any attached files
202
203			:param embeds:
204			any embedded content
205
206			:param reactions:
207			reactions to the message
208
209			:param nonce:
210			user for validating a message was sent
211
212			:param pinned:
213			whether this message is pinned
214
215			:param webhook_id:
216			if the message is generated by a webhook,
217			this is the webhook's id
218
219			:param type:
220			type of message
221
222			:param activity:
223			sent with Rich Presence-related chat embeds
224
225			:param application:
226			sent with Rich Presence-related chat embeds
227
228			:param application_id:
229			if the message is a response to an Interaction,
230			this is the id of the interaction's application
231
232			:param message_reference:
233			data showing the source of a crosspost,
234			channel follow add, pin, or reply message
235
236			:param flags:
237			message flags combined as a bitfield
238
239			:param referenced_message:
240			the message associated with the message_reference
241
242			:param interaction:
243			sent if the message is a response to an Interaction
244
245			:param thread:
246			the thread that was started from this message,
247			includes thread member object
248
249			:param components:
250			sent if the message contains components like buttons,
251			action rows, or other interactive components
252
253			:param sticker_items:
254			sent if the message contains stickers
255			"""
256			id: Snowflake
257			channel_id: Snowflake
258			author: User
259			content: str
260			timestamp: Timestamp
261			tts: bool
262			mention_everyone: bool
263			mentions: List[GuildMember]
264			mention_roles: List[Role]
265			attachments: List[Attachment]
266			embeds: List[Embed]
267			pinned: bool
268			type: MessageType
269			edited_timestamp: Optional[Timestamp] = None
270
271			mention_channels: APINullable[List[ChannelMention]] = MISSING
272			guild_id: APINullable[Snowflake] = MISSING
273			member: APINullable[GuildMember] = MISSING
274			reactions: APINullable[List[Reaction]] = MISSING
275			nonce: APINullable[Union[int, str]] = MISSING
276			webhook_id: APINullable[Snowflake] = MISSING
277			activity: APINullable[MessageActivity] = MISSING
278			application: APINullable[Application] = MISSING
279			application_id: APINullable[Snowflake] = MISSING
280			message_reference: APINullable[MessageReference] = MISSING
281			flags: APINullable[MessageFlags] = MISSING
282			referenced_message: APINullable[Optional[UserMessage]] = MISSING
283			interaction: APINullable[MessageInteraction] = MISSING
284			thread: APINullable[Channel] = MISSING
285			components: APINullable[List[MessageComponent]] = MISSING
286			sticker_items: APINullable[List[StickerItem]] = MISSING
287
288			def __str__(self):
289			return self.content
290

Pincer-org / Pincer

Pull Request — main (#158)

pincer.objects.message.user_message.UserMessage.__post_init__() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like