id_translation.dio.integration.polars#

Integration for Polars types.

Module Attributes

PolarsT

Supported polars types.

Classes

PolarsIO()

Optional IO implementation for polars types.
class PolarsIO[source]#

Bases: DataStructureIO[PolarsT, str, SourceType, IdType]

Optional IO implementation for polars types.

classmethod extract(translatable, names)[source]#

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)[source]#

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

classmethod insert(translatable, names, tmap, copy)[source]#

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)[source]#

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 = 1990#

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

Set priority < 0 to disable.

class PolarsT#

Supported polars types.

alias of TypeVar(‘PolarsT’, ~polars.dataframe.frame.DataFrame, ~polars.series.series.Series)