Skip to content
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

Reduce duplicate code to construct URL from a tuple #1334

Merged
merged 1 commit into from
Oct 19, 2024
Merged

Reduce duplicate code to construct URL from a tuple #1334

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
85 changes: 30 additions & 55 deletions yarl/_url.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,10 +428,15 @@ def build(
return url

@classmethod
def _from_val(cls, val: SplitResult) -> "URL":
"""Create a new URL from a SplitResult."""
def _from_tup(cls, val: tuple[str, str, str, str, str]) -> "URL":
"""Create a new URL from a tuple.

The tuple should be in the form of a SplitResult.

(scheme, netloc, path, query, fragment)
"""
self = object.__new__(cls)
self._val = val
self._val = tuple.__new__(SplitResult, val)
self._cache = {}
return self

Expand Down Expand Up @@ -603,7 +608,7 @@ def _origin(self) -> "URL":
netloc = self._make_netloc(None, None, encoded_host, self.explicit_port)
elif not path and not query and not fragment:
return self
return self._from_val(tuple.__new__(SplitResult, (scheme, netloc, "", "", "")))
return self._from_tup((scheme, netloc, "", "", ""))

def relative(self) -> "URL":
"""Return a relative part of the URL.
Expand All @@ -614,8 +619,7 @@ def relative(self) -> "URL":
_, netloc, path, query, fragment = self._val
if not netloc:
raise ValueError("URL should be absolute")
val = tuple.__new__(SplitResult, ("", "", path, query, fragment))
return self._from_val(val)
return self._from_tup(("", "", path, query, fragment))

@cached_property
def absolute(self) -> bool:
Expand Down Expand Up @@ -907,12 +911,10 @@ def parent(self) -> "URL":
scheme, netloc, path, query, fragment = self._val
if not path or path == "/":
if fragment or query:
val = tuple.__new__(SplitResult, (scheme, netloc, path, "", ""))
return self._from_val(val)
return self._from_tup((scheme, netloc, path, "", ""))
return self
parts = path.split("/")
val = tuple.__new__(SplitResult, (scheme, netloc, "/".join(parts[:-1]), "", ""))
return self._from_val(val)
return self._from_tup((scheme, netloc, "/".join(parts[:-1]), "", ""))

@cached_property
def raw_name(self) -> str:
Expand Down Expand Up @@ -990,14 +992,14 @@ def _make_child(self, paths: "Sequence[str]", encoded: bool = False) -> "URL":
parsed += segments[segment_slice_start:]
parsed.reverse()

v = self._val
if v.path and (old_path_segments := v.path.split("/")):
scheme, netloc, path, _, _ = self._val
if path and (old_path_segments := path.split("/")):
# If the old path ends with a slash, the last segment is an empty string
# and should be removed before adding the new path segments.
old_path_cutoff = -1 if old_path_segments[-1] == "" else None
parsed = [*old_path_segments[:old_path_cutoff], *parsed]

if netloc := v.netloc:
if netloc := netloc:
# If the netloc is present, we need to ensure that the path is normalized
parsed = _normalize_path_segments(parsed) if needs_normalize else parsed
if parsed and parsed[0] != "":
Expand All @@ -1007,9 +1009,7 @@ def _make_child(self, paths: "Sequence[str]", encoded: bool = False) -> "URL":

new_path = "/".join(parsed)

return self._from_val(
tuple.__new__(SplitResult, (v.scheme, netloc, new_path, "", ""))
)
return self._from_tup((scheme, netloc, new_path, "", ""))

@classmethod
def _normalize_path(cls, path: str) -> str:
Expand Down Expand Up @@ -1181,8 +1181,7 @@ def with_scheme(self, scheme: str) -> "URL":
f"relative URLs for the {lower_scheme} scheme"
)
raise ValueError(msg)
val = tuple.__new__(SplitResult, (lower_scheme, netloc, path, query, fragment))
return self._from_val(val)
return self._from_tup((lower_scheme, netloc, path, query, fragment))

def with_user(self, user: Union[str, None]) -> "URL":
"""Return a new URL with user replaced.
Expand All @@ -1205,9 +1204,7 @@ def with_user(self, user: Union[str, None]) -> "URL":
raise ValueError("user replacement is not allowed for relative URLs")
encoded_host = self.host_subcomponent or ""
netloc = self._make_netloc(user, password, encoded_host, self.explicit_port)
return self._from_val(
tuple.__new__(SplitResult, (scheme, netloc, path, query, fragment))
)
return self._from_tup((scheme, netloc, path, query, fragment))

def with_password(self, password: Union[str, None]) -> "URL":
"""Return a new URL with password replaced.
Expand All @@ -1230,9 +1227,7 @@ def with_password(self, password: Union[str, None]) -> "URL":
encoded_host = self.host_subcomponent or ""
port = self.explicit_port
netloc = self._make_netloc(self.raw_user, password, encoded_host, port)
return self._from_val(
tuple.__new__(SplitResult, (scheme, netloc, path, query, fragment))
)
return self._from_tup((scheme, netloc, path, query, fragment))

def with_host(self, host: str) -> "URL":
"""Return a new URL with host replaced.
Expand All @@ -1254,9 +1249,7 @@ def with_host(self, host: str) -> "URL":
encoded_host = self._encode_host(host, validate_host=True) if host else ""
port = self.explicit_port
netloc = self._make_netloc(self.raw_user, self.raw_password, encoded_host, port)
return self._from_val(
tuple.__new__(SplitResult, (scheme, netloc, path, query, fragment))
)
return self._from_tup((scheme, netloc, path, query, fragment))

def with_port(self, port: Union[int, None]) -> "URL":
"""Return a new URL with port replaced.
Expand All @@ -1275,9 +1268,7 @@ def with_port(self, port: Union[int, None]) -> "URL":
raise ValueError("port replacement is not allowed for relative URLs")
encoded_host = self.host_subcomponent or ""
netloc = self._make_netloc(self.raw_user, self.raw_password, encoded_host, port)
return self._from_val(
tuple.__new__(SplitResult, (scheme, netloc, path, query, fragment))
)
return self._from_tup((scheme, netloc, path, query, fragment))

def with_path(self, path: str, *, encoded: bool = False) -> "URL":
"""Return a new URL with path replaced."""
Expand All @@ -1288,9 +1279,7 @@ def with_path(self, path: str, *, encoded: bool = False) -> "URL":
path = self._normalize_path(path) if "." in path else path
if path and path[0] != "/":
path = f"/{path}"
return self._from_val(
tuple.__new__(SplitResult, (scheme, netloc, path, "", ""))
)
return self._from_tup((scheme, netloc, path, "", ""))

@classmethod
def _get_str_query_from_sequence_iterable(
Expand Down Expand Up @@ -1417,9 +1406,7 @@ def with_query(self, *args: Any, **kwargs: Any) -> "URL":
# N.B. doesn't cleanup query/fragment
query = self._get_str_query(*args, **kwargs) or ""
scheme, netloc, path, _, fragment = self._val
return self._from_val(
tuple.__new__(SplitResult, (scheme, netloc, path, query, fragment))
)
return self._from_tup((scheme, netloc, path, query, fragment))

@overload
def extend_query(self, query: Query) -> "URL": ...
Expand All @@ -1446,9 +1433,7 @@ def extend_query(self, *args: Any, **kwargs: Any) -> "URL":
query += new_query if query[-1] == "&" else f"&{new_query}"
else:
query = new_query
return self._from_val(
tuple.__new__(SplitResult, (scheme, netloc, path, query, fragment))
)
return self._from_tup((scheme, netloc, path, query, fragment))

@overload
def update_query(self, query: Query) -> "URL": ...
Expand Down Expand Up @@ -1506,9 +1491,7 @@ def update_query(self, *args: Any, **kwargs: Any) -> "URL":
"Invalid query type: only str, mapping or "
"sequence of (key, value) pairs is allowed"
)
return self._from_val(
tuple.__new__(SplitResult, (scheme, netloc, path, query, fragment))
)
return self._from_tup((scheme, netloc, path, query, fragment))

def without_query_params(self, *query_params: str) -> "URL":
"""Remove some keys from query part and return new URL."""
Expand Down Expand Up @@ -1541,9 +1524,7 @@ def with_fragment(self, fragment: Union[str, None]) -> "URL":
if self._val.fragment == raw_fragment:
return self
scheme, netloc, path, query, _ = self._val
return self._from_val(
tuple.__new__(SplitResult, (scheme, netloc, path, query, raw_fragment))
)
return self._from_tup((scheme, netloc, path, query, raw_fragment))

def with_name(self, name: str) -> "URL":
"""Return a new URL with name (last part of path) replaced.
Expand Down Expand Up @@ -1573,8 +1554,7 @@ def with_name(self, name: str) -> "URL":
parts[-1] = name
if parts[0] == "/":
parts[0] = "" # replace leading '/'
val = tuple.__new__(SplitResult, (scheme, netloc, "/".join(parts), "", ""))
return self._from_val(val)
return self._from_tup((scheme, netloc, "/".join(parts), "", ""))

def with_suffix(self, suffix: str) -> "URL":
"""Return a new URL with suffix (file extension of name) replaced.
Expand Down Expand Up @@ -1617,11 +1597,8 @@ def join(self, url: "URL") -> "URL":

# scheme is in uses_authority as uses_authority is a superset of uses_relative
if join_netloc and scheme in USES_AUTHORITY:
return self._from_val(
tuple.__new__(
SplitResult,
(scheme, join_netloc, join_path, join_query, join_fragment),
)
return self._from_tup(
(scheme, join_netloc, join_path, join_query, join_fragment)
)

fragment = join_fragment if join_path or join_fragment else orig_fragment
Expand All @@ -1647,9 +1624,7 @@ def join(self, url: "URL") -> "URL":
path = path[1:]
path = self._normalize_path(path) if "." in path else path

return self._from_val(
tuple.__new__(SplitResult, (scheme, orig_netloc, path, query, fragment))
)
return self._from_tup((scheme, orig_netloc, path, query, fragment))

def joinpath(self, *other: str, encoded: bool = False) -> "URL":
"""Return a new URL with the elements in other appended to the path."""
Expand Down