getsentry / getsentry/sentry-python

Don't export `Any` instead of instantiable types

Đang mở
#4,656 5 bình luận 0 reaction 0 người được giao Xem trên GitHub
Component: Typing Errors Improvement Python
Ngôn ngữ chính
Python
Star
2.2k
Fork
669
Merge trung bình
1 ngày 1 giờ
Pull request đã merge (30 ngày)
213

Mô tả

`sentry_sdk/types.py` exports types for hinting, but some of the types it exports in type-checking mode can be instantiated. This creates a dangerous mismatch between the type-checking and runtime API where i.e, `Event()` will appear valid due to being a `TypedDict`, but will raise an `Any type cannot be instantiated` error at runtime.

I don't think there's an easy solution for hinting the type checker about hint-only types, but also I'm not sure why the `_types.py` code is behind `if TYPE_CHECKING:`. My recommendation would either be:
* Just remove the `if TYPE_CHECKING:` or,
* Export instantiable substitutes versions of the instantiable types (maybe just TypedDict types but not sure)

https://github.com/getsentry/sentry-python/blob/84adbb74e27b7716cbaaddbb299a44fe3fbcd6a6/sentry_sdk/types.py#L28-L37

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.