nitpick.plugins package
Hook specifications used by Nitpick plugins.
Note
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.
Submodules
- nitpick.plugins.base module
NitpickPluginNitpickPlugin.enforce_rules()NitpickPlugin.entry_point()NitpickPlugin.filenameNitpickPlugin.fixableNitpickPlugin.identify_tagsNitpickPlugin.initial_contentsNitpickPlugin.nitpick_file_dictNitpickPlugin.post_init()NitpickPlugin.predefined_special_config()NitpickPlugin.skip_empty_suggestionNitpickPlugin.validation_schemaNitpickPlugin.violation_base_codeNitpickPlugin.write_file()NitpickPlugin.write_initial_contents()
- nitpick.plugins.info module
- nitpick.plugins.ini module
IniPluginIniPlugin.add_options_before_space()IniPlugin.comma_separated_valuesIniPlugin.compare_different_keys()IniPlugin.contents_without_top_section()IniPlugin.current_sectionsIniPlugin.dirtyIniPlugin.enforce_comma_separated_values()IniPlugin.enforce_missing_sections()IniPlugin.enforce_rules()IniPlugin.enforce_section()IniPlugin.entry_point()IniPlugin.expected_configIniPlugin.expected_sectionsIniPlugin.file_pathIniPlugin.filenameIniPlugin.fixableIniPlugin.get_example_cfg()IniPlugin.get_missing_output()IniPlugin.identify_tagsIniPlugin.initial_contentsIniPlugin.missing_sectionsIniPlugin.needs_top_sectionIniPlugin.nitpick_file_dictIniPlugin.post_init()IniPlugin.predefined_special_config()IniPlugin.show_missing_keys()IniPlugin.skip_empty_suggestionIniPlugin.updaterIniPlugin.validation_schemaIniPlugin.violation_base_codeIniPlugin.write_file()IniPlugin.write_initial_contents()
Violationscan_handle()plugin_class()
- nitpick.plugins.json module
JsonFileSchemaJsonFileSchema.MetaJsonFileSchema.OPTIONS_CLASSJsonFileSchema.TYPE_MAPPINGJsonFileSchema.dict_classJsonFileSchema.dump()JsonFileSchema.dumps()JsonFileSchema.error_messagesJsonFileSchema.fieldsJsonFileSchema.from_dict()JsonFileSchema.get_attribute()JsonFileSchema.handle_error()JsonFileSchema.load()JsonFileSchema.loads()JsonFileSchema.on_bind_field()JsonFileSchema.optsJsonFileSchema.set_classJsonFileSchema.validate()
JsonPluginJsonPlugin.dirtyJsonPlugin.enforce_rules()JsonPlugin.entry_point()JsonPlugin.expected_configJsonPlugin.expected_dict_from_contains_json()JsonPlugin.expected_dict_from_contains_keys()JsonPlugin.file_pathJsonPlugin.filenameJsonPlugin.fixableJsonPlugin.identify_tagsJsonPlugin.initial_contentsJsonPlugin.nitpick_file_dictJsonPlugin.post_init()JsonPlugin.predefined_special_config()JsonPlugin.report()JsonPlugin.skip_empty_suggestionJsonPlugin.validation_schemaJsonPlugin.violation_base_codeJsonPlugin.write_file()JsonPlugin.write_initial_contents()
can_handle()plugin_class()
- nitpick.plugins.text module
TextItemSchemaTextItemSchema.MetaTextItemSchema.OPTIONS_CLASSTextItemSchema.TYPE_MAPPINGTextItemSchema.dict_classTextItemSchema.dump()TextItemSchema.dumps()TextItemSchema.error_messagesTextItemSchema.fieldsTextItemSchema.from_dict()TextItemSchema.get_attribute()TextItemSchema.handle_error()TextItemSchema.load()TextItemSchema.loads()TextItemSchema.on_bind_field()TextItemSchema.optsTextItemSchema.set_classTextItemSchema.validate()
TextPluginTextPlugin.dirtyTextPlugin.enforce_rules()TextPlugin.entry_point()TextPlugin.expected_configTextPlugin.file_pathTextPlugin.filenameTextPlugin.fixableTextPlugin.identify_tagsTextPlugin.initial_contentsTextPlugin.nitpick_file_dictTextPlugin.post_init()TextPlugin.predefined_special_config()TextPlugin.skip_empty_suggestionTextPlugin.validation_schemaTextPlugin.violation_base_codeTextPlugin.write_file()TextPlugin.write_initial_contents()
TextSchemaTextSchema.MetaTextSchema.OPTIONS_CLASSTextSchema.TYPE_MAPPINGTextSchema.dict_classTextSchema.dump()TextSchema.dumps()TextSchema.error_messagesTextSchema.fieldsTextSchema.from_dict()TextSchema.get_attribute()TextSchema.handle_error()TextSchema.load()TextSchema.loads()TextSchema.on_bind_field()TextSchema.optsTextSchema.set_classTextSchema.validate()
Violationscan_handle()plugin_class()
- nitpick.plugins.toml module
TomlPluginTomlPlugin.dirtyTomlPlugin.enforce_rules()TomlPlugin.entry_point()TomlPlugin.expected_configTomlPlugin.file_pathTomlPlugin.filenameTomlPlugin.fixableTomlPlugin.identify_tagsTomlPlugin.initial_contentsTomlPlugin.nitpick_file_dictTomlPlugin.post_init()TomlPlugin.predefined_special_config()TomlPlugin.report()TomlPlugin.skip_empty_suggestionTomlPlugin.validation_schemaTomlPlugin.violation_base_codeTomlPlugin.write_file()TomlPlugin.write_initial_contents()
can_handle()plugin_class()
- nitpick.plugins.yaml module
YamlPluginYamlPlugin.dirtyYamlPlugin.enforce_rules()YamlPlugin.entry_point()YamlPlugin.expected_configYamlPlugin.file_pathYamlPlugin.filenameYamlPlugin.fixableYamlPlugin.identify_tagsYamlPlugin.initial_contentsYamlPlugin.nitpick_file_dictYamlPlugin.post_init()YamlPlugin.predefined_special_config()YamlPlugin.report()YamlPlugin.skip_empty_suggestionYamlPlugin.validation_schemaYamlPlugin.violation_base_codeYamlPlugin.write_file()YamlPlugin.write_initial_contents()
can_handle()plugin_class()