id_translation.dio.integration.pandas

Integration for Pandas types.

Module Attributes

PandasT

Supported pandas types.

Classes

PandasIO()

Optional IO implementation for pandas types.

class PandasIO

Bases: DataStructureIO[PandasT, NameType, SourceType, IdType]

Optional IO implementation for pandas types.

classmethod extract(translatable, names)

Extract IDs from translatable.

Parameters:

• translatable – Data to extract IDs from.

• names – List of names in translatable to extract IDs for.

Returns:

A dict {name: ids}.

classmethod handles_type(arg)

Return True if the implementation handles data for the type of arg.

classmethod insert(translatable, names, tmap, copy)

Insert translations into translatable.

Parameters:

• translatable – Data to translate. Modified iff copy=False.

• names – Names in translatable to translate.

• tmap – Translations for IDs in translatable.

• copy – If True, modify contents of the original translatable. Otherwise, returns a copy.

Returns:

A copy of translatable if copy=True, None otherwise.

Raises:

NotInplaceTranslatableError – If copy=False for a type which is not translatable in-place.

classmethod names(translatable)

Extract names from translatable.

Parameters:

translatable – Data to extract names from.

Returns:

A list of names to translate. Returns None if names cannot be extracted.

priority = 1999

Determines order in which IOs are considered (higher = earlier).

Set priority < 0 to disable.

class PandasT

Supported pandas types.

alias of TypeVar(‘PandasT’, ~pandas.core.frame.DataFrame, ~pandas.core.series.Series, ~pandas.core.indexes.base.Index, ~pandas.core.indexes.multi.MultiIndex)