Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

gh-106535: Document PEP 387 Soft Deprecation (#106536) 

Mark the optparse module as soft deprecated.
This commit is contained in:
Victor Stinner 2023-07-08 00:03:51 +02:00 committed by GitHub
parent 1fb9bd222b
commit d524b6f61f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Doc/glossary.rst
View File

@ -1107,6 +1107,21 @@ Glossary
when several are given, such as in ``variable_name[1:3:5]``. The bracket
(subscript) notation uses :class:`slice` objects internally.
soft deprecated
A soft deprecation can be used when using an API which should no longer
be used to write new code, but it remains safe to continue using it in
existing code. The API remains documented and tested, but will not be
developed further (no enhancement).
The main difference between a "soft" and a (regular) "hard" deprecation
is that the soft deprecation does not imply scheduling the removal of the
deprecated API.
Another difference is that a soft deprecation does not issue a warning.
See `PEP 387: Soft Deprecation
<https://peps.python.org/pep-0387/#soft-deprecation>`_.
special method
.. index:: pair: special; method

5
Doc/library/optparse.rst
View File

@ -11,8 +11,9 @@
**Source code:** :source:`Lib/optparse.py`
.. deprecated:: 3.2
The :mod:`optparse` module is deprecated and will not be developed further;
development will continue with the :mod:`argparse` module.
The :mod:`optparse` module is :term:`soft deprecated` and will not be
developed further; development will continue with the :mod:`argparse`
module.
--------------