polars.ScanCastOptions

class polars.ScanCastOptions(
    *,
    integer_cast: Literal['upcast',
    'allow-float',
    'forbid'] | Collection[Literal['upcast',
    'allow-float',
    'forbid']] = 'forbid',
    float_cast: Literal['upcast',
    'downcast',
    'forbid'] | Collection[Literal['upcast',
    'downcast',
    'forbid']] = 'forbid',
    datetime_cast: Literal['convert-timezone',
    'nanosecond-downcast',
    'microsecond-downcast',
    'microsecond-upcast',
    'millisecond-upcast',
    'downcast',
    'upcast',
    'forbid'] | Collection[Literal['convert-timezone',
    'nanosecond-downcast',
    'microsecond-downcast',
    'microsecond-upcast',
    'millisecond-upcast',
    'downcast',
    'upcast',
    'forbid']] = 'forbid',
    missing_struct_fields: Literal['insert',
    'raise'] = 'raise',
    extra_struct_fields: Literal['ignore',
    'raise'] = 'raise',
    categorical_to_string: Literal['allow',
    'forbid'] = 'forbid',
    _internal_call: bool = False,
)

Параметры приведения типов, применяемые при сканировании файлов.

__init__(
    *,
    integer_cast: Literal['upcast',
    'allow-float',
    'forbid'] | Collection[Literal['upcast',
    'allow-float',
    'forbid']] = 'forbid',
    float_cast: Literal['upcast',
    'downcast',
    'forbid'] | Collection[Literal['upcast',
    'downcast',
    'forbid']] = 'forbid',
    datetime_cast: Literal['convert-timezone',
    'nanosecond-downcast',
    'microsecond-downcast',
    'microsecond-upcast',
    'millisecond-upcast',
    'downcast',
    'upcast',
    'forbid'] | Collection[Literal['convert-timezone',
    'nanosecond-downcast',
    'microsecond-downcast',
    'microsecond-upcast',
    'millisecond-upcast',
    'downcast',
    'upcast',
    'forbid']] = 'forbid',
    missing_struct_fields: Literal['insert',
    'raise'] = 'raise',
    extra_struct_fields: Literal['ignore',
    'raise'] = 'raise',
    categorical_to_string: Literal['allow',
    'forbid'] = 'forbid',
    _internal_call: bool = False,
) → None

Общие параметры для сканирования файлов.

Предупреждение

Эта функциональность считается нестабильной. Она может быть изменена в любой момент без того, чтобы это считалось критическим изменением.

Параметры:

integer_cast

Параметры приведения целочисленных типов:

• upcast: Разрешает приведение без потери данных к более широким целочисленным типам.
• allow-float: Разрешает приведение целых чисел к типам с плавающей точкой.
• forbid: Вызывает ошибку, если типы данных не совпадают.

float_cast

Параметры приведения типов с плавающей точкой:

• upcast: Разрешает приведение к типам с плавающей точкой большей точности.
• downcast: Разрешает приведение к типам с плавающей точкой меньшей точности.
• forbid: Вызывает ошибку, если типы данных не совпадают.

datetime_cast

Параметры приведения типов datetime:

• nanosecond-downcast: Разрешает понижение точности datetime с точностью до наносекунд до любой меньшей точности. Это оказывает эффект, аналогичный coerce_int96_timestamp_unit в PyArrow.
• microsecond-downcast: Разрешает понижение точности datetime с точностью до микросекунд до точности до миллисекунд.
• microsecond-upcast: Разрешает повышение точности datetime с точностью до микросекунд до точности до наносекунд.
• millisecond-upcast: Разрешает повышение точности datetime с точностью до миллисекунд до точности до микросекунд или наносекунд.
• downcast: Разрешает понижение точности до любой меньшей точности (объединение параметров nanosecond-downcast и microsecond-downcast для удобства).
• upcast: Разрешает повышение точности до любой большей точности (объединение параметров millisecond-upcast и microsecond-upcast для удобства).
• convert-timezone: Разрешает приведение к другому часовому поясу.
• forbid: Вызывает ошибку, если типы данных не совпадают.

missing_struct_fields

Параметры поведения при отсутствии в данных полей struct, определённых в схеме:

• insert: Добавляет отсутствующие поля.
• raise: Вызывает ошибку.

extra_struct_fields

Параметры поведения при обнаружении в данных дополнительных полей struct, не определённых в схеме:

• ignore: Молча игнорирует.
• raise: Вызывает ошибку.

categorical_to_string

Параметры поведения при чтении столбца, ожидаемый тип которого — строковый, а тип в файле — категориальный.

• allow: Приводит категориальный тип к строковому.
• forbid: Вызывает ошибку.

Методы

__init__(*[, integer_cast, float_cast, ...])

Общие параметры для сканирования файлов.

Атрибуты

integer_cast
float_cast
datetime_cast
missing_struct_fields
extra_struct_fields
categorical_to_string