Current File : //opt/cloudlinux/venv/lib/python3.11/site-packages/prospector/config/configuration.py
# flake8: noqa
import pkg_resources
import setoptconf as soc
from prospector.config.datatype import OutputChoice
from prospector.formatters import FORMATTERS
from prospector.tools import DEFAULT_TOOLS, TOOLS
__all__ = ("build_manager",)
_VERSION = pkg_resources.get_distribution("prospector").version
def build_manager():
manager = soc.ConfigurationManager("prospector")
manager.add(soc.BooleanSetting("zero_exit", default=False))
manager.add(soc.BooleanSetting("autodetect", default=True))
manager.add(soc.ListSetting("uses", soc.String, default=[]))
manager.add(soc.BooleanSetting("blending", default=True))
manager.add(soc.BooleanSetting("doc_warnings", default=None))
manager.add(soc.BooleanSetting("test_warnings", default=None))
manager.add(soc.BooleanSetting("no_style_warnings", default=None))
manager.add(soc.BooleanSetting("member_warnings", default=None))
manager.add(soc.BooleanSetting("full_pep8", default=None))
manager.add(soc.IntegerSetting("max_line_length", default=None))
manager.add(soc.BooleanSetting("messages_only", default=False))
manager.add(soc.BooleanSetting("summary_only", default=False))
manager.add(soc.BooleanSetting("quiet", default=False))
manager.add(
soc.ListSetting(
"output_format",
OutputChoice(sorted(FORMATTERS.keys())),
default=None,
)
)
manager.add(soc.BooleanSetting("absolute_paths", default=False))
manager.add(
soc.ListSetting(
"tools",
soc.Choice(sorted(TOOLS.keys())),
default=None,
)
)
manager.add(soc.ListSetting("with_tools", soc.String, default=[]))
manager.add(soc.ListSetting("without_tools", soc.String, default=[]))
manager.add(soc.ListSetting("profiles", soc.String, default=[]))
manager.add(soc.ListSetting("profile_path", soc.String, default=[]))
manager.add(
soc.ChoiceSetting(
"strictness",
["veryhigh", "high", "medium", "low", "verylow"],
default=None,
)
)
manager.add(soc.BooleanSetting("show_profile", default=False))
manager.add(soc.BooleanSetting("no_external_config", default=False))
manager.add(soc.BooleanSetting("legacy_tool_names", default=False))
manager.add(soc.StringSetting("pylint_config_file", default=None))
manager.add(soc.StringSetting("path", default=None))
manager.add(soc.ListSetting("ignore_patterns", soc.String, default=[]))
manager.add(soc.ListSetting("ignore_paths", soc.String, default=[]))
manager.add(soc.BooleanSetting("die_on_tool_error", default=False))
manager.add(soc.BooleanSetting("include_tool_stdout", default=False))
manager.add(soc.BooleanSetting("direct_tool_stdout", default=False))
return manager
def build_default_sources():
sources = [
build_command_line_source(),
soc.EnvironmentVariableSource(),
soc.ConfigFileSource(
(
".prospectorrc",
"setup.cfg",
"tox.ini",
)
),
soc.ConfigFileSource(
(
soc.ConfigDirectory(".prospectorrc"),
soc.HomeDirectory(".prospectorrc"),
)
),
]
return sources
def build_command_line_source(prog=None, description="Performs static analysis of Python code"):
parser_options = {}
if prog is not None:
parser_options["prog"] = prog
if description is not None:
parser_options["description"] = description
options = {
"zero_exit": {
"flags": ["-0", "--zero-exit"],
"help": "Prospector will exit with a code of 1 (one) if any messages"
" are found. This makes automation easier; if there are any"
" problems at all, the exit code is non-zero. However this behaviour"
" is not always desirable, so if this flag is set, prospector will"
" exit with a code of 0 if it ran successfully, and non-zero if"
" it failed to run.",
},
"autodetect": {
"flags": ["-A", "--no-autodetect"],
"help": "Turn off auto-detection of frameworks and libraries used."
" By default, autodetection will be used. To specify"
" manually, see the --uses option.",
},
"uses": {
"flags": ["-u", "--uses"],
"help": "A list of one or more libraries or frameworks that the"
" project uses. Possible values are: django, celery, flask. This will be"
" autodetected by default, but if autodetection doesn't"
" work, manually specify them using this flag.",
},
"blending": {
"flags": ["-B", "--no-blending"],
"help": "Turn off blending of messages. Prospector will merge"
" together messages from different tools if they represent"
" the same error. Use this option to see all unmerged"
" messages.",
},
"doc_warnings": {
"flags": ["-D", "--doc-warnings"],
"help": "Include warnings about documentation.",
},
"test_warnings": {
"flags": ["-T", "--test-warnings"],
"help": "Also check test modules and packages.",
},
"legacy_tool_names": {
"flags": ["--legacy-tool-names"],
"help": "Output deprecated names for tools (pep8, pep257) "
"instead of updated names (pycodestyle, pydocstyle)",
},
"no_style_warnings": {
"flags": ["-8", "--no-style-warnings"],
"help": "Don't create any warnings about style. This disables the"
" PEP8 tool and similar checks for formatting.",
},
"member_warnings": {
"flags": ["-m", "--member-warnings"],
"help": "Attempt to warn when code tries to access an attribute of a "
"class or member of a module which does not exist. This is disabled "
"by default as it tends to be quite inaccurate.",
},
"quiet": {
"flags": ["-q", "--quiet"],
"help": "Run but do not output anything to stdout. Useful to suppress "
"output in scripts without sending to a file (via -o)",
},
"full_pep8": {
"flags": ["-F", "--full-pep8"],
"help": "Enables every PEP8 warning, so that all PEP8 style violation will be reported.",
},
"max_line_length": {
"flags": ["--max-line-length"],
"help": "The maximum line length allowed. This will be set by the strictness if no"
" value is explicitly specified",
},
"messages_only": {
"flags": ["-M", "--messages-only"],
"help": "Only output message information (don't output summary" " information about the checks)",
},
"summary_only": {
"flags": ["-S", "--summary-only"],
"help": "Only output summary information about the checks (don't" "output message information)",
},
"output_format": {
"flags": ["-o", "--output-format"],
"help": "The output format. Valid values are: %s. This will output to stdout by default, "
"however a target file can be used instead by adding :path-to-output-file, eg, -o json:output.json"
% (", ".join(sorted(FORMATTERS.keys())),),
},
"absolute_paths": {
"help": "Whether to output absolute paths when referencing files "
"in messages. By default, paths will be relative to the "
"project path",
},
"tools": {
"flags": ["-t", "--tool"],
"help": "A list of tools to run. This lets you set exactly which "
"tools to run. To add extra tools to the defaults, see "
"--with-tool. Possible values are: %s. By "
"default, the following tools will be run: %s"
% (
", ".join(sorted(TOOLS.keys())),
", ".join(sorted(DEFAULT_TOOLS)),
),
},
"with_tools": {
"flags": ["-w", "--with-tool"],
"help": "A list of tools to run in addition to the default tools. "
"To specify all tools explicitly, use the --tool argument. "
"Possible values are %s." % (", ".join(sorted(TOOLS.keys()))),
},
"without_tools": {
"flags": ["-W", "--without-tool"],
"help": "A list of tools that should not be run. Useful to turn off "
"only a single tool from the defaults. "
"To specify all tools explicitly, use the --tool argument. "
"Possible values are %s." % (", ".join(sorted(TOOLS.keys()))),
},
"profiles": {
"flags": ["-P", "--profile"],
"help": "The list of profiles to load. A profile is a certain"
" 'type' of behaviour for prospector, and is represented"
" by a YAML configuration file. Either a full path to the YAML"
" file describing the profile must be provided, or it must be"
" on the profile path (see --profile-path)",
},
"profile_path": {
"flags": ["--profile-path"],
"help": "Additional paths to search for profile files. By default this"
" is the path that prospector will check, and a directory "
' called ".prospector" in the path that prospector will check.',
},
"show_profile": {
"flags": ["--show-profile"],
"help": "Include the computed profile in the summary. This will show what"
" prospector has decided the overall profile is once all profiles"
" have been combined and inherited from. This will produce a large"
" output in most cases so is only useful when trying to debug why"
" prospector is not behaving like you expect.",
},
"strictness": {
"flags": ["-s", "--strictness"],
"help": "How strict the checker should be. This affects how"
" harshly the checker will enforce coding guidelines. The"
' default value is "medium", possible values are'
' "veryhigh", "high", "medium", "low" and "verylow".',
},
"no_external_config": {
"flags": ["-E", "--no-external-config"],
"help": "Determines how prospector should behave when"
" configuration already exists for a tool. By default,"
" prospector will use existing configuration. This flag"
" will cause prospector to ignore existing configuration"
" and use its own settings for every tool. Note that"
" prospector will always use its own config for tools which"
" do not have custom configuration.",
},
"pylint_config_file": {
"flags": ["--pylint-config-file"],
"help": "The path to a pylintrc file to use to configure pylint. Prospector will find"
" .pylintrc files in the root of the project, but you can use this option to "
"specify manually where it is.",
},
"ignore_patterns": {
"flags": ["-I", "--ignore-patterns"],
"help": "A list of paths to ignore, as a list of regular"
" expressions. Files and folders will be ignored if their"
" full path contains any of these patterns.",
},
"ignore_paths": {
"flags": ["-i", "--ignore-paths"],
"help": "A list of file or directory names to ignore. If the"
" complete name matches any of the items in this list, the"
" file or directory (and all subdirectories) will be"
" ignored.",
},
"die_on_tool_error": {
"flags": ["-X", "--die-on-tool-error"],
"help": "If a tool fails to run, prospector will try to carry on."
" Use this flag to cause prospector to die and raise the"
" exception the tool generated. Mostly useful for"
" development on prospector.",
},
"include-tool-stdout": {
"flags": ["--include-tool-stdout"],
"help": "There are various places where tools will output warnings to "
"stdout/stderr, which breaks parsing of JSON output. Therefore while tols "
"is running, this is suppressed. For developing, it is sometimes useful to "
"see this. This flag will cause stdout/stderr from a tool to be shown as "
"a normal message amongst other warnings. See also --direct-tool-stdout",
},
"direct-tool-stdout": {
"flags": ["--direct-tool-stdout"],
"help": "Same as --include-tool-stdout, except the output will be printed "
"directly rather than shown as a message.",
},
"path": {
"flags": ["-p", "--path"],
"help": "The path to a Python project to inspect. Defaults to PWD"
" if not specified. Note: This command line argument is"
" deprecated and will be removed in a future update. Please"
" use the positional PATH argument instead.",
},
}
positional = (
(
"checkpath",
{
"help": "The path to a Python project to inspect. Defaults to PWD"
" if not specified. If multiple paths are specified,"
" they must all be files (no directories).",
"metavar": "PATH",
"nargs": "*",
},
),
)
return soc.CommandLineSource(
options=options,
version=_VERSION,
parser_options=parser_options,
positional=positional,
)