Skip to content

fix(typing): Resolve LSP violation for ChartType.data #3740

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
dangotbanned merged 2 commits into from
Jan 2, 2025
+32 −27
Merged

fix(typing): Resolve LSP violation for ChartType.data #3740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5811ce
fix(typing): Resolve LSP violation for `ChartType.data`
dangotbanned Jan 2, 2025
fd3bbfc
Merge remote-tracking branch 'upstream/main' into chart-data-type
dangotbanned Jan 2, 2025
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
15 changes: 6 additions & 9 deletions altair/vegalite/v5/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3939,11 +3939,8 @@ def __init__(
height: Optional[int | dict | Step | Literal["container"]] = Undefined,
**kwargs: Any,
) -> None:
# Data type hints won't match with what TopLevelUnitSpec expects
# as there is some data processing happening when converting to
# a VL spec
super().__init__(
data=data, # type: ignore[arg-type]
data=data,
encoding=encoding,
mark=mark,
width=width,
Expand Down Expand Up @@ -4328,7 +4325,7 @@ def __init__(
) -> None:
for spec in concat:
_check_if_valid_subspec(spec, "ConcatChart")
super().__init__(data=data, concat=list(concat), columns=columns, **kwargs) # type: ignore[arg-type]
super().__init__(data=data, concat=list(concat), columns=columns, **kwargs)
self.concat: list[ChartType]
self.params: Optional[Sequence[_Parameter]]
self.data: Optional[ChartDataType]
Expand Down Expand Up @@ -4432,7 +4429,7 @@ def __init__(
) -> None:
for spec in hconcat:
_check_if_valid_subspec(spec, "HConcatChart")
super().__init__(data=data, hconcat=list(hconcat), **kwargs) # type: ignore[arg-type]
super().__init__(data=data, hconcat=list(hconcat), **kwargs)
self.hconcat: list[ChartType]
self.params: Optional[Sequence[_Parameter]]
self.data: Optional[ChartDataType]
Expand Down Expand Up @@ -4536,7 +4533,7 @@ def __init__(
) -> None:
for spec in vconcat:
_check_if_valid_subspec(spec, "VConcatChart")
super().__init__(data=data, vconcat=list(vconcat), **kwargs) # type: ignore[arg-type]
super().__init__(data=data, vconcat=list(vconcat), **kwargs)
self.vconcat: list[ChartType]
self.params: Optional[Sequence[_Parameter]]
self.data: Optional[ChartDataType]
Expand Down Expand Up @@ -4644,7 +4641,7 @@ def __init__(
for spec in layer:
_check_if_valid_subspec(spec, "LayerChart")
_check_if_can_be_layered(spec)
super().__init__(data=data, layer=list(layer), **kwargs) # type: ignore[arg-type]
super().__init__(data=data, layer=list(layer), **kwargs)
self.layer: list[ChartType]
self.params: Optional[Sequence[_Parameter]]
self.data: Optional[ChartDataType]
Expand Down Expand Up @@ -4775,7 +4772,7 @@ def __init__(
_spec_as_list = [spec]
params, _spec_as_list = _combine_subchart_params(params, _spec_as_list)
spec = _spec_as_list[0]
super().__init__(data=data, spec=spec, facet=facet, params=params, **kwargs) # type: ignore[arg-type]
super().__init__(data=data, spec=spec, facet=facet, params=params, **kwargs)
self.data: Optional[ChartDataType]
self.spec: ChartType
self.params: Optional[Sequence[_Parameter]]
Expand Down
37 changes: 19 additions & 18 deletions altair/vegalite/v5/schema/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

from altair import Parameter
from altair.typing import Optional
from altair.vegalite.v5.api import ChartDataType

from ._typing import * # noqa: F403

Expand Down Expand Up @@ -7887,7 +7888,7 @@ class GenericUnitSpecEncodingAnyMark(VegaLiteSchema):
def __init__(
self,
mark: Optional[SchemaBase | Map | Mark_T | CompositeMark_T] = Undefined,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
description: Optional[str] = Undefined,
encoding: Optional[SchemaBase | Map] = Undefined,
name: Optional[str] = Undefined,
Expand Down Expand Up @@ -11062,7 +11063,7 @@ class LookupData(VegaLiteSchema):

def __init__(
self,
data: Optional[SchemaBase | Map] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map] = Undefined,
key: Optional[str | SchemaBase] = Undefined,
fields: Optional[Sequence[str | SchemaBase]] = Undefined,
**kwds,
Expand Down Expand Up @@ -21055,7 +21056,7 @@ def __init__(
bounds: Optional[Literal["full", "flush"]] = Undefined,
center: Optional[bool | SchemaBase | Map] = Undefined,
columns: Optional[float] = Undefined,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
description: Optional[str] = Undefined,
name: Optional[str] = Undefined,
resolve: Optional[SchemaBase | Map] = Undefined,
Expand Down Expand Up @@ -21182,7 +21183,7 @@ def __init__(
bounds: Optional[Literal["full", "flush"]] = Undefined,
center: Optional[bool | SchemaBase | Map] = Undefined,
columns: Optional[float] = Undefined,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
description: Optional[str] = Undefined,
name: Optional[str] = Undefined,
resolve: Optional[SchemaBase | Map] = Undefined,
Expand Down Expand Up @@ -21340,7 +21341,7 @@ def __init__(
align: Optional[SchemaBase | Map | LayoutAlign_T] = Undefined,
bounds: Optional[Literal["full", "flush"]] = Undefined,
center: Optional[bool | SchemaBase | Map] = Undefined,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
description: Optional[str] = Undefined,
encoding: Optional[SchemaBase | Map] = Undefined,
height: Optional[float | SchemaBase | Literal["container"] | Map] = Undefined,
Expand Down Expand Up @@ -21429,7 +21430,7 @@ def __init__(
hconcat: Optional[Sequence[SchemaBase | Map]] = Undefined,
bounds: Optional[Literal["full", "flush"]] = Undefined,
center: Optional[bool] = Undefined,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
description: Optional[str] = Undefined,
name: Optional[str] = Undefined,
resolve: Optional[SchemaBase | Map] = Undefined,
Expand Down Expand Up @@ -21537,7 +21538,7 @@ class LayerSpec(Spec, NonNormalizedSpec):
def __init__(
self,
layer: Optional[Sequence[SchemaBase | Map]] = Undefined,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
description: Optional[str] = Undefined,
encoding: Optional[SchemaBase | Map] = Undefined,
height: Optional[float | SchemaBase | Literal["container"] | Map] = Undefined,
Expand Down Expand Up @@ -21677,7 +21678,7 @@ def __init__(
bounds: Optional[Literal["full", "flush"]] = Undefined,
center: Optional[bool | SchemaBase | Map] = Undefined,
columns: Optional[float] = Undefined,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
description: Optional[str] = Undefined,
name: Optional[str] = Undefined,
resolve: Optional[SchemaBase | Map] = Undefined,
Expand Down Expand Up @@ -21807,7 +21808,7 @@ def __init__(
bounds: Optional[Literal["full", "flush"]] = Undefined,
center: Optional[bool | SchemaBase | Map] = Undefined,
columns: Optional[float] = Undefined,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
description: Optional[str] = Undefined,
name: Optional[str] = Undefined,
resolve: Optional[SchemaBase | Map] = Undefined,
Expand Down Expand Up @@ -24400,7 +24401,7 @@ def __init__(
center: Optional[bool | SchemaBase | Map] = Undefined,
columns: Optional[float] = Undefined,
config: Optional[SchemaBase | Map] = Undefined,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
datasets: Optional[SchemaBase | Map] = Undefined,
description: Optional[str] = Undefined,
name: Optional[str] = Undefined,
Expand Down Expand Up @@ -24565,7 +24566,7 @@ class TopLevelFacetSpec(TopLevelSpec):

def __init__(
self,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
facet: Optional[SchemaBase | Map] = Undefined,
spec: Optional[SchemaBase | Map] = Undefined,
align: Optional[SchemaBase | Map | LayoutAlign_T] = Undefined,
Expand Down Expand Up @@ -24704,7 +24705,7 @@ def __init__(
bounds: Optional[Literal["full", "flush"]] = Undefined,
center: Optional[bool] = Undefined,
config: Optional[SchemaBase | Map] = Undefined,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
datasets: Optional[SchemaBase | Map] = Undefined,
description: Optional[str] = Undefined,
name: Optional[str] = Undefined,
Expand Down Expand Up @@ -24860,7 +24861,7 @@ def __init__(
str | Parameter | SchemaBase | Map | ColorName_T
] = Undefined,
config: Optional[SchemaBase | Map] = Undefined,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
datasets: Optional[SchemaBase | Map] = Undefined,
description: Optional[str] = Undefined,
encoding: Optional[SchemaBase | Map] = Undefined,
Expand Down Expand Up @@ -25067,7 +25068,7 @@ class TopLevelUnitSpec(TopLevelSpec):

def __init__(
self,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
mark: Optional[SchemaBase | Map | Mark_T | CompositeMark_T] = Undefined,
align: Optional[SchemaBase | Map | LayoutAlign_T] = Undefined,
autosize: Optional[SchemaBase | Map | AutosizeType_T] = Undefined,
Expand Down Expand Up @@ -25212,7 +25213,7 @@ def __init__(
bounds: Optional[Literal["full", "flush"]] = Undefined,
center: Optional[bool] = Undefined,
config: Optional[SchemaBase | Map] = Undefined,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
datasets: Optional[SchemaBase | Map] = Undefined,
description: Optional[str] = Undefined,
name: Optional[str] = Undefined,
Expand Down Expand Up @@ -26229,7 +26230,7 @@ class UnitSpec(VegaLiteSchema):
def __init__(
self,
mark: Optional[SchemaBase | Map | Mark_T | CompositeMark_T] = Undefined,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
description: Optional[str] = Undefined,
encoding: Optional[SchemaBase | Map] = Undefined,
name: Optional[str] = Undefined,
Expand Down Expand Up @@ -26333,7 +26334,7 @@ class UnitSpecWithFrame(VegaLiteSchema):
def __init__(
self,
mark: Optional[SchemaBase | Map | Mark_T | CompositeMark_T] = Undefined,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
description: Optional[str] = Undefined,
encoding: Optional[SchemaBase | Map] = Undefined,
height: Optional[float | SchemaBase | Literal["container"] | Map] = Undefined,
Expand Down Expand Up @@ -26460,7 +26461,7 @@ def __init__(
vconcat: Optional[Sequence[SchemaBase | Map]] = Undefined,
bounds: Optional[Literal["full", "flush"]] = Undefined,
center: Optional[bool] = Undefined,
data: Optional[SchemaBase | Map | None] = Undefined,
data: Optional[SchemaBase | ChartDataType | Map | None] = Undefined,
description: Optional[str] = Undefined,
name: Optional[str] = Undefined,
resolve: Optional[SchemaBase | Map] = Undefined,
Expand Down
2 changes: 2 additions & 0 deletions tools/generate_schema_wrapper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,7 @@ class {name}(TypedDict{metaclass_kwds}):{comment}
BIN: Literal["Bin"] = "Bin"
IMPUTE: Literal["Impute"] = "Impute"
INTO_CONDITION: Literal["IntoCondition"] = "IntoCondition"
CHART_DATA_TYPE: Literal["ChartDataType"] = "ChartDataType"

# NOTE: `core.py` typing imports
DATETIME: Literal["DateTime"] = "DateTime"
Expand Down Expand Up @@ -761,6 +762,7 @@ def generate_vegalite_schema_wrapper(fp: Path, /) -> ModuleDef[str]:
"from datetime import date, datetime",
"from altair import Parameter",
"from altair.typing import Optional",
f"from altair.vegalite.v5.api import {CHART_DATA_TYPE}",
"from ._typing import * # noqa: F403",
),
"\n" f"__all__ = {all_}\n",
Expand Down
5 changes: 5 additions & 0 deletions tools/schemapi/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -613,6 +613,8 @@ def title_to_type_reprs(self, *, use_concrete: bool) -> set[str]:
tps.add("Parameter")
if self.is_datetime():
tps.add("Temporal")
if self.is_top_level_spec_data():
tps.add("ChartDataType")
elif self.is_value():
value = self.properties["value"]
t = value.to_type_repr(target="annotation", use_concrete=use_concrete)
Expand Down Expand Up @@ -969,6 +971,9 @@ def is_theme_config_target(self) -> bool:
def is_datetime(self) -> bool:
return self.refname == "DateTime"

def is_top_level_spec_data(self) -> bool:
return self.refname == "Data"


class Grouped(Generic[T]):
"""
Expand Down