home *** CD-ROM | disk | FTP | other *** search
/ PC World 2005 June / PCWorld_2005-06_cd.bin / software / vyzkuste / firewally / firewally.exe / framework-2.3.exe / site.py < prev    next >
Text File  |  2003-12-30  |  12KB  |  376 lines
  1. """Append module search paths for third-party packages to sys.path.
  2.  
  3. ****************************************************************
  4. * This module is automatically imported during initialization. *
  5. ****************************************************************
  6.  
  7. In earlier versions of Python (up to 1.5a3), scripts or modules that
  8. needed to use site-specific modules would place ``import site''
  9. somewhere near the top of their code.  Because of the automatic
  10. import, this is no longer necessary (but code that does it still
  11. works).
  12.  
  13. This will append site-specific paths to the module search path.  On
  14. Unix, it starts with sys.prefix and sys.exec_prefix (if different) and
  15. appends lib/python<version>/site-packages as well as lib/site-python.
  16. On other platforms (mainly Mac and Windows), it uses just sys.prefix
  17. (and sys.exec_prefix, if different, but this is unlikely).  The
  18. resulting directories, if they exist, are appended to sys.path, and
  19. also inspected for path configuration files.
  20.  
  21. A path configuration file is a file whose name has the form
  22. <package>.pth; its contents are additional directories (one per line)
  23. to be added to sys.path.  Non-existing directories (or
  24. non-directories) are never added to sys.path; no directory is added to
  25. sys.path more than once.  Blank lines and lines beginning with
  26. '#' are skipped. Lines starting with 'import' are executed.
  27.  
  28. For example, suppose sys.prefix and sys.exec_prefix are set to
  29. /usr/local and there is a directory /usr/local/lib/python1.5/site-packages
  30. with three subdirectories, foo, bar and spam, and two path
  31. configuration files, foo.pth and bar.pth.  Assume foo.pth contains the
  32. following:
  33.  
  34.   # foo package configuration
  35.   foo
  36.   bar
  37.   bletch
  38.  
  39. and bar.pth contains:
  40.  
  41.   # bar package configuration
  42.   bar
  43.  
  44. Then the following directories are added to sys.path, in this order:
  45.  
  46.   /usr/local/lib/python1.5/site-packages/bar
  47.   /usr/local/lib/python1.5/site-packages/foo
  48.  
  49. Note that bletch is omitted because it doesn't exist; bar precedes foo
  50. because bar.pth comes alphabetically before foo.pth; and spam is
  51. omitted because it is not mentioned in either path configuration file.
  52.  
  53. After these path manipulations, an attempt is made to import a module
  54. named sitecustomize, which can perform arbitrary additional
  55. site-specific customizations.  If this import fails with an
  56. ImportError exception, it is silently ignored.
  57.  
  58. """
  59.  
  60. import sys, os
  61.  
  62.  
  63. def makepath(*paths):
  64.     dir = os.path.abspath(os.path.join(*paths))
  65.     return dir, os.path.normcase(dir)
  66.  
  67. for m in sys.modules.values():
  68.     if hasattr(m, "__file__") and m.__file__:
  69.         m.__file__ = os.path.abspath(m.__file__)
  70. del m
  71.  
  72. # This ensures that the initial path provided by the interpreter contains
  73. # only absolute pathnames, even if we're running from the build directory.
  74. L = []
  75. _dirs_in_sys_path = {}
  76. dir = dircase = None  # sys.path may be empty at this point
  77. for dir in sys.path:
  78.     # Filter out duplicate paths (on case-insensitive file systems also
  79.     # if they only differ in case); turn relative paths into absolute
  80.     # paths.
  81.     dir, dircase = makepath(dir)
  82.     if not dircase in _dirs_in_sys_path:
  83.         L.append(dir)
  84.         _dirs_in_sys_path[dircase] = 1
  85. sys.path[:] = L
  86. del dir, dircase, L
  87.  
  88. # Append ./build/lib.<platform> in case we're running in the build dir
  89. # (especially for Guido :-)
  90. # XXX This should not be part of site.py, since it is needed even when
  91. # using the -S option for Python.  See http://www.python.org/sf/586680
  92. if (os.name == "posix" and sys.path and
  93.     os.path.basename(sys.path[-1]) == "Modules"):
  94.     from distutils.util import get_platform
  95.     s = "build/lib.%s-%.3s" % (get_platform(), sys.version)
  96.     s = os.path.join(os.path.dirname(sys.path[-1]), s)
  97.     sys.path.append(s)
  98.     del get_platform, s
  99.  
  100. def _init_pathinfo():
  101.     global _dirs_in_sys_path
  102.     _dirs_in_sys_path = d = {}
  103.     for dir in sys.path:
  104.         if dir and not os.path.isdir(dir):
  105.             continue
  106.         dir, dircase = makepath(dir)
  107.         d[dircase] = 1
  108.  
  109. def addsitedir(sitedir):
  110.     global _dirs_in_sys_path
  111.     if _dirs_in_sys_path is None:
  112.         _init_pathinfo()
  113.         reset = 1
  114.     else:
  115.         reset = 0
  116.     sitedir, sitedircase = makepath(sitedir)
  117.     if not sitedircase in _dirs_in_sys_path:
  118.         sys.path.append(sitedir)        # Add path component
  119.     try:
  120.         names = os.listdir(sitedir)
  121.     except os.error:
  122.         return
  123.     names.sort()
  124.     for name in names:
  125.         if name[-4:] == os.extsep + "pth":
  126.             addpackage(sitedir, name)
  127.     if reset:
  128.         _dirs_in_sys_path = None
  129.  
  130. def addpackage(sitedir, name):
  131.     global _dirs_in_sys_path
  132.     if _dirs_in_sys_path is None:
  133.         _init_pathinfo()
  134.         reset = 1
  135.     else:
  136.         reset = 0
  137.     fullname = os.path.join(sitedir, name)
  138.     try:
  139.         f = open(fullname)
  140.     except IOError:
  141.         return
  142.     while 1:
  143.         dir = f.readline()
  144.         if not dir:
  145.             break
  146.         if dir[0] == '#':
  147.             continue
  148.         if dir.startswith("import"):
  149.             exec dir
  150.             continue
  151.         if dir[-1] == '\n':
  152.             dir = dir[:-1]
  153.         dir, dircase = makepath(sitedir, dir)
  154.         if not dircase in _dirs_in_sys_path and os.path.exists(dir):
  155.             sys.path.append(dir)
  156.             _dirs_in_sys_path[dircase] = 1
  157.     if reset:
  158.         _dirs_in_sys_path = None
  159.  
  160. prefixes = [sys.prefix]
  161. sitedir = None # make sure sitedir is initialized because of later 'del'
  162. if sys.exec_prefix != sys.prefix:
  163.     prefixes.append(sys.exec_prefix)
  164. for prefix in prefixes:
  165.     if prefix:
  166.         if sys.platform in ('os2emx', 'riscos'):
  167.             sitedirs = [os.path.join(prefix, "Lib", "site-packages")]
  168.         elif os.sep == '/':
  169.             sitedirs = [os.path.join(prefix,
  170.                                      "lib",
  171.                                      "python" + sys.version[:3],
  172.                                      "site-packages"),
  173.                         os.path.join(prefix, "lib", "site-python")]
  174.         else:
  175.             sitedirs = [prefix, os.path.join(prefix, "lib", "site-packages")]
  176.         if sys.platform == 'darwin':
  177.             # for framework builds *only* we add the standard Apple
  178.             # locations. Currently only per-user, but /Library and
  179.             # /Network/Library could be added too
  180.             if 'Python.framework' in prefix:
  181.                 home = os.environ.get('HOME')
  182.                 if home:
  183.                     sitedirs.append(
  184.                         os.path.join(home,
  185.                                      'Library',
  186.                                      'Python',
  187.                                      sys.version[:3],
  188.                                      'site-packages'))
  189.         for sitedir in sitedirs:
  190.             if os.path.isdir(sitedir):
  191.                 addsitedir(sitedir)
  192. del prefix, sitedir
  193.  
  194. _dirs_in_sys_path = None
  195.  
  196.  
  197. # the OS/2 EMX port has optional extension modules that do double duty
  198. # as DLLs (and must use the .DLL file extension) for other extensions.
  199. # The library search path needs to be amended so these will be found
  200. # during module import.  Use BEGINLIBPATH so that these are at the start
  201. # of the library search path.
  202. if sys.platform == 'os2emx':
  203.     dllpath = os.path.join(sys.prefix, "Lib", "lib-dynload")
  204.     libpath = os.environ['BEGINLIBPATH'].split(';')
  205.     if libpath[-1]:
  206.         libpath.append(dllpath)
  207.     else:
  208.         libpath[-1] = dllpath
  209.     os.environ['BEGINLIBPATH'] = ';'.join(libpath)
  210.  
  211.  
  212. # Define new built-ins 'quit' and 'exit'.
  213. # These are simply strings that display a hint on how to exit.
  214. if os.sep == ':':
  215.     exit = 'Use Cmd-Q to quit.'
  216. elif os.sep == '\\':
  217.     exit = 'Use Ctrl-Z plus Return to exit.'
  218. else:
  219.     exit = 'Use Ctrl-D (i.e. EOF) to exit.'
  220. import __builtin__
  221. __builtin__.quit = __builtin__.exit = exit
  222. del exit
  223.  
  224. # interactive prompt objects for printing the license text, a list of
  225. # contributors and the copyright notice.
  226. class _Printer:
  227.     MAXLINES = 23
  228.  
  229.     def __init__(self, name, data, files=(), dirs=()):
  230.         self.__name = name
  231.         self.__data = data
  232.         self.__files = files
  233.         self.__dirs = dirs
  234.         self.__lines = None
  235.  
  236.     def __setup(self):
  237.         if self.__lines:
  238.             return
  239.         data = None
  240.         for dir in self.__dirs:
  241.             for file in self.__files:
  242.                 file = os.path.join(dir, file)
  243.                 try:
  244.                     fp = open(file)
  245.                     data = fp.read()
  246.                     fp.close()
  247.                     break
  248.                 except IOError:
  249.                     pass
  250.             if data:
  251.                 break
  252.         if not data:
  253.             data = self.__data
  254.         self.__lines = data.split('\n')
  255.         self.__linecnt = len(self.__lines)
  256.  
  257.     def __repr__(self):
  258.         self.__setup()
  259.         if len(self.__lines) <= self.MAXLINES:
  260.             return "\n".join(self.__lines)
  261.         else:
  262.             return "Type %s() to see the full %s text" % ((self.__name,)*2)
  263.  
  264.     def __call__(self):
  265.         self.__setup()
  266.         prompt = 'Hit Return for more, or q (and Return) to quit: '
  267.         lineno = 0
  268.         while 1:
  269.             try:
  270.                 for i in range(lineno, lineno + self.MAXLINES):
  271.                     print self.__lines[i]
  272.             except IndexError:
  273.                 break
  274.             else:
  275.                 lineno += self.MAXLINES
  276.                 key = None
  277.                 while key is None:
  278.                     key = raw_input(prompt)
  279.                     if key not in ('', 'q'):
  280.                         key = None
  281.                 if key == 'q':
  282.                     break
  283.  
  284. __builtin__.copyright = _Printer("copyright", sys.copyright)
  285. if sys.platform[:4] == 'java':
  286.     __builtin__.credits = _Printer(
  287.         "credits",
  288.         "Jython is maintained by the Jython developers (www.jython.org).")
  289. else:
  290.     __builtin__.credits = _Printer("credits", """\
  291. Thanks to CWI, CNRI, BeOpen.com, Zope Corporation and a cast of thousands
  292. for supporting Python development.  See www.python.org for more information.""")
  293. here = os.path.dirname(os.__file__)
  294. __builtin__.license = _Printer(
  295.     "license", "See http://www.python.org/%.3s/license.html" % sys.version,
  296.     ["LICENSE.txt", "LICENSE"],
  297.     [os.path.join(here, os.pardir), here, os.curdir])
  298.  
  299.  
  300. # Define new built-in 'help'.
  301. # This is a wrapper around pydoc.help (with a twist).
  302.  
  303. class _Helper:
  304.     def __repr__(self):
  305.         return "Type help() for interactive help, " \
  306.                "or help(object) for help about object."
  307.     def __call__(self, *args, **kwds):
  308.         import pydoc
  309.         return pydoc.help(*args, **kwds)
  310.  
  311. __builtin__.help = _Helper()
  312.  
  313.  
  314. # On Windows, some default encodings are not provided
  315. # by Python (e.g. "cp932" in Japanese locale), while they
  316. # are always available as "mbcs" in each locale.
  317. # Make them usable by aliasing to "mbcs" in such a case.
  318.  
  319. if sys.platform == 'win32':
  320.     import locale, codecs
  321.     enc = locale.getdefaultlocale()[1]
  322.     if enc.startswith('cp'):            # "cp***" ?
  323.         try:
  324.             codecs.lookup(enc)
  325.         except LookupError:
  326.             import encodings
  327.             encodings._cache[enc] = encodings._unknown
  328.             encodings.aliases.aliases[enc] = 'mbcs'
  329.  
  330. # Set the string encoding used by the Unicode implementation.  The
  331. # default is 'ascii', but if you're willing to experiment, you can
  332. # change this.
  333.  
  334. encoding = "ascii" # Default value set by _PyUnicode_Init()
  335.  
  336. if 0:
  337.     # Enable to support locale aware default string encodings.
  338.     import locale
  339.     loc = locale.getdefaultlocale()
  340.     if loc[1]:
  341.         encoding = loc[1]
  342.  
  343. if 0:
  344.     # Enable to switch off string to Unicode coercion and implicit
  345.     # Unicode to string conversion.
  346.     encoding = "undefined"
  347.  
  348. if encoding != "ascii":
  349.     # On Non-Unicode builds this will raise an AttributeError...
  350.     sys.setdefaultencoding(encoding) # Needs Python Unicode build !
  351.  
  352. #
  353. # Run custom site specific code, if available.
  354. #
  355. try:
  356.     import sitecustomize
  357. except ImportError:
  358.     pass
  359.  
  360. #
  361. # Remove sys.setdefaultencoding() so that users cannot change the
  362. # encoding after initialization.  The test for presence is needed when
  363. # this module is run as a script, because this code is executed twice.
  364. #
  365. if hasattr(sys, "setdefaultencoding"):
  366.     del sys.setdefaultencoding
  367.  
  368. def _test():
  369.     print "sys.path = ["
  370.     for dir in sys.path:
  371.         print "    %s," % `dir`
  372.     print "]"
  373.  
  374. if __name__ == '__main__':
  375.     _test()
  376.