Skip to content

Commit

Permalink
Doc: http.server: directory is not a class attribute, but an argument. (
Browse files Browse the repository at this point in the history
GH-26017) (GH-26030)

* Doc: http.server: directory is not a class attribute, but an argument.
(cherry picked from commit d1b8157)

Co-authored-by: Julien Palard <julien@palard.fr>

Co-authored-by: Julien Palard <julien@palard.fr>
  • Loading branch information
miss-islington and JulienPalard committed May 11, 2021
1 parent b488408 commit 1d8c180
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions Doc/library/http.server.rst
Expand Up @@ -320,9 +320,16 @@ provides three different variants:

.. 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.

.. 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
:class:`BaseHTTPRequestHandler`. This class implements the :func:`do_GET`
and :func:`do_HEAD` functions.
Expand All @@ -345,13 +352,6 @@ provides three different variants:
This dictionary is no longer filled with the default system mappings,
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:

.. method:: do_HEAD()
Expand Down

0 comments on commit 1d8c180

Please sign in to comment.