543272887

Build Type

github

Committed by GitHub

Commit Message

Merge e642069a8 into 056dc133d

Pull Request Pull Request #255: Experimental CLI interface (alpha version)

Run Details

354 of 430 branches covered (82.33%)

Branch coverage included in aggregate %.

570 of 591 new or added lines in 23 files covered. (96.45%)

1 existing line in 1 file now uncovered.

1361 of 1430 relevant lines covered (95.17%)

3.8 hits per line

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

95.08

/src/nitpick/flake8.py

"""Flake8 plugin to check files."""
import logging
from functools import lru_cache
from pathlib import Path
from typing import Iterator

import attr
from flake8.options.manager import OptionManager
from loguru import logger

from nitpick import __version__
from nitpick.cli import NitpickFlag
from nitpick.constants import FLAKE8_PREFIX, PROJECT_NAME
from nitpick.core import Nitpick
from nitpick.exceptions import QuitComplainingError
from nitpick.typedefs import Flake8Error
from nitpick.violations import Fuss


@attr.s(hash=False)
class NitpickFlake8Extension:
    """Main class for the flake8 extension."""

    # Plugin config
    name = PROJECT_NAME
    version = __version__

    # Plugin arguments passed by Flake8
    tree = attr.ib(default=None)
    filename = attr.ib(default="(none)")

    def run(self) -> Iterator[Flake8Error]:
        """Run the check plugin."""
        try:
            for collected_fuss in self.collect_errors():
                yield self.build_flake8_error(collected_fuss)
        except QuitComplainingError as err:
            for error_fuss in err.fusses:
                yield self.build_flake8_error(error_fuss)

    def build_flake8_error(self, obj: Fuss) -> Flake8Error:
        """Return a flake8 error from a fuss."""
        prefix = f"File {obj.filename}" if obj.filename else ""
        line = f"{FLAKE8_PREFIX}{obj.code:03} {prefix}{obj.message}{obj.colored_suggestion}"
        return 0, 0, line, self.__class__

    def collect_errors(self) -> Iterator[Fuss]:
        """Collect all possible Nitpick errors."""
        nit = Nitpick.singleton()

        current_python_file = Path(self.filename)
        main_python_file: Path = nit.project.find_main_python_file()
        if current_python_file.absolute() != main_python_file.absolute():
            # Only report warnings once, for the main Python file of this project.
            logger.debug("Ignoring other Python file: {}", self.filename)
            return []

        logger.debug("Nitpicking file through flake8: {}", self.filename)
        yield from nit.run()
        return []

    @staticmethod
    @lru_cache()  # To avoid calling this function twice in the same process
    def add_options(option_manager: OptionManager):
        """Add the offline option."""
        option_manager.add_option(
            NitpickFlag.OFFLINE.as_flake8_flag(), action="store_true", help=NitpickFlag.OFFLINE.value
        )

    @staticmethod
    def parse_options(option_manager: OptionManager, options, args):  # pylint: disable=unused-argument
        """Create the Nitpick app, set logging from the verbose flags, set offline mode.

        This function is called only once by flake8, so it's a good place to create the app.
        """
        log_mapping = {1: logging.INFO, 2: logging.DEBUG}
        logging.basicConfig(level=log_mapping.get(options.verbose, logging.WARNING))

        nit = Nitpick.singleton().init(offline=bool(options.nitpick_offline or NitpickFlag.OFFLINE.get_environ()))
        logger.info("Offline mode: {}", nit.offline)

1	"""Flake8 plugin to check files."""
2	import logging	4✔
3	from functools import lru_cache	4✔
4	from pathlib import Path	4✔
5	from typing import Iterator	4✔
6
7	import attr	4✔
8	from flake8.options.manager import OptionManager	4✔
9	from loguru import logger	4✔
10
11	from nitpick import __version__	4✔
12	from nitpick.cli import NitpickFlag	4✔
13	from nitpick.constants import FLAKE8_PREFIX, PROJECT_NAME	4✔
14	from nitpick.core import Nitpick	4✔
15	from nitpick.exceptions import QuitComplainingError	4✔
16	from nitpick.typedefs import Flake8Error	4✔
17	from nitpick.violations import Fuss	4✔
18
19
20	@attr.s(hash=False)	4✔
21	class NitpickFlake8Extension:	2✔
22	"""Main class for the flake8 extension."""
23
24	# Plugin config
25	name = PROJECT_NAME	4✔
26	version = __version__	4✔
27
28	# Plugin arguments passed by Flake8
29	tree = attr.ib(default=None)	4✔
30	filename = attr.ib(default="(none)")	4✔
31
32	def run(self) -> Iterator[Flake8Error]:	4✔
33	"""Run the check plugin."""
34	try:	4✔
35	for collected_fuss in self.collect_errors():	4✔
36	yield self.build_flake8_error(collected_fuss)	4✔
37	except QuitComplainingError as err:	4✔
38	for error_fuss in err.fusses:	4✔
39	yield self.build_flake8_error(error_fuss)	4✔
40
41	def build_flake8_error(self, obj: Fuss) -> Flake8Error:	4✔
42	"""Return a flake8 error from a fuss."""
43	prefix = f"File {obj.filename}" if obj.filename else ""	4✔
44	line = f"{FLAKE8_PREFIX}{obj.code:03} {prefix}{obj.message}{obj.colored_suggestion}"	4✔
45	return 0, 0, line, self.__class__	4✔
46
47	def collect_errors(self) -> Iterator[Fuss]:	4✔
48	"""Collect all possible Nitpick errors."""
49	nit = Nitpick.singleton()	4✔
50
51	current_python_file = Path(self.filename)	4✔
52	main_python_file: Path = nit.project.find_main_python_file()	4✔
53	if current_python_file.absolute() != main_python_file.absolute():	4!
54	# Only report warnings once, for the main Python file of this project.
NEW 55	logger.debug("Ignoring other Python file: {}", self.filename)	×
56	return []	×
57
58	logger.debug("Nitpicking file through flake8: {}", self.filename)	4✔
59	yield from nit.run()	4✔
60	return []	4✔
61
62	@staticmethod	4✔
63	@lru_cache() # To avoid calling this function twice in the same process	4✔
64	def add_options(option_manager: OptionManager):	4✔
65	"""Add the offline option."""
66	option_manager.add_option(	4✔
67	NitpickFlag.OFFLINE.as_flake8_flag(), action="store_true", help=NitpickFlag.OFFLINE.value
68	)
69
70	@staticmethod	4✔
71	def parse_options(option_manager: OptionManager, options, args): # pylint: disable=unused-argument	4✔
72	"""Create the Nitpick app, set logging from the verbose flags, set offline mode.
73
74	This function is called only once by flake8, so it's a good place to create the app.
75	"""
76	log_mapping = {1: logging.INFO, 2: logging.DEBUG}	4✔
77	logging.basicConfig(level=log_mapping.get(options.verbose, logging.WARNING))	4✔
78
79	nit = Nitpick.singleton().init(offline=bool(options.nitpick_offline or NitpickFlag.OFFLINE.get_environ()))	4✔
80	logger.info("Offline mode: {}", nit.offline)	4✔

andreoliwa / nitpick / 543272887

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