Feature: add httpx transport config to client#247
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for custom HTTPX transport configuration to the GitHub client, enabling users to inject custom transport implementations for both sync and async operations. This is particularly useful for unit testing scenarios where mock transports can stub API responses without making real HTTP calls.
- Added
transportandasync_transportparameters to the GitHub client configuration - Updated the client creation logic to use custom transports when provided
- Added comprehensive documentation and test examples demonstrating mock transport usage
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| githubkit/config.py | Added transport fields to Config dataclass and get_config function |
| githubkit/core.py | Updated GitHubCore init overloads and client creation methods to support custom transports |
| githubkit/github.py | Added transport parameters to GitHub class init overloads |
| tests/test_unit_test/test_mock_transport.py | New test file demonstrating sync and async mock transport usage |
| docs/usage/unit-test.md | Added documentation section explaining how to use test transports for mocking |
| docs/usage/configuration.md | Added documentation for the new transport configuration options |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
resolve #245