Skip to content

Ensure contains_symlink_up_to accept both str and Path-like objects #2740

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

Merged
merged 1 commit into from
Nov 5, 2019
Merged

Ensure contains_symlink_up_to accept both str and Path-like objects #2740

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
4 changes: 4 additions & 0 deletions dvc/utils/fs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from dvc.exceptions import DvcException
from dvc.system import System
from dvc.utils import dict_md5
from dvc.utils import fspath
from dvc.utils import fspath_py35
from dvc.utils import walk_files
from dvc.utils.compat import str
Expand Down Expand Up @@ -61,6 +62,9 @@ def __init__(self, path, base_path):


def contains_symlink_up_to(path, base_path):
base_path = fspath(base_path)
path = fspath(path)

if base_path not in path:
raise BasePathNotInCheckedPathException(path, base_path)

Expand Down
8 changes: 8 additions & 0 deletions tests/unit/utils/test_fs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,14 @@ def base_path_is_symlink(path):
):
self.assertFalse(contains_symlink_up_to(target_path, base_path))

def test_path_object_and_str_are_valid_arg_types(self):
base_path = "foo"
target_path = os.path.join(base_path, "bar")
self.assertFalse(contains_symlink_up_to(target_path, base_path))
self.assertFalse(
contains_symlink_up_to(PathInfo(target_path), PathInfo(base_path))
)
Copy link
Contributor

@efiop efiop Nov 5, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the record: Could also add a case for one str and one path_info, but the current one is good enough :)



@pytest.mark.parametrize(
"path1, path2",
Expand Down