Skip to content

Correct clamp annotations for callable formatters and None #516

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

Merged
hugovk merged 2 commits into from
Nov 12, 2026
Merged

Correct clamp annotations for callable formatters and None #516

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2ff89c
Correct clamp annotations for callable formatters and None
lohitredddy Oct 18, 2026
018c274
Remove eager typing import and redundant typing test
hugovk Nov 12, 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
12 changes: 7 additions & 5 deletions src/humanize/number.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

TYPE_CHECKING = False
if TYPE_CHECKING:
from collections.abc import Callable
from typing import TypeAlias

# This type can be better defined by typing.SupportsFloat
Expand Down Expand Up @@ -458,13 +459,13 @@ def scientific(value: NumberOrString, precision: int = 2) -> str:


def clamp(
value: float,
format: str = "{:}",
value: float | None,
format: str | Callable[[float], str] = "{:}",
floor: float | None = None,
ceil: float | None = None,
floor_token: str = "<",
ceil_token: str = ">",
) -> str:
) -> str | None:
"""Returns number with the specified format, clamped between floor and ceil.
If the number is larger than ceil or smaller than floor, then the respective limit
Expand All @@ -488,7 +489,7 @@ def clamp(
```
Args:
value (int, float): Input number.
value (int, float, None): Input number, or `None` to return `None`.
format (str OR callable): Can either be a formatting string, or a callable
function that receives value and returns a string.
floor (int, float): Smallest value before clamping.
Expand All @@ -499,7 +500,8 @@ def clamp(
to output.
Returns:
str: Formatted number. The output is clamped between the indicated floor and
str | None: Formatted number, or `None` when `value` is `None`.
The output is clamped between the indicated floor and
ceil. If the number is larger than ceil or smaller than floor, the output
will be prepended with a token indicating as such.
Expand Down
Loading