def main():
configure_logging()
try:
console_printer = ConsolePrinter()
log_printer = LogPrinter(console_printer)
# Note: We parse the args here once to check whether to show bears or
# not.
args = default_arg_parser().parse_args()
# Defer imports so if e.g. --help is called they won't be run
from coalib.coala_modes import (
mode_format, mode_json, mode_non_interactive, mode_normal)
from coalib.output.ConsoleInteraction import (
show_bears, show_language_bears_capabilities)
console_printer = ConsolePrinter(print_colored=not args.no_color)
configure_logging(not args.no_color)
if args.json: # needs to be checked in order to display bears in json
return mode_json(args)
if args.show_bears:
from coalib.settings.ConfigurationGathering import (
get_filtered_bears)
local_bears, global_bears = get_filtered_bears(
args.filter_by_language, log_printer)
show_bears(local_bears,
global_bears,
args.show_description or args.show_details,
args.show_details,
console_printer)
return 0
elif args.show_capabilities:
from coalib.collecting.Collectors import (
filter_capabilities_by_languages)
from coalib.settings.ConfigurationGathering import (
get_filtered_bears)
local_bears, global_bears = get_filtered_bears(
args.filter_by_language, log_printer)
capabilities = filter_capabilities_by_languages(
local_bears, args.show_capabilities)
show_language_bears_capabilities(capabilities, console_printer)
return 0
except BaseException as exception: # pylint: disable=broad-except
return get_exitcode(exception, log_printer)
if args.format:
return mode_format()
if args.non_interactive:
return mode_non_interactive(console_printer, args)
return mode_normal(console_printer, log_printer)
def Analyze(self):
"""
This method analyzes the document and sends back the result
:return: The output is a list with an element for each section.
It contains:
- The name of the section
- Boolean which is true if all bears in the section executed
successfully
- List of results where each result is a list which contains:
(str)origin, (str)message, (str)file, (str)line_nr,
(str)severity
"""
retval = []
if self.path == "" or self.config_file == "":
return retval
args = ["--config=" + self.config_file]
log_printer = ListLogPrinter()
exitcode = 0
try:
yielded_results = False
(sections,
local_bears,
global_bears,
targets) = gather_configuration(fail_acquire_settings,
log_printer,
arg_list=args)
for section_name in sections:
section = sections[section_name]
if not section.is_enabled(targets):
continue
if any([fnmatch(self.path, file_pattern)
for file_pattern in path_list(section["files"])]):
section["files"].value = self.path
section_result = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=lambda *args: True,
log_printer=log_printer,
file_diff_dict={})
yielded_results = yielded_results or section_result[0]
retval.append(
DbusDocument.results_to_dbus_struct(section_result,
section_name))
if yielded_results:
exitcode = 1
except BaseException as exception: # pylint: disable=broad-except
exitcode = exitcode or get_exitcode(exception, log_printer)
logs = [log.to_string_dict() for log in log_printer.logs]
return (exitcode, logs, retval)
def main():
try:
console_printer = ConsolePrinter()
log_printer = LogPrinter(console_printer)
# Note: We parse the args here once to check whether to show bears or
# not.
args = default_arg_parser().parse_args()
if args.show_bears:
sections, _ = load_configuration(arg_list=None,
log_printer=log_printer)
local_bears, global_bears = collect_all_bears_from_sections(
sections, log_printer)
if args.filter_by_language:
local_bears = filter_section_bears_by_languages(
local_bears, args.filter_by_language)
global_bears = filter_section_bears_by_languages(
global_bears, args.filter_by_language)
show_bears(local_bears, global_bears, args.show_description
or args.show_details, args.show_details,
console_printer)
return 0
except BaseException as exception: # pylint: disable=broad-except
return get_exitcode(exception, log_printer)
partial_print_sec_beg = functools.partial(print_section_beginning,
console_printer)
results, exitcode, _ = run_coala(
print_results=print_results,
acquire_settings=acquire_settings,
print_section_beginning=partial_print_sec_beg,
nothing_done=nothing_done)
return exitcode
def main():
# Note: We parse the args here once to find the log printer to use.
# Also, commands like -h (help) and -v (version) are executed here.
# The args are again parsed later to find the settings and configs
# to use during analysis.
arg_parser = default_arg_parser()
try:
args = arg_parser.parse_args()
except BaseException as exception: # Ignore PyLintBear
return get_exitcode(exception)
log_printer = None if args.text_logs else ListLogPrinter()
results, exitcode = run_coala(log_printer=log_printer, autoapply=False)
retval = {"results": results}
if not args.text_logs:
retval["logs"] = log_printer.logs
print(
json.dumps(retval,
cls=JSONEncoder,
sort_keys=True,
indent=2,
separators=(',', ': ')))
return exitcode
def main():
log_printer = LogPrinter(ConsolePrinter())
exitcode = 0
try:
yielded_results = False
(sections,
local_bears,
global_bears,
targets) = gather_configuration(lambda *args: True, log_printer)
for section_name in sections:
section = sections[section_name]
if not section.is_enabled(targets):
continue
results = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=lambda *args: True,
log_printer=log_printer,
file_diff_dict={})
yielded_results = yielded_results or results[0]
if yielded_results:
exitcode = 1
except BaseException as exception: # pylint: disable=broad-except
exitcode = exitcode or get_exitcode(exception, log_printer)
return exitcode
def main():
try:
console_printer = ConsolePrinter()
log_printer = LogPrinter(console_printer)
# Note: We parse the args here once to check whether to show bears or
# not.
args = default_arg_parser().parse_args()
if args.show_bears:
local_bears, global_bears = get_filtered_bears(args.filter_by_language, log_printer)
show_bears(
local_bears,
global_bears,
args.show_description or args.show_details,
args.show_details,
console_printer,
)
return 0
except BaseException as exception: # pylint: disable=broad-except
return get_exitcode(exception, log_printer)
partial_print_sec_beg = functools.partial(print_section_beginning, console_printer)
results, exitcode, _ = run_coala(
print_results=print_results,
acquire_settings=acquire_settings,
print_section_beginning=partial_print_sec_beg,
nothing_done=nothing_done,
)
return exitcode
def main():
# Note: We parse the args here once to find the log printer to use.
# Also, commands like -h (help) and -v (version) are executed here.
# The args are again parsed later to find the settings and configs
# to use during analysis.
arg_parser = default_arg_parser()
try:
args = arg_parser.parse_args()
except BaseException as exception: # Ignore PyLintBear
return get_exitcode(exception)
log_printer = None if args.text_logs else ListLogPrinter()
results, exitcode = run_coala(log_printer=log_printer, autoapply=False)
retval = {"results": results}
if not args.text_logs:
retval["logs"] = log_printer.logs
print(json.dumps(retval,
cls=JSONEncoder,
sort_keys=True,
indent=2,
separators=(',', ': ')))
return exitcode
def Analyze(self):
"""
This method analyzes the document and sends back the result
:return: The output is a list with an element for each section.
It contains:
- The name of the section
- Boolean which is true if all bears in the section executed
successfully
- List of results where each result is a string dictionary
which contains: id, origin, message, file, line_nr, severity
"""
retval = []
if self.path == "" or self.config_file == "":
return retval
args = ["--config=" + self.config_file]
log_printer = ListLogPrinter()
exitcode = 0
try:
yielded_results = False
(sections, local_bears, global_bears,
targets) = gather_configuration(fail_acquire_settings,
log_printer,
arg_list=args)
for section_name in sections:
section = sections[section_name]
if not section.is_enabled(targets):
continue
if any([
fnmatch(self.path, file_pattern)
for file_pattern in path_list(section["files"])
]):
section["files"].value = self.path
section_result = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=lambda *args: True,
log_printer=log_printer)
yielded_results = yielded_results or section_result[0]
retval.append(
DbusDocument.results_to_dbus_struct(
section_result, section_name))
if yielded_results:
exitcode = 1
except BaseException as exception: # pylint: disable=broad-except
exitcode = exitcode or get_exitcode(exception, log_printer)
logs = [log.to_string_dict() for log in log_printer.logs]
return (exitcode, logs, retval)
def main():
configure_logging()
try:
console_printer = ConsolePrinter()
log_printer = LogPrinter(console_printer)
# Note: We parse the args here once to check whether to show bears or
# not.
args = default_arg_parser().parse_args()
# Defer imports so if e.g. --help is called they won't be run
from coalib.coala_modes import (mode_format, mode_json,
mode_non_interactive, mode_normal)
from coalib.output.ConsoleInteraction import (
show_bears, show_language_bears_capabilities)
console_printer = ConsolePrinter(print_colored=not args.no_color)
configure_logging(not args.no_color)
if args.json: # needs to be checked in order to display bears in json
return mode_json(args)
if args.show_bears:
from coalib.settings.ConfigurationGathering import (
get_filtered_bears)
local_bears, global_bears = get_filtered_bears(
args.filter_by_language, log_printer)
show_bears(local_bears, global_bears, args.show_description
or args.show_details, args.show_details,
console_printer)
return 0
elif args.show_capabilities:
from coalib.collecting.Collectors import (
filter_capabilities_by_languages)
from coalib.settings.ConfigurationGathering import (
get_filtered_bears)
local_bears, global_bears = get_filtered_bears(
args.filter_by_language, log_printer)
capabilities = filter_capabilities_by_languages(
local_bears, args.show_capabilities)
show_language_bears_capabilities(capabilities, console_printer)
return 0
except BaseException as exception: # pylint: disable=broad-except
return get_exitcode(exception, log_printer)
if args.format:
return mode_format()
if args.non_interactive:
return mode_non_interactive(console_printer, args)
return mode_normal(console_printer, log_printer)
def mode_json(args, debug=False):
import json
from coalib.coala_main import run_coala
from coalib.misc.DictUtilities import inverse_dicts
from coalib.misc.Exceptions import get_exitcode
from coalib.output.Logging import configure_json_logging
from coalib.output.JSONEncoder import create_json_encoder
if args.log_json:
log_stream = configure_json_logging()
JSONEncoder = create_json_encoder(use_relpath=args.relpath)
results = []
if args.show_bears:
try:
from coalib.parsing.FilterHelper import FilterHelper
local_bears, global_bears = FilterHelper.apply_filter(
'language', args.filter_by_language)
bears = inverse_dicts(local_bears, global_bears)
for bear, _ in sorted(bears.items(),
key=lambda bear_tuple: bear_tuple[0].name):
results.append(bear)
except BaseException as exception: # pylint: disable=broad-except
return get_exitcode(exception)
else:
results, exitcode, _ = run_coala(args=args, debug=debug)
retval = {'bears': results} if args.show_bears else {'results': results}
if args.log_json:
retval['logs'] = [
json.loads(line) for line in log_stream.getvalue().splitlines()
]
if args.output:
filename = str(args.output[0])
with open(filename, 'w+') as fp:
json.dump(retval,
fp,
cls=JSONEncoder,
sort_keys=True,
indent=2,
separators=(',', ': '))
else:
print(
json.dumps(retval,
cls=JSONEncoder,
sort_keys=True,
indent=2,
separators=(',', ': ')))
return 0 if args.show_bears else exitcode
def main():
configure_logging()
try:
console_printer = ConsolePrinter()
log_printer = LogPrinter(console_printer)
# Note: We parse the args here once to check whether to show bears or
# not.
args = default_arg_parser().parse_args()
console_printer = ConsolePrinter(print_colored=not args.no_color)
if args.show_bears:
from coalib.settings.ConfigurationGathering import (
get_filtered_bears)
local_bears, global_bears = get_filtered_bears(
args.filter_by_language, log_printer)
show_bears(local_bears, global_bears, args.show_description
or args.show_details, args.show_details,
console_printer)
return 0
elif args.show_capabilities:
from coalib.collecting.Collectors import (
filter_capabilities_by_languages)
from coalib.settings.ConfigurationGathering import (
get_filtered_bears)
local_bears, global_bears = get_filtered_bears(
args.filter_by_language, log_printer)
capabilities = filter_capabilities_by_languages(
local_bears, args.show_capabilities)
show_language_bears_capabilities(capabilities, console_printer)
return 0
except BaseException as exception: # pylint: disable=broad-except
return get_exitcode(exception, log_printer)
import functools
from coalib.coala_main import run_coala
partial_print_sec_beg = functools.partial(print_section_beginning,
console_printer)
results, exitcode, _ = run_coala(
print_results=print_results,
acquire_settings=acquire_settings,
print_section_beginning=partial_print_sec_beg,
nothing_done=nothing_done,
console_printer=console_printer)
return exitcode
def test_get_exitcode(self):
self.assertEqual(get_exitcode(KeyboardInterrupt()), 130)
self.assertEqual(get_exitcode(AssertionError()), 255)
self.assertEqual(get_exitcode(SystemExit(999)), 999)
self.assertEqual(get_exitcode(VersionConflict(
'version 1.0', 'version 2.0')), 13)
self.assertEqual(get_exitcode(EOFError()), 0)
self.assertEqual(get_exitcode(None), 0)
def test_get_exitcode(self):
self.assertEqual(get_exitcode(KeyboardInterrupt()), 130)
self.assertEqual(get_exitcode(AssertionError()), 255)
self.assertEqual(get_exitcode(SystemExit(999)), 999)
self.assertEqual(get_exitcode(VersionConflict(
"libclang-py3 0.3", "libclang-py3==0.2")), 13)
self.assertEqual(get_exitcode(EOFError()), 0)
self.assertEqual(get_exitcode(None), 0)
def test_get_exitcode(self):
self.assertEqual(get_exitcode(KeyboardInterrupt()), 130)
self.assertEqual(get_exitcode(AssertionError()), 255)
self.assertEqual(get_exitcode(SystemExit(999)), 999)
self.assertEqual(get_exitcode(VersionConflict(
'libclang-py3 0.3', 'libclang-py3==0.2')), 13)
self.assertEqual(get_exitcode(EOFError()), 0)
self.assertEqual(get_exitcode(None), 0)
def main():
log_printer = ListLogPrinter()
exitcode = 0
results = {}
try:
yielded_results = False
section_results = []
(sections,
local_bears,
global_bears,
targets) = gather_configuration(fail_acquire_settings, log_printer)
for section_name in sections:
section = sections[section_name]
if not section.is_enabled(targets):
continue
section_result = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=lambda *args: True,
log_printer=log_printer,
file_diff_dict={})
yielded_results = yielded_results or section_result[0]
results_for_section = []
for i in [1, 2]:
for key, value in section_result[i].items():
for result in value:
if isinstance(result, HiddenResult):
continue
results_for_section.append(result)
results[section_name] = results_for_section
if yielded_results:
exitcode = 1
except BaseException as exception: # pylint: disable=broad-except
exitcode = exitcode or get_exitcode(exception, log_printer)
retval = {"logs": log_printer.logs, "results": results}
retval = json.dumps(retval,
cls=JSONEncoder,
sort_keys=True,
indent=2,
separators=(',', ': '))
print(retval)
return exitcode
def main():
# Note: We parse the args here once to find the log printer to use.
# Also, commands like -h (help) and -v (version) are executed here.
# The args are again parsed later to find the settings and configs
# to use during analysis.
arg_parser = default_arg_parser()
args = arg_parser.parse_args()
log_printer = None if args.text_logs else ListLogPrinter()
JSONEncoder = create_json_encoder(use_relpath=args.relpath)
results = []
if args.show_bears:
try:
local_bears, global_bears = get_filtered_bears(
args.filter_by_language, log_printer)
bears = inverse_dicts(local_bears, global_bears)
for bear, _ in sorted(bears.items(),
key=lambda bear_tuple: bear_tuple[0].name):
results.append(bear)
except BaseException as exception: # pylint: disable=broad-except
return get_exitcode(exception, log_printer)
else:
results, exitcode, _ = run_coala(log_printer=log_printer,
autoapply=False)
retval = {"bears": results} if args.show_bears else {"results": results}
if not args.text_logs:
retval["logs"] = log_printer.logs
if args.output:
filename = str(args.output[0])
with open(filename, 'w+') as fp:
json.dump(retval,
fp,
cls=JSONEncoder,
sort_keys=True,
indent=2,
separators=(',', ': '))
else:
print(
json.dumps(retval,
cls=JSONEncoder,
sort_keys=True,
indent=2,
separators=(',', ': ')))
return 0 if args.show_bears else exitcode
def main():
# Note: We parse the args here once to find the log printer to use.
# Also, commands like -h (help) and -v (version) are executed here.
# The args are again parsed later to find the settings and configs
# to use during analysis.
arg_parser = default_arg_parser()
args = arg_parser.parse_args()
log_printer = None if args.text_logs else ListLogPrinter()
JSONEncoder = create_json_encoder(use_relpath=args.relpath)
results = []
if args.show_bears:
try:
local_bears, global_bears = get_filtered_bears(
args.filter_by_language, log_printer)
bears = inverse_dicts(local_bears, global_bears)
for bear, _ in sorted(bears.items(),
key=lambda bear_tuple:
bear_tuple[0].name):
results.append(bear)
except BaseException as exception: # pylint: disable=broad-except
return get_exitcode(exception, log_printer)
else:
results, exitcode, _ = run_coala(
log_printer=log_printer, autoapply=False)
retval = {"bears": results} if args.show_bears else {"results": results}
if not args.text_logs:
retval["logs"] = log_printer.logs
if args.output:
filename = str(args.output[0])
with open(filename, 'w+') as fp:
json.dump(retval, fp,
cls=JSONEncoder,
sort_keys=True,
indent=2,
separators=(',', ': '))
else:
print(json.dumps(retval,
cls=JSONEncoder,
sort_keys=True,
indent=2,
separators=(',', ': ')))
return 0 if args.show_bears else exitcode
def main():
log_printer = LogPrinter(ConsolePrinter())
console_printer = ConsolePrinter()
exitcode = 0
try:
did_nothing = True
yielded_results = False
(sections,
local_bears,
global_bears,
targets) = gather_configuration(acquire_settings, log_printer)
if bool(sections["default"].get("show_bears", "False")):
show_bears(local_bears,
global_bears,
console_printer)
did_nothing = False
else:
for section_name in sections:
section = sections[section_name]
if not section.is_enabled(targets):
continue
file_diff_dict = {}
print_section_beginning(console_printer, section)
results = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=print_results,
log_printer=log_printer,
file_diff_dict=file_diff_dict)
yielded_results = yielded_results or results[0]
finalize(file_diff_dict, results[3], log_printer)
did_nothing = False
if did_nothing:
nothing_done(console_printer)
if yielded_results:
exitcode = 1
except BaseException as exception: # pylint: disable=broad-except
exitcode = exitcode or get_exitcode(exception, log_printer)
return exitcode
def mode_json(args):
import json
from coalib.coala_main import run_coala
from coalib.misc.DictUtilities import inverse_dicts
from coalib.misc.Exceptions import get_exitcode
from coalib.output.JSONEncoder import create_json_encoder
from coalib.output.printers.LogPrinter import LogPrinter
from coalib.parsing.DefaultArgParser import default_arg_parser
from coalib.settings.ConfigurationGathering import get_filtered_bears
JSONEncoder = create_json_encoder(use_relpath=args.relpath)
results = []
if args.show_bears:
try:
local_bears, global_bears = get_filtered_bears(
args.filter_by_language, LogPrinter())
bears = inverse_dicts(local_bears, global_bears)
for bear, _ in sorted(bears.items(),
key=lambda bear_tuple:
bear_tuple[0].name):
results.append(bear)
except BaseException as exception: # pylint: disable=broad-except
return get_exitcode(exception)
else:
results, exitcode, _ = run_coala()
retval = {'bears': results} if args.show_bears else {'results': results}
if args.output:
filename = str(args.output[0])
with open(filename, 'w+') as fp:
json.dump(retval, fp,
cls=JSONEncoder,
sort_keys=True,
indent=2,
separators=(',', ': '))
else:
print(json.dumps(retval,
cls=JSONEncoder,
sort_keys=True,
indent=2,
separators=(',', ': ')))
return 0 if args.show_bears else exitcode
def mode_json(args):
import json
from coalib.coala_main import run_coala
from coalib.misc.DictUtilities import inverse_dicts
from coalib.misc.Exceptions import get_exitcode
from coalib.output.JSONEncoder import create_json_encoder
from coalib.output.printers.LogPrinter import LogPrinter
from coalib.settings.ConfigurationGathering import get_filtered_bears
JSONEncoder = create_json_encoder(use_relpath=args.relpath)
results = []
if args.show_bears:
try:
local_bears, global_bears = get_filtered_bears(
args.filter_by_language, LogPrinter())
bears = inverse_dicts(local_bears, global_bears)
for bear, _ in sorted(bears.items(),
key=lambda bear_tuple: bear_tuple[0].name):
results.append(bear)
except BaseException as exception: # pylint: disable=broad-except
return get_exitcode(exception)
else:
results, exitcode, _ = run_coala()
retval = {'bears': results} if args.show_bears else {'results': results}
if args.output:
filename = str(args.output[0])
with open(filename, 'w+') as fp:
json.dump(retval,
fp,
cls=JSONEncoder,
sort_keys=True,
indent=2,
separators=(',', ': '))
else:
print(
json.dumps(retval,
cls=JSONEncoder,
sort_keys=True,
indent=2,
separators=(',', ': ')))
return 0 if args.show_bears else exitcode
def main():
# Note: We parse the args here once to check whether to show bears or not.
arg_parser = default_arg_parser()
args = arg_parser.parse_args()
console_printer = ConsolePrinter()
if args.show_bears or args.show_all_bears or args.show_language_bears:
log_printer = LogPrinter(console_printer)
try:
sections, _ = load_configuration(arg_list=None,
log_printer=log_printer)
if args.show_language_bears:
local_bears, global_bears = collect_all_bears_from_sections(
sections, log_printer)
local_bears = filter_section_bears_by_languages(
local_bears, args.show_language_bears)
global_bears = filter_section_bears_by_languages(
global_bears, args.show_language_bears)
elif args.show_all_bears:
local_bears, global_bears = collect_all_bears_from_sections(
sections, log_printer)
else:
# We ignore missing settings as it's not important.
local_bears, global_bears = fill_settings(
sections,
acquire_settings=lambda *args, **kwargs: {},
log_printer=log_printer)
show_bears(local_bears, global_bears,
args.show_language_bears or args.show_all_bears,
console_printer)
except BaseException as exception: # pylint: disable=broad-except
return get_exitcode(exception, log_printer)
return 0
partial_print_sec_beg = functools.partial(
print_section_beginning,
console_printer)
results, exitcode, _ = run_coala(
print_results=print_results,
acquire_settings=acquire_settings,
print_section_beginning=partial_print_sec_beg,
nothing_done=nothing_done)
return exitcode
def main():
# Note: We parse the args here once to check whether to show bears or not.
arg_parser = default_arg_parser()
args = arg_parser.parse_args()
console_printer = ConsolePrinter()
if args.show_bears or args.show_all_bears or args.show_language_bears:
log_printer = LogPrinter(console_printer)
try:
sections, _ = load_configuration(arg_list=None,
log_printer=log_printer)
if args.show_language_bears:
local_bears, global_bears = collect_all_bears_from_sections(
sections, log_printer)
local_bears = filter_section_bears_by_languages(
local_bears, args.show_language_bears)
global_bears = filter_section_bears_by_languages(
global_bears, args.show_language_bears)
elif args.show_all_bears:
local_bears, global_bears = collect_all_bears_from_sections(
sections, log_printer)
else:
# We ignore missing settings as it's not important.
local_bears, global_bears = fill_settings(
sections,
acquire_settings=lambda *args, **kwargs: {},
log_printer=log_printer)
show_bears(local_bears, global_bears, args.show_all_bears,
console_printer)
except BaseException as exception: # pylint: disable=broad-except
return get_exitcode(exception, log_printer)
return 0
partial_print_sec_beg = functools.partial(
print_section_beginning,
console_printer)
results, exitcode, _ = run_coala(
print_results=print_results,
acquire_settings=acquire_settings,
print_section_beginning=partial_print_sec_beg,
nothing_done=nothing_done)
return exitcode
def mode_json(args):
import json
from coalib.coala_main import run_coala
from coalib.misc.DictUtilities import inverse_dicts
from coalib.misc.Exceptions import get_exitcode
from coalib.output.Logging import configure_json_logging
from coalib.output.JSONEncoder import create_json_encoder
from coalib.output.printers.LogPrinter import LogPrinter
from coalib.settings.ConfigurationGathering import get_filtered_bears
if args.log_json:
log_stream = configure_json_logging()
JSONEncoder = create_json_encoder(use_relpath=args.relpath)
results = []
if args.show_bears:
try:
local_bears, global_bears = get_filtered_bears(args.filter_by_language, LogPrinter())
bears = inverse_dicts(local_bears, global_bears)
for bear, _ in sorted(bears.items(), key=lambda bear_tuple: bear_tuple[0].name):
results.append(bear)
except BaseException as exception: # pylint: disable=broad-except
return get_exitcode(exception)
else:
results, exitcode, _ = run_coala()
retval = {"bears": results} if args.show_bears else {"results": results}
if args.log_json:
retval["logs"] = [json.loads(line) for line in log_stream.getvalue().splitlines()]
if args.output:
filename = str(args.output[0])
with open(filename, "w+") as fp:
json.dump(retval, fp, cls=JSONEncoder, sort_keys=True, indent=2, separators=(",", ": "))
else:
print(json.dumps(retval, cls=JSONEncoder, sort_keys=True, indent=2, separators=(",", ": ")))
return 0 if args.show_bears else exitcode
def main():
try:
console_printer = ConsolePrinter()
log_printer = LogPrinter(console_printer)
# Note: We parse the args here once to check whether to show bears or
# not.
args = default_arg_parser().parse_args()
if args.show_bears:
local_bears, global_bears = get_filtered_bears(
args.filter_by_language, log_printer)
show_bears(local_bears, global_bears, args.show_description
or args.show_details, args.show_details,
console_printer)
return 0
elif args.show_capabilities:
local_bears, global_bears = get_filtered_bears(
args.filter_by_language, log_printer)
capabilities = filter_capabilities_by_languages(
local_bears, args.show_capabilities)
show_language_bears_capabilities(capabilities, console_printer)
return 0
except BaseException as exception: # pylint: disable=broad-except
return get_exitcode(exception, log_printer)
partial_print_sec_beg = functools.partial(print_section_beginning,
console_printer)
results, exitcode, _ = run_coala(
print_results=print_results,
acquire_settings=acquire_settings,
print_section_beginning=partial_print_sec_beg,
nothing_done=nothing_done)
return exitcode
def run_coala(log_printer=None,
print_results=do_nothing,
acquire_settings=fail_acquire_settings,
print_section_beginning=do_nothing,
nothing_done=do_nothing,
autoapply=True,
arg_parser=None):
"""
This is a main method that should be usable for almost all purposes and
reduces executing coala to one function call.
:param log_printer: A LogPrinter object to use for logging.
:param 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.
:param 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.
:param print_section_beginning: A callback that will be called with a
section name string whenever analysis of a
new section is started.
:param nothing_done: A callback that will be called with only a
log printer that shall indicate that
nothing was done.
:param autoapply: Set to False to autoapply nothing by
default; this is overridable via any
configuration file/CLI.
:return: A dictionary containing a list of results
for all analyzed sections as key.
"""
log_printer = log_printer or LogPrinter(ConsolePrinter(), LOG_LEVEL.DEBUG)
exitcode = 0
results = {}
file_dicts = {}
try:
yielded_results = yielded_unfixed_results = False
did_nothing = True
sections, local_bears, global_bears, targets = gather_configuration(
acquire_settings,
log_printer,
autoapply=autoapply,
arg_parser=arg_parser)
log_printer.debug("Platform {} -- Python {}, pip {}, coalib {}"
.format(platform.system(), platform.python_version(),
pip.__version__, VERSION))
config_file = os.path.abspath(str(sections["default"].get("config")))
settings_hash = get_settings_hash(sections)
flush_cache = bool(sections["default"].get("flush_cache", False) or
settings_changed(log_printer, settings_hash))
cache = FileCache(log_printer, os.getcwd(), flush_cache)
for section_name, section in sections.items():
if not section.is_enabled(targets):
continue
print_section_beginning(section)
section_result = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=print_results,
cache=cache,
log_printer=log_printer)
yielded, yielded_unfixed, results[section_name] = (
simplify_section_result(section_result))
yielded_results = yielded_results or yielded
yielded_unfixed_results = (
yielded_unfixed_results or yielded_unfixed)
did_nothing = False
file_dicts[section_name] = section_result[3]
update_settings_db(log_printer, settings_hash)
if sections["default"].get("changed_files", False):
cache.write()
if did_nothing:
nothing_done(log_printer)
elif yielded_unfixed_results:
exitcode = 1
elif yielded_results:
exitcode = 5
except BaseException as exception: # pylint: disable=broad-except
exitcode = exitcode or get_exitcode(exception, log_printer)
return results, exitcode, file_dicts
def test_get_exitcode(self):
self.assertEqual(get_exitcode(KeyboardInterrupt()), 130)
self.assertEqual(get_exitcode(AssertionError()), 255)
self.assertEqual(get_exitcode(SystemExit(999)), 999)
self.assertEqual(get_exitcode(EOFError()), 0)
self.assertEqual(get_exitcode(None), 0)
def run_coala(log_printer=None,
print_results=do_nothing,
acquire_settings=do_nothing,
print_section_beginning=do_nothing,
finalize=do_nothing,
nothing_done=do_nothing,
show_bears=do_nothing):
"""
This is a main method that should be usable for almost all purposes and
reduces executing coala to one function call.
:param log_printer: A LogPrinter object to use for logging.
:param 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.
:param 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.
:param print_section_beginning: A callback that will be called with a
section name string whenever analysis of a
new section is started.
:param finalize: 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.
:param nothing_done: A callback that will be called without
parameters if nothing was done.
:param show_bears: A callback that will be called with first
a list of local bears, second a list of
global bears to output them.
:return: A dictionary containing a list of results
for all analyzed sections as key.
"""
log_printer = log_printer or LogPrinter(ConsolePrinter())
exitcode = 0
results = None
try:
yielded_results = False
did_nothing = True
(sections,
local_bears,
global_bears,
targets) = gather_configuration(acquire_settings, log_printer)
if bool(sections["default"].get("show_bears", "False")):
show_bears(local_bears,
global_bears)
did_nothing = False
else:
results = {}
for section_name in sections:
section = sections[section_name]
if not section.is_enabled(targets):
continue
print_section_beginning(section)
file_diff_dict = {}
section_result = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=print_results,
log_printer=log_printer,
file_diff_dict=file_diff_dict)
yielded_results = yielded_results or section_result[0]
finalize(file_diff_dict, section_result[3], log_printer)
results_for_section = []
for value in chain(section_result[1].values(),
section_result[2].values()):
for result in value:
if not isinstance(result, HiddenResult):
results_for_section.append(result)
results[section_name] = results_for_section
did_nothing = False
if did_nothing:
nothing_done()
if yielded_results:
exitcode = 1
except BaseException as exception: # pylint: disable=broad-except
exitcode = exitcode or get_exitcode(exception, log_printer)
return results, exitcode
def main(debug=False):
configure_logging()
args = None # to have args variable in except block when parse_args fails
try:
# Note: We parse the args here once to check whether to show bears or
# not.
args = default_arg_parser().parse_args()
if args.debug:
req_ipdb = PipRequirement('ipdb')
if not req_ipdb.is_installed():
logging.error('--debug flag requires ipdb. '
'You can install it with:\n%s',
' '.join(req_ipdb.install_command()))
sys.exit(13)
if debug or args.debug:
args.log_level = 'DEBUG'
# Defer imports so if e.g. --help is called they won't be run
from coalib.coala_modes import (
mode_format, mode_json, mode_non_interactive, mode_normal)
from coalib.output.ConsoleInteraction import (
show_bears, show_language_bears_capabilities)
console_printer = ConsolePrinter(print_colored=not args.no_color)
configure_logging(not args.no_color)
if args.show_bears:
from coalib.settings.ConfigurationGathering import get_all_bears
kwargs = {}
if args.bears:
kwargs['bear_globs'] = args.bears
filtered_bears = get_all_bears(**kwargs)
if args.filter_by_language:
logging.warning(
"'--filter-by-language ...' is deprecated. "
"Use '--filter-by language ...' instead.")
if args.filter_by is None:
args.filter_by = []
args.filter_by.append(['language'] + args.filter_by_language)
if args.filter_by:
# Each iteration of the following loop applies
# filters one by one provided as arguments
try:
args.filter_by = filter_vector_to_dict(args.filter_by)
filtered_bears = apply_filters(
args.filter_by, filtered_bears)
except (InvalidFilterException, NotImplementedError) as ex:
# If filter is not available or is unusable
console_printer.print(ex)
return 2
local_bears, global_bears = filtered_bears
show_bears(local_bears,
global_bears,
args.show_description or args.show_details,
args.show_details,
console_printer,
args)
return 0
elif args.show_capabilities:
from coalib.collecting.Collectors import (
filter_capabilities_by_languages)
local_bears, _ = apply_filter('language', args.show_capabilities)
capabilities = filter_capabilities_by_languages(
local_bears, args.show_capabilities)
show_language_bears_capabilities(capabilities, console_printer)
return 0
if args.json:
return mode_json(args, debug=debug)
except BaseException as exception: # pylint: disable=broad-except
if not isinstance(exception, SystemExit):
if args and args.debug:
import ipdb
with ipdb.launch_ipdb_on_exception():
raise
if debug:
raise
return get_exitcode(exception)
if args.format:
return mode_format(args, debug=debug)
if args.non_interactive:
return mode_non_interactive(console_printer, args, debug=debug)
return mode_normal(console_printer, None, args, debug=debug)
def test_get_exitcode(self):
self.assertEqual(get_exitcode(KeyboardInterrupt()), 130)
self.assertEqual(get_exitcode(AssertionError()), 255)
self.assertEqual(get_exitcode(SystemExit(999)), 999)
self.assertEqual(get_exitcode(EOFError()), 0)
self.assertEqual(get_exitcode(None), 0)
def run_coala(log_printer=None,
print_results=do_nothing,
acquire_settings=fail_acquire_settings,
print_section_beginning=do_nothing,
nothing_done=do_nothing,
autoapply=True):
"""
This is a main method that should be usable for almost all purposes and
reduces executing coala to one function call.
:param log_printer: A LogPrinter object to use for logging.
:param 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.
:param 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.
:param print_section_beginning: A callback that will be called with a
section name string whenever analysis of a
new section is started.
:param nothing_done: A callback that will be called with only a
log printer that shall indicate that
nothing was done.
:param autoapply: Set to False to autoapply nothing by
default; this is overridable via any
configuration file/CLI.
:return: A dictionary containing a list of results
for all analyzed sections as key.
"""
log_printer = log_printer or LogPrinter(ConsolePrinter())
exitcode = 0
results = {}
file_dicts = {}
try:
yielded_results = yielded_unfixed_results = False
did_nothing = True
sections, local_bears, global_bears, targets = gather_configuration(
acquire_settings, log_printer, autoapply=autoapply)
log_printer.debug("Platform {} -- Python {}, pip {}, coalib {}".format(
platform.system(), platform.python_version(), pip.__version__,
VERSION))
tag = str(sections['default'].get('tag', None))
dtag = str(sections['default'].get('dtag', None))
config_file = os.path.abspath(str(sections["default"].get("config")))
# Deleting all .orig files, so the latest files are up to date!
coala_delete_orig.main(log_printer, sections["default"])
delete_tagged_results(dtag, config_file, log_printer)
for section_name, section in sections.items():
if not section.is_enabled(targets):
continue
print_section_beginning(section)
section_result = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=print_results,
log_printer=log_printer)
yielded, yielded_unfixed, results[section_name] = (
simplify_section_result(section_result))
yielded_results = yielded_results or yielded
yielded_unfixed_results = (yielded_unfixed_results
or yielded_unfixed)
did_nothing = False
file_dicts[section_name] = section_result[3]
tag_results(tag, config_file, results, log_printer)
if did_nothing:
nothing_done(log_printer)
elif yielded_unfixed_results:
exitcode = 1
elif yielded_results:
exitcode = 5
except BaseException as exception: # pylint: disable=broad-except
exitcode = exitcode or get_exitcode(exception, log_printer)
return results, exitcode, file_dicts
def run_coala(log_printer=None,
print_results=do_nothing,
acquire_settings=fail_acquire_settings,
print_section_beginning=do_nothing,
nothing_done=do_nothing,
autoapply=True,
arg_parser=None,
arg_list=None):
"""
This is a main method that should be usable for almost all purposes and
reduces executing coala to one function call.
:param log_printer: A LogPrinter object to use for logging.
:param 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.
:param 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.
:param print_section_beginning: A callback that will be called with a
section name string whenever analysis of a
new section is started.
:param nothing_done: A callback that will be called with only a
log printer that shall indicate that
nothing was done.
:param autoapply: Set to False to autoapply nothing by
default; this is overridable via any
configuration file/CLI.
:param arg_list: The CLI argument list.
:return: A dictionary containing a list of results
for all analyzed sections as key.
"""
configure_logging()
log_printer = (LogPrinter(ConsolePrinter(), LOG_LEVEL.DEBUG)
if log_printer is None else log_printer)
exitcode = 0
results = {}
file_dicts = {}
try:
yielded_results = yielded_unfixed_results = False
did_nothing = True
sections, local_bears, global_bears, targets = gather_configuration(
acquire_settings,
log_printer,
autoapply=autoapply,
arg_parser=arg_parser,
arg_list=arg_list)
log_printer.debug("Platform {} -- Python {}, pip {}, coalib {}".format(
platform.system(), platform.python_version(), pip.__version__,
VERSION))
config_file = os.path.abspath(str(sections["default"].get("config")))
settings_hash = get_settings_hash(sections, targets)
flush_cache = bool(sections["default"].get("flush_cache", False)
or settings_changed(log_printer, settings_hash))
disable_caching = bool(sections["default"].get("disable_caching",
False))
cache = None
if not sections["default"].get("disable_caching", False):
cache = FileCache(log_printer, os.getcwd(), flush_cache)
for section_name, section in sections.items():
if not section.is_enabled(targets):
continue
print_section_beginning(section)
section_result = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=print_results,
cache=cache,
log_printer=log_printer)
yielded, yielded_unfixed, results[section_name] = (
simplify_section_result(section_result))
yielded_results = yielded_results or yielded
yielded_unfixed_results = (yielded_unfixed_results
or yielded_unfixed)
did_nothing = False
file_dicts[section_name] = section_result[3]
update_settings_db(log_printer, settings_hash)
if cache:
cache.write()
if did_nothing:
nothing_done(log_printer)
elif yielded_unfixed_results:
exitcode = 1
elif yielded_results:
exitcode = 5
except BaseException as exception: # pylint: disable=broad-except
exitcode = exitcode or get_exitcode(exception, log_printer)
return results, exitcode, file_dicts
def run_coala(log_printer=None,
print_results=do_nothing,
acquire_settings=fail_acquire_settings,
print_section_beginning=do_nothing,
nothing_done=do_nothing,
show_bears=do_nothing,
autoapply=True):
"""
This is a main method that should be usable for almost all purposes and
reduces executing coala to one function call.
:param log_printer: A LogPrinter object to use for logging.
:param 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.
:param 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.
:param print_section_beginning: A callback that will be called with a
section name string whenever analysis of a
new section is started.
:param nothing_done: A callback that will be called with only a
log printer that shall indicate that
nothing was done.
:param show_bears: A callback that will be called with first
a list of local bears, second a list of
global bears to output them. A third bool
parameter may be used to indicate if a
compressed output (True) or a normal output
(False) is desired, the former being used
for showing all available bears to the
user.
:param autoapply: Set to False to autoapply nothing by
default; this is overridable via any
configuration file/CLI.
:return: A dictionary containing a list of results
for all analyzed sections as key.
"""
log_printer = log_printer or LogPrinter(ConsolePrinter())
exitcode = 0
results = None
try:
yielded_results = yielded_unfixed_results = False
did_nothing = True
sections, local_bears, global_bears, targets = gather_configuration(
acquire_settings, log_printer, autoapply=autoapply)
tag = str(sections['default'].get('tag', None))
dtag = str(sections['default'].get('dtag', None))
config_file = os.path.abspath(str(sections["default"].get("config")))
show_all_bears = bool(sections['default'].get('show_all_bears', False))
show_bears_ = bool(sections["default"].get("show_bears", "False"))
# Deleting all .orig files, so the latest files are up to date!
coala_delete_orig.main(log_printer, sections["default"])
delete_tagged_results(dtag, config_file, log_printer)
if show_bears_ or show_all_bears:
if show_all_bears:
(local_bears, global_bears) = collect_all_bears_from_sections(
sections, log_printer)
show_bears(local_bears, global_bears, show_all_bears)
did_nothing = False
else:
results = {}
for section_name, section in sections.items():
if not section.is_enabled(targets):
continue
print_section_beginning(section)
section_result = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=print_results,
log_printer=log_printer)
yielded, yielded_unfixed, results[section_name] = (
simplify_section_result(section_result))
yielded_results = yielded_results or yielded
yielded_unfixed_results = (yielded_unfixed_results
or yielded_unfixed)
did_nothing = False
tag_results(tag, config_file, results, log_printer)
if did_nothing:
nothing_done(log_printer)
elif yielded_unfixed_results:
exitcode = 1
elif yielded_results:
exitcode = 5
except BaseException as exception: # pylint: disable=broad-except
exitcode = exitcode or get_exitcode(exception, log_printer)
return results, exitcode
def run_coala(log_printer=None,
print_results=do_nothing,
acquire_settings=fail_acquire_settings,
print_section_beginning=do_nothing,
nothing_done=do_nothing,
show_bears=do_nothing,
autoapply=True):
"""
This is a main method that should be usable for almost all purposes and
reduces executing coala to one function call.
:param log_printer: A LogPrinter object to use for logging.
:param 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.
:param 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.
:param print_section_beginning: A callback that will be called with a
section name string whenever analysis of a
new section is started.
:param nothing_done: A callback that will be called with only a
log printer that shall indicate that
nothing was done.
:param show_bears: A callback that will be called with first
a list of local bears, second a list of
global bears to output them. A third bool
parameter may be used to indicate if a
compressed output (True) or a normal output
(False) is desired, the former being used
for showing all available bears to the
user.
:param autoapply: Set to False to autoapply nothing by
default; this is overridable via any
configuration file/CLI.
:return: A dictionary containing a list of results
for all analyzed sections as key.
"""
log_printer = log_printer or LogPrinter(ConsolePrinter())
exitcode = 0
results = None
try:
yielded_results = yielded_unfixed_results = False
did_nothing = True
sections, local_bears, global_bears, targets = gather_configuration(
acquire_settings,
log_printer,
autoapply=autoapply)
tag = str(sections['default'].get('tag', None))
dtag = str(sections['default'].get('dtag', None))
config_file = os.path.abspath(str(sections["default"].get("config")))
show_all_bears = bool(sections['default'].get('show_all_bears', False))
show_bears_ = bool(sections["default"].get("show_bears", "False"))
# Deleting all .orig files, so the latest files are up to date!
coala_delete_orig.main(log_printer, sections["default"])
delete_tagged_results(dtag, config_file, log_printer)
if show_bears_ or show_all_bears:
if show_all_bears:
(local_bears,
global_bears) = collect_all_bears_from_sections(sections,
log_printer)
show_bears(local_bears, global_bears, show_all_bears)
did_nothing = False
else:
results = {}
for section_name, section in sections.items():
if not section.is_enabled(targets):
continue
print_section_beginning(section)
section_result = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=print_results,
log_printer=log_printer)
yielded, yielded_unfixed, results[section_name] = (
simplify_section_result(section_result))
yielded_results = yielded_results or yielded
yielded_unfixed_results = (
yielded_unfixed_results or yielded_unfixed)
did_nothing = False
tag_results(tag, config_file, results, log_printer)
if did_nothing:
nothing_done(log_printer)
elif yielded_unfixed_results:
exitcode = 1
elif yielded_results:
exitcode = 5
except BaseException as exception: # pylint: disable=broad-except
exitcode = exitcode or get_exitcode(exception, log_printer)
return results, exitcode
def run_coala(console_printer=None,
log_printer=None,
print_results=do_nothing,
acquire_settings=fail_acquire_settings,
print_section_beginning=do_nothing,
nothing_done=do_nothing,
autoapply=True,
force_show_patch=False,
arg_parser=None,
arg_list=None):
"""
This is a main method that should be usable for almost all purposes and
reduces executing coala to one function call.
:param console_printer: Object to print messages on the console.
:param log_printer: A LogPrinter object to use for logging.
:param 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.
:param 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.
:param print_section_beginning: A callback that will be called with a
section name string whenever analysis of a
new section is started.
:param nothing_done: A callback that will be called with only a
log printer that shall indicate that
nothing was done.
:param autoapply: Set this to false to not autoapply any
actions. If you set this to `False`,
`force_show_patch` will be ignored.
:param force_show_patch: If set to True, a patch will be always
shown. (Using ApplyPatchAction.)
:param arg_parser: Instance of ArgParser that is used to parse
non-setting arguments.
:param arg_list: The CLI argument list.
:return: A dictionary containing a list of results
for all analyzed sections as key.
"""
log_printer = (LogPrinter(ConsolePrinter(), LOG_LEVEL.DEBUG)
if log_printer is None else log_printer)
exitcode = 0
results = {}
file_dicts = {}
try:
yielded_results = yielded_unfixed_results = False
did_nothing = True
sections, local_bears, global_bears, targets = gather_configuration(
acquire_settings,
log_printer,
arg_parser=arg_parser,
arg_list=arg_list)
log_printer.debug('Platform {} -- Python {}, coalib {}'.format(
platform.system(), platform.python_version(), VERSION))
settings_hash = get_settings_hash(sections, targets)
flush_cache = bool(sections['cli'].get('flush_cache', False)
or settings_changed(log_printer, settings_hash))
cache = None
if not sections['cli'].get('disable_caching', False):
cache = FileCache(log_printer, os.getcwd(), flush_cache)
for section_name, section in sections.items():
if not section.is_enabled(targets):
continue
if not autoapply:
section['default_actions'] = ''
elif force_show_patch:
section['default_actions'] = '*: ShowPatchAction'
section['show_result_on_top'] = 'yeah'
print_section_beginning(section)
section_result = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=print_results,
cache=cache,
log_printer=log_printer,
console_printer=console_printer)
yielded, yielded_unfixed, results[section_name] = (
simplify_section_result(section_result))
yielded_results = yielded_results or yielded
yielded_unfixed_results = (yielded_unfixed_results
or yielded_unfixed)
did_nothing = False
file_dicts[section_name] = section_result[3]
update_settings_db(log_printer, settings_hash)
if cache:
cache.write()
if CounterHandler.get_num_calls_for_level('ERROR') > 0:
exitcode = 1
elif did_nothing:
nothing_done(log_printer)
exitcode = 2
elif yielded_unfixed_results:
exitcode = 1
elif yielded_results:
exitcode = 5
except BaseException as exception: # pylint: disable=broad-except
exitcode = exitcode or get_exitcode(exception, log_printer)
return results, exitcode, file_dicts
def run_coala(console_printer=None,
log_printer=None,
print_results=do_nothing,
acquire_settings=fail_acquire_settings,
print_section_beginning=do_nothing,
nothing_done=do_nothing,
autoapply=True,
force_show_patch=False,
arg_parser=None,
arg_list=None,
args=None,
debug=False,
cache=None):
"""
This is a main method that should be usable for almost all purposes and
reduces executing coala to one function call.
:param console_printer: Object to print messages on the console.
:param log_printer: A LogPrinter object to use for logging.
:param 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.
:param 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.
:param print_section_beginning: A callback that will be called with a
section name string whenever analysis of a
new section is started.
:param nothing_done: A callback that will be called with only a
log printer that shall indicate that
nothing was done.
:param autoapply: Set this to false to not autoapply any
actions. If you set this to `False`,
`force_show_patch` will be ignored.
:param force_show_patch: If set to True, a patch will be always
shown. (Using ApplyPatchAction.)
:param arg_parser: Instance of ArgParser that is used to parse
non-setting arguments.
:param arg_list: The CLI argument list.
:param args: Alternative pre-parsed CLI arguments.
:param debug: Run in debug mode, bypassing
multiprocessing, and not catching any
exceptions.
:param cache: Instance of a FileCache instance.
:return: A dictionary containing a list of results
for all analyzed sections as key.
"""
all_actions_possible = provide_all_actions()
apply_single = None
if getattr(args, 'single_action', None) is not None:
while True:
for i, action in enumerate(all_actions_possible, 1):
console_printer.print(format_lines('{}'.format(
action), symbol='['))
line = format_lines(STR_ENTER_LETTER, symbol='[')
choice = input(line)
if choice.isalpha():
choice = choice.upper()
choice = '(' + choice + ')'
if choice == '(N)':
apply_single = 'Do (N)othing'
break
for i, action in enumerate(all_actions_possible, 1):
if choice in action:
apply_single = action
break
if apply_single:
break
console_printer.print(format_lines(
'Please enter a valid letter.',
symbol='['))
args.apply_patch = False
exitcode = 0
sections = {}
results = {}
file_dicts = {}
try:
yielded_results = yielded_unfixed_results = False
did_nothing = True
sections, local_bears, global_bears, targets = gather_configuration(
acquire_settings,
arg_parser=arg_parser,
arg_list=arg_list,
args=args)
logging.debug('Platform {} -- Python {}, coalib {}'
.format(platform.system(), platform.python_version(),
VERSION))
settings_hash = get_settings_hash(sections, targets)
flush_cache = bool(sections['cli'].get('flush_cache', False) or
settings_changed(None, settings_hash))
if cache is None and not sections['cli'].get('disable_caching', False):
cache = FileDictFileCache(None, os.getcwd(), flush_cache)
if targets:
sections = OrderedDict(
(section_name, sections[section_name])
for section_name in targets)
# Collect all the filters and try to filter sections
filters = collect_filters(args, arg_list, arg_parser)
if len(filters) > 0:
all_sections = list(sections.values())
try:
filtered = apply_filters(filters, sections=all_sections)
sections = OrderedDict(
(sect.name.lower(), sect) for sect in filtered)
except (InvalidFilterException, NotImplementedError) as ex:
console_printer.print(ex)
for section_name, section in sections.items():
if not section.is_enabled(targets):
continue
if not autoapply:
section['default_actions'] = ''
elif force_show_patch:
section['default_actions'] = '*: ShowPatchAction'
section['show_result_on_top'] = 'yeah'
print_section_beginning(section)
section_result = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=print_results,
cache=cache,
log_printer=None,
console_printer=console_printer,
debug=debug or args and args.debug,
apply_single=(apply_single
if apply_single is not None else
False))
yielded, yielded_unfixed, results[section_name] = (
simplify_section_result(section_result))
yielded_results = yielded_results or yielded
yielded_unfixed_results = (
yielded_unfixed_results or yielded_unfixed)
did_nothing = False
file_dicts[section_name] = section_result[3]
update_settings_db(None, settings_hash)
if cache:
cache.write()
if CounterHandler.get_num_calls_for_level('ERROR') > 0:
exitcode = 1
elif did_nothing:
nothing_done(None)
exitcode = 2
elif yielded_unfixed_results:
exitcode = 1
elif yielded_results:
exitcode = 5
except BaseException as exception: # pylint: disable=broad-except
if not isinstance(exception, SystemExit):
if args and args.debug or (
sections and sections.get('cli', {}).get('debug', False)
):
import ipdb
with ipdb.launch_ipdb_on_exception():
raise
if debug:
raise
exitcode = exitcode or get_exitcode(exception)
return results, exitcode, file_dicts
def run_coala(log_printer=None,
print_results=do_nothing,
acquire_settings=fail_acquire_settings,
print_section_beginning=do_nothing,
nothing_done=do_nothing,
show_bears=do_nothing,
autoapply=True):
"""
This is a main method that should be usable for almost all purposes and
reduces executing coala to one function call.
:param log_printer: A LogPrinter object to use for logging.
:param 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.
:param 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.
:param print_section_beginning: A callback that will be called with a
section name string whenever analysis of a
new section is started.
:param nothing_done: A callback that will be called with only a
log printer that shall indicate that
nothing was done.
:param show_bears: A callback that will be called with first
a list of local bears, second a list of
global bears to output them. A third bool
parameter may be used to indicate if a
compressed output (True) or a normal output
(False) is desired, the former being used
for showing all available bears to the
user.
:param autoapply: Set to False to autoapply nothing by
default; this is overridable via any
configuration file/CLI.
:return: A dictionary containing a list of results
for all analyzed sections as key.
"""
log_printer = log_printer or LogPrinter(ConsolePrinter())
exitcode = 0
results = None
try:
yielded_results = False
did_nothing = True
sections, local_bears, global_bears, targets = (gather_configuration(
acquire_settings, log_printer))
tag = str(sections['default'].get('tag', None))
dtag = str(sections['default'].get('dtag', None))
if not autoapply and 'autoapply' not in sections['default']:
sections['default']['autoapply'] = "False"
show_all_bears = bool(sections['default'].get('show_all_bears', False))
show_bears_ = bool(sections["default"].get("show_bears", "False"))
if show_all_bears:
show_bears_ = True
for section in sections:
bear_dirs = sections[section].bear_dirs()
local_bears[section] = collect_bears(bear_dirs, ["**"],
[BEAR_KIND.LOCAL],
log_printer)
global_bears[section] = collect_bears(bear_dirs, ["**"],
[BEAR_KIND.GLOBAL],
log_printer)
if dtag != "None":
delete_tagged_results(
dtag, os.path.abspath(str(sections["default"].get("config"))))
if show_bears_:
show_bears(local_bears, global_bears, show_all_bears)
did_nothing = False
else:
results = {}
for section_name in sections:
section = sections[section_name]
if not section.is_enabled(targets):
continue
print_section_beginning(section)
section_result = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=print_results,
log_printer=log_printer)
yielded_results = yielded_results or section_result[0]
results_for_section = []
for value in chain(section_result[1].values(),
section_result[2].values()):
if value is None:
continue
for result in value:
results_for_section.append(result)
results[section_name] = results_for_section
did_nothing = False
if tag != "None":
tag_results(
tag,
os.path.abspath(str(sections["default"].get("config"))),
results)
if did_nothing:
nothing_done(log_printer)
if yielded_results:
exitcode = 1
except BaseException as exception: # pylint: disable=broad-except
exitcode = exitcode or get_exitcode(exception, log_printer)
return results, exitcode
def run_coala(log_printer=None,
print_results=do_nothing,
acquire_settings=fail_acquire_settings,
print_section_beginning=do_nothing,
nothing_done=do_nothing,
show_bears=do_nothing,
autoapply=True):
"""
This is a main method that should be usable for almost all purposes and
reduces executing coala to one function call.
:param log_printer: A LogPrinter object to use for logging.
:param 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.
:param 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.
:param print_section_beginning: A callback that will be called with a
section name string whenever analysis of a
new section is started.
:param nothing_done: A callback that will be called with only a
log printer that shall indicate that
nothing was done.
:param show_bears: A callback that will be called with first
a list of local bears, second a list of
global bears to output them. A third bool
parameter may be used to indicate if a
compressed output (True) or a normal output
(False) is desired, the former being used
for showing all available bears to the
user.
:param autoapply: Set to False to autoapply nothing by
default; this is overridable via any
configuration file/CLI.
:return: A dictionary containing a list of results
for all analyzed sections as key.
"""
log_printer = log_printer or LogPrinter(ConsolePrinter())
exitcode = 0
results = None
try:
yielded_results = False
did_nothing = True
sections, local_bears, global_bears, targets = (
gather_configuration(acquire_settings, log_printer))
tag = str(sections['default'].get('tag', None))
dtag = str(sections['default'].get('dtag', None))
if not autoapply and 'autoapply' not in sections['default']:
sections['default']['autoapply'] = "False"
show_all_bears = bool(sections['default'].get('show_all_bears', False))
show_bears_ = bool(sections["default"].get("show_bears", "False"))
if show_all_bears:
show_bears_ = True
for section in sections:
bear_dirs = sections[section].bear_dirs()
local_bears[section] = collect_bears(bear_dirs,
["**"],
[BEAR_KIND.LOCAL],
log_printer)
global_bears[section] = collect_bears(bear_dirs,
["**"],
[BEAR_KIND.GLOBAL],
log_printer)
if dtag != "None":
delete_tagged_results(
dtag,
os.path.abspath(str(sections["default"].get("config"))))
if show_bears_:
show_bears(local_bears,
global_bears,
show_all_bears)
did_nothing = False
else:
results = {}
for section_name in sections:
section = sections[section_name]
if not section.is_enabled(targets):
continue
print_section_beginning(section)
section_result = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=print_results,
log_printer=log_printer)
yielded_results = yielded_results or section_result[0]
results_for_section = []
for value in chain(section_result[1].values(),
section_result[2].values()):
if value is None:
continue
for result in value:
results_for_section.append(result)
results[section_name] = results_for_section
did_nothing = False
if tag != "None":
tag_results(
tag,
os.path.abspath(str(sections["default"].get("config"))),
results)
if did_nothing:
nothing_done(log_printer)
if yielded_results:
exitcode = 1
except BaseException as exception: # pylint: disable=broad-except
exitcode = exitcode or get_exitcode(exception, log_printer)
return results, exitcode
def run_coala(console_printer=None,
log_printer=None,
print_results=do_nothing,
acquire_settings=fail_acquire_settings,
print_section_beginning=do_nothing,
nothing_done=do_nothing,
autoapply=True,
force_show_patch=False,
arg_parser=None,
arg_list=None):
"""
This is a main method that should be usable for almost all purposes and
reduces executing coala to one function call.
:param console_printer: Object to print messages on the console.
:param log_printer: A LogPrinter object to use for logging.
:param 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.
:param 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.
:param print_section_beginning: A callback that will be called with a
section name string whenever analysis of a
new section is started.
:param nothing_done: A callback that will be called with only a
log printer that shall indicate that
nothing was done.
:param autoapply: Set this to false to not autoapply any
actions. If you set this to `False`,
`force_show_patch` will be ignored.
:param force_show_patch: If set to True, a patch will be always
shown. (Using ApplyPatchAction.)
:param arg_parser: Instance of ArgParser that is used to parse
non-setting arguments.
:param arg_list: The CLI argument list.
:return: A dictionary containing a list of results
for all analyzed sections as key.
"""
log_printer = (
LogPrinter(ConsolePrinter(), LOG_LEVEL.DEBUG) if log_printer is None
else log_printer)
exitcode = 0
results = {}
file_dicts = {}
try:
yielded_results = yielded_unfixed_results = False
did_nothing = True
sections, local_bears, global_bears, targets = gather_configuration(
acquire_settings,
log_printer,
arg_parser=arg_parser,
arg_list=arg_list)
log_printer.debug('Platform {} -- Python {}, coalib {}'
.format(platform.system(), platform.python_version(),
VERSION))
settings_hash = get_settings_hash(sections, targets)
flush_cache = bool(sections['cli'].get('flush_cache', False) or
settings_changed(log_printer, settings_hash))
cache = None
if not sections['cli'].get('disable_caching', False):
cache = FileCache(log_printer, os.getcwd(), flush_cache)
for section_name, section in sections.items():
if not section.is_enabled(targets):
continue
if not autoapply:
section['default_actions'] = ''
elif force_show_patch:
section['default_actions'] = '*: ShowPatchAction'
section['show_result_on_top'] = 'yeah'
print_section_beginning(section)
section_result = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=print_results,
cache=cache,
log_printer=log_printer,
console_printer=console_printer)
yielded, yielded_unfixed, results[section_name] = (
simplify_section_result(section_result))
yielded_results = yielded_results or yielded
yielded_unfixed_results = (
yielded_unfixed_results or yielded_unfixed)
did_nothing = False
file_dicts[section_name] = section_result[3]
update_settings_db(log_printer, settings_hash)
if cache:
cache.write()
if did_nothing:
nothing_done(log_printer)
exitcode = 2
elif yielded_unfixed_results:
exitcode = 1
elif yielded_results:
exitcode = 5
except BaseException as exception: # pylint: disable=broad-except
exitcode = exitcode or get_exitcode(exception, log_printer)
return results, exitcode, file_dicts
def main(debug=False):
configure_logging()
args = None # to have args variable in except block when parse_args fails
try:
# Note: We parse the args here once to check whether to show bears or
# not.
args = default_arg_parser().parse_args()
if args.debug:
req_ipdb = PipRequirement('ipdb')
if not req_ipdb.is_installed():
logging.error(
'--debug flag requires ipdb. '
'You can install it with:\n%s',
' '.join(req_ipdb.install_command()))
sys.exit(13)
if debug or args.debug:
args.log_level = 'DEBUG'
# Defer imports so if e.g. --help is called they won't be run
from coalib.coala_modes import (mode_format, mode_json,
mode_non_interactive, mode_normal)
from coalib.output.ConsoleInteraction import (
show_bears, show_language_bears_capabilities)
console_printer = ConsolePrinter(print_colored=not args.no_color)
configure_logging(not args.no_color)
if args.show_bears:
from coalib.settings.ConfigurationGathering import get_all_bears
kwargs = {}
if args.bears:
kwargs['bear_globs'] = args.bears
filtered_bears = get_all_bears(**kwargs)
if args.filter_by_language:
logging.warning("'--filter-by-language ...' is deprecated. "
"Use '--filter-by language ...' instead.")
if args.filter_by is None:
args.filter_by = []
args.filter_by.append(['language'] + args.filter_by_language)
if args.filter_by:
# Each iteration of the following loop applies
# filters one by one provided as arguments
try:
filtered_bears = apply_filters(args.filter_by,
filtered_bears)
except (InvalidFilterException, NotImplementedError) as ex:
# If filter is not available or is unusable
console_printer.print(ex)
return 2
local_bears, global_bears = filtered_bears
show_bears(local_bears, global_bears, args.show_description
or args.show_details, args.show_details,
console_printer, args)
return 0
elif args.show_capabilities:
from coalib.collecting.Collectors import (
filter_capabilities_by_languages)
local_bears, _ = apply_filter('language', args.show_capabilities)
capabilities = filter_capabilities_by_languages(
local_bears, args.show_capabilities)
show_language_bears_capabilities(capabilities, console_printer)
return 0
if args.json:
return mode_json(args, debug=debug)
except BaseException as exception: # pylint: disable=broad-except
if not isinstance(exception, SystemExit):
if args and args.debug:
import ipdb
with ipdb.launch_ipdb_on_exception():
raise
if debug:
raise
return get_exitcode(exception)
if args.format:
return mode_format(args, debug=debug)
if args.non_interactive:
return mode_non_interactive(console_printer, args, debug=debug)
return mode_normal(console_printer, None, args, debug=debug)
def run_coala(console_printer=None,
log_printer=None,
print_results=do_nothing,
acquire_settings=fail_acquire_settings,
print_section_beginning=do_nothing,
nothing_done=do_nothing,
autoapply=True,
force_show_patch=False,
arg_parser=None,
arg_list=None,
args=None,
debug=False):
"""
This is a main method that should be usable for almost all purposes and
reduces executing coala to one function call.
:param console_printer: Object to print messages on the console.
:param log_printer: A LogPrinter object to use for logging.
:param 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.
:param 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.
:param print_section_beginning: A callback that will be called with a
section name string whenever analysis of a
new section is started.
:param nothing_done: A callback that will be called with only a
log printer that shall indicate that
nothing was done.
:param autoapply: Set this to false to not autoapply any
actions. If you set this to `False`,
`force_show_patch` will be ignored.
:param force_show_patch: If set to True, a patch will be always
shown. (Using ApplyPatchAction.)
:param arg_parser: Instance of ArgParser that is used to parse
non-setting arguments.
:param arg_list: The CLI argument list.
:param args: Alternative pre-parsed CLI arguments.
:param debug: Run in debug mode, bypassing
multiprocessing, and not catching any
exceptions.
:return: A dictionary containing a list of results
for all analyzed sections as key.
"""
all_actions_possible = provide_all_actions()
apply_single = None
if getattr(args, 'single_action', None) is not None:
while True:
for i, action in enumerate(all_actions_possible, 1):
console_printer.print(
format_lines('{}'.format(action), symbol='['))
line = format_lines(STR_ENTER_NUMBER, symbol='[')
choice = input(line)
if choice.isalpha():
choice = choice.upper()
choice = '(' + choice + ')'
if choice == '(N)':
apply_single = 'Do (N)othing'
break
for i, action in enumerate(all_actions_possible, 1):
if choice in action:
apply_single = action
break
if apply_single:
break
console_printer.print(
format_lines('Please enter a valid letter.', symbol='['))
args.apply_patch = False
log_printer = (LogPrinter(ConsolePrinter(), LOG_LEVEL.DEBUG)
if log_printer is None else log_printer)
exitcode = 0
sections = {}
results = {}
file_dicts = {}
try:
yielded_results = yielded_unfixed_results = False
did_nothing = True
sections, local_bears, global_bears, targets = gather_configuration(
acquire_settings,
log_printer,
arg_parser=arg_parser,
arg_list=arg_list,
args=args)
log_printer.debug('Platform {} -- Python {}, coalib {}'.format(
platform.system(), platform.python_version(), VERSION))
settings_hash = get_settings_hash(sections, targets)
flush_cache = bool(sections['cli'].get('flush_cache', False)
or settings_changed(log_printer, settings_hash))
cache = None
if not sections['cli'].get('disable_caching', False):
cache = FileCache(log_printer, os.getcwd(), flush_cache)
for section_name, section in sections.items():
if not section.is_enabled(targets):
continue
if not autoapply:
section['default_actions'] = ''
elif force_show_patch:
section['default_actions'] = '*: ShowPatchAction'
section['show_result_on_top'] = 'yeah'
print_section_beginning(section)
section_result = execute_section(
section=section,
global_bear_list=global_bears[section_name],
local_bear_list=local_bears[section_name],
print_results=print_results,
cache=cache,
log_printer=log_printer,
console_printer=console_printer,
debug=debug or args and args.debug,
apply_single=(apply_single
if apply_single is not None else False))
yielded, yielded_unfixed, results[section_name] = (
simplify_section_result(section_result))
yielded_results = yielded_results or yielded
yielded_unfixed_results = (yielded_unfixed_results
or yielded_unfixed)
did_nothing = False
file_dicts[section_name] = section_result[3]
update_settings_db(log_printer, settings_hash)
if cache:
cache.write()
if CounterHandler.get_num_calls_for_level('ERROR') > 0:
exitcode = 1
elif did_nothing:
nothing_done(log_printer)
exitcode = 2
elif yielded_unfixed_results:
exitcode = 1
elif yielded_results:
exitcode = 5
except BaseException as exception: # pylint: disable=broad-except
if not isinstance(exception, SystemExit):
if args and args.debug or (sections and sections.get(
'cli', {}).get('debug', False)):
import ipdb
with ipdb.launch_ipdb_on_exception():
raise
if debug:
raise
exitcode = exitcode or get_exitcode(exception, log_printer)
return results, exitcode, file_dicts
