fix: add missing return type annotations#640
Open
miachillgood wants to merge 1 commit into
Open
Conversation
Contributor
|
Reviews (1): Last reviewed commit: "Add return annotations for client lifecy..." | Re-trigger Greptile |
turnipdabeets
approved these changes
Jun 1, 2026
b44082e to
3dbb599
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds explicit return annotations for
Client.capture_exception, the client lifecycle helpers (flush,join,shutdown), and the equivalent module-level helpers.capture_exceptionnow also returnsNoneexplicitly if its defensive exception handler is reached.This is a small incremental typing improvement related to #559.
Validation
pytest posthog/test/test_client.py::TestClient::test_basic_capture_exception posthog/test/test_client.py::TestClient::test_basic_capture_exception_with_distinct_id posthog/test/test_client.py::TestClient::test_basic_capture_exception_with_correct_host_generation posthog/test/test_client.py::TestClient::test_basic_capture_exception_with_correct_host_generation_for_server_hosts posthog/test/test_client.py::TestClient::test_basic_capture_exception_with_no_exception_given posthog/test/test_client.py::TestClient::test_basic_capture_exception_with_no_exception_happening posthog/test/test_client.py::TestClient::test_capture_exception_logs_when_enabled posthog/test/test_client.py::TestClient::test_flush posthog/test/test_client.py::TestClient::test_shutdown posthog/test/test_module.py::TestModule::test_flushpyright typing_smoke.pywith# pyright: strictconfirmed the updated helper return types asstr | NoneorNone.