You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2022/01/03 12:07:11 UTC
[GitHub] [airflow] eladkal commented on a change in pull request #20542: [Part 1]: Add hook for integrating with Google Calendar
eladkal commented on a change in pull request #20542:
URL: https://github.com/apache/airflow/pull/20542#discussion_r777436293
##########
File path: airflow/providers/google/suite/hooks/calendar.py
##########
@@ -0,0 +1,239 @@
+#
+# 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 Calendar API hook"""
+
+from datetime import datetime
+from typing import Any, Dict, Optional, Sequence, Union
+
+from googleapiclient.discovery import build
+
+from airflow.exceptions import AirflowException
+from airflow.providers.google.common.hooks.base_google import GoogleBaseHook
+
+
+class GoogleCalendarHook(GoogleBaseHook):
+ """
+ Interact with Google Calendar via Google Cloud connection
+ Reading and writing cells in Google Sheet:
+ https://developers.google.com/calendar/api/v3/reference
+
+ :param gcp_conn_id: The connection ID to use when fetching connection info.
+ :type gcp_conn_id: str
+ :param api_version: API Version
+ :type api_version: str
+ :param delegate_to: The account to impersonate using domain-wide delegation of authority,
+ if any. For this to work, the service account making the request must have
+ domain-wide delegation enabled.
+ :type delegate_to: str
+ :param impersonation_chain: Optional service account to impersonate using short-term
+ credentials, or chained list of accounts required to get the access_token
+ of the last account in the list, which will be impersonated in the request.
+ If set as a string, the account must grant the originating account
+ the Service Account Token Creator IAM role.
+ If set as a sequence, the identities from the list must grant
+ Service Account Token Creator IAM role to the directly preceding identity, with first
+ account from the list granting this role to the originating account.
+ :type impersonation_chain: Union[str, Sequence[str]]
+ """
+
+ def __init__(
+ self,
+ api_version: str,
+ gcp_conn_id: str = 'google_cloud_default',
+ delegate_to: Optional[str] = None,
+ impersonation_chain: Optional[Union[str, Sequence[str]]] = None,
+ ) -> None:
+ super().__init__(
+ gcp_conn_id=gcp_conn_id,
+ delegate_to=delegate_to,
+ impersonation_chain=impersonation_chain,
+ )
+ self.gcp_conn_id = gcp_conn_id
+ self.api_version = api_version
+ self.delegate_to = delegate_to
+ self._conn = None
+
+ def get_conn(self) -> Any:
+ """
+ Retrieves connection to Google Calendar.
+
+ :return: Google Calendar services object.
+ :rtype: Any
+ """
+ if not self._conn:
+ http_authorized = self._authorize()
+ self._conn = build('calendar', self.api_version, http=http_authorized, cache_discovery=False)
+
+ return self._conn
+
+ def get_events(
+ self,
+ calendar_id: str = 'primary',
+ i_cal_uid: Optional[str] = None,
+ max_attendees: Optional[int] = None,
+ max_results: Optional[int] = None,
+ order_by: Optional[str] = None,
+ private_extended_property: Optional[str] = None,
+ q: Optional[str] = None,
+ shared_extended_property: Optional[str] = None,
+ show_deleted: Optional[bool] = False,
+ show_hidden_invitation: Optional[bool] = False,
+ single_events: Optional[bool] = False,
+ sync_token: Optional[str] = None,
+ time_max: Optional[datetime] = None,
+ time_min: Optional[datetime] = None,
+ time_zone: Optional[str] = None,
+ updated_min: Optional[datetime] = None,
+ ) -> list:
+ """
+ Gets events from Google Calendar from a single calendar_id
+ https://developers.google.com/calendar/api/v3/reference/events/list
+
+ :param calendar_id: The Google Calendar ID to interact with
+ :type calendar_id: str
+ :param i_cal_uid: Optional. Specifies event ID in the iCalendar format in the response.
+ :type i_cal_uid: str
+ :param max_attendees: Optional. If there are more than the specified number of attendees,
+ only the participant is returned.
+ :type max_attendees: int
+ :param max_results: Optional. Maximum number of events returned on one result page.
+ Incomplete pages can be detected by a non-empty nextPageToken field in the response.
+ By default the value is 250 events. The page size can never be larger than 2500 events
+ :type max_results: int
+ :param order_by: Optional. Acceptable values are "startTime" or "updated"
+ :type order_by: str
+ :param private_extended_property: Optional. Extended properties constraint specified as
+ propertyName=value. Matches only private properties. This parameter might be repeated
+ multiple times to return events that match all given constraints.
+ :type private_extended_property: str
+ :param q: Optional. Free text search.
+ :type q: str
+ :param shared_extended_property: Optional. Extended properties constraint specified as
+ propertyName=value. Matches only shared properties. This parameter might be repeated
+ multiple times to return events that match all given constraints.
+ :type shared_extended_property: str
+ :param show_deleted: Optional. False by default
+ :type show_deleted: bool
+ :param show_hidden_invitation: Optional. False by default
+ :type show_hidden_invitation: bool
+ :param single_events: Optional. False by default
+ :type single_events: bool
+ :param sync_token: Optional. Token obtained from the nextSyncToken field returned
+ :type sync_token: str
+ :param time_max: Optional. Upper bound (exclusive) for an event's start time to filter by.
+ Default is no filter
+ :type time_max: datetime
+ :param time_min: Optional. Lower bound (exclusive) for an event's end time to filter by.
+ Default is no filter
+ :type time_min: datetime
+ :param time_zone: Optional. Time zone used in response. Default is calendars time zone.
+ :type time_zone: str
+ :param updated_min: Optional. Lower bound for an event's last modification time
+ :type updated_min: datetime
+ :rtype: List
+ """
+ service = self.get_conn()
+ page_token = None
+ events = []
+ while True:
+ response = (
+ service.events()
+ .list(
+ calendarId=calendar_id,
+ iCalUID=i_cal_uid,
+ maxAttendees=max_attendees,
+ maxResults=max_results,
+ orderBy=order_by,
+ pageToken=page_token,
+ privateExtendedProperty=private_extended_property,
+ q=q,
+ sharedExtendedProperty=shared_extended_property,
+ showDeleted=show_deleted,
+ showHiddenInvitations=show_hidden_invitation,
+ singleEvents=single_events,
+ syncToken=sync_token,
+ timeMax=time_max,
+ timeMin=time_min,
+ timeZone=time_zone,
+ updatedMin=updated_min,
+ )
+ .execute(num_retries=self.num_retries)
+ )
+ events.extend(response["items"])
+ page_token = response.get("nextPageToken")
+ if not page_token:
+ break
+ return events
+
+ def create_event(
+ self,
+ event: Dict[str, Any],
+ calendar_id: str = 'primary',
+ conference_data_version: Optional[int] = 0,
+ max_attendees: Optional[int] = None,
+ send_notifications: Optional[bool] = False,
+ send_updates: Optional[str] = 'false',
+ supports_attachments: Optional[bool] = False,
+ ) -> dict:
+ """
+ Create event on the specified calendar
+ https://developers.google.com/calendar/api/v3/reference/events/insert
+
+ :param calendar_id: The Google Calendar ID to interact with
+ :type calendar_id: str
+ :param conference_data_version: Optional. Version number of conference data
+ supported by the API client.
+ :type conference_data_version: int
+ :param max_attendees: Optional. If there are more than the specified number of attendees,
+ only the participant is returned.
+ :type max_attendees: int
+ :param send_notifications: Optional. Default is False
+ :type send_notifications: bool
+ :param send_updates: Optional. Default is "false". Acceptable values as "all", "none",
+ "externalOnly"
+ :type send_updates: str
+ :type supports_attachments: Optional. Default is False
+ :type supports_attachments: bool
+ :type event: Required. Request body of Events resource. Start and End are required
+ https://developers.google.com/calendar/api/v3/reference/events#resource
+ :type event: dict
+ :rtype: Dict
+ """
+ if "start" not in event or "end" not in event:
+ raise AirflowException(
+ "start and end must be specified in the event body while creating an event. "
+ "Refer https://developers.google.com/calendar/api/v3/reference/events/insert "
Review comment:
We probably want to replace `v3` with the api version the user set
##########
File path: airflow/providers/google/suite/hooks/calendar.py
##########
@@ -0,0 +1,239 @@
+#
+# 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 Calendar API hook"""
+
+from datetime import datetime
+from typing import Any, Dict, Optional, Sequence, Union
+
+from googleapiclient.discovery import build
+
+from airflow.exceptions import AirflowException
+from airflow.providers.google.common.hooks.base_google import GoogleBaseHook
+
+
+class GoogleCalendarHook(GoogleBaseHook):
+ """
+ Interact with Google Calendar via Google Cloud connection
+ Reading and writing cells in Google Sheet:
+ https://developers.google.com/calendar/api/v3/reference
+
+ :param gcp_conn_id: The connection ID to use when fetching connection info.
+ :type gcp_conn_id: str
+ :param api_version: API Version
+ :type api_version: str
+ :param delegate_to: The account to impersonate using domain-wide delegation of authority,
+ if any. For this to work, the service account making the request must have
+ domain-wide delegation enabled.
+ :type delegate_to: str
+ :param impersonation_chain: Optional service account to impersonate using short-term
+ credentials, or chained list of accounts required to get the access_token
+ of the last account in the list, which will be impersonated in the request.
+ If set as a string, the account must grant the originating account
+ the Service Account Token Creator IAM role.
+ If set as a sequence, the identities from the list must grant
+ Service Account Token Creator IAM role to the directly preceding identity, with first
+ account from the list granting this role to the originating account.
+ :type impersonation_chain: Union[str, Sequence[str]]
+ """
+
+ def __init__(
+ self,
+ api_version: str,
+ gcp_conn_id: str = 'google_cloud_default',
+ delegate_to: Optional[str] = None,
+ impersonation_chain: Optional[Union[str, Sequence[str]]] = None,
+ ) -> None:
+ super().__init__(
+ gcp_conn_id=gcp_conn_id,
+ delegate_to=delegate_to,
+ impersonation_chain=impersonation_chain,
+ )
+ self.gcp_conn_id = gcp_conn_id
+ self.api_version = api_version
+ self.delegate_to = delegate_to
+ self._conn = None
+
+ def get_conn(self) -> Any:
+ """
+ Retrieves connection to Google Calendar.
+
+ :return: Google Calendar services object.
+ :rtype: Any
+ """
+ if not self._conn:
+ http_authorized = self._authorize()
+ self._conn = build('calendar', self.api_version, http=http_authorized, cache_discovery=False)
+
+ return self._conn
+
+ def get_events(
+ self,
+ calendar_id: str = 'primary',
+ i_cal_uid: Optional[str] = None,
+ max_attendees: Optional[int] = None,
+ max_results: Optional[int] = None,
+ order_by: Optional[str] = None,
+ private_extended_property: Optional[str] = None,
+ q: Optional[str] = None,
+ shared_extended_property: Optional[str] = None,
+ show_deleted: Optional[bool] = False,
+ show_hidden_invitation: Optional[bool] = False,
+ single_events: Optional[bool] = False,
+ sync_token: Optional[str] = None,
+ time_max: Optional[datetime] = None,
+ time_min: Optional[datetime] = None,
+ time_zone: Optional[str] = None,
+ updated_min: Optional[datetime] = None,
+ ) -> list:
+ """
+ Gets events from Google Calendar from a single calendar_id
+ https://developers.google.com/calendar/api/v3/reference/events/list
+
+ :param calendar_id: The Google Calendar ID to interact with
+ :type calendar_id: str
+ :param i_cal_uid: Optional. Specifies event ID in the iCalendar format in the response.
+ :type i_cal_uid: str
+ :param max_attendees: Optional. If there are more than the specified number of attendees,
+ only the participant is returned.
+ :type max_attendees: int
+ :param max_results: Optional. Maximum number of events returned on one result page.
+ Incomplete pages can be detected by a non-empty nextPageToken field in the response.
Review comment:
```suggestion
Incomplete pages can be detected by a non-empty ``nextPageToken`` field in the response.
```
I think that this way you won't need to add this word to the spelling list. can you verify?
##########
File path: airflow/providers/google/suite/hooks/calendar.py
##########
@@ -0,0 +1,239 @@
+#
+# 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 Calendar API hook"""
+
+from datetime import datetime
+from typing import Any, Dict, Optional, Sequence, Union
+
+from googleapiclient.discovery import build
+
+from airflow.exceptions import AirflowException
+from airflow.providers.google.common.hooks.base_google import GoogleBaseHook
+
+
+class GoogleCalendarHook(GoogleBaseHook):
+ """
+ Interact with Google Calendar via Google Cloud connection
+ Reading and writing cells in Google Sheet:
+ https://developers.google.com/calendar/api/v3/reference
+
+ :param gcp_conn_id: The connection ID to use when fetching connection info.
+ :type gcp_conn_id: str
+ :param api_version: API Version
+ :type api_version: str
+ :param delegate_to: The account to impersonate using domain-wide delegation of authority,
+ if any. For this to work, the service account making the request must have
+ domain-wide delegation enabled.
+ :type delegate_to: str
+ :param impersonation_chain: Optional service account to impersonate using short-term
+ credentials, or chained list of accounts required to get the access_token
+ of the last account in the list, which will be impersonated in the request.
+ If set as a string, the account must grant the originating account
+ the Service Account Token Creator IAM role.
+ If set as a sequence, the identities from the list must grant
+ Service Account Token Creator IAM role to the directly preceding identity, with first
+ account from the list granting this role to the originating account.
+ :type impersonation_chain: Union[str, Sequence[str]]
+ """
+
+ def __init__(
+ self,
+ api_version: str,
+ gcp_conn_id: str = 'google_cloud_default',
+ delegate_to: Optional[str] = None,
+ impersonation_chain: Optional[Union[str, Sequence[str]]] = None,
+ ) -> None:
+ super().__init__(
+ gcp_conn_id=gcp_conn_id,
+ delegate_to=delegate_to,
+ impersonation_chain=impersonation_chain,
+ )
+ self.gcp_conn_id = gcp_conn_id
+ self.api_version = api_version
+ self.delegate_to = delegate_to
+ self._conn = None
+
+ def get_conn(self) -> Any:
+ """
+ Retrieves connection to Google Calendar.
+
+ :return: Google Calendar services object.
+ :rtype: Any
+ """
+ if not self._conn:
+ http_authorized = self._authorize()
+ self._conn = build('calendar', self.api_version, http=http_authorized, cache_discovery=False)
+
+ return self._conn
+
+ def get_events(
+ self,
+ calendar_id: str = 'primary',
+ i_cal_uid: Optional[str] = None,
+ max_attendees: Optional[int] = None,
+ max_results: Optional[int] = None,
+ order_by: Optional[str] = None,
+ private_extended_property: Optional[str] = None,
+ q: Optional[str] = None,
+ shared_extended_property: Optional[str] = None,
+ show_deleted: Optional[bool] = False,
+ show_hidden_invitation: Optional[bool] = False,
+ single_events: Optional[bool] = False,
+ sync_token: Optional[str] = None,
+ time_max: Optional[datetime] = None,
+ time_min: Optional[datetime] = None,
+ time_zone: Optional[str] = None,
+ updated_min: Optional[datetime] = None,
+ ) -> list:
+ """
+ Gets events from Google Calendar from a single calendar_id
+ https://developers.google.com/calendar/api/v3/reference/events/list
+
+ :param calendar_id: The Google Calendar ID to interact with
+ :type calendar_id: str
+ :param i_cal_uid: Optional. Specifies event ID in the iCalendar format in the response.
Review comment:
What is iCalendar?
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org