Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.11/site-packages/IPython/paths.py: 23%

1"""Find files and directories which IPython uses. 

2""" 

3import os.path 

4import tempfile 

5from warnings import warn 

6 

7import IPython 

8from IPython.utils.importstring import import_item 

9from IPython.utils.path import ( 

10 get_home_dir, 

11 get_xdg_dir, 

12 get_xdg_cache_dir, 

13 compress_user, 

14 _writable_dir, 

15 ensure_dir_exists, 

16) 

17 

18 

19def get_ipython_dir() -> str: 

20 """Get the IPython directory for this platform and user. 

21 

22 This uses the logic in `get_home_dir` to find the home directory 

23 and then adds .ipython to the end of the path. 

24 """ 

25 

26 env = os.environ 

27 pjoin = os.path.join 

28 

29 

30 ipdir_def = '.ipython' 

31 

32 home_dir = get_home_dir() 

33 xdg_dir = get_xdg_dir() 

34 

35 ipdir = env.get("IPYTHONDIR", None) 

36 if ipdir is None: 

37 # not set explicitly, use ~/.ipython 

38 ipdir = pjoin(home_dir, ipdir_def) 

39 if xdg_dir: 

40 # Several IPython versions (up to 1.x) defaulted to .config/ipython 

41 # on Linux. We have decided to go back to using .ipython everywhere 

42 xdg_ipdir = pjoin(xdg_dir, 'ipython') 

43 

44 if _writable_dir(xdg_ipdir): 

45 cu = compress_user 

46 if os.path.exists(ipdir): 

47 warn(('Ignoring {0} in favour of {1}. Remove {0} to ' 

48 'get rid of this message').format(cu(xdg_ipdir), cu(ipdir))) 

49 elif os.path.islink(xdg_ipdir): 

50 warn(('{0} is deprecated. Move link to {1} to ' 

51 'get rid of this message').format(cu(xdg_ipdir), cu(ipdir))) 

52 else: 

53 ipdir = xdg_ipdir 

54 

55 ipdir = os.path.normpath(os.path.expanduser(ipdir)) 

56 

57 if os.path.exists(ipdir) and not _writable_dir(ipdir): 

58 # ipdir exists, but is not writable 

59 warn("IPython dir '{0}' is not a writable location," 

60 " using a temp directory.".format(ipdir)) 

61 ipdir = tempfile.mkdtemp() 

62 elif not os.path.exists(ipdir): 

63 parent = os.path.dirname(ipdir) 

64 if not _writable_dir(parent): 

65 # ipdir does not exist and parent isn't writable 

66 warn("IPython parent '{0}' is not a writable location," 

67 " using a temp directory.".format(parent)) 

68 ipdir = tempfile.mkdtemp() 

69 else: 

70 os.makedirs(ipdir, exist_ok=True) 

71 assert isinstance(ipdir, str), "all path manipulation should be str(unicode), but are not." 

72 return ipdir 

73 

74 

75def get_ipython_cache_dir() -> str: 

76 """Get the cache directory it is created if it does not exist.""" 

77 xdgdir = get_xdg_cache_dir() 

78 if xdgdir is None: 

79 return get_ipython_dir() 

80 ipdir = os.path.join(xdgdir, "ipython") 

81 if not os.path.exists(ipdir) and _writable_dir(xdgdir): 

82 ensure_dir_exists(ipdir) 

83 elif not _writable_dir(xdgdir): 

84 return get_ipython_dir() 

85 

86 return ipdir 

87 

88 

89def get_ipython_package_dir() -> str: 

90 """Get the base directory where IPython itself is installed.""" 

91 ipdir = os.path.dirname(IPython.__file__) 

92 assert isinstance(ipdir, str) 

93 return ipdir 

94 

95 

96def get_ipython_module_path(module_str): 

97 """Find the path to an IPython module in this version of IPython. 

98 

99 This will always find the version of the module that is in this importable 

100 IPython package. This will always return the path to the ``.py`` 

101 version of the module. 

102 """ 

103 if module_str == 'IPython': 

104 return os.path.join(get_ipython_package_dir(), '__init__.py') 

105 mod = import_item(module_str) 

106 the_path = mod.__file__.replace('.pyc', '.py') 

107 the_path = the_path.replace('.pyo', '.py') 

108 return the_path 

109 

110 

111def locate_profile(profile='default'): 

112 """Find the path to the folder associated with a given profile. 

113 

114 I.e. find $IPYTHONDIR/profile_whatever. 

115 """ 

116 from IPython.core.profiledir import ProfileDir, ProfileDirError 

117 try: 

118 pd = ProfileDir.find_profile_dir_by_name(get_ipython_dir(), profile) 

119 except ProfileDirError as e: 

120 # IOError makes more sense when people are expecting a path 

121 raise IOError("Couldn't find profile %r" % profile) from e 

122 return pd.location