cpython/Lib/site.py

170 lines
5.2 KiB
Python
Raw Normal View History

"""Append module search paths for third-party packages to sys.path.
1996-08-17 19:56:26 +00:00
****************************************************************
* This module is automatically imported during initialization. *
****************************************************************
1996-08-17 19:56:26 +00:00
In earlier versions of Python (up to 1.5a3), scripts or modules that
needed to use site-specific modules would place ``import site''
somewhere near the top of their code. Because of the automatic
import, this is no longer necessary (but code that does it still
works).
1996-08-17 19:56:26 +00:00
This will append site-specific paths to to the module search path. On
Unix, it starts with sys.prefix and sys.exec_prefix (if different) and
appends lib/python<version>/site-packages as well as lib/site-python.
On other platforms (mainly Mac and Windows), it uses just sys.prefix
(and sys.exec_prefix, if different, but this is unlikely). The
1997-09-08 02:14:09 +00:00
resulting directories, if they exist, are appended to sys.path, and
also inspected for path configuration files.
1996-08-17 19:56:26 +00:00
A path configuration file is a file whose name has the form
<package>.pth; its contents are additional directories (one per line)
to be added to sys.path. Non-existing directories (or
non-directories) are never added to sys.path; no directory is added to
sys.path more than once. Blank lines and lines beginning with
\code{#} are skipped.
1996-08-17 19:56:26 +00:00
For example, suppose sys.prefix and sys.exec_prefix are set to
/usr/local and there is a directory /usr/local/lib/python1.5/site-packages
1997-09-08 02:14:09 +00:00
with three subdirectories, foo, bar and spam, and two path
configuration files, foo.pth and bar.pth. Assume foo.pth contains the
following:
# foo package configuration
foo
bar
bletch
and bar.pth contains:
# bar package configuration
bar
Then the following directories are added to sys.path, in this order:
1997-09-08 02:14:09 +00:00
/usr/local/lib/python1.5/site-packages/bar
/usr/local/lib/python1.5/site-packages/foo
Note that bletch is omitted because it doesn't exist; bar precedes foo
because bar.pth comes alphabetically before foo.pth; and spam is
omitted because it is not mentioned in either path configuration file.
1996-08-17 19:56:26 +00:00
After these path manipulations, an attempt is made to import a module
named sitecustomize, which can perform arbitrary additional
site-specific customizations. If this import fails with an
ImportError exception, it is silently ignored.
1996-08-17 19:56:26 +00:00
"""
import sys, os
def addsitedir(sitedir):
if sitedir not in sys.path:
sys.path.append(sitedir) # Add path component
try:
names = os.listdir(sitedir)
except os.error:
return
names = map(os.path.normcase, names)
names.sort()
for name in names:
if name[-4:] == ".pth":
addpackage(sitedir, name)
def addpackage(sitedir, name):
fullname = os.path.join(sitedir, name)
try:
f = open(fullname)
except IOError:
return
while 1:
dir = f.readline()
if not dir:
break
if dir[0] == '#':
continue
if dir[-1] == '\n':
dir = dir[:-1]
dir = os.path.join(sitedir, dir)
if dir not in sys.path and os.path.exists(dir):
sys.path.append(dir)
prefixes = [sys.prefix]
if sys.exec_prefix != sys.prefix:
prefixes.append(sys.exec_prefix)
for prefix in prefixes:
1996-08-17 19:56:26 +00:00
if prefix:
if os.sep == '/':
sitedirs = [os.path.join(prefix,
"lib",
"python" + sys.version[:3],
"site-packages"),
os.path.join(prefix, "lib", "site-python")]
else:
sitedirs = [prefix]
for sitedir in sitedirs:
if os.path.isdir(sitedir):
addsitedir(sitedir)
1996-08-17 19:56:26 +00:00
# Define new built-ins 'quit' and 'exit'.
# These are simply strings that display a hint on how to exit.
if os.sep == ':':
exit = 'Use Cmd-Q to quit.'
elif os.sep == '\\':
exit = 'Use Ctrl-Z plus Return to exit.'
else:
exit = 'Use Ctrl-D (i.e. EOF) to exit.'
import __builtin__
__builtin__.quit = __builtin__.exit = exit
del exit
#
# Set the string encoding used by the Unicode implementation to the
# encoding used by the default locale of this system. If the default
2000-06-28 14:48:01 +00:00
# encoding cannot be determined or is unknown, it defaults to 'ascii'.
#
def locale_aware_defaultencoding():
import locale
code, encoding = locale.get_default()
if encoding is None:
encoding = 'ascii'
try:
sys.setdefaultencoding(encoding)
except LookupError:
sys.setdefaultencoding('ascii')
if 1:
# Enable to support locale aware default string encodings.
locale_aware_defaultencoding()
elif 0:
# Enable to switch off string to Unicode coercion and implicit
# Unicode to string conversion.
sys.setdefaultencoding('undefined')
elif 0:
# Enable to hard-code a site specific default string encoding.
sys.setdefaultencoding('ascii')
#
# Run custom site specific code, if available.
#
1996-08-17 19:56:26 +00:00
try:
import sitecustomize
1996-08-17 19:56:26 +00:00
except ImportError:
pass
#
# Remove sys.setdefaultencoding() so that users cannot change the
# encoding after initialization.
#
del sys.setdefaultencoding
def _test():
print "sys.path = ["
for dir in sys.path:
print " %s," % `dir`
print "]"
if __name__ == '__main__':
_test()