summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSenthil Kumaran <orsenthil@gmail.com>2010-06-16 16:41:11 (GMT)
committerSenthil Kumaran <orsenthil@gmail.com>2010-06-16 16:41:11 (GMT)
commit97db43b6cc1f7c7e16ab09b908bbeaedb000cfe3 (patch)
treea673eaecad35b5ef597cad5a8f602ab6dabd63ec
parent17c371ca30cfec69e8085ed784969f2ecf4b9e0e (diff)
downloadcpython-97db43b6cc1f7c7e16ab09b908bbeaedb000cfe3.zip
cpython-97db43b6cc1f7c7e16ab09b908bbeaedb000cfe3.tar.gz
cpython-97db43b6cc1f7c7e16ab09b908bbeaedb000cfe3.tar.bz2
Merged revisions 82018 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r82018 | senthil.kumaran | 2010-06-16 20:25:31 +0530 (Wed, 16 Jun 2010) | 3 lines Fix Issue8937 - SimpleHTTPServer should contain usage example ........
-rw-r--r--Doc/library/http.server.rst24
1 files changed, 23 insertions, 1 deletions
diff --git a/Doc/library/http.server.rst b/Doc/library/http.server.rst
index d647980..3d15b9e 100644
--- a/Doc/library/http.server.rst
+++ b/Doc/library/http.server.rst
@@ -281,8 +281,30 @@ of which this module provides three different variants:
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.
+ For example usage, see the implementation of the :func:`test` function
+ invocation in the :mod:`http.server` module.
+The :class:`SimpleHTTPRequestHandler` class can be invoked the following manner
+with the :mod:`http.server` to create a very basic webserver serving files
+relative to the current directory.::
+
+ import http.server
+ import socketserver
+
+ PORT = 8000
+
+ Handler = http.server.SimpleHTTPRequestHandler
+
+ httpd = socketserver.TCPServer(("", PORT), Handler)
+
+ print("serving at port", PORT)
+ httpd.serve_forever()
+
+:mod:`http.server` can also be invoked directly using the ``-m`` switch of
+interpreter a with ``port number`` argument which interfaces
+:class:`SimpleHTTPRequestHandler` by default.::
+
+ python -m http.server 8000
.. class:: CGIHTTPRequestHandler(request, client_address, server)