nitpick.plugins package

Hook specifications used by Nitpick plugins.


The hook specifications and the plugin classes are still experimental and considered as an internal API. They might change at any time; use at your own risk.

nitpick.plugins.handle_config_file(config: Dict[str, Any], file_name: str, tags: Set[str]) → Optional[NitpickPlugin][source]

You should return a valid nitpick.plugins.base.NitpickPlugin instance or None.


A plugin instance if your plugin handles this file name or any of its identify tags. Return None if your plugin doesn’t handle this file or file type.

nitpick.plugins.plugin_class() → Type[NitpickPlugin][source]

You should return your plugin class here.