def test_run_linter_non_worktree():
"""``run_linter()`` doesn't support linting commits, only the worktree"""
with pytest.raises(NotImplementedError):
linting.run_linter(
"dummy-linter",
Path("/dummy"),
{Path("dummy.py")},
RevisionRange.parse("..HEAD"),
)
def test_revisionrange_parse_pre_commit(environ, expect_rev1, expect_rev2,
expect_use_common_ancestor):
"""RevisionRange.parse(':PRE-COMMIT:') gets the range from environment variables"""
with patch.dict(os.environ, environ):
result = RevisionRange.parse(":PRE-COMMIT:")
assert result.rev1 == expect_rev1
assert result.rev2 == expect_rev2
assert result.use_common_ancestor == expect_use_common_ancestor
def test_git_get_modified_files_revision_range(_description, branched_repo,
revrange, expect):
"""Test for :func:`darker.git.git_get_modified_files` with a revision range"""
result = git_get_modified_files(
[Path(branched_repo.root)],
RevisionRange.parse(revrange),
Path(branched_repo.root),
)
assert {path.name for path in result} == expect
def main(argv: List[str] = None) -> int:
"""Parse the command line and apply black formatting for each source file
:param argv: The command line arguments to the ``darker`` command
:return: 1 if the ``--check`` argument was provided and at least one file was (or
should be) reformatted; 0 otherwise.
"""
if argv is None:
argv = sys.argv[1:]
args, config, config_nondefault = parse_command_line(argv)
logging.basicConfig(level=args.log_level)
if args.log_level == logging.INFO:
formatter = logging.Formatter("%(levelname)s: %(message)s")
logging.getLogger().handlers[0].setFormatter(formatter)
# Make sure we don't get excessive debug log output from Black
logging.getLogger("blib2to3.pgen2.driver").setLevel(logging.WARNING)
if args.log_level <= logging.DEBUG:
print("\n# Effective configuration:\n")
print(dump_config(config))
print("\n# Configuration options which differ from defaults:\n")
print(dump_config(config_nondefault))
print("\n")
if args.isort and not isort:
logger.error(f"{ISORT_INSTRUCTION} to use the `--isort` option.")
exit(1)
black_args = BlackArgs()
if args.config:
black_args["config"] = args.config
if args.line_length:
black_args["line_length"] = args.line_length
if args.skip_string_normalization is not None:
black_args["skip_string_normalization"] = args.skip_string_normalization
paths = {Path(p) for p in args.src}
some_files_changed = False
revrange = RevisionRange.parse(args.revision)
for path, old, new in format_edited_parts(
paths, revrange, args.isort, args.lint, black_args
):
some_files_changed = True
if args.diff:
print_diff(path, old, new)
if not args.check and not args.diff:
modify_file(path, new)
return 1 if args.check and some_files_changed else 0
def main(argv: List[str] = None) -> int:
"""Parse the command line and reformat and optionally lint each source file
1. run isort on each edited file (optional)
2. diff the given revision and worktree (optionally with isort modifications) for
all file & dir paths on the command line
3. extract line numbers in each edited to-file for changed lines
4. run black on the contents of each edited to-file
5. get a diff between the edited to-file and the reformatted content
6. convert the diff into chunks, keeping original and reformatted content for each
chunk
7. choose reformatted content for each chunk if there were any changed lines inside
the chunk in the edited to-file, or choose the chunk's original contents if no
edits were done in that chunk
8. verify that the resulting reformatted source code parses to an identical AST as
the original edited to-file
9. write the reformatted source back to the original file
10. run linter subprocesses for all edited files (10.-13. optional)
11. diff the given revision and worktree (after isort and Black reformatting) for
each file reported by a linter
12. extract line numbers in each file reported by a linter for changed lines
13. print only linter error lines which fall on changed lines
:param argv: The command line arguments to the ``darker`` command
:return: 1 if the ``--check`` argument was provided and at least one file was (or
should be) reformatted; 0 otherwise.
"""
if argv is None:
argv = sys.argv[1:]
args, config, config_nondefault = parse_command_line(argv)
logging.basicConfig(level=args.log_level)
if args.log_level == logging.INFO:
formatter = logging.Formatter("%(levelname)s: %(message)s")
logging.getLogger().handlers[0].setFormatter(formatter)
# Make sure we don't get excessive debug log output from Black
logging.getLogger("blib2to3.pgen2.driver").setLevel(logging.WARNING)
if args.log_level <= logging.DEBUG:
print("\n# Effective configuration:\n")
print(dump_config(config))
print("\n# Configuration options which differ from defaults:\n")
print(dump_config(config_nondefault))
print("\n")
if args.isort and not isort:
logger.error(f"{ISORT_INSTRUCTION} to use the `--isort` option.")
exit(1)
black_args = BlackArgs()
if args.config:
black_args["config"] = args.config
if args.line_length:
black_args["line_length"] = args.line_length
if args.skip_string_normalization is not None:
black_args[
"skip_string_normalization"] = args.skip_string_normalization
paths = {Path(p) for p in args.src}
git_root = get_common_root(paths)
failures_on_modified_lines = False
revrange = RevisionRange.parse(args.revision)
changed_files = git_get_modified_files(paths, revrange, git_root)
for path, old, new in format_edited_parts(git_root, changed_files,
revrange, args.isort,
black_args):
failures_on_modified_lines = True
if args.diff:
print_diff(path, old, new)
if not args.check and not args.diff:
modify_file(path, new)
if run_linters(args.lint, git_root, changed_files, revrange):
failures_on_modified_lines = True
return 1 if args.check and failures_on_modified_lines else 0
def test_revisionrange_parse(revision_range, expect):
"""Test for :meth:`RevisionRange.parse`"""
revrange = RevisionRange.parse(revision_range)
assert (revrange.rev1, revrange.rev2,
revrange.use_common_ancestor) == expect
