pincer.objects.message.sticker.Sticker.modify() - Code Metrics - Inspection of ":sparkles: Added sticker support" - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#292)

unknown

created 2021-12-06 06:14 UTC

pincer.objects.message.sticker.Sticker.modify() A

↳ Parent: pincer.objects.message.sticker

Complexity

Conditions

Size

Total Lines	36
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	12
dl	0
loc	36
rs	9.8
c	0
b	0
f	0
cc	1
nop	5

# Copyright Pincer 2021-Present

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

from __future__ import annotations

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

from ...utils.api_object import APIObject
from ...utils.conversion import remove_none
from ...utils.types import MISSING

if TYPE_CHECKING:
    from typing import List, Optional

    from ..user import User
    from ...utils import APINullable, Snowflake


class StickerType(IntEnum):
    """Displays from where the sticker comes from.

    Attributes
    ----------
    STANDARD:
        Sticker is included in the default Discord sticker pack.
    GUILD:
        Sticker is a custom sticker from a discord server.
    """

    STANDARD = 1
    GUILD = 2


class StickerFormatType(IntEnum):
    """The type of the sticker.

    Attributes
    ----------
    PNG:
        Sticker is of PNG format.
    APNG:
        Sticker is animated with APNG format.
    LOTTIE:
        Sticker is animated with with LOTTIE format. (vector based)
    """

    PNG = 1
    APNG = 2
    LOTTIE = 3


@dataclass(repr=False)
class Sticker(APIObject):

    """Represents a Discord sticker.

    Attributes
    ----------
    description: Optional[:class:`str`]
        description of the sticker
    format_type: :class:`~pincer.objects.message.sticker.StickerFormatType`
        type of sticker format
    id: :class:`~pincer.utils.snowflake.Snowflake`
        id of the sticker
    name: :class:`str`
        name of the sticker
    tags: :class:`str`
        for guild stickers, the Discord name of a unicode emoji
        representing the sticker's expression. For standard stickers,
        a comma-separated list of related expressions.
    type: :class:`~pincer.objects.message.sticker.StickerType`
        type of sticker
    available: APINullable[:class:`bool`]
        whether this guild sticker can be used,
        may be false due to loss of Server Boosts
    guild_id: APINullable[:class:`~pincer.utils.snowflake.Snowflake`]
        id of the guild that owns this sticker
    pack_id: APINullable[:class:`~pincer.utils.snowflake.Snowflake`]
        for standard stickers, id of the pack the sticker is from
    sort_value: APINullable[:class:`int`]
        the standard sticker's sort order within its pack
    user: APINullable[:class:`~pincer.objects.user.user.User`]
        the user that uploaded the guild sticker
    """

    description: Optional[str]
    format_type: StickerFormatType
    id: Snowflake
    name: str
    tags: str
    type: StickerType

    available: APINullable[bool] = MISSING
    guild_id: APINullable[Snowflake] = MISSING
    pack_id: APINullable[Snowflake] = MISSING
    sort_value: APINullable[int] = MISSING
    user: APINullable[User] = MISSING

    @classmethod
    async def from_id(cls, _id: Snowflake) -> Sticker:
        """|coro|
        Returns a sticker object for the given sticker ID.

        Parameters
        ----------
        _id : Snowflake
            id of the sticker

        Returns
        -------
        :class:`~pincer.objects.message.sticker.Sticker`
            sticker object of the given ID
        """
        sticker = await cls._http.get(f"stickers/{_id}")

        return cls.from_dict(sticker)

    async def modify(
        self,

        name: Optional[str] = None,

        description: Optional[str] = None,

        tags: Optional[str] = None,

        reason: Optional[str] = None,

    ) -> Sticker:
        """|coro|
        Modify the given sticker.
        Requires the ``MANAGE_EMOJIS_AND_STICKERS permission.``

        Parameters
        ----------
        name : Optional[:class:`str`] |default| :data:`None`
            name of the sticker (2-30 characters)
        description : Optional[:class:`str`] |default| :data:`None`
            description of the sticker (2-100 characters)
        tags : Optional[:class:`str`] |default| :data:`None`
            autocomplete/suggestion tags for the sticker (max 200 characters)
        reason : Optional[:class:`str`]
            reason for modifying the sticker

        Returns
        -------
        :class:`~pincer.objects.message.sticker.Sticker`
            the modified sticker
        """
        sticker = self._http.patch(
            f"guilds/{self.guild_id}/stickers/{self.id}",
            data=remove_none(
                {"name": name, "description": description, "tags": tags}
            ),
            headers=remove_none({"X-Audit-Log-Reason": reason}),
        )

        return Sticker.from_dict(sticker)


@dataclass(repr=False)
class StickerItem(APIObject):
    """Represents the smallest amount of data required to render a sticker.
    A partial sticker object.

    Attributes
    ----------
    id: :class:`~pincer.utils.snowflake.Snowflake`
        Id of the sticker
    name: :class:`str`
        Name of the sticker
    format_type: :class:`~pincer.objects.message.sticker.StickerFormatType`
        Type of sticker format
    """

    id: Snowflake
    name: str
    format_type: StickerFormatType


@dataclass(repr=False)
class StickerPack(APIObject):
    """Represents a pack of standard stickers.

    Attributes
    ----------
    id: :class:`~pincer.utils.snowflake.Snowflake`
        Id of the sticker pack
    stickers: List[:class:`~pincer.objects.message.sticker.Sticker`]
        The stickers in the pack
    name: :class:`str`
        Name of the sticker pack
    sku_id: :class:`~pincer.utils.snowflake.Snowflake`
        Id of the pack's SKU
    description: :class:`str`
        Description of the sticker pack
    cover_sticker_id: APINullable[:class:`~pincer.utils.snowflake.Snowflake`]
        Id of a sticker in the pack which is shown as the pack's icon
    banner_asset_id: APINullable[:class:`~pincer.utils.snowflake.Snowflake`]
        Id of the sticker pack's banner image
    """

    id: Snowflake
    stickers: List[Sticker]
    name: str
    sku_id: Snowflake
    description: str

    cover_sticker_id: APINullable[Snowflake] = MISSING
    banner_asset_id: APINullable[Snowflake] = MISSING


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 dataclasses import dataclass
7			from enum import IntEnum
8			from typing import TYPE_CHECKING
9
10			from ...utils.api_object import APIObject
11			from ...utils.conversion import remove_none
12			from ...utils.types import MISSING
13
14			if TYPE_CHECKING:
15			from typing import List, Optional
16
17			from ..user import User
18			from ...utils import APINullable, Snowflake
19
20
21			class StickerType(IntEnum):
22			"""Displays from where the sticker comes from.
23
24			Attributes
25			----------
26			STANDARD:
27			Sticker is included in the default Discord sticker pack.
28			GUILD:
29			Sticker is a custom sticker from a discord server.
30			"""
31
32			STANDARD = 1
33			GUILD = 2
34
35
36			class StickerFormatType(IntEnum):
37			"""The type of the sticker.
38
39			Attributes
40			----------
41			PNG:
42			Sticker is of PNG format.
43			APNG:
44			Sticker is animated with APNG format.
45			LOTTIE:
46			Sticker is animated with with LOTTIE format. (vector based)
47			"""
48
49			PNG = 1
50			APNG = 2
51			LOTTIE = 3
52
53
54			@dataclass(repr=False)
55			class Sticker(APIObject):
			0 ignored issues – show best-practice introduced 2021-10-03 07:58 UTC by Report Bug Copy Issue Report Too many instance attributes (11/7) Loading history...
56			"""Represents a Discord sticker.
57
58			Attributes
59			----------
60			description: Optional[:class:`str`]
61			description of the sticker
62			format_type: :class:`~pincer.objects.message.sticker.StickerFormatType`
63			type of sticker format
64			id: :class:`~pincer.utils.snowflake.Snowflake`
65			id of the sticker
66			name: :class:`str`
67			name of the sticker
68			tags: :class:`str`
69			for guild stickers, the Discord name of a unicode emoji
70			representing the sticker's expression. For standard stickers,
71			a comma-separated list of related expressions.
72			type: :class:`~pincer.objects.message.sticker.StickerType`
73			type of sticker
74			available: APINullable[:class:`bool`]
75			whether this guild sticker can be used,
76			may be false due to loss of Server Boosts
77			guild_id: APINullable[:class:`~pincer.utils.snowflake.Snowflake`]
78			id of the guild that owns this sticker
79			pack_id: APINullable[:class:`~pincer.utils.snowflake.Snowflake`]
80			for standard stickers, id of the pack the sticker is from
81			sort_value: APINullable[:class:`int`]
82			the standard sticker's sort order within its pack
83			user: APINullable[:class:`~pincer.objects.user.user.User`]
84			the user that uploaded the guild sticker
85			"""
86
87			description: Optional[str]
88			format_type: StickerFormatType
89			id: Snowflake
90			name: str
91			tags: str
92			type: StickerType
93
94			available: APINullable[bool] = MISSING
95			guild_id: APINullable[Snowflake] = MISSING
96			pack_id: APINullable[Snowflake] = MISSING
97			sort_value: APINullable[int] = MISSING
98			user: APINullable[User] = MISSING
99
100			@classmethod
101			async def from_id(cls, _id: Snowflake) -> Sticker:
102			"""\|coro\|
103			Returns a sticker object for the given sticker ID.
104
105			Parameters
106			----------
107			_id : Snowflake
108			id of the sticker
109
110			Returns
111			-------
112			:class:`~pincer.objects.message.sticker.Sticker`
113			sticker object of the given ID
114			"""
115			sticker = await cls._http.get(f"stickers/{_id}")
			0 ignored issues – show Bug introduced 2021-12-05 22:01 UTC by Report Bug Copy Issue Report The Class `Sticker` does not seem to have a member named `_http`. 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...
116			return cls.from_dict(sticker)
117
118			async def modify(
119			self,
			0 ignored issues – show Coding Style introduced 2021-12-06 06:03 UTC by Report Bug Copy Issue Report Wrong hanging indentation before block (add 4 spaces). Loading history...
120			name: Optional[str] = None,
			0 ignored issues – show Coding Style introduced 2021-12-05 23:17 UTC by Report Bug Copy Issue Report Wrong hanging indentation before block (add 4 spaces). Loading history...
121			description: Optional[str] = None,
			0 ignored issues – show Coding Style introduced 2021-11-30 03:08 UTC by Report Bug Copy Issue Report Wrong hanging indentation before block (add 4 spaces). Loading history...
122			tags: Optional[str] = None,
			0 ignored issues – show Coding Style introduced 2021-12-06 06:03 UTC by Report Bug Copy Issue Report Wrong hanging indentation before block (add 4 spaces). Loading history...
123			reason: Optional[str] = None,
			0 ignored issues – show Coding Style introduced 2021-12-06 06:03 UTC by Report Bug Copy Issue Report Wrong hanging indentation before block (add 4 spaces). Loading history...
124			) -> Sticker:
125			"""\|coro\|
126			Modify the given sticker.
127			Requires the ``MANAGE_EMOJIS_AND_STICKERS permission.``
128
129			Parameters
130			----------
131			name : Optional[:class:`str`] \|default\| :data:`None`
132			name of the sticker (2-30 characters)
133			description : Optional[:class:`str`] \|default\| :data:`None`
134			description of the sticker (2-100 characters)
135			tags : Optional[:class:`str`] \|default\| :data:`None`
136			autocomplete/suggestion tags for the sticker (max 200 characters)
137			reason : Optional[:class:`str`]
138			reason for modifying the sticker
139
140			Returns
141			-------
142			:class:`~pincer.objects.message.sticker.Sticker`
143			the modified sticker
144			"""
145			sticker = self._http.patch(
146			f"guilds/{self.guild_id}/stickers/{self.id}",
147			data=remove_none(
148			{"name": name, "description": description, "tags": tags}
149			),
150			headers=remove_none({"X-Audit-Log-Reason": reason}),
151			)
152
153			return Sticker.from_dict(sticker)
154
155
156			@dataclass(repr=False)
157			class StickerItem(APIObject):
158			"""Represents the smallest amount of data required to render a sticker.
159			A partial sticker object.
160
161			Attributes
162			----------
163			id: :class:`~pincer.utils.snowflake.Snowflake`
164			Id of the sticker
165			name: :class:`str`
166			Name of the sticker
167			format_type: :class:`~pincer.objects.message.sticker.StickerFormatType`
168			Type of sticker format
169			"""
170
171			id: Snowflake
172			name: str
173			format_type: StickerFormatType
174
175
176			@dataclass(repr=False)
177			class StickerPack(APIObject):
178			"""Represents a pack of standard stickers.
179
180			Attributes
181			----------
182			id: :class:`~pincer.utils.snowflake.Snowflake`
183			Id of the sticker pack
184			stickers: List[:class:`~pincer.objects.message.sticker.Sticker`]
185			The stickers in the pack
186			name: :class:`str`
187			Name of the sticker pack
188			sku_id: :class:`~pincer.utils.snowflake.Snowflake`
189			Id of the pack's SKU
190			description: :class:`str`
191			Description of the sticker pack
192			cover_sticker_id: APINullable[:class:`~pincer.utils.snowflake.Snowflake`]
193			Id of a sticker in the pack which is shown as the pack's icon
194			banner_asset_id: APINullable[:class:`~pincer.utils.snowflake.Snowflake`]
195			Id of the sticker pack's banner image
196			"""
197
198			id: Snowflake
199			stickers: List[Sticker]
200			name: str
201			sku_id: Snowflake
202			description: str
203
204			cover_sticker_id: APINullable[Snowflake] = MISSING
205			banner_asset_id: APINullable[Snowflake] = MISSING
206

Pincer-org / Pincer

Pull Request — main (#292)

pincer.objects.message.sticker.Sticker.modify() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like