Skip to content

Use None as default Text width as in pyglet's Label + tests #2222

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
pushfoo merged 8 commits into from
Jul 8, 2024
Merged

Use None as default Text width as in pyglet's Label + tests #2222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2eb1cc9
Use | None in arcade.text.Text.__init__
pushfoo Jul 8, 2024
ebe0b6f
Use | None in arcade.text.create_text_sprite
pushfoo Jul 8, 2024
c83fd75
Handle Text width=None, multiline=True edge case
pushfoo Jul 8, 2024
1779fe0
Add edge case handling to draw_text following Text's
pushfoo Jul 8, 2024
11de06c
Whitespace in test file
pushfoo Jul 8, 2024
c39cd68
Use width = None default to follow upstream pyglet.Label
pushfoo Jul 8, 2024
2c7ae98
./make.py format
pushfoo Jul 8, 2024
234d207
Make tests more specific
pushfoo Jul 8, 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
28 changes: 17 additions & 11 deletions arcade/text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ def __init__(
y: float,
color: RGBOrA255 = arcade.color.WHITE,
font_size: float = 12,
width: Optional[int] = 0,
width: int | None = None,
align: str = "left",
font_name: FontNameOrNames = ("calibri", "arial"),
bold: bool = False,
Expand All @@ -186,8 +186,8 @@ def __init__(
anchor_y: str = "baseline",
multiline: bool = False,
rotation: float = 0,
batch: Optional[pyglet.graphics.Batch] = None,
group: Optional[pyglet.graphics.Group] = None,
batch: pyglet.graphics.Batch | None = None,
group: pyglet.graphics.Group | None = None,
z: float = 0,
):
# Raises a RuntimeError if no window for better user feedback
Expand All @@ -196,8 +196,11 @@ def __init__(
if align not in ("left", "center", "right"):
raise ValueError("The 'align' parameter must be equal to 'left', 'right', or 'center'.")

if multiline and width == 0:
raise ValueError("The 'width' parameter must be set when 'multiline' is True.")
if multiline and not width:
raise ValueError(
f"The 'width' parameter must be set to a non-zero value when 'multiline' is True, "
f"but got {width!r}."
)

adjusted_font = _attempt_font_name_resolution(font_name)
self._label = pyglet.text.Label(
Expand Down Expand Up @@ -581,15 +584,15 @@ def create_text_sprite(
text: str,
color: RGBA255 = arcade.color.WHITE,
font_size: float = 12,
width: Optional[int] = None,
width: int | None = None,
align: str = "left",
font_name: FontNameOrNames = ("calibri", "arial"),
bold: bool = False,
italic: bool = False,
anchor_x: str = "left",
multiline: bool = False,
texture_atlas: Optional[TextureAtlasBase] = None,
background_color: Optional[RGBA255] = None,
texture_atlas: TextureAtlasBase | None = None,
background_color: RGBA255 | None = None,
) -> arcade.Sprite:
"""
Creates a sprite containing text based off of :py:class:`~arcade.Text`.
Expand Down Expand Up @@ -669,7 +672,7 @@ def draw_text(
y: int,
color: RGBA255 = arcade.color.WHITE,
font_size: float = 12,
width: int = 0,
width: int | None = None,
align: str = "left",
font_name: FontNameOrNames = ("calibri", "arial"),
bold: bool = False,
Expand Down Expand Up @@ -847,8 +850,11 @@ def draw_text(
if align not in ("left", "center", "right"):
raise ValueError("The 'align' parameter must be equal to 'left', 'right', or 'center'.")

if multiline and width == 0:
raise ValueError("The 'width' parameter must be set when 'multiline' is True.")
if multiline and not width:
raise ValueError(
f"The 'width' parameter must be set to a non-zero value when 'multiline' is True, "
f"but got {width!r}."
)

if not label:
adjusted_font = _attempt_font_name_resolution(font_name)
Expand Down
18 changes: 14 additions & 4 deletions tests/unit/text/test_text_error_handling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,23 @@

def test_text_instance_raise_multiline_error(window):
with pytest.raises(ValueError) as e:
_ = arcade.Text("Initial text", 0, 0, multiline=True)
_ = arcade.Text("Initial text", 0, 0, width=0, multiline=True)

assert e.value.args[0] == "The 'width' parameter must be set when 'multiline' is True."
assert e.value.args[0] == "The 'width' parameter must be set to a non-zero value when 'multiline' is True, but got 0."

with pytest.raises(ValueError) as e:
_ = arcade.Text("Initial text", 0, 0, width=None, multiline=True)

assert e.value.args[0] == "The 'width' parameter must be set to a non-zero value when 'multiline' is True, but got None."


def test_text_function_raise_multiline_error(window):
with pytest.raises(ValueError) as e:
_ = arcade.draw_text("Initial text", 0, 0, multiline=True)
_ = arcade.draw_text("Initial text", 0, 0, width=0, multiline=True)

assert e.value.args[0] == "The 'width' parameter must be set to a non-zero value when 'multiline' is True, but got 0."

with pytest.raises(ValueError) as e:
_ = arcade.draw_text("Initial text", 0, 0, width=None, multiline=True)

assert e.value.args[0] == "The 'width' parameter must be set when 'multiline' is True."
assert e.value.args[0] == "The 'width' parameter must be set to a non-zero value when 'multiline' is True, but got None."