2000-08-07 22:31:25 -04:00
|
|
|
PEP: 2
|
|
|
|
Title: Procedure for Adding New Modules
|
|
|
|
Version: $Revision$
|
2002-03-11 12:23:14 -05:00
|
|
|
Last-Modified: $Date$
|
2022-09-23 18:56:29 -04:00
|
|
|
Author: Brett Cannon <brett@python.org>,
|
|
|
|
Martijn Faassen <faassen@infrae.com>
|
|
|
|
Status: Active
|
2007-06-19 00:52:34 -04:00
|
|
|
Type: Process
|
2016-06-18 18:40:35 -04:00
|
|
|
Content-Type: text/x-rst
|
2002-03-11 12:23:14 -05:00
|
|
|
Created: 07-Jul-2001
|
|
|
|
Post-History: 07-Jul-2001, 09-Mar-2002
|
2000-08-07 22:31:25 -04:00
|
|
|
|
|
|
|
|
2002-03-11 12:23:14 -05:00
|
|
|
Introduction
|
2016-06-18 18:40:35 -04:00
|
|
|
============
|
|
|
|
|
|
|
|
The Python Standard Library contributes significantly to Python's
|
|
|
|
success. The language comes with "batteries included", so it is easy
|
|
|
|
for people to become productive with just the standard library alone.
|
2022-09-23 18:56:29 -04:00
|
|
|
It is therefore important that the usefulness of the standard library
|
|
|
|
be maintained.
|
2016-06-18 18:40:35 -04:00
|
|
|
|
2022-09-23 18:56:29 -04:00
|
|
|
Due to the visibility and importance of the standard library, it must
|
|
|
|
be maintained thoughtfully. As such, any code within it must be
|
|
|
|
maintained by Python's development team which leads to a perpetual
|
|
|
|
cost to each addition made. There is also added cognitive load for
|
|
|
|
users in familiarizing themselves with what is in the standard
|
|
|
|
library to be considered.
|
2016-06-18 18:40:35 -04:00
|
|
|
|
|
|
|
New functionality is commonly added to the library in the form of new
|
|
|
|
modules. This PEP will describe the procedure for the *addition* of
|
2022-01-21 06:03:51 -05:00
|
|
|
new modules. :pep:`4` deals with procedures for deprecation of modules;
|
2016-06-18 18:40:35 -04:00
|
|
|
the *removal* of old and unused modules from the standard library.
|
2002-03-11 12:23:14 -05:00
|
|
|
|
|
|
|
|
|
|
|
Acceptance Procedure
|
2016-06-18 18:40:35 -04:00
|
|
|
====================
|
|
|
|
|
2022-09-23 18:56:29 -04:00
|
|
|
For top-level modules/packages, a PEP is required. The procedure for
|
|
|
|
writing a PEP is covered in :pep:`1`.
|
2016-06-18 18:40:35 -04:00
|
|
|
|
2022-09-23 18:56:29 -04:00
|
|
|
For submodules of a preexisting package in the standard library,
|
|
|
|
additions are at the discretion of the general Python development team
|
|
|
|
and its members.
|
2016-06-18 18:40:35 -04:00
|
|
|
|
2022-09-23 18:56:29 -04:00
|
|
|
General guidance on what modules typically are accepted into the
|
|
|
|
standard library, the overall process, etc. are covered in the
|
|
|
|
`developer's guide <https://devguide.python.org/stdlibchanges/>`_.
|
2002-03-11 12:23:14 -05:00
|
|
|
|
|
|
|
|
|
|
|
Maintenance Procedure
|
2016-06-18 18:40:35 -04:00
|
|
|
=====================
|
2002-03-11 12:23:14 -05:00
|
|
|
|
2022-09-23 18:56:29 -04:00
|
|
|
Anything accepted into the standard library is expected to be
|
|
|
|
primarily maintained there, within Python's development infrastructure.
|
|
|
|
While some members of the development team may choose to maintain a
|
|
|
|
backport of a module outside of the standard library, it is up to them
|
|
|
|
to keep their external code in sync as appropriate.
|
|
|
|
|
2002-03-11 12:23:14 -05:00
|
|
|
|
|
|
|
Copyright
|
2016-06-18 18:40:35 -04:00
|
|
|
=========
|
2002-03-11 12:23:14 -05:00
|
|
|
|
2016-06-18 18:40:35 -04:00
|
|
|
This document has been placed in the public domain.
|