Skip to content

Add a security warning to pydoc #150409

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

Open
StanFromIreland wants to merge 2 commits into
base: main
Choose a base branch
from
+5 −0
Open

Add a security warning to pydoc #150409

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9b96cd
Add a secuirty warning to `pydoc`
StanFromIreland May 25, 2026
e900b15
Move warning as per Bénédikt's request
StanFromIreland May 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Doc/library/pydoc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,11 @@ will start a HTTP server on port 1234, allowing you to browse the
documentation at ``http://localhost:1234/`` in your preferred web browser.
Specifying ``0`` as the port number will select an arbitrary unused port.

.. warning::

The :mod:`!pydoc` HTTP server is intended for local use during
development and is not suitable for production use.

:program:`python -m pydoc -n <hostname>` will start the server listening at the given
hostname. By default the hostname is 'localhost' but if you want the server to
be reached from other machines, you may want to change the host name that the
Expand Down
Loading