Adding all files
This commit is contained in:
68
.local/lib/python3.14/site-packages/disnake/object.py
Normal file
68
.local/lib/python3.14/site-packages/disnake/object.py
Normal file
@@ -0,0 +1,68 @@
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import TYPE_CHECKING, SupportsInt, Union
|
||||
|
||||
from . import utils
|
||||
from .mixins import Hashable
|
||||
|
||||
if TYPE_CHECKING:
|
||||
import datetime
|
||||
|
||||
SupportsIntCast = Union[SupportsInt, str, bytes, bytearray]
|
||||
|
||||
__all__ = ("Object",)
|
||||
|
||||
|
||||
class Object(Hashable):
|
||||
"""Represents a generic Discord object.
|
||||
|
||||
The purpose of this class is to allow you to create 'miniature'
|
||||
versions of data classes if you want to pass in just an ID. Most functions
|
||||
that take in a specific data class with an ID can also take in this class
|
||||
as a substitute instead. Note that even though this is the case, not all
|
||||
objects (if any) actually inherit from this class.
|
||||
|
||||
There are also some cases where some websocket events are received
|
||||
in :issue-dpy:`strange order <21>` and when such events happened you would
|
||||
receive this class rather than the actual data class. These cases are
|
||||
extremely rare.
|
||||
|
||||
.. collapse:: operations
|
||||
|
||||
.. describe:: x == y
|
||||
|
||||
Checks if two objects are equal.
|
||||
|
||||
.. describe:: x != y
|
||||
|
||||
Checks if two objects are not equal.
|
||||
|
||||
.. describe:: hash(x)
|
||||
|
||||
Returns the object's hash.
|
||||
|
||||
Attributes
|
||||
----------
|
||||
id: :class:`int`
|
||||
The ID of the object.
|
||||
"""
|
||||
|
||||
def __init__(self, id: SupportsIntCast) -> None:
|
||||
try:
|
||||
id = int(id)
|
||||
except ValueError:
|
||||
raise TypeError(
|
||||
f"id parameter must be convertible to int not {id.__class__!r}"
|
||||
) from None
|
||||
else:
|
||||
self.id = id
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return f"<Object id={self.id!r}>"
|
||||
|
||||
@property
|
||||
def created_at(self) -> datetime.datetime:
|
||||
""":class:`datetime.datetime`: Returns the snowflake's creation time in UTC."""
|
||||
return utils.snowflake_time(self.id)
|
||||
Reference in New Issue
Block a user