Support ArgumentParser.fromfile_prefix_chars#91
Open
lehmannro wants to merge 4 commits intosphinx-doc:mainfrom
Open
Support ArgumentParser.fromfile_prefix_chars#91lehmannro wants to merge 4 commits intosphinx-doc:mainfrom
ArgumentParser.fromfile_prefix_chars#91lehmannro wants to merge 4 commits intosphinx-doc:mainfrom
Conversation
`argparse.ArgumentParser(fromfile_prefix_chars)` allows specifying a filename prefixed by any of the characters included in the string. `fromfile_prefix_chars='@'` means `@file.txt` is interpreted not as a regular positional argument, but as an instruction to read `file.txt` for additional arguments (positional or named.) For now, only the first character in the string is documented such that the usage instructions don't get overloaded.
Add a separate paragraph *iff* `fromfile_prefix_chars` was more than one character to enumerate all possible prefixes.
Linter fixes by `ruff`.
Linter fixes by `ruff format`.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #91 +/- ##
==========================================
+ Coverage 50.19% 50.65% +0.45%
==========================================
Files 18 18
Lines 1289 1301 +12
Branches 262 265 +3
==========================================
+ Hits 647 659 +12
Misses 598 598
Partials 44 44
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
ArgumentParser.fromfile_prefix_charsallows specifying a filename to read additional parameters from. For example, whenfromfile_prefix_chars="@", calling<command> @file.txtwill readfile.txtfor more parameters.This change adds
[@file]to the usage line (or whichever character was configured first.) If there is more than one prefix character configured, there's also a text paragraph added to document all of them.