pincer.objects.message.file.File.uri() - Code Metrics - Inspection of ":sparkles: Changes File class to allow for certain..." - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#282)

unknown

created 2021-12-01 03:16 UTC

pincer.objects.message.file.File.uri() A

↳ Parent: pincer.objects.message.file

Complexity

Conditions

Size

Total Lines	18
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	7
dl	0
loc	18
rs	10
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 base64 import b64encode
import os
from dataclasses import dataclass
from io import BytesIO
from json import dumps
from typing import TYPE_CHECKING

from aiohttp import FormData, Payload

from ...exceptions import ImageEncodingError

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

    IMAGE_TYPE = Any

PILLOW_IMPORT = True


try:
    from PIL.Image import Image

    if TYPE_CHECKING:
        IMAGE_TYPE = Image
except (ModuleNotFoundError, ImportError):
    PILLOW_IMPORT = False


def create_form(
    json_payload: Dict[Any], files: List[File]

) -> Tuple[str, Payload]:
    """
    Creates a aiohttp payload from an array of File objects.

    json_payload : Dict[Any]
        The json part of the request
    files : List[`~pincer.objects.message.file.File`]
        A list of files to be used in the request.

    Returns
    -------
    Tuple[str, :class:`aiohttp.Payload`]
        The content type and the payload to be send in an HTTP request.
    """
    form = FormData()
    form.add_field("payload_json", dumps(json_payload))

    for file in files:
        if not file.filename:
            raise ImageEncodingError(
                "A filename is required for uploading attachments"
            )

        form.add_field("file", file.content, filename=file.filename)

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


def _get_file_extension(filename: str) -> Optional[str]:
    """
    Returns the file extension from a str if it exists, otherwise
    return :data:`None`.

    filename : str
        The filename

    Returns
    -------
    Optional[str]
        The file extension or :data:`None`
    """
    path = os.path.splitext(filename)
    if len(path) >= 2:
        return path[1][1:]
    return None


@dataclass
class File:
    """A file that is prepared by the user to be send to the discord
    API.

    Attributes
    ----------
    content: :class:`bytes`
        File bytes.
    filename: :class:`str`
        The name of the file when its uploaded to discord.
    """

    content: bytes
    image_format: str
    filename: Optional[str] = None

    @classmethod
    def from_file(cls, filepath: str, filename: str = None) -> File:
        """Make a ``File`` object from a file stored locally.

        Parameters
        ----------
        filepath: :class:`str`
            The path to the file you want to send. Must be string. The file's
            name in the file path is used as the name when uploaded to discord
            by default.

        filename: :class:`str`
            The name of the file. Will override the default name.
            |default| ``os.path.basename(filepath)``

        Returns
        -------
        :class:`~pincer.objects.message.file.File`
            The new file object.
        """
        with open(filepath, "rb") as data:
            file = data.read()

        return cls(
            content=file,
            image_format=_get_file_extension(filename),
            filename=filename or os.path.basename(filepath)
        )

    @classmethod
    def from_pillow_image(
            cls,

            img: IMAGE_TYPE,
            filename: Optional[str] = None,
            image_format: Optional[str] = None,
            **kwargs
    ) -> File:
        """Creates a file object from a PIL image
        Supports GIF, PNG, JPEG, and WEBP.

        Parameters
        ----------
        img: :class:`~pil:PIL.Image.Image`
            Pillow image object.
        filename:
            The filename to be used when uploaded to discord. The extension is
            used as image_format unless otherwise specified.
        image_format:
            The image_format to be used if you want to override the file
            extension.

        Returns
        -------
        :class:`~pincer.objects.message.file.File`
            The new file object.

        Raises
        ------
        ModuleNotFoundError:
            ``Pillow`` is not installed
        """
        if not PILLOW_IMPORT:
            raise ModuleNotFoundError(

                "The `Pillow` library is required for sending and converting "
                "pillow images,"
            )

        if image_format is None:
            image_format = _get_file_extension(filename)

        if image_format == "jpg":
            image_format = "jpeg"

        # https://stackoverflow.com/questions/33101935/convert-pil-image-to-byte-array
        # Credit goes to second answer
        img_byte_arr = BytesIO()
        img.save(img_byte_arr, format=image_format)
        img_bytes = img_byte_arr.getvalue()

        return cls(
            content=img_bytes,
            image_format=image_format,
            filename=filename
        )

    @property
    def uri(self) -> str:
        """
        Returns
        -------
        str
            The uri for the image.
            See `<https://discord.com/developers/docs/reference#api-versioning>`_.
        """  # noqa: E501
        if self.image_format not in {"jpeg", "png", "gif"}:
            raise ImageEncodingError(
                "Only image types \"jpeg\", \"png\", and \"gif\" can be sent in"
                " an Image URI"
            )

        encoded_bytes = b64encode(self.content).decode('ascii')

        return f"data:image/{self.image_format};base64,{encoded_bytes}"


1			# Copyright Pincer 2021-Present
			0 ignored issues – show introduced 2021-09-06 08:54 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 base64 import b64encode
7			import os
8			from dataclasses import dataclass
9			from io import BytesIO
10			from json import dumps
11			from typing import TYPE_CHECKING
12
13			from aiohttp import FormData, Payload
14
15			from ...exceptions import ImageEncodingError
16
17			if TYPE_CHECKING:
18			from typing import Any, Dict, List, Optional, Tuple, Union
19
20			IMAGE_TYPE = Any
21
22			PILLOW_IMPORT = True
23
24
25			try:
26			from PIL.Image import Image
27
28			if TYPE_CHECKING:
29			IMAGE_TYPE = Image
30			except (ModuleNotFoundError, ImportError):
31			PILLOW_IMPORT = False
32
33
34			def create_form(
35			json_payload: Dict[Any], files: List[File]
			0 ignored issues – show Coding Style introduced 2021-11-30 22:07 UTC by Report Bug Copy Issue Report Wrong hanging indentation before block (add 4 spaces). Loading history...
36			) -> Tuple[str, Payload]:
37			"""
38			Creates a aiohttp payload from an array of File objects.
39
40			json_payload : Dict[Any]
41			The json part of the request
42			files : List[`~pincer.objects.message.file.File`]
43			A list of files to be used in the request.
44
45			Returns
46			-------
47			Tuple[str, :class:`aiohttp.Payload`]
48			The content type and the payload to be send in an HTTP request.
49			"""
50			form = FormData()
51			form.add_field("payload_json", dumps(json_payload))
52
53			for file in files:
54			if not file.filename:
55			raise ImageEncodingError(
56			"A filename is required for uploading attachments"
57			)
58
59			form.add_field("file", file.content, filename=file.filename)
60
61			payload = form()
62			return payload.headers["Content-Type"], payload
63
64
65			def _get_file_extension(filename: str) -> Optional[str]:
66			"""
67			Returns the file extension from a str if it exists, otherwise
68			return :data:`None`.
69
70			filename : str
71			The filename
72
73			Returns
74			-------
75			Optional[str]
76			The file extension or :data:`None`
77			"""
78			path = os.path.splitext(filename)
79			if len(path) >= 2:
80			return path[1][1:]
81			return None
82
83
84			@dataclass
85			class File:
86			"""A file that is prepared by the user to be send to the discord
87			API.
88
89			Attributes
90			----------
91			content: :class:`bytes`
92			File bytes.
93			filename: :class:`str`
94			The name of the file when its uploaded to discord.
95			"""
96
97			content: bytes
98			image_format: str
99			filename: Optional[str] = None
100
101			@classmethod
102			def from_file(cls, filepath: str, filename: str = None) -> File:
103			"""Make a ``File`` object from a file stored locally.
104
105			Parameters
106			----------
107			filepath: :class:`str`
108			The path to the file you want to send. Must be string. The file's
109			name in the file path is used as the name when uploaded to discord
110			by default.
111
112			filename: :class:`str`
113			The name of the file. Will override the default name.
114			\|default\| ``os.path.basename(filepath)``
115
116			Returns
117			-------
118			:class:`~pincer.objects.message.file.File`
119			The new file object.
120			"""
121			with open(filepath, "rb") as data:
122			file = data.read()
123
124			return cls(
125			content=file,
126			image_format=_get_file_extension(filename),
127			filename=filename or os.path.basename(filepath)
128			)
129
130			@classmethod
131			def from_pillow_image(
132			cls,
			0 ignored issues – show Unused Code introduced 2021-10-05 21:24 UTC by Report Bug Copy Issue Report The argument `kwargs` seems to be unused. Loading history...
133			img: IMAGE_TYPE,
134			filename: Optional[str] = None,
135			image_format: Optional[str] = None,
136			**kwargs
137			) -> File:
138			"""Creates a file object from a PIL image
139			Supports GIF, PNG, JPEG, and WEBP.
140
141			Parameters
142			----------
143			img: :class:`~pil:PIL.Image.Image`
144			Pillow image object.
145			filename:
146			The filename to be used when uploaded to discord. The extension is
147			used as image_format unless otherwise specified.
148			image_format:
149			The image_format to be used if you want to override the file
150			extension.
151
152			Returns
153			-------
154			:class:`~pincer.objects.message.file.File`
155			The new file object.
156
157			Raises
158			------
159			ModuleNotFoundError:
160			``Pillow`` is not installed
161			"""
162			if not PILLOW_IMPORT:
163			raise ModuleNotFoundError(
			0 ignored issues – show Comprehensibility Best Practice introduced 2021-10-07 14:58 UTC by Report Bug Copy Issue Report The variable `ModuleNotFoundError` does not seem to be defined. Loading history...
164			"The `Pillow` library is required for sending and converting "
165			"pillow images,"
166			)
167
168			if image_format is None:
169			image_format = _get_file_extension(filename)
170
171			if image_format == "jpg":
172			image_format = "jpeg"
173
174			# https://stackoverflow.com/questions/33101935/convert-pil-image-to-byte-array
175			# Credit goes to second answer
176			img_byte_arr = BytesIO()
177			img.save(img_byte_arr, format=image_format)
178			img_bytes = img_byte_arr.getvalue()
179
180			return cls(
181			content=img_bytes,
182			image_format=image_format,
183			filename=filename
184			)
185
186			@property
187			def uri(self) -> str:
188			"""
189			Returns
190			-------
191			str
192			The uri for the image.
193			See `<https://discord.com/developers/docs/reference#api-versioning>`_.
194			""" # noqa: E501
195			if self.image_format not in {"jpeg", "png", "gif"}:
196			raise ImageEncodingError(
197			"Only image types \"jpeg\", \"png\", and \"gif\" can be sent in"
198			" an Image URI"
199			)
200
201			encoded_bytes = b64encode(self.content).decode('ascii')
202
203			return f"data:image/{self.image_format};base64,{encoded_bytes}"
204

Pincer-org / Pincer

Pull Request — main (#282)

pincer.objects.message.file.File.uri() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like