Add timezone_abbr property shortcut to tzname()

Author: StephenBrown2

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## Unreleased
+
+### Added
+
+- Added `DateTime.timezone_abbr` property to output timezone abbreviation of current datetime.
+
 ## [2.1.0] - 2020-03-07
 
 ### Added

docs/docs/attributes_properties.md

@@ -63,6 +63,9 @@ Pendulum gives access to more attributes and properties than the default ``datet
 # Gets the timezone name
 >>> pendulum.now().timezone_name
 
+# Gets the timezone abbreviation
+>>> pendulum.now().timezone_abbr
+
 # Indicates if daylight savings time is on
 >>> dt = pendulum.datetime(2012, 1, 1, tz='America/Toronto')
 >>> dt.is_dst()

docs/docs/comparison.md

@@ -14,10 +14,14 @@ so things aren't always as they seem.
 '2012-09-05 23:26:11'
 >>> first.timezone_name
 'America/Toronto'
+>>> first.timezone_abbr
+'EDT'
 >>> second.to_datetime_string()
 '2012-09-05 20:26:11'
 >>> second.timezone_name
 'America/Vancouver'
+>>> second.timezone_abbr
+'PDT'
 
 >>> first == second
 True

docs/docs/instantiation.md

@@ -62,6 +62,8 @@ There is also the `now()` method.
 >>> now_in_london_tz = pendulum.now('Europe/London')
 >>> now_in_london_tz.timezone_name
 'Europe/London'
+>>> now_in_london_tz.timezone_abbr
+'BST'
 ```
 
 To accompany `now()`, a few other static instantiation helpers exist to create known instances.

pendulum/datetime.py

@@ -239,6 +239,10 @@ def timezone_name(self):  # type: () -> Optional[str]
 
         return tz.name
 
+    @property
+    def timezone_abbr(self):  # type: () -> Optional[str]
+        return self.tzname()
+
     @property
     def age(self):
         return self.date().diff(self.now(self.tz).date(), abs=False).in_years()

tests/datetime/test_add.py

@@ -138,6 +138,7 @@ def test_add_to_fixed_timezones():
 
     assert_datetime(dt, 2015, 3, 15, 2, 0, 0)
     assert dt.timezone_name == "-06:00"
+    assert dt.timezone_abbr == "-06:00"
     assert dt.offset == -6 * 3600
 
 
@@ -146,41 +147,47 @@ def test_add_time_to_new_transition_skipped():
 
     assert_datetime(dt, 2013, 3, 31, 1, 59, 59, 999999)
     assert dt.timezone_name == "Europe/Paris"
+    assert dt.timezone_abbr == "CET"
     assert dt.offset == 3600
     assert not dt.is_dst()
 
     dt = dt.add(microseconds=1)
 
     assert_datetime(dt, 2013, 3, 31, 3, 0, 0, 0)
     assert dt.timezone_name == "Europe/Paris"
+    assert dt.timezone_abbr == "CEST"
     assert dt.offset == 7200
     assert dt.is_dst()
 
     dt = pendulum.datetime(2013, 3, 10, 1, 59, 59, 999999, tz="America/New_York")
 
     assert_datetime(dt, 2013, 3, 10, 1, 59, 59, 999999)
     assert dt.timezone_name == "America/New_York"
+    assert dt.timezone_abbr == "EST"
     assert dt.offset == -5 * 3600
     assert not dt.is_dst()
 
     dt = dt.add(microseconds=1)
 
     assert_datetime(dt, 2013, 3, 10, 3, 0, 0, 0)
     assert dt.timezone_name == "America/New_York"
+    assert dt.timezone_abbr == "EDT"
     assert dt.offset == -4 * 3600
     assert dt.is_dst()
 
     dt = pendulum.datetime(1957, 4, 28, 1, 59, 59, 999999, tz="America/New_York")
 
     assert_datetime(dt, 1957, 4, 28, 1, 59, 59, 999999)
     assert dt.timezone_name == "America/New_York"
+    assert dt.timezone_abbr == "EST"
     assert dt.offset == -5 * 3600
     assert not dt.is_dst()
 
     dt = dt.add(microseconds=1)
 
     assert_datetime(dt, 1957, 4, 28, 3, 0, 0, 0)
     assert dt.timezone_name == "America/New_York"
+    assert dt.timezone_abbr == "EDT"
     assert dt.offset == -4 * 3600
     assert dt.is_dst()
 
@@ -190,13 +197,15 @@ def test_add_time_to_new_transition_skipped_big():
 
     assert_datetime(dt, 2013, 3, 31, 1, 0, 0, 0)
     assert dt.timezone_name == "Europe/Paris"
+    assert dt.timezone_abbr == "CET"
     assert dt.offset == 3600
     assert not dt.is_dst()
 
     dt = dt.add(weeks=1)
 
     assert_datetime(dt, 2013, 4, 7, 1, 0, 0, 0)
     assert dt.timezone_name == "Europe/Paris"
+    assert dt.timezone_abbr == "CEST"
     assert dt.offset == 7200
     assert dt.is_dst()
 
@@ -207,13 +216,15 @@ def test_add_time_to_new_transition_repeated():
 
     assert_datetime(dt, 2013, 10, 27, 2, 59, 59, 999999)
     assert dt.timezone_name == "Europe/Paris"
+    assert dt.timezone_abbr == "CEST"
     assert dt.offset == 7200
     assert dt.is_dst()
 
     dt = dt.add(microseconds=1)
 
     assert_datetime(dt, 2013, 10, 27, 2, 0, 0, 0)
     assert dt.timezone_name == "Europe/Paris"
+    assert dt.timezone_abbr == "CET"
     assert dt.offset == 3600
     assert not dt.is_dst()
 
@@ -224,13 +235,15 @@ def test_add_time_to_new_transition_repeated():
 
     assert_datetime(dt, 2013, 11, 3, 1, 59, 59, 999999)
     assert dt.timezone_name == "America/New_York"
+    assert dt.timezone_abbr == "EDT"
     assert dt.offset == -4 * 3600
     assert dt.is_dst()
 
     dt = dt.add(microseconds=1)
 
     assert_datetime(dt, 2013, 11, 3, 1, 0, 0, 0)
     assert dt.timezone_name == "America/New_York"
+    assert dt.timezone_abbr == "EST"
     assert dt.offset == -5 * 3600
     assert not dt.is_dst()
 
@@ -240,13 +253,15 @@ def test_add_time_to_new_transition_repeated_big():
 
     assert_datetime(dt, 2013, 10, 27, 1, 0, 0, 0)
     assert dt.timezone_name == "Europe/Paris"
+    assert dt.timezone_abbr == "CEST"
     assert dt.offset == 7200
     assert dt.is_dst()
 
     dt = dt.add(weeks=1)
 
     assert_datetime(dt, 2013, 11, 3, 1, 0, 0, 0)
     assert dt.timezone_name == "Europe/Paris"
+    assert dt.timezone_abbr == "CET"
     assert dt.offset == 3600
     assert not dt.is_dst()
 

tests/datetime/test_construct.py

@@ -28,29 +28,35 @@ def test_creates_an_instance_default_to_utcnow():
         now.year, now.month, now.day, now.hour, now.minute, now.second
     )
     assert now.timezone_name == p.timezone_name
+    assert now.timezone_name == p.timezone_abbr
+    assert now.timezone_abbr == p.timezone_abbr
 
     assert_datetime(p, now.year, now.month, now.day, now.hour, now.minute, now.second)
 
 
 def test_setting_timezone():
     tz = "Europe/London"
+    abbr = "BST"
     dtz = timezone(tz)
     dt = datetime.utcnow()
     offset = dtz.convert(dt).utcoffset().total_seconds() / 3600
 
     p = pendulum.datetime(dt.year, dt.month, dt.day, tz=dtz)
     assert p.timezone_name == tz
+    assert p.timezone_abbr == abbr
     assert p.offset_hours == int(offset)
 
 
 def test_setting_timezone_with_string():
     tz = "Europe/London"
+    abbr = "BST"
     dtz = timezone(tz)
     dt = datetime.utcnow()
     offset = dtz.convert(dt).utcoffset().total_seconds() / 3600
 
     p = pendulum.datetime(dt.year, dt.month, dt.day, tz=tz)
     assert p.timezone_name == tz
+    assert p.timezone_abbr == abbr
     assert p.offset_hours == int(offset)
 
 
@@ -77,22 +83,26 @@ def test_yesterday():
 def test_instance_naive_datetime_defaults_to_utc():
     now = pendulum.instance(datetime.now())
     assert now.timezone_name == "UTC"
+    assert now.timezone_abbr == "UTC"
 
 
 def test_instance_timezone_aware_datetime():
     now = pendulum.instance(datetime.now(timezone("Europe/Paris")))
     assert now.timezone_name == "Europe/Paris"
+    assert now.timezone_abbr == "CEST"
 
 
 def test_instance_timezone_aware_datetime_pytz():
     now = pendulum.instance(datetime.now(pytz.timezone("Europe/Paris")))
     assert now.timezone_name == "Europe/Paris"
+    assert now.timezone_abbr == "CEST"
 
 
 def test_instance_timezone_aware_datetime_any_tzinfo():
     dt = datetime(2016, 8, 7, 12, 34, 56, tzinfo=tz.gettz("Europe/Paris"))
     now = pendulum.instance(dt)
     assert now.timezone_name == "+02:00"
+    assert now.timezone_abbr == "+02:00"
 
 
 def test_now():
@@ -106,12 +116,14 @@ def test_now_with_fixed_offset():
     now = pendulum.now(6)
 
     assert "+06:00" == now.timezone_name
+    assert "+06:00" == now.timezone_abbr
 
 
 def test_create_with_no_transition_timezone():
     dt = pendulum.now("Etc/UTC")
 
     assert dt.timezone_name == "Etc/UTC"
+    assert dt.timezone_abbr == "UTC"
 
 
 def test_create_maintains_microseconds():
@@ -133,3 +145,4 @@ def test_local():
 
     assert_datetime(local, 2018, 2, 2, 12, 34, 56, 123456)
     assert local.timezone_name == "America/Toronto"
+    assert local.timezone_abbr == "EST"

tests/datetime/test_create_from_timestamp.py

@@ -9,15 +9,18 @@ def test_create_from_timestamp_returns_pendulum():
     d = pendulum.from_timestamp(pendulum.datetime(1975, 5, 21, 22, 32, 5).timestamp())
     assert_datetime(d, 1975, 5, 21, 22, 32, 5)
     assert d.timezone_name == "UTC"
+    assert d.timezone_abbr == "UTC"
 
 
 def test_create_from_timestamp_with_timezone_string():
     d = pendulum.from_timestamp(0, "America/Toronto")
     assert d.timezone_name == "America/Toronto"
+    assert d.timezone_abbr == "EST"
     assert_datetime(d, 1969, 12, 31, 19, 0, 0)
 
 
 def test_create_from_timestamp_with_timezone():
     d = pendulum.from_timestamp(0, timezone("America/Toronto"))
     assert d.timezone_name == "America/Toronto"
+    assert d.timezone_abbr == "EST"
     assert_datetime(d, 1969, 12, 31, 19, 0, 0)

tests/datetime/test_fluent_setters.py

@@ -72,6 +72,7 @@ def test_fluid_timezone_setter():
     new = d.set(tz="Europe/Paris")
     assert isinstance(new, datetime)
     assert "Europe/Paris" == new.timezone_name
+    assert "CEST" == new.timezone_abbr
     assert "Europe/Paris" == new.tzinfo.name
 
 
@@ -144,6 +145,7 @@ def test_replace_tzinfo():
     new = d.replace(tzinfo=pendulum.timezone("Europe/Paris"))
 
     assert new.timezone_name == "Europe/Paris"
+    assert new.timezone_abbr == "CEST"
 
 
 def test_replace_tzinfo_dst():
@@ -154,3 +156,4 @@ def test_replace_tzinfo_dst():
     assert new.is_dst()
     assert new.offset == 7200
     assert new.timezone_name == "Europe/Paris"
+    assert new.timezone_abbr == "CEST"

tests/datetime/test_from_format.py

@@ -11,6 +11,7 @@ def test_from_format_returns_datetime():
     assert_datetime(d, 1975, 5, 21, 22, 32, 11)
     assert isinstance(d, pendulum.DateTime)
     assert "UTC" == d.timezone_name
+    assert "UTC" == d.timezone_abbr
 
 
 def test_from_format_rejects_extra_text():
@@ -24,6 +25,7 @@ def test_from_format_with_timezone_string():
     )
     assert_datetime(d, 1975, 5, 21, 22, 32, 11)
     assert "Europe/London" == d.timezone_name
+    assert "BST" == d.timezone_abbr
 
 
 def test_from_format_with_timezone():
@@ -34,18 +36,21 @@ def test_from_format_with_timezone():
     )
     assert_datetime(d, 1975, 5, 21, 22, 32, 11)
     assert "Europe/London" == d.timezone_name
+    assert "BST" == d.timezone_abbr
 
 
 def test_from_format_with_escaped_elements():
     d = pendulum.from_format("1975-05-21T22:32:11+00:00", "YYYY-MM-DD[T]HH:mm:ssZ")
     assert_datetime(d, 1975, 5, 21, 22, 32, 11)
     assert "+00:00" == d.timezone_name
+    assert "+00:00" == d.timezone_abbr
 
 
 def test_from_format_with_escaped_elements_valid_tokens():
     d = pendulum.from_format("1975-05-21T22:32:11.123Z", "YYYY-MM-DD[T]HH:mm:ss.SSS[Z]")
     assert_datetime(d, 1975, 5, 21, 22, 32, 11)
     assert "UTC" == d.timezone_name
+    assert "UTC" == d.timezone_abbr
 
 
 def test_from_format_with_millis():
@@ -198,3 +203,4 @@ def test_strptime():
     assert_datetime(d, 1975, 5, 21, 22, 32, 11)
     assert isinstance(d, pendulum.DateTime)
     assert "UTC" == d.timezone_name
+    assert "UTC" == d.timezone_abbr

tests/datetime/test_getters.py

@@ -230,6 +230,14 @@ def test_timezone_name():
     assert d.timezone_name == "-05:00"
 
 
+def test_timezone_abbr():
+    d = pendulum.datetime(2000, 1, 1, tz="America/Toronto")
+    assert d.timezone_abbr == "EST"
+
+    d = pendulum.datetime(2000, 1, 1, tz=-5)
+    assert d.timezone_abbr == "-05:00"
+
+
 def test_is_future():
     with pendulum.test(DateTime(2000, 1, 1)):
         d = pendulum.now()

tests/datetime/test_naive.py

@@ -10,6 +10,7 @@ def test_naive():
     assert dt.tzinfo is None
     assert dt.timezone is None
     assert dt.timezone_name is None
+    assert dt.timezone_abbr is None
 
 
 def test_naive_add():
@@ -32,6 +33,7 @@ def test_naive_in_timezone():
 
     assert_datetime(new, 2013, 3, 31, 1, 30)
     assert new.timezone_name == "Europe/Paris"
+    assert new.timezone_abbr == "CET"
 
 
 def test_naive_in_timezone_dst():
@@ -40,6 +42,7 @@ def test_naive_in_timezone_dst():
 
     assert_datetime(new, 2013, 3, 31, 3, 30)
     assert new.timezone_name == "Europe/Paris"
+    assert new.timezone_abbr == "CEST"
 
 
 def test_add():
@@ -74,3 +77,4 @@ def test_naive_method():
     assert dt.tzinfo is None
     assert dt.timezone is None
     assert dt.timezone_name is None
+    assert dt.timezone_abbr is None