Add missing | None to auth parameter in convenience methods#3770
Open
bysiber wants to merge 1 commit intoencode:masterfrom
Open
Add missing | None to auth parameter in convenience methods#3770bysiber wants to merge 1 commit intoencode:masterfrom
| None to auth parameter in convenience methods#3770bysiber wants to merge 1 commit intoencode:masterfrom
Conversation
The `options()`, `head()`, `post()`, `put()`, `patch()`, and `delete()` methods on both `Client` and `AsyncClient` were missing `| None` in their `auth` parameter type annotation. This makes them inconsistent with `get()`, `request()`, `send()`, and `stream()` which all accept `auth: AuthTypes | UseClientDefault | None`. Passing `auth=None` to explicitly opt out of authentication is a valid use case that was already supported at runtime (via `request()`) but the type annotations on these methods would incorrectly flag it.
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
1 participant
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.
The
options(),head(),post(),put(),patch(), anddelete()methods on bothClientandAsyncClientare missing| Nonein theirauthparameter type annotation.This is inconsistent with
get(),request(),send(), andstream()which all acceptauth: AuthTypes | UseClientDefault | None.Passing
auth=Noneto explicitly opt out of authentication is a valid use case already supported at runtime, but the type annotations on these methods would incorrectly flag it.