piper.custom.fiscal_year¶
-
piper.custom.fiscal_year(date: pandas._libs.tslibs.timestamps.Timestamp, start_month: int = 7, year_only: bool = False) → str[source]¶ Convert to fiscal year
Used with pd.Series date objects to obtain Fiscal Year information.
- Parameters
date – pd.TimeStamp object
start_month – Fiscal year starting month, default 7 (Australia)
year_only –
- Default False. Returns a 4 digit year e.g. 2019, 2020
True Returns a 2 digit year e.g. 19, 20
Examples
assert fiscal_year(pd.Timestamp('2014-01-01')) == 'FY 2013/2014' assert fiscal_year(pd.to_datetime('2014-01-01')) == 'FY 2013/2014' assert fiscal_year(pd.Timestamp('2014-01-01'), year_only=True) == 'FY 13/14' assert fiscal_year(pd.to_datetime('2014-01-01'), year_only=True) == 'FY 13/14' assert pd.isna(from_excel(np.nan)) == pd.isna(np.nan) assert pd.isna(from_excel(pd.NaT)) == pd.isna(pd.NaT) df = pd.DataFrame() df['Date'] = pd.date_range('2020-01-01', periods=12, freq='M') df['Date'] = df['Date'].apply(fiscal_year) df.head() 0 FY 2018/2019 1 FY 2018/2019 2 FY 2018/2019 3 FY 2018/2019 4 FY 2018/2019 Name: Date, dtype: object