Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 11 additions & 9 deletions src/humanize/lists.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@

TYPE_CHECKING = False
if TYPE_CHECKING:
from collections.abc import Iterable
from typing import Any

__all__ = ["natural_list"]


def natural_list(items: list[Any]) -> str:
def natural_list(items: Iterable[Any]) -> str:
"""Natural list.

Convert a list of items into a human-readable string with commas and 'and'.
Convert an iterable of items into a human-readable string with commas and 'and'.

Examples:
>>> natural_list(["one", "two", "three"])
Expand All @@ -23,16 +24,17 @@ def natural_list(items: list[Any]) -> str:
'one'

Args:
items (list): An iterable of items.
items (Iterable): An iterable of items.

Returns:
str: A string with commas and 'and' in the right places.
"""
if not items:
item_list = [str(item) for item in items]
if not item_list:
return ""
if len(items) == 1:
return str(items[0])
elif len(items) == 2:
return f"{str(items[0])} and {str(items[1])}"
if len(item_list) == 1:
return item_list[0]
elif len(item_list) == 2:
return f"{item_list[0]} and {item_list[1]}"
else:
return ", ".join([str(item) for item in items[:-1]]) + f" and {str(items[-1])}"
return ", ".join(item_list[:-1]) + f" and {item_list[-1]}"
13 changes: 10 additions & 3 deletions tests/test_lists.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
from __future__ import annotations

from collections.abc import Iterable
from typing import Any

import pytest

import humanize
Expand All @@ -16,9 +19,13 @@
([[""]], ""),
([[1, 2, 3]], "1, 2 and 3"),
([[1, "two"]], "1 and two"),
([("one", "two", "three")], "one, two and three"),
([("one", "two")], "one and two"),
([("one",)], "one"),
([{"one": 1, "two": 2}.keys()], "one and two"),
([(x for x in ["one", "two", "three"])], "one, two and three"),
([range(1, 4)], "1, 2 and 3"),
],
)
def test_natural_list(
test_args: list[str] | list[int] | list[str | int], expected: str
) -> None:
def test_natural_list(test_args: Iterable[Any], expected: str) -> None:
assert humanize.natural_list(*test_args) == expected