Makes localizable methods return unicode strings

Author: sdispater

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+### Changed
+
+- `format()`, `diff_for_humans()`, `in_words()` and `to_xxx_string()` methods now return unicode strings.
+
 ### Fixed
 
 - Fixed `from_format()` raising an error with the alternative formatter.

pendulum/_compat.py

@@ -21,6 +21,7 @@
 except NameError:  # Python < 3.3
     FileNotFoundError = IOError  # cf PEP-3151 
 
+
 def decode(string, encodings=None):
     if not PY2 and not isinstance(string, bytes):
         return string

pendulum/formatting/alternative_formatter.py

@@ -3,6 +3,7 @@
 import re
 import datetime
 
+from .._compat import decode
 from .formatter import Formatter
 
 
@@ -316,7 +317,7 @@ def _format_localizable_token(self, dt, token, locale):
             # Defaulting to english
             return self._format_localizable_token(dt, token, 'en')
 
-        return trans
+        return decode(trans)
 
     def parse(self, time, fmt):
         """

pendulum/formatting/classic_formatter.py

@@ -3,6 +3,7 @@
 import re
 import datetime
 
+from .._compat import decode
 from .formatter import Formatter
 
 
@@ -36,12 +37,13 @@ def format(self, dt, fmt, locale=None):
         fmt = re.sub('%(a|A|b|B|p)', lambda m: self._localize_directive(dt, m.group(1), locale), fmt)
 
         if hasattr(dt, '_datetime'):
-            return dt._datetime.strftime(fmt)
-
-        if hasattr(dt, '_time'):
-            return dt._time.strftime(fmt)
+            trans = dt._datetime.strftime(fmt)
+        elif hasattr(dt, '_time'):
+            trans = dt._time.strftime(fmt)
+        else:
+            trans = datetime.date(dt.year, dt.month, dt.day).strftime(fmt)
 
-        return datetime.date(dt.year, dt.month, dt.day).strftime(fmt)
+        return decode(trans)
 
     def _localize_directive(self, dt, directive, locale):
         """

pendulum/formatting/difference_formatter.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 
+from .._compat import decode
 from ..translator import Translator
 
 
@@ -79,7 +80,7 @@ def diff_for_humans(self, date, other=None, absolute=False, locale=None):
         time = self._translator.transchoice(unit, count, {'count': count}, locale=locale)
 
         if absolute:
-            return time
+            return decode(time)
 
         is_future = diff.invert
 
@@ -93,4 +94,6 @@ def diff_for_humans(self, date, other=None, absolute=False, locale=None):
         if try_key_exists != self._translator.transchoice(try_key_exists, count, locale=locale):
             time = self._translator.transchoice(try_key_exists, count, {'count': count}, locale=locale)
 
-        return self._translator.trans(trans_id, {'time': time}, locale=locale)
+        trans = self._translator.trans(trans_id, {'time': time}, locale=locale)
+
+        return decode(trans)

pendulum/mixins/interval.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 
+from .._compat import decode
 from .default import TranslatableMixin
 
 
@@ -49,7 +50,7 @@ def in_words(self, locale=None, separator=' ', _periods=None):
             )
             parts.append(translation)
 
-        return separator.join(parts)
+        return decode(separator.join(parts))
 
     def __str__(self):
         return self.in_words()

tests/date_tests/test_strings.py

@@ -44,7 +44,7 @@ def test_repr(self):
 
     def test_format_with_locale(self):
         d = Date(1975, 12, 25)
-        self.assertEqual('jeudi 25e jour de décembre 1975',
+        self.assertEqual(u'jeudi 25e jour de décembre 1975',
                          d.format('%A %d%_t jour de %B %Y', locale='fr'))
 
     def test_set_formatter_globally(self):

tests/formatting_tests/test_alternative_formatter.py

@@ -200,9 +200,9 @@ def test_date_formats(self):
         self.assertEqual('07:03', f.format(d, 'LT', locale='fr'))
         self.assertEqual('07:03:06', f.format(d, 'LTS', locale='fr'))
         self.assertEqual('28/08/2016', f.format(d, 'L', locale='fr'))
-        self.assertEqual('28 août 2016', f.format(d, 'LL', locale='fr'))
-        self.assertEqual('28 août 2016 07:03', f.format(d, 'LLL', locale='fr'))
-        self.assertEqual('dimanche 28 août 2016 07:03', f.format(d, 'LLLL', locale='fr'))
+        self.assertEqual(u'28 août 2016', f.format(d, 'LL', locale='fr'))
+        self.assertEqual(u'28 août 2016 07:03', f.format(d, 'LLL', locale='fr'))
+        self.assertEqual(u'dimanche 28 août 2016 07:03', f.format(d, 'LLLL', locale='fr'))
 
     def test_escape(self):
         f = AlternativeFormatter()

tests/formatting_tests/test_classic_formatter.py

@@ -20,7 +20,7 @@ def test_format_with_locale(self):
         d = Pendulum(1975, 12, 25, 14, 15, 16, tzinfo='Europe/Paris')
         f = ClassicFormatter()
         self.assertEqual(
-            'jeudi 25e jour de décembre 1975 02:15:16  +01:00',
+            u'jeudi 25e jour de décembre 1975 02:15:16  +01:00',
             f.format(d, '%A %d%_t jour de %B %Y %I:%M:%S %p %_z', locale='fr')
         )
 
@@ -46,8 +46,8 @@ def test_month(self):
         self.assertEqual('Aug', f.format(d, '%b'))
         self.assertEqual('August', f.format(d, '%B'))
 
-        self.assertEqual('août', f.format(d, '%b', locale='fr'))
-        self.assertEqual('août', f.format(d, '%B', locale='fr'))
+        self.assertEqual(u'août', f.format(d, '%b', locale='fr'))
+        self.assertEqual(u'août', f.format(d, '%B', locale='fr'))
 
     def test_strftime(self):
         f = ClassicFormatter()

tests/localization_tests/test_da.py

@@ -43,24 +43,24 @@ def diff_for_humans(self):
         self.assertEqual('2 uger siden', d.diff_for_humans())
 
         d = Pendulum.now().subtract(months=1)
-        self.assertEqual('1 måned siden', d.diff_for_humans())
+        self.assertEqual(u'1 måned siden', d.diff_for_humans())
 
         d = Pendulum.now().subtract(months=2)
-        self.assertEqual('2 måneder siden', d.diff_for_humans())
+        self.assertEqual(u'2 måneder siden', d.diff_for_humans())
 
         d = Pendulum.now().subtract(years=1)
-        self.assertEqual('1 år siden', d.diff_for_humans())
+        self.assertEqual(u'1 år siden', d.diff_for_humans())
 
         d = Pendulum.now().subtract(years=2)
-        self.assertEqual('2 år siden', d.diff_for_humans())
+        self.assertEqual(u'2 år siden', d.diff_for_humans())
 
         d = Pendulum.now().add(seconds=1)
         self.assertEqual('om 1 sekund', d.diff_for_humans())
 
         d = Pendulum.now().add(seconds=1)
         d2 = Pendulum.now()
         self.assertEqual('1 sekund efter', d.diff_for_humans(d2))
-        self.assertEqual('1 sekund før', d2.diff_for_humans(d))
+        self.assertEqual(u'1 sekund før', d2.diff_for_humans(d))
 
         self.assertEqual('1 sekund', d.diff_for_humans(d2, True))
         self.assertEqual('2 sekunder', d2.diff_for_humans(d.add(seconds=1), True))