Skip to content

Commit f00c0d7

Browse files
committed
Add clear_params function
1 parent 701f1bb commit f00c0d7

File tree

3 files changed

+19
-0
lines changed

3 files changed

+19
-0
lines changed

src/pybroker/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@
7070
disable_progress_bar as disable_progress_bar,
7171
enable_progress_bar as enable_progress_bar,
7272
param as param,
73+
clear_params as clear_params,
7374
register_columns as register_columns,
7475
unregister_columns as unregister_columns,
7576
)

src/pybroker/scope.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,10 @@ def param(
177177
self._params[name] = value
178178
return value
179179

180+
def clear_params(self):
181+
"""Clears all global parameters."""
182+
self._params.clear()
183+
180184
@classmethod
181185
def instance(cls) -> "StaticScope":
182186
"""Returns singleton instance."""
@@ -220,6 +224,11 @@ def param(name: str, value: Optional[Any] = _EMPTY_PARAM) -> Optional[Any]:
220224
return StaticScope.instance().param(name, value)
221225

222226

227+
def clear_params():
228+
"""Clears all global parameters."""
229+
StaticScope.instance().clear_params()
230+
231+
223232
class ColumnScope:
224233
"""Caches and retrieves column data queried from :class:`pandas.DataFrame`.
225234

tests/test_scope.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -517,3 +517,12 @@ def test_get_signals(
517517
ind_data[IndicatorSymbol(ind_name, sym)].values,
518518
equal_nan=True,
519519
)
520+
521+
522+
def test_clear_params(scope):
523+
scope.clear_params()
524+
param("alpha", 0.1)
525+
param("beta", 0.2)
526+
assert scope._params == {"alpha": 0.1, "beta": 0.2}
527+
scope.clear_params()
528+
assert scope._params == {}

0 commit comments

Comments
 (0)