1669195387

Build # 1669195387

Build Type

github

Committed by GitHub

Commit Message

Merge e88a7f178 into 82625d2fb

Pull Request Pull Request #434: feat(yaml): autofix .pre-commit-config.yaml (note: style changed!)

Run Details

538 of 610 branches covered (88.2%)

Branch coverage included in aggregate %.

191 of 206 new or added lines in 7 files covered. (92.72%)

36 existing lines in 3 files now uncovered.

1996 of 2094 relevant lines covered (95.32%)

4.74 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.09

/src/nitpick/plugins/base.py

"""Base class for file checkers."""
import abc
from functools import lru_cache
from pathlib import Path
from typing import Dict, Iterator, Optional, Set, Type

import jmespath
from autorepr import autotext
from loguru import logger
from marshmallow import Schema

from nitpick.constants import DUNDER_SEARCH_UNIQUE_KEY
from nitpick.documents import BaseDoc, Comparison
from nitpick.generic import search_dict
from nitpick.plugins.info import FileInfo
from nitpick.typedefs import JsonDict, mypy_property
from nitpick.violations import Fuss, Reporter, SharedViolations


class NitpickPlugin(metaclass=abc.ABCMeta):  # pylint: disable=too-many-instance-attributes
    """Base class for Nitpick plugins.

    :param data: File information (project, path, tags).
    :param expected_config: Expected configuration for the file
    :param autofix: Flag to modify files, if the plugin supports it (default: True).
    """

    __str__, __unicode__ = autotext("{self.info.path_from_root} ({self.__class__.__name__})")

    filename = ""  # TODO: remove filename attribute after fixing dynamic/fixed schema loading
    violation_base_code: int = 0

    #: Can this plugin modify its files directly? Are the files fixable?
    fixable: bool = False

    #: Nested validation field for this file, to be applied in runtime when the validation schema is rebuilt.
    #: Useful when you have a strict configuration for a file type (e.g. :py:class:`nitpick.plugins.json.JsonPlugin`).
    validation_schema: Optional[Schema] = None

    #: Which ``identify`` tags this :py:class:`nitpick.plugins.base.NitpickPlugin` child recognises.
    identify_tags: Set[str] = set()

    skip_empty_suggestion = False

    def __init__(self, info: FileInfo, expected_config: JsonDict, autofix=False) -> None:
        self.info = info
        self.filename = info.path_from_root
        self.reporter = Reporter(info, self.violation_base_code)

        self.file_path: Path = self.info.project.root / self.filename

        # Configuration for this file as a TOML dict, taken from the style file.
        self.expected_config: JsonDict = expected_config or {}

        self.autofix = self.fixable and autofix
        # Dirty flag to avoid changing files without need
        self.dirty: bool = False

        # The user can override the default unique keys (if any) by setting them on the style file.
        self.unique_keys: JsonDict = self.unique_keys_default.copy()
        self.unique_keys.update(self.expected_config.pop(DUNDER_SEARCH_UNIQUE_KEY, None) or {})

    @mypy_property
    @lru_cache()
    def nitpick_file_dict(self) -> JsonDict:
        """Nitpick configuration for this file as a TOML dict, taken from the style file."""
        return search_dict(f'files."{self.filename}"', self.info.project.nitpick_section, {})

    @property
    def unique_keys_default(self) -> JsonDict:
        """Default unique keys that might be set by a plugin."""
        return {}

    @classmethod
    def get_compiled_jmespath_filenames(cls):
        """Return a compiled JMESPath expression for file names, using the class name as part of the key."""
        return jmespath.compile(f"nitpick.{cls.__name__}.filenames")

    def entry_point(self) -> Iterator[Fuss]:
        """Entry point of the Nitpick plugin."""
        self.post_init()

        should_exist: bool = bool(self.info.project.nitpick_files_section.get(self.filename, True))
        if self.file_path.exists() and not should_exist:
            logger.info(f"{self}: File {self.filename} exists when it should not")
            # Only display this message if the style is valid.
            yield self.reporter.make_fuss(SharedViolations.DELETE_FILE)
            return

        has_config_dict = bool(self.expected_config or self.nitpick_file_dict)
        if not has_config_dict:
            return

        yield from self._enforce_file_configuration()

    def _enforce_file_configuration(self):
        file_exists = self.file_path.exists()
        if file_exists:
            logger.info(f"{self}: Enforcing rules")
            yield from self.enforce_rules()
        else:
            yield from self._suggest_when_file_not_found()

        if self.autofix and self.dirty:
            fuss = self.write_file(file_exists)  # pylint: disable=assignment-from-none
            if fuss:
                yield fuss

    def post_init(self):
        """Hook for plugin initialization after the instance was created.

        The name mimics ``__post_init__()`` on dataclasses, without the magic double underscores:
        `Post-init processing <https://docs.python.org/3/library/dataclasses.html#post-init-processing>`_
        """

    def _suggest_when_file_not_found(self):
        suggestion = self.initial_contents
        if not suggestion and self.skip_empty_suggestion:
            return
        logger.info(f"{self}: Suggest initial contents for {self.filename}")

        if suggestion:
            yield self.reporter.make_fuss(SharedViolations.CREATE_FILE_WITH_SUGGESTION, suggestion, fixed=self.autofix)
        else:
            yield self.reporter.make_fuss(SharedViolations.CREATE_FILE)

    def write_file(self, file_exists: bool) -> Optional[Fuss]:  # pylint: disable=unused-argument,no-self-use
        """Hook to write the new file when autofix mode is on. Should be used by inherited classes."""
        return None

    @abc.abstractmethod
    def enforce_rules(self) -> Iterator[Fuss]:
        """Enforce rules for this file. It must be overridden by inherited classes if needed."""

    @property
    @abc.abstractmethod
    def initial_contents(self) -> str:
        """Suggested initial content when the file doesn't exist."""

    def write_initial_contents(self, doc_class: Type[BaseDoc], expected_dict: Dict = None) -> str:
        """Helper to write initial contents based on a format."""
        if not expected_dict:
            expected_dict = self.expected_config

        formatted_str = doc_class(obj=expected_dict).reformatted
        if self.autofix:
            self.file_path.parent.mkdir(exist_ok=True, parents=True)
            self.file_path.write_text(formatted_str)
        return formatted_str

    def warn_missing_different(self, comparison: Comparison, prefix: str = "") -> Iterator[Fuss]:
        """Warn about missing and different keys."""
        # pylint: disable=not-callable
        if comparison.missing:
            yield self.reporter.make_fuss(
                SharedViolations.MISSING_VALUES, comparison.missing.reformatted, prefix=prefix
            )
        if comparison.diff:
            yield self.reporter.make_fuss(SharedViolations.DIFFERENT_VALUES, comparison.diff.reformatted, prefix=prefix)

1	"""Base class for file checkers."""
2	import abc	5✔
3	from functools import lru_cache	5✔
4	from pathlib import Path	5✔
5	from typing import Dict, Iterator, Optional, Set, Type	5✔
6
7	import jmespath	5✔
8	from autorepr import autotext	5✔
9	from loguru import logger	5✔
10	from marshmallow import Schema	5✔
11
12	from nitpick.constants import DUNDER_SEARCH_UNIQUE_KEY	5✔
13	from nitpick.documents import BaseDoc, Comparison	5✔
14	from nitpick.generic import search_dict	5✔
15	from nitpick.plugins.info import FileInfo	5✔
16	from nitpick.typedefs import JsonDict, mypy_property	5✔
17	from nitpick.violations import Fuss, Reporter, SharedViolations	5✔
18
19
20	class NitpickPlugin(metaclass=abc.ABCMeta): # pylint: disable=too-many-instance-attributes	5✔
21	"""Base class for Nitpick plugins.
22
23	:param data: File information (project, path, tags).
24	:param expected_config: Expected configuration for the file
25	:param autofix: Flag to modify files, if the plugin supports it (default: True).
26	"""
27
28	__str__, __unicode__ = autotext("{self.info.path_from_root} ({self.__class__.__name__})")	5✔
29
30	filename = "" # TODO: remove filename attribute after fixing dynamic/fixed schema loading	5✔
31	violation_base_code: int = 0	5✔
32
33	#: Can this plugin modify its files directly? Are the files fixable?
34	fixable: bool = False	5✔
35
36	#: Nested validation field for this file, to be applied in runtime when the validation schema is rebuilt.
37	#: Useful when you have a strict configuration for a file type (e.g. :py:class:`nitpick.plugins.json.JsonPlugin`).
38	validation_schema: Optional[Schema] = None	5✔
39
40	#: Which ``identify`` tags this :py:class:`nitpick.plugins.base.NitpickPlugin` child recognises.
41	identify_tags: Set[str] = set()	5✔
42
43	skip_empty_suggestion = False	5✔
44
45	def __init__(self, info: FileInfo, expected_config: JsonDict, autofix=False) -> None:	5✔
46	self.info = info	5✔
47	self.filename = info.path_from_root	5✔
48	self.reporter = Reporter(info, self.violation_base_code)	5✔
49
50	self.file_path: Path = self.info.project.root / self.filename	5✔
51
52	# Configuration for this file as a TOML dict, taken from the style file.
53	self.expected_config: JsonDict = expected_config or {}	5✔
54
55	self.autofix = self.fixable and autofix	5✔
56	# Dirty flag to avoid changing files without need
57	self.dirty: bool = False	5✔
58
59	# The user can override the default unique keys (if any) by setting them on the style file.
60	self.unique_keys: JsonDict = self.unique_keys_default.copy()	5✔
61	self.unique_keys.update(self.expected_config.pop(DUNDER_SEARCH_UNIQUE_KEY, None) or {})	5✔
62
63	@mypy_property	5✔
64	@lru_cache()	5✔
65	def nitpick_file_dict(self) -> JsonDict:	5✔
66	"""Nitpick configuration for this file as a TOML dict, taken from the style file."""
67	return search_dict(f'files."{self.filename}"', self.info.project.nitpick_section, {})	5✔
68
69	@property	5✔
70	def unique_keys_default(self) -> JsonDict:	5✔
71	"""Default unique keys that might be set by a plugin."""
72	return {}	5✔
73
74	@classmethod	5✔
75	def get_compiled_jmespath_filenames(cls):	3✔
76	"""Return a compiled JMESPath expression for file names, using the class name as part of the key."""
77	return jmespath.compile(f"nitpick.{cls.__name__}.filenames")	×
78
79	def entry_point(self) -> Iterator[Fuss]:	5✔
80	"""Entry point of the Nitpick plugin."""
81	self.post_init()	5✔
82
83	should_exist: bool = bool(self.info.project.nitpick_files_section.get(self.filename, True))	5✔
84	if self.file_path.exists() and not should_exist:	5!
85	logger.info(f"{self}: File {self.filename} exists when it should not")	×
86	# Only display this message if the style is valid.
87	yield self.reporter.make_fuss(SharedViolations.DELETE_FILE)	×
88	return	×
89
90	has_config_dict = bool(self.expected_config or self.nitpick_file_dict)	5✔
91	if not has_config_dict:	5!
92	return	×
93
94	yield from self._enforce_file_configuration()	5✔
95
96	def _enforce_file_configuration(self):	5✔
97	file_exists = self.file_path.exists()	5✔
98	if file_exists:	5✔
99	logger.info(f"{self}: Enforcing rules")	5✔
100	yield from self.enforce_rules()	5✔
101	else:
102	yield from self._suggest_when_file_not_found()	5✔
103
104	if self.autofix and self.dirty:	5✔
105	fuss = self.write_file(file_exists) # pylint: disable=assignment-from-none	5✔
106	if fuss:	5✔
107	yield fuss	5✔
108
109	def post_init(self):	5✔
110	"""Hook for plugin initialization after the instance was created.
111
112	The name mimics ``__post_init__()`` on dataclasses, without the magic double underscores:
113	`Post-init processing <https://docs.python.org/3/library/dataclasses.html#post-init-processing>`_
114	"""
115
116	def _suggest_when_file_not_found(self):	5✔
117	suggestion = self.initial_contents	5✔
118	if not suggestion and self.skip_empty_suggestion:	5✔
119	return	5✔
120	logger.info(f"{self}: Suggest initial contents for {self.filename}")	5✔
121
122	if suggestion:	5!
123	yield self.reporter.make_fuss(SharedViolations.CREATE_FILE_WITH_SUGGESTION, suggestion, fixed=self.autofix)	5✔
124	else:
125	yield self.reporter.make_fuss(SharedViolations.CREATE_FILE)	×
126
127	def write_file(self, file_exists: bool) -> Optional[Fuss]: # pylint: disable=unused-argument,no-self-use	5✔
128	"""Hook to write the new file when autofix mode is on. Should be used by inherited classes."""
129	return None	5✔
130
131	@abc.abstractmethod	5✔
132	def enforce_rules(self) -> Iterator[Fuss]:	5✔
133	"""Enforce rules for this file. It must be overridden by inherited classes if needed."""
134
135	@property	5✔
136	@abc.abstractmethod	5✔
137	def initial_contents(self) -> str:	5✔
138	"""Suggested initial content when the file doesn't exist."""
139
140	def write_initial_contents(self, doc_class: Type[BaseDoc], expected_dict: Dict = None) -> str:	5✔
141	"""Helper to write initial contents based on a format."""
142	if not expected_dict:	5✔
143	expected_dict = self.expected_config	5✔
144
145	formatted_str = doc_class(obj=expected_dict).reformatted	5✔
146	if self.autofix:	5✔
147	self.file_path.parent.mkdir(exist_ok=True, parents=True)	5✔
148	self.file_path.write_text(formatted_str)	5✔
149	return formatted_str	5✔
150
151	def warn_missing_different(self, comparison: Comparison, prefix: str = "") -> Iterator[Fuss]:	5✔
152	"""Warn about missing and different keys."""
153	# pylint: disable=not-callable
UNCOV 154	if comparison.missing:	×
UNCOV 155	yield self.reporter.make_fuss(	×
156	SharedViolations.MISSING_VALUES, comparison.missing.reformatted, prefix=prefix
157	)
UNCOV 158	if comparison.diff:	×
UNCOV 159	yield self.reporter.make_fuss(SharedViolations.DIFFERENT_VALUES, comparison.diff.reformatted, prefix=prefix)	×

andreoliwa / nitpick / 1669195387

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous