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.

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

chore: privatizing methods in tornado,unittest,urllib,urllib3,vertica #9928

Conversation

rachelyangdog
Copy link
Contributor

@rachelyangdog rachelyangdog commented Jul 24, 2024

The API should just be what is necessary. A lot of integrations expose implementation details through the patch.py We can’t just remove these functions right away as it will break our API so for each we will need to deprecate first and then remove in 2.x.

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

Copy link
Contributor

github-actions bot commented Jul 24, 2024

CODEOWNERS have been resolved as:

releasenotes/notes/deprecate-patch-py-methods-tornado-unittest-urllib-vertica-7e5e7bd8f5613323.yaml  @DataDog/apm-python
ddtrace/contrib/tornado/__init__.py                                     @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/tornado/patch.py                                        @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/unittest/__init__.py                                    @DataDog/ci-app-libraries
ddtrace/contrib/unittest/patch.py                                       @DataDog/ci-app-libraries
ddtrace/contrib/urllib/__init__.py                                      @DataDog/asm-python
ddtrace/contrib/urllib/patch.py                                         @DataDog/asm-python
ddtrace/contrib/urllib3/__init__.py                                     @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/urllib3/patch.py                                        @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/vertica/__init__.py                                     @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/vertica/patch.py                                        @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/tornado/test_tornado_patch.py                             @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/unittest/test_unittest_patch.py                           @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/urllib3/test_urllib3_patch.py                             @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/vertica/test_vertica_patch.py                             @DataDog/apm-core-python @DataDog/apm-idm-python

@rachelyangdog rachelyangdog reopened this Jul 24, 2024
@rachelyangdog rachelyangdog added the changelog/no-changelog A changelog entry is not required for this PR. label Jul 24, 2024
@rachelyangdog rachelyangdog requested review from ZStriker19 and removed request for ManuelPalenzuelaDD, taegyunkim and lievan July 24, 2024 20:53
@datadog-dd-trace-py-rkomorn
Copy link

datadog-dd-trace-py-rkomorn bot commented Jul 24, 2024

Datadog Report

Branch report: rachel.yang/privatize-public-functions-tornado-to-vertica
Commit report: 7e22f2a
Test service: dd-trace-py

✅ 0 Failed, 799 Passed, 35 Skipped, 3m 15.23s Total Time

@pr-commenter
Copy link

pr-commenter bot commented Jul 24, 2024

Benchmarks

Benchmark execution time: 2024-07-30 15:50:16

Comparing candidate commit 7e22f2a in PR branch rachel.yang/privatize-public-functions-tornado-to-vertica with baseline commit f462685 in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 214 metrics, 2 unstable metrics.

Copy link
Contributor

@ZStriker19 ZStriker19 left a comment

Choose a reason for hiding this comment

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

Looks good, could we just update the PR name to reflect the various integrations modified here?

@rachelyangdog rachelyangdog changed the title chore: privatizing public API of integrations in tornado patch.py chore: privatizing methods in tornado,unittest,urllib,urllib3,vertica Jul 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants