Skip to content
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

rename CompositeHTTPPropagator, add deprecation notice #1807

Merged
merged 9 commits into from
May 7, 2021
Merged

rename CompositeHTTPPropagator, add deprecation notice #1807

merged 9 commits into from
May 7, 2021

Conversation

codeboten
Copy link
Contributor

Description

Renaming CompositeHTTPPropagator to CompositePropagator. Note this change adds the dependency on the Deprecated package to the API, we may or may not want this, would love some feedback from reviewers. The following is what users will see when using CompositeHTTPPropagator:

>>> from opentelemetry.propagators.composite import CompositeHTTPPropagator
>>> CompositeHTTPPropagator([])
<stdin>:1: DeprecationWarning: Call to deprecated class CompositeHTTPPropagator. (You should use CompositePropagator) -- Deprecated since version 1.2.0.
<opentelemetry.propagators.composite.CompositeHTTPPropagator object at 0x108712be0>

Fixes #1775

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

Does This PR Require a Contrib Repo Change?

  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been updated

@codeboten codeboten requested a review from a team as a code owner May 3, 2021 20:03
@codeboten codeboten requested review from owais and ocelotl and removed request for a team May 3, 2021 20:03
ocelotl
ocelotl requested changes May 3, 2021
View reviewed changes
Copy link
Contributor

@ocelotl ocelotl left a comment

Choose a reason for hiding this comment

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

We should leave the documentation as it is for deprecated objects, besides that, LGTM 👍

opentelemetry-api/src/opentelemetry/propagators/composite.py Outdated Show resolved Hide resolved
alrex and others added 2 commits May 4, 2021 11:29
@codeboten
Copy link
Contributor Author

@ocelotl PTAL

@ocelotl
Copy link
Contributor

ocelotl commented May 7, 2021

@ocelotl PTAL

Approved 👍

@codeboten codeboten merged commit 2c76890 into open-telemetry:main May 7, 2021
@codeboten codeboten deleted the codeboten/fix-1775 branch May 7, 2021 22:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@owais owais owais approved these changes

@ocelotl ocelotl ocelotl approved these changes

@lzchen lzchen lzchen 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.

Rename CompositeHTTPPropagator
4 participants
@codeboten @ocelotl @owais @lzchen