From 1718808a12ad6607a7c39fa15e903724198ddda1 Mon Sep 17 00:00:00 2001 From: Addison Snelling Date: Tue, 22 Feb 2022 07:31:39 -0600 Subject: [PATCH 1/5] bpo-46826: add documentation for prefixes argument on site.getsitepackages --- Doc/library/site.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/Doc/library/site.rst b/Doc/library/site.rst index e2ad3c48f9754ee..4033bfd880b54a6 100644 --- a/Doc/library/site.rst +++ b/Doc/library/site.rst @@ -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. + + For each directory present in *prefixes* (or :data:`PREFIXES` if *prefixes* + is None), this function will find its :file:`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() From 80538ad81de2a1e30601368d2a1a0862754310ef Mon Sep 17 00:00:00 2001 From: "blurb-it[bot]" <43283697+blurb-it[bot]@users.noreply.github.com> Date: Thu, 24 Feb 2022 03:07:53 +0000 Subject: [PATCH 2/5] =?UTF-8?q?=F0=9F=93=9C=F0=9F=A4=96=20Added=20by=20blu?= =?UTF-8?q?rb=5Fit.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../next/Documentation/2022-02-24-03-07-52.bpo-46826.ktq3H4.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 Misc/NEWS.d/next/Documentation/2022-02-24-03-07-52.bpo-46826.ktq3H4.rst diff --git a/Misc/NEWS.d/next/Documentation/2022-02-24-03-07-52.bpo-46826.ktq3H4.rst b/Misc/NEWS.d/next/Documentation/2022-02-24-03-07-52.bpo-46826.ktq3H4.rst new file mode 100644 index 000000000000000..88bd07197310255 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2022-02-24-03-07-52.bpo-46826.ktq3H4.rst @@ -0,0 +1 @@ +document prefixes argument on site.getsitepackages From ab942597bcc168bd4a0952200dbbd2ab91783022 Mon Sep 17 00:00:00 2001 From: Serhiy Storchaka Date: Wed, 12 Aug 2026 22:01:25 +0300 Subject: [PATCH 3/5] Delete Misc/NEWS.d/next/Documentation/2022-02-24-03-07-52.bpo-46826.ktq3H4.rst --- .../next/Documentation/2022-02-24-03-07-52.bpo-46826.ktq3H4.rst | 1 - 1 file changed, 1 deletion(-) delete mode 100644 Misc/NEWS.d/next/Documentation/2022-02-24-03-07-52.bpo-46826.ktq3H4.rst diff --git a/Misc/NEWS.d/next/Documentation/2022-02-24-03-07-52.bpo-46826.ktq3H4.rst b/Misc/NEWS.d/next/Documentation/2022-02-24-03-07-52.bpo-46826.ktq3H4.rst deleted file mode 100644 index 88bd07197310255..000000000000000 --- a/Misc/NEWS.d/next/Documentation/2022-02-24-03-07-52.bpo-46826.ktq3H4.rst +++ /dev/null @@ -1 +0,0 @@ -document prefixes argument on site.getsitepackages From 03919ab0a71cf092eb0d8e4896152c5aa0716379 Mon Sep 17 00:00:00 2001 From: Serhiy Storchaka Date: Wed, 12 Aug 2026 22:04:33 +0300 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: Stan Ulbrych --- Doc/library/site.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/library/site.rst b/Doc/library/site.rst index 5bd77872459f589..cd066400764c667 100644 --- a/Doc/library/site.rst +++ b/Doc/library/site.rst @@ -451,10 +451,10 @@ Module contents .. function:: getsitepackages(prefixes=None) - Return a list containing all global :file:`site-packages` directories. + Return a list containing all global 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 + is ``None``), this function will find its :file:`site-packages` subdirectory depending on the system environment, and will return a list of full paths. .. versionadded:: 3.2 From 272331b98e0af44396b578759ae0d24b882ae34d Mon Sep 17 00:00:00 2001 From: Serhiy Storchaka Date: Wed, 12 Aug 2026 22:08:56 +0300 Subject: [PATCH 5/5] Fix newlines and remaining :file:. --- Doc/library/site.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/library/site.rst b/Doc/library/site.rst index cd066400764c667..6f989e2b21b8bf7 100644 --- a/Doc/library/site.rst +++ b/Doc/library/site.rst @@ -451,10 +451,10 @@ Module contents .. function:: getsitepackages(prefixes=None) - Return a list containing all global site-packages directories. + Return a list containing all global 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 + 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