2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
:mod:`site` --- Site-specific configuration hook
|
|
|
|
================================================
|
|
|
|
|
|
|
|
.. module:: site
|
|
|
|
:synopsis: A standard way to reference site-specific modules.
|
|
|
|
|
|
|
|
|
|
|
|
**This module is automatically imported during initialization.** The automatic
|
|
|
|
import can be suppressed using the interpreter's :option:`-S` option.
|
|
|
|
|
|
|
|
.. index:: triple: module; search; path
|
|
|
|
|
|
|
|
Importing this module will append site-specific paths to the module search path.
|
|
|
|
|
|
|
|
.. index::
|
|
|
|
pair: site-python; directory
|
|
|
|
pair: site-packages; directory
|
|
|
|
|
|
|
|
It starts by constructing up to four directories from a head and a tail part.
|
|
|
|
For the head part, it uses ``sys.prefix`` and ``sys.exec_prefix``; empty heads
|
|
|
|
are skipped. For the tail part, it uses the empty string and then
|
|
|
|
:file:`lib/site-packages` (on Windows) or
|
|
|
|
:file:`lib/python|version|/site-packages` and then :file:`lib/site-python` (on
|
|
|
|
Unix and Macintosh). For each of the distinct head-tail combinations, it sees
|
|
|
|
if it refers to an existing directory, and if so, adds it to ``sys.path`` and
|
|
|
|
also inspects the newly added path for configuration files.
|
|
|
|
|
|
|
|
A path configuration file is a file whose name has the form :file:`package.pth`
|
|
|
|
and exists in one of the four directories mentioned above; its contents are
|
|
|
|
additional items (one per line) to be added to ``sys.path``. Non-existing items
|
|
|
|
are never added to ``sys.path``, but no check is made that the item refers to a
|
|
|
|
directory (rather than a file). No item is added to ``sys.path`` more than
|
|
|
|
once. Blank lines and lines beginning with ``#`` are skipped. Lines starting
|
|
|
|
with ``import`` (followed by space or tab) are executed.
|
|
|
|
|
|
|
|
.. index::
|
|
|
|
single: package
|
|
|
|
triple: path; configuration; file
|
|
|
|
|
|
|
|
For example, suppose ``sys.prefix`` and ``sys.exec_prefix`` are set to
|
|
|
|
:file:`/usr/local`. The Python X.Y library is then installed in
|
|
|
|
:file:`/usr/local/lib/python{X.Y}` (where only the first three characters of
|
|
|
|
``sys.version`` are used to form the installation path name). Suppose this has
|
|
|
|
a subdirectory :file:`/usr/local/lib/python{X.Y}/site-packages` with three
|
|
|
|
subsubdirectories, :file:`foo`, :file:`bar` and :file:`spam`, and two path
|
|
|
|
configuration files, :file:`foo.pth` and :file:`bar.pth`. Assume
|
|
|
|
:file:`foo.pth` contains the following::
|
|
|
|
|
|
|
|
# foo package configuration
|
|
|
|
|
|
|
|
foo
|
|
|
|
bar
|
|
|
|
bletch
|
|
|
|
|
|
|
|
and :file:`bar.pth` contains::
|
|
|
|
|
|
|
|
# bar package configuration
|
|
|
|
|
|
|
|
bar
|
|
|
|
|
Devil merge!
Merged revisions 66561,66564,66580,66610,66614,66618,66624-66625,66628-66629,66643,66645,66660-66665 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r66561 | benjamin.peterson | 2008-09-22 17:13:29 -0500 (Mon, 22 Sep 2008) | 1 line
clean up docs for platform's linux_distribution and dist functions
........
r66564 | benjamin.peterson | 2008-09-23 08:32:46 -0500 (Tue, 23 Sep 2008) | 1 line
mention how to override boolean evaluation
........
r66580 | georg.brandl | 2008-09-24 04:47:55 -0500 (Wed, 24 Sep 2008) | 2 lines
Indentation normalization.
........
r66610 | andrew.kuchling | 2008-09-24 12:27:55 -0500 (Wed, 24 Sep 2008) | 1 line
Improve wording
........
r66614 | benjamin.peterson | 2008-09-24 17:11:59 -0500 (Wed, 24 Sep 2008) | 4 lines
#3950 fix missing scale factors in turtle.py
reviewers: Georg, Benjamin
........
r66618 | benjamin.peterson | 2008-09-25 15:35:45 -0500 (Thu, 25 Sep 2008) | 1 line
add a NEWs entry for r66614
........
r66624 | raymond.hettinger | 2008-09-25 18:31:52 -0500 (Thu, 25 Sep 2008) | 1 line
Fix namedtuple bug reported by Glenn Linderman. Template did not form correctly if the field names were input in Unicode.
........
r66625 | benjamin.peterson | 2008-09-25 21:58:36 -0500 (Thu, 25 Sep 2008) | 1 line
add the beginnings of a C-API 2 -> 3 porting guide
........
r66628 | benjamin.peterson | 2008-09-26 15:52:06 -0500 (Fri, 26 Sep 2008) | 1 line
add an 'other options' section
........
r66629 | georg.brandl | 2008-09-26 16:15:21 -0500 (Fri, 26 Sep 2008) | 2 lines
typos.
........
r66643 | andrew.kuchling | 2008-09-27 09:12:33 -0500 (Sat, 27 Sep 2008) | 1 line
Add a last bunch of items
........
r66645 | benjamin.peterson | 2008-09-27 11:23:55 -0500 (Sat, 27 Sep 2008) | 1 line
2to3's api should be considered unstable
........
r66660 | andrew.kuchling | 2008-09-27 17:54:08 -0500 (Sat, 27 Sep 2008) | 1 line
#3510: future-proof text
........
r66661 | benjamin.peterson | 2008-09-27 18:28:43 -0500 (Sat, 27 Sep 2008) | 1 line
clarify a few things
........
r66662 | andrew.kuchling | 2008-09-27 19:15:27 -0500 (Sat, 27 Sep 2008) | 1 line
#1579477: mention necessity to flush output before exec'ing
........
r66663 | andrew.kuchling | 2008-09-27 20:08:47 -0500 (Sat, 27 Sep 2008) | 1 line
#1415508: Document two functions
........
r66664 | benjamin.peterson | 2008-09-27 20:51:36 -0500 (Sat, 27 Sep 2008) | 1 line
better grammar
........
r66665 | benjamin.peterson | 2008-09-27 20:53:29 -0500 (Sat, 27 Sep 2008) | 1 line
note the 2to3 -d could be useful for other refactoring
........
2008-09-27 23:06:32 -03:00
|
|
|
Then the following version-specific directories are added to
|
|
|
|
``sys.path``, in this order::
|
2007-08-15 11:28:22 -03:00
|
|
|
|
Devil merge!
Merged revisions 66561,66564,66580,66610,66614,66618,66624-66625,66628-66629,66643,66645,66660-66665 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r66561 | benjamin.peterson | 2008-09-22 17:13:29 -0500 (Mon, 22 Sep 2008) | 1 line
clean up docs for platform's linux_distribution and dist functions
........
r66564 | benjamin.peterson | 2008-09-23 08:32:46 -0500 (Tue, 23 Sep 2008) | 1 line
mention how to override boolean evaluation
........
r66580 | georg.brandl | 2008-09-24 04:47:55 -0500 (Wed, 24 Sep 2008) | 2 lines
Indentation normalization.
........
r66610 | andrew.kuchling | 2008-09-24 12:27:55 -0500 (Wed, 24 Sep 2008) | 1 line
Improve wording
........
r66614 | benjamin.peterson | 2008-09-24 17:11:59 -0500 (Wed, 24 Sep 2008) | 4 lines
#3950 fix missing scale factors in turtle.py
reviewers: Georg, Benjamin
........
r66618 | benjamin.peterson | 2008-09-25 15:35:45 -0500 (Thu, 25 Sep 2008) | 1 line
add a NEWs entry for r66614
........
r66624 | raymond.hettinger | 2008-09-25 18:31:52 -0500 (Thu, 25 Sep 2008) | 1 line
Fix namedtuple bug reported by Glenn Linderman. Template did not form correctly if the field names were input in Unicode.
........
r66625 | benjamin.peterson | 2008-09-25 21:58:36 -0500 (Thu, 25 Sep 2008) | 1 line
add the beginnings of a C-API 2 -> 3 porting guide
........
r66628 | benjamin.peterson | 2008-09-26 15:52:06 -0500 (Fri, 26 Sep 2008) | 1 line
add an 'other options' section
........
r66629 | georg.brandl | 2008-09-26 16:15:21 -0500 (Fri, 26 Sep 2008) | 2 lines
typos.
........
r66643 | andrew.kuchling | 2008-09-27 09:12:33 -0500 (Sat, 27 Sep 2008) | 1 line
Add a last bunch of items
........
r66645 | benjamin.peterson | 2008-09-27 11:23:55 -0500 (Sat, 27 Sep 2008) | 1 line
2to3's api should be considered unstable
........
r66660 | andrew.kuchling | 2008-09-27 17:54:08 -0500 (Sat, 27 Sep 2008) | 1 line
#3510: future-proof text
........
r66661 | benjamin.peterson | 2008-09-27 18:28:43 -0500 (Sat, 27 Sep 2008) | 1 line
clarify a few things
........
r66662 | andrew.kuchling | 2008-09-27 19:15:27 -0500 (Sat, 27 Sep 2008) | 1 line
#1579477: mention necessity to flush output before exec'ing
........
r66663 | andrew.kuchling | 2008-09-27 20:08:47 -0500 (Sat, 27 Sep 2008) | 1 line
#1415508: Document two functions
........
r66664 | benjamin.peterson | 2008-09-27 20:51:36 -0500 (Sat, 27 Sep 2008) | 1 line
better grammar
........
r66665 | benjamin.peterson | 2008-09-27 20:53:29 -0500 (Sat, 27 Sep 2008) | 1 line
note the 2to3 -d could be useful for other refactoring
........
2008-09-27 23:06:32 -03:00
|
|
|
/usr/local/lib/pythonX.Y/site-packages/bar
|
|
|
|
/usr/local/lib/pythonX.Y/site-packages/foo
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
Note that :file:`bletch` is omitted because it doesn't exist; the :file:`bar`
|
|
|
|
directory precedes the :file:`foo` directory because :file:`bar.pth` comes
|
|
|
|
alphabetically before :file:`foo.pth`; and :file:`spam` is omitted because it is
|
|
|
|
not mentioned in either path configuration file.
|
|
|
|
|
|
|
|
.. index:: module: sitecustomize
|
|
|
|
|
|
|
|
After these path manipulations, an attempt is made to import a module named
|
|
|
|
:mod:`sitecustomize`, which can perform arbitrary site-specific customizations.
|
|
|
|
If this import fails with an :exc:`ImportError` exception, it is silently
|
|
|
|
ignored.
|
|
|
|
|
|
|
|
.. index:: module: sitecustomize
|
|
|
|
|
|
|
|
Note that for some non-Unix systems, ``sys.prefix`` and ``sys.exec_prefix`` are
|
|
|
|
empty, and the path manipulations are skipped; however the import of
|
|
|
|
:mod:`sitecustomize` is still attempted.
|
|
|
|
|
2008-05-06 20:45:46 -03:00
|
|
|
|
|
|
|
.. data:: PREFIXES
|
|
|
|
|
|
|
|
A list of prefixes for site package directories
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: ENABLE_USER_SITE
|
|
|
|
|
|
|
|
Flag showing the status of the user site directory. True means the
|
|
|
|
user site directory is enabled and added to sys.path. When the flag
|
|
|
|
is None the user site directory is disabled for security reasons.
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: USER_SITE
|
|
|
|
|
|
|
|
Path to the user site directory for the current Python version or None
|
|
|
|
|
|
|
|
|
|
|
|
.. data:: USER_BASE
|
|
|
|
|
|
|
|
Path to the base directory for user site directories
|
|
|
|
|
|
|
|
|
|
|
|
.. envvar:: PYTHONNOUSERSITE
|
|
|
|
|
|
|
|
|
|
|
|
.. envvar:: PYTHONUSERBASE
|
|
|
|
|
|
|
|
|
|
|
|
.. function:: addsitedir(sitedir, known_paths=None)
|
|
|
|
|
|
|
|
Adds a directory to sys.path and processes its pth files.
|
|
|
|
|
|
|
|
|
Merged revisions 77236,77383,77399,77857,78238,78861-78862,78958 via svnmerge from
svn+ssh://svn.python.org/python/branches/py3k
................
r77236 | georg.brandl | 2010-01-02 15:51:12 +0100 (Sa, 02 Jan 2010) | 1 line
#7592: remove duplicate description.
................
r77383 | georg.brandl | 2010-01-09 10:48:46 +0100 (Sa, 09 Jan 2010) | 9 lines
Merged revisions 77382 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r77382 | georg.brandl | 2010-01-09 10:47:11 +0100 (Sa, 09 Jan 2010) | 1 line
#7422: make it clear that getargspec() only works on Python functions.
........
................
r77399 | georg.brandl | 2010-01-09 23:39:42 +0100 (Sa, 09 Jan 2010) | 1 line
Remove redundant brackets in signatures.
................
r77857 | georg.brandl | 2010-01-30 18:54:04 +0100 (Sa, 30 Jan 2010) | 1 line
#7814: fix wrong example function usage.
................
r78238 | georg.brandl | 2010-02-19 10:10:15 +0100 (Fr, 19 Feb 2010) | 1 line
#5341: fix parenthesis placement.
................
r78861 | georg.brandl | 2010-03-12 11:04:37 +0100 (Fr, 12 Mär 2010) | 1 line
Make tool compatible with 2.x and 3.x.
................
r78862 | georg.brandl | 2010-03-12 11:06:40 +0100 (Fr, 12 Mär 2010) | 13 lines
Merged revisions 78859-78860 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r78859 | georg.brandl | 2010-03-12 10:57:43 +0100 (Fr, 12 Mär 2010) | 1 line
Get rid of backticks.
........
r78860 | georg.brandl | 2010-03-12 11:02:03 +0100 (Fr, 12 Mär 2010) | 1 line
Fix warnings from "make check".
........
................
r78958 | georg.brandl | 2010-03-14 11:51:01 +0100 (So, 14 Mär 2010) | 37 lines
Merged revisions 78101,78115,78117,78182,78188,78245,78386,78496 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r78101 | georg.brandl | 2010-02-08 01:04:54 +0100 (Mo, 08 Feb 2010) | 1 line
Fix test_fnmatch.
........
r78115 | georg.brandl | 2010-02-08 23:40:51 +0100 (Mo, 08 Feb 2010) | 1 line
Fix missing string formatting placeholder.
........
r78117 | georg.brandl | 2010-02-08 23:48:37 +0100 (Mo, 08 Feb 2010) | 1 line
Convert test failure from output-producing to self.fail().
........
r78182 | georg.brandl | 2010-02-14 09:18:23 +0100 (So, 14 Feb 2010) | 1 line
#7926: fix stray parens.
........
r78188 | georg.brandl | 2010-02-14 14:38:12 +0100 (So, 14 Feb 2010) | 1 line
#7926: fix-up wording.
........
r78245 | georg.brandl | 2010-02-19 20:36:08 +0100 (Fr, 19 Feb 2010) | 1 line
#7967: PyXML is no more.
........
r78386 | georg.brandl | 2010-02-23 22:48:57 +0100 (Di, 23 Feb 2010) | 1 line
#6544: fix refleak in kqueue, occurring in certain error conditions.
........
r78496 | georg.brandl | 2010-02-27 15:58:08 +0100 (Sa, 27 Feb 2010) | 1 line
Link to http://www.python.org/dev/workflow/ from bugs page.
........
................
2010-10-06 04:55:35 -03:00
|
|
|
.. XXX Update documentation
|
|
|
|
.. XXX document python -m site --user-base --user-site
|