✨ Add slotscheck to ensure __slots__ are used correctly

Author: Paillat-dev

.github/workflows/lib-checks.yml

@@ -93,3 +93,21 @@ jobs:
         run: mkdir -p -v .mypy_cache
       - name: "Run mypy"
         run: uv run mypy --non-interactive discord/
+  slotscheck:
+    if: ${{ github.event_name != 'schedule' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout Repository"
+        uses: actions/checkout@v4
+      - name: "Setup Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: "Install uv"
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Sync dependencies
+        run: uv sync --no-python-downloads --group dev
+      - name: "Run slotscheck"
+        run: uv run slotscheck discord

.pre-commit-config.yaml

@@ -33,3 +33,11 @@ repos:
       - id: prettier
         args: [--prose-wrap=always, --print-width=88]
         exclude: \.(po|pot|yml|yaml)$
+  - repo: https://github.com/ariebovenberg/slotscheck
+    rev: v0.19.1
+    hooks:
+      - id: slotscheck
+        additional_dependencies:
+          - "typing-extensions>=4,<5"
+          - "colorlog~=6.9.0"
+          - "aiohttp>=3.6.0,<4.0"

discord/activity.py

@@ -204,7 +204,6 @@ class Activity(BaseActivity):
     __slots__ = (
         "state",
         "details",
-        "_created_at",
         "timestamps",
         "assets",
         "party",

discord/asset.py

@@ -51,6 +51,8 @@ class AssetMixin:
     url: str
     _state: Any | None
 
+    __slots__: tuple[str, ...] = ("_state", "url")
+
     async def read(self) -> bytes:
         """|coro|
 
@@ -148,7 +150,6 @@ class Asset(AssetMixin):
     """
 
     __slots__: tuple[str, ...] = (
-        "_state",
         "_url",
         "_animated",
         "_key",

discord/components.py

@@ -154,7 +154,6 @@ class InputText(Component):
     """
 
     __slots__: tuple[str, ...] = (
-        "type",
         "style",
         "custom_id",
         "label",

discord/emoji.py

@@ -53,9 +53,7 @@ class BaseEmoji(_EmojiTag, AssetMixin):
         "require_colons",
         "animated",
         "managed",
-        "id",
         "name",
-        "_state",
         "user",
         "available",
     )

discord/partial_emoji.py

@@ -91,7 +91,7 @@ class PartialEmoji(_EmojiTag, AssetMixin):
         The ID of the custom emoji, if applicable.
     """
 
-    __slots__ = ("animated", "name", "id", "_state")
+    __slots__ = ("animated", "name", "id")
 
     _CUSTOM_EMOJI_RE = re.compile(r"<?(?P<animated>a)?:?(?P<name>\w+):(?P<id>[0-9]{13,20})>?")
 

discord/raw_models.py

@@ -85,6 +85,8 @@
 
 
 class _RawReprMixin:
+    __slots__ = ()
+
     def __repr__(self) -> str:
         value = " ".join(f"{attr}={getattr(self, attr)!r}" for attr in self.__slots__)
         return f"<{self.__class__.__name__} {value}>"

discord/sticker.py

@@ -200,7 +200,7 @@ class StickerItem(_StickerTag):
         The URL for the sticker's image.
     """
 
-    __slots__ = ("_state", "name", "id", "format", "url")
+    __slots__ = ("name", "id", "format")
 
     def __init__(self, *, state: ConnectionState, data: StickerItemPayload):
         self._state: ConnectionState = state
@@ -271,7 +271,7 @@ class Sticker(_StickerTag):
         The URL for the sticker's image.
     """
 
-    __slots__ = ("_state", "id", "name", "description", "format", "url")
+    __slots__ = ("id", "name", "description", "format")
 
     def __init__(self, *, state: ConnectionState, data: StickerPayload) -> None:
         self._state: ConnectionState = state

discord/widget.py

@@ -152,13 +152,9 @@ class WidgetMember(BaseUser):
     """
 
     __slots__ = (
-        "name",
         "status",
         "nick",
         "avatar",
-        "discriminator",
-        "id",
-        "bot",
         "activity",
         "deafened",
         "suppress",