pincer.objects.events.guild.GuildMemberRemoveEvent.__post_init__() - Code Metrics - Inspection of "✨ Implement Guild Member Middleware" - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#162)

unknown

created 2021-10-25 11:40 UTC

GuildMemberRemoveEvent.__post_init__() A

↳ Parent: pincer.objects.events.guild

Complexity

Conditions

Size

Total Lines	3
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	3
dl	0
loc	3
rs	10
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 dataclasses import dataclass
from typing import Any, List, Optional

from .presence import PresenceUpdateEvent
from ..guild.member import GuildMember
from ..guild.role import Role
from ..message.emoji import Emoji
from ..message.sticker import Sticker
from ..user import User
from ...utils.api_object import APIObject
from ...utils.conversion import construct_client_dict
from ...utils.snowflake import Snowflake
from ...utils.timestamp import Timestamp

from ...utils.types import MISSING, APINullable


@dataclass
class GuildBanAddEvent(APIObject):
    """
    Sent when a user is banned from a guild.

    :param guild_id:
        id of the guild

    :param user:
        the banned user
    """
    guild_id: Snowflake
    user: User


@dataclass
class GuildBanRemoveEvent(APIObject):
    """
    Sent when a user is unbanned from a guild.

    :param guild_id:
        id of the guild

    :param user:
        the unbanned user
    """
    guild_id: Snowflake
    user: User


@dataclass
class GuildEmojisUpdateEvent(APIObject):
    """
    Sent when a guild's emojis have been updated.

    :param guild_id:
        id of the guild

    :param emojis:
        array of emojis
    """
    guild_id: Snowflake
    emojis: List[Emoji]


@dataclass
class GuildStickersUpdateEvent(APIObject):
    """
    Sent when a guild's stickers have been updated.

    :param guild_id:
        id of the guild

    :param stickers:
        array of stickers
    """
    guild_id: Snowflake
    stickers: List[Sticker]


@dataclass
class GuildIntegrationsUpdateEvent(APIObject):
    """
    Sent when a guild integration is updated.

    :param guild_id:
        id of the guild whose integrations were updated
    """
    guild_id: Snowflake


@dataclass
class GuildMemberAddEvent(GuildMember):
    """
    Sent when a user joins a guild.

    :param guild_id:
        ID of the guild that the user joined.
    """
    # NOTE: This isn't a default value. I set it to this because you can't
    # have fields without default values after regular fields. Apparently that
    # carries over when you inherit from a dataclass.
    guild_id: Snowflake = 0


@dataclass
class GuildMemberRemoveEvent(APIObject):
    """
    Sent when a user is removed from a guild (leave/kick/ban).

    :param guild_id:
        the id of the guild

    :param user:
        the user who was removed
    """
    guild_id: Snowflake
    user: User

    def __post_init__(self):
        self.user = User.from_dict(
            construct_client_dict(self._client, self.user)

        )


@dataclass

class GuildMemberUpdateEvent(APIObject):
    """
    Sent when a guild member is updated.
    This will also fire when the user object
    of a guild member changes.

    :param guild_id:
        the id of the guild

    :param roles:
        user role ids

    :param user:
        the user

    :param nick:
        nickname of the user in the guild

    :param joined_at:
        when the user joined the guild

    :param premium_since:
        when the user started boosting the guild

    :param deaf:
        whether the user is deafened in voice channels

    :param mute:
        whether the user is muted in voice channels

    :param pending:
        whether the user has not yet passed the guild's
        Membership Screening requirements
    """
    guild_id: Snowflake
    roles: List[Snowflake]
    user: User
    nick: APINullable[Optional[str]] = MISSING
    joined_at: Optional[Timestamp] = None
    premium_since: APINullable[Optional[Timestamp]] = MISSING
    deaf: APINullable[bool] = MISSING
    mute: APINullable[bool] = MISSING
    pending: APINullable[bool] = MISSING

    def __post_init__(self):
        self.user = User.from_dict(construct_client_dict(
            self._client, self.user

        ))


@dataclass
class GuildMembersChunkEvent(APIObject):
    """
    Sent in response to Guild Request Members.
    You can use the `chunk_index` and `chunk_count`
    to calculate how many chunks are left for your request.

    :param guild_id:
        the id of the guild

    :param members:
        set of guild members

    :param chunk_index:
        the chunk index in the expected chunks for this response
        (0 <= chunk_index < chunk_count)

    :param chunk_count:
        the total number of expected chunks for this response

    :param not_found:
        if passing an invalid id to `REQUEST_GUILD_MEMBERS`,
        it will be returned here

    :param presences:
        if passing true to `REQUEST_GUILD_MEMBERS`, presences
        of the returned members will be here

    :param nonce:"
        the nonce used in the Guild Members Request
    """
    guild_id: Snowflake
    members: List[GuildMember]
    chunk_index: int
    chunk_count: int

    not_found: APINullable[List[Any]] = MISSING
    presences: APINullable[PresenceUpdateEvent] = MISSING
    nonce: APINullable[str] = MISSING

    def __post_init__(self):
        self.members = [
            GuildMember.from_dict(
                construct_client_dict(
                    self._client, member

                )
            )
            for member in self.members
        ]


@dataclass
class GuildRoleCreateEvent(APIObject):
    """
    Sent when a guild role is created.

    :param guild_id:
        the id of the guild

    :param role:
        the role created
    """
    guild_id: Snowflake
    role: Role


@dataclass
class GuildRoleUpdateEvent(APIObject):
    """
    Sent when a guild role is updated.

    :param guild_id:
        the id of the guild

    :param role:
        the role updated
    """
    guild_id: Snowflake
    role: Role


@dataclass
class GuildRoleDeleteEvent(APIObject):
    """
    Sent when a guild role is deleted.

    :param guild_id:
        id of the guild

    :param role_id:
        id of the role
    """
    guild_id: Snowflake
    role_id: Snowflake


1			# Copyright Pincer 2021-Present
			0 ignored issues – show introduced 2021-09-14 08: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 dataclasses import dataclass
5			from typing import Any, List, Optional
6
7			from .presence import PresenceUpdateEvent
8			from ..guild.member import GuildMember
9			from ..guild.role import Role
10			from ..message.emoji import Emoji
11			from ..message.sticker import Sticker
12			from ..user import User
13			from ...utils.api_object import APIObject
14			from ...utils.conversion import construct_client_dict
15			from ...utils.snowflake import Snowflake
16			from ...utils.timestamp import Timestamp
			0 ignored issues – show Bug introduced 2021-09-06 08:54 UTC by Report Bug Copy Issue Report The name `timestamp` does not seem to exist in module `pincer.utils`. Loading history... introduced 2021-09-25 12:58 UTC by Report Bug Copy Issue Report Cannot import 'utils.timestamp' due to syntax error 'invalid syntax (<unknown>, line 70)' Loading history...
17			from ...utils.types import MISSING, APINullable
18
19
20			@dataclass
21			class GuildBanAddEvent(APIObject):
22			"""
23			Sent when a user is banned from a guild.
24
25			:param guild_id:
26			id of the guild
27
28			:param user:
29			the banned user
30			"""
31			guild_id: Snowflake
32			user: User
33
34
35			@dataclass
36			class GuildBanRemoveEvent(APIObject):
37			"""
38			Sent when a user is unbanned from a guild.
39
40			:param guild_id:
41			id of the guild
42
43			:param user:
44			the unbanned user
45			"""
46			guild_id: Snowflake
47			user: User
48
49
50			@dataclass
51			class GuildEmojisUpdateEvent(APIObject):
52			"""
53			Sent when a guild's emojis have been updated.
54
55			:param guild_id:
56			id of the guild
57
58			:param emojis:
59			array of emojis
60			"""
61			guild_id: Snowflake
62			emojis: List[Emoji]
63
64
65			@dataclass
66			class GuildStickersUpdateEvent(APIObject):
67			"""
68			Sent when a guild's stickers have been updated.
69
70			:param guild_id:
71			id of the guild
72
73			:param stickers:
74			array of stickers
75			"""
76			guild_id: Snowflake
77			stickers: List[Sticker]
78
79
80			@dataclass
81			class GuildIntegrationsUpdateEvent(APIObject):
82			"""
83			Sent when a guild integration is updated.
84
85			:param guild_id:
86			id of the guild whose integrations were updated
87			"""
88			guild_id: Snowflake
89
90
91			@dataclass
92			class GuildMemberAddEvent(GuildMember):
93			"""
94			Sent when a user joins a guild.
95
96			:param guild_id:
97			ID of the guild that the user joined.
98			"""
99			# NOTE: This isn't a default value. I set it to this because you can't
100			# have fields without default values after regular fields. Apparently that
101			# carries over when you inherit from a dataclass.
102			guild_id: Snowflake = 0
103
104
105			@dataclass
106			class GuildMemberRemoveEvent(APIObject):
107			"""
108			Sent when a user is removed from a guild (leave/kick/ban).
109
110			:param guild_id:
111			the id of the guild
112
113			:param user:
114			the user who was removed
115			"""
116			guild_id: Snowflake
117			user: User
118
119			def __post_init__(self):
120			self.user = User.from_dict(
121			construct_client_dict(self._client, self.user)
			0 ignored issues – show Bug introduced 2021-10-24 22:02 UTC by Report Bug Copy Issue Report The Instance of `GuildMemberRemoveEvent` does not seem to have a member named `_client`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
122			)
123
124
125			@dataclass
			0 ignored issues – show best-practice introduced 2021-09-14 08:25 UTC by Report Bug Copy Issue Report Too many instance attributes (9/7) Loading history...
126			class GuildMemberUpdateEvent(APIObject):
127			"""
128			Sent when a guild member is updated.
129			This will also fire when the user object
130			of a guild member changes.
131
132			:param guild_id:
133			the id of the guild
134
135			:param roles:
136			user role ids
137
138			:param user:
139			the user
140
141			:param nick:
142			nickname of the user in the guild
143
144			:param joined_at:
145			when the user joined the guild
146
147			:param premium_since:
148			when the user started boosting the guild
149
150			:param deaf:
151			whether the user is deafened in voice channels
152
153			:param mute:
154			whether the user is muted in voice channels
155
156			:param pending:
157			whether the user has not yet passed the guild's
158			Membership Screening requirements
159			"""
160			guild_id: Snowflake
161			roles: List[Snowflake]
162			user: User
163			nick: APINullable[Optional[str]] = MISSING
164			joined_at: Optional[Timestamp] = None
165			premium_since: APINullable[Optional[Timestamp]] = MISSING
166			deaf: APINullable[bool] = MISSING
167			mute: APINullable[bool] = MISSING
168			pending: APINullable[bool] = MISSING
169
170			def __post_init__(self):
171			self.user = User.from_dict(construct_client_dict(
172			self._client, self.user
			0 ignored issues – show Bug introduced 2021-10-24 22:02 UTC by Report Bug Copy Issue Report The Instance of `GuildMemberUpdateEvent` does not seem to have a member named `_client`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
173			))
174
175
176			@dataclass
177			class GuildMembersChunkEvent(APIObject):
178			"""
179			Sent in response to Guild Request Members.
180			You can use the `chunk_index` and `chunk_count`
181			to calculate how many chunks are left for your request.
182
183			:param guild_id:
184			the id of the guild
185
186			:param members:
187			set of guild members
188
189			:param chunk_index:
190			the chunk index in the expected chunks for this response
191			(0 <= chunk_index < chunk_count)
192
193			:param chunk_count:
194			the total number of expected chunks for this response
195
196			:param not_found:
197			if passing an invalid id to `REQUEST_GUILD_MEMBERS`,
198			it will be returned here
199
200			:param presences:
201			if passing true to `REQUEST_GUILD_MEMBERS`, presences
202			of the returned members will be here
203
204			:param nonce:"
205			the nonce used in the Guild Members Request
206			"""
207			guild_id: Snowflake
208			members: List[GuildMember]
209			chunk_index: int
210			chunk_count: int
211
212			not_found: APINullable[List[Any]] = MISSING
213			presences: APINullable[PresenceUpdateEvent] = MISSING
214			nonce: APINullable[str] = MISSING
215
216			def __post_init__(self):
217			self.members = [
218			GuildMember.from_dict(
219			construct_client_dict(
220			self._client, member
			0 ignored issues – show Bug introduced 2021-10-24 22:02 UTC by Report Bug Copy Issue Report The Instance of `GuildMembersChunkEvent` does not seem to have a member named `_client`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
221			)
222			)
223			for member in self.members
224			]
225
226
227			@dataclass
228			class GuildRoleCreateEvent(APIObject):
229			"""
230			Sent when a guild role is created.
231
232			:param guild_id:
233			the id of the guild
234
235			:param role:
236			the role created
237			"""
238			guild_id: Snowflake
239			role: Role
240
241
242			@dataclass
243			class GuildRoleUpdateEvent(APIObject):
244			"""
245			Sent when a guild role is updated.
246
247			:param guild_id:
248			the id of the guild
249
250			:param role:
251			the role updated
252			"""
253			guild_id: Snowflake
254			role: Role
255
256
257			@dataclass
258			class GuildRoleDeleteEvent(APIObject):
259			"""
260			Sent when a guild role is deleted.
261
262			:param guild_id:
263			id of the guild
264
265			:param role_id:
266			id of the role
267			"""
268			guild_id: Snowflake
269			role_id: Snowflake
270

Pincer-org / Pincer

Pull Request — main (#162)

GuildMemberRemoveEvent.__post_init__() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like