Skip to content

Deprecate ddtrace.propagation.utils #3068

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 12 commits into from
Dec 17, 2021
Merged

Deprecate ddtrace.propagation.utils #3068

merged 12 commits into from
Dec 17, 2021

Conversation

ZStriker19
Copy link
Contributor

Commit Message

In preparation for the 1.0 release where we'll remove the utils module.

Checklist

  • Added to the correct milestone.
  • Tests provided or description of manual testing performed is included in the code or PR.
  • Library documentation is updated.
  • Corp site documentation is updated (link to the PR).

@ZStriker19 ZStriker19 requested a review from a team as a code owner December 15, 2021 00:36
brettlangdon
brettlangdon reviewed Dec 15, 2021
View reviewed changes
releasenotes/notes/deprecate_external_ddtrace.propagation.utils-e5106df5b4723310.yaml Outdated
Comment on lines 4 to 7
The contents of ``ddtrace.propagation.utils.py`` have been moved into ``ddtrace.propagation._utils.py`` in an
effort to internalize the module. Public methods have been imported back
into ``ddtrace.propagation.utils.py`` in order to retain compatibility, but this module will be
removed entirely in version 1.0.0.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can probably simplify this message to be more like:

ddtrace.propagation.utils.from_wsgi_header and ddtrace.propagation.utils.get_wsgi_header have been deprecated and will be removed in version 1.0.0.

Or, if they really are going to ddtrace.contrib.trace_utils, we can just do that move now and state that as the release note.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I moved them to ddtrace.contrib.trace_utils I got a circular import error because of the propagation.http module, so Kyle just recommended I go the normal deprecation route. I'll simplify the message!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I'd prefer we just say

ddtrace.propagation.utils has been deprecated and will be removed in version 1.0.

@Kyle-Verhoog Kyle-Verhoog merged commit d02133a into master Dec 17, 2021
@Kyle-Verhoog Kyle-Verhoog deleted the deprecate_external_ddtrace.propagation.utils branch December 17, 2021 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brettlangdon brettlangdon brettlangdon approved these changes

@Kyle-Verhoog Kyle-Verhoog Kyle-Verhoog approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ZStriker19 @brettlangdon @Kyle-Verhoog