diff --git a/pandas/io/parsers.pyi b/pandas/io/parsers.pyi index 696616d6..aab90246 100644 --- a/pandas/io/parsers.pyi +++ b/pandas/io/parsers.pyi @@ -3,7 +3,7 @@ from collections import abc import sys from pandas._typing import FilePathOrBuffer as FilePathOrBuffer, Scalar from pandas.core.frame import DataFrame as DataFrame -from typing import Any, Callable, IO, List, Mapping, Optional, Sequence, Union, overload +from typing import Any, Callable, List, Mapping, Optional, Sequence, Union, overload if sys.version_info >= (3, 8): from typing import Literal else: @@ -11,7 +11,8 @@ else: @overload def read_csv( - reader: IO, + reader: FilePathOrBuffer, + *, sep: str = ..., delimiter: Optional[str] = ..., header: Union[int, Sequence[int], str, Literal["infer"]] = ..., @@ -41,7 +42,7 @@ def read_csv( date_parser: Optional[Callable] = ..., dayfirst: bool = ..., cache_dates: bool = ..., - iterator: bool = ..., + iterator: Literal[True], chunksize: Optional[int] = ..., compression: Optional[Union[str, Literal["infer", "gzip", "bz2", "zip", "xz"]]] = ..., thousands: Optional[str] = ..., @@ -61,10 +62,116 @@ def read_csv( memory_map: bool = ..., float_precision: Optional[str] = ..., ) -> TextFileReader: ... - @overload def read_csv( filepath: FilePathOrBuffer, + *, + sep: str = ..., + delimiter: Optional[str] = ..., + header: Union[int, Sequence[int], str, Literal["infer"]] = ..., + names: Optional[Sequence[str]] = ..., + index_col: Optional[Union[int, str, Sequence, Union[bool, Literal[False]]]] = ..., + usecols: Optional[Union[int, str, Sequence]] = ..., + squeeze: bool = ..., + prefix: Optional[str] = ..., + mangle_dupe_cols: bool = ..., + dtype: Optional[Union[str, Mapping[str, Any]]] = ..., + engine: Optional[Union[str, Literal["c", "python"]]] = ..., + converters: Optional[Mapping[Union[int, str], Callable]] = ..., + true_values: Optional[Sequence[Scalar]] = ..., + false_values: Optional[Sequence[Scalar]] = ..., + skipinitialspace: bool = ..., + skiprows: Optional[Union[Sequence, int, Callable]] = ..., + skipfooter: int = ..., + nrows: Optional[int] = ..., + na_values = ..., + keep_default_na: bool = ..., + na_filter: bool = ..., + verbose: bool = ..., + skip_blank_lines: bool = ..., + parse_dates: Union[bool, List[int], List[str]] = ..., + infer_datetime_format: bool = ..., + keep_date_col: bool = ..., + date_parser: Optional[Callable] = ..., + dayfirst: bool = ..., + cache_dates: bool = ..., + iterator: Literal[False], + chunksize: int, + compression: Optional[Union[str, Literal["infer", "gzip", "bz2", "zip", "xz"]]] = ..., + thousands: Optional[str] = ..., + decimal: Optional[str] = ..., + lineterminator: Optional[str] = ..., + quotechar: str = ..., + quoting: int = ..., + doublequote: bool = ..., + escapechar: Optional[str] = ..., + comment: Optional[str] = ..., + encoding: Optional[str] = ..., + dialect: Optional[str] = ..., + error_bad_lines: bool = ..., + warn_bad_lines: bool = ..., + delim_whitespace: bool = ..., + low_memory: bool = ..., + memory_map: bool = ..., + float_precision: Optional[str] = ..., +) -> TextFileReader: ... +@overload +def read_csv( + filepath: FilePathOrBuffer, + *, + sep: str = ..., + delimiter: Optional[str] = ..., + header: Union[int, Sequence[int], str, Literal["infer"]] = ..., + names: Optional[Sequence[str]] = ..., + index_col: Optional[Union[int, str, Sequence, Union[bool, Literal[False]]]] = ..., + usecols: Optional[Union[int, str, Sequence]] = ..., + squeeze: bool = ..., + prefix: Optional[str] = ..., + mangle_dupe_cols: bool = ..., + dtype: Optional[Union[str, Mapping[str, Any]]] = ..., + engine: Optional[Union[str, Literal["c", "python"]]] = ..., + converters: Optional[Mapping[Union[int, str], Callable]] = ..., + true_values: Optional[Sequence[Scalar]] = ..., + false_values: Optional[Sequence[Scalar]] = ..., + skipinitialspace: bool = ..., + skiprows: Optional[Union[Sequence, int, Callable]] = ..., + skipfooter: int = ..., + nrows: Optional[int] = ..., + na_values = ..., + keep_default_na: bool = ..., + na_filter: bool = ..., + verbose: bool = ..., + skip_blank_lines: bool = ..., + parse_dates: Union[bool, List[int], List[str]] = ..., + infer_datetime_format: bool = ..., + keep_date_col: bool = ..., + date_parser: Optional[Callable] = ..., + dayfirst: bool = ..., + cache_dates: bool = ..., + iterator: Literal[False] = ..., + chunksize: None = ..., + compression: Optional[Union[str, Literal["infer", "gzip", "bz2", "zip", "xz"]]] = ..., + thousands: Optional[str] = ..., + decimal: Optional[str] = ..., + lineterminator: Optional[str] = ..., + quotechar: str = ..., + quoting: int = ..., + doublequote: bool = ..., + escapechar: Optional[str] = ..., + comment: Optional[str] = ..., + encoding: Optional[str] = ..., + dialect: Optional[str] = ..., + error_bad_lines: bool = ..., + warn_bad_lines: bool = ..., + delim_whitespace: bool = ..., + low_memory: bool = ..., + memory_map: bool = ..., + float_precision: Optional[str] = ..., +) -> DataFrame: ... +@overload +def read_csv( + filepath: FilePathOrBuffer, + *, sep: str = ..., delimiter: Optional[str] = ..., header: Union[int, Sequence[int], str, Literal["infer"]] = ..., @@ -95,6 +202,111 @@ def read_csv( dayfirst: bool = ..., cache_dates: bool = ..., iterator: bool = ..., + chunksize: int = ..., + compression: Optional[Union[str, Literal["infer", "gzip", "bz2", "zip", "xz"]]] = ..., + thousands: Optional[str] = ..., + decimal: Optional[str] = ..., + lineterminator: Optional[str] = ..., + quotechar: str = ..., + quoting: int = ..., + doublequote: bool = ..., + escapechar: Optional[str] = ..., + comment: Optional[str] = ..., + encoding: Optional[str] = ..., + dialect: Optional[str] = ..., + error_bad_lines: bool = ..., + warn_bad_lines: bool = ..., + delim_whitespace: bool = ..., + low_memory: bool = ..., + memory_map: bool = ..., + float_precision: Optional[str] = ..., +) -> TextFileReader: ... +@overload +def read_csv( + filepath: FilePathOrBuffer, + sep: str = ..., + delimiter: Optional[str] = ..., + header: Union[int, Sequence[int], str, Literal["infer"]] = ..., + names: Optional[Sequence[str]] = ..., + index_col: Optional[Union[int, str, Sequence, Union[bool, Literal[False]]]] = ..., + usecols: Optional[Union[int, str, Sequence]] = ..., + squeeze: bool = ..., + prefix: Optional[str] = ..., + mangle_dupe_cols: bool = ..., + dtype: Optional[Union[str, Mapping[str, Any]]] = ..., + engine: Optional[Union[str, Literal["c", "python"]]] = ..., + converters: Optional[Mapping[Union[int, str], Callable]] = ..., + true_values: Optional[Sequence[Scalar]] = ..., + false_values: Optional[Sequence[Scalar]] = ..., + skipinitialspace: bool = ..., + skiprows: Optional[Union[Sequence, int, Callable]] = ..., + skipfooter: int = ..., + nrows: Optional[int] = ..., + na_values = ..., + keep_default_na: bool = ..., + na_filter: bool = ..., + verbose: bool = ..., + skip_blank_lines: bool = ..., + parse_dates: Union[bool, List[int], List[str]] = ..., + infer_datetime_format: bool = ..., + keep_date_col: bool = ..., + date_parser: Optional[Callable] = ..., + dayfirst: bool = ..., + cache_dates: bool = ..., + iterator: bool = ..., + chunksize: int = ..., + compression: Optional[Union[str, Literal["infer", "gzip", "bz2", "zip", "xz"]]] = ..., + thousands: Optional[str] = ..., + decimal: Optional[str] = ..., + lineterminator: Optional[str] = ..., + quotechar: str = ..., + quoting: int = ..., + doublequote: bool = ..., + escapechar: Optional[str] = ..., + comment: Optional[str] = ..., + encoding: Optional[str] = ..., + dialect: Optional[str] = ..., + error_bad_lines: bool = ..., + warn_bad_lines: bool = ..., + delim_whitespace: bool = ..., + low_memory: bool = ..., + memory_map: bool = ..., + float_precision: Optional[str] = ..., +) -> DataFrame: ... +@overload +def read_table( + reader: FilePathOrBuffer, + *, + sep: str = ..., + delimiter: Optional[str] = ..., + header: Union[int, Sequence[int], str, Literal["infer"]] = ..., + names: Optional[Sequence[str]] = ..., + index_col: Optional[Union[int, str, Sequence, bool, Literal[False]]] = ..., + usecols: Optional[Union[int, str, Sequence]] = ..., + squeeze: bool = ..., + prefix: Optional[str] = ..., + mangle_dupe_cols: bool = ..., + dtype: Optional[Union[str, Mapping[str, Any]]] = ..., + engine: Optional[Union[str, Literal["c", "python"]]] = ..., + converters: Optional[Mapping[Union[int, str], Callable]] = ..., + true_values: Optional[Sequence[Scalar]] = ..., + false_values: Optional[Sequence[Scalar]] = ..., + skipinitialspace: bool = ..., + skiprows: Optional[Union[Sequence, int, Callable]] = ..., + skipfooter: int = ..., + nrows: Optional[int] = ..., + na_values = ..., + keep_default_na: bool = ..., + na_filter: bool = ..., + verbose: bool = ..., + skip_blank_lines: bool = ..., + parse_dates: Union[bool, List[int], List[str]] = ..., + infer_datetime_format: bool = ..., + keep_date_col: bool = ..., + date_parser: Optional[Callable] = ..., + dayfirst: bool = ..., + cache_dates: bool = ..., + iterator: Literal[True], chunksize: Optional[int] = ..., compression: Optional[Union[str, Literal["infer", "gzip", "bz2", "zip", "xz"]]] = ..., thousands: Optional[str] = ..., @@ -113,11 +325,117 @@ def read_csv( low_memory: bool = ..., memory_map: bool = ..., float_precision: Optional[str] = ..., +) -> TextFileReader: ... +@overload +def read_table( + filepath: FilePathOrBuffer, + *, + sep: str = ..., + delimiter: Optional[str] = ..., + header: Union[int, Sequence[int], str, Literal["infer"]] = ..., + names: Optional[Sequence[str]] = ..., + index_col: Optional[Union[int, str, Sequence, bool, Literal[False]]] = ..., + usecols: Optional[Union[int, str, Sequence]] = ..., + squeeze: bool = ..., + prefix: Optional[str] = ..., + mangle_dupe_cols: bool = ..., + dtype: Optional[Union[str, Mapping[str, Any]]] = ..., + engine: Optional[Union[str, Literal["c", "python"]]] = ..., + converters: Optional[Mapping[Union[int, str], Callable]] = ..., + true_values: Optional[Sequence[Scalar]] = ..., + false_values: Optional[Sequence[Scalar]] = ..., + skipinitialspace: bool = ..., + skiprows: Optional[Union[Sequence, int, Callable]] = ..., + skipfooter: int = ..., + nrows: Optional[int] = ..., + na_values = ..., + keep_default_na: bool = ..., + na_filter: bool = ..., + verbose: bool = ..., + skip_blank_lines: bool = ..., + parse_dates: Union[bool, List[int], List[str]] = ..., + infer_datetime_format: bool = ..., + keep_date_col: bool = ..., + date_parser: Optional[Callable] = ..., + dayfirst: bool = ..., + cache_dates: bool = ..., + iterator: Literal[False], + chunksize: int, + compression: Optional[Union[str, Literal["infer", "gzip", "bz2", "zip", "xz"]]] = ..., + thousands: Optional[str] = ..., + decimal: Optional[str] = ..., + lineterminator: Optional[str] = ..., + quotechar: str = ..., + quoting: int = ..., + doublequote: bool = ..., + escapechar: Optional[str] = ..., + comment: Optional[str] = ..., + encoding: Optional[str] = ..., + dialect: Optional[str] = ..., + error_bad_lines: bool = ..., + warn_bad_lines: bool = ..., + delim_whitespace: bool = ..., + low_memory: bool = ..., + memory_map: bool = ..., + float_precision: Optional[str] = ..., +) -> TextFileReader: ... +@overload +def read_table( + filepath: FilePathOrBuffer, + *, + sep: str = ..., + delimiter: Optional[str] = ..., + header: Union[int, Sequence[int], str, Literal["infer"]] = ..., + names: Optional[Sequence[str]] = ..., + index_col: Optional[Union[int, str, Sequence, bool, Literal[False]]] = ..., + usecols: Optional[Union[int, str, Sequence]] = ..., + squeeze: bool = ..., + prefix: Optional[str] = ..., + mangle_dupe_cols: bool = ..., + dtype: Optional[Union[str, Mapping[str, Any]]] = ..., + engine: Optional[Union[str, Literal["c", "python"]]] = ..., + converters: Optional[Mapping[Union[int, str], Callable]] = ..., + true_values: Optional[Sequence[Scalar]] = ..., + false_values: Optional[Sequence[Scalar]] = ..., + skipinitialspace: bool = ..., + skiprows: Optional[Union[Sequence, int, Callable]] = ..., + skipfooter: int = ..., + nrows: Optional[int] = ..., + na_values = ..., + keep_default_na: bool = ..., + na_filter: bool = ..., + verbose: bool = ..., + skip_blank_lines: bool = ..., + parse_dates: Union[bool, List[int], List[str]] = ..., + infer_datetime_format: bool = ..., + keep_date_col: bool = ..., + date_parser: Optional[Callable] = ..., + dayfirst: bool = ..., + cache_dates: bool = ..., + iterator: Literal[False] = ..., + chunksize: None = ..., + compression: Optional[Union[str, Literal["infer", "gzip", "bz2", "zip", "xz"]]] = ..., + thousands: Optional[str] = ..., + decimal: Optional[str] = ..., + lineterminator: Optional[str] = ..., + quotechar: str = ..., + quoting: int = ..., + doublequote: bool = ..., + escapechar: Optional[str] = ..., + comment: Optional[str] = ..., + encoding: Optional[str] = ..., + dialect: Optional[str] = ..., + error_bad_lines: bool = ..., + warn_bad_lines: bool = ..., + delim_whitespace: bool = ..., + low_memory: bool = ..., + memory_map: bool = ..., + float_precision: Optional[str] = ..., ) -> DataFrame: ... - @overload def read_table( - reader: IO, + filepath: FilePathOrBuffer, + *, sep: str = ..., delimiter: Optional[str] = ..., header: Union[int, Sequence[int], str, Literal["infer"]] = ..., @@ -148,7 +466,7 @@ def read_table( dayfirst: bool = ..., cache_dates: bool = ..., iterator: bool = ..., - chunksize: Optional[int] = ..., + chunksize: int = ..., compression: Optional[Union[str, Literal["infer", "gzip", "bz2", "zip", "xz"]]] = ..., thousands: Optional[str] = ..., decimal: Optional[str] = ..., @@ -167,7 +485,6 @@ def read_table( memory_map: bool = ..., float_precision: Optional[str] = ..., ) -> TextFileReader: ... - @overload def read_table( filepath: FilePathOrBuffer, @@ -201,7 +518,7 @@ def read_table( dayfirst: bool = ..., cache_dates: bool = ..., iterator: bool = ..., - chunksize: Optional[int] = ..., + chunksize: int = ..., compression: Optional[Union[str, Literal["infer", "gzip", "bz2", "zip", "xz"]]] = ..., thousands: Optional[str] = ..., decimal: Optional[str] = ..., @@ -219,7 +536,7 @@ def read_table( low_memory: bool = ..., memory_map: bool = ..., float_precision: Optional[str] = ..., -) -> DataFrame: ... +) -> TextFileReader: ... def read_fwf(filepath_or_buffer: FilePathOrBuffer, colspecs=..., widths=..., infer_nrows=..., **kwds) : ...