CINXE.COM

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="color-scheme" content="light dark"> <title>PEP 3108 – Standard Library Reorganization | peps.python.org</title> <link rel="shortcut icon" href="../_static/py.png"> <link rel="canonical" href="https://peps.python.org/pep-3108/"> <link rel="stylesheet" href="../_static/style.css" type="text/css"> <link rel="stylesheet" href="../_static/mq.css" type="text/css"> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" media="(prefers-color-scheme: light)" id="pyg-light"> <link rel="stylesheet" href="../_static/pygments_dark.css" type="text/css" media="(prefers-color-scheme: dark)" id="pyg-dark"> <link rel="alternate" type="application/rss+xml" title="Latest PEPs" href="https://peps.python.org/peps.rss"> <meta property="og:title" content='PEP 3108 – Standard Library Reorganization | peps.python.org'> <meta property="og:description" content="Just like the language itself, Python’s standard library (stdlib) has grown over the years to be very rich. But over time some modules have lost their need to be included with Python. There has also been an introduction of a naming convention for modu..."> <meta property="og:type" content="website"> <meta property="og:url" content="https://peps.python.org/pep-3108/"> <meta property="og:site_name" content="Python Enhancement Proposals (PEPs)"> <meta property="og:image" content="https://peps.python.org/_static/og-image.png"> <meta property="og:image:alt" content="Python PEPs"> <meta property="og:image:width" content="200"> <meta property="og:image:height" content="200"> <meta name="description" content="Just like the language itself, Python’s standard library (stdlib) has grown over the years to be very rich. But over time some modules have lost their need to be included with Python. There has also been an introduction of a naming convention for modu..."> <meta name="theme-color" content="#3776ab"> </head> <body> <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <symbol id="svg-sun-half" viewBox="0 0 24 24" pointer-events="all"> <title>Following system colour scheme</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"> <circle cx="12" cy="12" r="9"></circle> <path d="M12 3v18m0-12l4.65-4.65M12 14.3l7.37-7.37M12 19.6l8.85-8.85"></path> </svg> </symbol> <symbol id="svg-moon" viewBox="0 0 24 24" pointer-events="all"> <title>Selected dark colour scheme</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"> <path stroke="none" d="M0 0h24v24H0z" fill="none"></path> <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z"></path> </svg> </symbol> <symbol id="svg-sun" viewBox="0 0 24 24" pointer-events="all"> <title>Selected light colour scheme</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"> <circle cx="12" cy="12" r="5"></circle> <line x1="12" y1="1" x2="12" y2="3"></line> <line x1="12" y1="21" x2="12" y2="23"></line> <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> <line x1="1" y1="12" x2="3" y2="12"></line> <line x1="21" y1="12" x2="23" y2="12"></line> <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> </svg> </symbol> </svg> <script> document.documentElement.dataset.colour_scheme = localStorage.getItem("colour_scheme") || "auto" </script> <section id="pep-page-section"> <header> <h1>Python Enhancement Proposals</h1> <ul class="breadcrumbs"> <li><a href="https://www.python.org/" title="The Python Programming Language">Python</a> » </li> <li><a href="../pep-0000/">PEP Index</a> » </li> <li>PEP 3108</li> </ul> <button id="colour-scheme-cycler" onClick="setColourScheme(nextColourScheme())"> <svg aria-hidden="true" class="colour-scheme-icon-when-auto"><use href="#svg-sun-half"></use></svg> <svg aria-hidden="true" class="colour-scheme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg aria-hidden="true" class="colour-scheme-icon-when-light"><use href="#svg-sun"></use></svg> <span class="visually-hidden">Toggle light / dark / auto colour theme</span> </button> </header> <article> <section id="pep-content"> <h1 class="page-title">PEP 3108 – Standard Library Reorganization</h1> <dl class="rfc2822 field-list simple"> <dt class="field-odd">Author<span class="colon">:</span></dt> <dd class="field-odd">Brett Cannon <brett at python.org></dd> <dt class="field-even">Status<span class="colon">:</span></dt> <dd class="field-even"><abbr title="Accepted and implementation complete, or no longer active">Final</abbr></dd> <dt class="field-odd">Type<span class="colon">:</span></dt> <dd class="field-odd"><abbr title="Normative PEP with a new feature for Python, implementation change for CPython or interoperability standard for the ecosystem">Standards Track</abbr></dd> <dt class="field-even">Created<span class="colon">:</span></dt> <dd class="field-even">01-Jan-2007</dd> <dt class="field-odd">Python-Version<span class="colon">:</span></dt> <dd class="field-odd">3.0</dd> <dt class="field-even">Post-History<span class="colon">:</span></dt> <dd class="field-even">28-Apr-2008</dd> </dl> <hr class="docutils" /> <section id="contents"> <details><summary>Table of Contents</summary><ul class="simple"> <li><a class="reference internal" href="#abstract">Abstract</a></li> <li><a class="reference internal" href="#modules-to-remove">Modules to Remove</a><ul> <li><a class="reference internal" href="#previously-deprecated-done">Previously deprecated [done]</a></li> <li><a class="reference internal" href="#platform-specific-with-minimal-use-done">Platform-specific with minimal use [done]</a><ul> <li><a class="reference internal" href="#irix">IRIX</a></li> <li><a class="reference internal" href="#mac-specific-modules">Mac-specific modules</a></li> <li><a class="reference internal" href="#solaris">Solaris</a></li> </ul> </li> <li><a class="reference internal" href="#hardly-used-done">Hardly used [done]</a></li> <li><a class="reference internal" href="#obsolete">Obsolete</a></li> <li><a class="reference internal" href="#maintenance-burden">Maintenance Burden</a></li> </ul> </li> <li><a class="reference internal" href="#modules-to-rename">Modules to Rename</a><ul> <li><a class="reference internal" href="#pep-8-violations-done">PEP 8 violations [done]</a></li> <li><a class="reference internal" href="#merging-c-and-python-implementations-of-the-same-interface">Merging C and Python implementations of the same interface</a></li> <li><a class="reference internal" href="#no-public-documented-interface-done">No public, documented interface [done]</a></li> <li><a class="reference internal" href="#poorly-chosen-names-done">Poorly chosen names [done]</a></li> <li><a class="reference internal" href="#grouping-of-modules-done">Grouping of modules [done]</a><ul> <li><a class="reference internal" href="#dbm-package">dbm package</a></li> <li><a class="reference internal" href="#html-package">html package</a></li> <li><a class="reference internal" href="#http-package">http package</a></li> <li><a class="reference internal" href="#tkinter-package">tkinter package</a></li> <li><a class="reference internal" href="#urllib-package">urllib package</a></li> <li><a class="reference internal" href="#xmlrpc-package">xmlrpc package</a></li> </ul> </li> </ul> </li> <li><a class="reference internal" href="#transition-plan">Transition Plan</a><ul> <li><a class="reference internal" href="#issues">Issues</a></li> <li><a class="reference internal" href="#for-modules-to-be-removed">For modules to be removed</a><ul> <li><a class="reference internal" href="#in-python-3-0">In Python 3.0</a></li> <li><a class="reference internal" href="#in-python-2-6">In Python 2.6</a></li> </ul> </li> <li><a class="reference internal" href="#renaming-of-modules">Renaming of modules</a><ul> <li><a class="reference internal" href="#python-3-0">Python 3.0</a></li> <li><a class="reference internal" href="#python-2-6">Python 2.6</a></li> </ul> </li> </ul> </li> <li><a class="reference internal" href="#open-issues">Open Issues</a><ul> <li><a class="reference internal" href="#renaming-of-modules-maintained-outside-of-the-stdlib">Renaming of modules maintained outside of the stdlib</a></li> </ul> </li> <li><a class="reference internal" href="#rejected-ideas">Rejected Ideas</a><ul> <li><a class="reference internal" href="#modules-that-were-originally-suggested-for-removal">Modules that were originally suggested for removal</a></li> <li><a class="reference internal" href="#introducing-a-new-top-level-package">Introducing a new top-level package</a></li> <li><a class="reference internal" href="#introducing-new-packages-to-contain-theme-related-modules">Introducing new packages to contain theme-related modules</a></li> </ul> </li> <li><a class="reference internal" href="#references">References</a></li> <li><a class="reference internal" href="#copyright">Copyright</a></li> </ul> </details></section> <div class="admonition note"> <p class="admonition-title">Note</p> <p>The merging of profile/cProfile as of Python 3.3 did not occur, and thus is considered abandoned (although it would be acceptable to do in the future).</p> </div> <section id="abstract"> <h2><a class="toc-backref" href="#abstract" role="doc-backlink">Abstract</a></h2> <p>Just like the language itself, Python’s standard library (stdlib) has grown over the years to be very rich. But over time some modules have lost their need to be included with Python. There has also been an introduction of a naming convention for modules since Python’s inception that not all modules follow.</p> <p>Python 3.0 presents a chance to remove modules that do not have long term usefulness. This chance also allows for the renaming of modules so that they follow the <a class="pep reference internal" href="../pep-0008/" title="PEP 8 – Style Guide for Python Code">Python style guide</a>. This PEP lists modules that should not be included in Python 3.0 or which need to be renamed.</p> </section> <section id="modules-to-remove"> <h2><a class="toc-backref" href="#modules-to-remove" role="doc-backlink">Modules to Remove</a></h2> <p>Guido pronounced that “silly old stuff” is to be deleted from the stdlib for Py3K <a class="footnote-reference brackets" href="#silly-old-stuff" id="id1">[7]</a>. This is open-ended on purpose. Each module to be removed needs to have a justification as to why it should no longer be distributed with Python. This can range from the module being deprecated in Python 2.x to being for a platform that is no longer widely used.</p> <p>This section of the PEP lists the various modules to be removed. Each subsection represents a different reason for modules to be removed. Each module must have a specific justification on top of being listed in a specific subsection so as to make sure only modules that truly deserve to be removed are in fact removed.</p> <p>When a reason mentions how long it has been since a module has been “uniquely edited”, it is in reference to how long it has been since a checkin was done specifically for the module and not for a change that applied universally across the entire stdlib. If an edit time is not denoted as “unique” then it is the last time the file was edited, period.</p> <section id="previously-deprecated-done"> <h3><a class="toc-backref" href="#previously-deprecated-done" role="doc-backlink">Previously deprecated [done]</a></h3> <p><a class="pep reference internal" href="../pep-0004/" title="PEP 4 – Deprecation of Standard Modules">PEP 4</a> lists all modules that have been deprecated in the stdlib. The specified motivations mirror those listed in <a class="pep reference internal" href="../pep-0004/" title="PEP 4 – Deprecation of Standard Modules">PEP 4</a>. All modules listed in the PEP at the time of the first alpha release of Python 3.0 will be removed.</p> <p>The entire contents of lib-old will also be removed. These modules have already been removed from being imported but are kept in the distribution for Python for users that rely upon the code.</p> <ul class="simple"> <li>cfmfile<ul> <li>Documented as deprecated since Python 2.4 without an explicit reason.</li> </ul> </li> <li>cl<ul> <li>Documented as obsolete since Python 2.0 or earlier.</li> <li>Interface to SGI hardware.</li> </ul> </li> <li>md5<ul> <li>Supplanted by the <code class="docutils literal notranslate"><span class="pre">hashlib</span></code> module.</li> </ul> </li> <li>mimetools<ul> <li>Documented as obsolete in a previous version.</li> <li>Supplanted by the <code class="docutils literal notranslate"><span class="pre">email</span></code> package.</li> </ul> </li> <li>MimeWriter<ul> <li>Supplanted by the <code class="docutils literal notranslate"><span class="pre">email</span></code> package.</li> </ul> </li> <li>mimify<ul> <li>Supplanted by the <code class="docutils literal notranslate"><span class="pre">email</span></code> package.</li> </ul> </li> <li>multifile<ul> <li>Supplanted by the <code class="docutils literal notranslate"><span class="pre">email</span></code> package.</li> </ul> </li> <li>posixfile<ul> <li>Locking is better done by <code class="docutils literal notranslate"><span class="pre">fcntl.lockf()</span></code>.</li> </ul> </li> <li>rfc822<ul> <li>Supplanted by the <code class="docutils literal notranslate"><span class="pre">email</span></code> package.</li> </ul> </li> <li>sha<ul> <li>Supplanted by the <code class="docutils literal notranslate"><span class="pre">hashlib</span></code> package.</li> </ul> </li> <li>sv<ul> <li>Documented as obsolete since Python 2.0 or earlier.</li> <li>Interface to obsolete SGI Indigo hardware.</li> </ul> </li> <li>timing<ul> <li>Documented as obsolete since Python 2.0 or earlier.</li> <li><code class="docutils literal notranslate"><span class="pre">time.clock()</span></code> gives better time resolution.</li> </ul> </li> </ul> </section> <section id="platform-specific-with-minimal-use-done"> <h3><a class="toc-backref" href="#platform-specific-with-minimal-use-done" role="doc-backlink">Platform-specific with minimal use [done]</a></h3> <p>Python supports many platforms, some of which are not widely used or maintained. And on some of these platforms there are modules that have limited use to people on those platforms. Because of their limited usefulness it would be better to no longer burden the Python development team with their maintenance.</p> <p>The modules mentioned below are documented. All undocumented modules for the specified platforms will also be removed.</p> <section id="irix"> <h4><a class="toc-backref" href="#irix" role="doc-backlink">IRIX</a></h4> <p>The IRIX operating system is no longer produced <a class="footnote-reference brackets" href="#irix-retirement" id="id2">[13]</a>. Removing all modules from the plat-irix[56] directory has been deemed reasonable because of this fact.</p> <ul class="simple"> <li>AL/al<ul> <li>Provides sound support on Indy and Indigo workstations.</li> <li>Both workstations are no longer available.</li> <li>Code has not been uniquely edited in three years.</li> </ul> </li> <li>cd/CD<ul> <li>CD drive control for SGI systems.</li> <li>SGI no longer sells machines with IRIX on them.</li> <li>Code has not been uniquely edited in 14 years.</li> </ul> </li> <li>cddb<ul> <li>Undocumented.</li> </ul> </li> <li>cdplayer<ul> <li>Undocumented.</li> </ul> </li> <li>cl/CL/CL_old<ul> <li>Compression library for SGI systems.</li> <li>SGI no longer sells machines with IRIX on them.</li> <li>Code has not been uniquely edited in 14 years.</li> </ul> </li> <li>DEVICE/GL/gl/cgen/cgensuport<ul> <li>GL access, which is the predecessor to OpenGL.</li> <li>Has not been edited in at least eight years.</li> <li>Third-party libraries provide better support (PyOpenGL <a class="footnote-reference brackets" href="#pyopengl" id="id3">[10]</a>).</li> </ul> </li> <li>ERRNO<ul> <li>Undocumented.</li> </ul> </li> <li>FILE<ul> <li>Undocumented.</li> </ul> </li> <li>FL/fl/flp<ul> <li>Wrapper for the FORMS library <a class="footnote-reference brackets" href="#irix-forms" id="id4">[14]</a></li> <li>FORMS has not been edited in 12 years.</li> <li>Library is not widely used.</li> <li>First eight hits on Google are for Python docs for fl.</li> </ul> </li> <li>fm<ul> <li>Wrapper to the IRIS Font Manager library.</li> <li>Only available on SGI machines which no longer come with IRIX.</li> </ul> </li> <li>GET<ul> <li>Undocumented.</li> </ul> </li> <li>GLWS<ul> <li>Undocumented.</li> </ul> </li> <li>imgfile<ul> <li>Wrapper for SGI libimage library for imglib image files (<code class="docutils literal notranslate"><span class="pre">.rgb</span></code> files).</li> <li>Python Imaging Library provides read-only support <a class="footnote-reference brackets" href="#pil" id="id5">[11]</a>.</li> <li>Not uniquely edited in 13 years.</li> </ul> </li> <li>IN<ul> <li>Undocumented.</li> </ul> </li> <li>IOCTL<ul> <li>Undocumented.</li> </ul> </li> <li>jpeg<ul> <li>Wrapper for JPEG (de)compressor.</li> <li>Code not uniquely edited in nine years.</li> <li>Third-party libraries provide better support (Python Imaging Library <a class="footnote-reference brackets" href="#pil" id="id6">[11]</a>).</li> </ul> </li> <li>panel<ul> <li>Undocumented.</li> </ul> </li> <li>panelparser<ul> <li>Undocumented.</li> </ul> </li> <li>readcd<ul> <li>Undocumented.</li> </ul> </li> <li>SV<ul> <li>Undocumented.</li> </ul> </li> <li>torgb<ul> <li>Undocumented.</li> </ul> </li> <li>WAIT<ul> <li>Undocumented.</li> </ul> </li> </ul> </section> <section id="mac-specific-modules"> <h4><a class="toc-backref" href="#mac-specific-modules" role="doc-backlink">Mac-specific modules</a></h4> <p>The Mac-specific modules are not well-maintained (e.g., the bgen tool used to auto-generate many of the modules has never been updated to support UCS-4). It is also not Python’s place to maintain such a large amount of OS-specific modules. Thus all modules under <code class="docutils literal notranslate"><span class="pre">Lib/plat-mac</span></code> and <code class="docutils literal notranslate"><span class="pre">Mac</span></code> are to be removed.</p> <p>A stub module for proxy access will be provided for use by urllib.</p> <ul class="simple"> <li>_builtinSuites<ul> <li>Undocumented.</li> <li>Package under lib-scriptpackages.</li> </ul> </li> <li>Audio_mac<ul> <li>Undocumented.</li> </ul> </li> <li>aepack<ul> <li>OSA support is better through third-party modules.<ul> <li>Appscript <a class="footnote-reference brackets" href="#appscript" id="id7">[15]</a>.</li> </ul> </li> <li>Hard-coded endianness which breaks on Intel Macs.</li> <li>Might need to rename if Carbon package dependent.</li> </ul> </li> <li>aetools<ul> <li>See aepack.</li> </ul> </li> <li>aetypes<ul> <li>See aepack.</li> </ul> </li> <li>applesingle<ul> <li>Undocumented.</li> <li>AppleSingle is a binary file format for A/UX.</li> <li>A/UX no longer distributed.</li> </ul> </li> <li>appletrawmain<ul> <li>Undocumented.</li> </ul> </li> <li>appletrunner<ul> <li>Undocumented.</li> </ul> </li> <li>argvemulator<ul> <li>Undocumented.</li> </ul> </li> <li>autoGIL<ul> <li>Very bad model for using Python with the CFRunLoop.</li> </ul> </li> <li>bgenlocations<ul> <li>Undocumented.</li> </ul> </li> <li>buildtools<ul> <li>Documented as deprecated since Python 2.3 without an explicit reason.</li> </ul> </li> <li>bundlebuilder<ul> <li>Undocumented.</li> </ul> </li> <li>Carbon<ul> <li>Carbon development has stopped.</li> <li>Does not support 64-bit systems completely.</li> <li>Dependent on bgen which has never been updated to support UCS-4 Unicode builds of Python.</li> </ul> </li> <li>CodeWarrior<ul> <li>Undocumented.</li> <li>Package under lib-scriptpackages.</li> </ul> </li> <li>ColorPicker<ul> <li>Better to use Cocoa for GUIs.</li> </ul> </li> <li>EasyDialogs<ul> <li>Better to use Cocoa for GUIs.</li> </ul> </li> <li>Explorer<ul> <li>Undocumented.</li> <li>Package under lib-scriptpackages.</li> </ul> </li> <li>Finder<ul> <li>Undocumented.</li> <li>Package under lib-scriptpackages.</li> </ul> </li> <li>findertools<ul> <li>No longer useful.</li> </ul> </li> <li>FrameWork<ul> <li>Poorly documented.</li> <li>Not updated to support Carbon Events.</li> </ul> </li> <li>gensuitemodule<ul> <li>See aepack.</li> </ul> </li> <li>ic</li> <li>icglue</li> <li>icopen<ul> <li>Not needed on OS X.</li> <li>Meant to replace ‘open’ which is usually a bad thing to do.</li> </ul> </li> <li>macerrors<ul> <li>Undocumented.</li> </ul> </li> <li>MacOS<ul> <li>Would also mean the removal of binhex.</li> </ul> </li> <li>macostools</li> <li>macresource<ul> <li>Undocumented.</li> </ul> </li> <li>MiniAEFrame<ul> <li>See aepack.</li> </ul> </li> <li>Nav<ul> <li>Undocumented.</li> </ul> </li> <li>Netscape<ul> <li>Undocumented.</li> <li>Package under lib-scriptpackages.</li> </ul> </li> <li>OSATerminology</li> <li>pimp<ul> <li>Undocumented.</li> </ul> </li> <li>PixMapWrapper<ul> <li>Undocumented.</li> </ul> </li> <li>StdSuites<ul> <li>Undocumented.</li> <li>Package under lib-scriptpackages.</li> </ul> </li> <li>SystemEvents<ul> <li>Undocumented.</li> <li>Package under lib-scriptpackages.</li> </ul> </li> <li>Terminal<ul> <li>Undocumented.</li> <li>Package under lib-scriptpackages.</li> </ul> </li> <li>terminalcommand<ul> <li>Undocumented.</li> </ul> </li> <li>videoreader<ul> <li>No longer used.</li> </ul> </li> <li>W<ul> <li>No longer distributed with Python.</li> </ul> </li> </ul> </section> <section id="solaris"> <h4><a class="toc-backref" href="#solaris" role="doc-backlink">Solaris</a></h4> <ul class="simple"> <li>SUNAUDIODEV/sunaudiodev<ul> <li>Access to the sound card on Sun machines.</li> <li>Code not uniquely edited in over eight years.</li> </ul> </li> </ul> </section> </section> <section id="hardly-used-done"> <h3><a class="toc-backref" href="#hardly-used-done" role="doc-backlink">Hardly used [done]</a></h3> <p>Some platform-independent modules are rarely used. There are a number of possible explanations for this, including, ease of reimplementation, very small audience or lack of adherence to more modern standards.</p> <ul class="simple"> <li>audiodev<ul> <li>Undocumented.</li> <li>Not edited in five years.</li> </ul> </li> <li>imputil<ul> <li>Undocumented.</li> <li>Never updated to support absolute imports.</li> </ul> </li> <li>mutex<ul> <li>Easy to implement using a semaphore and a queue.</li> <li>Cannot block on a lock attempt.</li> <li>Not uniquely edited since its addition 15 years ago.</li> <li>Only useful with the ‘sched’ module.</li> <li>Not thread-safe.</li> </ul> </li> <li>stringold<ul> <li>Function versions of the methods on string objects.</li> <li>Obsolete since Python 1.6.</li> <li>Any functionality not in the string object or module will be moved to the string module (mostly constants).</li> </ul> </li> <li>sunaudio<ul> <li>Undocumented.</li> <li>Not edited in over seven years.</li> <li>The <code class="docutils literal notranslate"><span class="pre">sunau</span></code> module provides similar abilities.</li> </ul> </li> <li>toaiff<ul> <li>Undocumented.</li> <li>Requires <code class="docutils literal notranslate"><span class="pre">sox</span></code> library to be installed on the system.</li> </ul> </li> <li>user<ul> <li>Easily handled by allowing the application specify its own module name, check for existence, and import if found.</li> </ul> </li> <li>new<ul> <li>Just a rebinding of names from the ‘types’ module.</li> <li>Can also call <code class="docutils literal notranslate"><span class="pre">type</span></code> built-in to get most types easily.</li> <li>Docstring states the module is no longer useful as of revision 27241 (2002-06-15).</li> </ul> </li> <li>pure<ul> <li>Written before Pure Atria was bought by Rational which was then bought by IBM (in other words, very old).</li> </ul> </li> <li>test.testall<ul> <li>From the days before regrtest.</li> </ul> </li> </ul> </section> <section id="obsolete"> <h3><a class="toc-backref" href="#obsolete" role="doc-backlink">Obsolete</a></h3> <p>Becoming obsolete signifies that either another module in the stdlib or a widely distributed third-party library provides a better solution for what the module is meant for.</p> <ul class="simple"> <li>Bastion/rexec [done]<ul> <li>Restricted execution / security.</li> <li>Turned off in Python 2.3.</li> <li>Modules deemed unsafe.</li> </ul> </li> <li>bsddb185 [done]<ul> <li>Superseded by bsddb3</li> <li>Not built by default.</li> <li>Documentation specifies that the “module should never be used directly in new code”.</li> <li>Available externally from <a class="reference external" href="http://pypi.python.org/">PyPI</a>.</li> </ul> </li> <li>Canvas [done]<ul> <li>Marked as obsolete in a comment by Guido since 2000 (see <a class="reference external" href="http://bugs.python.org/issue210677">http://bugs.python.org/issue210677</a>).</li> <li>Better to use the <code class="docutils literal notranslate"><span class="pre">Tkinter.Canvas</span></code> class.</li> </ul> </li> <li>commands [done]<ul> <li>subprocess module replaces it (<a class="pep reference internal" href="../pep-0324/" title="PEP 324 – subprocess - New process module">PEP 324</a>).</li> <li>Remove getstatus(), move rest to subprocess.</li> </ul> </li> <li>compiler [done]<ul> <li>Having to maintain both the built-in compiler and the stdlib package is redundant <a class="footnote-reference brackets" href="#ast-removal" id="id8">[17]</a>.</li> <li>The AST created by the compiler is available <a class="footnote-reference brackets" href="#ast" id="id9">[16]</a>.</li> <li>Mechanism to compile from an AST needs to be added.</li> </ul> </li> <li>dircache [done]<ul> <li>Negligible use.</li> <li>Easily replicated.</li> </ul> </li> <li>dl [done]<ul> <li>ctypes provides better support for same functionality.</li> </ul> </li> <li>fpformat [done]<ul> <li>All functionality is supported by string interpolation.</li> </ul> </li> <li>htmllib [done]<ul> <li>Superseded by HTMLParser.</li> </ul> </li> <li>ihooks [done]<ul> <li>Undocumented.</li> <li>For use with rexec which has been turned off since Python 2.3.</li> </ul> </li> <li>imageop [done]<ul> <li>Better support by third-party libraries (Python Imaging Library <a class="footnote-reference brackets" href="#pil" id="id10">[11]</a>).</li> <li><dl class="simple"> <dt>Unit tests relied on rgbimg and imgfile.</dt><dd><ul> <li>rgbimg was removed in Python 2.6.</li> <li>imgfile slated for removal in this PEP.</li> </ul> </dd> </dl> </li> </ul> </li> <li>linuxaudiodev [done]<ul> <li>Replaced by ossaudiodev.</li> </ul> </li> <li>mhlib [done]<ul> <li>Should be removed as an individual module; use <code class="docutils literal notranslate"><span class="pre">mailbox</span></code> instead.</li> </ul> </li> <li>popen2 [done]<ul> <li>subprocess module replaces it (<a class="pep reference internal" href="../pep-0324/" title="PEP 324 – subprocess - New process module">PEP 324</a>).</li> </ul> </li> <li>sgmllib [done]<ul> <li>Does not fully parse SGML.</li> <li>In the stdlib for support to htmllib which is slated for removal.</li> </ul> </li> <li>sre [done]<ul> <li>Previously deprecated; import <code class="docutils literal notranslate"><span class="pre">re</span></code> instead.</li> </ul> </li> <li>stat [TODO need to move all uses over to <code class="docutils literal notranslate"><span class="pre">os.stat()</span></code>]<ul> <li><code class="docutils literal notranslate"><span class="pre">os.stat()</span></code> now returns a tuple with attributes.</li> <li>Functions in the module should be made into methods for the object returned by os.stat.</li> </ul> </li> <li>statvfs [done]<ul> <li><code class="docutils literal notranslate"><span class="pre">os.statvfs</span></code> now returns a tuple with attributes.</li> </ul> </li> <li>thread [done]<ul> <li>People should use ‘threading’ instead.<ul> <li>Rename ‘thread’ to _thread.</li> <li>Deprecate dummy_thread and rename _dummy_thread.</li> <li>Move thread.get_ident over to threading.</li> </ul> </li> <li>Guido has previously supported the deprecation <a class="footnote-reference brackets" href="#thread-deprecation" id="id11">[8]</a>.</li> </ul> </li> <li>urllib [done]<ul> <li>Superseded by urllib2.</li> <li>Functionality unique to urllib will be kept in the urllib package.</li> </ul> </li> <li>UserDict [done: 3.0] [TODO handle 2.6]<ul> <li>Not as useful since types can be a superclass.</li> <li>Useful bits moved to the ‘collections’ module.</li> </ul> </li> <li>UserList/UserString [done]<ul> <li>Not useful since types can be a superclass.</li> <li>Moved to the ‘collections’ module.</li> </ul> </li> </ul> </section> <section id="maintenance-burden"> <h3><a class="toc-backref" href="#maintenance-burden" role="doc-backlink">Maintenance Burden</a></h3> <p>Over the years, certain modules have become a heavy burden upon python-dev to maintain. In situations like this, it is better for the module to be given to the community to maintain to free python-dev to focus more on language support and other modules in the standard library that do not take up an undue amount of time and effort.</p> <ul class="simple"> <li>bsddb3<ul> <li>Externally maintained at <a class="reference external" href="http://www.jcea.es/programacion/pybsddb.htm">http://www.jcea.es/programacion/pybsddb.htm</a> .</li> <li>Consistent testing instability.</li> <li>Berkeley DB follows a different release schedule than Python, leading to the bindings not necessarily being in sync with what is available.</li> </ul> </li> </ul> </section> </section> <section id="modules-to-rename"> <h2><a class="toc-backref" href="#modules-to-rename" role="doc-backlink">Modules to Rename</a></h2> <p>Many modules existed in the stdlib before <a class="pep reference internal" href="../pep-0008/" title="PEP 8 – Style Guide for Python Code">PEP 8</a> came into existence. This has led to some naming inconsistencies and namespace bloat that should be addressed.</p> <section id="pep-8-violations-done"> <h3><a class="toc-backref" href="#pep-8-violations-done" role="doc-backlink">PEP 8 violations [done]</a></h3> <p><a class="pep reference internal" href="../pep-0008/" title="PEP 8 – Style Guide for Python Code">PEP 8</a> specifies that modules “should have short, all-lowercase names” where “underscores can be used … if it improves readability”. The use of underscores is discouraged in package names. The following modules violate <a class="pep reference internal" href="../pep-0008/" title="PEP 8 – Style Guide for Python Code">PEP 8</a> and are not somehow being renamed by being moved to a package.</p> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Current Name</th> <th class="head">Replacement Name</th> </tr> </thead> <tbody> <tr class="row-even"><td>_winreg</td> <td>winreg</td> </tr> <tr class="row-odd"><td>ConfigParser</td> <td>configparser</td> </tr> <tr class="row-even"><td>copy_reg</td> <td>copyreg</td> </tr> <tr class="row-odd"><td>Queue</td> <td>queue</td> </tr> <tr class="row-even"><td>SocketServer</td> <td>socketserver</td> </tr> </tbody> </table> </section> <section id="merging-c-and-python-implementations-of-the-same-interface"> <h3><a class="toc-backref" href="#merging-c-and-python-implementations-of-the-same-interface" role="doc-backlink">Merging C and Python implementations of the same interface</a></h3> <p>Several interfaces have both a Python and C implementation. While it is great to have a C implementation for speed with a Python implementation as fallback, there is no need to expose the two implementations independently in the stdlib. For Python 3.0 all interfaces with two implementations will be merged into a single public interface.</p> <p>The C module is to be given a leading underscore to delineate the fact that it is not the reference implementation (the Python implementation is). This means that any semantic difference between the C and Python versions must be dealt with before Python 3.0 or else the C implementation will be removed until it can be fixed.</p> <p>One interface that is not listed below is xml.etree.ElementTree. This is an externally maintained module and thus is not under the direct control of the Python development team for renaming. See <a class="reference internal" href="#open-issues">Open Issues</a> for a discussion on this.</p> <ul class="simple"> <li>pickle/cPickle [done]<ul> <li>Rename cPickle to _pickle.</li> <li>Semantic completeness of C implementation <em>not</em> verified.</li> </ul> </li> <li>profile/cProfile [TODO]<ul> <li>Rename cProfile to _profile.</li> <li>Semantic completeness of C implementation <em>not</em> verified.</li> </ul> </li> <li>StringIO/cStringIO [done]<ul> <li>Add the class to the ‘io’ module.</li> </ul> </li> </ul> </section> <section id="no-public-documented-interface-done"> <h3><a class="toc-backref" href="#no-public-documented-interface-done" role="doc-backlink">No public, documented interface [done]</a></h3> <p>There are several modules in the stdlib that have no defined public interface. These modules exist as support code for other modules that are exposed. Because they are not meant to be used directly they should be renamed to reflect this fact.</p> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Current Name</th> <th class="head">Replacement Name</th> </tr> </thead> <tbody> <tr class="row-even"><td>markupbase</td> <td>_markupbase</td> </tr> </tbody> </table> </section> <section id="poorly-chosen-names-done"> <h3><a class="toc-backref" href="#poorly-chosen-names-done" role="doc-backlink">Poorly chosen names [done]</a></h3> <p>A few modules have names that were poorly chosen in hindsight. They should be renamed so as to prevent their bad name from perpetuating beyond the 2.x series.</p> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Current Name</th> <th class="head">Replacement Name</th> </tr> </thead> <tbody> <tr class="row-even"><td>repr</td> <td>reprlib</td> </tr> <tr class="row-odd"><td>test.test_support</td> <td>test.support</td> </tr> </tbody> </table> </section> <section id="grouping-of-modules-done"> <h3><a class="toc-backref" href="#grouping-of-modules-done" role="doc-backlink">Grouping of modules [done]</a></h3> <p>As the stdlib has grown, several areas within it have expanded to include multiple modules (e.g., support for database files). It thus makes sense to group related modules into packages.</p> <section id="dbm-package"> <h4><a class="toc-backref" href="#dbm-package" role="doc-backlink">dbm package</a></h4> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Current Name</th> <th class="head">Replacement Name</th> </tr> </thead> <tbody> <tr class="row-even"><td>anydbm</td> <td>dbm.__init__ <a class="footnote-reference brackets" href="#id14" id="id12">[1]</a></td> </tr> <tr class="row-odd"><td>dbhash</td> <td>dbm.bsd</td> </tr> <tr class="row-even"><td>dbm</td> <td>dbm.ndbm</td> </tr> <tr class="row-odd"><td>dumbdm</td> <td>dbm.dumb</td> </tr> <tr class="row-even"><td>gdbm</td> <td>dbm.gnu</td> </tr> <tr class="row-odd"><td>whichdb</td> <td>dbm.__init__ <a class="footnote-reference brackets" href="#id14" id="id13">[1]</a></td> </tr> </tbody> </table> <aside class="footnote-list brackets"> <aside class="footnote brackets" id="id14" role="doc-footnote"> <dt class="label" id="id14">[1]<em> (<a href='#id12'>1</a>, <a href='#id13'>2</a>) </em></dt> <dd><code class="docutils literal notranslate"><span class="pre">dbm.__init__</span></code> can combine <code class="docutils literal notranslate"><span class="pre">anybdbm</span></code> and <code class="docutils literal notranslate"><span class="pre">whichdb</span></code> since the public API for both modules has no name conflict and the two modules have closely related usage.</aside> </aside> </section> <section id="html-package"> <h4><a class="toc-backref" href="#html-package" role="doc-backlink">html package</a></h4> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Current Name</th> <th class="head">Replacement Name</th> </tr> </thead> <tbody> <tr class="row-even"><td>HTMLParser</td> <td>html.parser</td> </tr> <tr class="row-odd"><td>htmlentitydefs</td> <td>html.entities</td> </tr> </tbody> </table> </section> <section id="http-package"> <h4><a class="toc-backref" href="#http-package" role="doc-backlink">http package</a></h4> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Current Name</th> <th class="head">Replacement Name</th> </tr> </thead> <tbody> <tr class="row-even"><td>httplib</td> <td>http.client</td> </tr> <tr class="row-odd"><td>BaseHTTPServer</td> <td>http.server <a class="footnote-reference brackets" href="#id18" id="id15">[2]</a></td> </tr> <tr class="row-even"><td>CGIHTTPServer</td> <td>http.server <a class="footnote-reference brackets" href="#id18" id="id16">[2]</a></td> </tr> <tr class="row-odd"><td>SimpleHTTPServer</td> <td>http.server <a class="footnote-reference brackets" href="#id18" id="id17">[2]</a></td> </tr> <tr class="row-even"><td>Cookie</td> <td>http.cookies</td> </tr> <tr class="row-odd"><td>cookielib</td> <td>http.cookiejar</td> </tr> </tbody> </table> <aside class="footnote-list brackets"> <aside class="footnote brackets" id="id18" role="doc-footnote"> <dt class="label" id="id18">[2]<em> (<a href='#id15'>1</a>, <a href='#id16'>2</a>, <a href='#id17'>3</a>) </em></dt> <dd>The <code class="docutils literal notranslate"><span class="pre">http.server</span></code> module can combine the specified modules safely as they have no naming conflicts.</aside> </aside> </section> <section id="tkinter-package"> <h4><a class="toc-backref" href="#tkinter-package" role="doc-backlink">tkinter package</a></h4> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Current Name</th> <th class="head">Replacement Name</th> </tr> </thead> <tbody> <tr class="row-even"><td>Dialog</td> <td>tkinter.dialog</td> </tr> <tr class="row-odd"><td>FileDialog</td> <td>tkinter.filedialog <a class="footnote-reference brackets" href="#id23" id="id19">[4]</a></td> </tr> <tr class="row-even"><td>FixTk</td> <td>tkinter._fix</td> </tr> <tr class="row-odd"><td>ScrolledText</td> <td>tkinter.scrolledtext</td> </tr> <tr class="row-even"><td>SimpleDialog</td> <td>tkinter.simpledialog <a class="footnote-reference brackets" href="#id24" id="id20">[5]</a></td> </tr> <tr class="row-odd"><td>Tix</td> <td>tkinter.tix</td> </tr> <tr class="row-even"><td>Tkconstants</td> <td>tkinter.constants</td> </tr> <tr class="row-odd"><td>Tkdnd</td> <td>tkinter.dnd</td> </tr> <tr class="row-even"><td>Tkinter</td> <td>tkinter.__init__</td> </tr> <tr class="row-odd"><td>tkColorChooser</td> <td>tkinter.colorchooser</td> </tr> <tr class="row-even"><td>tkCommonDialog</td> <td>tkinter.commondialog</td> </tr> <tr class="row-odd"><td>tkFileDialog</td> <td>tkinter.filedialog <a class="footnote-reference brackets" href="#id23" id="id21">[4]</a></td> </tr> <tr class="row-even"><td>tkFont</td> <td>tkinter.font</td> </tr> <tr class="row-odd"><td>tkMessageBox</td> <td>tkinter.messagebox</td> </tr> <tr class="row-even"><td>tkSimpleDialog</td> <td>tkinter.simpledialog <a class="footnote-reference brackets" href="#id24" id="id22">[5]</a></td> </tr> <tr class="row-odd"><td>turtle</td> <td>tkinter.turtle</td> </tr> </tbody> </table> <aside class="footnote-list brackets"> <aside class="footnote brackets" id="id23" role="doc-footnote"> <dt class="label" id="id23">[4]<em> (<a href='#id19'>1</a>, <a href='#id21'>2</a>) </em></dt> <dd><code class="docutils literal notranslate"><span class="pre">tkinter.filedialog</span></code> can safely combine <code class="docutils literal notranslate"><span class="pre">FileDialog</span></code> and <code class="docutils literal notranslate"><span class="pre">tkFileDialog</span></code> as there are no naming conflicts.</aside> <aside class="footnote brackets" id="id24" role="doc-footnote"> <dt class="label" id="id24">[5]<em> (<a href='#id20'>1</a>, <a href='#id22'>2</a>) </em></dt> <dd><code class="docutils literal notranslate"><span class="pre">tkinter.simpledialog</span></code> can safely combine <code class="docutils literal notranslate"><span class="pre">SimpleDialog</span></code> and <code class="docutils literal notranslate"><span class="pre">tkSimpleDialog</span></code> have no naming conflicts.</aside> </aside> </section> <section id="urllib-package"> <h4><a class="toc-backref" href="#urllib-package" role="doc-backlink">urllib package</a></h4> <p>Originally this new package was to be named <code class="docutils literal notranslate"><span class="pre">url</span></code>, but because of the common use of the name as a variable, it has been deemed better to keep the name <code class="docutils literal notranslate"><span class="pre">urllib</span></code> and instead shift existing modules around into a new package.</p> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Current Name</th> <th class="head">Replacement Name</th> </tr> </thead> <tbody> <tr class="row-even"><td>urllib2</td> <td>urllib.request, urllib.error</td> </tr> <tr class="row-odd"><td>urlparse</td> <td>urllib.parse</td> </tr> <tr class="row-even"><td>urllib</td> <td>urllib.parse, urllib.request, urllib.error <a class="footnote-reference brackets" href="#id26" id="id25">[6]</a></td> </tr> <tr class="row-odd"><td>robotparser</td> <td>urllib.robotparser</td> </tr> </tbody> </table> <aside class="footnote-list brackets"> <aside class="footnote brackets" id="id26" role="doc-footnote"> <dt class="label" id="id26">[<a href="#id25">6</a>]</dt> <dd>The quoting-related functions from <code class="docutils literal notranslate"><span class="pre">urllib</span></code> will be added to <code class="docutils literal notranslate"><span class="pre">urllib.parse</span></code>. <code class="docutils literal notranslate"><span class="pre">urllib.URLOpener</span></code> and <code class="docutils literal notranslate"><span class="pre">urllib.FancyUrlOpener</span></code> will be added to <code class="docutils literal notranslate"><span class="pre">urllib.request</span></code> as long as the documentation for both modules is updated.</aside> </aside> </section> <section id="xmlrpc-package"> <h4><a class="toc-backref" href="#xmlrpc-package" role="doc-backlink">xmlrpc package</a></h4> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Current Name</th> <th class="head">Replacement Name</th> </tr> </thead> <tbody> <tr class="row-even"><td>xmlrpclib</td> <td>xmlrpc.client</td> </tr> <tr class="row-odd"><td>DocXMLRPCServer</td> <td>xmlrpc.server <a class="footnote-reference brackets" href="#id29" id="id27">[3]</a></td> </tr> <tr class="row-even"><td>SimpleXMLRPCServer</td> <td>xmlrpc.server <a class="footnote-reference brackets" href="#id29" id="id28">[3]</a></td> </tr> </tbody> </table> <aside class="footnote-list brackets"> <aside class="footnote brackets" id="id29" role="doc-footnote"> <dt class="label" id="id29">[3]<em> (<a href='#id27'>1</a>, <a href='#id28'>2</a>) </em></dt> <dd>The modules being combined into <code class="docutils literal notranslate"><span class="pre">xmlrpc.server</span></code> have no naming conflicts and thus can safely be merged.</aside> </aside> </section> </section> </section> <section id="transition-plan"> <h2><a class="toc-backref" href="#transition-plan" role="doc-backlink">Transition Plan</a></h2> <section id="issues"> <h3><a class="toc-backref" href="#issues" role="doc-backlink">Issues</a></h3> <p>Issues related to this PEP:</p> <ul class="simple"> <li><a class="reference external" href="http://bugs.python.org/issue2775">Issue 2775</a>: Master tracking issue</li> <li><a class="reference external" href="http://bugs.python.org/issue2828">Issue 2828</a>: clean up undoc.rst</li> </ul> </section> <section id="for-modules-to-be-removed"> <h3><a class="toc-backref" href="#for-modules-to-be-removed" role="doc-backlink">For modules to be removed</a></h3> <p>For module removals, it is easiest to remove the module first in Python 3.0 to see where dependencies exist. This makes finding code that (possibly) requires the suppression of the DeprecationWarning easier.</p> <section id="in-python-3-0"> <h4><a class="toc-backref" href="#in-python-3-0" role="doc-backlink">In Python 3.0</a></h4> <ol class="arabic simple"> <li>Remove the module.</li> <li>Remove related tests.</li> <li>Remove all documentation (typically the module’s documentation file and its entry in a file for the Library Reference).</li> <li>Edit <code class="docutils literal notranslate"><span class="pre">Modules/Setup.dist</span></code> and <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> if needed.</li> <li>Run the regression test suite (using <code class="docutils literal notranslate"><span class="pre">-uall</span></code>); watch out for tests that are skipped because an import failed for the removed module.</li> <li>Check in the change (with an appropriate <code class="docutils literal notranslate"><span class="pre">Misc/NEWS</span></code> entry).</li> <li>Update this PEP noting that the 3.0 step is done.</li> </ol> </section> <section id="in-python-2-6"> <h4><a class="toc-backref" href="#in-python-2-6" role="doc-backlink">In Python 2.6</a></h4> <ol class="arabic"> <li>Add the following code to the deprecated module if it is implemented in Python as the first piece of executed code (adjusting the module name and the <code class="docutils literal notranslate"><span class="pre">warnings</span></code> import and needed):<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">warnings</span><span class="w"> </span><span class="kn">import</span> <span class="n">warnpy3k</span> <span class="n">warnpy3k</span><span class="p">(</span><span class="s2">"the XXX module has been removed in Python 3.0"</span><span class="p">,</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> <span class="k">del</span> <span class="n">warnpy3k</span> </pre></div> </div> <p>or the following if it is an extension module:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="p">(</span><span class="n">PyErr_WarnPy3k</span><span class="p">(</span><span class="s2">"the XXX module has been removed in "</span> <span class="s2">"Python 3.0"</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> <span class="o"><</span> <span class="mi">0</span><span class="p">)</span> <span class="k">return</span><span class="p">;</span> </pre></div> </div> <p>(the Python-Dev TextMate bundle, available from <code class="docutils literal notranslate"><span class="pre">Misc/TextMate</span></code>, contains a command that will generate all of this for you).</p> </li> <li>Update the documentation. For modules with their own documentation file, use the <code class="docutils literal notranslate"><span class="pre">:deprecated:</span></code> option with the <code class="docutils literal notranslate"><span class="pre">module</span></code> directive along with the <code class="docutils literal notranslate"><span class="pre">deprecated</span></code> directive, stating the deprecation is occurring in 2.6, but is for the module’s removal in 3.0.:<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>.. deprecated:: 2.6 The :mod:`XXX` module has been removed in Python 3.0. </pre></div> </div> <p>For modules simply listed in a file (e.g., <code class="docutils literal notranslate"><span class="pre">undoc.rst</span></code>), use the <code class="docutils literal notranslate"><span class="pre">warning</span></code> directive.</p> </li> <li>Add the module to the module deletion test in <code class="docutils literal notranslate"><span class="pre">test_py3kwarn</span></code>.</li> <li><dl class="simple"> <dt>Suppress the warning in the module’s test code using</dt><dd><code class="docutils literal notranslate"><span class="pre">test.test_support.import_module(name,</span> <span class="pre">deprecated=True)</span></code>.</dd> </dl> </li> <li>Check in the change w/ appropriate <code class="docutils literal notranslate"><span class="pre">Misc/NEWS</span></code> entry (<strong>block</strong> this checkin in <code class="docutils literal notranslate"><span class="pre">py3k</span></code>!).</li> <li>Update this PEP noting that the 2.6 step is done.</li> </ol> </section> </section> <section id="renaming-of-modules"> <h3><a class="toc-backref" href="#renaming-of-modules" role="doc-backlink">Renaming of modules</a></h3> <p>Support in the 2to3 refactoring tool for renames will be used to help people transition to new module names <a class="footnote-reference brackets" href="#to3" id="id30">[9]</a>. Import statements will be rewritten so that only the import statement and none of the rest of the code needs to be touched. This will be accomplished by using the <code class="docutils literal notranslate"><span class="pre">as</span></code> keyword in import statements to bind in the module namespace to the old name while importing based on the new name (when the keyword is not already used, otherwise the reassigned name should be left alone and only the module that is imported needs to be changed). The <code class="docutils literal notranslate"><span class="pre">fix_imports</span></code> fixer is an example of how to approach this.</p> <section id="python-3-0"> <h4><a class="toc-backref" href="#python-3-0" role="doc-backlink">Python 3.0</a></h4> <ol class="arabic simple"> <li>Update 2to3 in the sandbox to support the rename.</li> <li>Use <code class="docutils literal notranslate"><span class="pre">svn</span> <span class="pre">move</span></code> to rename the module.</li> <li>Update all import statements in the stdlib to use the new name (use 2to3’s <code class="docutils literal notranslate"><span class="pre">fix_imports</span></code> fixer for the easiest solution).</li> <li>Rename the module in its own documentation.</li> <li>Update all references in the documentation from the old name to the new name.</li> <li>Run <code class="docutils literal notranslate"><span class="pre">regrtest.py</span> <span class="pre">-uall</span></code> to verify the rename worked.</li> <li>Add an entry in <code class="docutils literal notranslate"><span class="pre">Misc/NEWS</span></code>.</li> <li>Commit the changes.</li> </ol> </section> <section id="python-2-6"> <h4><a class="toc-backref" href="#python-2-6" role="doc-backlink">Python 2.6</a></h4> <ol class="arabic"> <li>In the module’s documentation, add a note mentioning that the module is renamed in Python 3.0:<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>.. note:: The :mod:`OLDNAME` module has been renamed to :mod:`NEWNAME` in Python 3.0. </pre></div> </div> </li> <li>Commit the documentation change.</li> <li>Block the revision in py3k.</li> </ol> </section> </section> </section> <section id="open-issues"> <h2><a class="toc-backref" href="#open-issues" role="doc-backlink">Open Issues</a></h2> <section id="renaming-of-modules-maintained-outside-of-the-stdlib"> <h3><a class="toc-backref" href="#renaming-of-modules-maintained-outside-of-the-stdlib" role="doc-backlink">Renaming of modules maintained outside of the stdlib</a></h3> <p>xml.etree.ElementTree not only does not meet <a class="pep reference internal" href="../pep-0008/" title="PEP 8 – Style Guide for Python Code">PEP 8</a> naming standards but it also has an exposed C implementation. It is an externally maintained package, though <a class="pep reference internal" href="../pep-0360/" title="PEP 360 – Externally Maintained Packages">PEP 360</a>. A request will be made for the maintainer to change the name so that it matches <a class="pep reference internal" href="../pep-0008/" title="PEP 8 – Style Guide for Python Code">PEP 8</a> and hides the C implementation.</p> </section> </section> <section id="rejected-ideas"> <h2><a class="toc-backref" href="#rejected-ideas" role="doc-backlink">Rejected Ideas</a></h2> <section id="modules-that-were-originally-suggested-for-removal"> <h3><a class="toc-backref" href="#modules-that-were-originally-suggested-for-removal" role="doc-backlink">Modules that were originally suggested for removal</a></h3> <ul class="simple"> <li>asynchat/asyncore<ul> <li>Josiah Carlson has said he will maintain the modules.</li> </ul> </li> <li>audioop/sunau/aifc<ul> <li>Audio modules where the formats are still used.</li> </ul> </li> <li>base64/quopri/uu<ul> <li>All still widely used.</li> <li>‘codecs’ module does not provide as nice of an API for basic usage.</li> </ul> </li> <li>fileinput<ul> <li>Useful when having to work with stdin.</li> </ul> </li> <li>linecache<ul> <li>Used internally in several places.</li> </ul> </li> <li>nis<ul> <li>Testimonials from people that new installations of NIS are still occurring</li> </ul> </li> <li>getopt<ul> <li>Simpler than optparse.</li> </ul> </li> <li>repr<ul> <li>Useful as a basis for overriding.</li> <li>Used internally.</li> </ul> </li> <li>sched<ul> <li>Useful for simulations.</li> </ul> </li> <li>symtable/_symtable<ul> <li>Docs were written.</li> </ul> </li> <li>telnetlib<ul> <li>Really handy for quick-and-dirty remote access.</li> <li>Some hardware supports using telnet for configuration and querying.</li> </ul> </li> <li>Tkinter<ul> <li>Would prevent IDLE from existing.</li> <li>No GUI toolkit would be available out of the box.</li> </ul> </li> </ul> </section> <section id="introducing-a-new-top-level-package"> <h3><a class="toc-backref" href="#introducing-a-new-top-level-package" role="doc-backlink">Introducing a new top-level package</a></h3> <p>It has been suggested that the entire stdlib be placed within its own package. This PEP will not address this issue as it has its own design issues (naming, does it deserve special consideration in import semantics, etc.). Everything within this PEP can easily be handled if a new top-level package is introduced.</p> </section> <section id="introducing-new-packages-to-contain-theme-related-modules"> <h3><a class="toc-backref" href="#introducing-new-packages-to-contain-theme-related-modules" role="doc-backlink">Introducing new packages to contain theme-related modules</a></h3> <p>During the writing of this PEP it was noticed that certain themes appeared in the stdlib. In the past people have suggested introducing new packages to help collect modules that share a similar theme (e.g., audio). An Open Issue was created to suggest some new packages to introduce.</p> <p>In the end, though, not enough support could be pulled together to warrant moving forward with the idea. Instead name simplification has been chosen as the guiding force for PEPs to create.</p> </section> </section> <section id="references"> <h2><a class="toc-backref" href="#references" role="doc-backlink">References</a></h2> <aside class="footnote-list brackets"> <aside class="footnote brackets" id="silly-old-stuff" role="doc-footnote"> <dt class="label" id="silly-old-stuff">[<a href="#id1">7</a>]</dt> <dd>Python-Dev email: “Py3k release schedule worries” (<a class="reference external" href="https://mail.python.org/pipermail/python-3000/2006-December/005130.html">https://mail.python.org/pipermail/python-3000/2006-December/005130.html</a>)</aside> <aside class="footnote brackets" id="thread-deprecation" role="doc-footnote"> <dt class="label" id="thread-deprecation">[<a href="#id11">8</a>]</dt> <dd>Python-Dev email: Autoloading? (<a class="reference external" href="https://mail.python.org/pipermail/python-dev/2005-October/057244.html">https://mail.python.org/pipermail/python-dev/2005-October/057244.html</a>)</aside> <aside class="footnote brackets" id="to3" role="doc-footnote"> <dt class="label" id="to3">[<a href="#id30">9</a>]</dt> <dd>2to3 refactoring tool (<a class="reference external" href="http://svn.python.org/view/sandbox/trunk/2to3/">http://svn.python.org/view/sandbox/trunk/2to3/</a>)</aside> <aside class="footnote brackets" id="pyopengl" role="doc-footnote"> <dt class="label" id="pyopengl">[<a href="#id3">10</a>]</dt> <dd>PyOpenGL (<a class="reference external" href="http://pyopengl.sourceforge.net/">http://pyopengl.sourceforge.net/</a>)</aside> <aside class="footnote brackets" id="pil" role="doc-footnote"> <dt class="label" id="pil">[11]<em> (<a href='#id5'>1</a>, <a href='#id6'>2</a>, <a href='#id10'>3</a>) </em></dt> <dd>Python Imaging Library (PIL) (<a class="reference external" href="http://www.pythonware.com/products/pil/">http://www.pythonware.com/products/pil/</a>)</aside> <aside class="footnote brackets" id="twisted" role="doc-footnote"> <dt class="label" id="twisted">[12]</dt> <dd>Twisted (<a class="reference external" href="http://twistedmatrix.com/trac/">http://twistedmatrix.com/trac/</a>)</aside> <aside class="footnote brackets" id="irix-retirement" role="doc-footnote"> <dt class="label" id="irix-retirement">[<a href="#id2">13</a>]</dt> <dd>SGI Press Release: End of General Availability for MIPS IRIX Products – December 2006 (<a class="reference external" href="http://www.sgi.com/support/mips_irix.html">http://www.sgi.com/support/mips_irix.html</a>)</aside> <aside class="footnote brackets" id="irix-forms" role="doc-footnote"> <dt class="label" id="irix-forms">[<a href="#id4">14</a>]</dt> <dd>FORMS Library by Mark Overmars (<a class="reference external" href="ftp://ftp.cs.ruu.nl/pub/SGI/FORMS">ftp://ftp.cs.ruu.nl/pub/SGI/FORMS</a>)</aside> <aside class="footnote brackets" id="appscript" role="doc-footnote"> <dt class="label" id="appscript">[<a href="#id7">15</a>]</dt> <dd>appscript (<a class="reference external" href="http://appscript.sourceforge.net/">http://appscript.sourceforge.net/</a>)</aside> <aside class="footnote brackets" id="ast" role="doc-footnote"> <dt class="label" id="ast">[<a href="#id9">16</a>]</dt> <dd>_ast module (<a class="reference external" href="http://docs.python.org/library/ast.html">http://docs.python.org/library/ast.html</a>)</aside> <aside class="footnote brackets" id="ast-removal" role="doc-footnote"> <dt class="label" id="ast-removal">[<a href="#id8">17</a>]</dt> <dd>python-dev email: getting compiler package failures (<a class="reference external" href="https://mail.python.org/pipermail/python-3000/2007-May/007615.html">https://mail.python.org/pipermail/python-3000/2007-May/007615.html</a>)</aside> </aside> </section> <section id="copyright"> <h2><a class="toc-backref" href="#copyright" role="doc-backlink">Copyright</a></h2> <p>This document has been placed in the public domain.</p> </section> </section> <hr class="docutils" /> <p>Source: <a class="reference external" href="https://github.com/python/peps/blob/main/peps/pep-3108.rst">https://github.com/python/peps/blob/main/peps/pep-3108.rst</a></p> <p>Last modified: <a class="reference external" href="https://github.com/python/peps/commits/main/peps/pep-3108.rst">2025-01-30 01:20:11 GMT</a></p> </article> <nav id="pep-sidebar"> <h2>Contents</h2> <ul> <li><a class="reference internal" href="#abstract">Abstract</a></li> <li><a class="reference internal" href="#modules-to-remove">Modules to Remove</a><ul> <li><a class="reference internal" href="#previously-deprecated-done">Previously deprecated [done]</a></li> <li><a class="reference internal" href="#platform-specific-with-minimal-use-done">Platform-specific with minimal use [done]</a><ul> <li><a class="reference internal" href="#irix">IRIX</a></li> <li><a class="reference internal" href="#mac-specific-modules">Mac-specific modules</a></li> <li><a class="reference internal" href="#solaris">Solaris</a></li> </ul> </li> <li><a class="reference internal" href="#hardly-used-done">Hardly used [done]</a></li> <li><a class="reference internal" href="#obsolete">Obsolete</a></li> <li><a class="reference internal" href="#maintenance-burden">Maintenance Burden</a></li> </ul> </li> <li><a class="reference internal" href="#modules-to-rename">Modules to Rename</a><ul> <li><a class="reference internal" href="#pep-8-violations-done">PEP 8 violations [done]</a></li> <li><a class="reference internal" href="#merging-c-and-python-implementations-of-the-same-interface">Merging C and Python implementations of the same interface</a></li> <li><a class="reference internal" href="#no-public-documented-interface-done">No public, documented interface [done]</a></li> <li><a class="reference internal" href="#poorly-chosen-names-done">Poorly chosen names [done]</a></li> <li><a class="reference internal" href="#grouping-of-modules-done">Grouping of modules [done]</a><ul> <li><a class="reference internal" href="#dbm-package">dbm package</a></li> <li><a class="reference internal" href="#html-package">html package</a></li> <li><a class="reference internal" href="#http-package">http package</a></li> <li><a class="reference internal" href="#tkinter-package">tkinter package</a></li> <li><a class="reference internal" href="#urllib-package">urllib package</a></li> <li><a class="reference internal" href="#xmlrpc-package">xmlrpc package</a></li> </ul> </li> </ul> </li> <li><a class="reference internal" href="#transition-plan">Transition Plan</a><ul> <li><a class="reference internal" href="#issues">Issues</a></li> <li><a class="reference internal" href="#for-modules-to-be-removed">For modules to be removed</a><ul> <li><a class="reference internal" href="#in-python-3-0">In Python 3.0</a></li> <li><a class="reference internal" href="#in-python-2-6">In Python 2.6</a></li> </ul> </li> <li><a class="reference internal" href="#renaming-of-modules">Renaming of modules</a><ul> <li><a class="reference internal" href="#python-3-0">Python 3.0</a></li> <li><a class="reference internal" href="#python-2-6">Python 2.6</a></li> </ul> </li> </ul> </li> <li><a class="reference internal" href="#open-issues">Open Issues</a><ul> <li><a class="reference internal" href="#renaming-of-modules-maintained-outside-of-the-stdlib">Renaming of modules maintained outside of the stdlib</a></li> </ul> </li> <li><a class="reference internal" href="#rejected-ideas">Rejected Ideas</a><ul> <li><a class="reference internal" href="#modules-that-were-originally-suggested-for-removal">Modules that were originally suggested for removal</a></li> <li><a class="reference internal" href="#introducing-a-new-top-level-package">Introducing a new top-level package</a></li> <li><a class="reference internal" href="#introducing-new-packages-to-contain-theme-related-modules">Introducing new packages to contain theme-related modules</a></li> </ul> </li> <li><a class="reference internal" href="#references">References</a></li> <li><a class="reference internal" href="#copyright">Copyright</a></li> </ul> <br> <a id="source" href="https://github.com/python/peps/blob/main/peps/pep-3108.rst">Page Source (GitHub)</a> </nav> </section> <script src="../_static/colour_scheme.js"></script> <script src="../_static/wrap_tables.js"></script> <script src="../_static/sticky_banner.js"></script> </body> </html>