add documentation

This commit is contained in:
2025-12-10 03:45:39 +01:00
parent 4a33281ca4
commit aa2e450454
4 changed files with 94 additions and 1 deletions

View File

@@ -5,7 +5,14 @@ import logging
class DiscordRPC:
"""
Client for interacting with Discord Rich Presence (RPC).
"""
def __init__(self):
"""
Initializes the Discord RPC client and connects to Discord via IPC.
"""
self.logger = logging.getLogger('DiscordRPC')
self.logger.info("Connecting to Discord RPC...")
@@ -14,6 +21,12 @@ class DiscordRPC:
self.logger.info("Connected to Discord RPC.")
def update(self, payload: DiscordRPCUpdatePayload):
"""
Updates the Discord RPC presence with the provided payload.
Args:
payload (DiscordRPCUpdatePayload): The payload containing presence information.
"""
self.logger.info("Updating Discord RPC presence...")
self.rpc.update(
activity_type=payload.activity_type,
@@ -27,6 +40,9 @@ class DiscordRPC:
self.logger.info("Discord RPC presence updated.")
def clear(self):
"""
Clears the Discord RPC presence.
"""
self.logger.info("Clearing Discord RPC presence...")
self.rpc.clear()
self.logger.info("Discord RPC presence cleared.")