Skip to content

Fix config path handling across Windows drives #3690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
hansu650 wants to merge 1 commit into from
+24 −6
Closed

Fix config path handling across Windows drives #3690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions pre_commit/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,13 @@
}


def _relpath(path: str) -> str:
try:
return os.path.relpath(path)
except ValueError: # Windows paths on different drives.
return path


def _add_config_option(parser: argparse.ArgumentParser) -> None:
parser.add_argument(
'-c', '--config', default=C.CONFIG_FILE,
Expand Down Expand Up @@ -188,15 +195,13 @@ def _adjust_args_and_chdir(args: argparse.Namespace) -> None:
toplevel = git.get_root()
os.chdir(toplevel)

args.config = os.path.relpath(args.config)
args.config = _relpath(args.config)
if args.command in {'run', 'try-repo'}:
args.files = [os.path.relpath(filename) for filename in args.files]
args.files = [_relpath(filename) for filename in args.files]
if args.commit_msg_filename is not None:
args.commit_msg_filename = os.path.relpath(
args.commit_msg_filename,
)
args.commit_msg_filename = _relpath(args.commit_msg_filename)
if args.command == 'try-repo' and os.path.exists(args.repo):
args.repo = os.path.relpath(args.repo)
args.repo = _relpath(args.repo)


def main(argv: Sequence[str] | None = None) -> int:
Expand Down
13 changes: 13 additions & 0 deletions tests/main_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,19 @@ def test_adjust_args_and_chdir_non_relative_config(in_git_dir):
assert args.config == C.CONFIG_FILE


@pytest.mark.skipif(os.name != 'nt', reason='windows feature')
def test_adjust_args_and_chdir_config_on_different_drive(in_git_dir):
drive, _ = os.path.splitdrive(str(in_git_dir))
other_drive = 'Z:' if drive.upper() != 'Z:' else 'Y:'
config = other_drive + r'\cfg.yaml'

args = _args(config=config)
main._adjust_args_and_chdir(args)

assert os.getcwd() == in_git_dir
assert args.config == config


def test_adjust_args_try_repo_repo_relative(in_git_dir):
with in_git_dir.join('foo').ensure_dir().as_cwd():
args = _args(command='try-repo', repo='../foo', files=[])
Expand Down
Loading