fix(tracing): ensure tracer.wrap preserves decorated function’s type #13906

zemek · 2025-07-07T21:10:04Z

This change reverts a regression introduced in #13480 where using @tracer.wrap() causes type checkers to infer the return type of decorated functions as Any instead of the actual return type.

Addresses #13637

Checklist

PR author has checked that all the criteria below are met
The PR description includes an overview of the change
The PR description articulates the motivation for the change
The change includes tests OR the PR description describes a testing strategy
The PR description notes risks associated with the change, if any
Newly-added code is easy to change
The change follows the library release note guidelines
The change includes or references documentation updates if necessary
Backport labels are set (if applicable)

Reviewer Checklist

Reviewer has checked that all the criteria below are met
Title is accurate
All changes are related to the pull request's stated goal
Avoids breaking API changes
Testing strategy adequately addresses listed risks
Newly-added code is easy to change
Release note makes sense to a user of the library
If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
Backport labels are set in a manner that is consistent with the release branch maintenance policy

brettlangdon · 2025-07-08T16:47:29Z

@zemek thanks for this contribution. We have a requirement that all contribution commits are signed, would you be able to update this PR to have signed commits?

If not, I'd be more than happy to make a clone PR and squash/sign the commits with my gpg key, and I can help make sure you are still listed as co-authored on the change.

zemek · 2025-07-08T17:06:28Z

@brettlangdon I believe I've signed the commits now, let me know if there's anything else I need to do. Thanks!

ddtrace/_trace/tracer.py

brettlangdon · 2025-07-08T17:28:34Z

Now there are some typing issues:

ddtrace/_trace/tracer.py:785: error: Incompatible return value type (got "_Wrapped[[VarArg(Any), KwArg(Any)], Any, [VarArg(Any), KwArg(Any)], Any]", expected "AnyCallable")  [return-value]
ddtrace/_trace/tracer.py:803: error: Incompatible return value type (got "_Wrapped[[VarArg(Any), KwArg(Any)], Any, [VarArg(Any), KwArg(Any)], Any]", expected "AnyCallable")  [return-value]

You can run these checks locally with:

./scripts/ddtest hatch run lint:checks
./scripts/ddtest hatch run lint:typing

ddtrace/_trace/tracer.py

zemek · 2025-07-08T18:37:07Z

Now there are some typing issues:

ddtrace/_trace/tracer.py:785: error: Incompatible return value type (got "_Wrapped[[VarArg(Any), KwArg(Any)], Any, [VarArg(Any), KwArg(Any)], Any]", expected "AnyCallable")  [return-value]
ddtrace/_trace/tracer.py:803: error: Incompatible return value type (got "_Wrapped[[VarArg(Any), KwArg(Any)], Any, [VarArg(Any), KwArg(Any)], Any]", expected "AnyCallable")  [return-value]

You can run these checks locally with:

./scripts/ddtest hatch run lint:checks
./scripts/ddtest hatch run lint:typing

Ok it looks like both

./scripts/ddtest hatch run lint:checks
./scripts/ddtest hatch run lint:typing

succeed now (other than some errors that codespell is reporting in unrelated files)

zemek · 2025-07-10T19:40:37Z

@brettlangdon it seems like the tests are failing that the DD_API_KEY is not set, but I'm not sure why my change would cause that?

Actually it looks like all ${{ secrets.* }} are just being rendered as empty string

brettlangdon · 2025-07-10T19:57:34Z

@brettlangdon it seems like the tests are failing that the DD_API_KEY is not set, but I'm not sure why my change would cause that?

Actually it looks like all ${{ secrets.* }} are just being rendered as empty string

Hey, sorry for the delay getting back to reviewing this PR. I'll try to set aside some time tomorrow to review again.

I need to do some magic to get CI to run your changes, since we don't allow access to CI secrets for non-employees.

ddtrace/_trace/tracer.py

zemek · 2025-07-11T19:06:53Z

@brettlangdon I see some tests failed in system-tests are those known to be flaky? I saw that some other PR's had the same errors:
https://github.com/DataDog/dd-trace-py/actions/runs/16221145773
https://github.com/DataDog/dd-trace-py/actions/runs/16210874121
https://github.com/DataDog/dd-trace-py/actions/runs/16205264531
https://github.com/DataDog/dd-trace-py/actions/runs/16204494733

(just want to make sure this wasn't due to my change)

brettlangdon · 2025-07-11T19:08:19Z

@brettlangdon I see some tests failed in system-tests are those known to be flaky? I saw that some other PR's had the same errors: https://github.com/DataDog/dd-trace-py/actions/runs/16221145773 https://github.com/DataDog/dd-trace-py/actions/runs/16210874121 https://github.com/DataDog/dd-trace-py/actions/runs/16205264531 https://github.com/DataDog/dd-trace-py/actions/runs/16204494733

(just want to make sure this wasn't due to my change)

I got it from here, I'll let you know if any changes are needed, these appear to be flaky jobs.

…13906) This change reverts a regression introduced in #13480 where using `@tracer.wrap()` causes type checkers to infer the return type of decorated functions as `Any` instead of the actual return type. Addresses #13637 ## Checklist - [x] PR author has checked that all the criteria below are met - The PR description includes an overview of the change - The PR description articulates the motivation for the change - The change includes tests OR the PR description describes a testing strategy - The PR description notes risks associated with the change, if any - Newly-added code is easy to change - The change follows the [library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Reviewer has checked that all the criteria below are met - Title is accurate - All changes are related to the pull request's stated goal - Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes - Testing strategy adequately addresses listed risks - Newly-added code is easy to change - Release note makes sense to a user of the library - If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment - Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) --------- Co-authored-by: Rachel Yang <rachel.yang@datadoghq.com> Co-authored-by: Brett Langdon <brett.langdon@datadoghq.com> (cherry picked from commit 65c54f6)

…13906) This change reverts a regression introduced in `@tracer.wrap()` causes type checkers to infer the return type of decorated functions as `Any` instead of the actual return type. Addresses #13637 - [x] PR author has checked that all the criteria below are met - The PR description includes an overview of the change - The PR description articulates the motivation for the change - The change includes tests OR the PR description describes a testing strategy - The PR description notes risks associated with the change, if any - Newly-added code is easy to change - The change follows the [library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) - [x] Reviewer has checked that all the criteria below are met - Title is accurate - All changes are related to the pull request's stated goal - Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes - Testing strategy adequately addresses listed risks - Newly-added code is easy to change - Release note makes sense to a user of the library - If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment - Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) --------- Co-authored-by: Joseph Zemek <jazemek@gmail.com> Co-authored-by: Rachel Yang <rachel.yang@datadoghq.com> Co-authored-by: Brett Langdon <brett.langdon@datadoghq.com>

…13906) This change reverts a regression introduced in #13480 where using `@tracer.wrap()` causes type checkers to infer the return type of decorated functions as `Any` instead of the actual return type. Addresses #13637 ## Checklist - [x] PR author has checked that all the criteria below are met - The PR description includes an overview of the change - The PR description articulates the motivation for the change - The change includes tests OR the PR description describes a testing strategy - The PR description notes risks associated with the change, if any - Newly-added code is easy to change - The change follows the [library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Reviewer has checked that all the criteria below are met - Title is accurate - All changes are related to the pull request's stated goal - Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes - Testing strategy adequately addresses listed risks - Newly-added code is easy to change - Release note makes sense to a user of the library - If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment - Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) --------- Co-authored-by: Rachel Yang <rachel.yang@datadoghq.com> Co-authored-by: Brett Langdon <brett.langdon@datadoghq.com>

zemek requested review from a team as code owners July 7, 2025 21:10

zemek requested review from rachelyangdog and ZStriker19 July 7, 2025 21:10

zemek mentioned this pull request Jul 7, 2025

[BUG]: tracer.wrap overrides the type of the decorated function #13637

Open

brettlangdon added the backport 3.10 label Jul 8, 2025

brettlangdon mentioned this pull request Jul 8, 2025

fix(tracing): ensure tracer.wrap preserves decorated function’s type [CLONE] #13915

Closed

2 tasks

zemek force-pushed the main branch from d952d3d to 5bc7731 Compare July 8, 2025 17:04

emmettbutler approved these changes Jul 8, 2025

View reviewed changes

mmanzur2 approved these changes Jul 8, 2025

View reviewed changes

brettlangdon reviewed Jul 8, 2025

View reviewed changes

ddtrace/_trace/tracer.py Show resolved Hide resolved

revert type change

a4b2bd1

zemek force-pushed the main branch from 5bc7731 to a4b2bd1 Compare July 8, 2025 17:17

brettlangdon enabled auto-merge (squash) July 8, 2025 17:22

cast to AnyCallable for generator wrappers

a08df5f

auto-merge was automatically disabled July 8, 2025 18:19
Head branch was pushed to by a user without write access

zemek commented Jul 8, 2025

View reviewed changes

ddtrace/_trace/tracer.py Show resolved Hide resolved

Merge branch 'main' into main

de77634

zemek requested review from emmettbutler and brettlangdon July 10, 2025 16:59

emmettbutler approved these changes Jul 11, 2025

View reviewed changes

ddtrace/_trace/tracer.py Show resolved Hide resolved

brettlangdon approved these changes Jul 11, 2025

View reviewed changes

Merge branch 'main' into main

c8d7a7c

brettlangdon approved these changes Jul 12, 2025

View reviewed changes

brettlangdon merged commit 65c54f6 into DataDog:main Jul 12, 2025
823 checks passed

github-actions bot mentioned this pull request Jul 12, 2025

fix(tracing): ensure tracer.wrap preserves decorated function’s type [backport 3.10] #13972

Open

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(tracing): ensure tracer.wrap preserves decorated function’s type #13906

fix(tracing): ensure tracer.wrap preserves decorated function’s type #13906

zemek commented Jul 7, 2025 •

edited by brettlangdon

Loading

Uh oh!

brettlangdon commented Jul 8, 2025 •

edited

Loading

Uh oh!

zemek commented Jul 8, 2025

Uh oh!

Uh oh!

brettlangdon commented Jul 8, 2025

Uh oh!

Uh oh!

zemek commented Jul 8, 2025

Uh oh!

zemek commented Jul 10, 2025 •

edited

Loading

Uh oh!

brettlangdon commented Jul 10, 2025

Uh oh!

Uh oh!

zemek commented Jul 11, 2025

Uh oh!

brettlangdon commented Jul 11, 2025

Uh oh!

Uh oh!

Uh oh!

fix(tracing): ensure tracer.wrap preserves decorated function’s type #13906

fix(tracing): ensure tracer.wrap preserves decorated function’s type #13906

Conversation

zemek commented Jul 7, 2025 • edited by brettlangdon Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Reviewer Checklist

Uh oh!

brettlangdon commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zemek commented Jul 8, 2025

Uh oh!

Uh oh!

brettlangdon commented Jul 8, 2025

Uh oh!

Uh oh!

zemek commented Jul 8, 2025

Uh oh!

zemek commented Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brettlangdon commented Jul 10, 2025

Uh oh!

Uh oh!

zemek commented Jul 11, 2025

Uh oh!

brettlangdon commented Jul 11, 2025

Uh oh!

Uh oh!

Uh oh!

zemek commented Jul 7, 2025 •

edited by brettlangdon

Loading

brettlangdon commented Jul 8, 2025 •

edited

Loading

zemek commented Jul 10, 2025 •

edited

Loading