fix(dvcfs): rename argument url
to repo
#10754
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See #10700 for the motivation.
β 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.
We need to rename the
url
to something else forfsspec.core.url_to_fs
to work for dvc urls withstorage_options
.We have two options to consider:
repo=
argument to accept bothstr
andRepo
instances, orurl=
to something else (preferablyrepo
), and introduce a new argument for acceptingRepo
instances.Most of the API in
dvc.api
already usesrepo=
(as astr
path to the DVC/Git repository, eg:dvc.api.open
anddvc.api.read
. So, I prefer the 1st option, as it will be a good opportunity to align naming and userepo=
consistently.But I am happy with either of the options.
Also note that accepting
Repo
instance is part of an internal API, and is done for avoiding cost of opening another DVC/Git repository.Related: