pincer.objects.message.message

Complexity

Total Complexity

19

Size/Duplication

Total Lines	183
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
C	Message.__post_init__()	0	26	9
A	Message.isempty()	0	8	1
A	Message.to_dict()	0	25	3
A	Message.serialize()	0	42	5
A	Message.__str__()	0	2	1

# Copyright Pincer 2021-Present

Missing module docstring

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

from __future__ import annotations

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

from aiohttp import FormData

from ..message.file import File
from ...exceptions import CommandReturnIsEmpty

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

    from aiohttp import Payload

    from .embed import Embed
    from .component import MessageComponent
    from ..app.interactions import InteractionFlags
    from ..message.user_message import AllowedMentions
    from ...objects.app import CallbackType

PILLOW_IMPORT = True

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


@dataclass(repr=False)
class Message:

Too many instance attributes (8/7)

    """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 scheme ``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

The variable Embed does not seem to be defined in case TYPE_CHECKING on line 15 is False. Are you sure this can never be the case?

    allowed_mentions: Optional[AllowedMentions] = None

The variable AllowedMentions does not seem to be defined in case TYPE_CHECKING on line 15 is False. Are you sure this can never be the case?

    components: Optional[List[MessageComponent]] = None

The variable MessageComponent does not seem to be defined in case TYPE_CHECKING on line 15 is False. Are you sure this can never be the case?

    flags: Optional[InteractionFlags] = None

The variable InteractionFlags does not seem to be defined in case TYPE_CHECKING on line 15 is False. Are you sure this can never be the case?

    delete_after: Optional[float] = None

    def __post_init__(self):
        if self.delete_after and self.delete_after < 0:
            raise ValueError(
                "Message can not be deleted after a negative amount of "
                "seconds!"
            )

        if not self.attachments:
            return

        attachment = []

        for count, value in enumerate(self.attachments):
            if isinstance(value, File):
                attachment.append(value)
            elif PILLOW_IMPORT and isinstance(value, Image):
                attachment.append(File.from_pillow_image(
                    value,
                    f"image{count}.png",
                ))
            elif isinstance(value, str):
                attachment.append(File.from_file(value))
            else:
                raise ValueError(f"Attachment {count} is invalid type.")

        self.attachments = attachment

    @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):

Missing function or method docstring

        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 [])
            ]
        }

        # IDE does not recognise return type of filter properly.
        # noinspection PyTypeChecker
        return dict(filter(
            lambda kv: kv[1],
            resp.items()
        ))

    def serialize(
        self, message_type: Optional[CallbackType] = None

Wrong hanging indentation before block (add 4 spaces).

    ) -> Tuple[str, Union[Payload, Dict]]:
        """
        Parameters
        ----------
        message_type : Optional[:class:`pincer.objects.app.CallbackType`]
            Callback type of message.

        Returns
        -------
        Tuple[str, Union[Payload, Dict]]
            (content_type, data)

        Raises
        ------
        :class:`pincer.exceptions.CommandReturnIsEmpty`
            Command does not have content, an embed, or attachment.
        """
        if self.isempty:
            raise CommandReturnIsEmpty("Cannot return empty message.")

        json_payload = self.to_dict()

        if message_type is not None:
            json_data = json_payload
            json_payload = {
                "data": json_data,
                "type": message_type
            }

        if not self.attachments:
            return "application/json", json_payload

        form = FormData()
        form.add_field("payload_json", dumps(json_payload))

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

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

    def __str__(self):
        return self.content