helper.slack_message_api module

slackにメッセージを送る

class helper.slack_message_api.SlackMessageAPI(access_token: str, json_path: str = 'D:\\git\\igaponr\\training\\python\\Web_scraping\\helper\\..\\json\\slack_message_api_config.json', client: WebClient = None)[ソース]

ベースクラス: object

Slackの設定情報を管理して、メッセージを送信するクラス。 access_tokenを指定せず、jsonファイルからaccess_tokenが読み込めない場合はアプリ終了する

パラメータ:
  • access_token (str) -- (省略可)Slack API のトークンを指定する。指定しない場合はJSONファイルから読み込む

  • json_path (str) -- (省略可)設定情報を保存するjsonファイルのパス

  • client (WebClient) -- (省略可)Slack Clientのインスタンス

戻り値:

インスタンス

戻り値の型:

SlackMessageAPI

access_token: str
client: WebClient = None
json_path: str = 'D:\\git\\igaponr\\training\\python\\Web_scraping\\helper\\..\\json\\slack_message_api_config.json'
classmethod load_from_json(json_path: str | None = None) SlackMessageAPI[ソース]

JSONファイルから設定情報を読み込み、インスタンスを生成する

パラメータ:

json_path (str) -- (省略可)JSONファイルのパス。指定しない場合は、デフォルトのパスを使用する

戻り値:

インスタンス

戻り値の型:

SlackMessageAPI

例外:

FileNotFoundError -- JSONファイルが見つからない、設定情報の保存に失敗した

save_to_json() None[ソース]

設定情報をJSONファイルに保存する。 設定情報の保存に失敗した場合は、エラーを表示して処理を継続する

send_message(_channel_id: str, _message: str) bool[ソース]

Slackにメッセージを送信する

パラメータ:
  • _channel_id (str) -- 送信先のチャンネルID

  • _message (str) -- 送信するメッセージ

戻り値:

送信に成功した場合はTrue、失敗した場合はFalseを返す

戻り値の型:

bool

helper.slack_message_api.get_option()[ソース]

オプションをパースする

戻り値:

オプションのパース結果

戻り値の型:

Namespace