Skip to content

Commit 30c93ae

Browse files
committed
doc: clarify get_test_params return type and validate parameter_set
Address review feedback: document list return type, reject unknown parameter_set values with a clear error.
1 parent 53bec97 commit 30c93ae

2 files changed

Lines changed: 20 additions & 2 deletions

File tree

pyaptamer/trafos/encode/_greedy.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,11 +136,21 @@ def _transform(self, X):
136136
def get_test_params(cls, parameter_set="default"):
137137
"""Get test parameters for GreedyEncoder.
138138
139+
Parameters
140+
----------
141+
parameter_set : str, default="default"
142+
Name of the parameter set to return. Only ``"default"`` is supported.
143+
139144
Returns
140145
-------
141-
params : dict
142-
Test parameters for GreedyEncoder.
146+
list[dict]
147+
List of parameter dictionaries for constructing test instances.
143148
"""
149+
if parameter_set != "default":
150+
raise ValueError(
151+
'parameter_set must be "default"; '
152+
f"got {parameter_set!r}"
153+
)
144154
param0 = {
145155
"words": {"A": 1, "C": 2, "G": 3, "U": 4, "AC": 5, "GU": 6},
146156
}

pyaptamer/trafos/encode/tests/test_greedy_encoder.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import inspect
22

33
import pandas as pd
4+
import pytest
45

56
from pyaptamer.trafos.encode import GreedyEncoder
67

@@ -9,12 +10,19 @@ def test_get_test_params_is_classmethod_and_callable():
910
descriptor = inspect.getattr_static(GreedyEncoder, "get_test_params")
1011
assert isinstance(descriptor, classmethod)
1112

13+
params_default = GreedyEncoder.get_test_params(parameter_set="default")
1214
params = GreedyEncoder.get_test_params()
15+
assert params == params_default
1316
assert isinstance(params, list)
1417
assert len(params) >= 1
1518
assert all(isinstance(p, dict) for p in params)
1619

1720

21+
def test_get_test_params_unknown_parameter_set_raises():
22+
with pytest.raises(ValueError, match='parameter_set must be "default"'):
23+
GreedyEncoder.get_test_params(parameter_set="not_a_real_set")
24+
25+
1826
def test_greedy_encoder_can_construct_from_test_params():
1927
for params in GreedyEncoder.get_test_params():
2028
enc = GreedyEncoder(**params)

0 commit comments

Comments
 (0)