From 360e1e4c519cfc139de707bcdd1e6c871eec79ee Mon Sep 17 00:00:00 2001 From: =?utf8?q?St=C3=A9phane=20Wirtel?= Date: Mon, 25 Mar 2019 23:52:56 +0100 Subject: [PATCH] bpo-36345: Add a new example in the documentation of wsgiref (#12511) --- Doc/library/wsgiref.rst | 32 +++++++++++++++++++ .../2019-03-23-09-25-12.bpo-36345.L704Zv.rst | 2 ++ 2 files changed, 34 insertions(+) create mode 100644 Misc/NEWS.d/next/Documentation/2019-03-23-09-25-12.bpo-36345.L704Zv.rst diff --git a/Doc/library/wsgiref.rst b/Doc/library/wsgiref.rst index ffca1fc816..b85ec53c8a 100644 --- a/Doc/library/wsgiref.rst +++ b/Doc/library/wsgiref.rst @@ -781,3 +781,35 @@ This is a working "Hello World" WSGI application:: # Serve until process is killed httpd.serve_forever() + + +Example of a small wsgiref-based web server:: + + # Takes a path to serve from and an optional port number (defaults to 8000), + # then tries to serve files. Mime types are guessed from the file names, 404 + # errors are raised if the file is not found. + import sys + import os + import mimetypes + from wsgiref import simple_server, util + + def app(environ, respond): + fn = os.path.join(path, environ['PATH_INFO'][1:]) + if '.' not in fn.split(os.path.sep)[-1]: + fn = os.path.join(fn, 'index.html') + type = mimetypes.guess_type(fn)[0] + + if os.path.exists(fn): + respond('200 OK', [('Content-Type', type)]) + return util.FileWrapper(open(fn, "rb")) + else: + respond('404 Not Found', [('Content-Type', 'text/plain')]) + return [b'not found'] + + path = sys.argv[1] + port = int(sys.argv[2]) if len(sys.argv) > 2 else 8000 + with simple_server.make_server('', port, app) as httpd: + print("Serving {} on port {}, control-C to stop".format(path, port)) + + # Serve until process is killed + httpd.serve_forever() diff --git a/Misc/NEWS.d/next/Documentation/2019-03-23-09-25-12.bpo-36345.L704Zv.rst b/Misc/NEWS.d/next/Documentation/2019-03-23-09-25-12.bpo-36345.L704Zv.rst new file mode 100644 index 0000000000..c6206a74ab --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2019-03-23-09-25-12.bpo-36345.L704Zv.rst @@ -0,0 +1,2 @@ +Using the code of the ``Tools/scripts/serve.py`` script as an example in the +:mod:`wsgiref` documentation. Contributed by Stéphane Wirtel. -- 2.49.0