328 lines
11 KiB
Python
328 lines
11 KiB
Python
|
from collections.abc import (
|
||
|
|
Callable,
|
||
|
|
Hashable,
|
||
|
|
Iterable,
|
||
|
|
Mapping,
|
||
|
|
Sequence,
|
||
|
|
)
|
||
|
|
from types import TracebackType
|
||
|
|
from typing import (
|
||
|
|
Any,
|
||
|
|
Literal,
|
||
|
|
overload,
|
||
|
|
)
|
||
|
|
|
||
|
|
from odf.opendocument import OpenDocument
|
||
|
|
from openpyxl.workbook.workbook import Workbook
|
||
|
|
from pandas.core.frame import DataFrame
|
||
|
|
import pyxlsb.workbook
|
||
|
|
from typing_extensions import Self
|
||
|
|
from xlrd.book import Book
|
||
|
|
|
||
|
|
from pandas._libs.lib import _NoDefaultDoNotUse
|
||
|
|
from pandas._typing import (
|
||
|
|
Dtype,
|
||
|
|
DtypeBackend,
|
||
|
|
ExcelReadEngine,
|
||
|
|
ExcelWriteEngine,
|
||
|
|
ExcelWriterIfSheetExists,
|
||
|
|
FilePath,
|
||
|
|
IntStrT,
|
||
|
|
ListLikeHashable,
|
||
|
|
ReadBuffer,
|
||
|
|
StorageOptions,
|
||
|
|
UsecolsArgType,
|
||
|
|
WriteExcelBuffer,
|
||
|
|
)
|
||
|
|
|
||
|
|
@overload
|
||
|
|
def read_excel(
|
||
|
|
io: (
|
||
|
|
FilePath
|
||
|
|
| ReadBuffer[bytes]
|
||
|
|
| ExcelFile
|
||
|
|
| Workbook
|
||
|
|
| Book
|
||
|
|
| OpenDocument
|
||
|
|
| pyxlsb.workbook.Workbook
|
||
|
|
),
|
||
|
|
sheet_name: list[IntStrT],
|
||
|
|
*,
|
||
|
|
header: int | Sequence[int] | None = ...,
|
||
|
|
names: ListLikeHashable | None = ...,
|
||
|
|
index_col: int | Sequence[int] | str | None = ...,
|
||
|
|
usecols: str | UsecolsArgType = ...,
|
||
|
|
dtype: str | Dtype | Mapping[str, str | Dtype] | None = ...,
|
||
|
|
engine: ExcelReadEngine | None = ...,
|
||
|
|
converters: Mapping[int | str, Callable[[object], object]] | None = ...,
|
||
|
|
true_values: Iterable[Hashable] | None = ...,
|
||
|
|
false_values: Iterable[Hashable] | None = ...,
|
||
|
|
skiprows: int | Sequence[int] | Callable[[object], bool] | None = ...,
|
||
|
|
nrows: int | None = ...,
|
||
|
|
na_values: Sequence[str] | dict[str | int, Sequence[str]] | None = ...,
|
||
|
|
keep_default_na: bool = ...,
|
||
|
|
na_filter: bool = ...,
|
||
|
|
verbose: bool = ...,
|
||
|
|
parse_dates: (
|
||
|
|
bool
|
||
|
|
| Sequence[int]
|
||
|
|
| Sequence[Sequence[str] | Sequence[int]]
|
||
|
|
| dict[str, Sequence[int] | list[str]]
|
||
|
|
) = ...,
|
||
|
|
date_format: dict[Hashable, str] | str | None = ...,
|
||
|
|
thousands: str | None = ...,
|
||
|
|
decimal: str = ...,
|
||
|
|
comment: str | None = ...,
|
||
|
|
skipfooter: int = ...,
|
||
|
|
storage_options: StorageOptions = ...,
|
||
|
|
dtype_backend: DtypeBackend | _NoDefaultDoNotUse = ...,
|
||
|
|
engine_kwargs: dict[str, Any] | None = ...,
|
||
|
|
) -> dict[IntStrT, DataFrame]: ...
|
||
|
|
@overload
|
||
|
|
def read_excel(
|
||
|
|
io: (
|
||
|
|
FilePath
|
||
|
|
| ReadBuffer[bytes]
|
||
|
|
| ExcelFile
|
||
|
|
| Workbook
|
||
|
|
| Book
|
||
|
|
| OpenDocument
|
||
|
|
| pyxlsb.workbook.Workbook
|
||
|
|
),
|
||
|
|
sheet_name: None,
|
||
|
|
*,
|
||
|
|
header: int | Sequence[int] | None = ...,
|
||
|
|
names: ListLikeHashable | None = ...,
|
||
|
|
index_col: int | Sequence[int] | str | None = ...,
|
||
|
|
usecols: str | UsecolsArgType = ...,
|
||
|
|
dtype: str | Dtype | Mapping[str, str | Dtype] | None = ...,
|
||
|
|
engine: ExcelReadEngine | None = ...,
|
||
|
|
converters: Mapping[int | str, Callable[[object], object]] | None = ...,
|
||
|
|
true_values: Iterable[Hashable] | None = ...,
|
||
|
|
false_values: Iterable[Hashable] | None = ...,
|
||
|
|
skiprows: int | Sequence[int] | Callable[[object], bool] | None = ...,
|
||
|
|
nrows: int | None = ...,
|
||
|
|
na_values: Sequence[str] | dict[str | int, Sequence[str]] | None = ...,
|
||
|
|
keep_default_na: bool = ...,
|
||
|
|
na_filter: bool = ...,
|
||
|
|
verbose: bool = ...,
|
||
|
|
parse_dates: (
|
||
|
|
bool
|
||
|
|
| Sequence[int]
|
||
|
|
| Sequence[Sequence[str] | Sequence[int]]
|
||
|
|
| dict[str, Sequence[int] | list[str]]
|
||
|
|
) = ...,
|
||
|
|
date_format: dict[Hashable, str] | str | None = ...,
|
||
|
|
thousands: str | None = ...,
|
||
|
|
decimal: str = ...,
|
||
|
|
comment: str | None = ...,
|
||
|
|
skipfooter: int = ...,
|
||
|
|
storage_options: StorageOptions = ...,
|
||
|
|
dtype_backend: DtypeBackend | _NoDefaultDoNotUse = ...,
|
||
|
|
engine_kwargs: dict[str, Any] | None = ...,
|
||
|
|
) -> dict[str, DataFrame]: ...
|
||
|
|
@overload
|
||
|
|
# mypy says this won't be matched
|
||
|
|
def read_excel( # type: ignore[overload-cannot-match]
|
||
|
|
io: (
|
||
|
|
FilePath
|
||
|
|
| ReadBuffer[bytes]
|
||
|
|
| ExcelFile
|
||
|
|
| Workbook
|
||
|
|
| Book
|
||
|
|
| OpenDocument
|
||
|
|
| pyxlsb.workbook.Workbook
|
||
|
|
),
|
||
|
|
sheet_name: list[int | str],
|
||
|
|
*,
|
||
|
|
header: int | Sequence[int] | None = ...,
|
||
|
|
names: ListLikeHashable | None = ...,
|
||
|
|
index_col: int | Sequence[int] | str | None = ...,
|
||
|
|
usecols: str | UsecolsArgType = ...,
|
||
|
|
dtype: str | Dtype | Mapping[str, str | Dtype] | None = ...,
|
||
|
|
engine: ExcelReadEngine | None = ...,
|
||
|
|
converters: Mapping[int | str, Callable[[object], object]] | None = ...,
|
||
|
|
true_values: Iterable[Hashable] | None = ...,
|
||
|
|
false_values: Iterable[Hashable] | None = ...,
|
||
|
|
skiprows: int | Sequence[int] | Callable[[object], bool] | None = ...,
|
||
|
|
nrows: int | None = ...,
|
||
|
|
na_values: Sequence[str] | dict[str | int, Sequence[str]] | None = ...,
|
||
|
|
keep_default_na: bool = ...,
|
||
|
|
na_filter: bool = ...,
|
||
|
|
verbose: bool = ...,
|
||
|
|
parse_dates: (
|
||
|
|
bool
|
||
|
|
| Sequence[int]
|
||
|
|
| Sequence[Sequence[str] | Sequence[int]]
|
||
|
|
| dict[str, Sequence[int] | list[str]]
|
||
|
|
) = ...,
|
||
|
|
date_format: dict[Hashable, str] | str | None = ...,
|
||
|
|
thousands: str | None = ...,
|
||
|
|
decimal: str = ...,
|
||
|
|
comment: str | None = ...,
|
||
|
|
skipfooter: int = ...,
|
||
|
|
storage_options: StorageOptions = ...,
|
||
|
|
dtype_backend: DtypeBackend | _NoDefaultDoNotUse = ...,
|
||
|
|
engine_kwargs: dict[str, Any] | None = ...,
|
||
|
|
) -> dict[int | str, DataFrame]: ...
|
||
|
|
@overload
|
||
|
|
def read_excel(
|
||
|
|
io: (
|
||
|
|
FilePath
|
||
|
|
| ReadBuffer[bytes]
|
||
|
|
| ExcelFile
|
||
|
|
| Workbook
|
||
|
|
| Book
|
||
|
|
| OpenDocument
|
||
|
|
| pyxlsb.workbook.Workbook
|
||
|
|
),
|
||
|
|
sheet_name: int | str = ...,
|
||
|
|
*,
|
||
|
|
header: int | Sequence[int] | None = ...,
|
||
|
|
names: ListLikeHashable | None = ...,
|
||
|
|
index_col: int | Sequence[int] | str | None = ...,
|
||
|
|
usecols: str | UsecolsArgType = ...,
|
||
|
|
dtype: str | Dtype | Mapping[str, str | Dtype] | None = ...,
|
||
|
|
engine: ExcelReadEngine | None = ...,
|
||
|
|
converters: Mapping[int | str, Callable[[object], object]] | None = ...,
|
||
|
|
true_values: Iterable[Hashable] | None = ...,
|
||
|
|
false_values: Iterable[Hashable] | None = ...,
|
||
|
|
skiprows: int | Sequence[int] | Callable[[object], bool] | None = ...,
|
||
|
|
nrows: int | None = ...,
|
||
|
|
na_values: Sequence[str] | dict[str | int, Sequence[str]] | None = ...,
|
||
|
|
keep_default_na: bool = ...,
|
||
|
|
na_filter: bool = ...,
|
||
|
|
verbose: bool = ...,
|
||
|
|
parse_dates: (
|
||
|
|
bool
|
||
|
|
| Sequence[int]
|
||
|
|
| Sequence[Sequence[str] | Sequence[int]]
|
||
|
|
| dict[str, Sequence[int] | list[str]]
|
||
|
|
) = ...,
|
||
|
|
date_format: dict[Hashable, str] | str | None = ...,
|
||
|
|
thousands: str | None = ...,
|
||
|
|
decimal: str = ...,
|
||
|
|
comment: str | None = ...,
|
||
|
|
skipfooter: int = ...,
|
||
|
|
storage_options: StorageOptions = ...,
|
||
|
|
dtype_backend: DtypeBackend | _NoDefaultDoNotUse = ...,
|
||
|
|
engine_kwargs: dict[str, Any] | None = ...,
|
||
|
|
) -> DataFrame: ...
|
||
|
|
|
||
|
|
class ExcelWriter:
|
||
|
|
def __init__(
|
||
|
|
self,
|
||
|
|
path: FilePath | WriteExcelBuffer | ExcelWriter,
|
||
|
|
engine: ExcelWriteEngine | Literal["auto"] | None = ...,
|
||
|
|
date_format: str | None = ...,
|
||
|
|
datetime_format: str | None = ...,
|
||
|
|
mode: Literal["w", "a"] = ...,
|
||
|
|
storage_options: StorageOptions = ...,
|
||
|
|
if_sheet_exists: ExcelWriterIfSheetExists | None = ...,
|
||
|
|
engine_kwargs: dict[str, Any] | None = ...,
|
||
|
|
) -> None: ...
|
||
|
|
@property
|
||
|
|
def supported_extensions(self) -> tuple[str, ...]: ...
|
||
|
|
@property
|
||
|
|
def engine(self) -> ExcelWriteEngine: ...
|
||
|
|
@property
|
||
|
|
def sheets(self) -> dict[str, Any]: ...
|
||
|
|
@property
|
||
|
|
def book(self) -> Workbook | OpenDocument: ...
|
||
|
|
@property
|
||
|
|
def date_format(self) -> str: ...
|
||
|
|
@property
|
||
|
|
def datetime_format(self) -> str: ...
|
||
|
|
@property
|
||
|
|
def if_sheet_exists(self) -> Literal["error", "new", "replace", "overlay"]: ...
|
||
|
|
def __fspath__(self) -> str: ...
|
||
|
|
def __enter__(self) -> Self: ...
|
||
|
|
def __exit__(
|
||
|
|
self,
|
||
|
|
exc_type: type[BaseException] | None,
|
||
|
|
exc_value: BaseException | None,
|
||
|
|
traceback: TracebackType | None,
|
||
|
|
) -> None: ...
|
||
|
|
def close(self) -> None: ...
|
||
|
|
|
||
|
|
class ExcelFile:
|
||
|
|
engine = ...
|
||
|
|
io: FilePath | ReadBuffer[bytes] | bytes = ...
|
||
|
|
def __init__(
|
||
|
|
self,
|
||
|
|
path_or_buffer: FilePath | ReadBuffer[bytes] | bytes,
|
||
|
|
engine: ExcelReadEngine | None = ...,
|
||
|
|
storage_options: StorageOptions = ...,
|
||
|
|
engine_kwargs: dict[str, Any] | None = ...,
|
||
|
|
) -> None: ...
|
||
|
|
def __fspath__(self): ...
|
||
|
|
@overload
|
||
|
|
def parse(
|
||
|
|
self,
|
||
|
|
sheet_name: list[int | str] | None,
|
||
|
|
header: int | Sequence[int] | None = ...,
|
||
|
|
names: ListLikeHashable | None = ...,
|
||
|
|
index_col: int | Sequence[int] | None = ...,
|
||
|
|
usecols: str | UsecolsArgType = ...,
|
||
|
|
converters: dict[int | str, Callable[[object], object]] | None = ...,
|
||
|
|
true_values: Iterable[Hashable] | None = ...,
|
||
|
|
false_values: Iterable[Hashable] | None = ...,
|
||
|
|
skiprows: int | Sequence[int] | Callable[[object], bool] | None = ...,
|
||
|
|
nrows: int | None = ...,
|
||
|
|
na_values: Sequence[str] | dict[str | int, Sequence[str]] = ...,
|
||
|
|
parse_dates: (
|
||
|
|
bool
|
||
|
|
| Sequence[int]
|
||
|
|
| Sequence[Sequence[str] | Sequence[int]]
|
||
|
|
| dict[str, Sequence[int] | list[str]]
|
||
|
|
) = ...,
|
||
|
|
date_parser: Callable | None = ...,
|
||
|
|
thousands: str | None = ...,
|
||
|
|
comment: str | None = ...,
|
||
|
|
skipfooter: int = ...,
|
||
|
|
keep_default_na: bool = ...,
|
||
|
|
na_filter: bool = ...,
|
||
|
|
**kwds: Any,
|
||
|
|
) -> dict[int | str, DataFrame]: ...
|
||
|
|
@overload
|
||
|
|
def parse(
|
||
|
|
self,
|
||
|
|
sheet_name: int | str,
|
||
|
|
header: int | Sequence[int] | None = ...,
|
||
|
|
names: ListLikeHashable | None = ...,
|
||
|
|
index_col: int | Sequence[int] | None = ...,
|
||
|
|
usecols: str | UsecolsArgType = ...,
|
||
|
|
converters: dict[int | str, Callable[[object], object]] | None = ...,
|
||
|
|
true_values: Iterable[Hashable] | None = ...,
|
||
|
|
false_values: Iterable[Hashable] | None = ...,
|
||
|
|
skiprows: int | Sequence[int] | Callable[[object], bool] | None = ...,
|
||
|
|
nrows: int | None = ...,
|
||
|
|
na_values: Sequence[str] | dict[str | int, Sequence[str]] = ...,
|
||
|
|
parse_dates: (
|
||
|
|
bool
|
||
|
|
| Sequence[int]
|
||
|
|
| Sequence[Sequence[str] | Sequence[int]]
|
||
|
|
| dict[str, Sequence[int] | list[str]]
|
||
|
|
) = ...,
|
||
|
|
date_parser: Callable | None = ...,
|
||
|
|
thousands: str | None = ...,
|
||
|
|
comment: str | None = ...,
|
||
|
|
skipfooter: int = ...,
|
||
|
|
keep_default_na: bool = ...,
|
||
|
|
na_filter: bool = ...,
|
||
|
|
**kwds: Any,
|
||
|
|
) -> DataFrame: ...
|
||
|
|
@property
|
||
|
|
def book(self) -> Workbook | Book | OpenDocument | pyxlsb.workbook.Workbook: ...
|
||
|
|
@property
|
||
|
|
def sheet_names(self) -> list[int | str]: ...
|
||
|
|
def close(self) -> None: ...
|
||
|
|
def __enter__(self) -> Self: ...
|
||
|
|
def __exit__(
|
||
|
|
self,
|
||
|
|
exc_type: type[BaseException] | None,
|
||
|
|
exc_value: BaseException | None,
|
||
|
|
traceback: TracebackType | None,
|
||
|
|
) -> None: ...
|
||
|
|
def __del__(self) -> None: ...
|