python-humanize / python-humanize/humanize
precisedelta() silently drops the sign of negative timedeltas
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 756
- Fork
- 148
- Merge trung bình
- 6 ngày 1 giờ
- Pull request đã merge (30 ngày)
- 12
Mô tả
precisedelta() silently drops the sign of negative timedeltas — the output is byte-identical to the positive counterpart, so a negative delta rendered in any UI becomes indistinguishable from a positive one.
Version: humanize 4.16.0 / current master. Python 3.13.
Repro
import datetime as dt
from humanize import precisedelta
td = dt.timedelta(seconds=-3661)
print(precisedelta(td)) # '1 hour, 1 minute and 1 second'
print(precisedelta(dt.timedelta(seconds=3661))) # '1 hour, 1 minute and 1 second' <- identical!
The sign is lost for every unit combination (also checked minimum_unit="minutes"). Neither the docstring nor the tests mention negative inputs at all, so it's unclear whether this is intended — but the current behavior makes the function unsafe for anything that can produce signed deltas (countdown corrections, progress deltas, A/B time differences), because the rendered string carries no trace of the direction.
For comparison, sibling function naturaldelta() also uses absolute value internally, but its output vocabulary ("a moment", "an hour") reads as inherently directionless; precisedelta's numeric output does not.
Suggested resolutions (either would work)
- Preserve the sign: prefix the result with
-whenvalueis negative (mirroringstr(timedelta), which keeps the sign:str(td)→'-1 day, 1:01:01'). - Or raise / document explicitly that only non-negative values are supported.
Option 1 seems most useful and backwards-compatible for positive inputs; option 2 at least removes the silent-corruption trap.
Happy to send a PR with either behavior + tests if maintainers indicate a preference.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu từ phần triển khai precisedelta(), docstring hiện có và các bài kiểm thử của nó, sau đó chạy reproduction negative-timedelta được cung cấp, bao gồm cả trường hợp minimum_unit="minutes". Bổ sung kiểm thử hồi quy cho các giá trị âm và xác nhận rằng hành vi được chọn là nhất quán, đồng thời giữ nguyên output dương hiện có.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- backend
- Loại issue
- Lỗi
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Sôi nổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 72/100