559187379

Build Type

push

github

Committed by Augusto W. Andreoli

Commit Message

Merge branch 'apply-toml' of github.com:andreoliwa/nitpick into apply-toml

Run Details

369 of 454 branches covered (81.28%)

Branch coverage included in aggregate %.

26 of 29 new or added lines in 3 files covered. (89.66%)

14 existing lines in 5 files now uncovered.

1408 of 1488 relevant lines covered (94.62%)

3.77 hits per line

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

93.1

/src/nitpick/plugins/pyproject_toml.py

"""Enforce config on `pyproject.toml <https://github.com/python-poetry/poetry/blob/master/docs/docs/pyproject.md>`_."""
from typing import Iterator, Optional, Type

from nitpick.constants import PYPROJECT_TOML
from nitpick.core import Nitpick
from nitpick.plugins import hookimpl
from nitpick.plugins.base import NitpickPlugin
from nitpick.plugins.data import FileData
from nitpick.violations import Fuss


class PyProjectTomlPlugin(NitpickPlugin):
    """Enforce config on `pyproject.toml <https://github.com/python-poetry/poetry/blob/master/docs/docs/pyproject.md>`_.

    See also `PEP 518 <https://www.python.org/dev/peps/pep-0518/>`_.

    Example: :ref:`the Python 3.7 default <default-python-3-7>`.
    There are many other examples in :ref:`defaults`.
    """

    filename = PYPROJECT_TOML
    violation_base_code = 310

    def enforce_rules(self) -> Iterator[Fuss]:
        """Enforce rules for missing key/value pairs in pyproject.toml."""
        file = Nitpick.singleton().project.pyproject_toml
        if file:
            comparison = file.compare_with_flatten(self.file_dict)
            # FIXME[AA]: use MergeDict to apply the difference, and toml to save the file
            yield from self.warn_missing_different(comparison)

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


@hookimpl
def plugin_class() -> Type["NitpickPlugin"]:
    """You should return your plugin class here."""
    return PyProjectTomlPlugin


@hookimpl
def can_handle(data: FileData) -> Optional["NitpickPlugin"]:
    """Handle pyproject.toml file."""
    if data.path_from_root == PYPROJECT_TOML:
        return PyProjectTomlPlugin(data)
    return None

1	"""Enforce config on `pyproject.toml <https://github.com/python-poetry/poetry/blob/master/docs/docs/pyproject.md>`_."""
2	from typing import Iterator, Optional, Type	4✔
3
4	from nitpick.constants import PYPROJECT_TOML	4✔
5	from nitpick.core import Nitpick	4✔
6	from nitpick.plugins import hookimpl	4✔
7	from nitpick.plugins.base import NitpickPlugin	4✔
8	from nitpick.plugins.data import FileData	4✔
9	from nitpick.violations import Fuss	4✔
10
11
12	class PyProjectTomlPlugin(NitpickPlugin):	4✔
13	"""Enforce config on `pyproject.toml <https://github.com/python-poetry/poetry/blob/master/docs/docs/pyproject.md>`_.
14
15	See also `PEP 518 <https://www.python.org/dev/peps/pep-0518/>`_.
16
17	Example: :ref:`the Python 3.7 default <default-python-3-7>`.
18	There are many other examples in :ref:`defaults`.
19	"""
20
21	filename = PYPROJECT_TOML	4✔
22	violation_base_code = 310	4✔
23
24	def enforce_rules(self) -> Iterator[Fuss]:	4✔
25	"""Enforce rules for missing key/value pairs in pyproject.toml."""
26	file = Nitpick.singleton().project.pyproject_toml	4✔
27	if file:	4!
28	comparison = file.compare_with_flatten(self.file_dict)	4✔
29	# FIXME[AA]: use MergeDict to apply the difference, and toml to save the file
30	yield from self.warn_missing_different(comparison)	4✔
31
32	def suggest_initial_contents(self) -> str:	4✔
33	"""Suggest the initial content for this missing file."""
UNCOV 34	return ""	×
35
36
37	@hookimpl	4✔
38	def plugin_class() -> Type["NitpickPlugin"]:	4✔
39	"""You should return your plugin class here."""
40	return PyProjectTomlPlugin	4✔
41
42
43	@hookimpl	4✔
44	def can_handle(data: FileData) -> Optional["NitpickPlugin"]:	4✔
45	"""Handle pyproject.toml file."""
46	if data.path_from_root == PYPROJECT_TOML:	4✔
47	return PyProjectTomlPlugin(data)	4✔
48	return None	4✔

andreoliwa / nitpick / 559187379

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