Skip to content

Feature: relative url in URL datastructure #2888

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
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Feature: relative url in URL datastructure #2888

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dfb062a
feature: added relative_url function to URL data structure
palani-johnson Feb 25, 2025
661e2b8
fix: use class constructor for relative url creation
palani-johnson Feb 25, 2025
2e2434a
test: added test for relative url
palani-johnson Feb 25, 2025
3a1b3d0
fix: added URL type
palani-johnson Feb 25, 2025
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
6 changes: 6 additions & 0 deletions starlette/datastructures.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,12 @@ def port(self) -> int | None:
def is_secure(self) -> bool:
return self.scheme in ("https", "wss")

def relative_url(self) -> URL:
"""
Get a URL that only includes url path, query string and fragment.
"""
return self.__class__(path=self.path, query=self.query, fragment=self.fragment)

def replace(self, **kwargs: typing.Any) -> URL:
if "username" in kwargs or "password" in kwargs or "hostname" in kwargs or "port" in kwargs:
hostname = kwargs.pop("hostname", None)
Expand Down
11 changes: 11 additions & 0 deletions tests/test_datastructures.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,17 @@ def test_hidden_password() -> None:
assert repr(u) == "URL('https://username:********@example.org/path/to/somewhere')"


def test_relative_url() -> None:
u = URL("https://example.org/path/to/somewhere")
assert u.relative_url() == URL("/path/to/somewhere")

u = URL("https://username:[email protected]/path/to/somewhere?abc=123")
assert u.relative_url() == URL("/path/to/somewhere?abc=123")

u = URL("https://[fe::2]:12345/path/to/somewhere?abc=123#anchor")
assert u.relative_url() == URL("/path/to/somewhere?abc=123#anchor")


def test_csv() -> None:
csv = CommaSeparatedStrings('"localhost", "127.0.0.1", 0.0.0.0')
assert list(csv) == ["localhost", "127.0.0.1", "0.0.0.0"]
Expand Down