Doc: make serve uses http.server instead of Tools/scripts/server.py

[matrixise]

BPO	36345
Nosy	@brettcannon, @vstinner, @ned-deily, @berkerpeksag, @serhiy-storchaka, @matrixise, @JulienPalard
PRs	bpo-36345: Doc: make serve uses http.server instead of Tools/scripts/server.py  #12408 bpo-36345: Add a new example in the documentation of wsgiref #12511 WIP: bpo-36345: Remove the deprecated Tools/scripts/serve.py script #12522 bpo-36345: Include the code from Tools/scripts/serve.py for the wsgiref-base web server example #12562

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2019-03-18.13:57:39.273>
labels = ['3.8', 'docs']
title = 'Doc: make serve uses http.server instead of Tools/scripts/server.py'
updated_at = <Date 2019-05-15.08:43:26.810>
user = 'https://github.com/matrixise'

bugs.python.org fields:

activity = <Date 2019-05-15.08:43:26.810>
actor = 'matrixise'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-03-18.13:57:39.273>
creator = 'matrixise'
dependencies = []
files = []
hgrepos = []
issue_num = 36345
keywords = ['patch']
message_count = 22.0
messages = ['338224', '338247', '338258', '338276', '338396', '338631', '338637', '338662', '338665', '338666', '338739', '338741', '338743', '338833', '338864', '338874', '338909', '340338', '341162', '342046', '342060', '342135']
nosy_count = 8.0
nosy_names = ['brett.cannon', 'vstinner', 'ned.deily', 'docs@python', 'berker.peksag', 'serhiy.storchaka', 'matrixise', 'mdk']
pr_nums = ['12408', '12511', '12522', '12562']
priority = 'normal'
resolution = None
stage = 'resolved'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue36345'
versions = ['Python 3.8']

[matrixise]

The Makefile of Doc/ has a serve target. Currently, this one uses [Tools/scripts/serve.py](https://github.com/python/cpython/blob/main/Tools/scripts/serve.py). But since 3.7, this script could be replaced by python -m http.server -d directory.

@mdk and myself thinking we could deprecate [Tools/scripts/serve.py](https://github.com/python/cpython/blob/main/Tools/scripts/serve.py) with a warning and propose to use -m http.server -d directory

[vstinner]

I'm ok with modifying "make server" to reuse http.server, but I'm not sure about deprecating Tools/scripts/serve.py.

serve.py uses wsgiref which is different than http.server. Does anyone use it? I would prefer to keep it. If you want to remove it, please send an email to python-dev to ask who uses it.

"make serve" has been added by bpo-8004 which added Tools/scripts/serve.py.

commit e4c74e1
Author: Dirkjan Ochtman <dirkjan@ochtman.nl>
Date: Wed Feb 24 04:12:11 2010 +0000

Issue bpo-8004: add a serve target to the Doc Makefile.

[serhiy-storchaka]

I disagree with deprecating serve.py. It is a demo for the wsgiref module.

[JulienPalard]

If it's appreciated as a demo for wsgiref, wouldn't it be better to move it inside Doc/library/wsgiref.rst?

It was written specifically for the Doc/Makefile, it's no longer needed for the Doc/Makefile, so the question pops: is it usefull to anyone? If not it's better to drop it (or move it to the documentation as a nice, time-proven example).

[brettcannon]

I agree that if it's a good example of using wsgiref then it should exist in the wsgiref docs as an example. Then that would mean dropping the script and updating the Makefile.

[matrixise]

Hi @mdk and @brett

with your suggestions, I will move the serve.py in the documentation of wsgiref and change Doc/Makefile.

[vstinner]

with your suggestions, I will move the serve.py in the documentation of wsgiref and change Doc/Makefile.

I suggest to write two separated PRs for each change.

[matrixise]

@vstinner

I propose two PRs.

The first one will remove the Tools/scripts/serve.py file and update the Makefile.

The second and independent PR just add a new example in the documentation of wsgiref, the example is based on Tools/scripts/serve.py

[vstinner]

I would remove to move the script into the doc in 1 PR and just modify
Makefile in the other one. So the Makefile can be updated first.

[vstinner]

Maybe others prefer to do both changes at once. I don't know.

[ned-deily]

The files in the Tools directory are installed on user systems by various distributions: for example, in Debian, as part of the python3.x-examples package and by the macOS python.org installer. If you move serve.py, it will no longer be available to end users there. I don't think there is any benefit to removing the file in Tools/scripts and there is some downside; let's leave it there.

https://packages.debian.org/sid/all/python3.7-examples/filelist

[matrixise]

Hi Ned,

There are 3 PRs, part-0, part-1 and part-2

We can ignore the part-1, this one remove serve.py and the two others are independent.