Skip to content

Commit 8fd5dee

Browse files
committed
DOC/BUG: Enforce that freq is required in Period.now
1 parent 7ebc3e8 commit 8fd5dee

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

pandas/_libs/tslibs/period.pyx

+6-1
Original file line numberDiff line numberDiff line change
@@ -2288,9 +2288,14 @@ cdef class _Period(PeriodMixin):
22882288
return bool(is_leapyear(self.year))
22892289

22902290
@classmethod
2291-
def now(cls, freq=None):
2291+
def now(cls, freq):
22922292
"""
22932293
Return the period of now's date.
2294+
2295+
Parameters
2296+
----------
2297+
freq : str, BaseOffset
2298+
Frequency to use for the returned period.
22942299
"""
22952300
return Period(datetime.now(), freq=freq)
22962301

pandas/tests/scalar/period/test_period.py

+7
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,13 @@ def test_construction(self):
7676
assert i1 == i2
7777
assert i1 == i3
7878

79+
i1 = Period.now("D")
80+
i2 = Period(datetime.now(), freq="D")
81+
i3 = Period.now(offsets.Day())
82+
83+
assert i1 == i2
84+
assert i1 == i3
85+
7986
i1 = Period("1982", freq="min")
8087
i2 = Period("1982", freq="MIN")
8188
assert i1 == i2

0 commit comments

Comments
 (0)