addressing: allow stage name addressing without ":" #3842
Conversation
skshetry
changed the title
|
Looks like we'll have a problem when we have a output and stage of same name. At the moment, the priority is for stage name. I don't want to provide priority to outputs, as it really slows things down. Currently, there's no way to indicate that the file is an output, not a stage in case of collision. I know, it can happen very rarely, but it is still a problem that should be solved. $ ls
copy-foo-bar copy-foo-bar.dvc dvc.yaml dvc.lock
$ # dvc.yaml has stage with name `copy-foo-bar`
$ dvc checkout copy-foo-bar
A barThe workaround for now is: $ dvc checkout ./copy-foo-bar |
this is a good and clear workaround to my mind! |
skshetry
changed the title
Clear: yes, but workaround nonetheless. We are making a distinction But, as it should happen rarely, and in docs, we should suggest users to not |
| stats[key].extend( | ||
| _fspath_dir(path, self.root_dir) for path in items | ||
| ) | ||
| stats[key].extend(_fspath_dir(path) for path in items) |
There was a problem hiding this comment.
Before, the checkout summary were shown as path_in_repo. This should now actually show in terms of relpath.
Also remove `cause` when throwing NoOutputOrStage, as CheckoutErrorSuggestGit will start chaining all the messages in cause of the exception.
@skshetry That is genuinely a very good approach, which is also intuitive, kinda like with launching scripts on *nix. I really like it personally. |
dvc/repo/__init__.py
Outdated
| raise NoOutputOrStage(target, exc.file) | ||
| raise NoOutputOrStageError(target, exc.file) from exc | ||
| except StageNotFound as exc: | ||
| raise NoOutputOrStage(target, exc.file) | ||
| raise NoOutputOrStageError(target, exc.file) from exc |
There was a problem hiding this comment.
We concat message of every chain of exceptions. So, when we get CheckoutErrorSuggestGit,
we will get following error message:
$ dvc repro random_name
ERROR: Did you mean `git checkout random_name`?: 'random_name' does not exist as an output or a stage name in 'dvc.yaml': "Stage 'random_name' not found inside 'dvc.yaml' file"
So, I left it out, as context is anyway set if they are in try...except block.
There was a problem hiding this comment.
Alternative thing to do is only concat messages from 2 exceptions.
This PR enables users to run/work with stage via their name if they are in dvc.yaml file.
Example
There is a caveat though: what if the output and the stage name clashes?
Currently, there is no way to specify it is an output, but, there is way to indicate it's a stage via:
$ dvc commit :stage_name # or, $ dvc commit dvc.yaml:stage_nameThe only good workaround is:
❗ I have followed the Contributing to DVC checklist.
📖 If this PR requires documentation updates, I have created a separate PR (or issue, at least) in dvc.org and linked it here. If the CLI API is changed, I have updated tab completion scripts.
❌ I will check DeepSource, CodeClimate, and other sanity checks below. (We consider them recommendatory and don't expect everything to be addressed. Please fix things that actually improve code or fix bugs.)
Thank you for the contribution - we'll try to review it as soon as possible. 🙏