2022-05-05 21:02:24 +00:00
|
|
|
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
|
|
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
|
|
|
|
# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt
|
|
|
|
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
|
|
import pickle
|
|
|
|
import sys
|
|
|
|
import warnings
|
|
|
|
from pathlib import Path
|
|
|
|
|
|
|
|
from pylint.constants import PYLINT_HOME
|
|
|
|
from pylint.utils import LinterStats
|
|
|
|
|
2022-11-01 07:12:44 +00:00
|
|
|
PYLINT_HOME_AS_PATH = Path(PYLINT_HOME)
|
|
|
|
|
2022-05-05 21:02:24 +00:00
|
|
|
|
|
|
|
def _get_pdata_path(
|
2022-11-01 07:12:44 +00:00
|
|
|
base_name: Path, recurs: int, pylint_home: Path = PYLINT_HOME_AS_PATH
|
2022-05-05 21:02:24 +00:00
|
|
|
) -> Path:
|
2022-11-01 07:12:44 +00:00
|
|
|
# We strip all characters that can't be used in a filename. Also strip '/' and
|
|
|
|
# '\\' because we want to create a single file, not sub-directories.
|
2022-05-06 19:56:09 +00:00
|
|
|
underscored_name = "_".join(
|
|
|
|
str(p.replace(":", "_").replace("/", "_").replace("\\", "_"))
|
|
|
|
for p in base_name.parts
|
|
|
|
)
|
2022-05-05 21:02:24 +00:00
|
|
|
return pylint_home / f"{underscored_name}_{recurs}.stats"
|
|
|
|
|
|
|
|
|
|
|
|
def load_results(
|
|
|
|
base: str | Path, pylint_home: str | Path = PYLINT_HOME
|
|
|
|
) -> LinterStats | None:
|
|
|
|
base = Path(base)
|
|
|
|
pylint_home = Path(pylint_home)
|
|
|
|
data_file = _get_pdata_path(base, 1, pylint_home)
|
|
|
|
|
|
|
|
if not data_file.exists():
|
|
|
|
return None
|
|
|
|
|
|
|
|
try:
|
|
|
|
with open(data_file, "rb") as stream:
|
|
|
|
data = pickle.load(stream)
|
|
|
|
if not isinstance(data, LinterStats):
|
|
|
|
warnings.warn(
|
|
|
|
"You're using an old pylint cache with invalid data following "
|
|
|
|
f"an upgrade, please delete '{data_file}'.",
|
|
|
|
UserWarning,
|
|
|
|
)
|
|
|
|
raise TypeError
|
|
|
|
return data
|
|
|
|
except Exception: # pylint: disable=broad-except
|
|
|
|
# There's an issue with the cache but we just continue as if it isn't there
|
|
|
|
return None
|
|
|
|
|
|
|
|
|
|
|
|
def save_results(
|
|
|
|
results: LinterStats, base: str | Path, pylint_home: str | Path = PYLINT_HOME
|
|
|
|
) -> None:
|
|
|
|
base = Path(base)
|
|
|
|
pylint_home = Path(pylint_home)
|
|
|
|
try:
|
|
|
|
pylint_home.mkdir(parents=True, exist_ok=True)
|
|
|
|
except OSError: # pragma: no cover
|
|
|
|
print(f"Unable to create directory {pylint_home}", file=sys.stderr)
|
|
|
|
data_file = _get_pdata_path(base, 1)
|
|
|
|
try:
|
|
|
|
with open(data_file, "wb") as stream:
|
|
|
|
pickle.dump(results, stream)
|
|
|
|
except OSError as ex: # pragma: no cover
|
|
|
|
print(f"Unable to create file {data_file}: {ex}", file=sys.stderr)
|