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