Parse and format human-readable duration strings like "2h30m" or "1 day, 3 hours"
Project description
philiprehberger-duration
Parse and format human-readable duration strings like "2h30m" or "1 day, 3 hours".
Installation
pip install philiprehberger-duration
Usage
Parsing duration strings
from philiprehberger_duration import parse
parse("2h30m") # 9000.0
parse("1 day, 3 hours") # 97200.0
parse("500ms") # 0.5
parse("1w 2d") # 777600.0
parse("2.5h") # 9000.0
parse("150m") # 9000.0
ISO 8601 parsing
from philiprehberger_duration import parse
parse("PT2H30M") # 9000.0
parse("P1DT12H") # 129600.0
parse("PT1M30S") # 90.0
parse("PT0.5S") # 0.5
Colon format parsing
from philiprehberger_duration import parse
parse("1:30:00") # 5400.0
parse("1:05") # 65.0
parse("1:05:30.500") # 3930.5
Formatting seconds
from philiprehberger_duration import format
format(9000) # "2h 30m"
format(9000, style="long") # "2 hours, 30 minutes"
format(9000, style="colon") # "2:30:00"
format(9000, style="iso") # "PT2H30M"
format(90061.5, style="short") # "1d 1h 1m 1s 500ms"
Duration object
from philiprehberger_duration import Duration
d = Duration.from_seconds(9000)
d.hours # 2
d.minutes # 30
# Arithmetic
d2 = d + Duration(minutes=15)
d3 = d * 2
d4 = d - Duration(minutes=10)
d5 = d / 2
d6 = d // 3
# Comparisons
Duration.from_seconds(60) < Duration.from_seconds(120) # True
Duration.from_seconds(60) == Duration(minutes=1) # True
Duration(hours=1) >= Duration(minutes=30) # True
# Convert to timedelta
td = d.to_timedelta()
# String representation (short format)
str(d) # "2h 30m"
Timedelta conversion
from philiprehberger_duration import Duration
d = Duration(hours=1, minutes=30, milliseconds=500)
td = d.to_timedelta() # datetime.timedelta(seconds=5400, microseconds=500000)
API Reference
| Function / Class | Description |
|---|---|
parse(s: str) -> float |
Parse a human-readable duration string to seconds. |
format(seconds: float, *, style: str = "short") -> str |
Format seconds to a human-readable string. Styles: "short", "long", "colon", "iso". |
parse(s: str) -> float |
Also accepts ISO 8601 ("PT2H30M") and colon format ("1:30:00"). |
Duration |
Dataclass with fields: weeks, days, hours, minutes, seconds, milliseconds, microseconds. |
Duration.total_seconds() -> float |
Return total duration in seconds. |
Duration.to_timedelta() -> datetime.timedelta |
Convert to a timedelta object. |
Duration.from_seconds(s: float) -> Duration |
Create a Duration from seconds. |
Supported parse units
| Unit | Aliases |
|---|---|
| Weeks | w, week, weeks |
| Days | d, day, days |
| Hours | h, hr, hrs, hour, hours |
| Minutes | m, min, mins, minute, minutes |
| Seconds | s, sec, secs, second, seconds |
| Milliseconds | ms, millisecond, milliseconds |
| Microseconds | us, μs, microsecond, microseconds |
Development
pip install -e .
python -m pytest tests/ -v
License
MIT
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file philiprehberger_duration-0.2.1.tar.gz.
File metadata
- Download URL: philiprehberger_duration-0.2.1.tar.gz
- Upload date:
- Size: 6.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bea805322a46021f64b75b4aa0004c842becd4c84664a611ff33fb38da927740
|
|
| MD5 |
c2c7f72f8e59d666f0376db91036a67d
|
|
| BLAKE2b-256 |
1b09bd988fad35e922084b7c868e7c595acd7d534dc90f7c0629347b6df3cbd1
|
File details
Details for the file philiprehberger_duration-0.2.1-py3-none-any.whl.
File metadata
- Download URL: philiprehberger_duration-0.2.1-py3-none-any.whl
- Upload date:
- Size: 6.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
61b2e820935588c95eba809d986c9b73f1f47a39ff4af12f8529637fe597858c
|
|
| MD5 |
9a3ab32feb88e931192c0eea8f8b942f
|
|
| BLAKE2b-256 |
b87f65ddf13548a1b3f0d70574512ad67833d2ffb5f74d3258a93568adccd987
|