gh-91219: http - use subclassing to override index_pages attribute (GH-100731)

Remove previously added parameter to `__init__`, and recommend subclassing to modify the `index_pages` attribute instead.
This commit is contained in:
Ethan Furman 2023-01-03 15:20:08 -08:00 committed by GitHub
parent 64ed609c53
commit a286caa937
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 4 deletions

View File

@ -413,6 +413,11 @@ the current directory::
print("serving at port", PORT)
httpd.serve_forever()
:class:`SimpleHTTPRequestHandler` can also be subclassed to enhance behavior,
such as using different index file names by overriding the class attribute
:attr:`index_pages`.
.. _http-server-cli:
:mod:`http.server` can also be invoked directly using the :option:`-m`

View File

@ -652,8 +652,8 @@ class SimpleHTTPRequestHandler(BaseHTTPRequestHandler):
"""
index_pages = ["index.html", "index.htm"]
server_version = "SimpleHTTP/" + __version__
index_pages = ("index.html", "index.htm")
extensions_map = _encodings_map_default = {
'.gz': 'application/gzip',
'.Z': 'application/octet-stream',
@ -661,11 +661,9 @@ class SimpleHTTPRequestHandler(BaseHTTPRequestHandler):
'.xz': 'application/x-xz',
}
def __init__(self, *args, directory=None, index_pages=None, **kwargs):
def __init__(self, *args, directory=None, **kwargs):
if directory is None:
directory = os.getcwd()
if index_pages is not None:
self.index_pages = index_pages
self.directory = os.fspath(directory)
super().__init__(*args, **kwargs)

View File

@ -0,0 +1,2 @@
Change ``SimpleHTTPRequestHandler`` to support subclassing to provide a
different set of index file names instead of using ``__init__`` parameters.