Skip to content

Fix flavor param with incorrect type hint in read_html #772

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 2, 2023
Merged

Fix flavor param with incorrect type hint in read_html #772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c6b38f6
Fix flavor param with incorrect type hint in read_html
matheusfelipeog Sep 11, 2023
3063be8
Add HTMLFlavors type to read_html
matheusfelipeog Nov 2, 2023
ff5faea
Add tests and new dev dependencies
matheusfelipeog Nov 2, 2023
e439ccd
Merge branch 'main' into fix/incorrect-flavor-type-hint
matheusfelipeog Nov 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions pandas-stubs/_typing.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,6 +587,9 @@ ParseDatesArg: TypeAlias = (
# read_xml parsers
XMLParsers: TypeAlias = Literal["lxml", "etree"]

# read_html flavors
HTMLFlavors: TypeAlias = Literal["lxml", "html5lib", "bs4"]

# Any plain Python or numpy function
Function: TypeAlias = np.ufunc | Callable[..., Any]
# Use a distinct HashableT in shared types to avoid conflicts with
Expand Down
3 changes: 2 additions & 1 deletion pandas-stubs/io/html.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ from pandas._typing import (
HashableT3,
HashableT4,
HashableT5,
HTMLFlavors,
ReadBuffer,
StorageOptions,
)
Expand All @@ -29,7 +30,7 @@ def read_html(
io: FilePath | ReadBuffer[str],
*,
match: str | Pattern = ...,
flavor: str | None = ...,
flavor: HTMLFlavors | Sequence[HTMLFlavors] | None = ...,
header: int | Sequence[int] | None = ...,
index_col: int | Sequence[int] | list[HashableT1] | None = ...,
skiprows: int | Sequence[int] | slice | None = ...,
Expand Down
5 changes: 4 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ pre-commit = ">=2.19.0"
black = ">=23.3.0"
isort = ">=5.12.0"
openpyxl = ">=3.0.10"
tables = { version = ">=3.8.0" , python = "<4"} # 3.8.0 depends on blosc2 which caps python to <4
tables = { version = ">=3.8.0", python = "<4"} # 3.8.0 depends on blosc2 which caps python to <4
lxml = ">=4.9.1"
pyreadstat = ">=1.2.0"
xlrd = ">=2.0.1"
Expand All @@ -61,6 +61,9 @@ jinja2 = ">=3.1"
scipy = { version = ">=1.9.1", python = "<3.13" }
SQLAlchemy = ">=2.0.12"
types-python-dateutil = ">=2.8.19"
numexpr = "<2.8.5" # https://github.com/pandas-dev/pandas/issues/54449
beautifulsoup4 = ">=4.12.2"
html5lib = ">=1.1"

[build-system]
requires = ["poetry-core>=1.0.0"]
Expand Down
6 changes: 6 additions & 0 deletions tests/test_io.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1237,6 +1237,12 @@ def test_read_html():
with ensure_clean() as path:
check(assert_type(DF.to_html(path), None), type(None))
check(assert_type(read_html(path), list[DataFrame]), list)
check(assert_type(read_html(path, flavor=None), list[DataFrame]), list)
check(assert_type(read_html(path, flavor="bs4"), list[DataFrame]), list)
check(assert_type(read_html(path, flavor=["bs4"]), list[DataFrame]), list)
check(
assert_type(read_html(path, flavor=["bs4", "lxml"]), list[DataFrame]), list
)


def test_csv_quoting():
Expand Down