extensions.rst

{{ header }}

Extensions

.. currentmodule:: pandas

These are primarily intended for library authors looking to extend pandas objects.

.. autosummary::
   :toctree: api/

   api.extensions.register_extension_dtype
   api.extensions.register_dataframe_accessor
   api.extensions.register_series_accessor
   api.extensions.register_index_accessor
   api.extensions.ExtensionDtype

.. autosummary::
   :toctree: api/
   :template: autosummary/class_without_autosummary.rst

   api.extensions.ExtensionArray
   arrays.PandasArray

Additionally, we have some utility methods for ensuring your object behaves correctly.

.. autosummary::
  :toctree: api/

  api.indexers.check_array_indexer

The sentinel pandas.api.extensions.no_default is used as the default value in some methods. Use an is comparison to check if the user provides a non-default value.