자주 묻는 질문

이 페이지에는 discord.py 와 추가적인 모듈과 관련된 자주 묻는 질문의 목록이 나열되어 있습니다. 얼마든지 pull requests를 통해 질문해주세요.

코루틴

코루틴과 asyncio 관련 질문은 여기에 나열되어 있습니다.

코루틴이 뭔가요?

코루틴 함수는 반드시 await 또는 yield from 과 함께 적용되어야 합니다. Python은 await 과 맞닥뜨리면 해당 함수의 실행을 중지하고 다른 작업을 끝내고 다시 그 지점으로 돌아옵니다. 이것은 당신의 프로그램이 쓰레드나 복잡한 멀티프로세싱 없이 여러 작업을 동시에 할 수 있게 만들어줍니다.

만약 코루틴을 await 하지 않았다면, 해당 코루틴은 실행되지 않을 것입니다. 절대 코루틴을 await 하는 것을 잊지 마세요.

await을 어디에 사용할 수 있나요?

await 은 async def 함수 안에만 사용할 수 있습니다.

《blocking》의 뜻이 뭔가요?

비동기 프로그래밍에서 호출 차단은 await 이 아닌 모든 함수의 본질적인 부분입니다. 그래도 걱정하지 마세요. 호출 차단은 항상 나쁜 것은 아니랍니다. 호출 차단을 사용하는 것은 불가피하지만, 당신은 과도하게 함수의 호출을 차단하지 않도록 해야 합니다. 기억하세요. 만약 너무 오랫동안 차단된다면 당신의 봇은 다른 일을 하기 위해 그 시점에서 함수의 실행을 중단하지 않았기 때문에 멈출 것입니다.

로깅이 활성화되었다면, 이 라이브러리는 당신에게 메시지의 차단이 일어나고 있다고 경고할 것입니다: Heartbeat blocked for more than N seconds. 로깅 설정 을 참고하여 로깅을 활성화하는 방법에 대해 자세히 알아보세요.

호출을 너무 오랫동안 차단하는 대표적인 원인은 time.sleep() 입니다. asyncio.sleep()을 대신 사용하세요. 아래의 예시를 참고하세요:

# bad
time.sleep(10)

# good
await asyncio.sleep(10)

차단을 너무 오랫동안 하는 또 하나의 원인은 유명한 모듈인 requests 의 HTTP 요청을 사용하는 것입니다. requests 는 동기 프로그래밍에서는 엄청난 모듈이지만, asyncio 와 함께 쓸 때는 좋은 선택이 아닙니다. 그 이유는 특정 요청은 이벤트 루프를 너무 오랫동안 차단할 수 있기 때문이죠. 대신에, 이 라이브러리와 함께 설치된 aiohttp 라이브러리를 사용하세요.

다음의 예시를 고려해보세요:

# bad
r = requests.get('http://aws.random.cat/meow')
if r.status_code == 200:
    js = r.json()
    await channel.send(js['file'])

# good
async with aiohttp.ClientSession() as session:
    async with session.get('http://aws.random.cat/meow') as r:
        if r.status == 200:
            js = await r.json()
            await channel.send(js['file'])

일반

라이브러리와 관련된 일반적인 질문은 여기에 있습니다.

예시들을 어디서 볼 수 있나요?

예제는 리포지토리의 예시 폴더 에서 찾으실 수 있습니다

봇의 《하는 중》 상태 메시지를 어디서 설정할 수 있나요?

Client 의 Client.change_presence() 메소드가 존재합니다. 이것과 관련된 측면은 Activity 오브젝트를 사용하는 activity 키워드 인자입니다.

ActivityType 을 사용하여 상태 타입(하는 중, 듣는 중, 방송 중, 시청 중)이 설정될 수 있습니다. 메모리 최적화를 위하여, 몇몇 상태는 축소된 버전으로 제공됩니다.:

• Game

• Streaming

이 두 가지를 모두 넣게 되면 다음과 같은 정보를 얻을 수 있습니다:

await client.change_presence(activity=discord.Game(name='my game'))

# or, for watching:
activity = discord.Activity(name='my activity', type=discord.ActivityType.watching)
await client.change_presence(activity=activity)

어떻게 특정 채널에 메시지를 보내나요?

채널의 정보(ID 등)를 바로 가져와 적절한 메서드를 호출해야 합니다.

channel = client.get_channel(12324234183172)
await channel.send('hello')

어떻게 DM(개인 메시지)을 보내나요?

User 또는 Member 오브젝트를 갖고 온 뒤 abc.Messageable.send() 를 호출하세요. 예를 들어:

user = client.get_user(381870129706958858)
await user.send('👀')

on_message() 와 같은 이벤트에 반응할 때, User 오브젝트를 Message.author 를 통하여 이미 갖고 있는 경우 이렇게 하세요:

await message.author.send('👋')

어떻게 보낸 메시지의 ID를 얻을 수 있나요?

abc.Messageable.send() 는 전송된 Message 를 반환합니다.메시지의 ID는 Message.id 를 통하여 접근할 수 있습니다:

message = await channel.send('hmm…')
message_id = message.id

어떻게 이미지를 올리나요?

디스코드에 무언가를 업로드하기 위해서는 File 오브젝트를 활용해야 합니다.

File 은 두 개의 매개변수를 허용합니다. 파일 오브젝트 (또는 파일의 경로) 그리고 디스코드에 업로드할 때 사용될 파일의 이름이 있습니다.

이미지의 업로드는 다음과 같이 매우 간단합니다:

await channel.send(file=discord.File('my_file.png'))

파일 오브젝트를 갖고 있다면 이렇게 하세요:

with open('my_file.png', 'rb') as fp:
    await channel.send(file=discord.File(fp, 'new_filename.png'))

여러 파일을 업로드하려면 당신은 file대신 files 키워드 인자를 사용할 수 있습니다:

my_files = [
    discord.File('result.zip'),
    discord.File('teaser_graph.png'),
]
await channel.send(files=my_files)

만약 URL을 통해 무언가를 업로드하고 싶다면, aiohttp 를 사용한 HTTP 요청을 한 뒤, io.BytesIO 인스턴스에서 File 로 다음과 같이 변환하세요:

import io
import aiohttp

async with aiohttp.ClientSession() as session:
    async with session.get(my_url) as resp:
        if resp.status != 200:
            return await channel.send('Could not download file...')
        data = io.BytesIO(await resp.read())
        await channel.send(file=discord.File(data, 'cool_image.png'))

어떻게 메시지에 반응을 추가하나요?

Message.add_reaction() 메서드를 활용하세요.

만약 유니코드로 된 이모티콘을 사용하고 싶다면, 문자열에 유효한 유니코드 코드 포인트를 전달해야 합니다. 다음과 같은 방법으로 작성할 수 있습니다:

• '👍'

• '\U0001F44D'

• '\N{THUMBS UP SIGN}'

빠른 예시:

emoji = '\N{THUMBS UP SIGN}'
# or '\U0001f44d' or '👍'
await message.add_reaction(emoji)

메시지에 있는 이모티콘을 사용하려는 경우, 이미 메시지의 내용에 코드 포인트가 있으므로 다른 것을 특별히 할 필요는 없습니다. ':thumbsup:' 스타일로는 이모티콘을 전송할 수 없습니다.

서버 이모티콘의 경우, Emoji 인스턴스를 전달해야 합니다. '<:name:id>' 문자열로 전달하는 것도 가능하지만, 전송된 이모티콘을 사용하기 위해서는 이모티콘의 ID 또는 utils.find()/ Client.emojis 의 utils.get() 또는 Guild.emojis 컬렉션을 통하여 Client.get_emoji() 를 사용하는 방법도 알아야 합니다

서버 이모티콘의 이름 또는 ID는 클라이언트가 역슬래시와 함께 :custom_emoji: 접두사를 붙이는 것으로 찾을 수 있습니다. 예를 들어, 클라이언트에 \:python3: 메시지를 전송하는 것은 <:python3:232720527448342530> 을 얻을 수 있습니다

빠른 예시:

# if you have the ID already
emoji = client.get_emoji(310177266011340803)
await message.add_reaction(emoji)

# no ID, do a lookup
emoji = discord.utils.get(guild.emojis, name='LUL')
if emoji:
    await message.add_reaction(emoji)

# if you have the name and ID of a custom emoji:
emoji = '<:python3:232720527448342530>'
await message.add_reaction(emoji)

어떻게 코루틴을 플레이어의 《after》 함수에 전달하나요?

라이브러리의 뮤직 플레이어는 분리된 쓰레드를 전송하므로 그것은 코루틴의 안에서 실행되지 않습니다. 이는 after 매개변수에 코루틴을 호출할 수 없다는 뜻이 아닙니다. 이를 하기 위해서는 반드시 몇 가지 측면을 정리하여 호출할 수 있게끔 전달해야 합니다

첫 번째로 반드시 알아두어야 할 것은 코루틴을 호출하는 것은 쓰레드로부터 안전한 조작이 아닙니다. 기술적으로는 다른 쓰레드에 있으므로, 버그를 만들어내지 않기 위해서는 조심스럽게 쓰레드에서 안전한 조작을 호출해야 합니다. 운이 좋게도, asyncio 는 다른 쓰레드에서 코루틴을 호출할 수 있는 asyncio.run_coroutine_threadsafe() 함수와 수반합니다.

하지만, 이 함수는 concurrent.Future 를 반환하고 이를 실질적으로 호출하기 위해서는 결과를 가져(fetch)와야 합니다. 이를 모두 하기 위해서는 다음을 따라야 합니다:

def my_after(error):
    coro = some_channel.send('Song is done!')
    fut = asyncio.run_coroutine_threadsafe(coro, client.loop)
    try:
        fut.result()
    except:
        # an error happened sending the message
        pass

voice.play(discord.FFmpegPCMAudio(url), after=my_after)

어떻게 백그라운드에서 무언가를 실행시키나요?

background_task.py 예시를 참고하세요.

어떻게 특정 모델을 갖고오나요?

여러 방법을 통해 갖고올 수 있습니다. 그 특정한 모델의 ID가 있는 경우, 아래의 함수 중 하나를 사용할 수 있습니다:

• Client.get_channel()

• Client.get_guild()

• Client.get_user()

• Client.get_emoji()

• Guild.get_member()

• Guild.get_channel()

• Guild.get_role()

다음은 HTTP 요청을 사용합니다:

• abc.Messageable.fetch_message()

• Client.fetch_user()

• Client.fetch_guilds()

• Client.fetch_guild()

• Guild.fetch_emoji()

• Guild.fetch_emojis()

• Guild.fetch_member()

위에 있는 함수가 전혀 도움이 되지 않을 경우, utils.find() 또는 utils.get() 이 구체적인 모델을 찾는데 사용될 것입니다

빠른 예시:

# find a guild by name
guild = discord.utils.get(client.guilds, name='My Server')

# make sure to check if it's found
if guild is not None:
    # find a channel by name
    channel = discord.utils.get(guild.text_channels, name='cool-channel')

어떻게 웹 리퀘스트를 만드나요?

리퀘스트를 만들기 위해서는 차단되지 않는 라이브러리를 사용해야 합니다. 이 라이브러리는 이미 제3자 라이브러리인 aiohttp 를 사용하고 필요로 합니다

빠른 예시:

async with aiohttp.ClientSession() as session:
    async with session.get('http://aws.random.cat/meow') as r:
        if r.status == 200:
            js = await r.json()

자세한 내용은 aiohttp의 문서 를 참고하세요.

내장 이미지 파일을 어떻게 임베드 사진에 사용할 수 있나요?

이미지를 업로드하고 임베드에 첨부하는 것은 디스코드의 특이 케이스로 구분되어 표시되지는 않지만, 대신 임베드의 썸네일, 이미지, 꼬리말 또는 작성자 아이콘에 사용하세요

그렇게 하기 위해서, 이미지를 abc.Messageable.send() 로 업로드하고, 임베드 이미지의 URL을 attachment://image.png 로 설정하세요. 이 때, image.png 는 보낼 이미지의 파일 이름이 됩니다.

빠른 예시:

file = discord.File("path/to/my/image.png", filename="image.png")
embed = discord.Embed()
embed.set_image(url="attachment://image.png")
await channel.send(file=file, embed=embed)

참고

디스코드의 한계로, 파일 이름은 언더바를 포함하지 않을 수 있습니다.

감사 로그를 생성하는 이벤트가 있나요?

디스코드는 이 정보를 대역폭에 전송하지 않으므로, 해당 라이브러리는 이 정보를 제공할 수 없습니다. 이는 디스코드의 한계입니다.

명령어 확장

discord.ext.commands 와 관련된 질문은 여기에 있습니다.

왜 on_message 는 명령어를 멈추게 만들죠?

on_message 에 제공된 기본값을 재정의하는 것은 추가 명령을 발생시키지 않습니다. 이를 해결하기 위해, bot.process_commands(message) 라인을 on_message 함수의 가장 끝에 배치하세요. 예를 들어:

@bot.event
async def on_message(message):
    # do some extra stuff here

    await bot.process_commands(message)

Alternatively, you can place your on_message logic into a listener. In this setup, you should not manually call bot.process_commands(). This also allows you to do multiple things asynchronously in response to a message. Example:

@bot.listen('on_message')
async def whatever_you_want_to_call_it(message):
    # do stuff here
    # do not process commands here

왜 인자에 인용구(따옴표)가 필요하죠?

다음과 같이 정의된 간단한 명령어에는:

@bot.command()
async def echo(ctx, message: str):
    await ctx.send(message)

?echo a b c 를 호출하는 것은 맨 처음의 인자만 불러오고 다른 인자는 전부 무시합니다. 이를 해결하기 위해, ?echo "a b c" 를 사용하거나 《consume rest》 행동을 갖도록 서명을 변경하세요. 예:

@bot.command()
async def echo(ctx, *, message: str):
    await ctx.send(message)

이는 인용구의 필요 없이 ?echo a b c 를 사용할 수 있게 해줍니다.

원본 message를 어떻게 얻나요?

Context 는 원본 메시지를 갖고 오기 위해 message 라는 속성을 포함하고 있습니다.

예:

@bot.command()
async def length(ctx):
    await ctx.send('Your message is {} characters long.'.format(len(ctx.message.content)))

하위 명령어를 어떻게 만드나요?

group 데코레이터를 사용하세요. 이렇게 하면 호출을 그룹화하여 《하위 명령어》로 명령어를 사용할 수 있게 만들어줍니다. 이 그룹은 임의적으로 중첩될 수도 있습니다.

예:

@bot.group()
async def git(ctx):
    if ctx.invoked_subcommand is None:
        await ctx.send('Invalid git command passed...')

@git.command()
async def push(ctx, remote: str, branch: str):
    await ctx.send('Pushing to {} {}'.format(remote, branch))

그리고 이것은 ?git push origin master 로 사용될 수도 있습니다.