factory_tests.py

# -*- coding: utf-8 -*-
import time
from datetime import date, datetime

from chai import Chai
from dateutil import tz

from arrow import factory, util


def assertDtEqual(dt1, dt2, within=10):
    assertEqual(dt1.tzinfo, dt2.tzinfo)  # noqa: F821
    assertTrue(abs(util.total_seconds(dt1 - dt2)) < within)  # noqa: F821


class GetTests(Chai):
    def setUp(self):
        super(GetTests, self).setUp()

        self.factory = factory.ArrowFactory()

    def test_no_args(self):

        assertDtEqual(self.factory.get(), datetime.utcnow().replace(tzinfo=tz.tzutc()))

    def test_timestamp_one_arg_no_arg(self):

        no_arg = self.factory.get("1406430900").timestamp
        one_arg = self.factory.get("1406430900", "X").timestamp

        self.assertEqual(no_arg, one_arg)

    def test_one_arg_non(self):

        assertDtEqual(
            self.factory.get(None), datetime.utcnow().replace(tzinfo=tz.tzutc())
        )

    def test_struct_time(self):

        assertDtEqual(
            self.factory.get(time.gmtime()),
            datetime.utcnow().replace(tzinfo=tz.tzutc()),
        )

    def test_one_arg_timestamp(self):

        timestamp = 12345
        timestamp_dt = datetime.utcfromtimestamp(timestamp).replace(tzinfo=tz.tzutc())

        self.assertEqual(self.factory.get(timestamp), timestamp_dt)
        self.assertEqual(self.factory.get(str(timestamp)), timestamp_dt)

        timestamp = 123.45
        timestamp_dt = datetime.utcfromtimestamp(timestamp).replace(tzinfo=tz.tzutc())

        self.assertEqual(self.factory.get(timestamp), timestamp_dt)
        self.assertEqual(self.factory.get(str(timestamp)), timestamp_dt)

        # Issue 216
        timestamp = "99999999999999999999999999"
        # Python 3 raises `OverflowError`, Python 2 raises `ValueError`
        with self.assertRaises((OverflowError, ValueError)):
            self.factory.get(timestamp)

    def test_one_arg_arrow(self):

        arw = self.factory.utcnow()
        result = self.factory.get(arw)

        self.assertEqual(arw, result)

    def test_one_arg_datetime(self):

        dt = datetime.utcnow().replace(tzinfo=tz.tzutc())

        self.assertEqual(self.factory.get(dt), dt)

    def test_one_arg_date(self):

        d = date.today()
        dt = datetime(d.year, d.month, d.day, tzinfo=tz.tzutc())

        self.assertEqual(self.factory.get(d), dt)

    def test_one_arg_tzinfo(self):

        self.expected = (
            datetime.utcnow()
            .replace(tzinfo=tz.tzutc())
            .astimezone(tz.gettz("US/Pacific"))
        )

        assertDtEqual(self.factory.get(tz.gettz("US/Pacific")), self.expected)

    def test_kwarg_tzinfo(self):

        self.expected = (
            datetime.utcnow()
            .replace(tzinfo=tz.tzutc())
            .astimezone(tz.gettz("US/Pacific"))
        )

        assertDtEqual(self.factory.get(tzinfo=tz.gettz("US/Pacific")), self.expected)

    def test_one_arg_iso_str(self):

        dt = datetime.utcnow()

        assertDtEqual(self.factory.get(dt.isoformat()), dt.replace(tzinfo=tz.tzutc()))

    def test_one_arg_other(self):

        with self.assertRaises(TypeError):
            self.factory.get(object())

    def test_one_arg_bool(self):

        with self.assertRaises(TypeError):
            self.factory.get(False)

        with self.assertRaises(TypeError):
            self.factory.get(True)

    def test_two_args_datetime_tzinfo(self):

        result = self.factory.get(datetime(2013, 1, 1), tz.gettz("US/Pacific"))

        self.assertEqual(
            result._datetime, datetime(2013, 1, 1, tzinfo=tz.gettz("US/Pacific"))
        )

    def test_two_args_datetime_tz_str(self):

        result = self.factory.get(datetime(2013, 1, 1), "US/Pacific")

        self.assertEqual(
            result._datetime, datetime(2013, 1, 1, tzinfo=tz.gettz("US/Pacific"))
        )

    def test_two_args_date_tzinfo(self):

        result = self.factory.get(date(2013, 1, 1), tz.gettz("US/Pacific"))

        self.assertEqual(
            result._datetime, datetime(2013, 1, 1, tzinfo=tz.gettz("US/Pacific"))
        )

    def test_two_args_date_tz_str(self):

        result = self.factory.get(date(2013, 1, 1), "US/Pacific")

        self.assertEqual(
            result._datetime, datetime(2013, 1, 1, tzinfo=tz.gettz("US/Pacific"))
        )

    def test_two_args_datetime_other(self):

        with self.assertRaises(TypeError):
            self.factory.get(datetime.utcnow(), object())

    def test_two_args_date_other(self):

        with self.assertRaises(TypeError):
            self.factory.get(date.today(), object())

    def test_two_args_str_str(self):

        result = self.factory.get("2013-01-01", "YYYY-MM-DD")

        self.assertEqual(result._datetime, datetime(2013, 1, 1, tzinfo=tz.tzutc()))

    def test_two_args_str_tzinfo(self):

        result = self.factory.get("2013-01-01", tzinfo=tz.gettz("US/Pacific"))

        assertDtEqual(
            result._datetime, datetime(2013, 1, 1, tzinfo=tz.gettz("US/Pacific"))
        )

    def test_two_args_twitter_format(self):

        # format returned by twitter API for created_at:
        twitter_date = "Fri Apr 08 21:08:54 +0000 2016"
        result = self.factory.get(twitter_date, "ddd MMM DD HH:mm:ss Z YYYY")

        self.assertEqual(
            result._datetime, datetime(2016, 4, 8, 21, 8, 54, tzinfo=tz.tzutc())
        )

    def test_two_args_str_list(self):

        result = self.factory.get("2013-01-01", ["MM/DD/YYYY", "YYYY-MM-DD"])

        self.assertEqual(result._datetime, datetime(2013, 1, 1, tzinfo=tz.tzutc()))

    def test_two_args_unicode_unicode(self):

        result = self.factory.get(u"2013-01-01", u"YYYY-MM-DD")

        self.assertEqual(result._datetime, datetime(2013, 1, 1, tzinfo=tz.tzutc()))

    def test_two_args_other(self):

        with self.assertRaises(TypeError):
            self.factory.get(object(), object())

    def test_three_args_with_tzinfo(self):

        timefmt = "YYYYMMDD"
        d = "20150514"

        self.assertEqual(
            self.factory.get(d, timefmt, tzinfo=tz.tzlocal()),
            datetime(2015, 5, 14, tzinfo=tz.tzlocal()),
        )

    def test_three_args(self):

        self.assertEqual(
            self.factory.get(2013, 1, 1), datetime(2013, 1, 1, tzinfo=tz.tzutc())
        )

    def test_full_kwargs(self):

        self.assertEqual(
            self.factory.get(
                year=2016,
                month=7,
                day=14,
                hour=7,
                minute=16,
                second=45,
                microsecond=631092,
            ),
            datetime(2016, 7, 14, 7, 16, 45, 631092, tzinfo=tz.tzutc()),
        )

    def test_three_kwargs(self):

        self.assertEqual(
            self.factory.get(year=2016, month=7, day=14),
            datetime(2016, 7, 14, 0, 0, tzinfo=tz.tzutc()),
        )

    def test_tzinfo_string_kwargs(self):
        result = self.factory.get("2019072807", "YYYYMMDDHH", tzinfo="UTC")
        self.assertEqual(
            result._datetime, datetime(2019, 7, 28, 7, 0, 0, 0, tzinfo=tz.tzutc())
        )

    def test_insufficient_kwargs(self):

        with self.assertRaises(TypeError):
            self.factory.get(year=2016)

        with self.assertRaises(TypeError):
            self.factory.get(year=2016, month=7)

    def test_locale(self):
        result = self.factory.get("2010", "YYYY", locale="ja")
        self.assertEqual(
            result._datetime, datetime(2010, 1, 1, 0, 0, 0, 0, tzinfo=tz.tzutc())
        )

    def test_locale_kwarg_only(self):
        res = self.factory.get(locale="ja")
        self.assertEqual(res.tzinfo, tz.tzutc())

    def test_locale_with_tzinfo(self):
        res = self.factory.get(locale="ja", tzinfo=tz.gettz("Asia/Tokyo"))
        self.assertEqual(res.tzinfo, tz.gettz("Asia/Tokyo"))


class UtcNowTests(Chai):
    def setUp(self):
        super(UtcNowTests, self).setUp()

        self.factory = factory.ArrowFactory()

    def test_utcnow(self):

        assertDtEqual(
            self.factory.utcnow()._datetime,
            datetime.utcnow().replace(tzinfo=tz.tzutc()),
        )


class NowTests(Chai):
    def setUp(self):
        super(NowTests, self).setUp()

        self.factory = factory.ArrowFactory()

    def test_no_tz(self):

        assertDtEqual(self.factory.now(), datetime.now(tz.tzlocal()))

    def test_tzinfo(self):

        assertDtEqual(self.factory.now(tz.gettz("EST")), datetime.now(tz.gettz("EST")))

    def test_tz_str(self):

        assertDtEqual(self.factory.now("EST"), datetime.now(tz.gettz("EST")))