pincer.objects.message.message.AllowedMentions.to_dict() - Code Metrics - Inspection of "Upgrade docs" - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#155)

by Oliver

created 2021-10-23 19:37 UTC

AllowedMentions.to_dict() A

↳ Parent: pincer.objects.message.message

Complexity

Conditions

Size

Total Lines	12
Code Lines	10

Duplication

Lines	12
Ratio	100 %

Importance

Changes

Metric	Value
eloc	10
dl	12
loc	12
rs	9.9
c	0
b	0
f	0
cc	2
nop	1

# Copyright Pincer 2021-Present

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

from __future__ import annotations

from json import dumps
from typing import TYPE_CHECKING
from dataclasses import dataclass

from ...utils.api_object import APIObject

if TYPE_CHECKING:
    from typing import Dict, Union, List, Optional, Tuple


    from aiohttp import FormData, Payload

    from .file import File
    from .embed import Embed
    from ..user.user import User
    from ..guild.role import Role
    from .component import MessageComponent
    from ...utils.snowflake import Snowflake
    from .user_message import AllowedMentionTypes
    from ...exceptions import CommandReturnIsEmpty
    from ..app.interactions import InteractionFlags
    from ..app.interaction_base import CallbackType

PILLOW_IMPORT = True

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


@dataclass

class AllowedMentions(APIObject):
    """Represents the entities the client can mention

    Attributes
    ----------
    parse: List[:class:`~pincer.objects.message.user_message.AllowedMentionTypes`]
        An array of allowed mention types to parse from the content.
    roles: List[Union[:class:`~pincer.objects.guild.role.Role`, :class:`~pincer.utils.snowflake.Snowflake`]]

        List of ``Role`` objects or snowflakes of allowed mentions.
    users: List[Union[:class:`~pincer.objects.user.user.User` :class:`~pincer.utils.snowflake.Snowflake`]]

        List of ``user`` objects or snowflakes of allowed mentions.
    reply: :class:`bool`
        If replies should mention the author.
        |default| :data:`True`
    """  # noqa: E501

    parse: List[AllowedMentionTypes]

    roles: List[Union[Role, Snowflake]]

    users: List[Union[User, Snowflake]]

    reply: bool = True

    def to_dict(self):
        def get_str_id(obj: Union[Snowflake, User, Role]) -> str:
            if hasattr(obj, "id"):
                obj = obj.id

            return str(obj)

        return {
            "parse": self.parse,
            "roles": list(map(get_str_id, self.roles)),
            "users": list(map(get_str_id, self.users)),
            "replied_user": self.reply
        }


@dataclass

class Message:
    """A discord message that will be send to discord

    Attributes
    ----------
    content: :class:`str`
        The text in the message.
        |default| ``""``
    attachments: Optional[List[:class:`~pincer.objects.message.file.File`]]
        Attachments on the message. This is a File object. You can also attach
        a Pillow Image or string. Pillow images will be converted to PNGs. They
        will use the naming sceme ``image%`` where % is the images index in the
        attachments array. Strings will be read as a filepath. The name of the
        file that the string points to will be used as the name.
    tts: Optional[:class:`bool`]
        Whether the message should be spoken to the user.
        |default| :data:`False`
    embeds: Optional[List[:class:`~pincer.objects.message.embed.Embed`]]
        Embed attached to the message. This is an Embed object.
    allowed_mentions: Optional[:class:`~pincer.objects.message.message.AllowedMentions`]
        The allowed mentions for the message.
    components: Optional[List[:class:`~pincer.objects.message.component.MessageComponent`]]
        The components of the message.
    flags: Optional[:class:`~pincer.objects.app.interactions.InteractionFlags`]
        The interaction flags for the message.
    type: Optional[:class:`~pincer.objects.app.interaction_base.CallbackType`]
        The type of the callback.
    """  # noqa: E501

    content: str = ''
    attachments: Optional[List[File]] = None

    tts: Optional[bool] = False
    embeds: Optional[List[Embed]] = None

    allowed_mentions: Optional[AllowedMentions] = None
    components: Optional[List[MessageComponent]] = None

    flags: Optional[InteractionFlags] = None

    type: Optional[CallbackType] = None


    def __post_init__(self):

        if not self.attachments:
            return

        attch = []

        for count, value in enumerate(self.attachments):
            if isinstance(value, File):

                attch.append(value)
            elif PILLOW_IMPORT and isinstance(value, Image):
                attch.append(File.from_pillow_image(
                    value,
                    f"image{count}.png",
                ))
            elif isinstance(value, str):
                attch.append(File.from_file(value))
            else:
                raise ValueError(f"Attachment {count} is invalid type.")

        self.attachments = attch

    @property
    def isempty(self) -> bool:
        """:class:`bool`: If the message is empty.
        """

        return (
            len(self.content) < 1
            and not self.embeds
            and not self.attachments
        )

    def to_dict(self):


        allowed_mentions = (
            self.allowed_mentions.to_dict()
            if self.allowed_mentions else {}
        )

        # Attachments aren't serialized
        # because they are not sent as part of the json
        resp = {
            "content": self.content,
            "tts": self.tts,
            "flags": self.flags,
            "embeds": [embed.to_dict() for embed in (self.embeds or [])],
            "allowed_mentions": allowed_mentions,
            "components": [
                components.to_dict() for components in (self.components or [])
            ]
        }

        return {
            "type": self.type or CallbackType.MESSAGE,

            "data": {k: i for k, i in resp.items() if i}
        }

    def serialize(self) -> Tuple[str, Union[Payload, Dict]]:

        if self.isempty:
            raise CommandReturnIsEmpty("Cannot return empty message.")


        if not self.attachments:
            return "application/json", self.to_dict()

        form = FormData()

        form.add_field("payload_json", dumps(self.to_dict()))

        for file in self.attachments:
            form.add_field("file", file.content, filename=file.filename)

        payload = form()
        return payload.headers["Content-Type"], payload


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		from json import dumps
7		from typing import TYPE_CHECKING
8		from dataclasses import dataclass
9
10		from ...utils.api_object import APIObject
11
12		if TYPE_CHECKING:
13		from typing import Dict, Union, List, Optional, Tuple
		0 ignored issues – show introduced 2021-10-13 21:04 UTC by Report Bug Copy Issue Report Imports from package typing are not grouped Loading history...
14
15		from aiohttp import FormData, Payload
16
17		from .file import File
18		from .embed import Embed
19		from ..user.user import User
20		from ..guild.role import Role
21		from .component import MessageComponent
22		from ...utils.snowflake import Snowflake
23		from .user_message import AllowedMentionTypes
24		from ...exceptions import CommandReturnIsEmpty
25		from ..app.interactions import InteractionFlags
26		from ..app.interaction_base import CallbackType
27
28		PILLOW_IMPORT = True
29
30		try:
31		from PIL.Image import Image
32		except (ModuleNotFoundError, ImportError):
33		PILLOW_IMPORT = False
34
35
36	View Code Duplication	@dataclass
		0 ignored issues – show Duplication introduced 2021-10-23 19:39 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
37		class AllowedMentions(APIObject):
38		"""Represents the entities the client can mention
39
40		Attributes
41		----------
42		parse: List[:class:`~pincer.objects.message.user_message.AllowedMentionTypes`]
43		An array of allowed mention types to parse from the content.
44		roles: List[Union[:class:`~pincer.objects.guild.role.Role`, :class:`~pincer.utils.snowflake.Snowflake`]]
		0 ignored issues – show Coding Style introduced 2021-10-18 13:34 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (108/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
45		List of ``Role`` objects or snowflakes of allowed mentions.
46		users: List[Union[:class:`~pincer.objects.user.user.User` :class:`~pincer.utils.snowflake.Snowflake`]]
		0 ignored issues – show Coding Style introduced 2021-10-18 13:34 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (106/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
47		List of ``user`` objects or snowflakes of allowed mentions.
48		reply: :class:`bool`
49		If replies should mention the author.
50		\|default\| :data:`True`
51		""" # noqa: E501
52
53		parse: List[AllowedMentionTypes]
		0 ignored issues – show introduced 2021-10-20 10:26 UTC by Report Bug Copy Issue Report The variable `AllowedMentionTypes` does not seem to be defined in case `TYPE_CHECKING` on line `12` is `False`. Are you sure this can never be the case? Loading history...
54		roles: List[Union[Role, Snowflake]]
		0 ignored issues – show introduced 2021-10-20 10:26 UTC by Report Bug Copy Issue Report The variable `Role` does not seem to be defined in case `TYPE_CHECKING` on line `12` is `False`. Are you sure this can never be the case? Loading history... introduced 2021-10-20 10:26 UTC by Report Bug Copy Issue Report The variable `Snowflake` does not seem to be defined in case `TYPE_CHECKING` on line `12` is `False`. Are you sure this can never be the case? Loading history...
55		users: List[Union[User, Snowflake]]
		0 ignored issues – show introduced 2021-10-20 10:26 UTC by Report Bug Copy Issue Report The variable `User` does not seem to be defined in case `TYPE_CHECKING` on line `12` is `False`. Are you sure this can never be the case? Loading history...
56		reply: bool = True
57
58		def to_dict(self):
59		def get_str_id(obj: Union[Snowflake, User, Role]) -> str:
60		if hasattr(obj, "id"):
61		obj = obj.id
62
63		return str(obj)
64
65		return {
66		"parse": self.parse,
67		"roles": list(map(get_str_id, self.roles)),
68		"users": list(map(get_str_id, self.users)),
69		"replied_user": self.reply
70		}
71
72
73		@dataclass
		0 ignored issues – show best-practice introduced 2021-10-04 01:39 UTC by Report Bug Copy Issue Report Too many instance attributes (8/7) Loading history...
74		class Message:
75		"""A discord message that will be send to discord
76
77		Attributes
78		----------
79		content: :class:`str`
80		The text in the message.
81		\|default\| ``""``
82		attachments: Optional[List[:class:`~pincer.objects.message.file.File`]]
83		Attachments on the message. This is a File object. You can also attach
84		a Pillow Image or string. Pillow images will be converted to PNGs. They
85		will use the naming sceme ``image%`` where % is the images index in the
86		attachments array. Strings will be read as a filepath. The name of the
87		file that the string points to will be used as the name.
88		tts: Optional[:class:`bool`]
89		Whether the message should be spoken to the user.
90		\|default\| :data:`False`
91		embeds: Optional[List[:class:`~pincer.objects.message.embed.Embed`]]
92		Embed attached to the message. This is an Embed object.
93		allowed_mentions: Optional[:class:`~pincer.objects.message.message.AllowedMentions`]
94		The allowed mentions for the message.
95		components: Optional[List[:class:`~pincer.objects.message.component.MessageComponent`]]
96		The components of the message.
97		flags: Optional[:class:`~pincer.objects.app.interactions.InteractionFlags`]
98		The interaction flags for the message.
99		type: Optional[:class:`~pincer.objects.app.interaction_base.CallbackType`]
100		The type of the callback.
101		""" # noqa: E501
102
103		content: str = ''
104		attachments: Optional[List[File]] = None
		0 ignored issues – show introduced 2021-10-20 10:26 UTC by Report Bug Copy Issue Report The variable `File` does not seem to be defined in case `TYPE_CHECKING` on line `12` is `False`. Are you sure this can never be the case? Loading history...
105		tts: Optional[bool] = False
106		embeds: Optional[List[Embed]] = None
		0 ignored issues – show introduced 2021-10-20 10:26 UTC by Report Bug Copy Issue Report The variable `Embed` does not seem to be defined in case `TYPE_CHECKING` on line `12` is `False`. Are you sure this can never be the case? Loading history...
107		allowed_mentions: Optional[AllowedMentions] = None
108		components: Optional[List[MessageComponent]] = None
		0 ignored issues – show introduced 2021-10-03 07:58 UTC by Report Bug Copy Issue Report The variable `MessageComponent` does not seem to be defined in case `TYPE_CHECKING` on line `12` is `False`. Are you sure this can never be the case? Loading history...
109		flags: Optional[InteractionFlags] = None
		0 ignored issues – show introduced 2021-10-03 07:58 UTC by Report Bug Copy Issue Report The variable `InteractionFlags` does not seem to be defined in case `TYPE_CHECKING` on line `12` is `False`. Are you sure this can never be the case? Loading history...
110		type: Optional[CallbackType] = None
		0 ignored issues – show introduced 2021-10-20 10:26 UTC by Report Bug Copy Issue Report The variable `CallbackType` does not seem to be defined in case `TYPE_CHECKING` on line `12` is `False`. Are you sure this can never be the case? Loading history...
111
112		def __post_init__(self):
113
114		if not self.attachments:
115		return
116
117		attch = []
118
119		for count, value in enumerate(self.attachments):
120		if isinstance(value, File):
		0 ignored issues – show introduced 2021-10-20 10:26 UTC by Report Bug Copy Issue Report The variable `File` does not seem to be defined in case `TYPE_CHECKING` on line `12` is `False`. Are you sure this can never be the case? Loading history...
121		attch.append(value)
122		elif PILLOW_IMPORT and isinstance(value, Image):
123		attch.append(File.from_pillow_image(
124		value,
125		f"image{count}.png",
126		))
127		elif isinstance(value, str):
128		attch.append(File.from_file(value))
129		else:
130		raise ValueError(f"Attachment {count} is invalid type.")
131
132		self.attachments = attch
133
134		@property
135		def isempty(self) -> bool:
136		""":class:`bool`: If the message is empty.
137		"""
138
139		return (
140		len(self.content) < 1
141		and not self.embeds
142		and not self.attachments
143		)
144
145		def to_dict(self):
		0 ignored issues – show introduced 2021-10-03 07:58 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
146
147		allowed_mentions = (
148		self.allowed_mentions.to_dict()
149		if self.allowed_mentions else {}
150		)
151
152		# Attachments aren't serialized
153		# because they are not sent as part of the json
154		resp = {
155		"content": self.content,
156		"tts": self.tts,
157		"flags": self.flags,
158		"embeds": [embed.to_dict() for embed in (self.embeds or [])],
159		"allowed_mentions": allowed_mentions,
160		"components": [
161		components.to_dict() for components in (self.components or [])
162		]
163		}
164
165		return {
166		"type": self.type or CallbackType.MESSAGE,
		0 ignored issues – show introduced 2021-10-20 10:26 UTC by Report Bug Copy Issue Report The variable `CallbackType` does not seem to be defined in case `TYPE_CHECKING` on line `12` is `False`. Are you sure this can never be the case? Loading history...
167		"data": {k: i for k, i in resp.items() if i}
168		}
169
170		def serialize(self) -> Tuple[str, Union[Payload, Dict]]:
		0 ignored issues – show introduced 2021-10-18 13:34 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
171		if self.isempty:
172		raise CommandReturnIsEmpty("Cannot return empty message.")
		0 ignored issues – show Bug introduced 2021-10-13 21:04 UTC by Report Bug Copy Issue Report The variable `CommandReturnIsEmpty` was used before it was assigned. Loading history... introduced 2021-10-20 10:26 UTC by Report Bug Copy Issue Report The variable `CommandReturnIsEmpty` does not seem to be defined in case `TYPE_CHECKING` on line `12` is `False`. Are you sure this can never be the case? Loading history...
173
174		if not self.attachments:
175		return "application/json", self.to_dict()
176
177		form = FormData()
		0 ignored issues – show Bug introduced 2021-10-18 18:08 UTC by Report Bug Copy Issue Report The variable `FormData` was used before it was assigned. Loading history... introduced 2021-10-20 10:26 UTC by Report Bug Copy Issue Report The variable `FormData` does not seem to be defined in case `TYPE_CHECKING` on line `12` is `False`. Are you sure this can never be the case? Loading history...
178		form.add_field("payload_json", dumps(self.to_dict()))
179
180		for file in self.attachments:
181		form.add_field("file", file.content, filename=file.filename)
182
183		payload = form()
184		return payload.headers["Content-Type"], payload
185

Pincer-org / Pincer

Pull Request — main (#155)

AllowedMentions.to_dict() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like