Bring back https://github.com/datalad/datasalad/pull/63 #66
Conversation
This file contains hidden or 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
In the DataLad world `CommandError` was traditionally a `RuntimeError`. Whether or not that makes sense in the general case, one can have different opinions about. The rest of the world is using `subprocess.CalledProcessError`. This exception type is very similar to `CommandError` in the properties that it can capture. It is only missing the CWD info, and the context message that comes with `RuntimeError` (see class docs). This change connects the two worlds, by inheriting from both `RuntimeError` and `CalledProcessError`, and using the properties of both, where possible. The behavior of `CommandError` remains unchanged, but it will now also work with code that expects a `subprocess` exception. Previously it was possible to not provide a return code when instantiating the exception. This is not supported by ``CalledProcessError``. The behavior of ``CommandError`` of not requiring a returncode is maintained (whether or not that makes sense). In order to satisfy ``CalledProcessError`` as special ``CommandError.UNKNOWN_RETURNCODE`` value is introduced as the new default. It is set to 32767, a value that should not occur in actual use.
This helps to homogenize the rendered documentation.
This adopts the Google docstring conventions (without duplication of type annotations in the docstring). For now this is a trials (not amending the contributing guidelines yet).
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #66 +/- ##
==========================================
- Coverage 98.39% 98.33% -0.07%
==========================================
Files 36 36
Lines 1435 1440 +5
Branches 130 131 +1
==========================================
+ Hits 1412 1416 +4
Misses 12 12
- Partials 11 12 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.