diff options
author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2021-10-24 18:54:38 +0200 |
---|---|---|
committer | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2021-10-26 06:48:45 +0200 |
commit | d3fd7f0f5292be31b92b431b6c9c9d6c05e8dd64 (patch) | |
tree | a66eb1bfd10c26ef77ceed96ef832ee13ac332bc | |
parent | b6d154e8bbc32c3d71a1bfceed467c8614e0e4f1 (diff) | |
download | pylint-git-d3fd7f0f5292be31b92b431b6c9c9d6c05e8dd64.tar.gz |
Create a DEFAULT_PYLINT_HOME constant and upgrade help text
-rw-r--r-- | pylint/config/__init__.py | 5 | ||||
-rw-r--r-- | pylint/constants.py | 3 | ||||
-rw-r--r-- | pylint/lint/run.py | 7 |
3 files changed, 8 insertions, 7 deletions
diff --git a/pylint/config/__init__.py b/pylint/config/__init__.py index 44e4131e7..f9c393ef7 100644 --- a/pylint/config/__init__.py +++ b/pylint/config/__init__.py @@ -40,8 +40,6 @@ import pickle import sys from datetime import datetime -import platformdirs - from pylint.config.configuration_mixin import ConfigurationMixIn from pylint.config.find_default_config_files import find_default_config_files from pylint.config.man_help_formatter import _ManHelpFormatter @@ -49,6 +47,7 @@ from pylint.config.option import Option from pylint.config.option_manager_mixin import OptionsManagerMixIn from pylint.config.option_parser import OptionParser from pylint.config.options_provider_mixin import OptionsProviderMixIn, UnsupportedAction +from pylint.constants import DEFAULT_PYLINT_HOME from pylint.utils import LinterStats __all__ = [ @@ -70,7 +69,7 @@ if "PYLINTHOME" in os.environ: elif USER_HOME == "~": PYLINT_HOME = ".pylint.d" else: - PYLINT_HOME = platformdirs.user_cache_dir("pylint") + PYLINT_HOME = DEFAULT_PYLINT_HOME # The spam prevention is due to pylint being used in parallel by # pre-commit, and the message being spammy in this context # Also if you work with old version of pylint that recreate the diff --git a/pylint/constants.py b/pylint/constants.py index 05a1a0b25..df688eada 100644 --- a/pylint/constants.py +++ b/pylint/constants.py @@ -4,6 +4,7 @@ import platform import sys import astroid +import platformdirs from pylint.__pkginfo__ import __version__ @@ -39,6 +40,8 @@ MSG_TYPES_STATUS = {"I": 0, "C": 16, "R": 8, "W": 4, "E": 2, "F": 1} # on all project using [MASTER] in their rcfile. MAIN_CHECKER_NAME = "master" +DEFAULT_PYLINT_HOME = platformdirs.user_cache_dir("pylint") + class WarningScope: LINE = "line-based-msg" diff --git a/pylint/lint/run.py b/pylint/lint/run.py index 95be1a6f7..d63c936f1 100644 --- a/pylint/lint/run.py +++ b/pylint/lint/run.py @@ -6,7 +6,7 @@ import sys import warnings from pylint import __pkginfo__, extensions, interfaces -from pylint.constants import full_version +from pylint.constants import DEFAULT_PYLINT_HOME, full_version from pylint.lint.pylinter import PyLinter from pylint.lint.utils import ArgumentPreprocessingError, preprocess_options from pylint.utils import print_full_documentation, utils @@ -271,12 +271,11 @@ group are mutually exclusive.", # add some help section linter.add_help_section( "Environment variables", - """ + f""" The following environment variables are used: * PYLINTHOME Path to the directory where persistent data for the run will be stored. If -not found, it defaults to ~/.pylint.d/ or .pylint.d (in the current working -directory). +not found, it defaults to '{DEFAULT_PYLINT_HOME}'. * PYLINTRC Path to the configuration file. See the documentation for the method used to search for configuration file. |