543751385

Build Type

push

github

Committed by Augusto W. Andreoli

Commit Message

Merge branch 'develop' into apply-fixes-by-default

Run Details

354 of 430 branches covered (82.33%)

Branch coverage included in aggregate %.

13 of 14 new or added lines in 2 files covered. (92.86%)

35 existing lines in 8 files 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

86.9

/src/nitpick/core.py

"""The Nitpick application."""
from functools import lru_cache
from itertools import chain
from pathlib import Path
from typing import Iterator, Union

from loguru import logger

from nitpick.constants import PROJECT_NAME
from nitpick.exceptions import QuitComplainingError
from nitpick.plugins.data import FileData
from nitpick.project import Project
from nitpick.violations import Fuss, ProjectViolations, Reporter


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, path_or_project: Union[Path, Project] = None, offline: bool = None) -> "Nitpick":
        """Initialize attributes of the singleton."""
        if path_or_project is None or isinstance(path_or_project, (Path, str)):
            self.project = Project(path_or_project)
        elif isinstance(path_or_project, Project):
            self.project = path_or_project
        else:
            raise TypeError("path_or_project should be a Path or a Project")

        if offline is not None:
            self.offline = offline

        return self

    def run(self) -> Iterator[Fuss]:
        """Run Nitpick."""
        try:
            yield from chain(
                self.project.merge_styles(self.offline), self.enforce_present_absent(), self.enforce_style()
            )
        except QuitComplainingError as err:
            yield from err.fusses

    def enforce_present_absent(self) -> Iterator[Fuss]:
        """Enforce files that should be present or absent."""
        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
            for filename, custom_message in self.project.nitpick_files_section.get(key, {}).items():
                file_path: Path = self.project.root / filename
                exists = file_path.exists()
                if (present and exists) or (absent and not exists):
                    continue

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

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

    def enforce_style(self):
        """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.
        """

        # 1.
        for config_key, config_dict in self.project.style_dict.items():
            logger.info(f"{config_key}: Finding plugins to enforce style")

            # 2.
            if config_key == PROJECT_NAME:
                continue

            # 3.
            for plugin_instance in self.project.plugin_manager.hook.can_handle(  # pylint: disable=no-member
                data=FileData.create(self.project, config_key)
            ):
                yield from plugin_instance.entry_point(config_dict)

1	"""The Nitpick application."""
2	from functools import lru_cache	4✔
3	from itertools import chain	4✔
4	from pathlib import Path	4✔
5	from typing import Iterator, Union	4✔
6
7	from loguru import logger	4✔
8
9	from nitpick.constants import PROJECT_NAME	4✔
10	from nitpick.exceptions import QuitComplainingError	4✔
11	from nitpick.plugins.data import FileData	4✔
12	from nitpick.project import Project	4✔
13	from nitpick.violations import Fuss, ProjectViolations, Reporter	4✔
14
15
16	class Nitpick:	4✔
17	"""The Nitpick API."""
18
19	_allow_init = False	4✔
20
21	project: Project	4✔
22
23	def __init__(self):	4✔
24	if not self._allow_init:	4✔
25	raise TypeError("This class cannot be instantiated directly. Use Nitpick.singleton().init(...) instead")	4✔
26
27	self.offline: bool = False	4✔
28
29	@classmethod	4✔
30	@lru_cache()	4✔
31	def singleton(cls) -> "Nitpick":	4✔
32	"""Return a single instance of the class."""
33	Nitpick._allow_init = True	4✔
34	instance = cls()	4✔
35	Nitpick._allow_init = False	4✔
36	return instance	4✔
37
38	def init(self, path_or_project: Union[Path, Project] = None, offline: bool = None) -> "Nitpick":	4✔
39	"""Initialize attributes of the singleton."""
40	if path_or_project is None or isinstance(path_or_project, (Path, str)):	4!
41	self.project = Project(path_or_project)	4✔
UNCOV 42	elif isinstance(path_or_project, Project):	×
43	self.project = path_or_project	×
44	else:
UNCOV 45	raise TypeError("path_or_project should be a Path or a Project")	×
46
47	if offline is not None:	4!
48	self.offline = offline	4✔
49
50	return self	4✔
51
52	def run(self) -> Iterator[Fuss]:	4✔
53	"""Run Nitpick."""
54	try:	4✔
55	yield from chain(	4✔
56	self.project.merge_styles(self.offline), self.enforce_present_absent(), self.enforce_style()
57	)
58	except QuitComplainingError as err:	4✔
59	yield from err.fusses	4✔
60
61	def enforce_present_absent(self) -> Iterator[Fuss]:	4✔
62	"""Enforce files that should be present or absent."""
63	if not self.project:	4!
64	return	×
65
66	for present in (True, False):	4✔
67	key = "present" if present else "absent"	4✔
68	logger.info(f"Enforce {key} files")	4✔
69	absent = not present	4✔
70	for filename, custom_message in self.project.nitpick_files_section.get(key, {}).items():	4✔
71	file_path: Path = self.project.root / filename	4✔
72	exists = file_path.exists()	4✔
73	if (present and exists) or (absent and not exists):	4!
UNCOV 74	continue	×
75
76	reporter = Reporter(FileData.create(self.project, filename))	4✔
77
78	extra = f": {custom_message}" if custom_message else ""	4✔
79	violation = ProjectViolations.MissingFile if present else ProjectViolations.FileShouldBeDeleted	4✔
80	yield reporter.make_fuss(violation, extra=extra)	4✔
81
82	def enforce_style(self):	4✔
83	"""Read the merged style and enforce the rules in it.
84
85	1. Get all root keys from the merged style
86	2. All except "nitpick" are file names.
87	3. For each file name, find the plugin(s) that can handle the file.
88	"""
89
90	# 1.
91	for config_key, config_dict in self.project.style_dict.items():	4✔
92	logger.info(f"{config_key}: Finding plugins to enforce style")	4✔
93
94	# 2.
95	if config_key == PROJECT_NAME:	4✔
96	continue	4✔
97
98	# 3.
99	for plugin_instance in self.project.plugin_manager.hook.can_handle( # pylint: disable=no-member	4✔
100	data=FileData.create(self.project, config_key)
101	):
102	yield from plugin_instance.entry_point(config_dict)	4✔

andreoliwa / nitpick / 543751385

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