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 psycopg,pylibmc,pymemcache,pymongo,pymysql,pynamodb,pyodbc,pyramid #9944

Merged
merged 6 commits into from
Jul 26, 2024

Conversation

rachelyangdog
Copy link
Contributor

@rachelyangdog rachelyangdog commented Jul 25, 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

CODEOWNERS have been resolved as:

releasenotes/notes/deprecate-patch-py-methods-psycopg-pylibmc-pymemcache-pymongo-pymysql-pynamodb-pyodbc-pyramid-df1d8182d30d1950.yaml  @DataDog/apm-python
ddtrace/contrib/psycopg/patch.py                                        @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/pylibmc/patch.py                                        @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/pymemcache/patch.py                                     @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/pymongo/patch.py                                        @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/pymysql/patch.py                                        @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/pynamodb/patch.py                                       @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/pyodbc/patch.py                                         @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/pyramid/patch.py                                        @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/pyramid/utils.py                                          @DataDog/apm-core-python @DataDog/apm-idm-python

@rachelyangdog rachelyangdog added the changelog/no-changelog A changelog entry is not required for this PR. label Jul 25, 2024
@datadog-dd-trace-py-rkomorn
Copy link

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

Datadog Report

Branch report: rachel.yang/privatize-public-functions-psyocpg
Commit report: b4397ae
Test service: dd-trace-py

✅ 0 Failed, 2965 Passed, 2220 Skipped, 41m 19.64s Total duration (3m 15.43s time saved)

@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 0% with 104 lines in your changes missing coverage. Please review.

Project coverage is 10.54%. Comparing base (de35e9a) to head (c9e89dd).
Report is 9 commits behind head on main.

Files Patch % Lines
ddtrace/contrib/pymongo/patch.py 0.00% 21 Missing ⚠️
ddtrace/contrib/psycopg/patch.py 0.00% 16 Missing ⚠️
ddtrace/contrib/pyramid/patch.py 0.00% 16 Missing ⚠️
ddtrace/contrib/pymysql/patch.py 0.00% 11 Missing ⚠️
ddtrace/contrib/pynamodb/patch.py 0.00% 11 Missing ⚠️
ddtrace/contrib/pyodbc/patch.py 0.00% 11 Missing ⚠️
ddtrace/contrib/pylibmc/patch.py 0.00% 6 Missing ⚠️
ddtrace/contrib/pymemcache/patch.py 0.00% 6 Missing ⚠️
tests/contrib/pyramid/utils.py 0.00% 6 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##             main    #9944       +/-   ##
===========================================
- Coverage   73.90%   10.54%   -63.36%     
===========================================
  Files        1402     1368       -34     
  Lines      130341   128030     -2311     
===========================================
- Hits        96324    13504    -82820     
- Misses      34017   114526    +80509     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…pymysql-pynamodb-pyodbc-pyramid-df1d8182d30d1950.yaml
@pr-commenter
Copy link

pr-commenter bot commented Jul 25, 2024

Benchmarks

Benchmark execution time: 2024-07-26 16:41:20

Comparing candidate commit 7f38ea5 in PR branch rachel.yang/privatize-public-functions-psyocpg with baseline commit 159806f in branch main.

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

…pymysql-pynamodb-pyodbc-pyramid-df1d8182d30d1950.yaml
@rachelyangdog rachelyangdog enabled auto-merge (squash) July 26, 2024 15:00
@rachelyangdog rachelyangdog merged commit 11e9573 into main Jul 26, 2024
73 checks passed
@rachelyangdog rachelyangdog deleted the rachel.yang/privatize-public-functions-psyocpg branch July 26, 2024 17:45
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.

4 participants