Server IP : 66.29.132.122 / Your IP : 13.59.163.1 Web Server : LiteSpeed System : Linux business142.web-hosting.com 4.18.0-553.lve.el8.x86_64 #1 SMP Mon May 27 15:27:34 UTC 2024 x86_64 User : admazpex ( 531) PHP Version : 7.2.34 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /proc/self/root/opt/cloudlinux/venv/lib64/python3.11/site-packages/prospector/ |
Upload File : |
import codecs import os.path import sys import warnings from datetime import datetime from pathlib import Path from typing import TextIO from prospector import blender, postfilter, tools from prospector.compat import is_relative_to from prospector.config import ProspectorConfig from prospector.config import configuration as cfg from prospector.exceptions import FatalProspectorException from prospector.finder import FileFinder from prospector.formatters import FORMATTERS, Formatter from prospector.message import Location, Message from prospector.tools import DEPRECATED_TOOL_NAMES from prospector.tools.utils import CaptureOutput class Prospector: def __init__(self, config: ProspectorConfig): self.config = config self.summary = None self.messages = config.messages def process_messages(self, found_files, messages): if self.config.blending: messages = blender.blend(messages) if self.config.legacy_tool_names: updated = [] new_names = {v: k for k, v in DEPRECATED_TOOL_NAMES.items()} for msg in messages: msg.source = new_names.get(msg.source, msg.source) updated.append(msg) messages = updated return postfilter.filter_messages(found_files.python_modules, messages) def execute(self): deprecated_names = self.config.replace_deprecated_tool_names() summary = { "started": datetime.now(), } summary.update(self.config.get_summary_information()) paths = [Path(p) for p in self.config.paths] found_files = FileFinder(*paths, exclusion_filters=[self.config.make_exclusion_filter()]) messages = [] # see if any old tool names are run for deprecated_name in deprecated_names: loc = Location(self.config.workdir, None, None, None, None) new_name = DEPRECATED_TOOL_NAMES[deprecated_name] msg = ( f"Tool {deprecated_name} has been renamed to {new_name}. " f"The old name {deprecated_name} is now deprecated and will be removed in Prospector 2.0. " f"Please update your prospector configuration." ) message = Message( "prospector", "Deprecation", loc, message=msg, ) messages.append(message) warnings.warn(msg, category=DeprecationWarning) # Run the tools for tool in self.config.get_tools(found_files): for name, cls in tools.TOOLS.items(): if cls == tool.__class__: toolname = name break else: toolname = "Unknown" try: # Tools can output to stdout/stderr in unexpected places, for example, # pydocstyle emits warnings about __all__ and as pyroma exec's the setup.py # file, it will execute any print statements in that, etc etc... with CaptureOutput(hide=not self.config.direct_tool_stdout) as capture: messages += tool.run(found_files) if self.config.include_tool_stdout: loc = Location(self.config.workdir, None, None, None, None) if capture.get_hidden_stderr(): msg = f"stderr from {toolname}:\n{capture.get_hidden_stderr()}" messages.append(Message(toolname, "hidden-output", loc, message=msg)) if capture.get_hidden_stdout(): msg = f"stdout from {toolname}:\n{capture.get_hidden_stdout()}" messages.append(Message(toolname, "hidden-output", loc, message=msg)) except FatalProspectorException as fatal: sys.stderr.write(str(fatal)) sys.exit(2) except Exception as ex: # pylint:disable=broad-except if self.config.die_on_tool_error: raise FatalProspectorException(f"Tool {toolname} failed to run.") from ex loc = Location(self.config.workdir, None, None, None, None) msg = ( f"Tool {toolname} failed to run " f"(exception was raised, re-run prospector with -X to see the stacktrace)" ) message = Message( toolname, "failure", loc, message=msg, ) messages.append(message) messages = self.process_messages(found_files, messages) summary["message_count"] = len(messages) summary["completed"] = datetime.now() delta = summary["completed"] - summary["started"] summary["time_taken"] = "%0.2f" % delta.total_seconds() external_config = [] for tool, configured_by in self.config.configured_by.items(): if configured_by is not None: external_config.append((tool, configured_by)) if len(external_config) > 0: summary["external_config"] = ", ".join(["%s: %s" % info for info in external_config]) self.summary = summary self.messages = self.messages + messages def get_summary(self): return self.summary def get_messages(self): return self.messages def print_messages(self): output_reports = self.config.get_output_report() for report in output_reports: output_format, output_files = report self.summary["formatter"] = output_format relative_to = None # use relative paths by default unless explicitly told otherwise (with a --absolute-paths flag) # or if some paths passed to prospector are not relative to the CWD if not self.config.absolute_paths and all( is_relative_to(p, self.config.workdir) for p in self.config.paths ): relative_to = self.config.workdir formatter = FORMATTERS[output_format](self.summary, self.messages, self.config.profile, relative_to) if not output_files and not self.config.quiet: self.write_to(formatter, sys.stdout) for output_file in output_files: with codecs.open(output_file, "w+") as target: self.write_to(formatter, target) def write_to(self, formatter: Formatter, target: TextIO): # Produce the output target.write( formatter.render( summary=not self.config.messages_only, messages=not self.config.summary_only, profile=self.config.show_profile, ) ) target.write("\n") def get_parser(): """ This is a helper method to return an argparse parser, to be used with the Sphinx argparse plugin for documentation. """ manager = cfg.build_manager() source = cfg.build_command_line_source(prog="prospector", description=None) return source.build_parser(manager.settings, None) def main(): # Get our configuration config = ProspectorConfig() paths = config.paths if len(paths) > 1 and not all(os.path.isfile(path) for path in paths): sys.stderr.write("\nIn multi-path mode, all inputs must be files, " "not directories.\n\n") get_parser().print_usage() sys.exit(2) # Make it so prospector = Prospector(config) prospector.execute() prospector.print_messages() if config.exit_with_zero_on_success(): # if we ran successfully, and the user wants us to, then we'll # exit cleanly sys.exit(0) # otherwise, finding messages is grounds for exiting with an error # code, to make it easier for bash scripts and similar situations # to know if any errors have been found. if len(prospector.get_messages()) > 0: sys.exit(1) sys.exit(0) if __name__ == "__main__": main()