You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
120 lines
3.7 KiB
120 lines
3.7 KiB
"""
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2015-present Rapptz
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a
|
|
copy of this software and associated documentation files (the "Software"),
|
|
to deal in the Software without restriction, including without limitation
|
|
the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
and/or sell copies of the Software, and to permit persons to whom the
|
|
Software is furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
DEALINGS IN THE SOFTWARE.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
from typing import TYPE_CHECKING, List, Optional
|
|
|
|
from .mixins import Hashable
|
|
from .asset import Asset
|
|
from .utils import snowflake_time
|
|
from .enums import StickerType, try_enum
|
|
|
|
__all__ = (
|
|
'Sticker',
|
|
)
|
|
|
|
if TYPE_CHECKING:
|
|
import datetime
|
|
from .state import ConnectionState
|
|
from .types.message import Sticker as StickerPayload
|
|
|
|
|
|
class Sticker(Hashable):
|
|
"""Represents a sticker.
|
|
|
|
.. versionadded:: 1.6
|
|
|
|
.. container:: operations
|
|
|
|
.. describe:: str(x)
|
|
|
|
Returns the name of the sticker.
|
|
|
|
.. describe:: x == y
|
|
|
|
Checks if the sticker is equal to another sticker.
|
|
|
|
.. describe:: x != y
|
|
|
|
Checks if the sticker is not equal to another sticker.
|
|
|
|
Attributes
|
|
----------
|
|
name: :class:`str`
|
|
The sticker's name.
|
|
id: :class:`int`
|
|
The id of the sticker.
|
|
description: :class:`str`
|
|
The description of the sticker.
|
|
pack_id: :class:`int`
|
|
The id of the sticker's pack.
|
|
format: :class:`StickerType`
|
|
The format for the sticker's image.
|
|
tags: List[:class:`str`]
|
|
A list of tags for the sticker.
|
|
"""
|
|
|
|
__slots__ = ('_state', 'id', 'name', 'description', 'pack_id', 'format', '_image', 'tags')
|
|
|
|
def __init__(self, *, state: ConnectionState, data: StickerPayload):
|
|
self._state: ConnectionState = state
|
|
self.id: int = int(data['id'])
|
|
self.name: str = data['name']
|
|
self.description: str = data['description']
|
|
self.pack_id: int = int(data.get('pack_id', 0))
|
|
self.format: StickerType = try_enum(StickerType, data['format_type'])
|
|
self._image: str = data['asset']
|
|
|
|
try:
|
|
self.tags: List[str] = [tag.strip() for tag in data['tags'].split(',')]
|
|
except KeyError:
|
|
self.tags = []
|
|
|
|
def __repr__(self) -> str:
|
|
return f'<{self.__class__.__name__} id={self.id} name={self.name!r}>'
|
|
|
|
def __str__(self) -> str:
|
|
return self.name
|
|
|
|
@property
|
|
def created_at(self) -> datetime.datetime:
|
|
""":class:`datetime.datetime`: Returns the sticker's creation time in UTC."""
|
|
return snowflake_time(self.id)
|
|
|
|
@property
|
|
def image(self) -> Optional[Asset]:
|
|
"""Returns an :class:`Asset` for the sticker's image.
|
|
|
|
.. note::
|
|
This will return ``None`` if the format is ``StickerType.lottie``.
|
|
|
|
Returns
|
|
-------
|
|
Optional[:class:`Asset`]
|
|
The resulting CDN asset.
|
|
"""
|
|
if self.format is StickerType.lottie:
|
|
return None
|
|
|
|
return Asset._from_sticker(self._state, self.id, self._image)
|
|
|