diff --git a/Doc/library/site.rst b/Doc/library/site.rst index e98dd83b60eb60..70feab9dc19709 100644 --- a/Doc/library/site.rst +++ b/Doc/library/site.rst @@ -241,12 +241,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() 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 00000000000000..88bd0719731025 --- /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