Fix FIXME in telemetry by using functools.wraps#11569
Open
ritikraj2425 wants to merge 1 commit into
Open
Conversation
|
@ritikraj2425 is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
Coverage reportClick to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issues
Proposed Changes:
import functoolstohaystack/telemetry/_telemetry.py.@functools.wraps(func)decorator tosend_telemetry_wrapper.# FIXMEcomment suggesting thatfunctools.wrapsmakes the globaltelemetryvariable out of scope.This ensures that any telemetry-wrapped functions (such as
pipeline_runningandtutorial_running) retain their original metadata, such as__name__,__doc__, and__annotations__.How did you test it?
hatch -e test run python -m pytest test/test_telemetry.pyNotes for the reviewer
The original
# FIXMEwas likely caused by a missingfunctoolsimport in this file rather than an actual scoping issue. Python resolves global variables at execution time, andfunctools.wrapsmerely copies function metadata at decoration time, meaning it has no effect on the runtime scope of the globaltelemetryvariable.Checklist
fix: telemetry decorator overwrites original function metadata.hatch run release-note "Fix telemetry decorator metadata loss")