Skip to content

Make all relevant types public#4315

Merged
antonpirker merged 5 commits into
masterfrom
antonpirker/types
Apr 22, 2025
Merged

Make all relevant types public#4315
antonpirker merged 5 commits into
masterfrom
antonpirker/types

Conversation

@antonpirker

@antonpirker antonpirker commented Apr 17, 2025

Copy link
Copy Markdown
Contributor

Make types that users can use when configuring the SDK public.

Accompaniyng docs update: getsentry/sentry-docs#13437

Fixes #4127

@codecov

codecov Bot commented Apr 17, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 83.33333% with 1 line in your changes missing coverage. Please review.

Project coverage is 80.30%. Comparing base (c361337) to head (4a7304f).
Report is 2 commits behind head on master.

✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
sentry_sdk/types.py 83.33% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4315      +/-   ##
==========================================
+ Coverage   80.28%   80.30%   +0.01%     
==========================================
  Files         142      142              
  Lines       15925    15929       +4     
  Branches     2724     2724              
==========================================
+ Hits        12786    12792       +6     
+ Misses       2263     2262       -1     
+ Partials      876      875       -1     
Files with missing lines Coverage Δ
sentry_sdk/types.py 84.61% <83.33%> (+6.83%) ⬆️

... and 2 files with indirect coverage changes

@antonpirker
antonpirker marked this pull request as ready for review April 17, 2025 14:13
@antonpirker
antonpirker requested a review from a team as a code owner April 17, 2025 14:13

@szokeasaurusrex szokeasaurusrex left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good! Although, I would recommend omitting the TODO comments.

Comment thread sentry_sdk/_types.py
tuple[None, None, None],
]

# TODO: Make a proper type definition for this (PRs welcome!)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

[nit] I'd suggest we just remove these TODO comments and make GitHub issues for them; I think TODO comments will just get ignored

Suggested change
# TODO: Make a proper type definition for this (PRs welcome!)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I will keep them. Maybe someone wants to earn some internet points and creates nice types here :-)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

okay fair enough 😂

@antonpirker
antonpirker enabled auto-merge (squash) April 22, 2025 09:12
@antonpirker
antonpirker merged commit d1819c7 into master Apr 22, 2025
@antonpirker
antonpirker deleted the antonpirker/types branch April 22, 2025 09:17
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.

Move public types to a more public place

2 participants