Doc: http.server: directory is not a class attribute, but an argument. (GH-26017)

* Doc: http.server: directory is not a class attribute, but an argument.
This commit is contained in:
Julien Palard 2021-05-11 03:26:53 +02:00 committed by GitHub
parent c0190137ca
commit d1b81574ed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -320,9 +320,16 @@ provides three different variants:
.. class:: SimpleHTTPRequestHandler(request, client_address, server, directory=None) .. class:: SimpleHTTPRequestHandler(request, client_address, server, directory=None)
This class serves files from the current directory and below, directly This class serves files from the directory *directory* and below,
or the current directory if *directory* is not provided, directly
mapping the directory structure to HTTP requests. mapping the directory structure to HTTP requests.
.. versionadded:: 3.7
The *directory* parameter.
.. versionchanged:: 3.9
The *directory* parameter accepts a :term:`path-like object`.
A lot of the work, such as parsing the request, is done by the base class A lot of the work, such as parsing the request, is done by the base class
:class:`BaseHTTPRequestHandler`. This class implements the :func:`do_GET` :class:`BaseHTTPRequestHandler`. This class implements the :func:`do_GET`
and :func:`do_HEAD` functions. and :func:`do_HEAD` functions.
@ -345,13 +352,6 @@ provides three different variants:
This dictionary is no longer filled with the default system mappings, This dictionary is no longer filled with the default system mappings,
but only contains overrides. but only contains overrides.
.. attribute:: directory
If not specified, the directory to serve is the current working directory.
.. versionchanged:: 3.9
Accepts a :term:`path-like object`.
The :class:`SimpleHTTPRequestHandler` class defines the following methods: The :class:`SimpleHTTPRequestHandler` class defines the following methods:
.. method:: do_HEAD() .. method:: do_HEAD()