array_split.split.pad_with_object

array_split.split.pad_with_object(sequence, new_length, obj=None)[source]

Returns sequence list end-padded with obj elements so that the length of the returned list equals new_length.

Parameters:
  • sequence (iterable) – Return listified sequence which has been end-padded.
  • new_length (int) – The length of the returned list.
  • obj (object) – Object used as padding elements.
Return type:

list

Returns:

A list of length new_length.

Raises:

ValueError – if len(sequence) > new_length).

Example:

>>> pad_with_object([1, 2, 3], 5, obj=0)
[1, 2, 3, 0, 0]
>>> pad_with_object([1, 2, 3], 5, obj=None)
[1, 2, 3, None, None]