polars.read_lines

polars.read_lines(
    source: str | Path | IO[str] | IO[bytes] | bytes | list[str] | list[Path] | list[IO[str]] | list[IO[bytes]],
    *,
    name: str = 'line',
    n_rows: int | None = None,
    row_index_name: str | None = None,
    row_index_offset: int = 0,
    glob: bool = True,
    storage_options: StorageOptionsDict | None = None,
    credential_provider: CredentialProviderFunction | Literal['auto'] | None = 'auto',
    include_file_paths: str | None = None,
) → DataFrame

Читает строки из файла в столбец типа string.

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

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

Параметры:

source

Путь или пути к файлу либо каталогу. Если для сканирования облачных хранилищ требуется аутентификация, см. параметр storage_options.

name

Имя выходного столбца.

n_rows

Прекратить чтение файла parquet после чтения n_rows.

row_index_name

Если значение не равно None, в DataFrame будет добавлен столбец с индексами строк с указанным именем.

row_index_offset

Смещение, с которого начинается столбец с индексами строк (используется, только если задано имя).

glob

Раскрывать путь с использованием правил glob.

storage_options

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

В настоящее время поддерживаются облачные провайдеры AWS, GCP и Azure. Поддерживаемые ключи см. здесь:

• aws
• gcp
• azure
• Hugging Face (hf://): принимает ключ API в параметре token: {'token': '...'} либо через переменную окружения HF_TOKEN.

Если параметр storage_options не указан, Polars попытается получить эту информацию из переменных окружения.

credential_provider

Функция, вызываемая для предоставления учетных данных для доступа к облачному хранилищу. Функция должна возвращать словарь с ключами учетных данных и необязательным сроком их действия.

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

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

include_file_paths

Добавить путь к исходному файлу или файлам в виде столбца с указанным именем.

См. также

scan_lines

Примеры

>>> pl.read_lines(b"Hello\nworld")
shape: (2, 1)
┌───────┐
│ line  │
│ ---   │
│ str   │
╞═══════╡
│ Hello │
│ world │
└───────┘