summaryrefslogtreecommitdiffstats
path: root/Doc/library/site.rst
diff options
context:
space:
mode:
authorTarek Ziadé <ziade.tarek@gmail.com>2009-08-20 21:28:05 (GMT)
committerTarek Ziadé <ziade.tarek@gmail.com>2009-08-20 21:28:05 (GMT)
commit4a608c0619b32db3d53bf46a38bb3bf77d9b45a1 (patch)
tree2411f54ada2a2fb41fe1976fb00403531c409ede /Doc/library/site.rst
parent21baf33dc02e696517dee3d6d17e391e4ee8f917 (diff)
downloadcpython-4a608c0619b32db3d53bf46a38bb3bf77d9b45a1.zip
cpython-4a608c0619b32db3d53bf46a38bb3bf77d9b45a1.tar.gz
cpython-4a608c0619b32db3d53bf46a38bb3bf77d9b45a1.tar.bz2
Merged revisions 74526 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r74526 | tarek.ziade | 2009-08-20 23:23:13 +0200 (Thu, 20 Aug 2009) | 1 line #6693: New functions in site.py to get user/global site packages paths. ........
Diffstat (limited to 'Doc/library/site.rst')
-rw-r--r--Doc/library/site.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/Doc/library/site.rst b/Doc/library/site.rst
index 0fe63a3..82184cb 100644
--- a/Doc/library/site.rst
+++ b/Doc/library/site.rst
@@ -116,6 +116,32 @@ empty, and the path manipulations are skipped; however the import of
Adds a directory to sys.path and processes its pth files.
+.. function:: getsitepackages()
+
+ Returns a list containing all global site-packages directories
+ (and possibly site-python).
+
+ .. versionadded:: 2.7
+
+.. function:: getuserbase()
+
+ Returns the `user base` directory path.
+
+ The `user base` directory can be used to store data. If the global
+ variable ``USER_BASE`` is not initialized yet, this function will also set
+ it.
+
+ .. versionadded:: 2.7
+
+.. function:: getusersitepackages()
+
+ Returns the user-specific site-packages directory path.
+
+ If the global variable ``USER_SITE`` is not initialized yet, this
+ function will also set it.
+
+ .. versionadded:: 2.7
XXX Update documentation
XXX document python -m site --user-base --user-site
+