Skip to content

Commit

Permalink
Add PluginManager.unblock method to unblock a name
Browse files Browse the repository at this point in the history
Pytest currently accesses internals to do this:
https://github.com/pytest-dev/pytest/blob/1b78de4e21d55983422e7327a51304ef0fc61679/src/_pytest/config/__init__.py#L740-L746
Let's provide a proper API for this.
  • Loading branch information
bluetech committed Jan 13, 2024
1 parent 29912d7 commit 13b3661
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/pluggy/_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,16 @@ def is_blocked(self, name: str) -> bool:
"""Return whether the given plugin name is blocked."""
return name in self._name2plugin and self._name2plugin[name] is None

def unblock(self, name: str) -> bool:
"""Unblocks a name.

Check warning on line 240 in src/pluggy/_manager.py

View check run for this annotation

Codecov / codecov/patch

src/pluggy/_manager.py#L240

Added line #L240 was not covered by tests
Returns whether the name was actually blocked.
"""

Check warning on line 242 in src/pluggy/_manager.py

View check run for this annotation

Codecov / codecov/patch

src/pluggy/_manager.py#L242

Added line #L242 was not covered by tests
if self._name2plugin.get(name, -1) is None:
del self._name2plugin[name]
return True
return False

Check warning on line 247 in src/pluggy/_manager.py

View check run for this annotation

Codecov / codecov/patch

src/pluggy/_manager.py#L247

Added line #L247 was not covered by tests
def add_hookspecs(self, module_or_class: _Namespace) -> None:
"""Add new hook specifications defined in the given ``module_or_class``.
Expand Down
7 changes: 7 additions & 0 deletions testing/test_pluginmanager.py
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,13 @@ class A:
pm.unregister(name="somename")
assert pm.is_blocked("somename")

# Unblock.
assert not pm.unblock("someothername")
assert pm.unblock("somename")
assert not pm.is_blocked("somename")
assert not pm.unblock("somename")
assert pm.register(A(), "somename")


def test_register_mismatch_method(he_pm: PluginManager) -> None:
class hello:
Expand Down

0 comments on commit 13b3661

Please sign in to comment.