Skip to content

rename CompositeHTTPPropagator, add deprecation notice - #1807

Merged
codeboten merged 9 commits into
open-telemetry:mainfrom
codeboten:codeboten/fix-1775
May 7, 2021
Merged

rename CompositeHTTPPropagator, add deprecation notice#1807
codeboten merged 9 commits into
open-telemetry:mainfrom
codeboten:codeboten/fix-1775

Conversation

@codeboten

Copy link
Copy Markdown
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 review from a team, ocelotl and owais and removed request for a team May 3, 2021 20:03

@ocelotl ocelotl left a comment

Copy link
Copy Markdown
Contributor

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 👍

Comment thread opentelemetry-api/src/opentelemetry/propagators/composite.py Outdated
alrex and others added 2 commits May 4, 2021 11:29
Co-authored-by: Diego Hurtado <ocelotl@users.noreply.github.com>
@codeboten

Copy link
Copy Markdown
Contributor Author

@ocelotl PTAL

@ocelotl

ocelotl commented May 7, 2021

Copy link
Copy Markdown
Contributor

@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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rename CompositeHTTPPropagator

4 participants