pandas_uuid API

class pandas_uuid.BaseUuidArray

Bases: ExtensionArray, ABC

Base class for UuidArray and ArrowUuidArray.

abstractmethod classmethod random(size: int, *, rng: int | np.random.Generator | None = None) → Self

Generate an array of random UUIDs.

class pandas_uuid.UuidArray(values: Iterable[UuidLike], *, copy: bool = False, dtype: UuidDtype | None = None)

Bases: BaseUuidArray, NumpyExtensionArray

Extension array for storing uuid data in a numpy.ndarray.

class pandas_uuid.ArrowUuidArray(values: Iterable[UuidLike | NAType | None] | pa.UuidArray | pa.ChunkedArray[pa.UuidScalar], *, dtype: UuidDtype | None = None)

Bases: BaseUuidArray, ArrowExtensionArray

Extension array for storing uuid data in a pyarrow.ChunkedArray.

class pandas_uuid.UuidDtype(storage: UuidStorage = <factory>)

Bases: ExtensionDtype

Pandas extension dtype for UUIDs.

storage: UuidStorage

Storage kind, either "numpy" or "pyarrow".

property na_value: NAType

Returns pandas.NA, i.e. this dtype has missing value semantics.

type pandas_uuid.UuidStorage = Literal['numpy', 'pyarrow']

Supported storage backend for UuidDtype.

type pandas_uuid.UuidLike = UUID | UuidScalar | bytes | int | str

Supported element types when creating a BaseUuidArray from a sequence.