`TimeDeltaSensorAsync` vs `TimeDeltaSensor(deferrable=True)`

[fritz-astronomer]

Description

I noticed that this sensor doesn't match the implementation that seems more common in the code base

TimeDeltaSensor
TimeDeltaSensorAsync

I'd expect TimeDeltaSensor(deferrable=True), to match the pattern most other operators have.
Admittedly - I haven't checked to see if the behavior is different to explain an intentional difference, or if this was oversight.

Use case/motivation

No response

Related issues

No response

Are you willing to submit a PR?

• Yes I am willing to submit a PR!

Code of Conduct

• I agree to follow this project's Code of Conduct

[Subham-KRLX]

@fritz-astronomer, I would like to work on this issue raising a pr regarding this.

[jroachgolf84]

@fritz-astronomer, can you explain this a bit more? From what I can tell, TimeDeltaSensorAsync is going to be removed in a future release, and the code base points to TimeDeltaSensor. What specifically about this Sensor isn't lining up?

[fritz-astronomer]

Oh! @jroachgolf84 , thanks!

I didn't see a notice of this anywhere in the docs, and am only now seeing this in the source code :/

# TODO: Remove in the next major release
@deprecated(
    "Use `TimeDeltaSensor` with `deferrable=True` instead", category=AirflowProviderDeprecationWarning
)
class TimeDeltaSensorAsync(TimeDeltaSensor):

You're entirely right - both that deferrable=True already exists and that TimeDeltaSensorAsync is deprecated for removal.

Maybe this could be a "improve docs" / make deprecation obvious issue/PR @Subham-KRLX ?

[jroachgolf84]

@fritz-astronomer, I think that's a great idea! A docs improvement would be awesome. @Subham-KRLX, would you be willing to take a shot at this?

[Subham-KRLX]

@fritz-astronomer @jroachgolf84 Thanks for the feedback! I have just pushed documentation improvements to this PR that make the deferrable=True pattern much more prominent.

The updated docs now include:

• Dedicated "Deferrable Mode (Recommended)" section with benefits
• Clear migration guidance from TimeDeltaSensorAsync
• Better visibility of when and why to use deferrable mode

Please take a look and let me know if any additional improvements are needed.

[jroachgolf84]

Can you link the PR here? Apologies, I see it now!