FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[3.13] gh-130160: use `.. program::` directive for documenting `http.server` CLI (GH-131010) by miss-islington · Pull Request #131293 · python/cpython · GitHub

/ cpython Public

[3.13] gh-130160: use .. program:: directive for documenting http.server CLI (GH-131010) #131293

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.

Sign up for GitHub

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

Merged
hugovk merged 1 commit into from
Mar 15, 2025
Conversation 0 Commits 1 Checks 0 Files changed
Merged

[3.13] gh-130160: use .. program:: directive for documenting http.server CLI (GH-131010) #131293

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .rst  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
119 changes: 68 additions & 51 deletions Doc/library/http.server.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -418,49 +418,6 @@ the current directory::
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`
switch of the interpreter. Similar to
the previous example, this serves files relative to the current directory::

python -m http.server

The server listens to port 8000 by default. The default can be overridden
by passing the desired port number as an argument::

python -m http.server 9000

By default, the server binds itself to all interfaces. The option ``-b/--bind``
specifies a specific address to which it should bind. Both IPv4 and IPv6
addresses are supported. For example, the following command causes the server
to bind to localhost only::

python -m http.server --bind 127.0.0.1

.. versionchanged:: 3.4
Added the ``--bind`` option.

.. versionchanged:: 3.8
Support IPv6 in the ``--bind`` option.

By default, the server uses the current directory. The option ``-d/--directory``
specifies a directory to which it should serve the files. For example,
the following command uses a specific directory::

python -m http.server --directory /tmp/

.. versionchanged:: 3.7
Added the ``--directory`` option.

By default, the server is conformant to HTTP/1.0. The option ``-p/--protocol``
specifies the HTTP version to which the server is conformant. For example, the
following command runs an HTTP/1.1 conformant server::

python -m http.server --protocol HTTP/1.1

.. versionchanged:: 3.11
Added the ``--protocol`` option.

.. class:: CGIHTTPRequestHandler(request, client_address, server)

Expand Down Expand Up @@ -510,25 +467,85 @@ following command runs an HTTP/1.1 conformant server::
Retaining it could lead to further :ref:`security considerations
<http.server-security>`.

:class:`CGIHTTPRequestHandler` can be enabled in the command line by passing
the ``--cgi`` option::

python -m http.server --cgi
.. _http-server-cli:

Command-line interface
----------------------

:mod:`http.server` can also be invoked directly using the :option:`-m`
switch of the interpreter. The following example illustrates how to serve
files relative to the current directory::

python -m http.server [OPTIONS] [port]

The following options are accepted:

.. program:: http.server

.. deprecated-removed:: 3.13 3.15
.. option:: port

:mod:`http.server` command line ``--cgi`` support is being removed
because :class:`CGIHTTPRequestHandler` is being removed.
The server listens to port 8000 by default. The default can be overridden
by passing the desired port number as an argument::

python -m http.server 9000

.. option:: -b, --bind <address>

Specifies a specific address to which it should bind. Both IPv4 and IPv6
addresses are supported. By default, the server binds itself to all
interfaces. For example, the following command causes the server to bind
to localhost only::

python -m http.server --bind 127.0.0.1

.. versionadded:: 3.4

.. versionchanged:: 3.8
Support IPv6 in the ``--bind`` option.

.. option:: -d, --directory <dir>

Specifies a directory to which it should serve the files. By default,
the server uses the current directory. For example, the following command
uses a specific directory::

python -m http.server --directory /tmp/

.. versionadded:: 3.7

.. option:: -p, --protocol <version>

Specifies the HTTP version to which the server is conformant. By default,
the server is conformant to HTTP/1.0. For example, the following command
runs an HTTP/1.1 conformant server::

python -m http.server --protocol HTTP/1.1

.. versionadded:: 3.11

.. option:: --cgi

:class:`CGIHTTPRequestHandler` can be enabled in the command line by passing
the ``--cgi`` option::

python -m http.server --cgi

.. deprecated-removed:: 3.13 3.15

:mod:`http.server` command line ``--cgi`` support is being removed
because :class:`CGIHTTPRequestHandler` is being removed.

.. warning::

:class:`CGIHTTPRequestHandler` and the ``--cgi`` command line option
:class:`CGIHTTPRequestHandler` and the ``--cgi`` command-line option
are not intended for use by untrusted clients and may be vulnerable
to exploitation. Always use within a secure environment.


.. _http.server-security:

Security Considerations
Security considerations
-----------------------

.. index:: pair: http.server; security
Expand Down
Back | FazBrowse Home | New Git URL