Skip to content

Add stub for Styler.map_index #905

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
Dr-Irv merged 5 commits into from
Apr 10, 2024
Merged

Add stub for Styler.map_index #905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b1c98fe
fix: add stub for Styler.map_index
cquick01 Apr 10, 2024
af3c09c
add test for Styler.map_index
cquick01 Apr 10, 2024
fc0d75f
Fix map_index type definition
cquick01 Apr 10, 2024
8700140
Update test_map_index to show example from docs
cquick01 Apr 10, 2024
49d9b5a
Run pre-commit
cquick01 Apr 10, 2024
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
7 changes: 7 additions & 0 deletions pandas-stubs/io/formats/style.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,13 @@ class Styler(StylerRenderer):
level: Level | list[Level] | None = ...,
**kwargs: Any,
) -> Styler: ...
def map_index(
self,
func: Callable[[Scalar], str | None],
axis: Axis = ...,
level: Level | list[Level] | None = ...,
**kwargs,
) -> Styler: ...
def set_table_attributes(self, attributes: str) -> Styler: ...
def export(self) -> StyleExportDict: ...
def use(self, styles: StyleExportDict) -> Styler: ...
Expand Down
9 changes: 9 additions & 0 deletions tests/test_styler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
import pytest
from typing_extensions import assert_type

from pandas._typing import Scalar

from tests import check

from pandas.io.formats.style import Styler
Expand Down Expand Up @@ -63,6 +65,13 @@ def f1(s: Series) -> Series[str]:
check(assert_type(DF.style.apply_index(f1), Styler), Styler)


def test_map_index() -> None:
def f(s: Scalar) -> str | None:
return "background-color: yellow;" if s == "B" else None

check(assert_type(DF.style.map_index(f), Styler), Styler)


def test_background_gradient() -> None:
check(assert_type(DF.style.background_gradient(), Styler), Styler)

Expand Down