1141

pending completion

Build # 1141

Build Type

push

travis-ci-com

Committed by

andreoliwa

Commit Message

chore: first attempt to enforce the style using the CLI

Run Details

345 of 427 branches covered (80.8%)

Branch coverage included in aggregate %.

17 of 18 new or added lines in 5 files covered. (94.44%)

1 existing line in 1 file now uncovered.

1321 of 1399 relevant lines covered (94.42%)

3.78 hits per line

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

64.1

/src/nitpick/cli.py

"""Module that contains the command line app.

Why does this file exist, and why not put this in __main__?

  You might be tempted to import things from __main__ later, but that will cause
  problems: the code will get executed twice:

  - When you run `python -mnitpick` python will execute
    ``__main__.py`` as a script. That means there won't be any
    ``nitpick.__main__`` in ``sys.modules``.
  - When you import __main__ it will get executed again (as a module) because
    there's no ``nitpick.__main__`` in ``sys.modules``.

  Also see (1) from http://click.pocoo.org/5/setuptools/#setuptools-integration
"""
import os
from enum import Enum
from itertools import chain
from pathlib import Path

import click
from loguru import logger

from nitpick.constants import ERROR_PREFIX, PROJECT_NAME
from nitpick.core import Nitpick


class _FlagMixin:
    """Private mixin used to test the flags."""

    name: str

    def as_flake8_flag(self) -> str:
        """Format the name of a flag to be used on the CLI."""
        slug = self.name.lower().replace("_", "-")
        return f"--{PROJECT_NAME}-{slug}"

    def as_envvar(self) -> str:
        """Format the name of an environment variable."""
        return f"{PROJECT_NAME.upper()}_{self.name.upper()}"

    def get_environ(self) -> str:
        """Get the value of an environment variable."""
        return os.environ.get(self.as_envvar(), "")


class NitpickFlag(_FlagMixin, Enum):
    """Flags to be used with the CLI."""

    OFFLINE = "Offline mode: no style will be downloaded (no HTTP requests at all)"


@click.command()
@click.option(
    "--project",
    "-p",
    "project_root",
    type=click.Path(exists=True, dir_okay=True, file_okay=False, resolve_path=True),
    help="Path to project root",
)
@click.option(
    f"--{NitpickFlag.OFFLINE.name.lower()}",  # pylint: disable=no-member
    is_flag=True,
    default=False,
    help=NitpickFlag.OFFLINE.value,
)
@click.option(
    "--check",
    "-c",
    is_flag=True,
    default=False,
    help="Don't modify the configuration files, just print the difference."
    " Return code 0 means nothing would change. Return code 1 means some files would be modified.",
)
@click.option("--verbose", "-v", is_flag=True, default=False, help="Verbose logging")
def nitpick_cli(project_root: Path = None, offline=False, check=False, verbose=False):
    """Enforce the same configuration across multiple projects."""
    if verbose:
        logger.enable(PROJECT_NAME)

    if not check:
        logger.warning("Apply mode is not yet implemented; running a check instead")

    nit = Nitpick.singleton().init(project_root, offline)

    for err in chain(nit.project.merge_styles(offline), nit.enforce_present_absent(), nit.enforce_style()):
        click.echo(f"{ERROR_PREFIX}{err.number:03} {err.message}{err.suggestion}")

    click.secho("All done! ✨ 🍰 ✨", fg="bright_white")
    # FIXME[AA]: add a CLI test with one error and the expected stdout results

1	"""Module that contains the command line app.
2
3	Why does this file exist, and why not put this in __main__?
4
5	You might be tempted to import things from __main__ later, but that will cause
6	problems: the code will get executed twice:
7
8	- When you run `python -mnitpick` python will execute
9	``__main__.py`` as a script. That means there won't be any
10	``nitpick.__main__`` in ``sys.modules``.
11	- When you import __main__ it will get executed again (as a module) because
12	there's no ``nitpick.__main__`` in ``sys.modules``.
13
14	Also see (1) from http://click.pocoo.org/5/setuptools/#setuptools-integration
15	"""
16	import os	4✔
17	from enum import Enum	4✔
18	from itertools import chain	4✔
19	from pathlib import Path	4✔
20
21	import click	4✔
22	from loguru import logger	4✔
23
24	from nitpick.constants import ERROR_PREFIX, PROJECT_NAME	4✔
25	from nitpick.core import Nitpick	4✔
26
27
28	class _FlagMixin:	4✔
29	"""Private mixin used to test the flags."""
30
31	name: str	4✔
32
33	def as_flake8_flag(self) -> str:	4✔
34	"""Format the name of a flag to be used on the CLI."""
35	slug = self.name.lower().replace("_", "-")	4✔
36	return f"--{PROJECT_NAME}-{slug}"	4✔
37
38	def as_envvar(self) -> str:	4✔
39	"""Format the name of an environment variable."""
40	return f"{PROJECT_NAME.upper()}_{self.name.upper()}"	4✔
41
42	def get_environ(self) -> str:	4✔
43	"""Get the value of an environment variable."""
44	return os.environ.get(self.as_envvar(), "")	4✔
45
46
47	class NitpickFlag(_FlagMixin, Enum):	4✔
48	"""Flags to be used with the CLI."""
49
50	OFFLINE = "Offline mode: no style will be downloaded (no HTTP requests at all)"	4✔
51
52
53	@click.command()	4✔
54	@click.option(	4✔
55	"--project",
56	"-p",
57	"project_root",
58	type=click.Path(exists=True, dir_okay=True, file_okay=False, resolve_path=True),
59	help="Path to project root",
60	)
61	@click.option(	4✔
62	f"--{NitpickFlag.OFFLINE.name.lower()}", # pylint: disable=no-member
63	is_flag=True,
64	default=False,
65	help=NitpickFlag.OFFLINE.value,
66	)
67	@click.option(	4✔
68	"--check",
69	"-c",
70	is_flag=True,
71	default=False,
72	help="Don't modify the configuration files, just print the difference."
73	" Return code 0 means nothing would change. Return code 1 means some files would be modified.",
74	)
75	@click.option("--verbose", "-v", is_flag=True, default=False, help="Verbose logging")	4✔
76	def nitpick_cli(project_root: Path = None, offline=False, check=False, verbose=False):	4✔
77	"""Enforce the same configuration across multiple projects."""
78	if verbose:	×
79	logger.enable(PROJECT_NAME)	×
80
81	if not check:	×
82	logger.warning("Apply mode is not yet implemented; running a check instead")	×
83
84	nit = Nitpick.singleton().init(project_root, offline)	×
85
NEW 86	for err in chain(nit.project.merge_styles(offline), nit.enforce_present_absent(), nit.enforce_style()):	×
87	click.echo(f"{ERROR_PREFIX}{err.number:03} {err.message}{err.suggestion}")	×
88
UNCOV 89	click.secho("All done! ✨ 🍰 ✨", fg="bright_white")	×
90	# FIXME[AA]: add a CLI test with one error and the expected stdout results

andreoliwa / nitpick / 1141

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