SarahPythonista
8784d3300e
Fix error in argparse documentation example (GH-17399)
...
Automerge-Triggered-By: @rhettinger
2020-08-28 11:47:58 -07:00
Vincent Férotin
344c2a75c1
bpo-41024: doc: Explicitly mention use of 'enum.Enum' as a valid container for '… (GH-20964)
...
…choices' argument of 'argparse.ArgumentParser.add_argument'.
Here's a short first proposal of doc. enhancement addressing [bpo-41024]().
Automerge-Triggered-By: @csabella
2020-06-20 05:55:05 -07:00
Albert
59f5022b5d
bpo-17050: Remove documentation on argparse.REMAINDER (GH-18661)
...
Closes [Issue 17050]() by removing argparse.REMAINDER from the documentation, as discussed on the issue.
Automerge-Triggered-By: @rhettinger
2020-05-24 11:57:40 -07:00
Raymond Hettinger
04c79d6088
bpo-38678: Improve argparse example in tutorial (GH-17207)
2019-11-17 22:06:19 -08:00
Brandt Bucher
a0ed99bca8
bpo-38438: Simplify argparse "star nargs" usage. (GH-17106)
2019-11-11 12:47:48 -08:00
Batuhan Taşkaya
74142078b3
bpo-38531: document extend action's added version (GH-16865)
2019-10-20 13:13:54 -07:00
Adam J. Stewart
9e71917e02
bpo-26510: Add versionchanged for required arg of add_subparsers (GH-16588)
...
The `required` argument to `argparse.add_subparsers` was added in #3027 . This PR specifies the earliest version of Python where it is available.
https://bugs.python.org/issue26510
Automerge-Triggered-By: @merwok
2019-10-06 19:08:48 -07:00
Rémi Lapeyre
6a517c6749
bpo-8538: Add support for boolean actions to argparse (GH-11478)
...
Co-Authored-By: remilapeyre <remi.lapeyre@henki.fr>
2019-09-13 11:17:43 +01:00
Hai Shi
b1a2abdb06
bpo-37908: Add an example of ArgumentParser.exit() (GH-15455)
...
Co-Authored-By: Brandt Bucher <brandtbucher@gmail.com>
2019-09-12 16:34:24 +01:00
Hai Shi
f545638b57
bpo-9938: Add optional keyword argument exit_on_error to argparse.ArgumentParser (GH-15362)
...
Co-Authored-by: Xuanji Li <xuanji@gmail.com>
https://bugs.python.org/issue9938
Automerge-Triggered-By: @matrixise
2019-09-12 03:56:05 -07:00
Raymond Hettinger
84125fed2a
bpo-16468: Clarify which objects can be passed to "choices" in argparse (GH-15566)
2019-08-29 00:58:08 -07:00
Zac Hatfield-Dodds
dffca9e925
bpo-26967: fix flag grouping with allow_abbrev=False (GH-14316)
...
The `allow_abbrev` option for ArgumentParser is documented and intended to disable support for unique prefixes of --options, which may sometimes be ambiguous due to deferred parsing.
However, the initial implementation also broke parsing of grouped short flags, such as `-ab` meaning `-a -b` (or `-a=b`). Checking the argument for a leading `--` before rejecting it fixes this.
This was prompted by pytest-dev/pytest#5469 , so a backport to at least 3.8 would be great 😄
And this is my first PR to CPython, so please let me know if I've missed anything!
https://bugs.python.org/issue26967
2019-07-13 22:35:58 -07:00
Batuhan Taşkaya
aa32a7e111
bpo-23378: Add an extend action to argparse (GH-13305)
...
Add an extend action to argparse
https://bugs.python.org/issue23378
2019-05-21 10:47:42 -07:00
Serhiy Storchaka
913876d824
bpo-35054: Add yet more index entries for symbols. (GH-10121)
2018-10-28 13:41:26 +02:00
Anthony Sottile
cc18258daf
Fix doc for `add_subparsers` arguments (GH-8884)
...
There was a missing comma.
2018-08-23 20:08:54 -07:00
Ned Deily
8ebf5ceb0f
bpo-33109: argparse subparsers are once again not required by default (GH-6919)
...
bpo-26510 in 3.7.0a2 changed the behavior of argparse to make
subparsers required by default, returning to the behavior of 2.7
and 3.2. The behavior was changed in 3.3 to be no longer required.
While it might make more sense to have the default to required,
compatibility with 3.3 through 3.6 is probably less disruptive
than trying to reintroduce compatibility with 2.7 at this point.
This change restores the 3.6 behavior.
2018-05-23 21:55:15 -04:00
suic86
04e8293465
Fix error messages in argparse examples (GH-6435)
...
The examples in argparse documentation use `error: too few arguments`
error message which was removed in this commit f97c59a
in 2011.
2018-04-11 13:45:04 -05:00
Julien Palard
78553138be
Fix typos '.::' should typically just be '::'. (GH-6165)
2018-03-28 23:14:15 +02:00
Anthony Sottile
aaf6fc0982
bpo-26510: make argparse subparsers required by default ( #3027 )
...
This fixes a regression from Python 2. To get optional subparsers,
use the new parameter ``add_subparsers(required=False)``.
Patch by Anthony Sottile.
2017-09-20 17:35:27 -04:00
Elena Oat
397c467c49
bpo-31330: Clarify that RawTextHelpFormatter collapses repeated newlines. ( #3272 )
...
Also provide a solution if the user wants to keep multiple blank lines.
2017-09-07 16:06:45 -04:00
R. David Murray
0f6b9d2306
bpo-14191 Add parse_intermixed_args. ( #3319 )
...
This adds support for parsing a command line where options and positionals are intermixed as is common in many unix commands. This is paul.j3's patch with a few tweaks.
2017-09-06 20:25:40 -04:00
R. David Murray
0c7983e4ad
Clarify nature of parse_args 'args' argument. ( #3292 )
...
Patch by Paul.j3. Includes an unrelated but useful addition to the
optparse porting section.
2017-09-04 16:17:26 -04:00
Martin Panter
536d70ed33
Fix grammar, typos and markup in documentation and code comments
...
* Indent versionchanged at method level, not class level
* Mark up ``--help`` to avoid generating an en dash
* Use forward slash in Unix command line with a dollar sign ($) prompt
2017-01-14 08:23:08 +00:00
Serhiy Storchaka
ecf41da83e
Issue #19795 : Mark up None as literal text.
2016-10-19 16:29:26 +03:00
Berker Peksag
5493e4723a
Issue #28455 : Clarify example of overriding the convert_arg_line_to_args method
...
Patch by Mariatta Wijaya.
2016-10-17 06:14:17 +03:00
Martin Panter
0f0eac431f
Issue #27993 : Fix problems with plural objects in docs and comments
2016-09-07 11:04:41 +00:00
Martin Panter
1050d2d0c7
Issue #26462 : Doc: reduce literal_block warnings, fix syntax highlighting.
...
Patch by Julien Palard.
2016-07-26 11:18:21 +02:00
Terry Jan Reedy
fa089b9b0b
Issue #22558 : Add remaining doc links to source code for Python-coded modules.
...
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
Serhiy Storchaka
dba903993a
Issue #23921 : Standardized documentation whitespace formatting.
...
Original patch by James Edwards.
2016-05-10 12:01:23 +03:00
Martin Panter
f5e60480b9
Issue #20598 : Replace trivial split() calls with lists in argparse docs
2016-04-26 11:41:25 +00:00
Martin Panter
119e502277
Fix typos in code comments and documentation
2016-04-16 09:28:57 +00:00
Martin Panter
b4912b8ed3
Issue #25314 : Remove confused statement about const argument
2016-04-09 03:49:48 +00:00
Raymond Hettinger
f9cddccf8c
Issue #25314 : store_true and store_false also create appropriate defaults.
2011-11-20 11:05:23 -08:00
Martin Panter
d2ad5718ad
Issue #25523 : Further a-to-an corrections new in 3.5
2015-11-02 04:20:33 +00:00
Martin Panter
84835ab1cb
Issue #25161 : Merge full stops from 3.4 into 3.5
2015-10-10 10:44:25 +00:00
Martin Panter
d21e0b52f1
Issue #25161 : Add full stops in documentation; patch by Takase Arihiro
2015-10-10 10:36:22 +00:00
Senthil Kumaran
b4760efbad
Back porting changeset db302b88fdb6 to 3.4 branch, which fixed multiple documentation typos.
...
Related Issues:
#issue21528
#issue24453
2015-06-14 17:35:37 -07:00
Berker Peksag
a7edf1e57c
Issue #23356 : Simplify convert_arg_line_to_args example.
...
Patch by py.user.
2015-04-26 12:10:27 +03:00
Berker Peksag
8c99a6d604
Issue #23356 : Simplify convert_arg_line_to_args example.
...
Patch by py.user.
2015-04-26 12:09:54 +03:00
Berker Peksag
e7e497bdca
Issue #23651 : Fix typo in allow_abbrev docs.
...
Noticed by Nathan West.
2015-03-12 20:47:41 +02:00
Berker Peksag
8089cd642f
Issue #14910 : Add allow_abbrev parameter to argparse.ArgumentParser.
...
Patch by Jonathan Paugh, Steven Bethard, paul j3 and Daniel Eriksson.
2015-02-14 01:39:17 +02:00
Berker Peksag
7b6b3d771a
Issue #22317 : Document the action parameter in ArgumentParser.add_subparsers() docs.
...
Patch by Mike Short.
2015-01-20 06:46:49 +02:00
Berker Peksag
5a494f6ad8
Issue #22317 : Document the action parameter in ArgumentParser.add_subparsers() docs.
...
Patch by Mike Short.
2015-01-20 06:45:53 +02:00
Berker Peksag
131caba074
Revert #22251
2014-09-28 00:01:55 +03:00
Berker Peksag
9c1dba2758
Revert #22251
2014-09-28 00:00:58 +03:00
Berker Peksag
f7fee33104
Issue #22251 : Fix ReST markup to avoid errors building docs.
2014-09-27 23:22:35 +03:00
Berker Peksag
3749404ba5
Issue #22251 : Fix ReST markup to avoid errors building docs.
2014-09-27 23:21:35 +03:00
Berker Peksag
4f6355f861
Issue #17462 : Add a paragraph about advantages of argparse over optparse.
...
Patch by Anastasia Filatova.
2014-09-26 15:35:02 +03:00
Berker Peksag
6c1f0ad665
Issue #17462 : Add a paragraph about advantages of argparse over optparse.
...
Patch by Anastasia Filatova.
2014-09-26 15:34:26 +03:00
Terry Jan Reedy
fa6e73bac9
Merge with 3.4
2014-08-23 22:22:07 -04:00
Terry Jan Reedy
ee55826072
Issue #13540 : add missing markup.
2014-08-23 22:21:47 -04:00
Raymond Hettinger
2b24884f18
merge
2014-08-03 23:44:59 -07:00
Raymond Hettinger
c0de59bfc3
Fix markup.
2014-08-03 23:44:30 -07:00
Jason R. Coombs
1ab3dc92f2
Issue #13540 : Merge changes from 3.4
2014-08-03 15:27:18 -04:00
Jason R. Coombs
b3d4c212f7
Issue #13540 : Merge changes from 3.3
2014-08-03 15:26:58 -04:00
Jason R. Coombs
89e186f24e
Issue #13540 : Merge changes from 3.2
2014-08-03 15:26:32 -04:00
Jason R. Coombs
79690ac1d0
Issue #13540 : Update references to Action class to match syntax used for other classes in this file.
2014-08-03 14:54:11 -04:00
Jason R. Coombs
eb0ef415d5
Issue #13540 : Removed redundant documentation about Action instance attributes. Updated example and documentation per recommendations by Steven Bethard in msg149524.
2014-07-20 10:52:46 -04:00
Donald Stufft
8b852f111e
Fix Issue #21528 - Fix documentation typos
2014-05-20 12:58:38 -04:00
R David Murray
fced3ec2db
whatsnew: argparse FileType accepts errors and encodings args.
2013-12-31 11:18:01 -05:00
Eli Bendersky
b55c4d4539
Issue #19814 : Clarify argparse's docs w.r.t prefix matching
2013-12-02 05:50:48 -08:00
Eli Bendersky
f3114532e4
Issue #19814 : Clarify argparse's docs w.r.t prefix matching
2013-12-02 05:49:54 -08:00
Georg Brandl
fd11551710
merge with 3.3
2013-10-06 19:34:19 +02:00
Georg Brandl
29fc4bf5c7
Use the platform-independent way of calling a script from the shell: "python prog.py", not "prog.py"
...
Found by Micheal Wells on docs@.
2013-10-06 19:33:56 +02:00
Georg Brandl
94c1467bad
merge with 3.3
2013-10-06 18:57:02 +02:00
Georg Brandl
fc9a113418
Closes #11807 : document argparse add_subparsers method better.
...
Patch by Filip Gruszczyński.
2013-10-06 18:51:39 +02:00
Georg Brandl
7caabe09aa
merge with 3.3
2013-10-06 13:10:06 +02:00
Georg Brandl
ed86ff868a
Fix missing class name in markup. Found by Tanky Woo on docs@.
2013-10-06 13:09:59 +02:00
Georg Brandl
d1830c422d
merge with 3.3
2013-10-06 09:50:49 +02:00
Georg Brandl
d2914ce0f7
Fix prefix_chars not being applied in help text example (reported by John Kooker on docs@)
2013-10-06 09:50:36 +02:00
Andrew Svetlov
5cd72b7b9c
Update argparse docs to follow order of ArgumentParser() arguments.
2013-04-07 14:44:34 +03:00
Andrew Svetlov
5b6e1cad37
Update argparse docs to follow order of ArgumentParser() arguments.
2013-04-07 14:43:17 +03:00
Ezio Melotti
e6f3d53138
#16940 : merge with 3.3.
2013-01-12 10:40:49 +02:00
Ezio Melotti
9895ab463b
#16940 : merge with 3.2.
2013-01-12 10:40:24 +02:00
Ezio Melotti
7128e073e2
#16940 : fix indentation in example.
2013-01-12 10:39:45 +02:00
Chris Jerdonek
eb9e885f78
Issue #16933 (merge from 3.3): Improve choices examples in argparse docs.
2013-01-11 19:29:43 -08:00
Chris Jerdonek
71e39fb484
Issue #16933 (merge from 3.2): Improve choices examples in argparse docs.
2013-01-11 19:28:05 -08:00
Chris Jerdonek
174ef67b56
Issue #16933 (2.7 forward-port): Improve choices examples in argparse docs.
2013-01-11 19:26:44 -08:00
Sandro Tosi
ba8279f252
merge with 3.3
2013-01-11 10:49:43 +01:00
Sandro Tosi
a525fc161a
merge with 3.2
2013-01-11 10:49:28 +01:00
Sandro Tosi
32587fbb89
grammatical fix; thanks to Alex Rudnick from docs@
2013-01-11 10:49:00 +01:00
Ezio Melotti
774715cd81
#16796 : merge with 3.3.
2012-12-28 02:00:41 +02:00
Ezio Melotti
63ee149ca6
#16796 : merge with 3.2.
2012-12-28 02:00:22 +02:00
Ezio Melotti
52336f0b50
#16796 : fix typo. Patch by Michael Schurter.
2012-12-28 01:59:24 +02:00
Petri Lehtinen
74d6c250e1
#11175 : argparse.FileType now accepts encoding and errors arguments.
...
Patch by Lucas Maystre.
2012-12-15 22:42:47 +02:00
Andrew Svetlov
eff1738e01
Revert duplicate changes in argparse docs.
2012-11-28 19:24:31 +02:00
Andrew Svetlov
74120996f5
Revert duplicate changes in argparse docs.
2012-11-28 19:23:52 +02:00
Andrew Svetlov
51292fff3f
Merge issue #11076 : document the way to convert argparse.Namespace to a dict.
...
Initial patch by Virgil Dupras.
2012-11-28 19:18:09 +02:00
Andrew Svetlov
e15cb61dde
Issue #11076 : document the way to convert argparse.Namespace to a dict.
...
Initial patch by Virgil Dupras.
2012-11-28 19:17:26 +02:00
Barry Warsaw
d09a05ebc5
Merge 3.2 except the massive Misc/NEWS conflict, so hand apply the NEWS entry.
2012-09-25 10:47:55 -04:00
Barry Warsaw
1dedd0a4a4
- Issue #15935 : Clarification of argparse docs, re: add_argument() type and
...
default arguments. Patch contributed by Chris Jerdonek.
2012-09-25 10:37:58 -04:00
Ezio Melotti
8429b6784b
#15831 : merge with 3.2
2012-09-14 06:35:09 +03:00
Ezio Melotti
e0add76468
#15831 : document multiple signatures on different lines. Patch by Chris Jerdonek.
2012-09-14 06:32:35 +03:00
Sandro Tosi
effb43bc38
merge with 3.2
2012-08-12 10:49:40 +02:00
Sandro Tosi
ee903c5125
add missing parenthesis to 'action' argparse doc; thanks to kishkin from docs@
2012-08-12 10:49:26 +02:00
Senthil Kumaran
93e3d3ac09
merge from 3.2 - Issue13685
2012-06-26 14:18:19 +08:00
Senthil Kumaran
f21804ad61
Issue #13685 - Update argparse help message for % sign usage.
2012-06-26 14:17:19 +08:00
Ezio Melotti
df5bedbf88
#14034 : merge argparse tutorial from 3.2.
2012-05-06 16:34:43 +03:00
Ezio Melotti
6cc7a41c2f
#14034 : added the argparse tutorial. Patch by Tshepang Lekhonkhobe.
2012-05-06 16:15:35 +03:00
R David Murray
3288e948f3
Merge #10423 : clarify options vs args in argparse discussion of optparse
...
Patch by Sandro Tosi.
2012-03-30 18:08:29 -04:00