Skip to content

Use localhost instead of http://localhost in TestClient(client=...) example#2870

Merged
Kludex merged 1 commit intoKludex:masterfrom
WilliamDEdwards:fix/override-client-host-example
Feb 16, 2025
Merged

Use localhost instead of http://localhost in TestClient(client=...) example#2870
Kludex merged 1 commit intoKludex:masterfrom
WilliamDEdwards:fix/override-client-host-example

Conversation

@WilliamDEdwards
Copy link
Contributor

Summary

With #2810, it is possible to override the client host (i.e. the remote address; see https://www.starlette.io/requests/#client-address).

The default value for TestClient is testclient, but an IP address in most circumstances.

The documentation example for overriding the client host uses a full URI, which makes no sense: it's the remote address.

Checklist

  • I understand that this PR may be closed in case there was no previous discussion. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.

With Kludex#2810, it is possible to override the client host (i.e. the remote address; see https://www.starlette.io/requests/#client-address).

The default value for `TestClient` is `testclient`, but an IP address in most circumstances.

The documentation example for overriding the client host uses a full URI, which makes no sense: it's the remote address.
@Kludex Kludex changed the title Fix client host override example Use localhost instead of http://localhost in TestClient(client=...) example Feb 16, 2025
@Kludex Kludex merged commit 1695942 into Kludex:master Feb 16, 2025
5 checks passed
@Kludex
Copy link
Owner

Kludex commented Feb 16, 2025

Thanks 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants