-

API 레퍼런스

-

아래의 섹션은 discord.py API에 대해 설명하고 있습니다.

+

API Reference

+

The following section outlines the API of discord.py.

참고

This module uses the Python logging module to log diagnostic and errors @@ -58,12 +58,12 @@

API 레퍼런스 -

버전과 관련된 정보

+

Version Related Info

There are two main ways to query version information about the library. For guarantees, check 버전 개런티.

discord.version_info
-

sys.version_info와 비슷한 튜플의 이름입니다.

+

A named tuple that is similar to sys.version_info.

Just like sys.version_info the valid values for releaselevel are 〈alpha〉, 〈beta〉, 〈candidate〉 and 〈final〉.

@@ -77,53 +77,57 @@

버전과 관련된 정보
-

클라이언트

+

Client

class discord.Client(*, loop=None, **options)

Represents a client connection that connects to Discord. This class is used to interact with the Discord WebSocket and API.

-

여러 가지 옵션을 Client에 전달할 수 있습니다.

+

A number of options can be passed to the Client.

매개변수
  • max_messages (Optional[int]) –

    The maximum number of messages to store in the internal message cache. This defaults to 1000. Passing in None disables the message cache.

    -

    버전 1.3에서 변경: 메시지 캐시를 비활성화하고 기본 크기를 1000으로 변경하세요.

    +

    버전 1.3에서 변경: Allow disabling the message cache and change the default size to 1000.

  • loop (Optional[asyncio.AbstractEventLoop]) – The asyncio.AbstractEventLoop to use for asynchronous operations. Defaults to None, in which case the default event loop is used via asyncio.get_event_loop().

  • -
  • connector (aiohttp.BaseConnector) – 연결 풀링에 사용할 커넥터.

  • -
  • proxy (Optional[str]) – 프록시 URL.

  • -
  • proxy_auth (Optional[aiohttp.BasicAuth]) – 프록시 HTTP Basic Authorization을 나타내는 오브젝트

  • -
  • shard_id (Optional[int]) – 0부터 시작하고 shard_count보다 작은 정수.

  • -
  • shard_count (Optional[int]) – 샤드의 총 개수.

  • +
  • connector (aiohttp.BaseConnector) – The connector to use for connection pooling.

  • +
  • proxy (Optional[str]) – Proxy URL.

  • +
  • proxy_auth (Optional[aiohttp.BasicAuth]) – An object that represents proxy HTTP Basic Authorization.

  • +
  • shard_id (Optional[int]) – Integer starting at 0 and less than shard_count.

  • +
  • shard_count (Optional[int]) – The total number of shards.

  • fetch_offline_members (bool) – Indicates if on_ready() should be delayed to fetch all offline members from the guilds the client belongs to. If this is False, then no offline members are received and request_offline_members() must be used to fetch the offline members of the guild.

  • -
  • status (Optional[Status]) – 디스코드에 로그인할 때 나타나는 상태.

  • -
  • activity (Optional[BaseActivity]) – 디스코드에 로그인할 때 나타나는 활동.

  • -
  • allowed_mentions (Optional[AllowedMentions]) – 전송된 모든 멘션에 대해 클라이언트가 어떻게 다루는지 제어합니다. .. versionadded:: 1.4

  • +
  • status (Optional[Status]) – A status to start your presence with upon logging on to Discord.

  • +
  • activity (Optional[BaseActivity]) – An activity to start your presence with upon logging on to Discord.

  • +
  • allowed_mentions (Optional[AllowedMentions]) –

    Control how the client handles mentions by default on every message sent.

    +
    +

    버전 1.4에 추가.

    +
    +

  • heartbeat_timeout (float) – The maximum numbers of seconds before timing out and restarting the WebSocket in the case of not receiving a HEARTBEAT_ACK. Useful if processing the initial packets take too long to the point of disconnecting you. The default timeout is 60 seconds.

  • -
  • guild_subscriptions (bool) –

    상태나 타이핑 이벤트의 처리 여부. 기본값은 True입니다.

    +
  • guild_subscriptions (bool) –

    Whether to dispatching of presence or typing events. Defaults to True.

    버전 1.3에 추가.

    경고

    -

    이것이 False로 설정되어 있을 경우, 아래의 기능이 비활성화됩니다:

    +

    If this is set to False then the following features will be disabled:

      -
    • 사용자 관련 이벤트 없음 (on_user_update()는 처리되지 않습니다)

    • +
    • No user related updates (on_user_update() will not dispatch)

    • -
      모든 멤버 관련 이벤트가 비활성화됩니다.
    • -
    • 타이핑 이벤트가 비활성화됩니다 (on_typing()).

    • +
    • Typing events will be disabled (on_typing()).

    • If fetch_offline_members is set to False then the user cache will not exist. This makes it difficult or impossible to do many things, for example:

        -
      • 컴퓨팅 권한

      • +
      • Computing permissions

      • Querying members in a voice channel via VoiceChannel.members will be empty.

      • Most forms of receiving Member will be receiving User instead, except for message events.

      • -
      • Guild.ownerNone으로 반환됩니다.

      • -
      • Guild.get_member()의 사용이 불가능해집니다.

      • -
      • Member를 사용한 모든 것.

      • -
      • users의 값이 그렇게 많지 않을 것입니다.

      • -
      • 등등.

      • +
      • Guild.owner will usually resolve to None.

      • +
      • Guild.get_member() will usually be unavailable.

      • +
      • Anything that involves using Member.

      • +
      • users will not be as populated.

      • +
      • etc.

    • @@ -169,15 +173,15 @@

      클라이언트
      ws
      -

      클라이언트가 현재 연결되어있는 웹소켓 대역폭. None일수도 있습니다.

      +

      The websocket gateway the client is currently connected to. Could be None.

      loop
      -

      클라이언트가 HTTP 요청과 웹소켓 작업에 사용하는 루프 이벤트.

      +

      The event loop that the client uses for HTTP requests and websocket operations.

      -
      타입
      +
      Type

      asyncio.AbstractEventLoop

      @@ -186,10 +190,10 @@

      클라이언트
      latency
      -

      HEARTBEAT와 HEARTBEAT_ACK 사이의 지연 시간을 초 단위로 측정합니다.

      -

      Discord WebSocket 프로토콜 지연 시간이라고 불리기도 합니다.

      +

      Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

      +

      This could be referred to as the Discord WebSocket protocol latency.

      -
      타입
      +
      Type

      float

      @@ -198,9 +202,9 @@

      클라이언트
      user
      -

      연결된 클라이언트에 해당합니다. 로그인되지 않았을 경우 None입니다.

      +

      Represents the connected client. None if not logged in.

      -
      타입
      +
      Type

      Optional[ClientUser]

      @@ -209,9 +213,9 @@

      클라이언트
      guilds
      -

      연결된 클라이언트가 속한 길드.

      +

      The guilds that the connected client is a member of.

      -
      타입
      +
      Type

      List[Guild]

      @@ -220,9 +224,9 @@

      클라이언트
      emojis
      -

      연결된 클라이언트가 보유중인 이모티콘.

      +

      The emojis that the connected client has.

      -
      타입
      +
      Type

      List[Emoji]

      @@ -231,12 +235,12 @@

      클라이언트
      cached_messages
      -

      연결된 클라이언트에 캐싱된 읽기 전용 메시지의 목록.

      +

      Read-only list of messages the connected client has cached.

      버전 1.1에 추가.

      -
      타입
      +
      Type

      Sequence[Message]

      @@ -245,13 +249,14 @@

      클라이언트
      private_channels
      -

      연결된 클라이언트가 참여중인 비공개 채널.

      +

      The private channels that the connected client is participating on.

      참고

      -

      디스코드 자체의 비공개 채널을 다루는 방식 때문에 최근 128개의 비공개 채널만 반환합니다.

      +

      This returns only up to 128 most recent private channels due to an internal working +on how Discord deals with private channels.

      -
      타입
      +
      Type

      List[abc.PrivateChannel]

      @@ -260,9 +265,9 @@

      클라이언트
      voice_clients
      -

      음성 연결 목록을 나타냅니다.

      +

      Represents a list of voice connections.

      -
      타입
      +
      Type

      List[VoiceClient]

      @@ -271,14 +276,14 @@

      클라이언트
      is_ready()
      -

      클라이언트의 내부 캐시를 사용할 준비가 되었는지의 여부를 지정합니다.

      +

      Specifies if the client’s internal cache is ready for use.

      await on_error(event_method, *args, **kwargs)

      This function is a coroutine.

      -

      클라이언트가 제공하는 기본적인 오류 처리기.

      +

      The default error handler provided by the client.

      By default this prints to sys.stderr however it could be overridden to have a different implementation. Check on_error() for more details.

      @@ -298,7 +303,7 @@

      클라이언트¶ if Guild.large is True.

      매개변수
      -

      *guilds (Guild) – 길드에 요청할 오프라인 멤버의 인자 목록.

      +

      *guilds (Guild) – An argument list of guilds to request offline members for.

      예외

      InvalidArgument – If any guild is unavailable or not large in the collection.

      @@ -310,11 +315,14 @@

      클라이언트
      await login(token, *, bot=True)

      This function is a coroutine.

      -

      지정된 인증서로 클라이언트에 로그인합니다.

      -

      이 함수는 두 가지의 다른 방법으로 사용될 수 있습니다.

      +

      Logs in the client with the specified credentials.

      +

      This function can be used in two different ways.

      경고

      -

      유저 토큰으로 로그인하는 것은 디스코드의 이용약관에 위배됩니다. 이는 잠재적으로 당신의 계정이 차단될 수 있음을 뜻합니다. 위험을 감수하고 사용하세요.

      +

      Logging on with a user token is against the Discord +Terms of Service +and doing so might potentially get your account banned. +Use this at your own risk.

      매개변수
      @@ -440,7 +448,7 @@

      클라이언트

      The activity being used upon logging in.

      -
      타입
      +
      Type

      Optional[BaseActivity]

      @@ -454,7 +462,7 @@

      클라이언트

      버전 1.4에 추가.

    -
    타입
    +
    Type

    Optional[AllowedMentions]

    @@ -465,7 +473,7 @@

    클라이언트users

    Returns a list of all the users the bot can see.

    -
    타입
    +
    Type

    List[User]

    @@ -1048,7 +1056,7 @@

    클라이언트shard_ids

    An optional list of shard_ids to launch the shards with.

    -
    타입
    +
    Type

    Optional[List[int]]

    @@ -1057,12 +1065,12 @@

    클라이언트
    latency
    -

    HEARTBEAT와 HEARTBEAT_ACK 사이의 지연 시간을 초 단위로 측정합니다.

    +

    Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

    This operates similarly to Client.latency() except it uses the average latency of every shard’s latency. To get a list of shard latency, check the latencies property. Returns nan if there are no shards ready.

    -
    타입
    +
    Type

    float

    @@ -1074,7 +1082,7 @@

    클라이언트

    A list of latencies between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

    This returns a list of tuples with elements (shard_id, latency).

    -
    타입
    +
    Type

    List[Tuple[int, float]]

    @@ -1094,7 +1102,7 @@

    클라이언트¶ if Guild.large is True.

    매개변수
    -

    *guilds (Guild) – 길드에 요청할 오프라인 멤버의 인자 목록.

    +

    *guilds (Guild) – An argument list of guilds to request offline members for.

    예외

    InvalidArgument – If any guild is unavailable or not large in the collection.

    @@ -1150,7 +1158,7 @@

    클라이언트id

    The application ID.

    -
    타입
    +
    Type

    int

    @@ -1161,7 +1169,7 @@

    클라이언트name

    The application name.

    -
    타입
    +
    Type

    str

    @@ -1172,7 +1180,7 @@

    클라이언트owner

    The application owner.

    -
    타입
    +
    Type

    User

    @@ -1186,7 +1194,7 @@

    클라이언트

    버전 1.3에 추가.

    -
    타입
    +
    Type

    Optional[Team]

    @@ -1197,7 +1205,7 @@

    클라이언트icon

    The icon hash, if it exists.

    -
    타입
    +
    Type

    Optional[str]

    @@ -1208,7 +1216,7 @@

    클라이언트description

    The application description.

    -
    타입
    +
    Type

    Optional[str]

    @@ -1220,7 +1228,7 @@

    클라이언트

    Whether the bot can be invited by anyone or if it is locked to the application owner.

    -
    타입
    +
    Type

    bool

    @@ -1232,7 +1240,7 @@

    클라이언트

    Whether the bot requires the completion of the full oauth2 code grant flow to join.

    -
    타입
    +
    Type

    bool

    @@ -1243,7 +1251,7 @@

    클라이언트rpc_origins

    A list of RPC origin URLs, if RPC is enabled.

    -
    타입
    +
    Type

    Optional[List[str]]

    @@ -1258,7 +1266,7 @@

    클라이언트

    버전 1.3에 추가.

-
타입
+
Type

str

@@ -1272,7 +1280,7 @@

클라이언트

버전 1.3에 추가.

-
타입
+
Type

str

@@ -1287,7 +1295,7 @@

클라이언트

버전 1.3에 추가.

-
타입
+
Type

Optional[int]

@@ -1302,7 +1310,7 @@

클라이언트

버전 1.3에 추가.