Skip to content
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.

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

dvcignore: api to unhide subrepos directory #4324

Merged
merged 2 commits into from Aug 10, 2020

Conversation

skshetry
Copy link
Member

@skshetry skshetry commented Aug 3, 2020

Thank you for the contribution - we'll try to review it as soon as possible. πŸ™

Part of #3369

I implemented this inside dvcignore, and it
should not require "internal" APIs hack as we discussed before.

Right now, ignore_subrepos will only work for the paths of subrepo,
not anything inside it. And the API user is more or less only
RepoTree, so should be safe (we switch DvcTree and repo.tree based
on path prefixes, so this is only required during walk, so as it
shows the repo that were previously dvcignored and so that we could
switch the trees later during walk.

So, if dir is dir -> repo
So, tree.walk("dir") will return [],
whereas tree.walk("dir", ignore_subrepos=False) will return ["repo"]
But, successive walk will just return ("repo", [], []), and could
just be ignored as a side-effect.

@skshetry skshetry requested a review from efiop August 3, 2020 13:14
@skshetry skshetry self-assigned this Aug 3, 2020
@skshetry skshetry added this to In progress in DVC 28 July - 11 August 2020 via automation Aug 3, 2020
@skshetry skshetry moved this from In progress to Review in progress in DVC 28 July - 11 August 2020 Aug 3, 2020
@skshetry skshetry marked this pull request as draft August 3, 2020 13:39
dvc/ignore.py Outdated Show resolved Hide resolved
dvc/ignore.py Outdated Show resolved Hide resolved
@@ -222,7 +240,8 @@ def _update(self, dirname):
def _update_sub_repo(self, root, dirs):
for d in dirs:
if self._is_dvc_repo(root, d):
new_pattern = DvcIgnorePatterns(["/{}/".format(d)], root)
self._ignored_subrepos.add(f"{root}{os.sep}{d}")
new_pattern = DvcIgnorePatterns([f"/{d}/"], root)
Copy link
Member

Choose a reason for hiding this comment

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

I know that fstrings are better than format() , but there wasn't really a reason to change it in this PR πŸ™‚

Copy link
Member Author

Choose a reason for hiding this comment

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

I had to change that before when I was experimenting with it. And, f-string is easy to read and understand (here, speed does not matter but could have been another reason), and therefore, I kept it.

dvc/ignore.py Outdated Show resolved Hide resolved
dvc/ignore.py Show resolved Hide resolved
I implemented this inside dvcignore, and it
should not require "internal" APIs hack as we discussed before.

Right now, `ignore_subrepos` will only work for the paths of subrepo,
not anything inside it. And the API user is more or less only
RepoTree, so should be safe (we switch DvcTree and repo.tree based
on path prefixes, so this is only required during `walk`, so as it
shows the repo that were previously dvcignored and so that we could
switch the trees later during walk.

So, if dir is `dir -> repo`
So, `tree.walk("dir")` will return `[]`,
whereas `tree.walk("dir", ignore_subrepos=False)` will return `["repo"]`
But, successive walk will just return `("repo", [], [])`, and could
just be ignored as a side-effect.
@skshetry skshetry marked this pull request as ready for review August 6, 2020 15:03
@skshetry skshetry changed the title Track ignored subrepos by dvcignore dvcignore: api to unhide subrepos directory Aug 6, 2020
@efiop efiop merged commit 8d1934d into iterative:master Aug 10, 2020
DVC 28 July - 11 August 2020 automation moved this from Review in progress to Done Aug 10, 2020
@skshetry skshetry deleted the track-subrepos-dvcignore branch August 10, 2020 07:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants