Skip to content

added abitity to instanciate date objects #355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/docs/instantiation.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,16 @@ and will set the timezone as well or default it to `UTC`.

Finally, if you find yourself inheriting a `DateTime` instance,
you can create a `DateTime` instance via the `instance()` function.
This also works with datetime.date instances.

```python
>>> dt = datetime(2008, 1, 1)
>>> p = pendulum.instance(dt)
>>> print(p)
'2008-01-01T00:00:00+00:00'
>>> d = date(2008, 1, 1)
>>> p = pendulum.instance(d)
>>> print(p)
'2008-01-01T00:00:00+00:00'

```
9 changes: 6 additions & 3 deletions pendulum/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -172,14 +172,17 @@ def instance(
dt, tz=UTC # type: _datetime.datetime # type: Union[str, _Timezone, None]
): # type: (...) -> DateTime
"""
Create a DateTime instance from a datetime one.
Create a DateTime instance from a datetime or date.
"""
if not isinstance(dt, _datetime.datetime):
raise ValueError("instance() only accepts datetime objects.")
if not isinstance(dt, _datetime.datetime) and not isinstance(dt, _datetime.date):
raise ValueError("instance() only accepts datetime and date objects.")

if isinstance(dt, DateTime):
return dt

if isinstance(dt, _datetime.date):
dt = _datetime.datetime(dt.year, dt.month, dt.day)

tz = dt.tzinfo or tz

# Checking for pytz/tzinfo
Expand Down
7 changes: 6 additions & 1 deletion tests/datetime/test_construct.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import pendulum
import pytest

from datetime import datetime
from datetime import datetime, date
from dateutil import tz
from pendulum import DateTime
from pendulum.tz import timezone
Expand Down Expand Up @@ -77,6 +77,11 @@ def test_instance_naive_datetime_defaults_to_utc():
assert now.timezone_name == "UTC"


def test_instance_naive_date():
now = pendulum.instance(date.today())
assert now.timezone_name == "UTC"


def test_instance_timezone_aware_datetime():
now = pendulum.instance(datetime.now(timezone("Europe/Paris")))
assert now.timezone_name == "Europe/Paris"
Expand Down