mirror of
https://github.com/Rapptz/discord.py.git
synced 2025-04-19 23:44:29 +00:00
2cd6d771ec
This includes raw events (which didn't have any) and a few other types that were missing them. Upon review some more useful fields were added to the repr output which would be more useful during debugging.
74 lines
2.4 KiB
Python
74 lines
2.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2015-2019 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 . import utils
|
|
from .mixins import Hashable
|
|
|
|
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:`strange order <21>` and when such events happened you would
|
|
receive this class rather than the actual data class. These cases are
|
|
extremely rare.
|
|
|
|
.. container:: 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:`str`
|
|
The ID of the object.
|
|
"""
|
|
|
|
def __init__(self, id):
|
|
self.id = id
|
|
|
|
def __repr__(self):
|
|
return '<Object id=%r>' % self.id
|
|
|
|
@property
|
|
def created_at(self):
|
|
"""Returns the snowflake's creation time in UTC."""
|
|
return utils.snowflake_time(self.id)
|