Collection.nth#

Collection.nth(index, *, base=0, onerror='raise') Calendar#

Returns a calendar with the nth date each period from the collection.

Allowed values for the onerror parameter:
  • ‘skip’ to skip periods where the n’th business day is not defined

  • ‘first’ to fallback to the first date in the period when the n’th

    business day is not defined

  • ‘last’ to fallback to the last date in the period when the n’th

    business day is not defined

  • ‘raise’ to raise an error if the n’th business day is not defined

Parameters:
  • index (int, slice) – the index or range of indices

  • base (0, 1) – whether indices are 0 or 1 based

  • onerror (str) – handling policy for periods the n’th business day is not defined

Return type:

Calendar