Skip to content

OptionsManager: do not turn an empty prefix into an underscore #29

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
JHopeCollins merged 2 commits into from
Nov 20, 2025
Merged

OptionsManager: do not turn an empty prefix into an underscore #29

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
9adf24c
OptionsManager: do not turn an empty prefix into an underscore
JHopeCollins Nov 20, 2025
c11327b
cannot turn None into a valid prefix
JHopeCollins Nov 20, 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
4 changes: 3 additions & 1 deletion petsctools/options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,10 @@ def _warn_unused_options(all_options: Iterable, used_options: Iterable,
def _validate_prefix(prefix):
"""Valid prefixes are strings ending with an underscore.
"""
if prefix is None:
raise ValueError("Cannot validate None as a prefix")
prefix = str(prefix)
if not prefix.endswith("_"):
if prefix and not prefix.endswith("_"):
prefix += "_"
return prefix

Expand Down
8 changes: 6 additions & 2 deletions tests/test_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,18 +84,22 @@ def test_options_prefix():
options = petsctools.OptionsManager({})
assert options.options_prefix.startswith("petsctools_")

# User defined empty prefix
options = petsctools.OptionsManager({}, options_prefix='')
assert options.options_prefix == ""

# User defined default prefix
options = petsctools.OptionsManager({}, default_prefix="firedrake")
assert options.options_prefix.startswith("firedrake_")

# Explicit prefix overrides default prefix
options = petsctools.OptionsManager({}, options_prefix="myobj")
assert options.options_prefix.startswith("myobj_")
assert options.options_prefix == "myobj_"

# Explicit prefix overrides default prefix
options = petsctools.OptionsManager({}, options_prefix="myobj",
default_prefix="firedrake")
assert options.options_prefix.startswith("myobj_")
assert options.options_prefix == "myobj_"


@pytest.mark.skipnopetsc4py
Expand Down