Skip to content

[MNT] [TYPING]: Use of Literal #30257

Open
@ZPyrolink

Description

@ZPyrolink

Summary

While checking pyplot and corresponding matplotlib methods, I noticed that there are several functions where we could use typing.Literal to explicitly indicate the possible values and have them suggested by IDEs.
We also can create the corresponding TypeAlias on matplotlib.typing when necessary.

Proposed fix

Function Parameter Literal replacing str PR
mpl.set_loglevel level "notset", "debug", "info", "warning", "error", "critical" #30302
plt.connect s "button_press_event", "button_release_event", ... #30275
plt.Axes.scatter marker See MarkerType behind ToDo
mpl.rc group "animation", "axes", axes3d, "axes3d", "boxplot", ... ToDo
mpl.RcParams.get_item / set_item key -- ToDo
Type Literal replacing str PR
MarkerType ".", ",", "o" #30261

On MarkerType we can also add litterals for the tuple version that is not indicated for now:

tuple[int, Literal[1, 2, 3], int]

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions