Skip to content

Reject empty keypaths separator #580

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
CodingFeng101 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Reject empty keypaths separator #580

Show file tree
Hide file tree
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
4 changes: 3 additions & 1 deletion benedict/core/keypaths.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ def keypaths(
indexes: bool = False,
sort: bool = True,
) -> list[str]:
separator = separator or "."
separator = "." if separator is None else separator
if not type_util.is_string(separator):
raise ValueError("separator argument must be a (non-empty) string.")
if not separator:
raise ValueError("separator argument must be a (non-empty) string.")
kls = keylists(d, indexes=indexes)
kps = [separator.join([f"{key}" for key in kl]) for kl in kls]
if sort:
Expand Down
4 changes: 4 additions & 0 deletions tests/core/test_keypaths.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,10 @@ def test_keypaths_with_invalid_separator(self) -> None:
with self.assertRaises(ValueError):
_ = _keypaths(i, separator=True) # type: ignore[arg-type]

def test_keypaths_with_empty_separator(self) -> None:
with self.assertRaises(ValueError):
_ = _keypaths({"a": {"b": 1}}, separator="")

def test_keypaths_without_separator(self) -> None:
i = {
"a": 1,
Expand Down