Skip to content

Ignore None consistently in URI template list expansions #161

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
machines-6657 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Ignore None consistently in URI template list expansions #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
711d66f
Ignore None entries in list expansions
machines-6657 Oct 3, 2026
233b4ce
Cover explode modifiers and preserved list values
machines-6657 Oct 3, 2026
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
63 changes: 63 additions & 0 deletions tests/test_uritemplate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -665,5 +665,68 @@ def test_expand(self) -> None:
self.assertEqual(expand("{/zero,a_float}", self.context), "/0/3.1415")


class TestNoneListValues(unittest.TestCase):
def test_expansion_ignores_none_list_items_for_all_operators(
self,
) -> None:
values = {"x": ["a", None, "b"]}
expected = {
"{x}": "a,b",
"{x*}": "a,b",
"{+x}": "a,b",
"{+x*}": "a,b",
"{#x}": "#a,b",
"{#x*}": "#a,b",
"{.x}": ".a,b",
"{.x*}": ".a.b",
"{/x}": "/a,b",
"{/x*}": "/a/b",
"{;x}": ";x=a,b",
"{;x*}": ";x=a;x=b",
"{?x}": "?x=a,b",
"{?x*}": "?x=a&x=b",
"{&x}": "&x=a,b",
"{&x*}": "&x=a&x=b",
}

for template, result in expected.items():
with self.subTest(template=template):
self.assertEqual(URITemplate(template).expand(values), result)

def test_expansion_preserves_defined_empty_and_zero_list_items(
self,
) -> None:
values = {"x": ["", None, 0, None, "b"]}
expected = {
"{x}": ",0,b",
"{x*}": ",0,b",
"{+x}": ",0,b",
"{+x*}": ",0,b",
"{#x}": "#,0,b",
"{#x*}": "#,0,b",
"{.x}": ".,0,b",
"{.x*}": "..0.b",
"{/x}": "/,0,b",
"{/x*}": "//0/b",
"{;x}": ";x=,0,b",
"{;x*}": ";x=;x=0;x=b",
"{?x}": "?x=,0,b",
"{?x*}": "?x=&x=0&x=b",
"{&x}": "&x=,0,b",
"{&x*}": "&x=&x=0&x=b",
}

for template, result in expected.items():
with self.subTest(template=template):
self.assertEqual(URITemplate(template).expand(values), result)

def test_expansion_does_not_mutate_none_containing_lists(self) -> None:
values = {"x": ["a", None, "b"]}
for template in ("{x}", "{.x}", "{;x}", "{?x}"):
with self.subTest(template=template):
URITemplate(template).expand(values)
self.assertEqual(values, {"x": ["a", None, "b"]})


if __name__ == "__main__":
unittest.main()
14 changes: 8 additions & 6 deletions uritemplate/variable.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,9 +284,10 @@ def _query_expansion(
safe = self.operator.reserved_characters()
_quote = self.operator.quote
if list_test(value) and not tuples:
value = t.cast(t.Sequence[ScalarVariableValue], value)
value = [v for v in value if v is not None]
if not value:
return None
value = t.cast(t.Sequence[ScalarVariableValue], value)
if explode:
return self.operator.expansion_separator().join(
f"{name}={_quote(v)}" for v in value
Expand Down Expand Up @@ -340,13 +341,12 @@ def _label_path_expansion(
tuples, items = is_list_of_tuples(value)

if list_test(value) and not tuples:
value = t.cast(t.Sequence[ScalarVariableValue], value)
value = [v for v in value if v is not None]
if not explode:
join_str = ","

value = t.cast(t.Sequence[ScalarVariableValue], value)
fragments = [
self.operator.quote(v) for v in value if v is not None
]
fragments = [self.operator.quote(v) for v in value]
return join_str.join(fragments) if fragments else None

if dict_test(value) or tuples:
Expand Down Expand Up @@ -386,9 +386,10 @@ def _semi_path_expansion(

if list_test(value) and not tuples:
value = t.cast(t.Sequence[ScalarVariableValue], value)
value = [v for v in value if v is not None]
if explode:
expanded = join_str.join(
f"{name}={quote(v, safe)}" for v in value if v is not None
f"{name}={quote(v, safe)}" for v in value
)
return expanded if expanded else None
else:
Expand Down Expand Up @@ -434,6 +435,7 @@ def _string_expansion(

if list_test(value) and not tuples:
value = t.cast(t.Sequence[ScalarVariableValue], value)
value = [v for v in value if v is not None]
return ",".join(self.operator.quote(v) for v in value)

if dict_test(value) or tuples:
Expand Down