Skip to content

Base Models

Internal API

These classes are for internal use only.

Users should interact with Client and other public API classes instead.


DataModel dataclass

DataModel is a base class for Discord JSONs that provides hydration from raw dicts, and optional field defaults.

from_dict classmethod

Hydrates the given data into the dataclass.

Parameters:

  • data (dict) –

    the JSON data

Returns:

  • cls

    hydrated dataclass

to_dict

Recursively turns the dataclass into a dictionary and drops empty fields.

Returns:

  • dict

    serialized dataclasss


BaseResource dataclass

Represents a Discord Resource object.

_http: HTTPClient instance-attribute

HTTP session for requests.

context: Any instance-attribute

Associated user data.


Event

Marker class for all gateway events.

name: str instance-attribute

Dispatch name of event.

raw: dict instance-attribute

Event's raw JSON payload. NOT A DATACLASS.