Skip to content

pygmt.params.Pattern: Set default pattern value to 1 plus extra validation checks #4134

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
weiji14 merged 8 commits into from
Oct 2, 2025
Merged

pygmt.params.Pattern: Set default pattern value to 1 plus extra validation checks #4134

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d1a1553
Check for invalid non-int values passed to Pattern class
weiji14 Oct 1, 2025
c76d951
Fix type checking
weiji14 Oct 1, 2025
4df4566
Update isinstance check to account for int types
weiji14 Oct 1, 2025
68f6c80
Set default pattern to 1
weiji14 Oct 1, 2025
709f7f8
Update pygmt/params/pattern.py
weiji14 Oct 2, 2025
0349476
Merge branch 'main' into pattern-validation
weiji14 Oct 2, 2025
03a6627
Merge branch 'main' into pattern-validation
weiji14 Oct 2, 2025
319b01a
[format-command] fixes
actions-bot Oct 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
8 changes: 5 additions & 3 deletions pygmt/params/pattern.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class Pattern(BaseParam):
The pattern to use. It can be specified in two forms:

- An integer in the range of 1-90, corresponding to one of 90 predefined 64x64
bit-patterns
bit-patterns. [Default is 1].
- Name of a 1-, 8-, or 24-bit image raster file, to create customized, repeating
images using image raster files.
dpi
Expand Down Expand Up @@ -69,7 +69,7 @@ class Pattern(BaseParam):
>>> fig.show()
"""

pattern: int | PathLike
pattern: int | PathLike = 1
dpi: int | None = None
bgcolor: str | None = None
fgcolor: str | None = None
Expand All @@ -80,7 +80,9 @@ def _validate(self):
Validate the parameters.
"""
# Integer pattern number must be in the range 1-90.
if isinstance(self.pattern, int) and not (1 <= self.pattern <= 90):
if not isinstance(self.pattern, (PathLike, int)) or (
isinstance(self.pattern, int) and not (1 <= self.pattern <= 90)
):
raise GMTValueError(
self.pattern,
description="pattern number",
Expand Down
4 changes: 3 additions & 1 deletion pygmt/tests/test_params_pattern.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,10 @@ def test_pattern():

def test_pattern_invalid_pattern():
"""
Test that an invalid pattern number raises a GMTValueError.
Test that an invalid pattern value or number raises a GMTValueError.
"""
with pytest.raises(GMTValueError):
_ = Pattern(None) # Value that is neither int nor PathLike
with pytest.raises(GMTValueError):
_ = str(Pattern(0))
with pytest.raises(GMTValueError):
Expand Down
Loading