"""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 thatneeded to use site-specific modules would place ``import site''somewhere near the top of their code.  Because of the automaticimport, this is no longer necessary (but code that does it stillworks). This will append site-specific paths to the module search path.  OnUnix (including Mac OSX), it starts with sys.prefix andsys.exec_prefix (if different) and appendslib/python<version>/site-packages as well as lib/site-python.On other platforms (such as Windows), it tries each of theprefixes directly, as well as with lib/site-packages appended.  Theresulting directories, if they exist, are appended to sys.path, andalso 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 (ornon-directories) are never added to sys.path; no directory is added tosys.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/python2.5/site-packageswith three subdirectories, foo, bar and spam, and two pathconfiguration files, foo.pth and bar.pth.  Assume foo.pth contains thefollowing:   # 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:   /usr/local/lib/python2.5/site-packages/bar  /usr/local/lib/python2.5/site-packages/foo Note that bletch is omitted because it doesn't exist; bar precedes foobecause bar.pth comes alphabetically before foo.pth; and spam isomitted because it is not mentioned in either path configuration file. After these path manipulations, an attempt is made to import a modulenamed sitecustomize, which can perform arbitrary additionalsite-specific customizations.  If this import fails with anImportError exception, it is silently ignored. """ import sysimport osimport __builtin__  def makepath(*paths):    dir = os.path.abspath(os.path.join(*paths))    return dir, os.path.normcase(dir) def abs__file__():    """Set all module' __file__ attribute to an absolute path"""    for m in sys.modules.values():        if hasattr(m, '__loader__'):            continue   # don't mess with a PEP 302-supplied __file__        try:            m.__file__ = os.path.abspath(m.__file__)        except AttributeError:            continue def removeduppaths():    """ Remove duplicate entries from sys.path along with making them    absolute"""    # This ensures that the initial path provided by the interpreter contains    # only absolute pathnames, even if we're running from the build directory.    L = []    known_paths = set()    for dir in sys.path:        # Filter out duplicate paths (on case-insensitive file systems also        # if they only differ in case); turn relative paths into absolute        # paths.        dir, dircase = makepath(dir)        if not dircase in known_paths:            L.append(dir)            known_paths.add(dircase)    sys.path[:] = L    return 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/586680def addbuilddir():    """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)    sys.path.append(s) def _init_pathinfo():    """Return a set containing all existing directory entries from sys.path"""    d = set()    for dir in sys.path:        try:            if os.path.isdir(dir):                dir, dircase = makepath(dir)                d.add(dircase)        except TypeError:            continue    return d 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'"""    if known_paths is None:        _init_pathinfo()        reset = 1    else:        reset = 0    fullname = os.path.join(sitedir, name)    try:        f = open(fullname, "rU")    except IOError:        return    try:        for line in f:            if line.startswith("#"):                continue            if line.startswith("import"):                exec line                continue            line = line.rstrip()            dir, dircase = makepath(sitedir, line)            if not dircase in known_paths and os.path.exists(dir):                sys.path.append(dir)                known_paths.add(dircase)    finally:        f.close()    if reset:        known_paths = None    return known_paths def addsitedir(sitedir, known_paths=None):    """Add 'sitedir' argument to sys.path if missing and handle .pth files in    'sitedir'"""    if known_paths is None:        known_paths = _init_pathinfo()        reset = 1    else:        reset = 0    sitedir, sitedircase = makepath(sitedir)    if not sitedircase in known_paths:        sys.path.append(sitedir)        # Add path component    try:        names = os.listdir(sitedir)    except os.error:        return    names.sort()    for name in names:        if name.endswith(os.extsep + "pth"):            addpackage(sitedir, name, known_paths)    if reset:        known_paths = None    return known_paths def addsitepackages(known_paths):    """Add site-packages (and possibly site-python) to sys.path"""    prefixes = [sys.prefix]    if sys.exec_prefix != sys.prefix:        prefixes.append(sys.exec_prefix)    for prefix in prefixes:        if prefix:            if sys.platform in ('os2emx', 'riscos'):                sitedirs = [os.path.join(prefix, "Lib", "site-packages")]            elif os.sep == '/':                sitedirs = [os.path.join(prefix,                                         "lib",                                         "python" + sys.version[:3],                                         "site-packages"),                            os.path.join(prefix, "lib", "site-python")]            else:                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 home:                        sitedirs.append(                            os.path.join(home,                                         'Library',                                         'Python',                                         sys.version[:3],                                         'site-packages'))            for sitedir in sitedirs:                if os.path.isdir(sitedir):                    addsitedir(sitedir, known_paths)    return None  def setBEGINLIBPATH():    """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(';')    if libpath[-1]:        libpath.append(dllpath)    else:        libpath[-1] = dllpath    os.environ['BEGINLIBPATH'] = ';'.join(libpath)  def setquit():    """Define new built-ins 'quit' and 'exit'.    These are simply strings that display a hint on how to exit.     """    if os.sep == ':':        eof = 'Cmd-Q'    elif os.sep == '\\':        eof = 'Ctrl-Z plus Return'    else:        eof = 'Ctrl-D (i.e. EOF)'     class Quitter(object):        def __init__(self, name):            self.name = name        def __repr__(self):            return 'Use %s() or %s to exit' % (self.name, eof)        def __call__(self, code=None):            # Shells like IDLE catch the SystemExit, but listen when their            # stdin wrapper is closed.            try:                sys.stdin.close()            except:                pass            raise SystemExit(code)    __builtin__.quit = Quitter('quit')    __builtin__.exit = Quitter('exit')  class _Printer(object):    """interactive prompt objects for printing the license text, a list of    contributors and the copyright notice."""     MAXLINES = 23     def __init__(self, name, data, files=(), dirs=()):        self.__name = name        self.__data = data        self.__files = files        self.__dirs = dirs        self.__lines = None     def __setup(self):        if self.__lines:            return        data = None        for dir in self.__dirs:            for filename in self.__files:                filename = os.path.join(dir, filename)                try:                    fp = file(filename, "rU")                    data = fp.read()                    fp.close()                    break                except IOError:                    pass            if data:                break        if not data:            data = self.__data        self.__lines = data.split('\n')        self.__linecnt = len(self.__lines)     def __repr__(self):        self.__setup()        if len(self.__lines) <= self.MAXLINES:            return "\n".join(self.__lines)        else:            return "Type %s() to see the full %s text" % ((self.__name,)*2)     def __call__(self):        self.__setup()        prompt = 'Hit Return for more, or q (and Return) to quit: '        lineno = 0        while 1:            try:                for i in range(lineno, lineno + self.MAXLINES):                    print self.__lines[i]            except IndexError:                break            else:                lineno += self.MAXLINES                key = None                while key is None:                    key = raw_input(prompt)                    if key not in ('', 'q'):                        key = None                if key == 'q':                    break def setcopyright():    """Set 'copyright' and 'credits' in __builtin__"""    __builtin__.copyright = _Printer("copyright", sys.copyright)    if sys.platform[:4] == 'java':        __builtin__.credits = _Printer(            "credits",            "Jython is maintained by the Jython developers (www.jython.org).")    else:        __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])  class _Helper(object):    """Define the built-in 'help'.    This is a wrapper around pydoc.help (with a twist).     """     def __repr__(self):        return "Type help() for interactive help, " \               "or help(object) for help about object."    def __call__(self, *args, **kwds):        import pydoc        return pydoc.help(*args, **kwds) def sethelper():    __builtin__.help = _Helper() def aliasmbcs():    """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':        import locale, codecs        enc = locale.getdefaultlocale()[1]        if enc.startswith('cp'):            # "cp***" ?            try:                codecs.lookup(enc)            except LookupError:                import encodings                encodings._cache[enc] = encodings._unknown                encodings.aliases.aliases[enc] = 'mbcs' def setencoding():    """Set the string encoding used by the Unicode implementation.  The    default is 'ascii', but if you're willing to experiment, you can    change this."""    encoding = "ascii" # Default value set by _PyUnicode_Init()    if 0:        # Enable to support locale aware default string encodings.        import locale        loc = locale.getdefaultlocale()        if loc[1]:            encoding = loc[1]    if 0:        # Enable to switch off string to Unicode coercion and implicit        # Unicode to string conversion.        encoding = "undefined"    if encoding != "ascii":        # On Non-Unicode builds this will raise an AttributeError...        sys.setdefaultencoding(encoding) # Needs Python Unicode build !  def execsitecustomize():    """Run custom site specific code, if available."""    try:        import sitecustomize    except ImportError:        pass  def main():    abs__file__()    paths_in_sys = removeduppaths()    if (os.name == "posix" and sys.path and        os.path.basename(sys.path[-1]) == "Modules"):        addbuilddir()    paths_in_sys = addsitepackages(paths_in_sys)    if sys.platform == 'os2emx':        setBEGINLIBPATH()    setquit()    setcopyright()    sethelper()    aliasmbcs()    setencoding()    execsitecustomize()    # 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 main() def _test():    print "sys.path = ["    for dir in sys.path:        print "    %r," % (dir,)    print "]" if __name__ == '__main__':    _test()