8000 Accept strings for {Cap,Join}Style in MarkerStyle · QuLogic/matplotlib@6bb1f87 · GitHub
[go: up one dir, main page]
Skip to content

Commit 6bb1f87

Browse files
QuLogicQuLogic
committed
Accept strings for {Cap,Join}Style in MarkerStyle
When these Enum classes were added in matplotlib#18544, they were supposed to be for documentation only. To that end, matplotlib#22055 was a followup that ensured that only the strings were exposed from the getter side. However, when user-supplied cap/join style were added in matplotlib#20914, they were only for the Enum type instead of the string, so correctly allow strings here as well. Also, specifically type hint the return values as literals, as was done in matplotlib#25719.
1 parent f1a8b92 commit 6bb1f87

File tree

3 files changed

+18
-21
lines changed

3 files changed

+18
-21
lines changed

‎lib/matplotlib/markers.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -241,16 +241,16 @@ def __init__(self, marker,
241241
Transform that will be combined with the native transform of the
242242
marker.
243243
244-
capstyle : CapStyle, default: None
244+
capstyle : `.CapStyle` or %(CapStyle)s, default: None
245245
Cap style that will override the default cap style of the marker.
246246
247-
joinstyle : JoinStyle, default: None
247+
joinstyle : `.JoinStyle` or %(JoinStyle)s, default: None
248248
Join style that will override the default join style of the marker.
249249
"""
250250
self._marker_function = None
251251
self._user_transform = transform
252-
self._user_capstyle = capstyle
253-
self._user_joinstyle = joinstyle
252+
self._user_capstyle = CapStyle(capstyle) if capstyle is not None else None
253+
self._user_joinstyle = JoinStyle(joinstyle) if joinstyle is not None else None
254254
self._set_fillstyle(fillstyle)
255255
self._set_marker(marker)
256256

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1+
from typing import Literal
2+
13
from . import cbook
2-
from ._enums import CapStyle, JoinStyle
34
from .path import Path
45
from .transforms import Affine2D, IdentityTransform, Transform
56

67
from numpy.typing import ArrayLike
7-
from .typing import FillStyleType
8+
from .typing import CapStyleType, FillStyleType, JoinStyleType
89

910
TICKLEFT: int
1011
TICKRIGHT: int
@@ -29,16 +30,14 @@ class MarkerStyle:
2930
marker: str | ArrayLike | Path | MarkerStyle | None,
3031
fillstyle: FillStyleType | None = ...,
3132
transform: Transform | None = ...,
32-
capstyle: CapStyle | None = ...,
33-
joinstyle: JoinStyle | None = ...,
33+
capstyle: CapStyleType | None = ...,
34+
joinstyle: JoinStyleType | None = ...,
3435
) -> None: ...
3536
def __bool__(self) -> bool: ...
3637
def is_filled(self) -> bool: ...
37-
def get_fillstyle(
38-
self,
39-
) -> FillStyleType: ...
40-
def get_joinstyle(self) -> JoinStyle: ...
41-
def get_capstyle(self) -> CapStyle: ...
38+
def get_fillstyle(self) -> FillStyleType: ...
39+
def get_joinstyle(self) -> Literal["miter", "round", "bevel"]: ...
40+
def get_capstyle(self) -> Literal["butt", "projecting", "round"]: ...
4241
def get_marker(self) -> str | ArrayLike | Path | MarkerStyle | None: ...
4342
def get_path(self) -> Path: ...
4443
def get_transform(self) -> Transform: ...

‎lib/matplotlib/tests/test_marker.py

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -207,18 +207,16 @@ def test_marker_init_transforms():
207207

208208
def test_marker_init_joinstyle():
209209
marker = markers.MarkerStyle("*")
210-
jstl = markers.JoinStyle.round
211-
styled_marker = markers.MarkerStyle("*", joinstyle=jstl)
212-
assert styled_marker.get_joinstyle() == jstl
213-
assert marker.get_joinstyle() != jstl
210+
styled_marker = markers.MarkerStyle("*", joinstyle="round")
211+
assert styled_marker.get_joinstyle() == "round"
212+
assert marker.get_joinstyle() != "round"
214213

215214

216215
def test_marker_init_captyle():
217216
marker = markers.MarkerStyle("*")
218-
capstl = markers.CapStyle.round
219-
styled_marker = markers.MarkerStyle("*", capstyle=capstl)
220-
assert styled_marker.get_capstyle() == capstl
221-
assert marker.get_capstyle() != capstl
217+
styled_marker = markers.MarkerStyle("*", capstyle="round")
218+
assert styled_marker.get_capstyle() == "round"
219+
assert marker.get_capstyle() != "round"
222220

223221

224222
@pytest.mark.parametrize("marker,transform,expected", [

0 commit comments

Comments
 (0)
0