summaryrefslogtreecommitdiff
path: root/Doc
diff options
context:
space:
mode:
authorAlexandre Vassalotti <alexandre@peadrop.com>2008-05-12 02:11:22 +0000
committerAlexandre Vassalotti <alexandre@peadrop.com>2008-05-12 02:11:22 +0000
commitd192c925ac0d8e7801462b71cd0be033ddb18103 (patch)
tree43eb5af5dc808d5d3c1892096ceed5fecdf3d60a /Doc
parentfb9ce65a91d674b1a80174c70a025aee83783388 (diff)
downloadcpython-git-d192c925ac0d8e7801462b71cd0be033ddb18103.tar.gz
Updated all import statements to use the new socketserver module name.
Renamed socketserver module in its own documentation. Renamed documentation references.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/basehttpserver.rst2
-rw-r--r--Doc/library/logging.rst10
-rw-r--r--Doc/library/simplexmlrpcserver.rst4
-rw-r--r--Doc/library/socket.rst2
-rw-r--r--Doc/library/socketserver.rst9
5 files changed, 13 insertions, 14 deletions
diff --git a/Doc/library/basehttpserver.rst b/Doc/library/basehttpserver.rst
index 0fbf8b0687..7d50613438 100644
--- a/Doc/library/basehttpserver.rst
+++ b/Doc/library/basehttpserver.rst
@@ -21,7 +21,7 @@ Usually, this module isn't used directly, but is used as a basis for building
functioning Web servers. See the :mod:`SimpleHTTPServer` and
:mod:`CGIHTTPServer` modules.
-The first class, :class:`HTTPServer`, is a :class:`SocketServer.TCPServer`
+The first class, :class:`HTTPServer`, is a :class:`socketserver.TCPServer`
subclass. It creates and listens at the HTTP socket, dispatching the requests
to a handler. Code to create and run the server looks like this::
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index 1f7c59b06a..371ece38d9 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -1299,17 +1299,17 @@ the receiving end. A simple way of doing this is attaching a
logger2.warning('Jail zesty vixen who grabbed pay from quack.')
logger2.error('The five boxing wizards jump quickly.')
-At the receiving end, you can set up a receiver using the :mod:`SocketServer`
+At the receiving end, you can set up a receiver using the :mod:`socketserver`
module. Here is a basic working example::
import cPickle
import logging
import logging.handlers
- import SocketServer
+ import socketserver
import struct
- class LogRecordStreamHandler(SocketServer.StreamRequestHandler):
+ class LogRecordStreamHandler(socketserver.StreamRequestHandler):
"""Handler for a streaming logging request.
This basically logs the record using whatever logging policy is
@@ -1351,7 +1351,7 @@ module. Here is a basic working example::
# cycles and network bandwidth!
logger.handle(record)
- class LogRecordSocketReceiver(SocketServer.ThreadingTCPServer):
+ class LogRecordSocketReceiver(socketserver.ThreadingTCPServer):
"""simple TCP socket-based logging receiver suitable for testing.
"""
@@ -1360,7 +1360,7 @@ module. Here is a basic working example::
def __init__(self, host='localhost',
port=logging.handlers.DEFAULT_TCP_LOGGING_PORT,
handler=LogRecordStreamHandler):
- SocketServer.ThreadingTCPServer.__init__(self, (host, port), handler)
+ socketserver.ThreadingTCPServer.__init__(self, (host, port), handler)
self.abort = 0
self.timeout = 1
self.logname = None
diff --git a/Doc/library/simplexmlrpcserver.rst b/Doc/library/simplexmlrpcserver.rst
index c788d55d57..d434210d66 100644
--- a/Doc/library/simplexmlrpcserver.rst
+++ b/Doc/library/simplexmlrpcserver.rst
@@ -22,7 +22,7 @@ XML-RPC servers written in Python. Servers can either be free standing, using
functions that can be called by the XML-RPC protocol. The *requestHandler*
parameter should be a factory for request handler instances; it defaults to
:class:`SimpleXMLRPCRequestHandler`. The *addr* and *requestHandler* parameters
- are passed to the :class:`SocketServer.TCPServer` constructor. If *logRequests*
+ are passed to the :class:`socketserver.TCPServer` constructor. If *logRequests*
is true (the default), requests will be logged; setting this parameter to false
will turn off logging. The *allow_none* and *encoding* parameters are passed
on to :mod:`xmlrpclib` and control the XML-RPC responses that will be returned
@@ -63,7 +63,7 @@ SimpleXMLRPCServer Objects
--------------------------
The :class:`SimpleXMLRPCServer` class is based on
-:class:`SocketServer.TCPServer` and provides a means of creating simple, stand
+:class:`socketserver.TCPServer` and provides a means of creating simple, stand
alone XML-RPC servers.
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index e5a8167a63..d05120ebdd 100644
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -481,7 +481,7 @@ The module :mod:`socket` exports the following constants and functions:
.. seealso::
- Module :mod:`SocketServer`
+ Module :mod:`socketserver`
Classes that simplify writing network servers.
diff --git a/Doc/library/socketserver.rst b/Doc/library/socketserver.rst
index 4163a8f581..e24b4296bc 100644
--- a/Doc/library/socketserver.rst
+++ b/Doc/library/socketserver.rst
@@ -1,12 +1,11 @@
-:mod:`SocketServer` --- A framework for network servers
+:mod:`socketserver` --- A framework for network servers
=======================================================
-.. module:: SocketServer
+.. module:: socketserver
:synopsis: A framework for network servers.
-
-The :mod:`SocketServer` module simplifies the task of writing network servers.
+The :mod:`socketserver` module simplifies the task of writing network servers.
There are four basic server classes: :class:`TCPServer` uses the Internet TCP
protocol, which provides for continuous streams of data between the client and
@@ -213,7 +212,7 @@ server classes like :class:`TCPServer`; these methods aren't useful to external
users of the server object.
.. XXX should the default implementations of these be documented, or should
- it be assumed that the user will look at SocketServer.py?
+ it be assumed that the user will look at socketserver.py?
.. function:: finish_request()