Skip to content

Add docstring for HTTPClient header validation contract #706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Alan4506 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add docstring for HTTPClient header validation contract #706

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion packages/smithy-http/src/smithy_http/aio/interfaces/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,14 @@ def consume_body(self) -> bytes:


class HTTPClient(ClientTransport[HTTPRequest, HTTPResponse], Protocol):
"""An asynchronous HTTP client interface."""
"""An asynchronous HTTP client interface.

Header field names and values are not validated before reaching this
layer. Implementations of ``HTTPClient`` are responsible for this
validation: if a request's fields contain characters prohibited by
the HTTP specifications (such as CR or LF), the request MUST be
rejected.
"""

def __init__(self, *, client_config: HTTPClientConfiguration | None) -> None:
"""
Expand Down
Loading