mik-laj commented on a change in pull request #5845: [AIRFLOW-5158] adds google sheets hook URL: https://github.com/apache/airflow/pull/5845#discussion_r317264294
########## File path: airflow/gcp/hooks/gsheets.py ########## @@ -0,0 +1,367 @@ +# -*- 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. +# +""" +This module contains a Google Sheets API hook +""" + +from googleapiclient.discovery import build +from airflow.contrib.hooks.gcp_api_base_hook import GoogleCloudBaseHook +from airflow.exceptions import AirflowException + + +class GSheetsHook(GoogleCloudBaseHook): + """ + Interact with Google Sheets via GCP connection + Reading and writing cells in Google Sheet: + https://developers.google.com/sheets/api/guides/values + + :param gcp_conn_id: The connection ID to use when fetching connection info. + :type gcp_conn_id: str + :param spreadsheet_id: The Google Sheet ID to interact with + :type spreadsheet_id: str + :param api_version: API Version + :type api_version: str + :param delegate_to: The account to impersonate, if any. + For this to work, the service account making the request must have + domain-wide delegation enabled. + :type delegate_to: str + """ + + def __init__( + self, + spreadsheet_id: str, + gcp_conn_id: str = 'google_cloud_default', + api_version: str = 'v4', + delegate_to: str = None + ) -> None: + super().__init__(gcp_conn_id, delegate_to) + self.spreadsheet_id = spreadsheet_id + self.gcp_conn_id = gcp_conn_id + self.api_version = api_version + self.delegate_to = delegate_to + self.num_retries = self._get_field('num_retries', 5) + self._conn = None + + def get_conn(self): + """ + Retrieves connection to Google Sheets. + :return: Google Sheets services object. + :rtype: dict + """ + if not self._conn: + http_authorized = self._authorize() + self._conn = build('sheets', self.api_version, http=http_authorized, cache_discovery=False) + + return self._conn + + @GoogleCloudBaseHook.catch_http_exception + def get_values( + self, + range_: str, + major_dimension: str = 'DIMENSION_UNSPECIFIED', + value_render_option: str = 'FORMATTED_VALUE', + date_time_render_option: str = 'SERIAL_NUMBER' + ) -> dict: + """ + Gets values from Google Sheet from a single range + https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/get + + :param range_: The A1 notation of the values to retrieve. + :type range_: str + :param major_dimension: Indicates which dimension an operation should apply to. + DIMENSION_UNSPECIFIED, ROWS, or COLUMNS + :type major_dimension: str + :param value_render_option: Determines how values should be rendered in the output. + FORMATTED_VALUE, UNFORMATTED_VALUE, or FORMULA + :type value_render_option: str + :param date_time_render_option: Determines how dates should be rendered in the output. + SERIAL_NUMBER or FORMATTED_STRING + :type date_time_render_option: str + :return: Google Sheets API response. + :rtype: dict + """ + service = self.get_conn() + response = service.spreadsheets().values().get( # pylint: disable=no-member + spreadsheetId=self.spreadsheet_id, + range=range_, + majorDimension=major_dimension, + valueRenderOption=value_render_option, + dateTimeRenderOption=date_time_render_option + ).execute(num_retries=self.num_retries) + + return response + + @GoogleCloudBaseHook.catch_http_exception + def batch_get_values( + self, + ranges: list, + major_dimension: str = 'DIMENSION_UNSPECIFIED', + value_render_option: str = 'FORMATTED_VALUE', + date_time_render_option: str = 'SERIAL_NUMBER' + ) -> dict: + """ + Gets values from Google Sheet from a list of ranges + https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/batchGet + + :param ranges: The A1 notation of the values to retrieve. + :type ranges: list + :param major_dimension: Indicates which dimension an operation should apply to. + DIMENSION_UNSPECIFIED, ROWS, or COLUMNS + :type major_dimension: str + :param value_render_option: Determines how values should be rendered in the output. + FORMATTED_VALUE, UNFORMATTED_VALUE, or FORMULA + :type value_render_option: str + :param date_time_render_option: Determines how dates should be rendered in the output. + SERIAL_NUMBER or FORMATTED_STRING + :type date_time_render_option: str + :return: Google Sheets API response. + :rtype: dict + """ + service = self.get_conn() + response = service.spreadsheets().values().batchGet( # pylint: disable=no-member + spreadsheetId=self.spreadsheet_id, + ranges=ranges, + majorDimension=major_dimension, + valueRenderOption=value_render_option, + dateTimeRenderOption=date_time_render_option + ).execute(num_retries=self.num_retries) + + return response + + @GoogleCloudBaseHook.catch_http_exception + def update_values( + self, + range_: str, + values: list, Review comment: ```suggestion values: List, ``` ---------------------------------------------------------------- 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
