From e55a20525e6c32c7d1361e9a61f51c96c366d2ce Mon Sep 17 00:00:00 2001 From: Senthil Kumaran Date: Wed, 16 Jun 2010 14:55:31 +0000 Subject: [PATCH] Fix Issue8937 - SimpleHTTPServer should contain usage example --- Doc/library/simplehttpserver.rst | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/Doc/library/simplehttpserver.rst b/Doc/library/simplehttpserver.rst index bdf66d1cbb4..79e01d0ea53 100644 --- a/Doc/library/simplehttpserver.rst +++ b/Doc/library/simplehttpserver.rst @@ -81,12 +81,34 @@ The :mod:`SimpleHTTPServer` module defines the following class: contents of the file are output. If the file's MIME type starts with ``text/`` the file is opened in text mode; otherwise binary mode is used. - For example usage, see the implementation of the :func:`test` function. + The :func:`test` function in the :mod:`SimpleHTTPServer` module is an + example which interfaces the :class:`SimpleHTTPRequestHandler` as a + Handler to the :mod:`BaseHTTPServer` module. .. versionadded:: 2.5 The ``'Last-Modified'`` header. +The :mod:`SimpleHTTPServer` module can be used the following manner in order to +setup a very basic web server serving files relative to the current directory.:: + + import SimpleHTTPServer + import SocketServer + + PORT = 8000 + + Handler = SimpleHTTPServer.SimpleHTTPRequestHandler + + httpd = SocketServer.TCPServer(("", PORT), Handler) + + print "serving at port", PORT + httpd.serve_forever() + +It can also be invoked directly using the ``-m`` switch of interpreter a with +``port number`` argument.:: + + python -m SimpleHTTPServer 8000 + .. seealso:: Module :mod:`BaseHTTPServer`