Implement HITLBranchOperator

[Lee-W]

Body

Why

AIP-90

What

Implement HITLBranchOperator.execute_complete

How

Implementation

Now we have

airflow/providers/standard/src/airflow/providers/standard/operators/hitl.py

Line 214 in 8bee736

class HITLBranchOperator(HITLOperator):

in the main branch, we can start developing the

airflow/providers/standard/src/airflow/providers/standard/operators/hitl.py

Lines 220 to 221 in 8bee736

	def execute_complete(self, context: Context, event: dict[str, Any]) -> None:
	raise NotImplementedError

method.

We should retrieve the response from the user like

airflow/providers/standard/src/airflow/providers/standard/operators/hitl.py

Lines 182 to 183 in 8bee736

	def execute_complete(self, context: Context, event: dict[str, Any]) -> Any:
	ret = super().execute_complete(context=context, event=event)

and retrieve the chosen_options ret["chosen_options"]

For the class itself, it needs to inherit from BranchMixIn, and set the class variable inherits_from_skipmixin = True

We'll end up have something like the following

class HITLBranchOperator(HITLOperator, BranchMixIn):
    inherits_from_skipmixin = True

    def execute_complete(self, context: Context, event: dict[str, Any]) -> Any:
        ret = super().execute_complete(context=context, event=event)
        chosen_options = res["chosen_options"]
        return self.do_branch(context=context, branches_to_execute=chosen_options)

After it's implemented and tested, we'll need to add test cases here https://github.com/apache/airflow/blob/main/providers/standard/tests/unit/standard/operators/test_hitl.py

Example dag for all HITL operators will be handled by @Lee-W in another PR

End-to-end test

Please refer to #52868 (comment) and change the operator to HITLBranchOperator

Committer

• I acknowledge that I am a maintainer/committer of the Apache Airflow project.

[Lee-W]

The description has been updated with more details. Thanks!

[Lee-W]

Hey @phanikumv , please let me know if the description works for you 😄 I'll be able to take a look at the PR this weekend

[Lee-W]

Hey @sunank200, it would be great if you could focus on #52202 first. If you haven't had the chance to dig into this one yet, I’d be happy to jump in and help out. Thanks!