gh-90982: document prefixes argument on site.getsitepackages by asnelling · Pull Request #31546 · python/cpython

asnelling · 2022-02-24T03:00:46Z

Adding prefixes argument from code below to site.getsitepackages docs.

Lines 346 to 352 in 7fce106

    
           def getsitepackages(prefixes=None): 
        
               """Returns a list containing all global site-packages directories. 
        
               For each directory present in ``prefixes`` (or the global ``PREFIXES``), 
        
               this function will find its `site-packages` subdirectory depending on the 
        
               system environment, and will return a list of full paths. 
        
               """

Introduced in commit 7ded1f0

https://bugs.python.org/issue46826

Issue: prefixes argument to site.getsitepackages() missing documentation #90982

…kages

slateny · 2022-10-02T23:17:26Z

@@ -0,0 +1 @@
+document prefixes argument on site.getsitepackages


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

slateny · 2022-12-06T08:24:37Z

@asnelling Would you still be interested in giving the PR a quick update?

StanFromIreland · 2025-09-05T17:18:23Z

+   Return a list containing all global :file:`site-packages` directories.
+
+   For each directory present in *prefixes* (or :data:`PREFIXES` if *prefixes*
+   is None), this function will find its :file:`site-packages` subdirectory


Suggested change

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

is None), this function will find its site-packages subdirectory

github-actions · 2026-04-10T12:15:09Z

This PR is stale because it has been open for 30 days with no activity.

read-the-docs-community · 2026-08-11T18:33:22Z

Documentation build overview

📚 cpython-previews | 🛠️ Build #34018860 | 📁 Comparing 7110714 against main (3444ef9)

🔍 Preview build

2 files changed

± library/site.html
± whatsnew/changelog.html

…tq3H4.rst

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: Stan Ulbrych <stan@python.org>

serhiy-storchaka

Applied suggestions, removed NEWS, fixed other errors. LGTM now.

miss-islington-app · 2026-08-12T20:16:52Z

Thanks @asnelling for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15.
🐍🍒⛏🤖

bedevere-app · 2026-08-12T20:17:08Z

GH-155643 is a backport of this pull request to the 3.15 branch.

bedevere-app · 2026-08-12T20:17:14Z

GH-155644 is a backport of this pull request to the 3.14 branch.

bedevere-app · 2026-08-12T20:17:20Z

GH-155645 is a backport of this pull request to the 3.13 branch.

StanFromIreland · 2026-08-12T20:18:13Z

   .. versionadded:: 3.2

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


Suggested change

Add the optional *prefixes* argument.

Add the optional *prefixes* parameter.

Little too late.

…H-31546) (GH-155644) (cherry picked from commit bc31217) Co-authored-by: Addison Snelling <addison@asnell.io>

…H-31546) (GH-155645) (cherry picked from commit bc31217) Co-authored-by: Addison Snelling <addison@asnell.io>

bpo-46826: add documentation for prefixes argument on site.getsitepac…

1718808

…kages

bedevere-bot added the awaiting review label Feb 24, 2022

the-knights-who-say-ni added the CLA signed label Feb 24, 2022

bedevere-bot added the docs Documentation in the Doc dir label Feb 24, 2022

📜🤖 Added by blurb_it.

80538ad

ezio-melotti removed the CLA signed label Jul 13, 2022

slateny reviewed Oct 2, 2022

View reviewed changes

slateny added the skip news label Oct 2, 2022

StanFromIreland reviewed Sep 5, 2025

View reviewed changes

Merge branch 'main' into issue46826

7eee161

StanFromIreland requested a review from FFY00 as a code owner September 5, 2025 17:18

asnelling mannequin mentioned this pull request Sep 5, 2025

prefixes argument to site.getsitepackages() missing documentation #90982

Closed

github-actions Bot added the stale Stale PR or inactive for long period of time. label Apr 10, 2026

Merge branch 'main' into issue46826

7110714

serhiy-storchaka requested a review from warsaw as a code owner August 11, 2026 18:19

github-actions Bot removed the stale Stale PR or inactive for long period of time. label Aug 12, 2026

serhiy-storchaka changed the title ~~bpo-46826: document prefixes argument on site.getsitepackages~~ gh-90982: document prefixes argument on site.getsitepackages Aug 12, 2026

serhiy-storchaka and others added 3 commits August 12, 2026 22:01

Delete Misc/NEWS.d/next/Documentation/2022-02-24-03-07-52.bpo-46826.k…

ab94259

…tq3H4.rst

Apply suggestions from code review

03919ab

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: Stan Ulbrych <stan@python.org>

Fix newlines and remaining :file:.

272331b

serhiy-storchaka approved these changes Aug 12, 2026

View reviewed changes

bedevere-app Bot added awaiting merge and removed awaiting review labels Aug 12, 2026

Merge branch 'main' into issue46826

ab9989d

serhiy-storchaka enabled auto-merge (squash) August 12, 2026 19:12

serhiy-storchaka added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Aug 12, 2026

serhiy-storchaka added the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Aug 12, 2026

serhiy-storchaka merged commit bc31217 into python:main Aug 12, 2026
56 of 60 checks passed

github-project-automation Bot moved this from Todo to Done in Docs PRs Aug 12, 2026

bedevere-app Bot removed the awaiting merge label Aug 12, 2026

bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Aug 12, 2026

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Aug 12, 2026

bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Aug 12, 2026

StanFromIreland reviewed Aug 12, 2026

View reviewed changes

serhiy-storchaka mentioned this pull request Aug 13, 2026

gh-90982: Use the standard wording in the site.getsitepackages() versionchanged #155654

Merged

serhiy-storchaka pushed a commit that referenced this pull request Aug 13, 2026

[3.14] gh-90982: Document prefixes argument on site.getsitepackages (G…

af0e7a6

…H-31546) (GH-155644) (cherry picked from commit bc31217) Co-authored-by: Addison Snelling <addison@asnell.io>

serhiy-storchaka pushed a commit that referenced this pull request Aug 13, 2026

[3.13] gh-90982: Document prefixes argument on site.getsitepackages (G…

52afde4

…H-31546) (GH-155645) (cherry picked from commit bc31217) Co-authored-by: Addison Snelling <addison@asnell.io>

Navigation Menu

Uh oh!

Uh oh!

gh-90982: document prefixes argument on site.getsitepackages - #31546

gh-90982: document prefixes argument on site.getsitepackages#31546
serhiy-storchaka merged 8 commits into
python:mainfrom
asnelling:issue46826

asnelling commented Feb 24, 2022 •

edited by serhiy-storchaka

Loading

Uh oh!

Uh oh!

slateny Oct 2, 2022 •

edited

Loading

Uh oh!

slateny commented Dec 6, 2022

Uh oh!

Uh oh!

StanFromIreland Sep 5, 2025

Uh oh!

github-actions Bot commented Apr 10, 2026

Uh oh!

read-the-docs-community Bot commented Aug 11, 2026

Uh oh!

serhiy-storchaka left a comment

Uh oh!

Uh oh!

miss-islington-app Bot commented Aug 12, 2026

Uh oh!

bedevere-app Bot commented Aug 12, 2026

Uh oh!

bedevere-app Bot commented Aug 12, 2026

Uh oh!

bedevere-app Bot commented Aug 12, 2026

Uh oh!

StanFromIreland Aug 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

	def getsitepackages(prefixes=None):
	"""Returns a list containing all global site-packages directories.

	For each directory present in ``prefixes`` (or the global ``PREFIXES``),
	this function will find its `site-packages` subdirectory depending on the
	system environment, and will return a list of full paths.
	"""

		@@ -0,0 +1 @@
		document prefixes argument on site.getsitepackages

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

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

	Add the optional prefixes argument.
	Add the optional prefixes parameter.

Uh oh!

Uh oh!

Conversation

asnelling commented Feb 24, 2022 • edited by serhiy-storchaka Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

slateny Oct 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

slateny commented Dec 6, 2022

Uh oh!

Uh oh!

StanFromIreland Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Apr 10, 2026

Uh oh!

read-the-docs-community Bot commented Aug 11, 2026

Documentation build overview

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

miss-islington-app Bot commented Aug 12, 2026

Uh oh!

bedevere-app Bot commented Aug 12, 2026

Uh oh!

bedevere-app Bot commented Aug 12, 2026

Uh oh!

bedevere-app Bot commented Aug 12, 2026

Uh oh!

StanFromIreland Aug 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

asnelling commented Feb 24, 2022 •

edited by serhiy-storchaka

Loading

slateny Oct 2, 2022 •

edited

Loading