Add ignore_plugins parameter for get_status and get_hook_caller #25
Conversation
Codecov Report
@@ Coverage Diff @@
## master #25 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 7 7
Lines 380 387 +7
=====================================
+ Hits 380 387 +7 |
| The :ref:`plugin-info-api-section` is a object that holds all information related to the plugin. | ||
| """ | ||
| plugin_config_files = hookman_utils.find_config_files(self.plugins_dirs) | ||
| return [PluginInfo(plugin_file, self.hooks_available) for plugin_file in plugin_config_files] |
There was a problem hiding this comment.
You could just add if plugin_info.name not in ignored_plugins to this list comprehension:
return [PluginInfo(x, self.hooks_available) for xin plugin_config_files
if x.name not in ignored_plugins]Also change the signature to accept a Sequence[str]=(), so you don't even need to handle None. 😉
There was a problem hiding this comment.
The problem is that X is a Path() to where the plugin_config_file is located =/
Only after creating an instance of PluginInfo that I will have access to the content of the configuration (such as name or any other specific ID).
There was a problem hiding this comment.
- Changed the signture to accept a
Sequence[str]=( )✔️
hookman/hooks.py
Outdated
| raise ConflictBetweenPluginsError( | ||
| f"Could not get a Hook Caller due to existing conflict between installed plugins") | ||
|
|
||
| def get_status(self) -> List[Optional[ConflictStatus]]: | ||
| def get_status(self, ignored_plugins: List[str]=None) -> List[Optional[ConflictStatus]]: |
There was a problem hiding this comment.
Ditto for the signature here: Sequence[str]=().
hookman/hooks.py
Outdated
| @@ -154,25 +167,27 @@ def _bind_libs_functions_on_hook_caller(self, shared_lib_path: Path, hook_caller | |||
| cpp_func = getattr(hook_caller, hook) | |||
| cpp_func(hooks_to_bind[hook]) | |||
|
|
|||
| def ensure_is_valid(self): | |||
| def ensure_is_valid(self, ignored_plugins: List[str]=None): | |||
There was a problem hiding this comment.
Ditto for the signature here: Sequence[str]=().
| assert len(hm.get_plugins_available()) == 2 | ||
| assert len(list((datadir / 'plugins').iterdir())) == 2 | ||
|
|
||
| hook_caller = hm.get_hook_caller(ignored_plugins=['Simple Plugin 2']) |
There was a problem hiding this comment.
Hmm by caption? We should ignore by some identifier, not the caption...
There was a problem hiding this comment.
I will create an issue to implement this in another PullRequest.
tests/test_hooks.py
Outdated
|
|
||
| plugin_status = hm.get_status() | ||
|
|
||
| assert plugin_status |
There was a problem hiding this comment.
Check the actual status here please
|
@nicoddemus Your suggestion about using an identifier instead of caption will be implemented on another PR because I need to do some changes in others modules that was not involved in this PR. |
Codecov Report
@@ Coverage Diff @@
## master #25 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 7 7
Lines 380 381 +1
=====================================
+ Hits 380 381 +1 |
hookman/hooks.py
Outdated
|
|
||
| def get_hook_caller(self): | ||
| plugins_available = [PluginInfo(plugin_file, self.hooks_available) for plugin_file in plugin_config_files] | ||
| return [ plugin_info for plugin_info in plugins_available if plugin_info.name not in ignored_plugins] |
No description provided.