openstack/oslo.utils
Code Issues Proposed changes

typing: Improve netutils.urlsplit signature

Browse Source 
Expose the actual return type. Doing so properly requires making the
class public. We're okay with that. A quick search on codesearch.o.o
shows no one was using the old name (and if they were, boo, since this
was clearly private). By making the class public, we also cause it get
to get picked up by autodoc. This requires a fix to the docstring to be
valid Python.

Change-Id: I48ca2e4bad25625887e3bac5c4358f605296a3b0
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
This commit is contained in:
Stephen Finucane
2026-03-11 11:22:50 +00:00
parent 2ae0def9bb
commit b95f81ea41
1 changed files with 14 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
oslo_utils/netutils.py
View File

@@ -22,7 +22,7 @@ import logging
import os
import re
import socket
from typing import cast, Any
from typing import cast
from urllib import parse
import netaddr
@@ -527,7 +527,7 @@ def _get_my_ipv6_address() -> str:
return LOCALHOST
class _ModifiedSplitResult(parse.SplitResult):
class SplitResult(parse.SplitResult):
"""Split results class for urlsplit."""
def params(self, collapse: bool = True) -> dict[str, list[str] | str]:
@@ -537,12 +537,13 @@ class _ModifiedSplitResult(parse.SplitResult):
names and values that were provided in the url.
:param collapse: Boolean, turn on or off collapsing of query values
with the same name. Since a url can contain the same query parameter
name with different values it may or may not be useful for users to
care that this has happened. This parameter when True uses the
last value that was given for a given name, while if False it will
retain all values provided by associating the query parameter name with
a list of values instead of a single (non-list) value.
with the same name. Since a url can contain the same query
parameter name with different values it may or may not be useful
for users to care that this has happened. This parameter when True
uses the last value that was given for a given name, while if False
it will retain all values provided by associating the query
parameter name with a list of values instead of a single (non-list)
value.
"""
if self.query:
if collapse:
@@ -563,8 +564,11 @@ class _ModifiedSplitResult(parse.SplitResult):
return {}
def urlsplit(url: str, scheme: str = '', allow_fragments: bool = True) -> Any:
def urlsplit(
url: str, scheme: str = '', allow_fragments: bool = True
) -> SplitResult:
"""Parse a URL using urlparse.urlsplit(), splitting query and fragments.
This function papers over Python issue9374_ when needed.
.. _issue9374: http://bugs.python.org/issue9374
@@ -578,7 +582,7 @@ def urlsplit(url: str, scheme: str = '', allow_fragments: bool = True) -> Any:
path, fragment = path.split('#', 1)
if '?' in path:
path, query = path.split('?', 1)
return _ModifiedSplitResult(scheme, netloc, path, query, fragment)
return SplitResult(scheme, netloc, path, query, fragment)
def set_tcp_keepalive(