pincer.objects.user.user.User.get_dm_channel() - Code Metrics - Inspection of ":sparkles: Closes 186, 201, 203, and 216." - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#235)

by Yohann

created 2021-11-20 18:31 UTC

pincer.objects.user.user.User.get_dm_channel() A

↳ Parent: pincer.objects.user.user

Complexity

Conditions

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	7
dl	0
loc	13
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 __future__ import annotations

import io
from dataclasses import dataclass
from enum import IntEnum
from typing import TYPE_CHECKING

from aiohttp import ClientSession

from ..guild import channel

from ...utils.api_object import APIObject

from ...utils.color import Color
from ...utils.conversion import construct_client_dict
from ...utils.convert_message import MessageConvertable
from ...utils.types import MISSING

PILLOW_IMPORT = True

try:
    from PIL import Image
except (ModuleNotFoundError, ImportError):
    PILLOW_IMPORT = False


if TYPE_CHECKING:
    from typing import Optional

    from ...client import Client

    from ...objects.message.user_message import UserMessage
    from ...utils.types import APINullable
    from ...utils.snowflake import Snowflake


class PremiumTypes(IntEnum):
    """The type of Discord premium a user has.

    Attributes
    ----------
    NONE:
        No nitro.
    NITRO_CLASSIC:
        Nitro classic (no boosts).
    NITRO:
        Full nitro subscription.
    """

    NONE = 0
    NITRO_CLASSIC = 1
    NITRO = 2


class VisibilityType(IntEnum):
    """The type of a connection visibility.

    Attributes
    ----------
    NONE:
        Connection is not visible.
    EVERYONE:
        Connection is visible to everyone.
    """

    NONE = 0
    EVERYONE = 1


@dataclass

class User(APIObject):
    """Represents a Discord user. This can be a bot account or a
    human account.

    Attributes
    ----------
    avatar: Optional[:class:`str`]
        The user's avatar hash
    discriminator: :class:`str`
        The user's 4-digit discord-tag
    id: :class:`~pincer.utils.snowflake.Snowflake`
        The user's id
    username: :class:`str`
        The user's username, not unique across the platform
    flags: APINullable[:class:`int`]
        The flags on a user's account
    accent_color: APINullable[Optional[:class:`int`]]
        The user's banner color encoded as an integer representation of
        hexadecimal color code
    banner: APINullable[Optional[:class:`str`]]
        The user's banner, or null if unset
    banner_color: APINullable[Optional[:class:`~pincer.utils.color.Color`]]
        The color of the user's banner
    bot: APINullable[:class:`bool`]
        Whether the user belongs to an OAuth2 application
    email: APINullable[Optional[:class:`str`]]
        The user's email
    locale: APINullable[:class:`str`]
        The user's chosen language option
    mfa_enabled: APINullable[:class:`bool`]
        Whether the user has two factor enabled on their account
    premium_type: APINullable[:class:`int`]
        The type of Nitro subscription on a user's account
    public_flags: APINullable[:class:`int`]
        The public flags on a user's account
    system: APINullable[:class:`bool`]
        Whether the user is an Official Discord System user
        (part of the urgent message system)
    verified: APINullable[:class:`bool`]
        Whether the email on this account has been verified
    """

    id: Snowflake
    username: APINullable[str] = MISSING
    discriminator: APINullable[str] = MISSING

    avatar: APINullable[str] = MISSING
    flags: APINullable[int] = MISSING
    accent_color: APINullable[Optional[int]] = MISSING
    banner: APINullable[Optional[str]] = MISSING
    banner_color: APINullable[Optional[Color]] = MISSING
    bot: APINullable[bool] = MISSING
    email: APINullable[Optional[str]] = MISSING
    locale: APINullable[str] = MISSING
    mfa_enabled: APINullable[bool] = MISSING
    premium_type: APINullable[int] = MISSING
    public_flags: APINullable[int] = MISSING
    system: APINullable[bool] = MISSING
    verified: APINullable[bool] = MISSING

    @property
    def premium(self) -> APINullable[PremiumTypes]:
        """APINullable[:class:`~pincer.objects.user.user.PremiumTypes`]: The
        user their premium type in a usable enum.
        """
        return (
            MISSING if self.premium_type is MISSING else PremiumTypes(
                self.premium_type)
        )

    @property
    def mention(self) -> str:
        """:class:`str`: The user's mention string."""
        return f"<@!{self.id}>"

    def get_avatar_url(self, size: int = 512, ext: str = "png") -> str:

        return (
            f"https://cdn.discordapp.com/avatars/{self.id}/{self.avatar}.{ext}"
            f"?size={size}"
        )

    if PILLOW_IMPORT:

        async def get_avatar(self, size: int = 512, ext: str = "png") -> Image:

            """Get the user's avatar as a Pillow image.

            Parameters
            ----------
            size : :class: int, optional
                The size of the image to get. Defaults to 512.
            ext : :class: str, optional
                The file extension to use. Defaults to 'png'.

            Returns
            -------
            :class: Image
                The user's avatar as a Pillow image.
            """
            async with ClientSession().get(url=self.get_avatar_url()) as resp:
                avatar = io.BytesIO(await resp.read())
                print(Image, dir(Image))
                return Image.open(avatar).convert("RGBA")

    def __str__(self):
        return self.username + "#" + self.discriminator

    @classmethod
    async def from_id(cls, client: Client, user_id: int) -> User:

        data = await client.http.get(f"users/{user_id}")
        return cls.from_dict(construct_client_dict(client, data))

    async def get_dm_channel(self) -> channel.Channel:
        """
        Returns
        -------
        :class:`~pincer.objects.guild.channel.Channel`
            DM channel for this user.
        """
        return channel.Channel.from_dict(
            construct_client_dict(
                self._client,
                await self._http.post(
                    "/users/@me/channels",
                    data={"recipient_id": self.id}
                )
            )
        )

    async def send(self, message: MessageConvertable) -> UserMessage:
        """
        Sends a message to a user.

        Parameters
        ----------
        message : :class:`~pincer.utils.convert_message.MessageConvertable`
            Message to be sent to the user.
        """
        channel = await self.get_dm_channel()
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param
        return await channel.send(message)


1			# Copyright Pincer 2021-Present
			0 ignored issues – show introduced 2021-10-03 07:58 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			import io
7			from dataclasses import dataclass
8			from enum import IntEnum
9			from typing import TYPE_CHECKING
10
11			from aiohttp import ClientSession
12
13			from ..guild import channel
			0 ignored issues – show Bug introduced 2021-11-20 02:54 UTC by Report Bug Copy Issue Report The name `channel` does not seem to exist in module `pincer.objects.guild`. Loading history...
14			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-26 09:00 UTC by Report Bug Copy Issue Report Cannot import 'utils.api_object' due to syntax error 'invalid syntax (<unknown>, line 80)' Loading history...
15			from ...utils.color import Color
16			from ...utils.conversion import construct_client_dict
17			from ...utils.convert_message import MessageConvertable
18			from ...utils.types import MISSING
19
20			PILLOW_IMPORT = True
21
22			try:
23			from PIL import Image
24			except (ModuleNotFoundError, ImportError):
25			PILLOW_IMPORT = False
26
27
28			if TYPE_CHECKING:
29			from typing import Optional
30
31			from ...client import Client
			0 ignored issues – show introduced 2021-11-14 21:12 UTC by Report Bug Copy Issue Report Cannot import 'client' due to syntax error 'invalid syntax (<unknown>, line 354)' Loading history...
32			from ...objects.message.user_message import UserMessage
33			from ...utils.types import APINullable
34			from ...utils.snowflake import Snowflake
35
36
37			class PremiumTypes(IntEnum):
38			"""The type of Discord premium a user has.
39
40			Attributes
41			----------
42			NONE:
43			No nitro.
44			NITRO_CLASSIC:
45			Nitro classic (no boosts).
46			NITRO:
47			Full nitro subscription.
48			"""
49
50			NONE = 0
51			NITRO_CLASSIC = 1
52			NITRO = 2
53
54
55			class VisibilityType(IntEnum):
56			"""The type of a connection visibility.
57
58			Attributes
59			----------
60			NONE:
61			Connection is not visible.
62			EVERYONE:
63			Connection is visible to everyone.
64			"""
65
66			NONE = 0
67			EVERYONE = 1
68
69
70			@dataclass
			0 ignored issues – show best-practice introduced 2021-10-14 09:19 UTC by Report Bug Copy Issue Report Too many instance attributes (16/7) Loading history...
71			class User(APIObject):
72			"""Represents a Discord user. This can be a bot account or a
73			human account.
74
75			Attributes
76			----------
77			avatar: Optional[:class:`str`]
78			The user's avatar hash
79			discriminator: :class:`str`
80			The user's 4-digit discord-tag
81			id: :class:`~pincer.utils.snowflake.Snowflake`
82			The user's id
83			username: :class:`str`
84			The user's username, not unique across the platform
85			flags: APINullable[:class:`int`]
86			The flags on a user's account
87			accent_color: APINullable[Optional[:class:`int`]]
88			The user's banner color encoded as an integer representation of
89			hexadecimal color code
90			banner: APINullable[Optional[:class:`str`]]
91			The user's banner, or null if unset
92			banner_color: APINullable[Optional[:class:`~pincer.utils.color.Color`]]
93			The color of the user's banner
94			bot: APINullable[:class:`bool`]
95			Whether the user belongs to an OAuth2 application
96			email: APINullable[Optional[:class:`str`]]
97			The user's email
98			locale: APINullable[:class:`str`]
99			The user's chosen language option
100			mfa_enabled: APINullable[:class:`bool`]
101			Whether the user has two factor enabled on their account
102			premium_type: APINullable[:class:`int`]
103			The type of Nitro subscription on a user's account
104			public_flags: APINullable[:class:`int`]
105			The public flags on a user's account
106			system: APINullable[:class:`bool`]
107			Whether the user is an Official Discord System user
108			(part of the urgent message system)
109			verified: APINullable[:class:`bool`]
110			Whether the email on this account has been verified
111			"""
112
113			id: Snowflake
114			username: APINullable[str] = MISSING
115			discriminator: APINullable[str] = MISSING
116
117			avatar: APINullable[str] = MISSING
118			flags: APINullable[int] = MISSING
119			accent_color: APINullable[Optional[int]] = MISSING
120			banner: APINullable[Optional[str]] = MISSING
121			banner_color: APINullable[Optional[Color]] = MISSING
122			bot: APINullable[bool] = MISSING
123			email: APINullable[Optional[str]] = MISSING
124			locale: APINullable[str] = MISSING
125			mfa_enabled: APINullable[bool] = MISSING
126			premium_type: APINullable[int] = MISSING
127			public_flags: APINullable[int] = MISSING
128			system: APINullable[bool] = MISSING
129			verified: APINullable[bool] = MISSING
130
131			@property
132			def premium(self) -> APINullable[PremiumTypes]:
133			"""APINullable[:class:`~pincer.objects.user.user.PremiumTypes`]: The
134			user their premium type in a usable enum.
135			"""
136			return (
137			MISSING if self.premium_type is MISSING else PremiumTypes(
138			self.premium_type)
139			)
140
141			@property
142			def mention(self) -> str:
143			""":class:`str`: The user's mention string."""
144			return f"<@!{self.id}>"
145
146			def get_avatar_url(self, size: int = 512, ext: str = "png") -> str:
			0 ignored issues – show introduced 2021-10-03 07:58 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
147			return (
148			f"https://cdn.discordapp.com/avatars/{self.id}/{self.avatar}.{ext}"
149			f"?size={size}"
150			)
151
152			if PILLOW_IMPORT:
153
154			async def get_avatar(self, size: int = 512, ext: str = "png") -> Image:
			0 ignored issues – show Unused Code introduced 2021-11-14 14:20 UTC by Report Bug Copy Issue Report The argument `size` seems to be unused. Loading history... Unused Code introduced 2021-11-14 14:20 UTC by Report Bug Copy Issue Report The argument `ext` seems to be unused. Loading history...
155			"""Get the user's avatar as a Pillow image.
156
157			Parameters
158			----------
159			size : :class: int, optional
160			The size of the image to get. Defaults to 512.
161			ext : :class: str, optional
162			The file extension to use. Defaults to 'png'.
163
164			Returns
165			-------
166			:class: Image
167			The user's avatar as a Pillow image.
168			"""
169			async with ClientSession().get(url=self.get_avatar_url()) as resp:
170			avatar = io.BytesIO(await resp.read())
171			print(Image, dir(Image))
172			return Image.open(avatar).convert("RGBA")
173
174			def __str__(self):
175			return self.username + "#" + self.discriminator
176
177			@classmethod
178			async def from_id(cls, client: Client, user_id: int) -> User:
			0 ignored issues – show introduced 2021-11-14 14:20 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
179			data = await client.http.get(f"users/{user_id}")
180			return cls.from_dict(construct_client_dict(client, data))
181
182			async def get_dm_channel(self) -> channel.Channel:
183			"""
184			Returns
185			-------
186			:class:`~pincer.objects.guild.channel.Channel`
187			DM channel for this user.
188			"""
189			return channel.Channel.from_dict(
190			construct_client_dict(
191			self._client,
192			await self._http.post(
193			"/users/@me/channels",
194			data={"recipient_id": self.id}
195			)
196			)
197			)
198
199			async def send(self, message: MessageConvertable) -> UserMessage:
200			"""
201			Sends a message to a user.
202
203			Parameters
204			----------
205			message : :class:`~pincer.utils.convert_message.MessageConvertable`
206			Message to be sent to the user.
207			"""
208			channel = await self.get_dm_channel()
			0 ignored issues – show Comprehensibility Bug introduced 2021-11-20 02:54 UTC by Report Bug Copy Issue Report `channel` is re-defining a name which is already available in the outer-scope (previously defined on line `13`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history...
209			return await channel.send(message)
210

Pincer-org / Pincer

Pull Request — main (#235)

pincer.objects.user.user.User.get_dm_channel() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like