Skip to content

bpo-46826: document prefixes argument on site.getsitepackages #31546

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

bpo-46826: document prefixes argument on site.getsitepackages #31546

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1718808
bpo-46826: add documentation for prefixes argument on site.getsitepac…
asnelling Feb 22, 2022
80538ad
📜🤖 Added by blurb_it.
blurb-it[bot] Feb 24, 2022
7eee161
Merge branch 'main' into issue46826
StanFromIreland Sep 5, 2025
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
11 changes: 9 additions & 2 deletions Doc/library/site.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,12 +211,19 @@ Module contents
used in :mod:`sitecustomize` or :mod:`usercustomize` (see above).


.. function:: getsitepackages()
.. function:: getsitepackages(prefixes=None)

Return a list containing all global site-packages directories.
Return a list containing all global :file:`site-packages` directories.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Return a list containing all global :file:`site-packages` directories.
Return a list containing all global site-packages directories.

This should be reverted, it does not do what you think it does.


For each directory present in *prefixes* (or :data:`PREFIXES` if *prefixes*
is None), this function will find its :file:`site-packages` subdirectory
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
is None), this function will find its :file:`site-packages` subdirectory
is ``None``), this function will find its :file:`site-packages` subdirectory

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
is None), this function will find its :file:`site-packages` subdirectory
is None), this function will find its site-packages subdirectory

depending on the system environment, and will return a list of full paths.

.. versionadded:: 3.2

.. versionchanged:: 3.3
Add the optional *prefixes* argument.


.. function:: getuserbase()

Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2022-02-24-03-07-52.bpo-46826.ktq3H4.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
document prefixes argument on site.getsitepackages
Copy link
Contributor

@slateny slateny Oct 2, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As it's a doc change I'd say you can remove this file

Actually, since it documents a new parameter it might be useful to have the news.

Suggested change
document prefixes argument on site.getsitepackages
Document prefixes argument for :func:`~site.getsitepackages`.