Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-36345: Include the code from Tools/scripts/serve.py for the wsgiref-base web server example #12562

Merged
merged 7 commits into from
Apr 16, 2019
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 4 additions & 30 deletions Doc/library/wsgiref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -783,33 +783,7 @@ This is a working "Hello World" WSGI application::
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()
Example of a WSGI application serving the current directory, accept optional
directory and port number on the command line:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
directory and port number on the command line:
directory and port number (default: 8000) on the command line:


.. literalinclude:: ../../Tools/scripts/serve.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Avoid the duplication of code from ``Tools/scripts/serve.py`` in using the
:rst:dir:`literalinclude` directive for the basic wsgiref-based web server in the
documentation of :mod:`wsgiref`. Contributed by Stéphane Wirtel.
2 changes: 1 addition & 1 deletion Tools/scripts/serve.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def app(environ, respond):
return [b'not found']

if __name__ == '__main__':
path = sys.argv[1]
path = sys.argv[1] if len(sys.argv) > 1 else os.getcwd()
port = int(sys.argv[2]) if len(sys.argv) > 2 else 8000
httpd = simple_server.make_server('', port, app)
print("Serving {} on port {}, control-C to stop".format(path, port))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I press CTRL+C, I get a ResourceWarning. Please add httpd.server_close() after print("\b\bShutting down."). By the way, I'm not sure that "\b" is supported on Windows. I suggest to remove ""\b\b" to make the script more portable.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

Expand Down