Skip to main content
`Ctrl`+`K`

# pandas.api.extensions.ExtensionArray.shift

ExtensionArray.shift(periods=1, fill_value=None)

  Shift values by desired number.

  Newly introduced missing values are filled with `self.dtype.na_value`.

  Parameters:
    periods int, default 1

      The number of periods to shift. Negative values are allowed for shifting backwards.

    fill_value object, optional

      The scalar value to use for newly introduced missing values. The default is `self.dtype.na_value`.

  Returns:
    ExtensionArray

      Shifted.

  See also

  `api.extensions.ExtensionArray.transpose`

    Return a transposed view on this array.

  `api.extensions.ExtensionArray.factorize`

    Encode the extension array as an enumerated type.

  Notes

  If `self` is empty or `periods` is 0, a copy of `self` is returned.

  If `periods > len(self)`, then an array of size len(self) is returned, with all values filled with `self.dtype.na_value`.

  For 2-dimensional ExtensionArrays, we are always shifting along axis=0.

  Examples

      >>> arr = pd.array([1, 2, 3])
      >>> arr.shift(2)
      <IntegerArray>
      [<NA>, <NA>, 1]
      Length: 3, dtype: Int64