"""Append module search paths for third-party packages to sys.path.
****************************************************************
* This module is automatically imported during initialization. *
****************************************************************
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
This will append site-specific paths 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
resulting directories, if they exist, are appended to sys.path, and
also inspected for path configuration files.
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
'#' are skipped. Lines starting with 'import' are executed.
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
with three subdirectories, foo, bar and spam, and two path
configuration files, foo.pth and bar.pth. Assume foo.pth contains the
# foo package configuration
# bar package configuration
Then the following directories are added to sys.path, in this order:
/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.
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.
dir = os
.path
.abspath(os
.path
.join(*paths
))
return dir, os
.path
.normcase(dir)
"""Set all module' __file__ attribute to an absolute path"""
for m
in sys
.modules
.values():
m
.__file
__ = os
.path
.abspath(m
.__file
__)
""" Remove duplicate entries from sys.path along with making them
# This ensures that the initial path provided by the interpreter contains
# only absolute pathnames, even if we're running from the build directory.
# Filter out duplicate paths (on case-insensitive file systems also
# if they only differ in case); turn relative paths into absolute
dir, dircase
= makepath(dir)
if not dircase
in known_paths
:
# XXX This should not be part of site.py, since it is needed even when
# using the -S option for Python. See http://www.python.org/sf/586680
"""Append ./build/lib.<platform> in case we're running in the build dir
(especially for Guido :-)"""
from distutils
.util
import get_platform
s
= "build/lib.%s-%.3s" % (get_platform(), sys
.version
)
s
= os
.path
.join(os
.path
.dirname(sys
.path
[-1]), s
)
"""Return a set containing all existing directory entries from sys.path"""
dir, dircase
= makepath(dir)
def addpackage(sitedir
, name
, known_paths
):
"""Add a new path to known_paths by combining sitedir and 'name' or execute
sitedir if it starts with 'import'"""
fullname
= os
.path
.join(sitedir
, name
)
if line
.startswith("import"):
dir, dircase
= makepath(sitedir
, line
)
if not dircase
in known_paths
and os
.path
.exists(dir):
def addsitedir(sitedir
, known_paths
=None):
"""Add 'sitedir' argument to sys.path if missing and handle .pth files in
known_paths
= _init_pathinfo()
sitedir
, sitedircase
= makepath(sitedir
)
if not sitedircase
in known_paths
:
sys
.path
.append(sitedir
) # Add path component
names
= os
.listdir(sitedir
)
if name
.endswith(os
.extsep
+ "pth"):
addpackage(sitedir
, name
, known_paths
)
def addsitepackages(known_paths
):
"""Add site-packages (and possibly site-python) to sys.path"""
if sys
.exec_prefix
!= sys
.prefix
:
prefixes
.append(sys
.exec_prefix
)
if sys
.platform
in ('os2emx', 'riscos'):
sitedirs
= [os
.path
.join(prefix
, "Lib", "site-packages")]
sitedirs
= [os
.path
.join(prefix
,
"python" + sys
.version
[:3],
os
.path
.join(prefix
, "lib", "site-python")]
sitedirs
= [prefix
, os
.path
.join(prefix
, "lib", "site-packages")]
if sys
.platform
== 'darwin':
# for framework builds *only* we add the standard Apple
# locations. Currently only per-user, but /Library and
# /Network/Library could be added too
if 'Python.framework' in prefix
:
home
= os
.environ
.get('HOME')
if os
.path
.isdir(sitedir
):
addsitedir(sitedir
, known_paths
)
"""The OS/2 EMX port has optional extension modules that do double duty
as DLLs (and must use the .DLL file extension) for other extensions.
The library search path needs to be amended so these will be found
during module import. Use BEGINLIBPATH so that these are at the start
of the library search path.
dllpath
= os
.path
.join(sys
.prefix
, "Lib", "lib-dynload")
libpath
= os
.environ
['BEGINLIBPATH'].split(';')
os
.environ
['BEGINLIBPATH'] = ';'.join(libpath
)
"""Define new built-ins 'quit' and 'exit'.
These are simply strings that display a hint on how to exit.
exit
= 'Use Cmd-Q to quit.'
exit
= 'Use Ctrl-Z plus Return to exit.'
exit
= 'Use Ctrl-D (i.e. EOF) to exit.'
__builtin__
.quit
= __builtin__
.exit
= exit
"""interactive prompt objects for printing the license text, a list of
contributors and the copyright notice."""
def __init__(self
, name
, data
, files
=(), dirs
=()):
for filename
in self
.__files
:
filename
= os
.path
.join(dir, filename
)
fp
= file(filename
, "rU")
self
.__lines
= data
.split('\n')
self
.__linecnt
= len(self
.__lines
)
if len(self
.__lines
) <= self
.MAXLINES
:
return "\n".join(self
.__lines
)
return "Type %s() to see the full %s text" % ((self
.__name
,)*2)
prompt
= 'Hit Return for more, or q (and Return) to quit: '
for i
in range(lineno
, lineno
+ self
.MAXLINES
):
"""Set 'copyright' and 'credits' in __builtin__"""
__builtin__
.copyright
= _Printer("copyright", sys
.copyright
)
if sys
.platform
[:4] == 'java':
__builtin__
.credits
= _Printer(
"Jython is maintained by the Jython developers (www.jython.org).")
__builtin__
.credits
= _Printer("credits", """\
Thanks to CWI, CNRI, BeOpen.com, Zope Corporation and a cast of thousands
for supporting Python development. See www.python.org for more information.""")
here
= os
.path
.dirname(os
.__file
__)
__builtin__
.license
= _Printer(
"license", "See http://www.python.org/%.3s/license.html" % sys
.version
,
["LICENSE.txt", "LICENSE"],
[os
.path
.join(here
, os
.pardir
), here
, os
.curdir
])
"""Define the built-in 'help'.
This is a wrapper around pydoc.help (with a twist).
return "Type help() for interactive help, " \
"or help(object) for help about object."
def __call__(self
, *args
, **kwds
):
return pydoc
.help(*args
, **kwds
)
__builtin__
.help = _Helper()
"""On Windows, some default encodings are not provided by Python,
while they are always available as "mbcs" in each locale. Make
them usable by aliasing to "mbcs" in such a case."""
if sys
.platform
== 'win32':
enc
= locale
.getdefaultlocale()[1]
if enc
.startswith('cp'): # "cp***" ?
encodings
._cache
[enc
] = encodings
._unknown
encodings
.aliases
.aliases
[enc
] = 'mbcs'
"""Set the string encoding used by the Unicode implementation. The
default is 'ascii', but if you're willing to experiment, you can
encoding
= "ascii" # Default value set by _PyUnicode_Init()
# Enable to support locale aware default string encodings.
loc
= locale
.getdefaultlocale()
# Enable to switch off string to Unicode coercion and implicit
# Unicode to string conversion.
# On Non-Unicode builds this will raise an AttributeError...
sys
.setdefaultencoding(encoding
) # Needs Python Unicode build !
"""Run custom site specific code, if available."""
paths_in_sys
= removeduppaths()
if (os
.name
== "posix" and sys
.path
and
os
.path
.basename(sys
.path
[-1]) == "Modules"):
paths_in_sys
= addsitepackages(paths_in_sys
)
if sys
.platform
== 'os2emx':
# Remove sys.setdefaultencoding() so that users cannot change the
# encoding after initialization. The test for presence is needed when
# this module is run as a script, because this code is executed twice.
if hasattr(sys
, "setdefaultencoding"):
del sys
.setdefaultencoding
if __name__
== '__main__':