1 """Append module search paths for third-party packages to sys.path.
3 ****************************************************************
4 * This module is automatically imported during initialization. *
5 ****************************************************************
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
13 This will append site-specific paths to the module search path. On
14 Unix (including Mac OSX), it starts with sys.prefix and
15 sys.exec_prefix (if different) and appends
16 lib/python<version>/site-packages as well as lib/site-python.
17 On other platforms (such as Windows), it tries each of the
18 prefixes directly, as well as with lib/site-packages appended. The
19 resulting directories, if they exist, are appended to sys.path, and
20 also inspected for path configuration files.
22 A path configuration file is a file whose name has the form
23 <package>.pth; its contents are additional directories (one per line)
24 to be added to sys.path. Non-existing directories (or
25 non-directories) are never added to sys.path; no directory is added to
26 sys.path more than once. Blank lines and lines beginning with
27 '#' are skipped. Lines starting with 'import' are executed.
29 For example, suppose sys.prefix and sys.exec_prefix are set to
30 /usr/local and there is a directory /usr/local/lib/python2.5/site-packages
31 with three subdirectories, foo, bar and spam, and two path
32 configuration files, foo.pth and bar.pth. Assume foo.pth contains the
35 # foo package configuration
42 # bar package configuration
45 Then the following directories are added to sys.path, in this order:
47 /usr/local/lib/python2.5/site-packages/bar
48 /usr/local/lib/python2.5/site-packages/foo
50 Note that bletch is omitted because it doesn't exist; bar precedes foo
51 because bar.pth comes alphabetically before foo.pth; and spam is
52 omitted because it is not mentioned in either path configuration file.
54 After these path manipulations, an attempt is made to import a module
55 named sitecustomize, which can perform arbitrary additional
56 site-specific customizations. If this import fails with an
57 ImportError exception, it is silently ignored.
67 dir = os.path.abspath(os.path.join(*paths))
68 return dir, os.path.normcase(dir)
71 """Set all module' __file__ attribute to an absolute path"""
72 for m in sys.modules.values():
73 if hasattr(m, '__loader__'):
74 continue # don't mess with a PEP 302-supplied __file__
76 m.__file__ = os.path.abspath(m.__file__)
77 except AttributeError:
81 """ Remove duplicate entries from sys.path along with making them
83 # This ensures that the initial path provided by the interpreter contains
84 # only absolute pathnames, even if we're running from the build directory.
88 # Filter out duplicate paths (on case-insensitive file systems also
89 # if they only differ in case); turn relative paths into absolute
91 dir, dircase = makepath(dir)
92 if not dircase in known_paths:
94 known_paths.add(dircase)
98 # XXX This should not be part of site.py, since it is needed even when
99 # using the -S option for Python. See http://www.python.org/sf/586680
101 """Append ./build/lib.<platform> in case we're running in the build dir
102 (especially for Guido :-)"""
103 from distutils.util import get_platform
104 s = "build/lib.%s-%.3s" % (get_platform(), sys.version)
105 s = os.path.join(os.path.dirname(sys.path[-1]), s)
108 def _init_pathinfo():
109 """Return a set containing all existing directory entries from sys.path"""
113 if os.path.isdir(dir):
114 dir, dircase = makepath(dir)
120 def addpackage(sitedir, name, known_paths):
121 """Add a new path to known_paths by combining sitedir and 'name' or execute
122 sitedir if it starts with 'import'"""
123 if known_paths is None:
128 fullname = os.path.join(sitedir, name)
130 f = open(fullname, "rU")
135 if line.startswith("#"):
137 if line.startswith("import"):
141 dir, dircase = makepath(sitedir, line)
142 if not dircase in known_paths and os.path.exists(dir):
144 known_paths.add(dircase)
151 def addsitedir(sitedir, known_paths=None):
152 """Add 'sitedir' argument to sys.path if missing and handle .pth files in
154 if known_paths is None:
155 known_paths = _init_pathinfo()
159 sitedir, sitedircase = makepath(sitedir)
160 if not sitedircase in known_paths:
161 sys.path.append(sitedir) # Add path component
163 names = os.listdir(sitedir)
168 if name.endswith(os.extsep + "pth"):
169 addpackage(sitedir, name, known_paths)
174 def addsitepackages(known_paths):
175 """Add site-packages (and possibly site-python) to sys.path"""
176 prefixes = [sys.prefix]
177 if sys.exec_prefix != sys.prefix:
178 prefixes.append(sys.exec_prefix)
179 for prefix in prefixes:
181 if sys.platform in ('os2emx', 'riscos'):
182 sitedirs = [os.path.join(prefix, "Lib", "site-packages")]
184 sitedirs = [os.path.join(prefix,
186 "python" + sys.version[:3],
188 os.path.join(prefix, "lib", "site-python")]
190 sitedirs = [prefix, os.path.join(prefix, "lib", "site-packages")]
191 if sys.platform == 'darwin':
192 # for framework builds *only* we add the standard Apple
193 # locations. Currently only per-user, but /Library and
194 # /Network/Library could be added too
195 if 'Python.framework' in prefix:
196 home = os.environ.get('HOME')
204 for sitedir in sitedirs:
205 if os.path.isdir(sitedir):
206 addsitedir(sitedir, known_paths)
210 def setBEGINLIBPATH():
211 """The OS/2 EMX port has optional extension modules that do double duty
212 as DLLs (and must use the .DLL file extension) for other extensions.
213 The library search path needs to be amended so these will be found
214 during module import. Use BEGINLIBPATH so that these are at the start
215 of the library search path.
218 dllpath = os.path.join(sys.prefix, "Lib", "lib-dynload")
219 libpath = os.environ['BEGINLIBPATH'].split(';')
221 libpath.append(dllpath)
223 libpath[-1] = dllpath
224 os.environ['BEGINLIBPATH'] = ';'.join(libpath)
228 """Define new built-ins 'quit' and 'exit'.
229 These are simply strings that display a hint on how to exit.
235 eof = 'Ctrl-Z plus Return'
237 eof = 'Ctrl-D (i.e. EOF)'
239 class Quitter(object):
240 def __init__(self, name):
243 return 'Use %s() or %s to exit' % (self.name, eof)
244 def __call__(self, code=None):
245 # Shells like IDLE catch the SystemExit, but listen when their
246 # stdin wrapper is closed.
251 raise SystemExit(code)
252 __builtin__.quit = Quitter('quit')
253 __builtin__.exit = Quitter('exit')
256 class _Printer(object):
257 """interactive prompt objects for printing the license text, a list of
258 contributors and the copyright notice."""
262 def __init__(self, name, data, files=(), dirs=()):
273 for dir in self.__dirs:
274 for filename in self.__files:
275 filename = os.path.join(dir, filename)
277 fp = file(filename, "rU")
287 self.__lines = data.split('\n')
288 self.__linecnt = len(self.__lines)
292 if len(self.__lines) <= self.MAXLINES:
293 return "\n".join(self.__lines)
295 return "Type %s() to see the full %s text" % ((self.__name,)*2)
299 prompt = 'Hit Return for more, or q (and Return) to quit: '
303 for i in range(lineno, lineno + self.MAXLINES):
304 print self.__lines[i]
308 lineno += self.MAXLINES
311 key = raw_input(prompt)
312 if key not in ('', 'q'):
318 """Set 'copyright' and 'credits' in __builtin__"""
319 __builtin__.copyright = _Printer("copyright", sys.copyright)
320 if sys.platform[:4] == 'java':
321 __builtin__.credits = _Printer(
323 "Jython is maintained by the Jython developers (www.jython.org).")
325 __builtin__.credits = _Printer("credits", """\
326 Thanks to CWI, CNRI, BeOpen.com, Zope Corporation and a cast of thousands
327 for supporting Python development. See www.python.org for more information.""")
328 here = os.path.dirname(os.__file__)
329 __builtin__.license = _Printer(
330 "license", "See http://www.python.org/%.3s/license.html" % sys.version,
331 ["LICENSE.txt", "LICENSE"],
332 [os.path.join(here, os.pardir), here, os.curdir])
335 class _Helper(object):
336 """Define the built-in 'help'.
337 This is a wrapper around pydoc.help (with a twist).
342 return "Type help() for interactive help, " \
343 "or help(object) for help about object."
344 def __call__(self, *args, **kwds):
346 return pydoc.help(*args, **kwds)
349 __builtin__.help = _Helper()
352 """On Windows, some default encodings are not provided by Python,
353 while they are always available as "mbcs" in each locale. Make
354 them usable by aliasing to "mbcs" in such a case."""
355 if sys.platform == 'win32':
356 import locale, codecs
357 enc = locale.getdefaultlocale()[1]
358 if enc.startswith('cp'): # "cp***" ?
363 encodings._cache[enc] = encodings._unknown
364 encodings.aliases.aliases[enc] = 'mbcs'
367 """Set the string encoding used by the Unicode implementation. The
368 default is 'ascii', but if you're willing to experiment, you can
370 encoding = "ascii" # Default value set by _PyUnicode_Init()
372 # Enable to support locale aware default string encodings.
374 loc = locale.getdefaultlocale()
378 # Enable to switch off string to Unicode coercion and implicit
379 # Unicode to string conversion.
380 encoding = "undefined"
381 if encoding != "ascii":
382 # On Non-Unicode builds this will raise an AttributeError...
383 sys.setdefaultencoding(encoding) # Needs Python Unicode build !
386 def execsitecustomize():
387 """Run custom site specific code, if available."""
396 paths_in_sys = removeduppaths()
397 if (os.name == "posix" and sys.path and
398 os.path.basename(sys.path[-1]) == "Modules"):
400 paths_in_sys = addsitepackages(paths_in_sys)
401 if sys.platform == 'os2emx':
409 # Remove sys.setdefaultencoding() so that users cannot change the
410 # encoding after initialization. The test for presence is needed when
411 # this module is run as a script, because this code is executed twice.
412 if hasattr(sys, "setdefaultencoding"):
413 del sys.setdefaultencoding
420 print " %r," % (dir,)
423 if __name__ == '__main__':