coalib package¶
Subpackages¶
- coalib.bearlib package
- Subpackages
- coalib.bearlib.abstractions package
- coalib.bearlib.aspects package
- Submodules
- coalib.bearlib.aspects.Metadata module
- coalib.bearlib.aspects.Redundancy module
- coalib.bearlib.aspects.Spelling module
- coalib.bearlib.aspects.base module
- coalib.bearlib.aspects.collections module
- coalib.bearlib.aspects.docs module
- coalib.bearlib.aspects.meta module
- coalib.bearlib.aspects.root module
- coalib.bearlib.aspects.taste module
- Module contents
- coalib.bearlib.languages package
- Subpackages
- coalib.bearlib.languages.definitions package
- Submodules
- coalib.bearlib.languages.definitions.C module
- coalib.bearlib.languages.definitions.CPP module
- coalib.bearlib.languages.definitions.CSS module
- coalib.bearlib.languages.definitions.CSharp module
- coalib.bearlib.languages.definitions.Golang module
- coalib.bearlib.languages.definitions.Java module
- coalib.bearlib.languages.definitions.JavaScript module
- coalib.bearlib.languages.definitions.Python module
- coalib.bearlib.languages.definitions.Unknown module
- coalib.bearlib.languages.definitions.Vala module
- Module contents
- coalib.bearlib.languages.documentation package
- coalib.bearlib.languages.definitions package
- Submodules
- coalib.bearlib.languages.Language module
- coalib.bearlib.languages.LanguageDefinition module
- Module contents
- Subpackages
- coalib.bearlib.naming_conventions package
- coalib.bearlib.spacing package
- Module contents
- Subpackages
- coalib.bears package
- coalib.collecting package
- coalib.core package
- coalib.misc package
- coalib.output package
- coalib.parsing package
- coalib.processes package
- coalib.results package
- Subpackages
- coalib.results.result_actions package
- Submodules
- coalib.results.result_actions.ApplyPatchAction module
- coalib.results.result_actions.IgnoreResultAction module
- coalib.results.result_actions.OpenEditorAction module
- coalib.results.result_actions.PrintAspectAction module
- coalib.results.result_actions.PrintDebugMessageAction module
- coalib.results.result_actions.PrintMoreInfoAction module
- coalib.results.result_actions.ResultAction module
- coalib.results.result_actions.ShowPatchAction module
- Module contents
- coalib.results.result_actions package
- Submodules
- coalib.results.AbsolutePosition module
- coalib.results.Diff module
- coalib.results.HiddenResult module
- coalib.results.LineDiff module
- coalib.results.RESULT_SEVERITY module
- coalib.results.Result module
- coalib.results.ResultFilter module
- coalib.results.SourcePosition module
- coalib.results.SourceRange module
- coalib.results.TextPosition module
- coalib.results.TextRange module
- Module contents
- Subpackages
- coalib.settings package
- coalib.testing package
Submodules¶
coalib.coala_delete_orig module¶
coalib.coala_main module¶
-
coalib.coala_main.
run_coala
(console_printer=None, log_printer=None, print_results=<function do_nothing>, acquire_settings=<function fail_acquire_settings>, print_section_beginning=<function do_nothing>, nothing_done=<function do_nothing>, autoapply=True, force_show_patch=False, arg_parser=None, arg_list=None)[source]¶ This is a main method that should be usable for almost all purposes and reduces executing coala to one function call.
Parameters: - console_printer – Object to print messages on the console.
- log_printer – A LogPrinter object to use for logging.
- print_results – A callback that takes a LogPrinter, a section, a list of results to be printed, the file dict and the mutable file diff dict.
- acquire_settings – The method to use for requesting settings. It will get a parameter which is a dictionary with the settings name as key and a list containing a description in [0] and the names of the bears who need this setting in all following indexes.
- print_section_beginning – A callback that will be called with a section name string whenever analysis of a new section is started.
- nothing_done – A callback that will be called with only a log printer that shall indicate that nothing was done.
- autoapply – Set this to false to not autoapply any actions. If you set this to False, force_show_patch will be ignored.
- force_show_patch – If set to True, a patch will be always shown. (Using ApplyPatchAction.)
- arg_parser – Instance of ArgParser that is used to parse non-setting arguments.
- arg_list – The CLI argument list.
Returns: A dictionary containing a list of results for all analyzed sections as key.