zhongjiajie commented on a change in pull request #4895: [AIRFLOW-1526] Add dingding hook and operator URL: https://github.com/apache/airflow/pull/4895#discussion_r264090337
########## File path: airflow/contrib/hooks/dingding_webhook_hook.py ########## @@ -0,0 +1,132 @@ +# -*- coding: utf-8 -*- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +import json + +from airflow import AirflowException +from airflow.hooks.http_hook import HttpHook + + +class DingdingWebhookHook(HttpHook): + """ + This hook allows you to post messages to Dingding use webhook. + Given either manually token or http_conn_id has ``webhook_token`` as extra could work, + if both of them are specific will use manual one. + + For more message detail in + `Dingding custom bot <https://open-doc.dingtalk.com/microapp/serverapi2/qf2nxq>`_ + + :param http_conn_id: connection that has Dingding ``webhook_token`` in the extra field + :type http_conn_id: str + :param webhook_token: Dingding webhook token + :type webhook_token: str + :param message_type: Message type you want to send to Dingding + support text/link/markdown/actionCard/feedCard five types so far + :type message_type: str + :param message: The message you want to send on Dingding + :type message: str or dict + :param at_mobiles: Users you want to remind at this message. + :type at_mobiles: list of str + :param at_all: Should remind all people in group or not. If True, will overwrite ``at_mobiles`` + :type at_all: bool + """ + + def __init__(self, + http_conn_id='dingding_webhook_default', + webhook_token=None, + message_type='text', + message=None, + at_mobiles=False, + at_all=False, + *args, + **kwargs + ): + super(DingdingWebhookHook, self).__init__(*args, **kwargs) + self.http_conn_id = http_conn_id + self.endpoint = self._get_endpoint(webhook_token, http_conn_id) + self.message_type = message_type + self.message = message + self.at_mobiles = at_mobiles + self.at_all = at_all + + def _get_endpoint(self, manual_token, http_conn_id): + """ + Get Dingding endpoint for sending message. If both ``manual_token`` and + ``http_conn_id`` specific, use ``manual_token`` + + :param manual_token: Manually provided token + :type manual_token: str + :param http_conn_id: http_conn_id provided + :type http_conn_id: str + """ + if manual_token: + token = manual_token + elif http_conn_id: + conn = self.get_connection(http_conn_id) + extra = conn.extra_dejson + token = extra.get('webhook_token') + else: + raise AirflowException('Cannot get token: No valid Dingding ' + 'webhook token nor http_conn_id supplied') + return 'robot/send?access_token={}'.format(token) + + def _build_message(self): + """ + Build different type of Dingding message + As most commonly used type, text message just need post message content + rather than a dict like ``{'content': 'message'}`` + """ + if self.message_type in ['text', 'markdown']: + data = { + 'msgtype': self.message_type, + self.message_type: { + 'content': self.message + } if self.message_type == 'text' else self.message, + 'at': { + 'atMobiles': self.at_mobiles, + 'isAtAll': self.at_all + } + } + else: + data = { + 'msgtype': self.message_type, + self.message_type: self.message + } + return json.dumps(data) + + def send(self): Review comment: I think is a monor change, I will keep the old function name. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
