Clarify util name/docs

This commit is contained in:
Joe Rickerby
2026-08-07 11:48:00 +01:00
parent e97e4562b1
commit b652a90184
3 changed files with 34 additions and 28 deletions
+23 -19
View File
@@ -11,8 +11,8 @@ from cibuildwheel.util.file import copy_test_sources, remove_on_error
from cibuildwheel.util.helpers import (
FlexibleVersion,
format_safe,
parse_arbitrary_key_value_string,
parse_key_value_string,
parse_kw_string,
prepare_command,
unwrap,
unwrap_preserving_paragraphs,
@@ -220,53 +220,57 @@ def test_parse_key_value_string_unknown_name() -> None:
parse_key_value_string("key: value")
def test_parse_kw_string_basic() -> None:
assert parse_kw_string("before-test: append; after-test: prepend") == {
def test_parse_arbitrary_key_value_string_basic() -> None:
assert parse_arbitrary_key_value_string("before-test: append; after-test: prepend") == {
"before-test": ["append"],
"after-test": ["prepend"],
}
def test_parse_kw_string_multiple_values() -> None:
assert parse_kw_string("package1: some/header.h some/library.a; package2: other/header.h") == {
def test_parse_arbitrary_key_value_string_multiple_values() -> None:
assert parse_arbitrary_key_value_string(
"package1: some/header.h some/library.a; package2: other/header.h"
) == {
"package1": ["some/header.h", "some/library.a"],
"package2": ["other/header.h"],
}
def test_parse_kw_string_keys_without_values_default() -> None:
assert parse_kw_string("before-build; before-test: prepend", default_kw_value="append") == {
def test_parse_arbitrary_key_value_string_keys_without_values_default() -> None:
assert parse_arbitrary_key_value_string(
"before-build; before-test: prepend", default_value="append"
) == {
"before-build": ["append"],
"before-test": ["prepend"],
}
def test_parse_kw_string_keys_without_values_no_default() -> None:
def test_parse_arbitrary_key_value_string_keys_without_values_no_default() -> None:
with pytest.raises(ValueError, match="No value specified"):
parse_kw_string("before-build")
parse_arbitrary_key_value_string("before-build")
def test_parse_kw_string_empty() -> None:
assert parse_kw_string("") == {}
def test_parse_arbitrary_key_value_string_empty() -> None:
assert parse_arbitrary_key_value_string("") == {}
def test_parse_kw_string_duplicate_keys() -> None:
assert parse_kw_string("key: val1; key: val2") == {
def test_parse_arbitrary_key_value_string_duplicate_keys() -> None:
assert parse_arbitrary_key_value_string("key: val1; key: val2") == {
"key": ["val1", "val2"],
}
def test_parse_kw_string_key_only_with_colon() -> None:
assert parse_kw_string("key:") == {"key": []}
def test_parse_arbitrary_key_value_string_key_only_with_colon() -> None:
assert parse_arbitrary_key_value_string("key:") == {"key": []}
def test_parse_kw_string_quoted_values() -> None:
assert parse_kw_string('key: "hello world"') == {"key": ["hello world"]}
def test_parse_arbitrary_key_value_string_quoted_values() -> None:
assert parse_arbitrary_key_value_string('key: "hello world"') == {"key": ["hello world"]}
def test_parse_kw_string_multiple_bare_keys_with_default() -> None:
def test_parse_arbitrary_key_value_string_multiple_bare_keys_with_default() -> None:
"""works, but should remain undocumented"""
assert parse_kw_string("a b c", default_kw_value="yes") == {
assert parse_arbitrary_key_value_string("a b c", default_value="yes") == {
"a": ["yes"],
"b": ["yes"],
"c": ["yes"],