From 5149742e8b3c8221d4cb53dcfc9a12ae3fec9238 Mon Sep 17 00:00:00 2001 From: Jeroen Ruigrok van der Werven Date: Thu, 19 Feb 2009 18:52:21 +0000 Subject: Since we recommend one module per import line, reflect this also in the documentation. --- Doc/howto/doanddont.rst | 3 ++- Doc/howto/webservers.rst | 7 +++++-- Doc/includes/sqlite3/adapter_datetime.py | 3 ++- Doc/library/asyncore.rst | 3 ++- Doc/library/cgi.rst | 12 ++++++++---- Doc/library/configparser.rst | 3 ++- Doc/library/cookielib.rst | 7 +++++-- Doc/library/crypt.rst | 4 +++- Doc/library/csv.rst | 7 +++++-- Doc/library/difflib.rst | 6 +++++- Doc/library/doctest.rst | 6 ++++-- Doc/library/fcntl.rst | 4 +++- Doc/library/getopt.rst | 3 ++- Doc/library/gl.rst | 4 +++- Doc/library/imaplib.rst | 3 ++- Doc/library/imputil.rst | 4 +++- Doc/library/logging.rst | 7 +++++-- Doc/library/modulefinder.rst | 3 ++- Doc/library/pickle.rst | 3 ++- Doc/library/poplib.rst | 3 ++- Doc/library/signal.rst | 3 ++- Doc/library/sqlite3.rst | 3 ++- Doc/library/ssl.rst | 7 +++++-- Doc/library/stat.rst | 3 ++- Doc/library/sunaudio.rst | 6 ++++-- Doc/library/termios.rst | 3 ++- Doc/library/traceback.rst | 6 ++++-- Doc/library/xmlrpclib.rst | 3 ++- Doc/tutorial/interactive.rst | 3 ++- Doc/tutorial/stdlib2.rst | 3 ++- Doc/whatsnew/2.6.rst | 3 ++- 31 files changed, 96 insertions(+), 42 deletions(-) diff --git a/Doc/howto/doanddont.rst b/Doc/howto/doanddont.rst index a56fb8c..b4f271e 100644 --- a/Doc/howto/doanddont.rst +++ b/Doc/howto/doanddont.rst @@ -267,7 +267,8 @@ sequence with comparable semantics, for example, yet many people write their own :func:`max`/:func:`min`. Another highly useful function is :func:`reduce`. A classical use of :func:`reduce` is something like :: - import sys, operator + import operator + import sys nums = map(float, sys.argv[1:]) print reduce(operator.add, nums)/len(nums) diff --git a/Doc/howto/webservers.rst b/Doc/howto/webservers.rst index 6e0c815..1b8e041 100644 --- a/Doc/howto/webservers.rst +++ b/Doc/howto/webservers.rst @@ -99,7 +99,8 @@ simple CGI program:: # -*- coding: UTF-8 -*- # enable debugging - import cgitb; cgitb.enable() + import cgitb + cgitb.enable() print "Content-Type: text/plain;charset=utf-8" print @@ -279,7 +280,9 @@ following WSGI-application:: # -*- coding: UTF-8 -*- from cgi import escape - import sys, os + import os + import sys + from flup.server.fcgi import WSGIServer def app(environ, start_response): diff --git a/Doc/includes/sqlite3/adapter_datetime.py b/Doc/includes/sqlite3/adapter_datetime.py index 3460498..56e533f 100644 --- a/Doc/includes/sqlite3/adapter_datetime.py +++ b/Doc/includes/sqlite3/adapter_datetime.py @@ -1,5 +1,6 @@ +import datetime import sqlite3 -import datetime, time +import time def adapt_datetime(ts): return time.mktime(ts.timetuple()) diff --git a/Doc/library/asyncore.rst b/Doc/library/asyncore.rst index 4736a9c..e7ef925 100644 --- a/Doc/library/asyncore.rst +++ b/Doc/library/asyncore.rst @@ -246,7 +246,8 @@ asyncore Example basic HTTP client Here is a very basic HTTP client that uses the :class:`dispatcher` class to implement its socket handling:: - import asyncore, socket + import asyncore + import socket class http_client(asyncore.dispatcher): diff --git a/Doc/library/cgi.rst b/Doc/library/cgi.rst index 0248284..6ad061f 100644 --- a/Doc/library/cgi.rst +++ b/Doc/library/cgi.rst @@ -67,16 +67,20 @@ Begin by writing ``import cgi``. Do not use ``from cgi import *`` --- the module defines all sorts of names for its own use or for backward compatibility that you don't want in your namespace. -When you write a new script, consider adding the line:: +When you write a new script, consider adding the following:: - import cgitb; cgitb.enable() + import cgitb + + cgitb.enable() This activates a special exception handler that will display detailed reports in the Web browser if any errors occur. If you'd rather not show the guts of your program to users of your script, you can have the reports saved to files -instead, with a line like this:: +instead, with something like this:: + + import cgitb - import cgitb; cgitb.enable(display=0, logdir="/tmp") + cgitb.enable(display=0, logdir="/tmp") It's very helpful to use this feature during script development. The reports produced by :mod:`cgitb` provide information that can save you a lot of time in diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst index 1de11b9..a04badb 100644 --- a/Doc/library/configparser.rst +++ b/Doc/library/configparser.rst @@ -231,7 +231,8 @@ RawConfigParser Objects load the required file or files using :meth:`readfp` before calling :meth:`read` for any optional files:: - import ConfigParser, os + import ConfigParser + import os config = ConfigParser.ConfigParser() config.readfp(open('defaults.cfg')) diff --git a/Doc/library/cookielib.rst b/Doc/library/cookielib.rst index 12a12a0..c52fca3 100644 --- a/Doc/library/cookielib.rst +++ b/Doc/library/cookielib.rst @@ -747,7 +747,8 @@ Examples The first example shows the most common usage of :mod:`cookielib`:: - import cookielib, urllib2 + import cookielib + import urllib2 cj = cookielib.CookieJar() opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj)) r = opener.open("http://example.com/") @@ -755,7 +756,9 @@ The first example shows the most common usage of :mod:`cookielib`:: This example illustrates how to open a URL using your Netscape, Mozilla, or Lynx cookies (assumes Unix/Netscape convention for location of the cookies file):: - import os, cookielib, urllib2 + import cookielib + import os + import urllib2 cj = cookielib.MozillaCookieJar() cj.load(os.path.join(os.environ["HOME"], ".netscape/cookies.txt")) opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj)) diff --git a/Doc/library/crypt.rst b/Doc/library/crypt.rst index 2f037c7..f8d4f92 100644 --- a/Doc/library/crypt.rst +++ b/Doc/library/crypt.rst @@ -45,7 +45,9 @@ this module. A simple example illustrating typical use:: - import crypt, getpass, pwd + import crypt + import getpass + import pwd def login(): username = raw_input('Python login:') diff --git a/Doc/library/csv.rst b/Doc/library/csv.rst index f19574b..4b402b1 100644 --- a/Doc/library/csv.rst +++ b/Doc/library/csv.rst @@ -460,7 +460,8 @@ Registering a new dialect:: A slightly more advanced use of the reader --- catching and reporting errors:: - import csv, sys + import csv + import sys filename = "some.csv" reader = csv.reader(open(filename, "rb")) try: @@ -506,7 +507,9 @@ For all other encodings the following :class:`UnicodeReader` and parameter in their constructor and make sure that the data passes the real reader or writer encoded as UTF-8:: - import csv, codecs, cStringIO + import codecs + import cStringIO + import csv class UTF8Recoder: """ diff --git a/Doc/library/difflib.rst b/Doc/library/difflib.rst index addd813..701c5d5 100644 --- a/Doc/library/difflib.rst +++ b/Doc/library/difflib.rst @@ -708,7 +708,11 @@ It is also contained in the Python source distribution, as """ - import sys, os, time, difflib, optparse + import difflib + import os + import optparse + import sys + import time def main(): # Configure the option parser diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst index 31e6d0f..49db1c8 100644 --- a/Doc/library/doctest.rst +++ b/Doc/library/doctest.rst @@ -951,9 +951,11 @@ Python 2.4, :mod:`doctest`'s :class:`Tester` class is deprecated, and test suites from modules and text files containing doctests. These test suites can then be run using :mod:`unittest` test runners:: - import unittest import doctest - import my_module_with_doctests, and_another + import unittest + + import my_module_with_doctests + import my_other_module_with_doctests suite = unittest.TestSuite() for mod in my_module_with_doctests, and_another: diff --git a/Doc/library/fcntl.rst b/Doc/library/fcntl.rst index b3b977f..c9118f0 100644 --- a/Doc/library/fcntl.rst +++ b/Doc/library/fcntl.rst @@ -133,7 +133,9 @@ The module defines the following functions: Examples (all on a SVR4 compliant system):: - import struct, fcntl, os + import fcntl + import os + import struct f = open(...) rv = fcntl.fcntl(f, fcntl.F_SETFL, os.O_NDELAY) diff --git a/Doc/library/getopt.rst b/Doc/library/getopt.rst index 2c0fad9..78958ee 100644 --- a/Doc/library/getopt.rst +++ b/Doc/library/getopt.rst @@ -114,7 +114,8 @@ Using long option names is equally easy: In a script, typical usage is something like this:: - import getopt, sys + import getopt + import sys def main(): try: diff --git a/Doc/library/gl.rst b/Doc/library/gl.rst index cbc175a..6a0a92a 100644 --- a/Doc/library/gl.rst +++ b/Doc/library/gl.rst @@ -124,7 +124,9 @@ The following functions are non-standard or have special argument conventions: Here is a tiny but complete example GL program in Python:: - import gl, GL, time + import gl + import GL + import time def main(): gl.foreground() diff --git a/Doc/library/imaplib.rst b/Doc/library/imaplib.rst index e18d7d5..e0b824e 100644 --- a/Doc/library/imaplib.rst +++ b/Doc/library/imaplib.rst @@ -521,7 +521,8 @@ IMAP4 Example Here is a minimal example (without error checking) that opens a mailbox and retrieves and prints all messages:: - import getpass, imaplib + import getpass + import imaplib M = imaplib.IMAP4() M.login(getpass.getuser(), getpass.getpass()) diff --git a/Doc/library/imputil.rst b/Doc/library/imputil.rst index 09a41f6..d36d1a0 100644 --- a/Doc/library/imputil.rst +++ b/Doc/library/imputil.rst @@ -112,7 +112,9 @@ This code is intended to be read, not executed. However, it does work :: - import sys, imp, __builtin__ + import __builtin__ + import imp + import sys # Replacement for __import__() def import_hook(name, globals=None, locals=None, fromlist=None): diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst index 8226661..554318a 100644 --- a/Doc/library/logging.rst +++ b/Doc/library/logging.rst @@ -1347,7 +1347,8 @@ Let's say you want to send logging events across a network, and handle them at the receiving end. A simple way of doing this is attaching a :class:`SocketHandler` instance to the root logger at the sending end:: - import logging, logging.handlers + import logging + import logging.handlers rootLogger = logging.getLogger('') rootLogger.setLevel(logging.DEBUG) @@ -2600,7 +2601,9 @@ properly preceded with the binary-encoded length, as the new logging configuration:: #!/usr/bin/env python - import socket, sys, struct + import socket + import struct + import sys data_to_send = open(sys.argv[1], "r").read() diff --git a/Doc/library/modulefinder.rst b/Doc/library/modulefinder.rst index a086206..9af5335 100644 --- a/Doc/library/modulefinder.rst +++ b/Doc/library/modulefinder.rst @@ -64,7 +64,8 @@ Example usage of :class:`ModuleFinder` The script that is going to get analyzed later on (bacon.py):: - import re, itertools + import itertools + import re try: import baconhameggs diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst index a99dc86..8d153ec 100644 --- a/Doc/library/pickle.rst +++ b/Doc/library/pickle.rst @@ -708,7 +708,8 @@ The following example reads the resulting pickled data. When reading a pickle-containing file, you should open the file in binary mode because you can't be sure if the ASCII or binary format was used. :: - import pprint, pickle + import pickle + import pprint pkl_file = open('data.pkl', 'rb') diff --git a/Doc/library/poplib.rst b/Doc/library/poplib.rst index e5f693d..891e20e 100644 --- a/Doc/library/poplib.rst +++ b/Doc/library/poplib.rst @@ -182,7 +182,8 @@ POP3 Example Here is a minimal example (without error checking) that opens a mailbox and retrieves and prints all messages:: - import getpass, poplib + import getpass + import poplib M = poplib.POP3('localhost') M.user(getpass.getuser()) diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst index 3793a89..fbcee6b 100644 --- a/Doc/library/signal.rst +++ b/Doc/library/signal.rst @@ -228,7 +228,8 @@ serial device that may not be turned on, which would normally cause the before opening the file; if the operation takes too long, the alarm signal will be sent, and the handler raises an exception. :: - import signal, os + import os + import signal def handler(signum, frame): print 'Signal handler called with signal', signum diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst index d031c90..1a44284 100644 --- a/Doc/library/sqlite3.rst +++ b/Doc/library/sqlite3.rst @@ -423,7 +423,8 @@ Connection Objects Example:: # Convert file existing_db.db to SQL dump file dump.sql - import sqlite3, os + import os + import sqlite3 con = sqlite3.connect('existing_db.db') with open('dump.sql', 'w') as f: diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst index 30f1fea..572c566 100644 --- a/Doc/library/ssl.rst +++ b/Doc/library/ssl.rst @@ -481,7 +481,9 @@ Client-side operation This example connects to an SSL server, prints the server's address and certificate, sends some bytes, and reads part of the response:: - import socket, ssl, pprint + import pprint + import socket + import ssl s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) @@ -535,7 +537,8 @@ For server operation, typically you'd need to have a server certificate, and pri You'd open a socket, bind it to a port, call :meth:`listen` on it, then start waiting for clients to connect:: - import socket, ssl + import socket + import ssl bindsocket = socket.socket() bindsocket.bind(('myaddr.mydomain.com', 10023)) diff --git a/Doc/library/stat.rst b/Doc/library/stat.rst index 430bb23..835f448 100644 --- a/Doc/library/stat.rst +++ b/Doc/library/stat.rst @@ -139,7 +139,8 @@ on the implementation of the underlying system call. Example:: - import os, sys + import os + import sys from stat import * def walktree(top, callback): diff --git a/Doc/library/sunaudio.rst b/Doc/library/sunaudio.rst index 4d67b21..4908cb4 100644 --- a/Doc/library/sunaudio.rst +++ b/Doc/library/sunaudio.rst @@ -135,11 +135,13 @@ methods (except ``control`` objects which only provide :meth:`getinfo`, The audio device supports asynchronous notification of various events, through the SIGPOLL signal. Here's an example of how you might enable this in Python:: + import fcntl + import signal + import STROPTS + def handle_sigpoll(signum, frame): print 'I got a SIGPOLL update' - import fcntl, signal, STROPTS - signal.signal(signal.SIGPOLL, handle_sigpoll) fcntl.ioctl(audio_obj.fileno(), STROPTS.I_SETSIG, STROPTS.S_MSG) diff --git a/Doc/library/termios.rst b/Doc/library/termios.rst index 4847949..38da7b4 100644 --- a/Doc/library/termios.rst +++ b/Doc/library/termios.rst @@ -91,7 +91,8 @@ technique using a separate :func:`tcgetattr` call and a :keyword:`try` ... exactly no matter what happens:: def getpass(prompt = "Password: "): - import termios, sys + import sys + import termios fd = sys.stdin.fileno() old = termios.tcgetattr(fd) new = termios.tcgetattr(fd) diff --git a/Doc/library/traceback.rst b/Doc/library/traceback.rst index 1260037..29b09ae 100644 --- a/Doc/library/traceback.rst +++ b/Doc/library/traceback.rst @@ -145,7 +145,8 @@ less useful than) the standard Python interactive interpreter loop. For a more complete implementation of the interpreter loop, refer to the :mod:`code` module. :: - import sys, traceback + import sys + import traceback def run_user_code(envdir): source = raw_input(">>> ") @@ -165,7 +166,8 @@ module. :: The following example demonstrates the different ways to print and format the exception and traceback:: - import sys, traceback + import sys + import traceback def lumberjack(): bright_side_of_death() diff --git a/Doc/library/xmlrpclib.rst b/Doc/library/xmlrpclib.rst index 4035f8e..f5aa40e 100644 --- a/Doc/library/xmlrpclib.rst +++ b/Doc/library/xmlrpclib.rst @@ -551,7 +551,8 @@ transport. The following example shows how: :: - import xmlrpclib, httplib + import httplib + import xmlrpclib class ProxiedTransport(xmlrpclib.Transport): def set_proxy(self, proxy): diff --git a/Doc/tutorial/interactive.rst b/Doc/tutorial/interactive.rst index 6a439bd..90981e5 100644 --- a/Doc/tutorial/interactive.rst +++ b/Doc/tutorial/interactive.rst @@ -99,7 +99,8 @@ Automatic completion of variable and module names is optionally available. To enable it in the interpreter's interactive mode, add the following to your startup file: [#]_ :: - import rlcompleter, readline + import readline + import rlcompleter readline.parse_and_bind('tab: complete') This binds the :kbd:`Tab` key to the completion function, so hitting the diff --git a/Doc/tutorial/stdlib2.rst b/Doc/tutorial/stdlib2.rst index 8faa360..b50a3b9 100644 --- a/Doc/tutorial/stdlib2.rst +++ b/Doc/tutorial/stdlib2.rst @@ -170,7 +170,8 @@ case is running I/O in parallel with computations in another thread. The following code shows how the high level :mod:`threading` module can run tasks in background while the main program continues to run:: - import threading, zipfile + import threading + import zipfile class AsyncZip(threading.Thread): def __init__(self, infile, outfile): diff --git a/Doc/whatsnew/2.6.rst b/Doc/whatsnew/2.6.rst index f04f194..17ee766 100644 --- a/Doc/whatsnew/2.6.rst +++ b/Doc/whatsnew/2.6.rst @@ -473,7 +473,8 @@ statement both starts a database transaction and acquires a thread lock:: Finally, the :func:`closing(object)` function returns *object* so that it can be bound to a variable, and calls ``object.close`` at the end of the block. :: - import urllib, sys + import sys + import urllib from contextlib import closing with closing(urllib.urlopen('http://www.yahoo.com')) as f: -- cgit v0.12