Shorthand datetime

Simple package to parse shorthand datetime strings in the Elasticsearch date math format.

Using the package

# Simplest usage example
from shorthand_datetime.shorthand import parse_shorthand_datetime

string = 'now-7d'
dt = parse_shorthand_datetime(string)
print(f'{string} -> {dt}')
# Suppose the current date is 2023-10-25 12:21:45+00:00
# Output: now-7d -> 2023-10-18 12:21:45+00:00

# Example with freeze_time for testings
from freezegun import freeze_time
from shorthand_datetime import parse_shorthand_datetime

@freeze_time("2023-10-25 12:21:45+00:00")
def test_now():
    strings = ['now-7d', 'now/d', 'now-7d/d', 'now/M', 'now-1M/M',
               'now-3W+6h', 'now-1M+1W/d']
    for string in strings:
        print(f'{string} -> {parse_shorthand_datetime(string)}')

# Call the test and print the results
test_now()

Output:

now-7d -> 2023-10-18 12:21:45+00:00
now/d -> 2023-10-25 00:00:00+00:00
now-7d/d -> 2023-10-18 00:00:00+00:00
now/M -> 2023-10-01 00:00:00+00:00
now-1M/M -> 2023-09-01 00:00:00+00:00
now-3W+6h -> 2023-10-04 18:21:45+00:00
now-1M+1W/d -> 2023-10-02 00:00:00+00:00

# Example with timezone
from shorthand_datetime import parse_shorthand_datetime

# Using the timezone as a parameter
string_1 = 'now-7d'
dt_1 = parse_shorthand_datetime(string_1, tz='Europe/Brussels')

# Using the timezone as part of the string
string_2 = 'now-7d"Europe/Brussels"'
dt_2 = parse_shorthand_datetime(string_2)

assert str(dt_1.tzinfo) == str(dt_2.tzinfo) == "Europe/Brussels"

Typical examples

By default, datetime strings are parsed in UTC. However, you can specify a timezone using the tz parameter or by including it in the string.

• now-7d: current timestamp minus 7 days
• now/d: today, rounded to the start of the day
• now-7d/d: 7 days ago, rounded to the start of the day
• now/M: first day of this month
• now-1M/M: first day of previous month
• now-3W+6h: 3 weeks ago plus 6 hours
• now-1M+1W/d: 1 month ago plus 1 week, rounded to the start of the day
• now'America/New_York': current timestamp in America/New_York
• now-7d'America/New_York': 7 days ago in America/New_York

Acknowledgements

© 2024 24SEA - Monitoring Offshore Structures. All rights reserved.