Add discord.Object class for generic pass-by-ID.

3 files changed, 52 insertions, 0 deletions

diff --git a/discord/__init__.py b/discord/__init__.py
index 5abbf0e6..9467b4bb 100644
--- a/discord/__init__.py
+++ b/discord/__init__.py
@@ -29,6 +29,7 @@ from .permissions import Permissions
 from .role import Role
 from .colour import Color, Colour
 from .invite import Invite
+from .object import Object
 from . import utils
 
 import logging
diff --git a/discord/object.py b/discord/object.py
new file mode 100644
index 00000000..2c33068c
--- /dev/null
+++ b/discord/object.py
@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+"""
+The MIT License (MIT)
+
+Copyright (c) 2015 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.
+"""
+
+class Object(object):
+    """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. All 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.
+
+    .. attribute:: id
+
+        The ID of the object.
+    """
+
+    def __init__(self, id):
+        self.id = id
diff --git a/docs/conf.py b/docs/conf.py
index ab3aab2c..6c6c749d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -31,8 +31,13 @@ sys.path.insert(0, os.path.abspath('..'))
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.extlinks',
 ]
 
+extlinks = {
+    'issue': ('https://github.com/Rapptz/discord.py/issues/%s', 'issue '),
+}
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']