API Docs

Utilities for managing the fiscal calendar.

class fiscalyear.FiscalDate

A wrapper around the builtin datetime.date class that provides the following attributes.

ctime()

Return ctime() style string.

day
fiscal_year
Returns:The fiscal year
Return type:int
fromisoformat()

str -> Construct a date from the output of date.isoformat()

fromordinal()

int -> date corresponding to a proleptic Gregorian ordinal.

fromtimestamp()

timestamp -> local date from a POSIX timestamp (like time.time()).

isocalendar()

Return a 3-tuple containing ISO year, week number, and weekday.

isoformat()

Return string in ISO 8601 format, YYYY-MM-DD.

isoweekday()

Return the day of the week represented by the date. Monday == 1 … Sunday == 7

max = datetime.date(9999, 12, 31)
min = datetime.date(1, 1, 1)
month
next_fiscal_year
Returns:The next fiscal year
Return type:FiscalYear
next_quarter
Returns:The next quarter
Return type:FiscalQuarter
prev_fiscal_year
Returns:The previous fiscal year
Return type:FiscalYear
prev_quarter
Returns:The previous quarter
Return type:FiscalQuarter
quarter
Returns:The quarter of the fiscal year
Return type:int
replace()

Return date with new specified fields.

resolution = datetime.timedelta(days=1)
strftime()

format -> strftime() style string.

timetuple()

Return time tuple, compatible with time.localtime().

today()

Current date or datetime: same as self.__class__.fromtimestamp(time.time()).

toordinal()

Return proleptic Gregorian ordinal. January 1 of year 1 is day 1.

weekday()

Return the day of the week represented by the date. Monday == 0 … Sunday == 6

year
class fiscalyear.FiscalDateTime

A wrapper around the builtin datetime.datetime class that provides the following attributes.

astimezone()

tz -> convert to local time in new timezone tz

combine()

date, time -> datetime with same date and time fields

ctime()

Return ctime() style string.

date()

Return date object with same year, month and day.

day
dst()

Return self.tzinfo.dst(self).

fiscal_year
Returns:The fiscal year
Return type:int
fold
fromisoformat()

string -> datetime from datetime.isoformat() output

fromordinal()

int -> date corresponding to a proleptic Gregorian ordinal.

fromtimestamp()

timestamp[, tz] -> tz’s local time from POSIX timestamp.

hour
isocalendar()

Return a 3-tuple containing ISO year, week number, and weekday.

isoformat()

[sep] -> string in ISO 8601 format, YYYY-MM-DDT[HH[:MM[:SS[.mmm[uuu]]]]][+HH:MM]. sep is used to separate the year from the time, and defaults to ‘T’. timespec specifies what components of the time to include (allowed values are ‘auto’, ‘hours’, ‘minutes’, ‘seconds’, ‘milliseconds’, and ‘microseconds’).

isoweekday()

Return the day of the week represented by the date. Monday == 1 … Sunday == 7

max = datetime.datetime(9999, 12, 31, 23, 59, 59, 999999)
microsecond
min = datetime.datetime(1, 1, 1, 0, 0)
minute
month
next_fiscal_year
Returns:The next fiscal year
Return type:FiscalYear
next_quarter
Returns:The next quarter
Return type:FiscalQuarter
now()

Returns new datetime object representing current time local to tz.

tz
Timezone object.

If no tz is specified, uses local timezone.

prev_fiscal_year
Returns:The previous fiscal year
Return type:FiscalYear
prev_quarter
Returns:The previous quarter
Return type:FiscalQuarter
quarter
Returns:The quarter of the fiscal year
Return type:int
replace()

Return datetime with new specified fields.

resolution = datetime.timedelta(microseconds=1)
second
strftime()

format -> strftime() style string.

strptime()

string, format -> new datetime parsed from a string (like time.strptime()).

time()

Return time object with same time but with tzinfo=None.

timestamp()

Return POSIX timestamp as float.

timetuple()

Return time tuple, compatible with time.localtime().

timetz()

Return time object with same time and tzinfo.

today()

Current date or datetime: same as self.__class__.fromtimestamp(time.time()).

toordinal()

Return proleptic Gregorian ordinal. January 1 of year 1 is day 1.

tzinfo
tzname()

Return self.tzinfo.tzname(self).

utcfromtimestamp()

Construct a naive UTC datetime from a POSIX timestamp.

utcnow()

Return a new datetime representing UTC day and time.

utcoffset()

Return self.tzinfo.utcoffset(self).

utctimetuple()

Return UTC time tuple, compatible with time.localtime().

weekday()

Return the day of the week represented by the date. Monday == 0 … Sunday == 6

year
class fiscalyear.FiscalQuarter

A class representing a single fiscal quarter.

classmethod current()

Alternative constructor. Returns the current FiscalQuarter.

Returns:A newly constructed FiscalQuarter object
Return type:FiscalQuarter
end
Returns:The end of the fiscal quarter
Return type:FiscalDateTime
fiscal_year
Returns:The fiscal year
Return type:int
next_quarter
Returns:The next fiscal quarter
Return type:int
prev_quarter
Returns:The previous fiscal quarter
Return type:FiscalQuarter
quarter
Returns:The fiscal quarter
Return type:int
start
Returns:The start of the fiscal quarter
Return type:FiscalDateTime
class fiscalyear.FiscalYear

A class representing a single fiscal year.

classmethod current()

Alternative constructor. Returns the current FiscalYear.

Returns:A newly constructed FiscalYear object
Return type:FiscalYear
end
Returns:End of the fiscal year
Return type:FiscalDateTime
fiscal_year
Returns:The fiscal year
Return type:int
next_fiscal_year
Returns:The next fiscal year
Return type:FiscalYear
prev_fiscal_year
Returns:The previous fiscal year
Return type:FiscalYear
q1
Returns:The first quarter of the fiscal year
Return type:FiscalQuarter
q2
Returns:The second quarter of the fiscal year
Return type:FiscalQuarter
q3
Returns:The third quarter of the fiscal year
Return type:FiscalQuarter
q4
Returns:The fourth quarter of the fiscal year
Return type:FiscalQuarter
start
Returns:Start of the fiscal year
Return type:FiscalDateTime
fiscalyear.fiscal_calendar(start_year=None, start_month=None, start_day=None)

A context manager that lets you modify the start of the fiscal calendar inside the scope of a with-statement.

Parameters:
  • start_year (str) – Relationship between the start of the fiscal year and the calendar year. Possible values: 'previous' or 'same'.
  • start_month (int or str) – The first month of the fiscal year
  • start_day (int or str) – The first day of the first month of the fiscal year
Raises:
  • ValueError – If start_year is not 'previous' or 'same'
  • TypeError – If start_month or start_day is not an int or int-like string
  • ValueError – If start_month or start_day is out of range
fiscalyear.setup_fiscal_calendar(start_year=None, start_month=None, start_day=None)

Modify the start of the fiscal calendar.

Parameters:
  • start_year (str) – Relationship between the start of the fiscal year and the calendar year. Possible values: 'previous' or 'same'.
  • start_month (int or str) – The first month of the fiscal year
  • start_day (int or str) – The first day of the first month of the fiscal year
Raises:
  • ValueError – If start_year is not 'previous' or 'same'
  • TypeError – If start_month or start_day is not an int or int-like string
  • ValueError – If start_month or start_day is out of range