Fix siblings crash with missing --name
#3555
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kyleam
reviewed
Jul 24, 2019
The fix looks good to me. It applies cleanly to 0.11.x, so ideally it'd go there.
datalad/distribution/siblings.py
Outdated
| default. This option can be used to limit 'query' to a specific | ||
| sibling.""", | ||
| doc="""name of the sibling. For sibling removal and addition | ||
| with path "URLs" this option is mandatory, otherwise the hostname |
There was a problem hiding this comment.
The reader would have to infer whether 'with path "URLs" 'applies to just addition or both addition and removal. You could avoid this ambiguity if you move 'addition with path "URLs"' before "sibling removal".
There was a problem hiding this comment.
Dear @kyleam -- could you please do what needs to be done (rebase on 0.11.x, adjust docstring here) so we could have this one merged ?
There was a problem hiding this comment.
Done
range-diff
1: 3b708139b = 1: d9321778e RF: Modernize imports
2: 474415ba9 ! 2: b186b1427 BF+TST: Don't crash with missing arg (fixes gh-3553)
@@ -13,8 +13,8 @@
- mandatory, otherwise the hostname part of a given URL is used as a
- default. This option can be used to limit 'query' to a specific
- sibling.""",
-+ doc="""name of the sibling. For sibling removal and addition
-+ with path "URLs" this option is mandatory, otherwise the hostname
++ doc="""name of the sibling. For addition with path "URLs" and
++ sibling removal this option is mandatory, otherwise the hostname
+ part of a given URL is used as a default. This option can be used
+ to limit 'query' to a specific sibling.""",
constraints=EnsureStr() | EnsureNone()),
Codecov Report
@@ Coverage Diff @@
## 0.11.x #3555 +/- ##
=========================================
Coverage ? 82.99%
=========================================
Files ? 272
Lines ? 35159
Branches ? 0
=========================================
Hits ? 29181
Misses ? 5978
Partials ? 0
Continue to review full report at Codecov.
|
kyleam
added a commit
that referenced
this issue
Aug 2, 2019
yarikoptic
added a commit
that referenced
this issue
Sep 6, 2019
0.11.7 (Sep 02, 2019) -- python2-we-still-love-you-but-...
Primarily bugfixes with some optimizations and refactorings.
Fixes
- [addurls][]
- now provides better handling when the URL file isn't in the
expected format. ([#3579][])
- always considered a relative file for the URL file argument as
relative to the current working directory, which goes against the
convention used by other commands of taking relative paths as
relative to the dataset argument. ([#3582][])
- [run-procedure][]
- hard coded "python" when formatting the command for non-executable
procedures ending with ".py". `sys.executable` is now used.
([#3624][])
- failed if arguments needed more complicated quoting than simply
surrounding the value with double quotes. This has been resolved
for systems that support `shlex.quote`, but note that on Windows
values are left unquoted. ([#3626][])
- [siblings][] now displays an informative error message if a local
path is given to `--url` but `--name` isn't specified. ([#3555][])
- [sshrun][], the command DataLad uses for `GIT_SSH_COMMAND`, didn't
support all the parameters that Git expects it to. ([#3616][])
- Fixed a number of Unicode py2-compatibility issues. ([#3597][])
Enhancements and new features
- The [annotate-paths][] helper now caches subdatasets it has seen to
avoid unnecessary calls. ([#3570][])
- A repeated configuration query has been dropped from the handling of
`--proc-pre` and `--proc-post`. ([#3576][])
- Calls to `git annex find` now use `--in=.` instead of the alias
`--in=here` to take advantage of an optimization that git-annex (as
of the current release, 7.20190730) applies only to the
former. ([#3574][])
- [addurls][] now suggests close matches when the URL or file format
contains an unknown field. ([#3594][])
- Shared logic used in the setup.py files of Datalad and its
extensions has been moved to modules in the _datalad_build_support/
directory. ([#3600][])
- Get ready for upcoming git-annex dropping support for direct mode
([#3631][])
* tag '0.11.7': (87 commits)
DOC: Added an entry to changelogn on merged 3631
ENH: finalizing changelog for 0.11.7
TST: Update tests for a git-annex without direct mode
TST: utils: Add decorator that skips when direct mode is unsupported
ENH: annexrepo: Refuse to initialize in direct mode if unsupported
ENH: annexrepo: Add check_direct_mode_support method
BF+TST: Avoid leaking patched git-annex version
TST+RF: test_annexrepo: Split up a test
CHANGELOG.md: Second batch for 0.11.7
TST: run_procedure: Mark test_spaces() as known Windows failure
TST: run_procedure: Mark test_quoting as known windows failure
TST: run_procedure: Test more arguments that need quoting
BF(py2): run_procedure: Avoid encoding error in log message
TST: add run_procedure test with spaces in file name
TST/RF: non-hardcoded Python executable
RF: newline at end of file
RF: helper instead of conditional
RF: remove superfluous imports
BF/TST: remove quoting
ENH: replace conditionals with helper function
...
yarikoptic
added a commit
that referenced
this issue
Sep 6, 2019
0.11.7 (Sep 02, 2019) -- python2-we-still-love-you-but-...
Primarily bugfixes with some optimizations and refactorings.
Fixes
- [addurls][]
- now provides better handling when the URL file isn't in the
expected format. ([#3579][])
- always considered a relative file for the URL file argument as
relative to the current working directory, which goes against the
convention used by other commands of taking relative paths as
relative to the dataset argument. ([#3582][])
- [run-procedure][]
- hard coded "python" when formatting the command for non-executable
procedures ending with ".py". `sys.executable` is now used.
([#3624][])
- failed if arguments needed more complicated quoting than simply
surrounding the value with double quotes. This has been resolved
for systems that support `shlex.quote`, but note that on Windows
values are left unquoted. ([#3626][])
- [siblings][] now displays an informative error message if a local
path is given to `--url` but `--name` isn't specified. ([#3555][])
- [sshrun][], the command DataLad uses for `GIT_SSH_COMMAND`, didn't
support all the parameters that Git expects it to. ([#3616][])
- Fixed a number of Unicode py2-compatibility issues. ([#3597][])
- [download-url][] now will create leading directories of the output path
if they do not exist ([#3646][])
Enhancements and new features
- The [annotate-paths][] helper now caches subdatasets it has seen to
avoid unnecessary calls. ([#3570][])
- A repeated configuration query has been dropped from the handling of
`--proc-pre` and `--proc-post`. ([#3576][])
- Calls to `git annex find` now use `--in=.` instead of the alias
`--in=here` to take advantage of an optimization that git-annex (as
of the current release, 7.20190730) applies only to the
former. ([#3574][])
- [addurls][] now suggests close matches when the URL or file format
contains an unknown field. ([#3594][])
- Shared logic used in the setup.py files of Datalad and its
extensions has been moved to modules in the _datalad_build_support/
directory. ([#3600][])
- Get ready for upcoming git-annex dropping support for direct mode
([#3631][])
* tag '0.11.7':
Changelog entry for download-url paths handling
ENH: downloaders: Ensure directories for target exist
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #3553
Plus bonus reformatting of imports.