Address user comments

Author: mroeschke

doc/source/whatsnew/v0.23.0.txt

@@ -289,6 +289,7 @@ Deprecations
 - ``Series.valid`` is deprecated. Use :meth:`Series.dropna` instead (:issue:`18800`).
 - :func:`read_excel` has deprecated the ``skip_footer`` parameter. Use ``skipfooter`` instead (:issue:`18836`)
 - The ``is_copy`` attribute is deprecated and will be removed in a future version (:issue:`18801`).
+- :attr:`Timestamp.weekday_name`, :attr:`DatetimeIndex.weekday_name`, and :attr:`Series.dt.weekday_name` are deprecated in favor of :meth:`Timestamp.day_name`, :meth:`DatetimeIndex.day_name`, and :meth:`Series.dt.day_name` (:issue:`12806`)
 
 .. _whatsnew_0230.prior_deprecations:
 

pandas/_libs/tslibs/ccalendar.pyx

@@ -13,9 +13,6 @@ 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
@@ -42,7 +39,7 @@ MONTHS = ['JAN', 'FEB', 'MAR', 'APR', 'MAY', 'JUN', 'JUL',
 # 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',
+               '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)}
@@ -184,7 +181,7 @@ cpdef int32_t get_week_of_year(int year, int month, int day) nogil:
     return woy
 
 
-cpdef get_locale_names(object name_type, object time_locale=None) nogil:
+cpdef get_locale_names(object name_type, object time_locale=None):
     """Returns an array of localized day or month names
 
     Parameters
@@ -199,9 +196,11 @@ cpdef get_locale_names(object name_type, object time_locale=None) nogil:
 
     """
     cdef:
-        object locale_time = LocaleTime()
         list locale_names
 
+    import locale
+    from pandas.util.testing import set_locale
+    from strptime import LocaleTime
     with set_locale(time_locale, locale.LC_TIME):
         locale_names = getattr(LocaleTime(), name_type)
     return locale_names

pandas/_libs/tslibs/fields.pyx

@@ -13,10 +13,9 @@ cimport numpy as np
 from numpy cimport ndarray, int64_t, int32_t, int8_t
 np.import_array()
 
-
+from ccalendar import get_locale_names, MONTHS_FULL, DAYS_FULL
 from ccalendar cimport (get_days_in_month, is_leapyear, dayofweek,
-                        get_week_of_year, get_locale_names, MONTHS_FULL,
-                        DAYS_FULL)
+                        get_week_of_year)
 from np_datetime cimport (pandas_datetimestruct, pandas_timedeltastruct,
                           dt64_to_dtstruct, td64_to_tdstruct)
 from nattype cimport NPY_NAT
@@ -111,7 +110,8 @@ def get_date_name_field(ndarray[int64_t] dtindex, object field,
             dt64_to_dtstruct(dtindex[i], &dts)
             dow = dayofweek(dts.year, dts.month, dts.day)
             out[i] = _dayname[dow]
-    if field == 'day_name':
+        return out
+    elif field == 'day_name':
         if time_locale is None:
             _dayname = np.array(DAYS_FULL, dtype=np.object_)
         else:

pandas/_libs/tslibs/nattype.pyx

@@ -37,22 +37,18 @@ _nat_scalar_rules[Py_GE] = False
 
 # ----------------------------------------------------------------------
 
-def _make_missing_value_func(func_name, missing_value, doc):
-    """Generate function that returns a missing value
-
-    Parameters
-    ----------
-    func_name : string
-    missing_value : nan value
-    doc: string
-
-    Returns
-    -------
-    f : function
-    """
+
+def _make_nan_func(func_name, doc):
     def f(*args, **kwargs):
-        return missing_value
+        return np.nan
+    f.__name__ = func_name
+    f.__doc__ = doc
+    return f
+
 
+def _make_nat_func(func_name, doc):
+    def f(*args, **kwargs):
+        return NaT
     f.__name__ = func_name
     f.__doc__ = doc
     return f
@@ -316,10 +312,9 @@ class NaTType(_NaT):
     # These are the ones that can get their docstrings from datetime.
 
     # nan methods
-    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
+    weekday = _make_nan_func('weekday', datetime.weekday.__doc__)
+    isoweekday = _make_nan_func('isoweekday', datetime.isoweekday.__doc__)
+    month_name = _make_nan_func('month_name',  # noqa:E128
         """
         Return the month name of the Timestamp with specified locale.
 
@@ -332,7 +327,7 @@ class NaTType(_NaT):
         -------
         month_name : string
         """)
-    day_name = _make_missing_value_func('day_name', np.nan,  # noqa:E128
+    day_name = _make_nan_func('day_name', # noqa:E128
         """
         Return the day name of the Timestamp with specified locale.
 
@@ -346,7 +341,7 @@ class NaTType(_NaT):
         day_name : string
         """)
     # _nat_methods
-    date = _make_missing_value_func('date', NaT, datetime.__doc__)
+    date = _make_nat_func('date', datetime.date.__doc__)
 
     utctimetuple = _make_error_func('utctimetuple', datetime)
     timetz = _make_error_func('timetz', datetime)
@@ -436,14 +431,14 @@ class NaTType(_NaT):
         """)
 
     # _nat_methods
-    to_pydatetime = _make_missing_value_func('to_pydatetime', NaT,  # noqa:E128
+    to_pydatetime = _make_nat_func('to_pydatetime',  # noqa:E128
         """
         Convert a Timestamp object to a native Python datetime object.
 
         If warn=True, issue a warning if nanoseconds is nonzero.
         """)
 
-    now = _make_missing_value_func('now', NaT,  # noqa:E128
+    now = _make_nat_func('now',  # noqa:E128
         """
         Timestamp.now(tz=None)
 
@@ -455,7 +450,7 @@ class NaTType(_NaT):
         tz : str or timezone object, default None
             Timezone to localize to
         """)
-    today = _make_missing_value_func('today', NaT,  # noqa:E128
+    today = _make_nat_func('today',  # noqa:E128
         """
         Timestamp.today(cls, tz=None)
 
@@ -468,7 +463,7 @@ class NaTType(_NaT):
         tz : str or timezone object, default None
             Timezone to localize to
         """)
-    round = _make_missing_value_func('round', NaT,  # noqa:E128
+    round = _make_nat_func('round',  # noqa:E128
         """
         Round the Timestamp to the specified resolution
 
@@ -484,15 +479,15 @@ class NaTType(_NaT):
         ------
         ValueError if the freq cannot be converted
         """)
-    floor = _make_missing_value_func('floor', NaT,  # noqa:E128
+    floor = _make_nat_func('floor',  # noqa:E128
         """
         return a new Timestamp floored to this resolution
 
         Parameters
         ----------
         freq : a freq string indicating the flooring resolution
         """)
-    ceil = _make_missing_value_func('ceil', NaT,  # noqa:E128
+    ceil = _make_nat_func('ceil',  # noqa:E128
         """
         return a new Timestamp ceiled to this resolution
 
@@ -501,7 +496,7 @@ class NaTType(_NaT):
         freq : a freq string indicating the ceiling resolution
         """)
 
-    tz_convert = _make_missing_value_func('tz_convert', NaT,  # noqa:E128
+    tz_convert = _make_nat_func('tz_convert',  # noqa:E128
         """
         Convert tz-aware Timestamp to another time zone.
 
@@ -520,7 +515,7 @@ class NaTType(_NaT):
         TypeError
             If Timestamp is tz-naive.
         """)
-    tz_localize = _make_missing_value_func('tz_localize', NaT,  # noqa:E128
+    tz_localize = _make_nat_func('tz_localize',  # noqa:E128
         """
         Convert naive Timestamp to local time zone, or remove
         timezone from tz-aware Timestamp.
@@ -555,7 +550,7 @@ class NaTType(_NaT):
         TypeError
             If the Timestamp is tz-aware and tz is not None.
         """)
-    replace = _make_missing_value_func('replace', NaT,  # noqa:E128
+    replace = _make_nat_func('replace',  # noqa:E128
         """
         implements datetime.replace, handles nanoseconds
 

pandas/_libs/tslibs/timestamps.pyx

@@ -21,6 +21,7 @@ from util cimport (is_datetime64_object, is_timedelta64_object,
                    INT64_MAX)
 
 cimport ccalendar
+from ccalendar import get_locale_names, MONTHS_FULL, DAYS_FULL
 from conversion import tz_localize_to_utc, date_normalize
 from conversion cimport (tz_convert_single, _TSObject,
                          convert_to_tsobject, convert_datetime_to_tsobject)
@@ -699,10 +700,10 @@ class Timestamp(_Timestamp):
         day_name : string
         """
         if time_locale is None:
-            days = dict(enumerate(ccalendar.DAYS_FULL))
+            names = DAYS_FULL
         else:
-            names = ccalendar.get_locale_names('f_weekday', time_locale)
-            days = dict(enumerate(names))
+            names = get_locale_names('f_weekday', time_locale)
+        days = dict(enumerate(names))
         return days[self.weekday()].capitalize()
 
     def month_name(self, time_locale=None):
@@ -719,21 +720,21 @@ class Timestamp(_Timestamp):
         month_name : string
         """
         if time_locale is None:
-            months = dict(enumerate(ccalendar.MONTHS_FULL))
+            names = MONTHS_FULL
         else:
-            names = ccalendar.get_locale_names('f_month', time_locale)
-            months = dict(enumerate(names))
+            names = get_locale_names('f_month', time_locale)
+        months = dict(enumerate(names))
         return months[self.month].capitalize()
 
     @property
     def weekday_name(self):
         """
-        .. depreciated:: 0.23.0
+        .. deprecated:: 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)
+                      DeprecationWarning, stacklevel=3)
         cdef dict wdays = {0: 'Monday', 1: 'Tuesday', 2: 'Wednesday',
                            3: 'Thursday', 4: 'Friday', 5: 'Saturday',
                            6: 'Sunday'}

pandas/core/indexes/datetimes.py

@@ -1688,7 +1688,7 @@ def freq(self, value):
     weekday_name = _field_accessor(
         'weekday_name',
         'weekday_name',
-        "The name of day in a week (ex: Friday)\n\n.. depreciated:: 0.23.0")
+        "The name of day in a week (ex: Friday)\n\n.. deprecated:: 0.23.0")
 
     dayofyear = _field_accessor('dayofyear', 'doy',
                                 "The ordinal day of the year")

pandas/tests/indexes/datetimes/test_misc.py

@@ -329,7 +329,7 @@ def test_datetimeindex_accessors(self):
 
     # GH 12806
     @pytest.mark.skipif(not tm.get_locales(), reason='No available locales')
-    @pytest.mark.parametrize('time_locale', tm.get_locales())
+    @pytest.mark.parametrize('time_locale', tm.get_locales() + [None])
     def test_datetime_name_accessors(self, time_locale):
         with tm.set_locale(time_locale, locale.LC_TIME):
             # GH 11128
@@ -341,20 +341,22 @@ def test_datetime_name_accessors(self, time_locale):
                                            calendar.day_name,
                                            english_days):
                 # Test Monday -> Sunday
+                name = name.capitalize()
                 assert dti.weekday_name[day] == eng_name
-                assert dti.day_name(time_locale=time_locale) == name
+                assert dti.day_name(time_locale=time_locale)[day] == name
                 ts = Timestamp(datetime(2016, 4, day))
                 assert ts.weekday_name == eng_name
                 assert ts.day_name(time_locale=time_locale) == name
 
+        with tm.set_locale(time_locale, locale.LC_TIME):
             # GH 12805
             dti = DatetimeIndex(freq='M', start='2012', end='2013')
+            expected_months = calendar.month_name[1:]
             # Test January -> December
-            result = dti.month_name
-            expected = Index([month.capitalize()
-                              for month in calendar.month_name[1:]])
+            result = dti.month_name(time_locale=time_locale)
+            expected = Index([month.capitalize() for month in expected_months])
             tm.assert_index_equal(result, expected)
-            for date, expected in zip(dti, calendar.month_name[1:]):
+            for date, expected in zip(dti, expected_months):
                 result = date.month_name(time_locale=time_locale)
                 assert result == expected.capitalize()
 

pandas/tests/scalar/test_timestamp.py

@@ -625,15 +625,26 @@ def check(value, equal):
     @pytest.mark.parametrize('data',
                              [Timestamp('2017-08-28 23:00:00'),
                               Timestamp('2017-08-28 23:00:00', tz='EST')])
-    @pytest.mark.parametrize('time_locale', tm.get_locales())
-    def test_day_name(self, data, time_locale):
+    @pytest.mark.parametrize('time_locale', tm.get_locales() + [None])
+    def test_names(self, data, time_locale):
         # GH 17354
-        # Test .weekday_name and .day_name()
-        assert data.weekday_name == 'Monday'
-        with tm.set_locale(time_locale, locale.LC_TIME):
-            expected = calendar.day_name[0].capitalize()
-            result = data.day_name(time_locale)
-            assert result == expected
+        # Test .weekday_name, .day_name(), .month_name
+        with tm.assert_produces_warning(DeprecationWarning,
+                                        check_stacklevel=False):
+            assert data.weekday_name == 'Monday'
+        if time_locale is None:
+            assert data.day_name(time_locale) == 'Monday'
+            assert data.month_name(time_locale) == 'August'
+        else:
+            with tm.set_locale(time_locale, locale.LC_TIME):
+                expected = calendar.day_name[0].capitalize()
+                result = data.day_name(time_locale)
+                assert result == expected
+
+            with tm.set_locale(time_locale, locale.LC_TIME):
+                expected = calendar.month_name[8].capitalize()
+                result = data.month_name(time_locale)
+                assert result == expected
 
     def test_pprint(self):
         # GH12622