summaryrefslogtreecommitdiffstats
path: root/Doc/library/site.rst
diff options
context:
space:
mode:
authorTarek Ziadé <ziade.tarek@gmail.com>2009-08-20 21:23:13 (GMT)
committerTarek Ziadé <ziade.tarek@gmail.com>2009-08-20 21:23:13 (GMT)
commit764fc235a6d6a8cf54ca47911e2237f2f17e38a7 (patch)
treeb3cca1cacd538c26059ff43048a96c4fca4d3a9d /Doc/library/site.rst
parent4e63d54b36093f35533bc0871bfa6ad3111bd048 (diff)
downloadcpython-764fc235a6d6a8cf54ca47911e2237f2f17e38a7.zip
cpython-764fc235a6d6a8cf54ca47911e2237f2f17e38a7.tar.gz
cpython-764fc235a6d6a8cf54ca47911e2237f2f17e38a7.tar.bz2
#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 37b786d..4844fb5 100644
--- a/Doc/library/site.rst
+++ b/Doc/library/site.rst
@@ -131,6 +131,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
+