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