Guido van Rossum | f30bec7 | 1997-08-29 22:30:45 +0000 | [diff] [blame] | 1 | """Append module search paths for third-party packages to sys.path. |
Guido van Rossum | e57c96e | 1996-08-17 19:56:26 +0000 | [diff] [blame] | 2 | |
Guido van Rossum | f30bec7 | 1997-08-29 22:30:45 +0000 | [diff] [blame] | 3 | **************************************************************** |
| 4 | * This module is automatically imported during initialization. * |
| 5 | **************************************************************** |
Guido van Rossum | e57c96e | 1996-08-17 19:56:26 +0000 | [diff] [blame] | 6 | |
Walter Dörwald | f0dfc7a | 2003-10-20 14:01:56 +0000 | [diff] [blame] | 7 | This will append site-specific paths to the module search path. On |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 8 | Unix (including Mac OSX), it starts with sys.prefix and |
| 9 | sys.exec_prefix (if different) and appends |
Antoine Pitrou | 9e82b17 | 2014-06-12 19:41:30 -0400 | [diff] [blame] | 10 | lib/python<version>/site-packages. |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 11 | On other platforms (such as Windows), it tries each of the |
| 12 | prefixes directly, as well as with lib/site-packages appended. The |
Guido van Rossum | 62b297b | 1997-09-08 02:14:09 +0000 | [diff] [blame] | 13 | resulting directories, if they exist, are appended to sys.path, and |
| 14 | also inspected for path configuration files. |
Guido van Rossum | e57c96e | 1996-08-17 19:56:26 +0000 | [diff] [blame] | 15 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 16 | If a file named "pyvenv.cfg" exists one directory above sys.executable, |
| 17 | sys.prefix and sys.exec_prefix are set to that directory and |
Antoine Pitrou | 9e82b17 | 2014-06-12 19:41:30 -0400 | [diff] [blame] | 18 | it is also checked for site-packages (sys.base_prefix and |
Vinay Sajip | abd344c | 2012-07-03 16:33:57 +0100 | [diff] [blame] | 19 | sys.base_exec_prefix will always be the "real" prefixes of the Python |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 20 | installation). If "pyvenv.cfg" (a bootstrap configuration file) contains |
| 21 | the key "include-system-site-packages" set to anything other than "false" |
| 22 | (case-insensitive), the system-level prefixes will still also be |
| 23 | searched for site-packages; otherwise they won't. |
| 24 | |
| 25 | All of the resulting site-specific directories, if they exist, are |
| 26 | appended to sys.path, and also inspected for path configuration |
| 27 | files. |
| 28 | |
Guido van Rossum | f30bec7 | 1997-08-29 22:30:45 +0000 | [diff] [blame] | 29 | A path configuration file is a file whose name has the form |
| 30 | <package>.pth; its contents are additional directories (one per line) |
| 31 | to be added to sys.path. Non-existing directories (or |
| 32 | non-directories) are never added to sys.path; no directory is added to |
| 33 | sys.path more than once. Blank lines and lines beginning with |
Guido van Rossum | facf24b | 2001-12-17 16:07:06 +0000 | [diff] [blame] | 34 | '#' are skipped. Lines starting with 'import' are executed. |
Guido van Rossum | e57c96e | 1996-08-17 19:56:26 +0000 | [diff] [blame] | 35 | |
Guido van Rossum | f30bec7 | 1997-08-29 22:30:45 +0000 | [diff] [blame] | 36 | For example, suppose sys.prefix and sys.exec_prefix are set to |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 37 | /usr/local and there is a directory /usr/local/lib/python2.5/site-packages |
Guido van Rossum | 62b297b | 1997-09-08 02:14:09 +0000 | [diff] [blame] | 38 | with three subdirectories, foo, bar and spam, and two path |
| 39 | configuration files, foo.pth and bar.pth. Assume foo.pth contains the |
| 40 | following: |
Guido van Rossum | f30bec7 | 1997-08-29 22:30:45 +0000 | [diff] [blame] | 41 | |
| 42 | # foo package configuration |
| 43 | foo |
| 44 | bar |
| 45 | bletch |
| 46 | |
| 47 | and bar.pth contains: |
| 48 | |
| 49 | # bar package configuration |
| 50 | bar |
| 51 | |
| 52 | Then the following directories are added to sys.path, in this order: |
| 53 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 54 | /usr/local/lib/python2.5/site-packages/bar |
| 55 | /usr/local/lib/python2.5/site-packages/foo |
Guido van Rossum | f30bec7 | 1997-08-29 22:30:45 +0000 | [diff] [blame] | 56 | |
| 57 | Note that bletch is omitted because it doesn't exist; bar precedes foo |
| 58 | because bar.pth comes alphabetically before foo.pth; and spam is |
| 59 | omitted because it is not mentioned in either path configuration file. |
Guido van Rossum | e57c96e | 1996-08-17 19:56:26 +0000 | [diff] [blame] | 60 | |
Antoine Pitrou | 1a6cb30 | 2013-05-04 20:08:35 +0200 | [diff] [blame] | 61 | The readline module is also automatically configured to enable |
Martin Panter | e26da7c | 2016-06-02 10:07:09 +0000 | [diff] [blame] | 62 | completion for systems that support it. This can be overridden in |
Steve Dower | 313523c | 2016-09-17 12:22:41 -0700 | [diff] [blame] | 63 | sitecustomize, usercustomize or PYTHONSTARTUP. Starting Python in |
| 64 | isolated mode (-I) disables automatic readline configuration. |
Antoine Pitrou | 1a6cb30 | 2013-05-04 20:08:35 +0200 | [diff] [blame] | 65 | |
| 66 | After these operations, an attempt is made to import a module |
Guido van Rossum | f30bec7 | 1997-08-29 22:30:45 +0000 | [diff] [blame] | 67 | named sitecustomize, which can perform arbitrary additional |
| 68 | site-specific customizations. If this import fails with an |
| 69 | ImportError exception, it is silently ignored. |
Guido van Rossum | e57c96e | 1996-08-17 19:56:26 +0000 | [diff] [blame] | 70 | """ |
| 71 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 72 | import sys |
| 73 | import os |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 74 | import builtins |
Antoine Pitrou | 853395b | 2013-08-06 22:56:40 +0200 | [diff] [blame] | 75 | import _sitebuiltins |
Guido van Rossum | e57c96e | 1996-08-17 19:56:26 +0000 | [diff] [blame] | 76 | |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 77 | # Prefixes for site-packages; add additional prefixes like /usr/local here |
| 78 | PREFIXES = [sys.prefix, sys.exec_prefix] |
| 79 | # Enable per user site-packages directory |
| 80 | # set it to False to disable the feature or True to force the feature |
| 81 | ENABLE_USER_SITE = None |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 82 | |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 83 | # for distutils.commands.install |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 84 | # These values are initialized by the getuserbase() and getusersitepackages() |
| 85 | # functions, through the main() function when Python starts. |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 86 | USER_SITE = None |
| 87 | USER_BASE = None |
| 88 | |
Guido van Rossum | d74fb6b | 2001-03-02 06:43:49 +0000 | [diff] [blame] | 89 | |
Fred Drake | 38cb9f1 | 2000-09-28 16:52:36 +0000 | [diff] [blame] | 90 | def makepath(*paths): |
Victor Stinner | b103a93 | 2010-10-12 22:23:23 +0000 | [diff] [blame] | 91 | dir = os.path.join(*paths) |
| 92 | try: |
| 93 | dir = os.path.abspath(dir) |
| 94 | except OSError: |
| 95 | pass |
Fred Drake | 1fb5ce0 | 2001-07-02 16:55:42 +0000 | [diff] [blame] | 96 | return dir, os.path.normcase(dir) |
Fred Drake | 38cb9f1 | 2000-09-28 16:52:36 +0000 | [diff] [blame] | 97 | |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 98 | |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 99 | def abs_paths(): |
| 100 | """Set all module __file__ and __cached__ attributes to an absolute path""" |
Guido van Rossum | 7ac9d40 | 2007-05-18 00:24:43 +0000 | [diff] [blame] | 101 | for m in set(sys.modules.values()): |
Eric Snow | 32439d6 | 2015-05-02 19:15:18 -0600 | [diff] [blame] | 102 | if (getattr(getattr(m, '__loader__', None), '__module__', None) not in |
| 103 | ('_frozen_importlib', '_frozen_importlib_external')): |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 104 | continue # don't mess with a PEP 302-supplied __file__ |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 105 | try: |
| 106 | m.__file__ = os.path.abspath(m.__file__) |
Steve Weber | 2487f30 | 2018-06-10 20:49:34 -0400 | [diff] [blame] | 107 | except (AttributeError, OSError, TypeError): |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 108 | pass |
| 109 | try: |
| 110 | m.__cached__ = os.path.abspath(m.__cached__) |
Steve Weber | 2487f30 | 2018-06-10 20:49:34 -0400 | [diff] [blame] | 111 | except (AttributeError, OSError, TypeError): |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 112 | pass |
Fred Drake | 38cb9f1 | 2000-09-28 16:52:36 +0000 | [diff] [blame] | 113 | |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 114 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 115 | def removeduppaths(): |
| 116 | """ Remove duplicate entries from sys.path along with making them |
| 117 | absolute""" |
| 118 | # This ensures that the initial path provided by the interpreter contains |
| 119 | # only absolute pathnames, even if we're running from the build directory. |
| 120 | L = [] |
| 121 | known_paths = set() |
| 122 | for dir in sys.path: |
| 123 | # Filter out duplicate paths (on case-insensitive file systems also |
| 124 | # if they only differ in case); turn relative paths into absolute |
| 125 | # paths. |
| 126 | dir, dircase = makepath(dir) |
INADA Naoki | a8f8d5b | 2017-06-29 00:31:53 +0900 | [diff] [blame] | 127 | if dircase not in known_paths: |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 128 | L.append(dir) |
| 129 | known_paths.add(dircase) |
| 130 | sys.path[:] = L |
| 131 | return known_paths |
Fred Drake | 38cb9f1 | 2000-09-28 16:52:36 +0000 | [diff] [blame] | 132 | |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 133 | |
Fred Drake | 7f5296e | 2001-07-20 20:06:17 +0000 | [diff] [blame] | 134 | def _init_pathinfo(): |
Brett Cannon | 5f0507d | 2016-04-08 15:04:28 -0700 | [diff] [blame] | 135 | """Return a set containing all existing file system items from sys.path.""" |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 136 | d = set() |
Brett Cannon | 5f0507d | 2016-04-08 15:04:28 -0700 | [diff] [blame] | 137 | for item in sys.path: |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 138 | try: |
Brett Cannon | 5f0507d | 2016-04-08 15:04:28 -0700 | [diff] [blame] | 139 | if os.path.exists(item): |
| 140 | _, itemcase = makepath(item) |
| 141 | d.add(itemcase) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 142 | except TypeError: |
Fred Drake | 7f5296e | 2001-07-20 20:06:17 +0000 | [diff] [blame] | 143 | continue |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 144 | return d |
Fred Drake | 7f5296e | 2001-07-20 20:06:17 +0000 | [diff] [blame] | 145 | |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 146 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 147 | def addpackage(sitedir, name, known_paths): |
Guido van Rossum | d59da4b | 2007-05-22 18:11:13 +0000 | [diff] [blame] | 148 | """Process a .pth file within the site-packages directory: |
| 149 | For each line in the file, either combine it with sitedir to a path |
| 150 | and add that to known_paths, or execute it if it starts with 'import '. |
| 151 | """ |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 152 | if known_paths is None: |
Brett Cannon | 13252b8 | 2013-01-25 13:57:16 -0500 | [diff] [blame] | 153 | known_paths = _init_pathinfo() |
Brett Cannon | 5f0507d | 2016-04-08 15:04:28 -0700 | [diff] [blame] | 154 | reset = True |
Fred Drake | 7f5296e | 2001-07-20 20:06:17 +0000 | [diff] [blame] | 155 | else: |
Brett Cannon | 5f0507d | 2016-04-08 15:04:28 -0700 | [diff] [blame] | 156 | reset = False |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 157 | fullname = os.path.join(sitedir, name) |
| 158 | try: |
Victor Stinner | 4e86d5b | 2011-05-04 13:55:36 +0200 | [diff] [blame] | 159 | f = open(fullname, "r") |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 160 | except OSError: |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 161 | return |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 162 | with f: |
R. David Murray | b4ca59b | 2010-12-26 19:54:29 +0000 | [diff] [blame] | 163 | for n, line in enumerate(f): |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 164 | if line.startswith("#"): |
| 165 | continue |
R. David Murray | b4ca59b | 2010-12-26 19:54:29 +0000 | [diff] [blame] | 166 | try: |
| 167 | if line.startswith(("import ", "import\t")): |
| 168 | exec(line) |
| 169 | continue |
| 170 | line = line.rstrip() |
| 171 | dir, dircase = makepath(sitedir, line) |
| 172 | if not dircase in known_paths and os.path.exists(dir): |
| 173 | sys.path.append(dir) |
| 174 | known_paths.add(dircase) |
Florent Xicluna | 54540ec | 2011-11-04 08:29:17 +0100 | [diff] [blame] | 175 | except Exception: |
R. David Murray | b4ca59b | 2010-12-26 19:54:29 +0000 | [diff] [blame] | 176 | print("Error processing line {:d} of {}:\n".format(n+1, fullname), |
| 177 | file=sys.stderr) |
Victor Stinner | 6553211 | 2012-02-21 22:10:16 +0100 | [diff] [blame] | 178 | import traceback |
R. David Murray | b4ca59b | 2010-12-26 19:54:29 +0000 | [diff] [blame] | 179 | for record in traceback.format_exception(*sys.exc_info()): |
| 180 | for line in record.splitlines(): |
| 181 | print(' '+line, file=sys.stderr) |
| 182 | print("\nRemainder of file ignored", file=sys.stderr) |
| 183 | break |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 184 | if reset: |
| 185 | known_paths = None |
| 186 | return known_paths |
| 187 | |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 188 | |
Brett Cannon | 12f8c4d | 2004-07-09 23:38:18 +0000 | [diff] [blame] | 189 | def addsitedir(sitedir, known_paths=None): |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 190 | """Add 'sitedir' argument to sys.path if missing and handle .pth files in |
| 191 | 'sitedir'""" |
| 192 | if known_paths is None: |
Brett Cannon | 4d0bddf | 2004-07-20 02:28:28 +0000 | [diff] [blame] | 193 | known_paths = _init_pathinfo() |
Brett Cannon | 5f0507d | 2016-04-08 15:04:28 -0700 | [diff] [blame] | 194 | reset = True |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 195 | else: |
Brett Cannon | 5f0507d | 2016-04-08 15:04:28 -0700 | [diff] [blame] | 196 | reset = False |
Fred Drake | 1fb5ce0 | 2001-07-02 16:55:42 +0000 | [diff] [blame] | 197 | sitedir, sitedircase = makepath(sitedir) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 198 | if not sitedircase in known_paths: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 199 | sys.path.append(sitedir) # Add path component |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 200 | known_paths.add(sitedircase) |
Guido van Rossum | f30bec7 | 1997-08-29 22:30:45 +0000 | [diff] [blame] | 201 | try: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 202 | names = os.listdir(sitedir) |
Andrew Svetlov | ad28c7f | 2012-12-18 22:02:39 +0200 | [diff] [blame] | 203 | except OSError: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 204 | return |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 205 | names = [name for name in names if name.endswith(".pth")] |
| 206 | for name in sorted(names): |
| 207 | addpackage(sitedir, name, known_paths) |
Fred Drake | 7f5296e | 2001-07-20 20:06:17 +0000 | [diff] [blame] | 208 | if reset: |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 209 | known_paths = None |
| 210 | return known_paths |
Guido van Rossum | f30bec7 | 1997-08-29 22:30:45 +0000 | [diff] [blame] | 211 | |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 212 | |
| 213 | def check_enableusersite(): |
| 214 | """Check if user site directory is safe for inclusion |
| 215 | |
Alexandre Vassalotti | a79e33e | 2008-05-15 22:51:26 +0000 | [diff] [blame] | 216 | The function tests for the command line flag (including environment var), |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 217 | process uid/gid equal to effective uid/gid. |
| 218 | |
| 219 | None: Disabled for security reasons |
| 220 | False: Disabled by user (command line option) |
| 221 | True: Safe and enabled |
| 222 | """ |
| 223 | if sys.flags.no_user_site: |
| 224 | return False |
| 225 | |
| 226 | if hasattr(os, "getuid") and hasattr(os, "geteuid"): |
| 227 | # check process uid == effective uid |
| 228 | if os.geteuid() != os.getuid(): |
| 229 | return None |
| 230 | if hasattr(os, "getgid") and hasattr(os, "getegid"): |
| 231 | # check process gid == effective gid |
| 232 | if os.getegid() != os.getgid(): |
| 233 | return None |
| 234 | |
| 235 | return True |
| 236 | |
INADA Naoki | a8f8d5b | 2017-06-29 00:31:53 +0900 | [diff] [blame] | 237 | |
| 238 | # NOTE: sysconfig and it's dependencies are relatively large but site module |
| 239 | # needs very limited part of them. |
| 240 | # To speedup startup time, we have copy of them. |
| 241 | # |
| 242 | # See https://bugs.python.org/issue29585 |
| 243 | |
| 244 | # Copy of sysconfig._getuserbase() |
| 245 | def _getuserbase(): |
| 246 | env_base = os.environ.get("PYTHONUSERBASE", None) |
| 247 | if env_base: |
| 248 | return env_base |
| 249 | |
| 250 | def joinuser(*args): |
| 251 | return os.path.expanduser(os.path.join(*args)) |
| 252 | |
| 253 | if os.name == "nt": |
| 254 | base = os.environ.get("APPDATA") or "~" |
| 255 | return joinuser(base, "Python") |
| 256 | |
| 257 | if sys.platform == "darwin" and sys._framework: |
| 258 | return joinuser("~", "Library", sys._framework, |
| 259 | "%d.%d" % sys.version_info[:2]) |
| 260 | |
| 261 | return joinuser("~", ".local") |
| 262 | |
| 263 | |
| 264 | # Same to sysconfig.get_path('purelib', os.name+'_user') |
| 265 | def _get_path(userbase): |
| 266 | version = sys.version_info |
| 267 | |
| 268 | if os.name == 'nt': |
Victor Stinner | b01c574 | 2017-06-28 18:34:42 +0200 | [diff] [blame] | 269 | return f'{userbase}\\Python{version[0]}{version[1]}\\site-packages' |
INADA Naoki | a8f8d5b | 2017-06-29 00:31:53 +0900 | [diff] [blame] | 270 | |
| 271 | if sys.platform == 'darwin' and sys._framework: |
| 272 | return f'{userbase}/lib/python/site-packages' |
| 273 | |
| 274 | return f'{userbase}/lib/python{version[0]}.{version[1]}/site-packages' |
| 275 | |
| 276 | |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 277 | def getuserbase(): |
| 278 | """Returns the `user base` directory path. |
| 279 | |
| 280 | The `user base` directory can be used to store data. If the global |
| 281 | variable ``USER_BASE`` is not initialized yet, this function will also set |
| 282 | it. |
| 283 | """ |
| 284 | global USER_BASE |
INADA Naoki | a8f8d5b | 2017-06-29 00:31:53 +0900 | [diff] [blame] | 285 | if USER_BASE is None: |
| 286 | USER_BASE = _getuserbase() |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 287 | return USER_BASE |
| 288 | |
INADA Naoki | a8f8d5b | 2017-06-29 00:31:53 +0900 | [diff] [blame] | 289 | |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 290 | def getusersitepackages(): |
| 291 | """Returns the user-specific site-packages directory path. |
| 292 | |
| 293 | If the global variable ``USER_SITE`` is not initialized yet, this |
| 294 | function will also set it. |
| 295 | """ |
| 296 | global USER_SITE |
INADA Naoki | a8f8d5b | 2017-06-29 00:31:53 +0900 | [diff] [blame] | 297 | userbase = getuserbase() # this will also set USER_BASE |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 298 | |
INADA Naoki | a8f8d5b | 2017-06-29 00:31:53 +0900 | [diff] [blame] | 299 | if USER_SITE is None: |
| 300 | USER_SITE = _get_path(userbase) |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 301 | |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 302 | return USER_SITE |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 303 | |
| 304 | def addusersitepackages(known_paths): |
| 305 | """Add a per user site-package to sys.path |
| 306 | |
| 307 | Each user has its own python directory with site-packages in the |
| 308 | home directory. |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 309 | """ |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 310 | # get the per user site-package path |
| 311 | # this call will also make sure USER_BASE and USER_SITE are set |
| 312 | user_site = getusersitepackages() |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 313 | |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 314 | if ENABLE_USER_SITE and os.path.isdir(user_site): |
| 315 | addsitedir(user_site, known_paths) |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 316 | return known_paths |
| 317 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 318 | def getsitepackages(prefixes=None): |
Antoine Pitrou | 9e82b17 | 2014-06-12 19:41:30 -0400 | [diff] [blame] | 319 | """Returns a list containing all global site-packages directories. |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 320 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 321 | For each directory present in ``prefixes`` (or the global ``PREFIXES``), |
| 322 | this function will find its `site-packages` subdirectory depending on the |
| 323 | system environment, and will return a list of full paths. |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 324 | """ |
| 325 | sitepackages = [] |
Benjamin Peterson | 3e5cd1d | 2010-06-27 21:45:24 +0000 | [diff] [blame] | 326 | seen = set() |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 327 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 328 | if prefixes is None: |
| 329 | prefixes = PREFIXES |
| 330 | |
| 331 | for prefix in prefixes: |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 332 | if not prefix or prefix in seen: |
| 333 | continue |
Benjamin Peterson | 3e5cd1d | 2010-06-27 21:45:24 +0000 | [diff] [blame] | 334 | seen.add(prefix) |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 335 | |
Christian Heimes | de0b962 | 2012-11-19 00:59:39 +0100 | [diff] [blame] | 336 | if os.sep == '/': |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 337 | sitepackages.append(os.path.join(prefix, "lib", |
Serhiy Storchaka | 885bdc4 | 2016-02-11 13:10:36 +0200 | [diff] [blame] | 338 | "python%d.%d" % sys.version_info[:2], |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 339 | "site-packages")) |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 340 | else: |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 341 | sitepackages.append(prefix) |
| 342 | sitepackages.append(os.path.join(prefix, "lib", "site-packages")) |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 343 | return sitepackages |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 344 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 345 | def addsitepackages(known_paths, prefixes=None): |
Antoine Pitrou | 9e82b17 | 2014-06-12 19:41:30 -0400 | [diff] [blame] | 346 | """Add site-packages to sys.path""" |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 347 | for sitedir in getsitepackages(prefixes): |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 348 | if os.path.isdir(sitedir): |
| 349 | addsitedir(sitedir, known_paths) |
| 350 | |
| 351 | return known_paths |
Fred Drake | 7f5296e | 2001-07-20 20:06:17 +0000 | [diff] [blame] | 352 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 353 | def setquit(): |
Brian Curtin | fb1d3c1 | 2010-04-12 23:33:42 +0000 | [diff] [blame] | 354 | """Define new builtins 'quit' and 'exit'. |
| 355 | |
| 356 | These are objects which make the interpreter exit when called. |
| 357 | The repr of each object contains a hint at how it works. |
Guido van Rossum | d89fa0c | 1998-08-07 18:01:14 +0000 | [diff] [blame] | 358 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 359 | """ |
Ned Deily | c6ef503 | 2016-10-01 21:12:16 -0400 | [diff] [blame] | 360 | if os.sep == '\\': |
Georg Brandl | 24cb053 | 2006-03-09 23:22:06 +0000 | [diff] [blame] | 361 | eof = 'Ctrl-Z plus Return' |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 362 | else: |
Georg Brandl | 24cb053 | 2006-03-09 23:22:06 +0000 | [diff] [blame] | 363 | eof = 'Ctrl-D (i.e. EOF)' |
Tim Peters | 88ca467 | 2006-03-10 23:39:56 +0000 | [diff] [blame] | 364 | |
Antoine Pitrou | 853395b | 2013-08-06 22:56:40 +0200 | [diff] [blame] | 365 | builtins.quit = _sitebuiltins.Quitter('quit', eof) |
| 366 | builtins.exit = _sitebuiltins.Quitter('exit', eof) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 367 | |
| 368 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 369 | def setcopyright(): |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 370 | """Set 'copyright' and 'credits' in builtins""" |
Antoine Pitrou | 853395b | 2013-08-06 22:56:40 +0200 | [diff] [blame] | 371 | builtins.copyright = _sitebuiltins._Printer("copyright", sys.copyright) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 372 | if sys.platform[:4] == 'java': |
Antoine Pitrou | 853395b | 2013-08-06 22:56:40 +0200 | [diff] [blame] | 373 | builtins.credits = _sitebuiltins._Printer( |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 374 | "credits", |
Antoine Pitrou | f93c7b8 | 2013-08-01 19:46:04 +0200 | [diff] [blame] | 375 | "Jython is maintained by the Jython developers (www.jython.org).") |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 376 | else: |
Antoine Pitrou | 853395b | 2013-08-06 22:56:40 +0200 | [diff] [blame] | 377 | builtins.credits = _sitebuiltins._Printer("credits", """\ |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 378 | Thanks to CWI, CNRI, BeOpen.com, Zope Corporation and a cast of thousands |
Antoine Pitrou | f93c7b8 | 2013-08-01 19:46:04 +0200 | [diff] [blame] | 379 | for supporting Python development. See www.python.org for more information.""") |
Martin v. Löwis | c00d39e | 2014-03-30 21:07:25 +0200 | [diff] [blame] | 380 | files, dirs = [], [] |
| 381 | # Not all modules are required to have a __file__ attribute. See |
| 382 | # PEP 420 for more details. |
| 383 | if hasattr(os, '__file__'): |
| 384 | here = os.path.dirname(os.__file__) |
| 385 | files.extend(["LICENSE.txt", "LICENSE"]) |
| 386 | dirs.extend([os.path.join(here, os.pardir), here, os.curdir]) |
Antoine Pitrou | 853395b | 2013-08-06 22:56:40 +0200 | [diff] [blame] | 387 | builtins.license = _sitebuiltins._Printer( |
R David Murray | 692ee9e | 2013-09-14 13:31:44 -0400 | [diff] [blame] | 388 | "license", |
Benjamin Peterson | d40f136 | 2015-02-01 20:17:22 -0500 | [diff] [blame] | 389 | "See https://www.python.org/psf/license/", |
Martin v. Löwis | c00d39e | 2014-03-30 21:07:25 +0200 | [diff] [blame] | 390 | files, dirs) |
Guido van Rossum | d125239 | 2000-09-05 04:39:55 +0000 | [diff] [blame] | 391 | |
| 392 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 393 | def sethelper(): |
Antoine Pitrou | 853395b | 2013-08-06 22:56:40 +0200 | [diff] [blame] | 394 | builtins.help = _sitebuiltins._Helper() |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 395 | |
Antoine Pitrou | 1a6cb30 | 2013-05-04 20:08:35 +0200 | [diff] [blame] | 396 | def enablerlcompleter(): |
| 397 | """Enable default readline configuration on interactive prompts, by |
| 398 | registering a sys.__interactivehook__. |
| 399 | |
| 400 | If the readline module can be imported, the hook will set the Tab key |
| 401 | as completion key and register ~/.python_history as history file. |
Martin Panter | e26da7c | 2016-06-02 10:07:09 +0000 | [diff] [blame] | 402 | This can be overridden in the sitecustomize or usercustomize module, |
Antoine Pitrou | 1a6cb30 | 2013-05-04 20:08:35 +0200 | [diff] [blame] | 403 | or in a PYTHONSTARTUP file. |
| 404 | """ |
| 405 | def register_readline(): |
| 406 | import atexit |
| 407 | try: |
| 408 | import readline |
| 409 | import rlcompleter |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 410 | except ImportError: |
Antoine Pitrou | 1a6cb30 | 2013-05-04 20:08:35 +0200 | [diff] [blame] | 411 | return |
| 412 | |
| 413 | # Reading the initialization (config) file may not be enough to set a |
R David Murray | 4a04301 | 2013-09-06 13:08:08 -0400 | [diff] [blame] | 414 | # completion key, so we set one first and then read the file. |
| 415 | readline_doc = getattr(readline, '__doc__', '') |
| 416 | if readline_doc is not None and 'libedit' in readline_doc: |
Antoine Pitrou | 1a6cb30 | 2013-05-04 20:08:35 +0200 | [diff] [blame] | 417 | readline.parse_and_bind('bind ^I rl_complete') |
| 418 | else: |
| 419 | readline.parse_and_bind('tab: complete') |
Mark Dickinson | 9d35133 | 2013-05-06 15:39:31 +0200 | [diff] [blame] | 420 | |
| 421 | try: |
| 422 | readline.read_init_file() |
| 423 | except OSError: |
| 424 | # An OSError here could have many causes, but the most likely one |
| 425 | # is that there's no .inputrc file (or .editrc file in the case of |
| 426 | # Mac OS X + libedit) in the expected location. In that case, we |
| 427 | # want to ignore the exception. |
| 428 | pass |
Antoine Pitrou | 1a6cb30 | 2013-05-04 20:08:35 +0200 | [diff] [blame] | 429 | |
Jason R. Coombs | 4d91490 | 2014-01-28 09:06:58 -0500 | [diff] [blame] | 430 | if readline.get_current_history_length() == 0: |
Antoine Pitrou | 5d23e6d | 2013-09-29 22:18:38 +0200 | [diff] [blame] | 431 | # If no history was loaded, default to .python_history. |
| 432 | # The guard is necessary to avoid doubling history size at |
| 433 | # each interpreter exit when readline was already configured |
| 434 | # through a PYTHONSTARTUP hook, see: |
| 435 | # http://bugs.python.org/issue5845#msg198636 |
| 436 | history = os.path.join(os.path.expanduser('~'), |
| 437 | '.python_history') |
| 438 | try: |
| 439 | readline.read_history_file(history) |
Serhiy Storchaka | 55fe1ae | 2017-04-16 10:46:38 +0300 | [diff] [blame] | 440 | except OSError: |
Antoine Pitrou | 5d23e6d | 2013-09-29 22:18:38 +0200 | [diff] [blame] | 441 | pass |
Anthony Sottile | b249966 | 2018-08-06 01:28:19 -0700 | [diff] [blame] | 442 | |
| 443 | def write_history(): |
| 444 | try: |
| 445 | readline.write_history_file(history) |
| 446 | except (FileNotFoundError, PermissionError): |
| 447 | # home directory does not exist or is not writable |
| 448 | # https://bugs.python.org/issue19891 |
| 449 | pass |
| 450 | |
| 451 | atexit.register(write_history) |
Antoine Pitrou | 1a6cb30 | 2013-05-04 20:08:35 +0200 | [diff] [blame] | 452 | |
| 453 | sys.__interactivehook__ = register_readline |
| 454 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 455 | def venv(known_paths): |
| 456 | global PREFIXES, ENABLE_USER_SITE |
| 457 | |
| 458 | env = os.environ |
Vinay Sajip | 2895244 | 2012-06-25 00:47:46 +0100 | [diff] [blame] | 459 | if sys.platform == 'darwin' and '__PYVENV_LAUNCHER__' in env: |
Steve Dower | a8474d0 | 2019-02-03 23:19:38 -0800 | [diff] [blame] | 460 | executable = sys._base_executable = os.environ['__PYVENV_LAUNCHER__'] |
| 461 | elif sys.platform == 'win32' and '__PYVENV_LAUNCHER__' in env: |
| 462 | executable = sys.executable |
| 463 | import _winapi |
| 464 | sys._base_executable = _winapi.GetModuleFileName(0) |
| 465 | # bpo-35873: Clear the environment variable to avoid it being |
| 466 | # inherited by child processes. |
| 467 | del os.environ['__PYVENV_LAUNCHER__'] |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 468 | else: |
| 469 | executable = sys.executable |
Vinay Sajip | 27e4b60 | 2012-11-23 19:16:49 +0000 | [diff] [blame] | 470 | exe_dir, _ = os.path.split(os.path.abspath(executable)) |
| 471 | site_prefix = os.path.dirname(exe_dir) |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 472 | sys._home = None |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 473 | conf_basename = 'pyvenv.cfg' |
| 474 | candidate_confs = [ |
| 475 | conffile for conffile in ( |
Vinay Sajip | 27e4b60 | 2012-11-23 19:16:49 +0000 | [diff] [blame] | 476 | os.path.join(exe_dir, conf_basename), |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 477 | os.path.join(site_prefix, conf_basename) |
| 478 | ) |
| 479 | if os.path.isfile(conffile) |
| 480 | ] |
| 481 | |
| 482 | if candidate_confs: |
| 483 | virtual_conf = candidate_confs[0] |
| 484 | system_site = "true" |
Vinay Sajip | f223c53 | 2015-10-01 11:27:00 +0100 | [diff] [blame] | 485 | # Issue 25185: Use UTF-8, as that's what the venv module uses when |
| 486 | # writing the file. |
| 487 | with open(virtual_conf, encoding='utf-8') as f: |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 488 | for line in f: |
Serhiy Storchaka | 727ba7c | 2016-11-08 20:17:35 +0200 | [diff] [blame] | 489 | if '=' in line: |
| 490 | key, _, value = line.partition('=') |
| 491 | key = key.strip().lower() |
| 492 | value = value.strip() |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 493 | if key == 'include-system-site-packages': |
| 494 | system_site = value.lower() |
| 495 | elif key == 'home': |
| 496 | sys._home = value |
| 497 | |
| 498 | sys.prefix = sys.exec_prefix = site_prefix |
| 499 | |
| 500 | # Doing this here ensures venv takes precedence over user-site |
| 501 | addsitepackages(known_paths, [sys.prefix]) |
| 502 | |
| 503 | # addsitepackages will process site_prefix again if its in PREFIXES, |
| 504 | # but that's ok; known_paths will prevent anything being added twice |
| 505 | if system_site == "true": |
| 506 | PREFIXES.insert(0, sys.prefix) |
| 507 | else: |
| 508 | PREFIXES = [sys.prefix] |
| 509 | ENABLE_USER_SITE = False |
| 510 | |
| 511 | return known_paths |
| 512 | |
| 513 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 514 | def execsitecustomize(): |
| 515 | """Run custom site specific code, if available.""" |
| 516 | try: |
Victor Stinner | e3560a7 | 2016-01-22 12:22:07 +0100 | [diff] [blame] | 517 | try: |
| 518 | import sitecustomize |
| 519 | except ImportError as exc: |
| 520 | if exc.name == 'sitecustomize': |
| 521 | pass |
| 522 | else: |
| 523 | raise |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 524 | except Exception as err: |
Steve Dower | 313523c | 2016-09-17 12:22:41 -0700 | [diff] [blame] | 525 | if sys.flags.verbose: |
Victor Stinner | 52f6dd7 | 2010-03-12 14:45:56 +0000 | [diff] [blame] | 526 | sys.excepthook(*sys.exc_info()) |
| 527 | else: |
| 528 | sys.stderr.write( |
| 529 | "Error in sitecustomize; set PYTHONVERBOSE for traceback:\n" |
| 530 | "%s: %s\n" % |
| 531 | (err.__class__.__name__, err)) |
Martin v. Löwis | 4eab486 | 2003-03-03 09:34:01 +0000 | [diff] [blame] | 532 | |
Martin v. Löwis | 4eab486 | 2003-03-03 09:34:01 +0000 | [diff] [blame] | 533 | |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 534 | def execusercustomize(): |
| 535 | """Run custom user specific code, if available.""" |
| 536 | try: |
Victor Stinner | e3560a7 | 2016-01-22 12:22:07 +0100 | [diff] [blame] | 537 | try: |
| 538 | import usercustomize |
| 539 | except ImportError as exc: |
| 540 | if exc.name == 'usercustomize': |
| 541 | pass |
| 542 | else: |
| 543 | raise |
Victor Stinner | 52f6dd7 | 2010-03-12 14:45:56 +0000 | [diff] [blame] | 544 | except Exception as err: |
Steve Dower | 313523c | 2016-09-17 12:22:41 -0700 | [diff] [blame] | 545 | if sys.flags.verbose: |
Victor Stinner | 52f6dd7 | 2010-03-12 14:45:56 +0000 | [diff] [blame] | 546 | sys.excepthook(*sys.exc_info()) |
| 547 | else: |
| 548 | sys.stderr.write( |
| 549 | "Error in usercustomize; set PYTHONVERBOSE for traceback:\n" |
| 550 | "%s: %s\n" % |
| 551 | (err.__class__.__name__, err)) |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 552 | |
| 553 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 554 | def main(): |
Éric Araujo | c09fca6 | 2011-03-23 02:06:24 +0100 | [diff] [blame] | 555 | """Add standard site-specific directories to the module search path. |
| 556 | |
| 557 | This function is called automatically when this module is imported, |
| 558 | unless the python interpreter was started with the -S flag. |
| 559 | """ |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 560 | global ENABLE_USER_SITE |
| 561 | |
INADA Naoki | 2e4e011 | 2017-03-15 00:52:19 +0900 | [diff] [blame] | 562 | orig_path = sys.path[:] |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 563 | known_paths = removeduppaths() |
INADA Naoki | 2e4e011 | 2017-03-15 00:52:19 +0900 | [diff] [blame] | 564 | if orig_path != sys.path: |
| 565 | # removeduppaths() might make sys.path absolute. |
| 566 | # fix __file__ and __cached__ of already imported modules too. |
| 567 | abs_paths() |
| 568 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 569 | known_paths = venv(known_paths) |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 570 | if ENABLE_USER_SITE is None: |
| 571 | ENABLE_USER_SITE = check_enableusersite() |
| 572 | known_paths = addusersitepackages(known_paths) |
| 573 | known_paths = addsitepackages(known_paths) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 574 | setquit() |
| 575 | setcopyright() |
| 576 | sethelper() |
Steve Dower | 313523c | 2016-09-17 12:22:41 -0700 | [diff] [blame] | 577 | if not sys.flags.isolated: |
| 578 | enablerlcompleter() |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 579 | execsitecustomize() |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 580 | if ENABLE_USER_SITE: |
| 581 | execusercustomize() |
Marc-André Lemburg | 990bbe9 | 2000-06-07 09:12:09 +0000 | [diff] [blame] | 582 | |
Steve Dower | 313523c | 2016-09-17 12:22:41 -0700 | [diff] [blame] | 583 | # Prevent extending of sys.path when python was started with -S and |
Éric Araujo | c09fca6 | 2011-03-23 02:06:24 +0100 | [diff] [blame] | 584 | # site is imported later. |
| 585 | if not sys.flags.no_site: |
| 586 | main() |
Guido van Rossum | f30bec7 | 1997-08-29 22:30:45 +0000 | [diff] [blame] | 587 | |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 588 | def _script(): |
| 589 | help = """\ |
| 590 | %s [--user-base] [--user-site] |
| 591 | |
| 592 | Without arguments print some useful information |
| 593 | With arguments print the value of USER_BASE and/or USER_SITE separated |
| 594 | by '%s'. |
| 595 | |
| 596 | Exit codes with --user-base or --user-site: |
| 597 | 0 - user site directory is enabled |
Alexandre Vassalotti | 6461e10 | 2008-05-15 22:09:29 +0000 | [diff] [blame] | 598 | 1 - user site directory is disabled by user |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 599 | 2 - uses site directory is disabled by super user |
| 600 | or for security reasons |
| 601 | >2 - unknown error |
| 602 | """ |
| 603 | args = sys.argv[1:] |
| 604 | if not args: |
Meador Inge | 9a7a811 | 2013-04-13 20:29:49 -0500 | [diff] [blame] | 605 | user_base = getuserbase() |
| 606 | user_site = getusersitepackages() |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 607 | print("sys.path = [") |
| 608 | for dir in sys.path: |
| 609 | print(" %r," % (dir,)) |
| 610 | print("]") |
Meador Inge | 9a7a811 | 2013-04-13 20:29:49 -0500 | [diff] [blame] | 611 | print("USER_BASE: %r (%s)" % (user_base, |
| 612 | "exists" if os.path.isdir(user_base) else "doesn't exist")) |
| 613 | print("USER_SITE: %r (%s)" % (user_site, |
| 614 | "exists" if os.path.isdir(user_site) else "doesn't exist")) |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 615 | print("ENABLE_USER_SITE: %r" % ENABLE_USER_SITE) |
| 616 | sys.exit(0) |
| 617 | |
| 618 | buffer = [] |
| 619 | if '--user-base' in args: |
| 620 | buffer.append(USER_BASE) |
| 621 | if '--user-site' in args: |
| 622 | buffer.append(USER_SITE) |
| 623 | |
| 624 | if buffer: |
| 625 | print(os.pathsep.join(buffer)) |
| 626 | if ENABLE_USER_SITE: |
| 627 | sys.exit(0) |
| 628 | elif ENABLE_USER_SITE is False: |
| 629 | sys.exit(1) |
| 630 | elif ENABLE_USER_SITE is None: |
| 631 | sys.exit(2) |
| 632 | else: |
| 633 | sys.exit(3) |
| 634 | else: |
| 635 | import textwrap |
| 636 | print(textwrap.dedent(help % (sys.argv[0], os.pathsep))) |
| 637 | sys.exit(10) |
Guido van Rossum | f30bec7 | 1997-08-29 22:30:45 +0000 | [diff] [blame] | 638 | |
| 639 | if __name__ == '__main__': |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 640 | _script() |