1039

pending completion

Build # 1039

Build Type

push

travis-ci-com

Committed by

andreoliwa

Commit Message

fix: toml module now accepts keys beginning with dot (fix #183)

test: deprecation of the section without dots
refactor: remove unused hook
refactor: a single hook to handle and validate
refactor: a simpler hook implementation
refactor: reduce complexity
chore: add dots, remove pytest warnings
chore: validate JSON files with a schema
build: fix lint warnings and (almost all) tests
refactor: add Deprecation class
fix: don't display a deprecation warning for the merged style

Run Details

358 of 418 branches covered (85.65%)

Branch coverage included in aggregate %.

112 of 112 new or added lines in 12 files covered. (100.0%)

24 existing lines in 6 files now uncovered.

1259 of 1314 relevant lines covered (95.81%)

3.83 hits per line

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

84.42

/src/nitpick/plugins/base.py

"""Base class for file checkers."""
import abc
from typing import TYPE_CHECKING, Optional, Set, Type

import jmespath

from nitpick.app import NitpickApp
from nitpick.generic import search_dict
from nitpick.mixin import NitpickMixin
from nitpick.typedefs import JsonDict, YieldFlake8Error

if TYPE_CHECKING:
    from pathlib import Path

    from marshmallow import Schema


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

    file_name = ""
    error_base_number = 300

    #: 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 = None  # type: Optional[Schema]

    fixed_name_classes = set()  # type: Set[Type[NitpickPlugin]]
    dynamic_name_classes = set()  # type: Set[Type[NitpickPlugin]]

    # TODO: This info is duplicated. Use the value passed on the hook spec, and remove this attribute.
    #  For this to work, validation and dynamic schema have to be done in a different way
    #  (maybe NOT using dynamic schemas)
    #: Which ``identify`` tags this :py:class:`nitpick.plugins.base.NitpickPlugin` child recognises.
    identify_tags = set()  # type: Set[str]

    def __init__(self, path_from_root: str = None) -> None:
        if path_from_root is not None:
            self.file_name = path_from_root

        self.error_prefix = "File {}".format(self.file_name)
        self.file_path = NitpickApp.current().root_dir / self.file_name  # type: Path

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

        # Nitpick configuration for this file as a TOML dict, taken from the style file.
        self.nitpick_file_dict = search_dict(
            'files."{}"'.format(self.file_name), NitpickApp.current().config.nitpick_section, {}
        )  # type: JsonDict

    @classmethod
    def load_fixed_dynamic_classes(cls) -> None:
        """Separate classes with fixed file names from classes with dynamic files names."""
        cls.fixed_name_classes = set()
        cls.dynamic_name_classes = set()
        for plugin_class in NitpickApp.current().plugin_manager.hook.plugin_class():
            if plugin_class.file_name:
                cls.fixed_name_classes.add(plugin_class)
            else:
                cls.dynamic_name_classes.add(plugin_class)

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

    def process(self, config: JsonDict) -> YieldFlake8Error:
        """Process the file, check if it should exist, check rules."""
        self.file_dict = config or {}

        config_data_exists = bool(self.file_dict or self.nitpick_file_dict)
        should_exist = NitpickApp.current().config.nitpick_files_section.get(self.file_name, True)  # type: bool
        file_exists = self.file_path.exists()

        if config_data_exists and not file_exists:
            suggestion = self.suggest_initial_contents()
            phrases = [" was not found"]
            message = NitpickApp.current().config.nitpick_files_section.get(self.file_name)
            if message and isinstance(message, str):
                phrases.append(message)
            if suggestion:
                phrases.append("Create it with this content:")
            yield self.flake8_error(1, ". ".join(phrases), suggestion)
        elif not should_exist and file_exists:
            # Only display this message if the style is valid.
            if not NitpickApp.current().style_errors:
                yield self.flake8_error(2, " should be deleted")
        elif file_exists and config_data_exists:
            yield from self.check_rules()

    @abc.abstractmethod
    def check_rules(self) -> YieldFlake8Error:
        """Check 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."""

1	"""Base class for file checkers."""
2	import abc	4✔
3	from typing import TYPE_CHECKING, Optional, Set, Type	4✔
4
5	import jmespath	4✔
6
7	from nitpick.app import NitpickApp	4✔
8	from nitpick.generic import search_dict	4✔
9	from nitpick.mixin import NitpickMixin	4✔
10	from nitpick.typedefs import JsonDict, YieldFlake8Error	4✔
11
12	if TYPE_CHECKING:	4!
UNCOV 13	from pathlib import Path	×
14
UNCOV 15	from marshmallow import Schema	×
16
17
18	class NitpickPlugin(NitpickMixin, metaclass=abc.ABCMeta):	4✔
19	"""Base class for file checkers."""
20
21	file_name = ""	4✔
22	error_base_number = 300	4✔
23
24	#: Nested validation field for this file, to be applied in runtime when the validation schema is rebuilt.
25	#: Useful when you have a strict configuration for a file type (e.g. :py:class:`nitpick.plugins.json.JSONPlugin`).
26	validation_schema = None # type: Optional[Schema]	4✔
27
28	fixed_name_classes = set() # type: Set[Type[NitpickPlugin]]	4✔
29	dynamic_name_classes = set() # type: Set[Type[NitpickPlugin]]	4✔
30
31	# TODO: This info is duplicated. Use the value passed on the hook spec, and remove this attribute.
32	# For this to work, validation and dynamic schema have to be done in a different way
33	# (maybe NOT using dynamic schemas)
34	#: Which ``identify`` tags this :py:class:`nitpick.plugins.base.NitpickPlugin` child recognises.
35	identify_tags = set() # type: Set[str]	4✔
36
37	def __init__(self, path_from_root: str = None) -> None:	4✔
38	if path_from_root is not None:	4✔
39	self.file_name = path_from_root	4✔
40
41	self.error_prefix = "File {}".format(self.file_name)	4✔
42	self.file_path = NitpickApp.current().root_dir / self.file_name # type: Path	4✔
43
44	# Configuration for this file as a TOML dict, taken from the style file.
45	self.file_dict = {} # type: JsonDict	4✔
46
47	# Nitpick configuration for this file as a TOML dict, taken from the style file.
48	self.nitpick_file_dict = search_dict(	4✔
49	'files."{}"'.format(self.file_name), NitpickApp.current().config.nitpick_section, {}
50	) # type: JsonDict
51
52	@classmethod	4✔
53	def load_fixed_dynamic_classes(cls) -> None:	4✔
54	"""Separate classes with fixed file names from classes with dynamic files names."""
55	cls.fixed_name_classes = set()	4✔
56	cls.dynamic_name_classes = set()	4✔
57	for plugin_class in NitpickApp.current().plugin_manager.hook.plugin_class():	4✔
58	if plugin_class.file_name:	4✔
59	cls.fixed_name_classes.add(plugin_class)	4✔
60	else:
61	cls.dynamic_name_classes.add(plugin_class)	4✔
62
63	@classmethod	4✔
64	def get_compiled_jmespath_file_names(cls):	1✔
65	"""Return a compiled JMESPath expression for file names, using the class name as part of the key."""
66	return jmespath.compile("nitpick.{}.file_names".format(cls.__name__))	4✔
67
68	def process(self, config: JsonDict) -> YieldFlake8Error:	4✔
69	"""Process the file, check if it should exist, check rules."""
70	self.file_dict = config or {}	4✔
71
72	config_data_exists = bool(self.file_dict or self.nitpick_file_dict)	4✔
73	should_exist = NitpickApp.current().config.nitpick_files_section.get(self.file_name, True) # type: bool	4✔
74	file_exists = self.file_path.exists()	4✔
75
76	if config_data_exists and not file_exists:	4✔
77	suggestion = self.suggest_initial_contents()	4✔
78	phrases = [" was not found"]	4✔
79	message = NitpickApp.current().config.nitpick_files_section.get(self.file_name)	4✔
80	if message and isinstance(message, str):	4!
UNCOV 81	phrases.append(message)	×
82	if suggestion:	4!
83	phrases.append("Create it with this content:")	4✔
84	yield self.flake8_error(1, ". ".join(phrases), suggestion)	4✔
85	elif not should_exist and file_exists:	4!
86	# Only display this message if the style is valid.
87	if not NitpickApp.current().style_errors:	×
UNCOV 88	yield self.flake8_error(2, " should be deleted")	×
89	elif file_exists and config_data_exists:	4!
90	yield from self.check_rules()	4✔
91
92	@abc.abstractmethod	4✔
93	def check_rules(self) -> YieldFlake8Error:	4✔
94	"""Check rules for this file. It should be overridden by inherited classes if needed."""
95
96	@abc.abstractmethod	4✔
97	def suggest_initial_contents(self) -> str:	4✔
98	"""Suggest the initial content for this missing file."""

andreoliwa / nitpick / 1039

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