DateTimeRange

DateTimeRange is a Python library to handle a time range. e.g. check whether a time is within the time range, get the intersection of time ranges, truncate a time range, iterate through a time range, and so forth.

These details have not been verified by PyPI

Project links

Project description

Summary

Installation

Installation: pip

pip install DateTimeRange

Installation: conda

conda install -c conda-forge datetimerange

Dependencies

Python 3.7+
Python package dependencies (automatically installed)

Features

Features of DateTimeRange class include:

Supported operations:
- Equation
- Addition
- Subtraction
- Intersection
- Union
- Contains
- Truncate
- Split
- Iteration
Timezone support
Daylight saving time support

Examples

Create a DateTimeRange instance from start and end datetime

Sample Code:

from datetimerange import DateTimeRange
time_range = DateTimeRange("2015-03-22T10:00:00+0900", "2015-03-22T10:10:00+0900")
str(time_range)

Output:

'2015-03-22T10:00:00+0900 - 2015-03-22T10:10:00+0900'

Create a DateTimeRange instance from a range text

Sample Code:

from datetimerange import DateTimeRange
time_range = DateTimeRange.from_range_text("2015-03-22T10:00:00+0900 - 2015-03-22T10:10:00+0900")
str(time_range)

Output:

'2015-03-22T10:00:00+0900 - 2015-03-22T10:10:00+0900'

Get an iterator

Sample Code 1:

import datetime
from datetimerange import DateTimeRange

time_range = DateTimeRange("2015-01-01T00:00:00+0900", "2015-01-04T00:00:00+0900")
for value in time_range.range(datetime.timedelta(days=1)):
    print(value)

Output 1:

2015-01-01 00:00:00+09:00
2015-01-02 00:00:00+09:00
2015-01-03 00:00:00+09:00
2015-01-04 00:00:00+09:00

Sample Code 2:

from datetimerange import DateTimeRange
from dateutil.relativedelta import relativedelta

time_range = DateTimeRange("2015-01-01T00:00:00+0900", "2016-01-01T00:00:00+0900")
for value in time_range.range(relativedelta(months=+4)):
    print(value)

Output 2:

2015-01-01 00:00:00+09:00
2015-05-01 00:00:00+09:00
2015-09-01 00:00:00+09:00
2016-01-01 00:00:00+09:00

Test whether a value within the time range

Sample Code:

from datetimerange import DateTimeRange

time_range = DateTimeRange("2015-03-22T10:00:00+0900", "2015-03-22T10:10:00+0900")
print("2015-03-22T10:05:00+0900" in time_range)
print("2015-03-22T10:15:00+0900" in time_range)

time_range_smaller = DateTimeRange("2015-03-22T10:03:00+0900", "2015-03-22T10:07:00+0900")
print(time_range_smaller in time_range)

Output:

True
False
True

Test whether a value intersects the time range

Sample Code:

from datetimerange import DateTimeRange
time_range = DateTimeRange("2015-03-22T10:00:00+0900", "2015-03-22T10:10:00+0900")
x = DateTimeRange("2015-03-22T10:05:00+0900", "2015-03-22T10:15:00+0900")
time_range.is_intersection(x)

Output:

True

Make an intersected time range

Sample Code:

from datetimerange import DateTimeRange
time_range = DateTimeRange("2015-03-22T10:00:00+0900", "2015-03-22T10:10:00+0900")
x = DateTimeRange("2015-03-22T10:05:00+0900", "2015-03-22T10:15:00+0900")
time_range.intersection(x)

Output:

2015-03-22T10:05:00+0900 - 2015-03-22T10:10:00+0900

Make an encompassed time range

Sample Code:

from datetimerange import DateTimeRange
time_range = DateTimeRange("2015-03-22T10:00:00+0900", "2015-03-22T10:10:00+0900")
x = DateTimeRange("2015-03-22T10:05:00+0900", "2015-03-22T10:15:00+0900")
time_range.encompass(x)

Output:

2015-03-22T10:00:00+0900 - 2015-03-22T10:15:00+0900

Truncate time range

Sample Code:

from datetimerange import DateTimeRange

time_range = DateTimeRange("2015-03-22T10:00:00+0900", "2015-03-22T10:10:00+0900")
time_range.is_output_elapse = True
print("before truncate: ", time_range)

time_range.truncate(10)
print("after truncate:  ", time_range)

Output:

before truncate:  2015-03-22T10:00:00+0900 - 2015-03-22T10:10:00+0900 (0:10:00)
after truncate:   2015-03-22T10:00:30+0900 - 2015-03-22T10:09:30+0900 (0:09:00)

For more information

More examples are available at https://datetimerange.rtfd.io/en/latest/pages/examples/index.html

Examples with Jupyter Notebook are also available at DateTimeRange.ipynb

Documentation

https://datetimerange.rtfd.io/

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

This version

2.3.0

Apr 30, 2024

2.2.1

Apr 7, 2024

2.2.0

Oct 3, 2023

2.1.1

Oct 1, 2023

2.1.0

Feb 19, 2023

2.0.0

Feb 11, 2023

1.2.0

Jul 10, 2021

1.1.0

Jun 9, 2021

1.0.0

Mar 31, 2020

0.6.1

May 11, 2019

0.6.0

May 2, 2019

0.5.5

Feb 16, 2019

0.5.4

Jan 11, 2019

0.5.3

Jan 11, 2019

0.5.2

Jan 3, 2019

0.5.1

Nov 25, 2018

0.5.0

Oct 31, 2018

0.4.0

Oct 30, 2018

0.3.7

Oct 7, 2018

0.3.6

Sep 15, 2018

0.3.5

Apr 29, 2018

0.3.4

Apr 29, 2018

0.3.3

Jul 31, 2017

0.3.2

Apr 23, 2017

0.3.1

Feb 25, 2017

0.2.8

Dec 30, 2016

0.2.7

Nov 20, 2016

0.2.6

Nov 17, 2016

0.2.5

Aug 11, 2016

0.2.4

Jul 9, 2016

0.2.3

Jul 3, 2016

0.2.2

Jun 19, 2016

0.2.1

Mar 15, 2016

0.2.0

Mar 10, 2016

0.1.3

Feb 28, 2016

0.1.2

Feb 25, 2016

0.1.1

Feb 20, 2016

0.1.0

Feb 19, 2016

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

datetimerange-2.3.0.tar.gz (39.6 kB view hashes)

Uploaded Apr 30, 2024 Source

Built Distribution

DateTimeRange-2.3.0-py3-none-any.whl (10.4 kB view hashes)

Uploaded Apr 30, 2024 Python 3

Hashes for datetimerange-2.3.0.tar.gz

Hashes for datetimerange-2.3.0.tar.gz
Algorithm	Hash digest
SHA256	`55a999d205d6aae73d526b6c38325c25b67a918285354770c5d494f595e9f1e0`
MD5	`ad92349c8421e0bff55155a99b345e29`
BLAKE2b-256	`9c746696a376e8e7288e5a818ef68daea423585293c8d18c1e9ffa26fd171230`

Hashes for DateTimeRange-2.3.0-py3-none-any.whl

Hashes for DateTimeRange-2.3.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`ba721d5dbb740b1c0fae24e4f736613fae68445c9c8a58bbd30e19624e66dec7`
MD5	`8ad9be7080d701c8f13f9ca90330243c`
BLAKE2b-256	`968bdb16ddaad58527146ea5a94ecd4282345d2c564ac5d8917d618916f70336`