Skip to content

Commit 240504c

Browse files
add docstrings to registry methods (#586)
1 parent 60931f1 commit 240504c

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

responses/__init__.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -680,9 +680,25 @@ def __init__(
680680
self._thread_lock = _ThreadingLock()
681681

682682
def get_registry(self) -> FirstMatchRegistry:
683+
"""Returns current registry instance with responses.
684+
685+
Returns
686+
-------
687+
FirstMatchRegistry
688+
Current registry instance with responses.
689+
690+
"""
683691
return self._registry
684692

685693
def _set_registry(self, new_registry: Type[FirstMatchRegistry]) -> None:
694+
"""Replaces current registry with `new_registry`.
695+
696+
Parameters
697+
----------
698+
new_registry : Type[FirstMatchRegistry]
699+
Class reference of the registry that should be set, eg OrderedRegistry
700+
701+
"""
686702
if self.registered():
687703
err_msg = (
688704
"Cannot replace Registry, current registry has responses.\n"
@@ -693,6 +709,7 @@ def _set_registry(self, new_registry: Type[FirstMatchRegistry]) -> None:
693709
self._registry = new_registry()
694710

695711
def reset(self) -> None:
712+
"""Resets registry (including type), calls, passthru_prefixes to default values."""
696713
self._registry = FirstMatchRegistry()
697714
self._calls.reset()
698715
self.passthru_prefixes = ()

0 commit comments

Comments
 (0)