Deprecate weekday_name, create localizing function in ccalendar.pyx

Author: mroeschke

pandas/_libs/tslibs/ccalendar.pyx

@@ -13,6 +13,9 @@ cimport numpy as np
 from numpy cimport int64_t, int32_t
 np.import_array()
 
+import locale
+from pandas.util.testing import set_locale
+from strptime import LocaleTime
 
 # ----------------------------------------------------------------------
 # Constants
@@ -36,11 +39,18 @@ cdef int32_t* _month_offset = [
 # Canonical location for other modules to find name constants
 MONTHS = ['JAN', 'FEB', 'MAR', 'APR', 'MAY', 'JUN', 'JUL',
           'AUG', 'SEP', 'OCT', 'NOV', 'DEC']
+# The first blank line is consistent with calendar.month_name in the calendar
+# standard library
+MONTHS_FULL = ['', 'January', 'February', 'March', 'April', 'May', 'June',
+               'July', 'August, 'September', 'October', 'November',
+               'December']
 MONTH_NUMBERS = {name: num for num, name in enumerate(MONTHS)}
 MONTH_ALIASES = {(num + 1): name for num, name in enumerate(MONTHS)}
 MONTH_TO_CAL_NUM = {name: num + 1 for num, name in enumerate(MONTHS)}
 
 DAYS = ['MON', 'TUE', 'WED', 'THU', 'FRI', 'SAT', 'SUN']
+DAYS_FULL = ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday',
+             'Saturday', 'Sunday']
 int_to_weekday = {num: name for num, name in enumerate(DAYS)}
 weekday_to_int = {int_to_weekday[key]: key for key in int_to_weekday}
 
@@ -172,3 +182,26 @@ cpdef int32_t get_week_of_year(int year, int month, int day) nogil:
             woy = 1
 
     return woy
+
+
+cpdef get_locale_names(object name_type, object time_locale=None) nogil:
+    """Returns an array of localized day or month names
+
+    Parameters
+    ----------
+    name_type : string, attribute of LocaleTime() in which to return localized
+        names
+    locale : string
+
+    Returns
+    -------
+    names : list
+
+    """
+    cdef:
+        object locale_time = LocaleTime()
+        list locale_names
+
+    with set_locale(time_locale, locale.LC_TIME):
+        locale_names = getattr(LocaleTime(), name_type)
+    return locale_names

pandas/_libs/tslibs/fields.pyx

@@ -15,7 +15,8 @@ np.import_array()
 
 
 from ccalendar cimport (get_days_in_month, is_leapyear, dayofweek,
-                        get_week_of_year)
+                        get_week_of_year, get_locale_names, MONTHS_FULL,
+                        DAYS_FULL)
 from np_datetime cimport (pandas_datetimestruct, pandas_timedeltastruct,
                           dt64_to_dtstruct, td64_to_tdstruct)
 from nattype cimport NPY_NAT
@@ -100,15 +101,12 @@ def get_date_name_field(ndarray[int64_t] dtindex, object field,
         ndarray[object] out
         pandas_datetimestruct dts
         int dow
-        object locale_time = LocaleTime()
 
     count = len(dtindex)
     out = np.empty(count, dtype=object)
 
     if field == 'weekday_name':
-        _dayname = np.array(['Monday', 'Tuesday', 'Wednesday', 'Thursday',
-                             'Friday', 'Saturday', 'Sunday'],
-                            dtype=np.object_)
+        _dayname = np.array(DAYS_FULL, dtype=np.object_)
         for i in range(count):
             if dtindex[i] == NPY_NAT:
                 out[i] = np.nan
@@ -119,13 +117,10 @@ def get_date_name_field(ndarray[int64_t] dtindex, object field,
             out[i] = _dayname[dow]
     if field == 'day_name':
         if time_locale is None:
-            _dayname = np.array(['monday', 'tuesday', 'wednesday', 'thursday',
-                                 'friday', 'saturday', 'sunday'],
-                                dtype=np.object_)
+            _dayname = np.array(DAYS_FULL, dtype=np.object_)
         else:
-            with set_locale(time_locale, locale.LC_TIME):
-                locale_time = LocaleTime()
-                _dayname = np.array(locale_time.f_weekday, dtype=np.object_)
+            _dayname = np.array(get_locale_names('f_weekday', time_locale),
+                                dtype=np.object_)
         for i in range(count):
             if dtindex[i] == NPY_NAT:
                 out[i] = np.nan
@@ -137,13 +132,10 @@ def get_date_name_field(ndarray[int64_t] dtindex, object field,
         return out
     elif field == 'month_name':
         if time_locale is None:
-            _monthname = np.array(['', 'monday', 'tuesday', 'wednesday',
-                                   'thursday', 'friday', 'saturday', 'sunday'],
-                                  dtype=np.object_)
+            _monthname = np.array(MONTHS_FULL, dtype=np.object_)
         else:
-            with set_locale(time_locale, locale.LC_TIME):
-                locale_time = LocaleTime()
-                _monthname = np.array(locale_time.f_month, dtype=np.object_)
+            _monthname = np.array(get_locale_names('f_month', time_locale),
+                                  dtype=np.object_)
         for i in range(count):
             if dtindex[i] == NPY_NAT:
                 out[i] = np.nan

pandas/_libs/tslibs/nattype.pyx

@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
 # cython: profile=False
-import warnings
 
 from cpython cimport (
     PyFloat_Check, PyComplex_Check,
@@ -38,30 +37,24 @@ _nat_scalar_rules[Py_GE] = False
 
 # ----------------------------------------------------------------------
 
+def _make_missing_value_func(func_name, missing_value, doc):
+    """Generate function that returns a missing value
 
-def _make_nan_func(func_name, cls):
-    def f(*args, **kwargs):
-        return np.nan
+    Parameters
+    ----------
+    func_name : string
+    missing_value : nan value
+    doc: string
 
-    f.__name__ = func_name
-    if isinstance(cls, str):
-        # passed the literal docstring directly
-        f.__doc__ = cls
-    else:
-        f.__doc__ = getattr(cls, func_name).__doc__
-    return f
-
-
-def _make_nat_func(func_name, cls):
+    Returns
+    -------
+    f : function
+    """
     def f(*args, **kwargs):
-        return NaT
+        return missing_value
 
     f.__name__ = func_name
-    if isinstance(cls, str):
-        # passed the literal docstring directly
-        f.__doc__ = cls
-    else:
-        f.__doc__ = getattr(cls, func_name).__doc__
+    f.__doc__ = doc
     return f
 
 
@@ -323,9 +316,10 @@ class NaTType(_NaT):
     # These are the ones that can get their docstrings from datetime.
 
     # nan methods
-    weekday = _make_nan_func('weekday', datetime)
-    isoweekday = _make_nan_func('isoweekday', datetime)
-    month_name = _make_nan_func('month_name',  # noqa:E128
+    weekday = _make_missing_value_func('weekday', np.nan, datetime.__doc__)
+    isoweekday = _make_missing_value_func('isoweekday', np.nan,
+                                          datetime.__doc__)
+    month_name = _make_missing_value_func('month_name',  np.nan,  # noqa:E128
         """
         Return the month name of the Timestamp with specified locale.
 
@@ -338,7 +332,7 @@ class NaTType(_NaT):
         -------
         month_name : string
         """)
-    day_name = _make_nan_func('day_name',  # noqa:E128
+    day_name = _make_missing_value_func('day_name', np.nan,  # noqa:E128
         """
         Return the day name of the Timestamp with specified locale.
 
@@ -352,7 +346,7 @@ class NaTType(_NaT):
         day_name : string
         """)
     # _nat_methods
-    date = _make_nat_func('date', datetime)
+    date = _make_missing_value_func('date', NaT, datetime.__doc__)
 
     utctimetuple = _make_error_func('utctimetuple', datetime)
     timetz = _make_error_func('timetz', datetime)
@@ -442,14 +436,14 @@ class NaTType(_NaT):
         """)
 
     # _nat_methods
-    to_pydatetime = _make_nat_func('to_pydatetime',  # noqa:E128
+    to_pydatetime = _make_missing_value_func('to_pydatetime', NaT,  # noqa:E128
         """
         Convert a Timestamp object to a native Python datetime object.
 
         If warn=True, issue a warning if nanoseconds is nonzero.
         """)
 
-    now = _make_nat_func('now',  # noqa:E128
+    now = _make_missing_value_func('now', NaT,  # noqa:E128
         """
         Timestamp.now(tz=None)
 
@@ -461,7 +455,7 @@ class NaTType(_NaT):
         tz : str or timezone object, default None
             Timezone to localize to
         """)
-    today = _make_nat_func('today',  # noqa:E128
+    today = _make_missing_value_func('today', NaT,  # noqa:E128
         """
         Timestamp.today(cls, tz=None)
 
@@ -474,7 +468,7 @@ class NaTType(_NaT):
         tz : str or timezone object, default None
             Timezone to localize to
         """)
-    round = _make_nat_func('round',  # noqa:E128
+    round = _make_missing_value_func('round', NaT,  # noqa:E128
         """
         Round the Timestamp to the specified resolution
 
@@ -490,15 +484,15 @@ class NaTType(_NaT):
         ------
         ValueError if the freq cannot be converted
         """)
-    floor = _make_nat_func('floor',  # noqa:E128
+    floor = _make_missing_value_func('floor', NaT,  # noqa:E128
         """
         return a new Timestamp floored to this resolution
 
         Parameters
         ----------
         freq : a freq string indicating the flooring resolution
         """)
-    ceil = _make_nat_func('ceil',  # noqa:E128
+    ceil = _make_missing_value_func('ceil', NaT,  # noqa:E128
         """
         return a new Timestamp ceiled to this resolution
 
@@ -507,7 +501,7 @@ class NaTType(_NaT):
         freq : a freq string indicating the ceiling resolution
         """)
 
-    tz_convert = _make_nat_func('tz_convert',  # noqa:E128
+    tz_convert = _make_missing_value_func('tz_convert', NaT,  # noqa:E128
         """
         Convert tz-aware Timestamp to another time zone.
 
@@ -526,7 +520,7 @@ class NaTType(_NaT):
         TypeError
             If Timestamp is tz-naive.
         """)
-    tz_localize = _make_nat_func('tz_localize',  # noqa:E128
+    tz_localize = _make_missing_value_func('tz_localize', NaT,  # noqa:E128
         """
         Convert naive Timestamp to local time zone, or remove
         timezone from tz-aware Timestamp.
@@ -561,7 +555,7 @@ class NaTType(_NaT):
         TypeError
             If the Timestamp is tz-aware and tz is not None.
         """)
-    replace = _make_nat_func('replace',  # noqa:E128
+    replace = _make_missing_value_func('replace', NaT,  # noqa:E128
         """
         implements datetime.replace, handles nanoseconds
 

pandas/_libs/tslibs/timestamps.pyx

@@ -37,7 +37,6 @@ from np_datetime cimport (reverse_ops, cmp_scalar, check_dts_bounds,
 from timedeltas import Timedelta
 from timedeltas cimport delta_to_nanoseconds
 from timezones cimport get_timezone, is_utc, maybe_get_tz, treat_tz_as_pytz
-from strptime import LocaleTime
 
 # ----------------------------------------------------------------------
 # Constants
@@ -703,13 +702,10 @@ class Timestamp(_Timestamp):
         day_name : string
         """
         if time_locale is None:
-            days = {0: 'monday', 1: 'tuesday', 2: 'wednesday',
-                    3: 'thursday', 4: 'friday', 5: 'saturday',
-                    6: 'sunday'}
+            days = dict(enumerate(ccalendar.DAYS_FULL))
         else:
-            with set_locale(time_locale, locale.LC_TIME):
-                locale_time = LocaleTime()
-                days = dict(enumerate(locale_time.f_weekday))
+            names = ccalendar.get_locale_names('f_weekday', time_locale)
+            days = dict(enumerate(names))
         return days[self.weekday()].capitalize()
 
     def month_name(self, time_locale=None):
@@ -726,14 +722,10 @@ class Timestamp(_Timestamp):
         month_name : string
         """
         if time_locale is None:
-            months = {1: 'january', 2: 'february', 3: 'march',
-                      4: 'april', 5: 'may', 6: 'june', 7: 'july',
-                      8: 'august', 9: 'september', 10: 'october',
-                      11: 'november', 12: 'december'}
+            months = dict(enumerate(ccalendar.MONTHS_FULL))
         else:
-            with set_locale(time_locale, locale.LC_TIME):
-                locale_time = LocaleTime()
-                months = dict(enumerate(locale_time.f_month))
+            names = ccalendar.get_locale_names('f_month', time_locale)
+            months = dict(enumerate(names))
         return months[self.month].capitalize()
 
     @property
@@ -742,6 +734,9 @@ class Timestamp(_Timestamp):
         .. depreciated:: 0.23.0
             Use ``Timestamp.day_name()`` instead
         """
+        warnings.warn("`weekday_name` is deprecated and will be removed in a "
+                      "future version. Use `day_name` instead",
+                      FutureWarning, stacklevel=2)
         cdef dict wdays = {0: 'Monday', 1: 'Tuesday', 2: 'Wednesday',
                            3: 'Thursday', 4: 'Friday', 5: 'Saturday',
                            6: 'Sunday'}