831b6de6d7
gh-126180: Remove getopt and optparse deprecation notices (GH-126227)
...
* Remove getopt and optparse deprecation notices
* Add new docs sections for command line app helper libraries
* Add guidance on choosing a CLI parsing library to the optparse docs
* Link to the new guidance from the argparse and getopt docs
* Reword intro in docs section for superseded stdlib modules
* Reframe the optparse->argparse guide as a migration guide
rather than as an upgrade guide
---------
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-12-23 14:17:19 +10:00
2104bde572
GH-127133: Remove ability to nest argument groups & mutually exclusive groups ( #127186 )
2024-11-24 15:20:37 +00:00
a13e94d84b
GH-127134: Add note about forward compatibility for suggest_on_error ( #127137 )
2024-11-22 19:18:18 -08:00
a5440d4a38
gh-86463: Fix a trailing space in argparse.rst ( #127162 )
2024-11-22 16:34:05 +00:00
0cb4d6c654
gh-86463: Fix default prog in subparsers if usage is used in the main parser (GH-125891)
...
The usage parameter of argparse.ArgumentParser no longer
affects the default value of the prog parameter in subparsers.
Previously the full custom usage of the main parser was used as
the prog prefix in subparsers.
2024-11-22 17:29:33 +02:00
fcfdb55465
GH-122679: Add `register()` to argparse docs ( #126939 )
...
* Add register() to argparse docs
* Add newline
* Formatting
* Fix codeblock
* Move section
* Add signature
* Add newline
* Fix indent
* Fix indent take 2
* Rephrase
* Simplify language
* Address PR comments
* Add references to register in type and action
* Remove unnecessary reference
* Rephrase and add success case
2024-11-21 16:36:11 -08:00
2ab377a47c
gh-126071: Improve formatting of the argparse documentation (GH-126073)
...
* Use appropriate roles for ArgumentParser, Action, etc.
* Remove superfluous repeated links.
* Explicitly document signatures and add index entries for some methods
and classes.
* Make it more clear that some parameters are keyword-only.
* Fix some minor errors.
2024-10-30 08:50:12 +00:00
da8673da36
gh-84545: Clarify the 'extend' action documentation in argparse (GH-125870)
2024-10-25 08:41:38 +00:00
834ba5aaf2
gh-58032: Deprecate the argparse.FileType type converter (GH-124664)
2024-10-23 10:50:29 +03:00
7b04496e5c
gh-125542: Deprecate prefix_chars in ArgumentParser.add_argument_group() (GH-125563)
2024-10-17 09:11:47 +00:00
624be8699a
GH-99749: Add optional feature to suggest correct names (ArgumentParser) (GH-124456)
2024-10-17 10:07:37 +03:00
c9826c11db
gh-89819: Add argument_default and conflict_handler to add_argument_group() docs (GH-125379)
2024-10-15 15:48:28 +00:00
07c2d15977
gh-85935: Explicitly document the case nargs=0 in argparse (GH-125302)
2024-10-12 11:53:00 +00:00
a6c0c64de0
gh-59330: Improve error message for dest= for positionals (GH-125215)
...
Also improve the documentation. Specify how dest and metavar are derived
from add_argument() positional arguments.
Co-authored-by: Simon Law <sfllaw@sfllaw.ca>
2024-10-12 14:46:28 +03:00
c1913effee
gh-125296: Fix strange fragment identifier for `name or flags` in argparse docs ( #125297 )
2024-10-11 09:30:27 +03:00
3b87fb74c9
Note argparse exit code in documentation (GH-119568)
...
Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
2024-10-10 20:56:05 +03:00
37228bd16e
GH-124478: Cleanup argparse documentation ( #124877 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2024-10-08 15:07:29 -07:00
04bfea2d26
gh-66436: Improved prog default value for argparse.ArgumentParser (GH-124799)
...
It can now have one of three forms:
* basename(argv0) -- for simple scripts
* python arv0 -- for directories, ZIP files, etc
* python -m module -- for imported modules
Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
2024-10-01 22:51:40 +03:00
f1a2417b9e
gh-61181: Fix support of choices with string value in argparse (GH-124578)
...
Substrings of the specified string no longer considered valid values.
2024-09-29 10:57:21 +03:00
4e2fb7bdf5
GH-58058: Add quick reference for `ArgumentParser` to argparse docs (gh-124227)
2024-09-25 15:22:17 -07:00
20ccda000b
GH-87358: Add clarification about nargs and default argparse behaviour ( #124094 )
2024-09-24 19:30:01 +03:00
e69ff34e81
gh-65169: Clarify prog default in argparse (GH-31602)
2024-09-24 10:57:37 +00:00
5f5c0b9c23
GH-79714: Add mention of stderr for clarity to ArgumentParser.exit() (GH-123932)
2024-09-23 12:08:03 +03:00
4e35dd607b
gh-83648: Use versionadded in 'deprecated' description (GH-121877)
2024-07-16 21:26:17 +00:00
bcb435ee8f
docs: module page titles should not start with a link to themselves ( #117099 )
2024-05-08 20:34:40 +01:00
cbe809dfa9
gh-83648: Add missing `deprecated` arg in argparse.rst (GH-115640)
2024-02-19 10:29:32 +02:00
bb57ffdb38
gh-83648: Support deprecation of options, arguments and subcommands in argparse (GH-114086)
2024-02-06 00:41:34 +02:00
1d7bddd961
Docs: align usage of versionadded/versionchanged with recommended practice ( #114409 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2024-01-22 21:40:26 +00:00
ab8f54668b
gh-103921: Rename "type" header in argparse docs ( #104654 )
...
This allows :keyword:`type` to link to docs for the new `type`
statement (being written in gh-104642) instead of to this header
in the argparse docs.
2023-05-19 06:50:34 -07:00
79ae019164
gh-101100: Fix Sphinx warnings in `argparse` module ( #103289 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-04-24 15:36:32 -06:00
f4d087964e
gh-103582: Remove last references to `argparse.REMAINDER` from docs ( #103586 )
2023-04-18 23:02:48 -06:00
061325e0d2
Fix style in argparse.rst ( #101733 )
2023-03-07 23:25:28 -08:00
6aab56f3c2
gh-99735: Use required=True in argparse subparsers example ( #100927 )
2023-02-18 17:06:03 -08:00
6e4a521c2a
Add missing preposition in argparse docs ( #101548 )
2023-02-05 15:15:07 +05:30
ad3c99e521
gh-92446: Improve argparse choices docs; revert bad change to lzma docs ( #94627 )
...
Based on the definition of the collections.abc classes, it is more accurate to use "sequence" instead of "container" when describing argparse choices.
A previous attempt at fixing this in #92450 was mistaken; this PR reverts that change.
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-26 00:22:53 -06:00
286e3c76a9
gh-99087: Add missing newline for prompts in docs (GH-98993)
...
Add newline for prompts so copying to REPL does not cause errors.
2022-12-08 19:31:19 -08:00
f5fea22886
gh-99650 : Updated argparse docs (GH-99653)
2022-11-22 13:16:06 -08:00
b27b57c6e4
`argparse` docs: normalize constant references ( #98765 )
2022-10-28 13:15:39 +01:00
810ae51787
gh-94787: [doc] Add to argparse doc an example of a mutually-exclusive group nested in an argument group (GH-94807)
2022-09-18 09:05:43 +01:00
9877f4c624
gh-85308: argparse: Use filesystem encoding for arguments file (GH-93277)
2022-06-23 12:09:57 +09:00
f2d994da10
gh-92812: Align ArgumentParser.add_subparsers() docs with argument spec ( #92814 )
2022-05-18 23:08:23 +02:00
3e3e8976b8
bpo-9182: Add a section on specifying positional arguments ( #31810 )
2022-05-13 09:17:07 -05:00
f67d71b431
Fix typo in argparse docs. (GH-92691)
...
# Fix typo in argparse docs.
> Sometimes, when dealing with **a** particularly long argument list**s**, [...]
Mixture between plural and singular forms is incorrect. Use singular consistently since typically only a single argument list is employed. Change to:
> Sometimes, when dealing with a particularly long argument list, [...]
No issue was opened, since this is a trivial change.
Automerge-Triggered-By: GH:rhettinger
2022-05-11 20:25:09 -07:00
301351c6a2
update argparse's doc of append action. ( #92344 )
2022-05-05 22:32:35 -05:00
238aa6253b
Improving readability of argparse.rst (GH-91751)
...
Fixed few typos and enhanced few paragraphs for your review and consideration.
Trivial contribution towards continuous improvement, so no issue was raised.
Automerge-Triggered-By: GH:rhettinger
2022-04-30 15:20:10 -07:00
25e35742ce
Minor improvements to grammar and markup. (GH-91762)
2022-04-20 16:02:47 -05:00
26f2e688b8
Clean-up the argparse docs quick links table (GH-91726)
2022-04-20 01:21:54 -05:00
8e76d7e1a9
bpo-21150: Add quick link/summary table to the top of argparse documentation (GH-12005)
...
No work has been done to move this forward. On the theory that perfect is the enemy of good, I'm going to push it and we can make minor edits as needed afterwards.
2022-04-17 23:46:18 -05:00
8e75c6b49b
argparse docs: prog default is the basename of argv[0] (GH-30298)
2022-01-02 12:16:25 -08:00
30322c497e
bpo-22047: [argparse] deprecate nested argument groups and mutually exclusive groups (GH-30098)
2021-12-16 15:31:08 +00:00
Alyssa Coghlan