##// END OF EJS Templates
Merge pull request #13336 from meeseeksmachine/auto-backport-of-pr-13334-on-7.x...
Matthias Bussonnier -
r27170:696d7c56 merge
parent child Browse files
Show More
@@ -1,121 +1,121 b''
1 1 """Find files and directories which IPython uses.
2 2 """
3 3 import os.path
4 4 import shutil
5 5 import tempfile
6 6 from warnings import warn
7 7
8 8 import IPython
9 9 from IPython.utils.importstring import import_item
10 10 from IPython.utils.path import (
11 11 get_home_dir, get_xdg_dir, get_xdg_cache_dir, compress_user, _writable_dir,
12 12 ensure_dir_exists, fs_encoding)
13 13 from IPython.utils import py3compat
14 14
15 15 def get_ipython_dir() -> str:
16 16 """Get the IPython directory for this platform and user.
17 17
18 18 This uses the logic in `get_home_dir` to find the home directory
19 19 and then adds .ipython to the end of the path.
20 20 """
21 21
22 22 env = os.environ
23 23 pjoin = os.path.join
24 24
25 25
26 26 ipdir_def = '.ipython'
27 27
28 28 home_dir = get_home_dir()
29 29 xdg_dir = get_xdg_dir()
30 30
31 31 if 'IPYTHON_DIR' in env:
32 32 warn('The environment variable IPYTHON_DIR is deprecated since IPython 3.0. '
33 33 'Please use IPYTHONDIR instead.', DeprecationWarning)
34 34 ipdir = env.get('IPYTHONDIR', env.get('IPYTHON_DIR', None))
35 35 if ipdir is None:
36 36 # not set explicitly, use ~/.ipython
37 37 ipdir = pjoin(home_dir, ipdir_def)
38 38 if xdg_dir:
39 39 # Several IPython versions (up to 1.x) defaulted to .config/ipython
40 40 # on Linux. We have decided to go back to using .ipython everywhere
41 41 xdg_ipdir = pjoin(xdg_dir, 'ipython')
42 42
43 43 if _writable_dir(xdg_ipdir):
44 44 cu = compress_user
45 45 if os.path.exists(ipdir):
46 46 warn(('Ignoring {0} in favour of {1}. Remove {0} to '
47 47 'get rid of this message').format(cu(xdg_ipdir), cu(ipdir)))
48 48 elif os.path.islink(xdg_ipdir):
49 49 warn(('{0} is deprecated. Move link to {1} to '
50 50 'get rid of this message').format(cu(xdg_ipdir), cu(ipdir)))
51 51 else:
52 52 warn('Moving {0} to {1}'.format(cu(xdg_ipdir), cu(ipdir)))
53 53 shutil.move(xdg_ipdir, ipdir)
54 54
55 55 ipdir = os.path.normpath(os.path.expanduser(ipdir))
56 56
57 57 if os.path.exists(ipdir) and not _writable_dir(ipdir):
58 58 # ipdir exists, but is not writable
59 59 warn("IPython dir '{0}' is not a writable location,"
60 60 " using a temp directory.".format(ipdir))
61 61 ipdir = tempfile.mkdtemp()
62 62 elif not os.path.exists(ipdir):
63 63 parent = os.path.dirname(ipdir)
64 64 if not _writable_dir(parent):
65 65 # ipdir does not exist and parent isn't writable
66 66 warn("IPython parent '{0}' is not a writable location,"
67 67 " using a temp directory.".format(parent))
68 68 ipdir = tempfile.mkdtemp()
69 69 else:
70 os.makedirs(ipdir)
70 os.makedirs(ipdir, exist_ok=True)
71 71 assert isinstance(ipdir, str), "all path manipulation should be str(unicode), but are not."
72 72 return ipdir
73 73
74 74
75 75 def get_ipython_cache_dir() -> str:
76 76 """Get the cache directory it is created if it does not exist."""
77 77 xdgdir = get_xdg_cache_dir()
78 78 if xdgdir is None:
79 79 return get_ipython_dir()
80 80 ipdir = os.path.join(xdgdir, "ipython")
81 81 if not os.path.exists(ipdir) and _writable_dir(xdgdir):
82 82 ensure_dir_exists(ipdir)
83 83 elif not _writable_dir(xdgdir):
84 84 return get_ipython_dir()
85 85
86 86 return ipdir
87 87
88 88
89 89 def get_ipython_package_dir() -> str:
90 90 """Get the base directory where IPython itself is installed."""
91 91 ipdir = os.path.dirname(IPython.__file__)
92 92 assert isinstance(ipdir, str)
93 93 return ipdir
94 94
95 95
96 96 def get_ipython_module_path(module_str):
97 97 """Find the path to an IPython module in this version of IPython.
98 98
99 99 This will always find the version of the module that is in this importable
100 100 IPython package. This will always return the path to the ``.py``
101 101 version of the module.
102 102 """
103 103 if module_str == 'IPython':
104 104 return os.path.join(get_ipython_package_dir(), '__init__.py')
105 105 mod = import_item(module_str)
106 106 the_path = mod.__file__.replace('.pyc', '.py')
107 107 the_path = the_path.replace('.pyo', '.py')
108 108 return py3compat.cast_unicode(the_path, fs_encoding)
109 109
110 110 def locate_profile(profile='default'):
111 111 """Find the path to the folder associated with a given profile.
112 112
113 113 I.e. find $IPYTHONDIR/profile_whatever.
114 114 """
115 115 from IPython.core.profiledir import ProfileDir, ProfileDirError
116 116 try:
117 117 pd = ProfileDir.find_profile_dir_by_name(get_ipython_dir(), profile)
118 118 except ProfileDirError:
119 119 # IOError makes more sense when people are expecting a path
120 120 raise IOError("Couldn't find profile %r" % profile)
121 121 return pd.location
General Comments 0
You need to be logged in to leave comments. Login now