Skip to content

Commit 248cc44

Browse files
committed
TYP: Add type hints to read_html
1 parent 71cd549 commit 248cc44

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

pandas/io/html.py

+15-12
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,17 @@
88
import numbers
99
import os
1010
import re
11+
from typing import Dict, List, Optional, Pattern, Union
1112

13+
from pandas._typing import FilePathOrBuffer
1214
from pandas.compat._optional import import_optional_dependency
1315
from pandas.errors import AbstractMethodError, EmptyDataError
1416
from pandas.util._decorators import deprecate_nonkeyword_arguments
1517

1618
from pandas.core.dtypes.common import is_list_like
1719

1820
from pandas.core.construction import create_series_with_explicit_dtype
21+
from pandas.core.frame import DataFrame
1922

2023
from pandas.io.common import is_url, urlopen, validate_header_arg
2124
from pandas.io.formats.printing import pprint_thing
@@ -924,22 +927,22 @@ def _parse(flavor, io, match, attrs, encoding, displayed_only, **kwargs):
924927

925928
@deprecate_nonkeyword_arguments(version="2.0")
926929
def read_html(
927-
io,
928-
match=".+",
929-
flavor=None,
930+
io: FilePathOrBuffer,
931+
match: Union[str, Pattern] = ".+",
932+
flavor: Optional[str] = None,
930933
header=None,
931934
index_col=None,
932935
skiprows=None,
933-
attrs=None,
934-
parse_dates=False,
935-
thousands=",",
936-
encoding=None,
937-
decimal=".",
938-
converters=None,
936+
attrs: Optional[Dict[str, str]] = None,
937+
parse_dates: Optional[bool] = False,
938+
thousands: str = ",",
939+
encoding: Optional[str] = None,
940+
decimal: str = ".",
941+
converters: Optional[dict] = None,
939942
na_values=None,
940-
keep_default_na=True,
941-
displayed_only=True,
942-
):
943+
keep_default_na: bool = True,
944+
displayed_only: bool = True,
945+
) -> List[DataFrame]:
943946
r"""
944947
Read HTML tables into a ``list`` of ``DataFrame`` objects.
945948

0 commit comments

Comments
 (0)