PEP 1 – PEP Purpose and Guidelines | peps.python.org
PEP 1 – PEP Purpose and Guidelines PEP 1 – PEP Purpose and Guidelines Author : Barry Warsaw, Jeremy Hylton, David Goodger, Alyssa Coghlan Status : Active Type : Process Created : 13-Jun-2000 Post-History : 21-Mar-2001, 29-Jul-2002, 03-May-2003, 05-May-2012, 07-Apr-2013 Table of Contents What is a PEP? PEP Audience PEP Types PEP Workflow Python’s Steering Council Python’s Core Developers Python’s BDFL PEP Editors Start with an idea for Python Finding a sponsor Submitting a PEP Discussing a PEP PEP Review & Resolution PEP Maintenance What belongs in a successful PEP?
PEP Formats and Templates PEP Header Preamble Auxiliary Files Changing Existing PEPs Transferring PEP Ownership PEP Editor Responsibilities & Workflow Change History Copyright What is a PEP? PEP stands for Python Enhancement Proposal. A PEP is a design document providing information to the Python community, or describing a new feature for Python or its processes or environment. The PEP should provide a concise technical specification of the feature and a rationale for the feature.
We intend PEPs to be the primary mechanisms for proposing major new features, for collecting community input on an issue, and for documenting the design decisions that have gone into Python. The PEP author is responsible for building consensus within the community and documenting dissenting opinions. Because the PEPs are maintained as text files in a versioned repository, their revision history is the historical record of the feature proposal.
This historical record is available by the normal git commands for retrieving older revisions, and can also be browsed on GitHub . PEP Audience The typical primary audience for PEPs are the core developers of the CPython reference interpreter and their elected Steering Council, as well as developers of other implementations of the Python language specification. However, other parts of the Python community may also choose to use the process (particularly for Informational PEPs) to document expected API conventions and to manage complex design coordination problems that require collaboration across multiple projects.
PEP Types There are three kinds of PEP: A Standards Track PEP describes a new feature or implementation for Python. It may also describe an interoperability standard that will be supported outside the standard library for current Python versions before a subsequent PEP adds standard library support in a future version. An Informational PEP describes a Python design issue, or provides general guidelines or information to the Python community, but does not propose a new feature.
Informational PEPs do not necessarily represent a Python community consensus or recommendation, so users and implementers are free to ignore Informational PEPs or follow their advice. A Process PEP describes a process surrounding Python, or proposes a change to (or an event in) a process. Process PEPs are like Standards Track PEPs but apply to areas other than the Python language itself. They may propose an implementation, but not to Python’s codebase; they often require community consensus; unlike Informational PEPs, they are more than recommendations, and users are typically not free to ignore them.
Examples include procedures, guidelines, changes to the decision-making process, and changes to the tools or environment used in Python development. Any meta-PEP is also considered a Process PEP. PEP Workflow Python’s Steering Council There are several references in this PEP to the “Steering Council” or “Council”. This refers to the current members of the elected Steering Council described in PEP 13 , in their role as the final authorities on whether or not PEPs will be accepted or rejected.
Python’s Core Developers There are several references in this PEP to “core developers”. This refers to the currently active Python core team members described in PEP 13 . Python’s BDFL Previous versions of this PEP used the title “BDFL-Delegate” for PEP decision makers. This was a historical reference to Python’s previous governance model, where all design authority ultimately derived from Guido van Rossum, the original creator of the Python programming language.
By contrast, the Steering Council’s design authority derives from their election by the currently active core developers. Now, PEP-Delegate is used in place of BDFL-Delegate. PEP Editors The PEP editors are individuals responsible for managing the administrative and editorial aspects of the PEP workflow (e.g. assigning PEP numbers and changing their status). See PEP Editor Responsibilities & Workflow for details. PEP editorship is by invitation of the current editors, and they can be contacted by mentioning @python/pep-editors on GitHub.
All of the PEP workflow can be conducted via the GitHub PEP repository issues and pull requests. Start with an idea for Python The PEP process begins with a new idea for Python. It is highly recommended that a single PEP contain a single key proposal or new idea; the more focused the PEP, the more successful it tends to be. Most enhancements and bug fixes don’t need a PEP and can be submitted directly to the Python issue tracker .
The PEP editors reserve the right to reject PEP proposals if they appear too unfocused or too broad. If in doubt, split your PEP into several well-focused ones. Each PEP must have a champion – someone who writes the PEP using the style and format described below, shepherds the discussions in the appropriate forums, and attempts to build community consensus around the idea. The PEP champion (a.k.a. Author) should first attempt to ascertain whether the idea is PEP-able.
Posting to the Ideas category of the Python Discourse is usually the best way to go about this, unless a more specialized venue is appropriate, such as the Typing category (for static typing ideas) or Packaging category (for packaging ideas) on the Python Discourse. Vetting an idea publicly before going as far as writing a PEP is meant to save the potential author time. Many ideas have been brought forward for changing Python that have been rejected for various reasons.
Asking the Python community first if an idea is original helps prevent too much time being spent on something that is guaranteed to be rejected based on prior discussions (searching the internet does not always do the trick). It also helps to make sure the idea is applicable to the entire community and not just the author. Just because an idea sounds good to the author does not mean it will work for most people in most areas where Python is used.
Once the champion has asked the Python community as to whether an idea has any chance of acceptance, a draft PEP should be presented to the appropriate venue mentioned above. This gives the author a chance to flesh out the draft PEP to make properly formatted, of high quality, and to address initial concerns about the proposal. Finding a sponsor Following the above initial discussion, a sponsor must be found for the PEP.
If one or more of the PEP’s co-authors qualify as a sponsor, they are responsible for following the process outlined below. Otherwise (i.e. none of the co-authors are sponsors), the PEP author(s) will need to find a sponsor for the PEP. People approved to be PEP sponsors are: Members of the Python core team Members of the GitHub “PEP editors” team Members of the Typing Council ( PEP 729 ) Members of the Packaging Council ( PEP 772 ) People appointed by the Steering or Packaging Councils The sponsor’s job is to provide guidance to the PEP author to help them through the logistics of the PEP process (somewhat acting like a mentor).
Being a sponsor does not disqualify that person from becoming a co-author or PEP-Delegate later on. The sponsor of a PEP is recorded in the “Sponsor:” field of the header. Submitting a PEP Once the sponsor or the core developer(s) co-authoring the PEP deem the PEP ready for submission, the proposal should be submitted
The rest of this page is on the live site.