610872407

Build Type

github

Committed by GitHub

Commit Message

Merge b81ed156d into 41420fcc4

Pull Request Pull Request #301: test: more missing branches, use Fuss classes

Run Details

414 of 477 branches covered (86.79%)

Branch coverage included in aggregate %.

28 of 29 new or added lines in 7 files covered. (96.55%)

3 existing lines in 1 file now uncovered.

1517 of 1582 relevant lines covered (95.89%)

3.82 hits per line

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

92.63

/src/nitpick/core.py

"""The Nitpick application."""
import os
from functools import lru_cache
from itertools import chain
from pathlib import Path
from typing import TYPE_CHECKING, Iterator, List, Type

import click
from loguru import logger

from nitpick.constants import PROJECT_NAME
from nitpick.exceptions import QuitComplainingError
from nitpick.generic import filter_names, relative_to_current_dir
from nitpick.plugins.info import FileInfo
from nitpick.project import Project
from nitpick.typedefs import PathOrStr
from nitpick.violations import Fuss, ProjectViolations, Reporter

if TYPE_CHECKING:
    from nitpick.plugins import NitpickPlugin


class Nitpick:
    """The Nitpick API."""

    _allow_init = False

    project: Project

    def __init__(self):
        if not self._allow_init:
            raise TypeError("This class cannot be instantiated directly. Use Nitpick.singleton().init(...) instead")

        self.offline: bool = False

    @classmethod
    @lru_cache()
    def singleton(cls) -> "Nitpick":
        """Return a single instance of the class."""
        Nitpick._allow_init = True
        instance = cls()
        Nitpick._allow_init = False
        return instance

    def init(self, project_root: PathOrStr = None, offline: bool = None) -> "Nitpick":
        """Initialize attributes of the singleton."""
        self.project = Project(project_root)

        if offline is not None:
            self.offline = offline

        return self

    def run(self, *partial_names: str, apply=False) -> Iterator[Fuss]:
        """Run Nitpick.

        :param partial_names: Names of the files to enforce configs for.
        :param apply: Flag to apply changes, if the plugin supports it (default: True).
        :return: Fuss generator.
        """
        Reporter.reset()

        try:
            yield from chain(
                self.project.merge_styles(self.offline),
                self.enforce_present_absent(*partial_names),
                self.enforce_style(*partial_names, apply=apply),
            )
        except QuitComplainingError as err:
            yield from err.violations

    def enforce_present_absent(self, *partial_names: str) -> Iterator[Fuss]:
        """Enforce files that should be present or absent.

        :param partial_names: Names of the files to enforce configs for.
        :return: Fuss generator.
        """
        if not self.project:
            return

        for present in (True, False):
            key = "present" if present else "absent"
            logger.info(f"Enforce {key} files")
            absent = not present
            file_mapping = self.project.nitpick_files_section.get(key, {})
            for filename in filter_names(file_mapping, *partial_names):
                custom_message = file_mapping[filename]
                file_path: Path = self.project.root / filename
                exists = file_path.exists()
                if (present and exists) or (absent and not exists):
                    continue

                reporter = Reporter(FileInfo.create(self.project, filename))

                extra = f": {custom_message}" if custom_message else ""
                violation = ProjectViolations.MISSING_FILE if present else ProjectViolations.FILE_SHOULD_BE_DELETED
                yield reporter.make_fuss(violation, extra=extra)

    def enforce_style(self, *partial_names: str, apply=True) -> Iterator[Fuss]:
        """Read the merged style and enforce the rules in it.

        1. Get all root keys from the merged style
        2. All except "nitpick" are file names.
        3. For each file name, find the plugin(s) that can handle the file.

        :param partial_names: Names of the files to enforce configs for.
        :param apply: Flag to apply changes, if the plugin supports it (default: True).
        :return: Fuss generator.
        """

        # 1.
        for config_key in filter_names(self.project.style_dict, *partial_names):
            config_dict = self.project.style_dict[config_key]
            logger.info(f"{config_key}: Finding plugins to enforce style")

            # 2.
            if config_key == PROJECT_NAME:
                continue

            # 3.
            info = FileInfo.create(self.project, config_key)
            # pylint: disable=no-member
            for plugin_class in self.project.plugin_manager.hook.can_handle(info=info):  # type: Type[NitpickPlugin]
                yield from plugin_class(info, config_dict, apply).entry_point()

    def configured_files(self, *partial_names: str) -> List[Path]:
        """List of files configured in the Nitpick style. Filter only the selected partial names."""
        return [Path(self.project.root) / key for key in filter_names(self.project.style_dict, *partial_names)]

    def echo(self, message: str):
        """Echo a message on the terminal, with the relative path at the beginning."""
        relative = relative_to_current_dir(self.project.root)
        if relative:
            relative += os.path.sep
        click.echo(f"{relative}{message}")

1	"""The Nitpick application."""
2	import os	4✔
3	from functools import lru_cache	4✔
4	from itertools import chain	4✔
5	from pathlib import Path	4✔
6	from typing import TYPE_CHECKING, Iterator, List, Type	4✔
7
8	import click	4✔
9	from loguru import logger	4✔
10
11	from nitpick.constants import PROJECT_NAME	4✔
12	from nitpick.exceptions import QuitComplainingError	4✔
13	from nitpick.generic import filter_names, relative_to_current_dir	4✔
14	from nitpick.plugins.info import FileInfo	4✔
15	from nitpick.project import Project	4✔
16	from nitpick.typedefs import PathOrStr	4✔
17	from nitpick.violations import Fuss, ProjectViolations, Reporter	4✔
18
19	if TYPE_CHECKING:
20	from nitpick.plugins import NitpickPlugin
21
22
23	class Nitpick:	4✔
24	"""The Nitpick API."""
25
26	_allow_init = False	4✔
27
28	project: Project	4✔
29
30	def __init__(self):	4✔
31	if not self._allow_init:	4✔
32	raise TypeError("This class cannot be instantiated directly. Use Nitpick.singleton().init(...) instead")	4✔
33
34	self.offline: bool = False	4✔
35
36	@classmethod	4✔
37	@lru_cache()	4✔
38	def singleton(cls) -> "Nitpick":	4✔
39	"""Return a single instance of the class."""
40	Nitpick._allow_init = True	4✔
41	instance = cls()	4✔
42	Nitpick._allow_init = False	4✔
43	return instance	4✔
44
45	def init(self, project_root: PathOrStr = None, offline: bool = None) -> "Nitpick":	4✔
46	"""Initialize attributes of the singleton."""
47	self.project = Project(project_root)	4✔
48
49	if offline is not None:	4!
50	self.offline = offline	4✔
51
52	return self	4✔
53
54	def run(self, *partial_names: str, apply=False) -> Iterator[Fuss]:	4✔
55	"""Run Nitpick.
56
57	:param partial_names: Names of the files to enforce configs for.
58	:param apply: Flag to apply changes, if the plugin supports it (default: True).
59	:return: Fuss generator.
60	"""
61	Reporter.reset()	4✔
62
63	try:	4✔
64	yield from chain(	4✔
65	self.project.merge_styles(self.offline),
66	self.enforce_present_absent(*partial_names),
67	self.enforce_style(*partial_names, apply=apply),
68	)
69	except QuitComplainingError as err:	4✔
70	yield from err.violations	4✔
71
72	def enforce_present_absent(self, *partial_names: str) -> Iterator[Fuss]:	4✔
73	"""Enforce files that should be present or absent.
74
75	:param partial_names: Names of the files to enforce configs for.
76	:return: Fuss generator.
77	"""
78	if not self.project:	4!
UNCOV 79	return	×
80
81	for present in (True, False):	4✔
82	key = "present" if present else "absent"	4✔
83	logger.info(f"Enforce {key} files")	4✔
84	absent = not present	4✔
85	file_mapping = self.project.nitpick_files_section.get(key, {})	4✔
86	for filename in filter_names(file_mapping, *partial_names):	4✔
87	custom_message = file_mapping[filename]	4✔
88	file_path: Path = self.project.root / filename	4✔
89	exists = file_path.exists()	4✔
90	if (present and exists) or (absent and not exists):	4!
UNCOV 91	continue	×
92
93	reporter = Reporter(FileInfo.create(self.project, filename))	4✔
94
95	extra = f": {custom_message}" if custom_message else ""	4✔
96	violation = ProjectViolations.MISSING_FILE if present else ProjectViolations.FILE_SHOULD_BE_DELETED	4✔
97	yield reporter.make_fuss(violation, extra=extra)	4✔
98
99	def enforce_style(self, *partial_names: str, apply=True) -> Iterator[Fuss]:	4✔
100	"""Read the merged style and enforce the rules in it.
101
102	1. Get all root keys from the merged style
103	2. All except "nitpick" are file names.
104	3. For each file name, find the plugin(s) that can handle the file.
105
106	:param partial_names: Names of the files to enforce configs for.
107	:param apply: Flag to apply changes, if the plugin supports it (default: True).
108	:return: Fuss generator.
109	"""
110
111	# 1.
112	for config_key in filter_names(self.project.style_dict, *partial_names):	4✔
113	config_dict = self.project.style_dict[config_key]	4✔
114	logger.info(f"{config_key}: Finding plugins to enforce style")	4✔
115
116	# 2.
117	if config_key == PROJECT_NAME:	4!
UNCOV 118	continue	×
119
120	# 3.
121	info = FileInfo.create(self.project, config_key)	4✔
122	# pylint: disable=no-member
123	for plugin_class in self.project.plugin_manager.hook.can_handle(info=info): # type: Type[NitpickPlugin]	4✔
124	yield from plugin_class(info, config_dict, apply).entry_point()	4✔
125
126	def configured_files(self, *partial_names: str) -> List[Path]:	4✔
127	"""List of files configured in the Nitpick style. Filter only the selected partial names."""
128	return [Path(self.project.root) / key for key in filter_names(self.project.style_dict, *partial_names)]	4✔
129
130	def echo(self, message: str):	4✔
131	"""Echo a message on the terminal, with the relative path at the beginning."""
132	relative = relative_to_current_dir(self.project.root)	4✔
133	if relative:	4✔
134	relative += os.path.sep	4✔
135	click.echo(f"{relative}{message}")	4✔

andreoliwa / nitpick / 610872407

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