Skip to main content
`Ctrl`+`K`

# pandas.CategoricalDtype

class pandas.CategoricalDtype(categories=None, ordered=False)

  Type for categorical data with the categories and orderedness.

  Parameters:
    categoriessequence, optional

      Must be unique, and must not contain any nulls. The categories are stored in an Index, and if an index is provided the dtype of that index will be used.

    orderedbool or None, default False

      Whether or not this categorical is treated as a ordered categorical. None can be used to maintain the ordered value of existing categoricals when used in operations that combine categoricals, e.g. astype, and will resolve to False if there is no existing ordered to maintain.

  Attributes

  `categories` | An `Index` containing the unique categories allowed.
  `ordered` | Whether the categories have an ordered relationship.

  Methods

  None |

  See also

  `Categorical`

    Represent a categorical variable in classic R / S-plus fashion.

  Notes

  This class is useful for specifying the type of a `Categorical` independent of the values. See CategoricalDtype for more.

  Examples

      >>> t = pd.CategoricalDtype(categories=['b', 'a'], ordered=True)
      >>> pd.Series(['a', 'b', 'a', 'c'], dtype=t)
      0      a
      1      b
      2      a
      3    NaN
      dtype: category
      Categories (2, object): ['b' < 'a']

  An empty CategoricalDtype with a specific dtype can be created by providing an empty index. As follows,

      >>> pd.CategoricalDtype(pd.DatetimeIndex([])).categories.dtype
      dtype('<M8[ns]')