site.py 17.8 KB
Newer Older
1
"""Append module search paths for third-party packages to sys.path.
2

3 4 5
****************************************************************
* This module is automatically imported during initialization. *
****************************************************************
6

7
This will append site-specific paths to the module search path.  On
8 9 10 11 12
Unix (including Mac OSX), 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 (such as Windows), it tries each of the
prefixes directly, as well as with lib/site-packages appended.  The
13 14
resulting directories, if they exist, are appended to sys.path, and
also inspected for path configuration files.
15

16 17 18 19 20
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
21
'#' are skipped. Lines starting with 'import' are executed.
22

23
For example, suppose sys.prefix and sys.exec_prefix are set to
24
/usr/local and there is a directory /usr/local/lib/python2.5/site-packages
25 26 27
with three subdirectories, foo, bar and spam, and two path
configuration files, foo.pth and bar.pth.  Assume foo.pth contains the
following:
28 29 30 31 32 33 34 35 36 37 38 39 40

  # 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:

41 42
  /usr/local/lib/python2.5/site-packages/bar
  /usr/local/lib/python2.5/site-packages/foo
43 44 45 46

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.
47 48

After these path manipulations, an attempt is made to import a module
49 50 51
named sitecustomize, which can perform arbitrary additional
site-specific customizations.  If this import fails with an
ImportError exception, it is silently ignored.
52 53 54

"""

55 56
import sys
import os
57
import builtins
58

59 60 61 62 63
# Prefixes for site-packages; add additional prefixes like /usr/local here
PREFIXES = [sys.prefix, sys.exec_prefix]
# Enable per user site-packages directory
# set it to False to disable the feature or True to force the feature
ENABLE_USER_SITE = None
64

65
# for distutils.commands.install
66 67
# These values are initialized by the getuserbase() and getusersitepackages()
# functions, through the main() function when Python starts.
68 69 70
USER_SITE = None
USER_BASE = None

71

72
def makepath(*paths):
73 74 75 76 77
    dir = os.path.join(*paths)
    try:
        dir = os.path.abspath(dir)
    except OSError:
        pass
78
    return dir, os.path.normcase(dir)
79

80

Barry Warsaw's avatar
Barry Warsaw committed
81 82
def abs_paths():
    """Set all module __file__ and __cached__ attributes to an absolute path"""
83
    for m in set(sys.modules.values()):
84 85
        if hasattr(m, '__loader__'):
            continue   # don't mess with a PEP 302-supplied __file__
86 87
        try:
            m.__file__ = os.path.abspath(m.__file__)
88
        except (AttributeError, OSError):
Barry Warsaw's avatar
Barry Warsaw committed
89 90 91
            pass
        try:
            m.__cached__ = os.path.abspath(m.__cached__)
92
        except (AttributeError, OSError):
Barry Warsaw's avatar
Barry Warsaw committed
93
            pass
94

95

96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
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

114

115
def _init_pathinfo():
116 117
    """Return a set containing all existing directory entries from sys.path"""
    d = set()
118
    for dir in sys.path:
119 120 121 122 123
        try:
            if os.path.isdir(dir):
                dir, dircase = makepath(dir)
                d.add(dircase)
        except TypeError:
124
            continue
125
    return d
126

127

128
def addpackage(sitedir, name, known_paths):
129 130 131 132
    """Process a .pth file within the site-packages directory:
       For each line in the file, either combine it with sitedir to a path
       and add that to known_paths, or execute it if it starts with 'import '.
    """
133
    if known_paths is None:
134 135 136 137
        _init_pathinfo()
        reset = 1
    else:
        reset = 0
138 139
    fullname = os.path.join(sitedir, name)
    try:
140
        f = open(fullname, "rU")
141 142
    except IOError:
        return
143
    with f:
144 145 146
        for line in f:
            if line.startswith("#"):
                continue
147
            if line.startswith(("import ", "import\t")):
148
                exec(line)
149 150 151 152 153 154 155 156 157 158
                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)
    if reset:
        known_paths = None
    return known_paths

159

160
def addsitedir(sitedir, known_paths=None):
161 162 163
    """Add 'sitedir' argument to sys.path if missing and handle .pth files in
    'sitedir'"""
    if known_paths is None:
164
        known_paths = _init_pathinfo()
165 166 167
        reset = 1
    else:
        reset = 0
168
    sitedir, sitedircase = makepath(sitedir)
169
    if not sitedircase in known_paths:
170
        sys.path.append(sitedir)        # Add path component
171
    try:
172
        names = os.listdir(sitedir)
173
    except os.error:
174
        return
175 176 177
    names = [name for name in names if name.endswith(".pth")]
    for name in sorted(names):
        addpackage(sitedir, name, known_paths)
178
    if reset:
179 180 181
        known_paths = None
    return known_paths

182 183 184 185

def check_enableusersite():
    """Check if user site directory is safe for inclusion

186
    The function tests for the command line flag (including environment var),
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
    process uid/gid equal to effective uid/gid.

    None: Disabled for security reasons
    False: Disabled by user (command line option)
    True: Safe and enabled
    """
    if sys.flags.no_user_site:
        return False

    if hasattr(os, "getuid") and hasattr(os, "geteuid"):
        # check process uid == effective uid
        if os.geteuid() != os.getuid():
            return None
    if hasattr(os, "getgid") and hasattr(os, "getegid"):
        # check process gid == effective gid
        if os.getegid() != os.getgid():
            return None

    return True

207 208
def getuserbase():
    """Returns the `user base` directory path.
209

210 211 212
    The `user base` directory can be used to store data. If the global
    variable ``USER_BASE`` is not initialized yet, this function will also set
    it.
213
    """
214 215 216
    global USER_BASE
    if USER_BASE is not None:
        return USER_BASE
217 218
    from sysconfig import get_config_var
    USER_BASE = get_config_var('userbase')
219 220 221 222 223 224 225 226 227 228 229 230 231 232
    return USER_BASE

def getusersitepackages():
    """Returns the user-specific site-packages directory path.

    If the global variable ``USER_SITE`` is not initialized yet, this
    function will also set it.
    """
    global USER_SITE
    user_base = getuserbase() # this will also set USER_BASE

    if USER_SITE is not None:
        return USER_SITE

233 234
    from sysconfig import get_path
    import os
235 236 237 238 239 240 241

    if sys.platform == 'darwin':
        from sysconfig import get_config_var
        if get_config_var('PYTHONFRAMEWORK'):
            USER_SITE = get_path('purelib', 'osx_framework_user')
            return USER_SITE

242
    USER_SITE = get_path('purelib', '%s_user' % os.name)
243 244 245 246 247 248 249 250 251 252 253 254 255 256
    return USER_SITE

def addusersitepackages(known_paths):
    """Add a per user site-package to sys.path

    Each user has its own python directory with site-packages in the
    home directory.
    """
    # get the per user site-package path
    # this call will also make sure USER_BASE and USER_SITE are set
    user_site = getusersitepackages()

    if ENABLE_USER_SITE and os.path.isdir(user_site):
        addsitedir(user_site, known_paths)
257 258
    return known_paths

259 260 261
def getsitepackages():
    """Returns a list containing all global site-packages directories
    (and possibly site-python).
262

263 264 265 266 267
    For each directory present in the global ``PREFIXES``, this function
    will find its `site-packages` subdirectory depending on the system
    environment, and will return a list of full paths.
    """
    sitepackages = []
268
    seen = set()
269 270 271 272

    for prefix in PREFIXES:
        if not prefix or prefix in seen:
            continue
273
        seen.add(prefix)
274 275

        if sys.platform in ('os2emx', 'riscos'):
276
            sitepackages.append(os.path.join(prefix, "Lib", "site-packages"))
277
        elif os.sep == '/':
278
            sitepackages.append(os.path.join(prefix, "lib",
279 280
                                        "python" + sys.version[:3],
                                        "site-packages"))
281
            sitepackages.append(os.path.join(prefix, "lib", "site-python"))
282
        else:
283 284
            sitepackages.append(prefix)
            sitepackages.append(os.path.join(prefix, "lib", "site-packages"))
285 286
        if sys.platform == "darwin":
            # for framework builds *only* we add the standard Apple
287
            # locations.
288 289
            from sysconfig import get_config_var
            framework = get_config_var("PYTHONFRAMEWORK")
290
            if framework:
291
                sitepackages.append(
292
                        os.path.join("/Library", framework,
293
                            sys.version[:3], "site-packages"))
294
    return sitepackages
295

296 297 298
def addsitepackages(known_paths):
    """Add site-packages (and possibly site-python) to sys.path"""
    for sitedir in getsitepackages():
299 300 301 302
        if os.path.isdir(sitedir):
            addsitedir(sitedir, known_paths)

    return known_paths
303 304 305 306 307 308 309

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.
Tim Peters's avatar
Tim Peters committed
310

311
    """
312 313 314 315 316 317 318 319 320
    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)


321
def setquit():
322 323 324 325
    """Define new builtins 'quit' and 'exit'.

    These are objects which make the interpreter exit when called.
    The repr of each object contains a hint at how it works.
326 327 328

    """
    if os.sep == ':':
329
        eof = 'Cmd-Q'
330
    elif os.sep == '\\':
331
        eof = 'Ctrl-Z plus Return'
332
    else:
333
        eof = 'Ctrl-D (i.e. EOF)'
Tim Peters's avatar
Tim Peters committed
334

335 336 337 338 339 340
    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):
341 342 343
            # Shells like IDLE catch the SystemExit, but listen when their
            # stdin wrapper is closed.
            try:
344 345 346 347 348 349
                fd = -1
                if hasattr(sys.stdin, "fileno"):
                    fd = sys.stdin.fileno()
                if fd != 0:
                    # Don't close stdin if it wraps fd 0
                    sys.stdin.close()
350 351
            except:
                pass
352
            raise SystemExit(code)
353 354
    builtins.quit = Quitter('quit')
    builtins.exit = Quitter('exit')
355 356 357 358 359


class _Printer(object):
    """interactive prompt objects for printing the license text, a list of
    contributors and the copyright notice."""
360

361 362
    MAXLINES = 23

363 364 365 366 367 368 369 370 371 372 373 374
    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:
375 376
            for filename in self.__files:
                filename = os.path.join(dir, filename)
377
                try:
378
                    fp = open(filename, "rU")
379 380 381 382 383 384 385 386 387 388
                    data = fp.read()
                    fp.close()
                    break
                except IOError:
                    pass
            if data:
                break
        if not data:
            data = self.__data
        self.__lines = data.split('\n')
389 390 391
        self.__linecnt = len(self.__lines)

    def __repr__(self):
392 393 394 395 396 397 398 399
        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()
400 401 402 403 404
        prompt = 'Hit Return for more, or q (and Return) to quit: '
        lineno = 0
        while 1:
            try:
                for i in range(lineno, lineno + self.MAXLINES):
405
                    print(self.__lines[i])
406 407 408 409 410 411
            except IndexError:
                break
            else:
                lineno += self.MAXLINES
                key = None
                while key is None:
412
                    key = input(prompt)
413 414 415 416 417
                    if key not in ('', 'q'):
                        key = None
                if key == 'q':
                    break

418
def setcopyright():
419 420
    """Set 'copyright' and 'credits' in builtins"""
    builtins.copyright = _Printer("copyright", sys.copyright)
421
    if sys.platform[:4] == 'java':
422
        builtins.credits = _Printer(
423 424 425
            "credits",
            "Jython is maintained by the Jython developers (www.jython.org).")
    else:
426
        builtins.credits = _Printer("credits", """\
427 428 429
    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__)
430
    builtins.license = _Printer(
431 432 433 434 435 436
        "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):
437
    """Define the builtin 'help'.
438 439 440 441
    This is a wrapper around pydoc.help (with a twist).

    """

442 443 444 445 446 447 448
    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)

449
def sethelper():
450
    builtins.help = _Helper()
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473

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 execsitecustomize():
    """Run custom site specific code, if available."""
    try:
        import sitecustomize
    except ImportError:
        pass
474
    except Exception as err:
475
        if os.environ.get("PYTHONVERBOSE"):
476 477 478 479 480 481
            sys.excepthook(*sys.exc_info())
        else:
            sys.stderr.write(
                "Error in sitecustomize; set PYTHONVERBOSE for traceback:\n"
                "%s: %s\n" %
                (err.__class__.__name__, err))
482 483


484 485 486 487 488 489
def execusercustomize():
    """Run custom user specific code, if available."""
    try:
        import usercustomize
    except ImportError:
        pass
490 491 492 493 494 495 496 497
    except Exception as err:
        if os.environ.get("PYTHONVERBOSE"):
            sys.excepthook(*sys.exc_info())
        else:
            sys.stderr.write(
                "Error in usercustomize; set PYTHONVERBOSE for traceback:\n"
                "%s: %s\n" %
                (err.__class__.__name__, err))
498 499


500
def main():
501 502
    global ENABLE_USER_SITE

Barry Warsaw's avatar
Barry Warsaw committed
503
    abs_paths()
504 505 506 507 508
    known_paths = removeduppaths()
    if ENABLE_USER_SITE is None:
        ENABLE_USER_SITE = check_enableusersite()
    known_paths = addusersitepackages(known_paths)
    known_paths = addsitepackages(known_paths)
509 510 511 512 513 514 515
    if sys.platform == 'os2emx':
        setBEGINLIBPATH()
    setquit()
    setcopyright()
    sethelper()
    aliasmbcs()
    execsitecustomize()
516 517
    if ENABLE_USER_SITE:
        execusercustomize()
518 519

main()
520

521 522 523 524 525 526 527 528 529 530
def _script():
    help = """\
    %s [--user-base] [--user-site]

    Without arguments print some useful information
    With arguments print the value of USER_BASE and/or USER_SITE separated
    by '%s'.

    Exit codes with --user-base or --user-site:
      0 - user site directory is enabled
531
      1 - user site directory is disabled by user
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
      2 - uses site directory is disabled by super user
          or for security reasons
     >2 - unknown error
    """
    args = sys.argv[1:]
    if not args:
        print("sys.path = [")
        for dir in sys.path:
            print("    %r," % (dir,))
        print("]")
        print("USER_BASE: %r (%s)" % (USER_BASE,
            "exists" if os.path.isdir(USER_BASE) else "doesn't exist"))
        print("USER_SITE: %r (%s)" % (USER_SITE,
            "exists" if os.path.isdir(USER_SITE) else "doesn't exist"))
        print("ENABLE_USER_SITE: %r" %  ENABLE_USER_SITE)
        sys.exit(0)

    buffer = []
    if '--user-base' in args:
        buffer.append(USER_BASE)
    if '--user-site' in args:
        buffer.append(USER_SITE)

    if buffer:
        print(os.pathsep.join(buffer))
        if ENABLE_USER_SITE:
            sys.exit(0)
        elif ENABLE_USER_SITE is False:
            sys.exit(1)
        elif ENABLE_USER_SITE is None:
            sys.exit(2)
        else:
            sys.exit(3)
    else:
        import textwrap
        print(textwrap.dedent(help % (sys.argv[0], os.pathsep)))
        sys.exit(10)
569 570

if __name__ == '__main__':
571
    _script()