Skip to main content

Parse and format human-readable duration strings like "2h30m" or "1 day, 3 hours"

Project description

philiprehberger-duration

Tests PyPI version License

Parse and format human-readable duration strings like "2h30m" or "1 day, 3 hours".

Install

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

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

# 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".
Duration Dataclass with fields: weeks, days, hours, minutes, seconds, milliseconds.
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

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

philiprehberger_duration-0.1.4.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

philiprehberger_duration-0.1.4-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file philiprehberger_duration-0.1.4.tar.gz.

File metadata

  • Download URL: philiprehberger_duration-0.1.4.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for philiprehberger_duration-0.1.4.tar.gz
Algorithm Hash digest
SHA256 3e88ef4f9ad67030acb7ba114eae168d082bbcb723317e2efe2fa666c9c3b76b
MD5 e74c69d161852cb724ff4b897afa6afb
BLAKE2b-256 50492cf85e5105863c106db61e3aaa36705a46760ebdf24621dfbd0398485c41

See more details on using hashes here.

File details

Details for the file philiprehberger_duration-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for philiprehberger_duration-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 cb719491b41026148e224803e94dc293e60ec3f3e488af01c454773084e46575
MD5 b62d594e3e9d4fec1b9cf3f486e607a8
BLAKE2b-256 61652e8ee8e6078f645a71e40a015a8b9a54aa31f0831598adeb606e90fdbc1a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page