eladkal commented on a change in pull request #11964: URL: https://github.com/apache/airflow/pull/11964#discussion_r532194095
########## File path: airflow/operators/datetime_branch.py ########## @@ -0,0 +1,77 @@ +# 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 datetime +from typing import Dict, Iterable, Optional, Union + +from airflow.exceptions import AirflowException +from airflow.operators.branch_operator import BaseBranchOperator +from airflow.utils import timezone +from airflow.utils.decorators import apply_defaults + + +class DateTimeBranchOperator(BaseBranchOperator): + """ + Branches into one of two lists of tasks depending on the current datetime. + + True branch will be returned when `datetime.datetime.now()` falls below + `target_upper` and above `target_lower`. + + :param follow_task_ids_if_true: task id or task ids to follow if + `datetime.datetime.now()` falls above target_lower and below `target_upper`. + :type follow_task_ids_if_true: str or list[str] + :param follow_task_ids_if_false: task id or task ids to follow if + `datetime.datetime.now()` falls below target_lower or above `target_upper`. + :type follow_task_ids_if_false: str or list[str] + :param target_lower: target lower bound. + :type target_lower: Optional[datetime.datetime] + :param target_upper: target upper bound. + :type target_upper: Optional[datetime.datetime] + """ + + @apply_defaults + def __init__( + self, + *, + follow_task_ids_if_true: Union[str, Iterable[str]], + follow_task_ids_if_false: Union[str, Iterable[str]], + target_lower: Optional[datetime.datetime], + target_upper: Optional[datetime.datetime], Review comment: yeah I think the `Optional[Union[datetime.datetime, datetime.time]]` approach is better as it simplify the usage for the users but maybe worth asking for more opinions on this one. note that there are edge cases for example lower is 23:00 and upper is 01:00 (the next day) so the duration of success is total of 2 hours yet it spread over two dates. Also it will be good to add [documentation](https://github.com/apache/airflow/tree/master/docs/howto/operator) about this operator. you can use previous PRs to see examples https://github.com/apache/airflow/pull/11472 ---------------------------------------------------------------- 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]
