제가 속해있는 Google Developer Groups Soongsil University(이하 GDG SSU)에서는 커뮤니케이션 툴로 Slack을 사용 중입니다. 잡담, 개발, 질문&답변을 각기 다른 채널에서 이야기할 수 있고 코드 하이라이팅이 있어서 단순 메신져보다 코드 공유가 쉽다고 생각했기 때문입니다. 여러 가지 편의를 위한 봇을 만들 수 있다는 것 또한 슬랙의 큰 장점입니다. 전 회사에서는 데이터베이스를 조회해서 성장 지표를 뽑아내거나, unix timestamp 형식으로 돼 있는 시간을 읽을 수 있는 시간으로 바꿔주는 등 여러가지 기능으로 운영했었는데요. 저도 이를 살려서 GDG SSU에서 1일 1커밋을 장려하기 위한 ‘github 그래프 파싱 봇’과 ‘학교 공지 파싱 봇’을 운영 중입니다. python과 django를 쓰면서 슬랙 봇은 어떻게 만들어볼까 하며 생각하다가 공식 API문서에 추천한 python 오픈 소프 라이브러리인 Slacker를 사용하기로 했습니다.

아래는 현재 가동되고 있는 1일 1커밋 커맨드를 입력해서 시작일로부터 얼마나 커밋을 했는지 알려주는 화면과 학교 공지를 파싱해서 새로운 공지가 있으면 알려주는 슬랙의 사진입니다.

gdgssu-slack-bot

Bot의 등록

봇을 사용하기 위하서는 봇을 등록하고 그 봇의 Token이 필요합니다. Slack App 페이지에서 Build를 클릭해서 다른 팀에게 공개할 봇을 만들 것인지, 아니면 현재 사용하고 있는 팀을 위한 슬랙 봇을 만들 것인지 선택합니다. 그다음 봇을 하나 등록합니다. 이때 팀에 슬랙 Integration을 추가할 권한이 있어야 합니다.

봇 페이지에서 필요한 부분들을 설정하고, Token은 잘 복사해 둡니다.

REST API를 통한 메세지 보내기

Slacker는 pip를 통해서 설치합니다.

$ pip install slacker

메세지는 다음과 같이 보냅니다.

from slacker import Slacker

token = 'xoxo-토큰토큰-유어토큰'
slack = Slacker(token)
slack.chat.post_message('#channel', 'message')

token부분에 아까 발급받은 봇의 token을 넣어줍니다. post_message에는 어디로 보낼지에 대한 채널과 보낼 메세지가 필수적으로 들어갑니다. 이렇게 보낸 메세지는 이름이 단순 bot으로 되어있는 무미건조한 애로 표현이 됩니다. 이때 as_user=True 인자를 주게 된다면 봇 등록할 때 설정했던 프로필로써 표현됩니다.

slack-bot-user



제일 처음 이미지에서 공지 봇에서 본거와 같이 Message Formatting을 하고 싶다면 다음과 같이 attachments인자를 채워주면 됩니다.

attachments_dict = dict()
attachments_dict['pretext'] = "attachments 블록 전에 나타나는 text"
attachments_dict['title'] = "다른 텍스트 보다 크고 볼드되어서 보이는 title"
attachments_dict['title_link'] = "https://corikachu.github.io"
attachments_dict['fallback'] = "클라이언트에서 노티피케이션에 보이는 텍스트 입니다. attachment 블록에는 나타나지 않습니다"
attachments_dict['text'] = "본문 텍스트! 5줄이 넘어가면 *show more*로 보이게 됩니다."
attachments_dict['mrkdwn_in'] = ["text", "pretext"]  # 마크다운을 적용시킬 인자들을 선택합니다.
attachments = [attachments_dict]

slack.chat.post_message(channel="#channel", text=None, attachments=attachments, as_user=True)

결과는 다음과 같습니다.

slack-bot-attachments-message

RTM을 이용한 메세지 주고 받기

메세지는 Real Time Message API를 통해서 주고 받을 수 있습니다. Websocket이 필요하므로 websocket-client를 사용하겠습니다.

메세지 받기

import websocket

response = slack.rtm.start()
sock_endpoint = response.body['url']
slack_socket = websocket.create_connection(endpoint)

slack_socket.recv()

slack.rtm.start()로 wss가 담긴 주소를 받고 연결하면 됩니다. recv()는 다음과 같은 json 형태로 반환합니다.

{
    "type": "message",
    "ts": "1358878749.000002",
    "user": "U023BECGF",
    "text": "Hello"
}

메세지 보내기

REST API로도 메세지를 보낼 수 있지만 RTM을 사용해서도 메세지를 보낼 수 있습니다. json형태로 다음과 같이 발송하면 됩니다.

import json

message_dict = {'id': '1', 'type': 'message', 'channel': 'C024BE91L', 'text': 'Hello, World!'}
slack_socket.send(json.dumps(message_dict))

channel부분에는 Group ID이나 DM channel ID가 필요합니다. rtm.start()이나 im.list()의 response에서 확인할 수 있습니다.

비동기 사용하기

python 3.5 이상 버전이 필요합니다. 3.3이나 3.4에서 적용할 경우 여기를 참고해주세요.

소켓으로 recv()를 호출했을 때 기본적으로는 blocking 모드로 동작합니다. 이는 소켓 버퍼에서 읽을 데이터가 없으면 새로운 데이터가 들어올 때까지 다음 코드로 진행하지 않는다는 것을 뜻합니다. 이에 코루틴을 사용하는 asycnio와 websockets를 사용해서 비동기를 구현해서 메세지를 수신할 동안 다른 작업을 할 수 있게 해줍니다.

여기서 사용하는 websockets는 위에서 소켓 통신 할 때 사용했던 websocket-client가 아닌 websockets를 사용합니다.

import asyncio
import websockets

async def execute_bot():
    ws = await websockets.connect(endpoint)
    while True:
        message_json = await ws.recv()
        print(message_json)

loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
asyncio.get_event_loop().run_until_complete(execute_bot())
asyncio.get_event_loop().run_forever()

python 3.5에서 추가된 async와 await로 간단하게 소켓의 connect()와 recv()를 비동기로 사용할 수 있습니다.

더 자세한 기능은?

slacker github 페이지의 documentation은 단 한 줄 적혀있습니다. https://api.slack.com/methods.

슬랙 API 도큐먼트를 링크 걸만큼 슬랙 API처럼 잘 만들어두었기도 하고, 간편하게 사용할 수 있다는 점에서 괜찮은 라이브러리라 생각합니다.