543404180

Build Type

push

github

Committed by Augusto W. Andreoli

Commit Message

refactor: missing yield

Run Details

354 of 430 branches covered (82.33%)

Branch coverage included in aggregate %.

1 of 1 new or added line in 1 file covered. (100.0%)

3 existing lines in 1 file now uncovered.

1365 of 1434 relevant lines covered (95.19%)

3.8 hits per line

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

91.03

/src/nitpick/plugins/base.py

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

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

from nitpick.formats import Comparison
from nitpick.generic import search_dict
from nitpick.plugins.data import FileData
from nitpick.typedefs import JsonDict, mypy_property
from nitpick.violations import Fuss, Reporter, SharedViolations, ViolationEnum


class NitpickPlugin(metaclass=abc.ABCMeta):
    """Base class for file checkers."""

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

    filename = ""  # TODO: remove filename attribute after fixing dynamic/fixed schema loading
    violation_base_code: int = 0
    error_codes: Optional[Type[ViolationEnum]] = None

    #: 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, data: FileData) -> None:
        self.data = data
        self.filename = data.path_from_root
        self.reporter = Reporter(data, self.violation_base_code)

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

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

    @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.data.project.nitpick_section, {})

    @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, config: JsonDict) -> Iterator[Fuss]:
        """Entry point of the Nitpick plugin."""
        self.file_dict = config or {}

        config_data_exists = bool(self.file_dict or self.nitpick_file_dict)
        should_exist: bool = self.data.project.nitpick_files_section.get(self.filename, True)
        file_exists = self.file_path.exists()

        if config_data_exists and not file_exists:
            yield from self._suggest()
        elif not should_exist and file_exists:
            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.DeleteFile)
        elif file_exists and config_data_exists:
            logger.info(f"{self}: Enforcing rules")
            yield from self.enforce_rules()

    def _suggest(self):
        suggestion = self.suggest_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.CreateFileWithSuggestion, suggestion)
        else:
            yield self.reporter.make_fuss(SharedViolations.CreateFile)

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

    @abc.abstractmethod
    def suggest_initial_contents(self) -> str:
        """Suggest the initial content for this missing file."""

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

1	"""Base class for file checkers."""
2	import abc	4✔
3	from functools import lru_cache	4✔
4	from pathlib import Path	4✔
5	from typing import Iterator, Optional, Set, Type	4✔
6
7	import jmespath	4✔
8	from autorepr import autotext	4✔
9	from loguru import logger	4✔
10	from marshmallow import Schema	4✔
11
12	from nitpick.formats import Comparison	4✔
13	from nitpick.generic import search_dict	4✔
14	from nitpick.plugins.data import FileData	4✔
15	from nitpick.typedefs import JsonDict, mypy_property	4✔
16	from nitpick.violations import Fuss, Reporter, SharedViolations, ViolationEnum	4✔
17
18
19	class NitpickPlugin(metaclass=abc.ABCMeta):	4✔
20	"""Base class for file checkers."""
21
22	__str__, __unicode__ = autotext("{self.data.path_from_root} ({self.__class__.__name__})")	4✔
23
24	filename = "" # TODO: remove filename attribute after fixing dynamic/fixed schema loading	4✔
25	violation_base_code: int = 0	4✔
26	error_codes: Optional[Type[ViolationEnum]] = None	4✔
27
28	#: Nested validation field for this file, to be applied in runtime when the validation schema is rebuilt.
29	#: Useful when you have a strict configuration for a file type (e.g. :py:class:`nitpick.plugins.json.JSONPlugin`).
30	validation_schema: Optional[Schema] = None	4✔
31
32	#: Which ``identify`` tags this :py:class:`nitpick.plugins.base.NitpickPlugin` child recognises.
33	identify_tags: Set[str] = set()	4✔
34
35	skip_empty_suggestion = False	4✔
36
37	def __init__(self, data: FileData) -> None:	4✔
38	self.data = data	4✔
39	self.filename = data.path_from_root	4✔
40	self.reporter = Reporter(data, self.violation_base_code)	4✔
41
42	self.file_path: Path = self.data.project.root / self.filename	4✔
43
44	# Configuration for this file as a TOML dict, taken from the style file.
45	self.file_dict: JsonDict = {}	4✔
46
47	@mypy_property	4✔
48	@lru_cache()	4✔
49	def nitpick_file_dict(self) -> JsonDict:	4✔
50	"""Nitpick configuration for this file as a TOML dict, taken from the style file."""
51	return search_dict(f'files."{self.filename}"', self.data.project.nitpick_section, {})	4✔
52
53	@classmethod	4✔
54	def get_compiled_jmespath_filenames(cls):	2✔
55	"""Return a compiled JMESPath expression for file names, using the class name as part of the key."""
56	return jmespath.compile(f"nitpick.{cls.__name__}.filenames")	×
57
58	def entry_point(self, config: JsonDict) -> Iterator[Fuss]:	4✔
59	"""Entry point of the Nitpick plugin."""
60	self.file_dict = config or {}	4✔
61
62	config_data_exists = bool(self.file_dict or self.nitpick_file_dict)	4✔
63	should_exist: bool = self.data.project.nitpick_files_section.get(self.filename, True)	4✔
64	file_exists = self.file_path.exists()	4✔
65
66	if config_data_exists and not file_exists:	4✔
67	yield from self._suggest()	4✔
68	elif not should_exist and file_exists:	4!
UNCOV 69	logger.info(f"{self}: File {self.filename} exists when it should not")	×
70	# Only display this message if the style is valid.
UNCOV 71	yield self.reporter.make_fuss(SharedViolations.DeleteFile)	×
72	elif file_exists and config_data_exists:	4!
73	logger.info(f"{self}: Enforcing rules")	4✔
74	yield from self.enforce_rules()	4✔
75
76	def _suggest(self):	4✔
77	suggestion = self.suggest_initial_contents()	4✔
78	if not suggestion and self.skip_empty_suggestion:	4✔
79	return	4✔
80	logger.info(f"{self}: Suggest initial contents for {self.filename}")	4✔
81	if suggestion:	4!
82	yield self.reporter.make_fuss(SharedViolations.CreateFileWithSuggestion, suggestion)	4✔
83	else:
UNCOV 84	yield self.reporter.make_fuss(SharedViolations.CreateFile)	×
85
86	@abc.abstractmethod	4✔
87	def enforce_rules(self) -> Iterator[Fuss]:	4✔
88	"""Enforce rules for this file. It should be overridden by inherited classes if needed."""
89
90	@abc.abstractmethod	4✔
91	def suggest_initial_contents(self) -> str:	4✔
92	"""Suggest the initial content for this missing file."""
93
94	def warn_missing_different(self, comparison: Comparison, prefix: str = "") -> Iterator[Fuss]:	4✔
95	"""Warn about missing and different keys."""
96	# pylint: disable=not-callable
97	if comparison.missing_format:	4✔
98	yield self.reporter.make_fuss(	4✔
99	SharedViolations.MissingValues, comparison.missing_format.reformatted, prefix=prefix
100	)
101	if comparison.diff_format:	4✔
102	yield self.reporter.make_fuss(	4✔
103	SharedViolations.DifferentValues, comparison.diff_format.reformatted, prefix=prefix
104	)

andreoliwa / nitpick / 543404180

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