Pythonサンプルコード集

【Python+Slackbot】Slackに入力した内容を記録する方法

本記事ではSlackに入力した内容をPython+Slackbotにログとして記録させる方法を紹介します。

Slackは無料プランだと10,000コメントしか保持できません。
また、有料プランの場合でも欲しい情報を探すのも意外に手間がかかります。

必要な情報だけ都度他のドキュメントに転記する面倒ですが、Slackbotを活用すればSlackに入力した内容をログとして出力可能です。

入力した内容が自動的に記録できれば手間を大幅に削減できるので、是非活用してみてください。

PythonでのSlackbot実装の基本については「SlackbotをPythonで作成しよう」をお読みください。

Python+Slackbotでファイルに書き込む方法使用

Python+Slackでファイルに書き込む方法はいくつかありますが、今回はcodecsライブラリを使用して書き込みを行います。

サンプルコードは以下の通りです。
◆filereadwrite.pyの記述内容

codecsライブラリの基本的な使い方については「「codecs」の使い方〜Pythonのファイル読み書きの基本と実装例〜」をお読みください。

関連記事>>Slackbotでファイルの読み書きをしよう

Slackに投稿した内容をBotに記録する方法

slackbotライブラリのデコレーター「@listen_to」を使用します。
読み取り内容を正規表現「^(.*)$」とすることで入力した全てのメッセージを受け取ることが可能です。

◆Botにおうむ返しさせる

Slackに投稿した内容を記録する

受け取ったコメントを書き込む

受け取ったコメントを書き込む処理は以下の通りです。

◆記述例

◆実行結果
受け取ったコメントを書き込む

◆ファイルの内容

テスト

◆注意事項
・Slackbotに記録させるため、Slackbotが起動している時のみ記録されます。
・Slackbotが応答した内容は記録されません。
・コメントの編集内容は記録できません。

ファイルに書き込む時に改行を入れておかないと次に文字を入力した時に続けて文字が出力されてしまいます。

改行がない場合

テストテスト

改行がある場合

テスト
テスト

◆改行は文頭と文末のどちらが良い?
改行は文頭に入れる方法と文末に入れる方法があります。
先頭に改行を入れた場合最初にファイルを作成した時に1行目が空きます。
(1行目が空いていてもその後の動作に特に影響はありません)

末尾に入れる場合、ファイルの文末に改行がないと改行されずに前の文章に続けて出力されます。

どちらに入れる場合でもルールを明確にしておけば特に問題はありません。
作成するプログラムに合わせて都合のいい方に入れましょう

Slackbotで時刻・ユーザー・チャンネルの情報も出力する

テキストだけ出力するのも味気ないので他の情報も出力するように改造について、以下の内容を追加で出力する例を説明します。

・コメント投稿の時刻
・ユーザー名
・チャンネル

時刻を出力する

時刻は「datetime」ライブラリを使用することで表示可能です。
strftime()メソッドでフォーマットを調整できます。

import datetime
# 現在時刻の取得
now = datetime.datetime.now()
# 時刻を文字列に変換する
str_now = now.strftime("%Y/%m/%d %H:%M:%S")

ユーザー名を取得する

ユーザー名は「message」に格納されている情報を使用します。
ユーザー名はいくつか種類がありますが、今回はプロフィール上に表示される名前である「'real_name'」とSlack上に表示される「'display_name'」を取得する例です。

# 名前を取得する
real_name = message.user['real_name'] # 表示名を取得する
display_name = message.user['profile']['display_name']

チャンネルを取得する

チャンネルは「message」に格納されている情報を使用します。

# チャンネル名を取得
channel = message.channel._body['name']

以上をまとめたデータはコードは以下の通りです。

CSVファイルやEXCELで扱いやすいようにカンマ区切りにしています。

ログの取得範囲を限定する

上記の内容だとSlackbotのいるチャンネルでコメントした内容が全て記録されます。

全ての会話を記録してしまうとノイズも多くなってしまうため、管理がしにくいです。

取得するチャンネルやユーザーを制限することで、記録する内容を限定していきましょう。

ログを取るチャンネルを限定する

ログを取得するチャンネルを限定する方法について説明します。

「target_channels」というリストを用意しておき、メッセージを投稿したチャンネル名がリストに含まれていた場合は終了します。
チャンネルの情報は「message.channel」オブジェクトに設定されている為この値を使用します。

チャンネルを限定する記述は以下の通りです。

ログを取るユーザーを限定する

ログを取得するユーザーを限定する方法について説明します。

チャンネルの時と同様に「target_users」というリストを用意しておき、投稿者と一致するかどうかをチェックします。
ユーザー情報は「message.user」オブジェクトに格納されています。

◆名前と表示名
プロフィールにある名前(real_name)の他に表示名(display_name)でもチェックできるようにします。
表示名は任意の為、名前か表示名のどちらかにヒットすればOKとします。

以上をまとめたデータはコードは以下の通りです。

以上、ファイルを記録する方法でした。

Slack+PythonまとめTOP>>Slackbotの作り方マニュアル〜Python編〜

こちらの記事も読まれています

  • この記事を書いた人
miyabikno

miyabikno

住んでいるところ:神奈川県。 SIer中小企業(C,VBA):8年(うち5年QA)。Web系ベンチャー(PHP,Javascript,Python):2年。フリーランス:2年。現在はブログをメインに活動しています。

-Pythonサンプルコード集
-

Copyright© みやびのどっとぴーわい , 2020 All Rights Reserved Powered by AFFINGER5.