##// END OF EJS Templates
Fix for #875 Unicode Encoding Error
paul -
Show More
@@ -1,464 +1,464 b''
1 1 # encoding: utf-8
2 2 """
3 3 Utilities for path handling.
4 4 """
5 5
6 6 #-----------------------------------------------------------------------------
7 7 # Copyright (C) 2008-2011 The IPython Development Team
8 8 #
9 9 # Distributed under the terms of the BSD License. The full license is in
10 10 # the file COPYING, distributed as part of this software.
11 11 #-----------------------------------------------------------------------------
12 12
13 13 #-----------------------------------------------------------------------------
14 14 # Imports
15 15 #-----------------------------------------------------------------------------
16 16
17 17 import os
18 18 import sys
19 19 import tempfile
20 20 import warnings
21 21 from hashlib import md5
22 22
23 23 import IPython
24 24 from IPython.utils.process import system
25 25 from IPython.utils.importstring import import_item
26 26 from IPython.utils import py3compat
27 27
28 28 #-----------------------------------------------------------------------------
29 29 # Code
30 30 #-----------------------------------------------------------------------------
31 31
32 32 fs_encoding = sys.getfilesystemencoding()
33 33
34 34 def _get_long_path_name(path):
35 35 """Dummy no-op."""
36 36 return path
37 37
38 38 def _writable_dir(path):
39 39 """Whether `path` is a directory, to which the user has write access."""
40 40 return os.path.isdir(path) and os.access(path, os.W_OK)
41 41
42 42 if sys.platform == 'win32':
43 43 def _get_long_path_name(path):
44 44 """Get a long path name (expand ~) on Windows using ctypes.
45 45
46 46 Examples
47 47 --------
48 48
49 49 >>> get_long_path_name('c:\\docume~1')
50 50 u'c:\\\\Documents and Settings'
51 51
52 52 """
53 53 try:
54 54 import ctypes
55 55 except ImportError:
56 56 raise ImportError('you need to have ctypes installed for this to work')
57 57 _GetLongPathName = ctypes.windll.kernel32.GetLongPathNameW
58 58 _GetLongPathName.argtypes = [ctypes.c_wchar_p, ctypes.c_wchar_p,
59 59 ctypes.c_uint ]
60 60
61 61 buf = ctypes.create_unicode_buffer(260)
62 62 rv = _GetLongPathName(path, buf, 260)
63 63 if rv == 0 or rv > 260:
64 64 return path
65 65 else:
66 66 return buf.value
67 67
68 68
69 69 def get_long_path_name(path):
70 70 """Expand a path into its long form.
71 71
72 72 On Windows this expands any ~ in the paths. On other platforms, it is
73 73 a null operation.
74 74 """
75 75 return _get_long_path_name(path)
76 76
77 77
78 78 def unquote_filename(name, win32=(sys.platform=='win32')):
79 79 """ On Windows, remove leading and trailing quotes from filenames.
80 80 """
81 81 if win32:
82 82 if name.startswith(("'", '"')) and name.endswith(("'", '"')):
83 83 name = name[1:-1]
84 84 return name
85 85
86 86
87 87 def get_py_filename(name, force_win32=None):
88 88 """Return a valid python filename in the current directory.
89 89
90 90 If the given name is not a file, it adds '.py' and searches again.
91 91 Raises IOError with an informative message if the file isn't found.
92 92
93 93 On Windows, apply Windows semantics to the filename. In particular, remove
94 94 any quoting that has been applied to it. This option can be forced for
95 95 testing purposes.
96 96 """
97 97
98 98 name = os.path.expanduser(name)
99 99 if force_win32 is None:
100 100 win32 = (sys.platform == 'win32')
101 101 else:
102 102 win32 = force_win32
103 103 name = unquote_filename(name, win32=win32)
104 104 if not os.path.isfile(name) and not name.endswith('.py'):
105 105 name += '.py'
106 106 if os.path.isfile(name):
107 107 return name
108 108 else:
109 raise IOError,'File `%s` not found.' % name
109 raise IOError,'File `%r` not found.' % name
110 110
111 111
112 112 def filefind(filename, path_dirs=None):
113 113 """Find a file by looking through a sequence of paths.
114 114
115 115 This iterates through a sequence of paths looking for a file and returns
116 116 the full, absolute path of the first occurence of the file. If no set of
117 117 path dirs is given, the filename is tested as is, after running through
118 118 :func:`expandvars` and :func:`expanduser`. Thus a simple call::
119 119
120 120 filefind('myfile.txt')
121 121
122 122 will find the file in the current working dir, but::
123 123
124 124 filefind('~/myfile.txt')
125 125
126 126 Will find the file in the users home directory. This function does not
127 127 automatically try any paths, such as the cwd or the user's home directory.
128 128
129 129 Parameters
130 130 ----------
131 131 filename : str
132 132 The filename to look for.
133 133 path_dirs : str, None or sequence of str
134 134 The sequence of paths to look for the file in. If None, the filename
135 135 need to be absolute or be in the cwd. If a string, the string is
136 136 put into a sequence and the searched. If a sequence, walk through
137 137 each element and join with ``filename``, calling :func:`expandvars`
138 138 and :func:`expanduser` before testing for existence.
139 139
140 140 Returns
141 141 -------
142 142 Raises :exc:`IOError` or returns absolute path to file.
143 143 """
144 144
145 145 # If paths are quoted, abspath gets confused, strip them...
146 146 filename = filename.strip('"').strip("'")
147 147 # If the input is an absolute path, just check it exists
148 148 if os.path.isabs(filename) and os.path.isfile(filename):
149 149 return filename
150 150
151 151 if path_dirs is None:
152 152 path_dirs = ("",)
153 153 elif isinstance(path_dirs, basestring):
154 154 path_dirs = (path_dirs,)
155 155
156 156 for path in path_dirs:
157 157 if path == '.': path = os.getcwdu()
158 158 testname = expand_path(os.path.join(path, filename))
159 159 if os.path.isfile(testname):
160 160 return os.path.abspath(testname)
161 161
162 162 raise IOError("File %r does not exist in any of the search paths: %r" %
163 163 (filename, path_dirs) )
164 164
165 165
166 166 class HomeDirError(Exception):
167 167 pass
168 168
169 169
170 170 def get_home_dir(require_writable=False):
171 171 """Return the 'home' directory, as a unicode string.
172 172
173 173 * First, check for frozen env in case of py2exe
174 174 * Otherwise, defer to os.path.expanduser('~')
175 175
176 176 See stdlib docs for how this is determined.
177 177 $HOME is first priority on *ALL* platforms.
178 178
179 179 Parameters
180 180 ----------
181 181
182 182 require_writable : bool [default: False]
183 183 if True:
184 184 guarantees the return value is a writable directory, otherwise
185 185 raises HomeDirError
186 186 if False:
187 187 The path is resolved, but it is not guaranteed to exist or be writable.
188 188 """
189 189
190 190 # first, check py2exe distribution root directory for _ipython.
191 191 # This overrides all. Normally does not exist.
192 192
193 193 if hasattr(sys, "frozen"): #Is frozen by py2exe
194 194 if '\\library.zip\\' in IPython.__file__.lower():#libraries compressed to zip-file
195 195 root, rest = IPython.__file__.lower().split('library.zip')
196 196 else:
197 197 root=os.path.join(os.path.split(IPython.__file__)[0],"../../")
198 198 root=os.path.abspath(root).rstrip('\\')
199 199 if _writable_dir(os.path.join(root, '_ipython')):
200 200 os.environ["IPYKITROOT"] = root
201 201 return py3compat.cast_unicode(root, fs_encoding)
202 202
203 203 homedir = os.path.expanduser('~')
204 204 # Next line will make things work even when /home/ is a symlink to
205 205 # /usr/home as it is on FreeBSD, for example
206 206 homedir = os.path.realpath(homedir)
207 207
208 208 if not _writable_dir(homedir) and os.name == 'nt':
209 209 # expanduser failed, use the registry to get the 'My Documents' folder.
210 210 try:
211 211 import _winreg as wreg
212 212 key = wreg.OpenKey(
213 213 wreg.HKEY_CURRENT_USER,
214 214 "Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders"
215 215 )
216 216 homedir = wreg.QueryValueEx(key,'Personal')[0]
217 217 key.Close()
218 218 except:
219 219 pass
220 220
221 221 if (not require_writable) or _writable_dir(homedir):
222 222 return py3compat.cast_unicode(homedir, fs_encoding)
223 223 else:
224 224 raise HomeDirError('%s is not a writable dir, '
225 225 'set $HOME environment variable to override' % homedir)
226 226
227 227 def get_xdg_dir():
228 228 """Return the XDG_CONFIG_HOME, if it is defined and exists, else None.
229 229
230 230 This is only for posix (Linux,Unix,OS X, etc) systems.
231 231 """
232 232
233 233 env = os.environ
234 234
235 235 if os.name == 'posix':
236 236 # Linux, Unix, AIX, OS X
237 237 # use ~/.config if empty OR not set
238 238 xdg = env.get("XDG_CONFIG_HOME", None) or os.path.join(get_home_dir(), '.config')
239 239 if xdg and _writable_dir(xdg):
240 240 return py3compat.cast_unicode(xdg, fs_encoding)
241 241
242 242 return None
243 243
244 244
245 245 def get_ipython_dir():
246 246 """Get the IPython directory for this platform and user.
247 247
248 248 This uses the logic in `get_home_dir` to find the home directory
249 249 and then adds .ipython to the end of the path.
250 250 """
251 251
252 252 env = os.environ
253 253 pjoin = os.path.join
254 254
255 255
256 256 ipdir_def = '.ipython'
257 257 xdg_def = 'ipython'
258 258
259 259 home_dir = get_home_dir()
260 260 xdg_dir = get_xdg_dir()
261 261
262 262 # import pdb; pdb.set_trace() # dbg
263 263 ipdir = env.get('IPYTHON_DIR', env.get('IPYTHONDIR', None))
264 264 if ipdir is None:
265 265 # not set explicitly, use XDG_CONFIG_HOME or HOME
266 266 home_ipdir = pjoin(home_dir, ipdir_def)
267 267 if xdg_dir:
268 268 # use XDG, as long as the user isn't already
269 269 # using $HOME/.ipython and *not* XDG/ipython
270 270
271 271 xdg_ipdir = pjoin(xdg_dir, xdg_def)
272 272
273 273 if _writable_dir(xdg_ipdir) or not _writable_dir(home_ipdir):
274 274 ipdir = xdg_ipdir
275 275
276 276 if ipdir is None:
277 277 # not using XDG
278 278 ipdir = home_ipdir
279 279
280 280 ipdir = os.path.normpath(os.path.expanduser(ipdir))
281 281
282 282 if os.path.exists(ipdir) and not _writable_dir(ipdir):
283 283 # ipdir exists, but is not writable
284 284 warnings.warn("IPython dir '%s' is not a writable location,"
285 285 " using a temp directory."%ipdir)
286 286 ipdir = tempfile.mkdtemp()
287 287 elif not os.path.exists(ipdir):
288 288 parent = ipdir.rsplit(os.path.sep, 1)[0]
289 289 if not _writable_dir(parent):
290 290 # ipdir does not exist and parent isn't writable
291 291 warnings.warn("IPython parent '%s' is not a writable location,"
292 292 " using a temp directory."%parent)
293 293 ipdir = tempfile.mkdtemp()
294 294
295 295 return py3compat.cast_unicode(ipdir, fs_encoding)
296 296
297 297
298 298 def get_ipython_package_dir():
299 299 """Get the base directory where IPython itself is installed."""
300 300 ipdir = os.path.dirname(IPython.__file__)
301 301 return py3compat.cast_unicode(ipdir, fs_encoding)
302 302
303 303
304 304 def get_ipython_module_path(module_str):
305 305 """Find the path to an IPython module in this version of IPython.
306 306
307 307 This will always find the version of the module that is in this importable
308 308 IPython package. This will always return the path to the ``.py``
309 309 version of the module.
310 310 """
311 311 if module_str == 'IPython':
312 312 return os.path.join(get_ipython_package_dir(), '__init__.py')
313 313 mod = import_item(module_str)
314 314 the_path = mod.__file__.replace('.pyc', '.py')
315 315 the_path = the_path.replace('.pyo', '.py')
316 316 return py3compat.cast_unicode(the_path, fs_encoding)
317 317
318 318 def locate_profile(profile='default'):
319 319 """Find the path to the folder associated with a given profile.
320 320
321 321 I.e. find $IPYTHON_DIR/profile_whatever.
322 322 """
323 323 from IPython.core.profiledir import ProfileDir, ProfileDirError
324 324 try:
325 325 pd = ProfileDir.find_profile_dir_by_name(get_ipython_dir(), profile)
326 326 except ProfileDirError:
327 327 # IOError makes more sense when people are expecting a path
328 328 raise IOError("Couldn't find profile %r" % profile)
329 329 return pd.location
330 330
331 331 def expand_path(s):
332 332 """Expand $VARS and ~names in a string, like a shell
333 333
334 334 :Examples:
335 335
336 336 In [2]: os.environ['FOO']='test'
337 337
338 338 In [3]: expand_path('variable FOO is $FOO')
339 339 Out[3]: 'variable FOO is test'
340 340 """
341 341 # This is a pretty subtle hack. When expand user is given a UNC path
342 342 # on Windows (\\server\share$\%username%), os.path.expandvars, removes
343 343 # the $ to get (\\server\share\%username%). I think it considered $
344 344 # alone an empty var. But, we need the $ to remains there (it indicates
345 345 # a hidden share).
346 346 if os.name=='nt':
347 347 s = s.replace('$\\', 'IPYTHON_TEMP')
348 348 s = os.path.expandvars(os.path.expanduser(s))
349 349 if os.name=='nt':
350 350 s = s.replace('IPYTHON_TEMP', '$\\')
351 351 return s
352 352
353 353
354 354 def target_outdated(target,deps):
355 355 """Determine whether a target is out of date.
356 356
357 357 target_outdated(target,deps) -> 1/0
358 358
359 359 deps: list of filenames which MUST exist.
360 360 target: single filename which may or may not exist.
361 361
362 362 If target doesn't exist or is older than any file listed in deps, return
363 363 true, otherwise return false.
364 364 """
365 365 try:
366 366 target_time = os.path.getmtime(target)
367 367 except os.error:
368 368 return 1
369 369 for dep in deps:
370 370 dep_time = os.path.getmtime(dep)
371 371 if dep_time > target_time:
372 372 #print "For target",target,"Dep failed:",dep # dbg
373 373 #print "times (dep,tar):",dep_time,target_time # dbg
374 374 return 1
375 375 return 0
376 376
377 377
378 378 def target_update(target,deps,cmd):
379 379 """Update a target with a given command given a list of dependencies.
380 380
381 381 target_update(target,deps,cmd) -> runs cmd if target is outdated.
382 382
383 383 This is just a wrapper around target_outdated() which calls the given
384 384 command if target is outdated."""
385 385
386 386 if target_outdated(target,deps):
387 387 system(cmd)
388 388
389 389 def filehash(path):
390 390 """Make an MD5 hash of a file, ignoring any differences in line
391 391 ending characters."""
392 392 with open(path, "rU") as f:
393 393 return md5(py3compat.str_to_bytes(f.read())).hexdigest()
394 394
395 395 # If the config is unmodified from the default, we'll just delete it.
396 396 # These are consistent for 0.10.x, thankfully. We're not going to worry about
397 397 # older versions.
398 398 old_config_md5 = {'ipy_user_conf.py': 'fc108bedff4b9a00f91fa0a5999140d3',
399 399 'ipythonrc': '12a68954f3403eea2eec09dc8fe5a9b5'}
400 400
401 401 def check_for_old_config(ipython_dir=None):
402 402 """Check for old config files, and present a warning if they exist.
403 403
404 404 A link to the docs of the new config is included in the message.
405 405
406 406 This should mitigate confusion with the transition to the new
407 407 config system in 0.11.
408 408 """
409 409 if ipython_dir is None:
410 410 ipython_dir = get_ipython_dir()
411 411
412 412 old_configs = ['ipy_user_conf.py', 'ipythonrc', 'ipython_config.py']
413 413 warned = False
414 414 for cfg in old_configs:
415 415 f = os.path.join(ipython_dir, cfg)
416 416 if os.path.exists(f):
417 417 if filehash(f) == old_config_md5.get(cfg, ''):
418 418 os.unlink(f)
419 419 else:
420 420 warnings.warn("Found old IPython config file %r (modified by user)"%f)
421 421 warned = True
422 422
423 423 if warned:
424 424 warnings.warn("""
425 425 The IPython configuration system has changed as of 0.11, and these files will
426 426 be ignored. See http://ipython.github.com/ipython-doc/dev/config for details
427 427 of the new config system.
428 428 To start configuring IPython, do `ipython profile create`, and edit
429 429 `ipython_config.py` in <ipython_dir>/profile_default.
430 430 If you need to leave the old config files in place for an older version of
431 431 IPython and want to suppress this warning message, set
432 432 `c.InteractiveShellApp.ignore_old_config=True` in the new config.""")
433 433
434 434 def get_security_file(filename, profile='default'):
435 435 """Return the absolute path of a security file given by filename and profile
436 436
437 437 This allows users and developers to find security files without
438 438 knowledge of the IPython directory structure. The search path
439 439 will be ['.', profile.security_dir]
440 440
441 441 Parameters
442 442 ----------
443 443
444 444 filename : str
445 445 The file to be found. If it is passed as an absolute path, it will
446 446 simply be returned.
447 447 profile : str [default: 'default']
448 448 The name of the profile to search. Leaving this unspecified
449 449 The file to be found. If it is passed as an absolute path, fname will
450 450 simply be returned.
451 451
452 452 Returns
453 453 -------
454 454 Raises :exc:`IOError` if file not found or returns absolute path to file.
455 455 """
456 456 # import here, because profiledir also imports from utils.path
457 457 from IPython.core.profiledir import ProfileDir
458 458 try:
459 459 pd = ProfileDir.find_profile_dir_by_name(get_ipython_dir(), profile)
460 460 except Exception:
461 461 # will raise ProfileDirError if no such profile
462 462 raise IOError("Profile %r not found")
463 463 return filefind(filename, ['.', pd.security_dir])
464 464
@@ -1,408 +1,415 b''
1 1 # encoding: utf-8
2 2 """Tests for IPython.utils.path.py"""
3 3
4 4 #-----------------------------------------------------------------------------
5 5 # Copyright (C) 2008-2011 The IPython Development Team
6 6 #
7 7 # Distributed under the terms of the BSD License. The full license is in
8 8 # the file COPYING, distributed as part of this software.
9 9 #-----------------------------------------------------------------------------
10 10
11 11 #-----------------------------------------------------------------------------
12 12 # Imports
13 13 #-----------------------------------------------------------------------------
14 14
15 15 from __future__ import with_statement
16 16
17 17 import os
18 18 import shutil
19 19 import sys
20 20 import tempfile
21 21 from io import StringIO
22 22
23 23 from os.path import join, abspath, split
24 24
25 25 import nose.tools as nt
26 26
27 27 from nose import with_setup
28 28
29 29 import IPython
30 30 from IPython.testing import decorators as dec
31 31 from IPython.testing.decorators import skip_if_not_win32, skip_win32
32 32 from IPython.testing.tools import make_tempfile, AssertPrints
33 33 from IPython.utils import path, io
34 34 from IPython.utils import py3compat
35 35
36 36 # Platform-dependent imports
37 37 try:
38 38 import _winreg as wreg
39 39 except ImportError:
40 40 #Fake _winreg module on none windows platforms
41 41 import types
42 42 wr_name = "winreg" if py3compat.PY3 else "_winreg"
43 43 sys.modules[wr_name] = types.ModuleType(wr_name)
44 44 import _winreg as wreg
45 45 #Add entries that needs to be stubbed by the testing code
46 46 (wreg.OpenKey, wreg.QueryValueEx,) = (None, None)
47 47
48 48 try:
49 49 reload
50 50 except NameError: # Python 3
51 51 from imp import reload
52 52
53 53 #-----------------------------------------------------------------------------
54 54 # Globals
55 55 #-----------------------------------------------------------------------------
56 56 env = os.environ
57 57 TEST_FILE_PATH = split(abspath(__file__))[0]
58 58 TMP_TEST_DIR = tempfile.mkdtemp()
59 59 HOME_TEST_DIR = join(TMP_TEST_DIR, "home_test_dir")
60 60 XDG_TEST_DIR = join(HOME_TEST_DIR, "xdg_test_dir")
61 61 IP_TEST_DIR = join(HOME_TEST_DIR,'.ipython')
62 62 #
63 63 # Setup/teardown functions/decorators
64 64 #
65 65
66 66 def setup():
67 67 """Setup testenvironment for the module:
68 68
69 69 - Adds dummy home dir tree
70 70 """
71 71 # Do not mask exceptions here. In particular, catching WindowsError is a
72 72 # problem because that exception is only defined on Windows...
73 73 os.makedirs(IP_TEST_DIR)
74 74 os.makedirs(os.path.join(XDG_TEST_DIR, 'ipython'))
75 75
76 76
77 77 def teardown():
78 78 """Teardown testenvironment for the module:
79 79
80 80 - Remove dummy home dir tree
81 81 """
82 82 # Note: we remove the parent test dir, which is the root of all test
83 83 # subdirs we may have created. Use shutil instead of os.removedirs, so
84 84 # that non-empty directories are all recursively removed.
85 85 shutil.rmtree(TMP_TEST_DIR)
86 86
87 87
88 88 def setup_environment():
89 89 """Setup testenvironment for some functions that are tested
90 90 in this module. In particular this functions stores attributes
91 91 and other things that we need to stub in some test functions.
92 92 This needs to be done on a function level and not module level because
93 93 each testfunction needs a pristine environment.
94 94 """
95 95 global oldstuff, platformstuff
96 96 oldstuff = (env.copy(), os.name, path.get_home_dir, IPython.__file__, os.getcwd())
97 97
98 98 if os.name == 'nt':
99 99 platformstuff = (wreg.OpenKey, wreg.QueryValueEx,)
100 100
101 101
102 102 def teardown_environment():
103 103 """Restore things that were remebered by the setup_environment function
104 104 """
105 105 (oldenv, os.name, path.get_home_dir, IPython.__file__, old_wd) = oldstuff
106 106 os.chdir(old_wd)
107 107 reload(path)
108 108
109 109 for key in env.keys():
110 110 if key not in oldenv:
111 111 del env[key]
112 112 env.update(oldenv)
113 113 if hasattr(sys, 'frozen'):
114 114 del sys.frozen
115 115 if os.name == 'nt':
116 116 (wreg.OpenKey, wreg.QueryValueEx,) = platformstuff
117 117
118 118 # Build decorator that uses the setup_environment/setup_environment
119 119 with_environment = with_setup(setup_environment, teardown_environment)
120 120
121 121 @skip_if_not_win32
122 122 @with_environment
123 123 def test_get_home_dir_1():
124 124 """Testcase for py2exe logic, un-compressed lib
125 125 """
126 126 sys.frozen = True
127 127
128 128 #fake filename for IPython.__init__
129 129 IPython.__file__ = abspath(join(HOME_TEST_DIR, "Lib/IPython/__init__.py"))
130 130
131 131 home_dir = path.get_home_dir()
132 132 nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
133 133
134 134
135 135 @skip_if_not_win32
136 136 @with_environment
137 137 def test_get_home_dir_2():
138 138 """Testcase for py2exe logic, compressed lib
139 139 """
140 140 sys.frozen = True
141 141 #fake filename for IPython.__init__
142 142 IPython.__file__ = abspath(join(HOME_TEST_DIR, "Library.zip/IPython/__init__.py")).lower()
143 143
144 144 home_dir = path.get_home_dir(True)
145 145 nt.assert_equal(home_dir, abspath(HOME_TEST_DIR).lower())
146 146
147 147
148 148 @with_environment
149 149 def test_get_home_dir_3():
150 150 """get_home_dir() uses $HOME if set"""
151 151 env["HOME"] = HOME_TEST_DIR
152 152 home_dir = path.get_home_dir(True)
153 153 # get_home_dir expands symlinks
154 154 nt.assert_equal(home_dir, os.path.realpath(env["HOME"]))
155 155
156 156
157 157 @with_environment
158 158 def test_get_home_dir_4():
159 159 """get_home_dir() still works if $HOME is not set"""
160 160
161 161 if 'HOME' in env: del env['HOME']
162 162 # this should still succeed, but we don't know what the answer should be
163 163 home = path.get_home_dir(True)
164 164 nt.assert_true(path._writable_dir(home))
165 165
166 166 @with_environment
167 167 def test_get_home_dir_5():
168 168 """raise HomeDirError if $HOME is specified, but not a writable dir"""
169 169 env['HOME'] = abspath(HOME_TEST_DIR+'garbage')
170 170 # set os.name = posix, to prevent My Documents fallback on Windows
171 171 os.name = 'posix'
172 172 nt.assert_raises(path.HomeDirError, path.get_home_dir, True)
173 173
174 174
175 175 # Should we stub wreg fully so we can run the test on all platforms?
176 176 @skip_if_not_win32
177 177 @with_environment
178 178 def test_get_home_dir_8():
179 179 """Using registry hack for 'My Documents', os=='nt'
180 180
181 181 HOMESHARE, HOMEDRIVE, HOMEPATH, USERPROFILE and others are missing.
182 182 """
183 183 os.name = 'nt'
184 184 # Remove from stub environment all keys that may be set
185 185 for key in ['HOME', 'HOMESHARE', 'HOMEDRIVE', 'HOMEPATH', 'USERPROFILE']:
186 186 env.pop(key, None)
187 187
188 188 #Stub windows registry functions
189 189 def OpenKey(x, y):
190 190 class key:
191 191 def Close(self):
192 192 pass
193 193 return key()
194 194 def QueryValueEx(x, y):
195 195 return [abspath(HOME_TEST_DIR)]
196 196
197 197 wreg.OpenKey = OpenKey
198 198 wreg.QueryValueEx = QueryValueEx
199 199
200 200 home_dir = path.get_home_dir()
201 201 nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
202 202
203 203
204 204 @with_environment
205 205 def test_get_ipython_dir_1():
206 206 """test_get_ipython_dir_1, Testcase to see if we can call get_ipython_dir without Exceptions."""
207 207 env_ipdir = os.path.join("someplace", ".ipython")
208 208 path._writable_dir = lambda path: True
209 209 env['IPYTHON_DIR'] = env_ipdir
210 210 ipdir = path.get_ipython_dir()
211 211 nt.assert_equal(ipdir, env_ipdir)
212 212
213 213
214 214 @with_environment
215 215 def test_get_ipython_dir_2():
216 216 """test_get_ipython_dir_2, Testcase to see if we can call get_ipython_dir without Exceptions."""
217 217 path.get_home_dir = lambda : "someplace"
218 218 path.get_xdg_dir = lambda : None
219 219 path._writable_dir = lambda path: True
220 220 os.name = "posix"
221 221 env.pop('IPYTHON_DIR', None)
222 222 env.pop('IPYTHONDIR', None)
223 223 env.pop('XDG_CONFIG_HOME', None)
224 224 ipdir = path.get_ipython_dir()
225 225 nt.assert_equal(ipdir, os.path.join("someplace", ".ipython"))
226 226
227 227 @with_environment
228 228 def test_get_ipython_dir_3():
229 229 """test_get_ipython_dir_3, use XDG if defined, and .ipython doesn't exist."""
230 230 path.get_home_dir = lambda : "someplace"
231 231 path._writable_dir = lambda path: True
232 232 os.name = "posix"
233 233 env.pop('IPYTHON_DIR', None)
234 234 env.pop('IPYTHONDIR', None)
235 235 env['XDG_CONFIG_HOME'] = XDG_TEST_DIR
236 236 ipdir = path.get_ipython_dir()
237 237 nt.assert_equal(ipdir, os.path.join(XDG_TEST_DIR, "ipython"))
238 238
239 239 @with_environment
240 240 def test_get_ipython_dir_4():
241 241 """test_get_ipython_dir_4, use XDG if both exist."""
242 242 path.get_home_dir = lambda : HOME_TEST_DIR
243 243 os.name = "posix"
244 244 env.pop('IPYTHON_DIR', None)
245 245 env.pop('IPYTHONDIR', None)
246 246 env['XDG_CONFIG_HOME'] = XDG_TEST_DIR
247 247 xdg_ipdir = os.path.join(XDG_TEST_DIR, "ipython")
248 248 ipdir = path.get_ipython_dir()
249 249 nt.assert_equal(ipdir, xdg_ipdir)
250 250
251 251 @with_environment
252 252 def test_get_ipython_dir_5():
253 253 """test_get_ipython_dir_5, use .ipython if exists and XDG defined, but doesn't exist."""
254 254 path.get_home_dir = lambda : HOME_TEST_DIR
255 255 os.name = "posix"
256 256 env.pop('IPYTHON_DIR', None)
257 257 env.pop('IPYTHONDIR', None)
258 258 env['XDG_CONFIG_HOME'] = XDG_TEST_DIR
259 259 os.rmdir(os.path.join(XDG_TEST_DIR, 'ipython'))
260 260 ipdir = path.get_ipython_dir()
261 261 nt.assert_equal(ipdir, IP_TEST_DIR)
262 262
263 263 @with_environment
264 264 def test_get_ipython_dir_6():
265 265 """test_get_ipython_dir_6, use XDG if defined and neither exist."""
266 266 xdg = os.path.join(HOME_TEST_DIR, 'somexdg')
267 267 os.mkdir(xdg)
268 268 shutil.rmtree(os.path.join(HOME_TEST_DIR, '.ipython'))
269 269 path.get_home_dir = lambda : HOME_TEST_DIR
270 270 path.get_xdg_dir = lambda : xdg
271 271 os.name = "posix"
272 272 env.pop('IPYTHON_DIR', None)
273 273 env.pop('IPYTHONDIR', None)
274 274 env.pop('XDG_CONFIG_HOME', None)
275 275 xdg_ipdir = os.path.join(xdg, "ipython")
276 276 ipdir = path.get_ipython_dir()
277 277 nt.assert_equal(ipdir, xdg_ipdir)
278 278
279 279 @with_environment
280 280 def test_get_ipython_dir_7():
281 281 """test_get_ipython_dir_7, test home directory expansion on IPYTHON_DIR"""
282 282 path._writable_dir = lambda path: True
283 283 home_dir = os.path.expanduser('~')
284 284 env['IPYTHON_DIR'] = os.path.join('~', 'somewhere')
285 285 ipdir = path.get_ipython_dir()
286 286 nt.assert_equal(ipdir, os.path.join(home_dir, 'somewhere'))
287 287
288 288
289 289 @with_environment
290 290 def test_get_xdg_dir_1():
291 291 """test_get_xdg_dir_1, check xdg_dir"""
292 292 reload(path)
293 293 path._writable_dir = lambda path: True
294 294 path.get_home_dir = lambda : 'somewhere'
295 295 os.name = "posix"
296 296 env.pop('IPYTHON_DIR', None)
297 297 env.pop('IPYTHONDIR', None)
298 298 env.pop('XDG_CONFIG_HOME', None)
299 299
300 300 nt.assert_equal(path.get_xdg_dir(), os.path.join('somewhere', '.config'))
301 301
302 302
303 303 @with_environment
304 304 def test_get_xdg_dir_1():
305 305 """test_get_xdg_dir_1, check nonexistant xdg_dir"""
306 306 reload(path)
307 307 path.get_home_dir = lambda : HOME_TEST_DIR
308 308 os.name = "posix"
309 309 env.pop('IPYTHON_DIR', None)
310 310 env.pop('IPYTHONDIR', None)
311 311 env.pop('XDG_CONFIG_HOME', None)
312 312 nt.assert_equal(path.get_xdg_dir(), None)
313 313
314 314 @with_environment
315 315 def test_get_xdg_dir_2():
316 316 """test_get_xdg_dir_2, check xdg_dir default to ~/.config"""
317 317 reload(path)
318 318 path.get_home_dir = lambda : HOME_TEST_DIR
319 319 os.name = "posix"
320 320 env.pop('IPYTHON_DIR', None)
321 321 env.pop('IPYTHONDIR', None)
322 322 env.pop('XDG_CONFIG_HOME', None)
323 323 cfgdir=os.path.join(path.get_home_dir(), '.config')
324 324 os.makedirs(cfgdir)
325 325
326 326 nt.assert_equal(path.get_xdg_dir(), cfgdir)
327 327
328 328 def test_filefind():
329 329 """Various tests for filefind"""
330 330 f = tempfile.NamedTemporaryFile()
331 331 # print 'fname:',f.name
332 332 alt_dirs = path.get_ipython_dir()
333 333 t = path.filefind(f.name, alt_dirs)
334 334 # print 'found:',t
335 335
336 336
337 337 def test_get_ipython_package_dir():
338 338 ipdir = path.get_ipython_package_dir()
339 339 nt.assert_true(os.path.isdir(ipdir))
340 340
341 341
342 342 def test_get_ipython_module_path():
343 343 ipapp_path = path.get_ipython_module_path('IPython.frontend.terminal.ipapp')
344 344 nt.assert_true(os.path.isfile(ipapp_path))
345 345
346 346
347 347 @dec.skip_if_not_win32
348 348 def test_get_long_path_name_win32():
349 349 p = path.get_long_path_name('c:\\docume~1')
350 350 nt.assert_equals(p,u'c:\\Documents and Settings')
351 351
352 352
353 353 @dec.skip_win32
354 354 def test_get_long_path_name():
355 355 p = path.get_long_path_name('/usr/local')
356 356 nt.assert_equals(p,'/usr/local')
357 357
358 358 @dec.skip_win32 # can't create not-user-writable dir on win
359 359 @with_environment
360 360 def test_not_writable_ipdir():
361 361 tmpdir = tempfile.mkdtemp()
362 362 os.name = "posix"
363 363 env.pop('IPYTHON_DIR', None)
364 364 env.pop('IPYTHONDIR', None)
365 365 env.pop('XDG_CONFIG_HOME', None)
366 366 env['HOME'] = tmpdir
367 367 ipdir = os.path.join(tmpdir, '.ipython')
368 368 os.mkdir(ipdir)
369 369 os.chmod(ipdir, 600)
370 370 with AssertPrints('is not a writable location', channel='stderr'):
371 371 ipdir = path.get_ipython_dir()
372 372 env.pop('IPYTHON_DIR', None)
373 373
374 374 def test_unquote_filename():
375 375 for win32 in (True, False):
376 376 nt.assert_equals(path.unquote_filename('foo.py', win32=win32), 'foo.py')
377 377 nt.assert_equals(path.unquote_filename('foo bar.py', win32=win32), 'foo bar.py')
378 378 nt.assert_equals(path.unquote_filename('"foo.py"', win32=True), 'foo.py')
379 379 nt.assert_equals(path.unquote_filename('"foo bar.py"', win32=True), 'foo bar.py')
380 380 nt.assert_equals(path.unquote_filename("'foo.py'", win32=True), 'foo.py')
381 381 nt.assert_equals(path.unquote_filename("'foo bar.py'", win32=True), 'foo bar.py')
382 382 nt.assert_equals(path.unquote_filename('"foo.py"', win32=False), '"foo.py"')
383 383 nt.assert_equals(path.unquote_filename('"foo bar.py"', win32=False), '"foo bar.py"')
384 384 nt.assert_equals(path.unquote_filename("'foo.py'", win32=False), "'foo.py'")
385 385 nt.assert_equals(path.unquote_filename("'foo bar.py'", win32=False), "'foo bar.py'")
386 386
387 387 @with_environment
388 388 def test_get_py_filename():
389 389 os.chdir(TMP_TEST_DIR)
390 390 for win32 in (True, False):
391 391 with make_tempfile('foo.py'):
392 392 nt.assert_equals(path.get_py_filename('foo.py', force_win32=win32), 'foo.py')
393 393 nt.assert_equals(path.get_py_filename('foo', force_win32=win32), 'foo.py')
394 394 with make_tempfile('foo'):
395 395 nt.assert_equals(path.get_py_filename('foo', force_win32=win32), 'foo')
396 396 nt.assert_raises(IOError, path.get_py_filename, 'foo.py', force_win32=win32)
397 397 nt.assert_raises(IOError, path.get_py_filename, 'foo', force_win32=win32)
398 398 nt.assert_raises(IOError, path.get_py_filename, 'foo.py', force_win32=win32)
399 399 true_fn = 'foo with spaces.py'
400 400 with make_tempfile(true_fn):
401 401 nt.assert_equals(path.get_py_filename('foo with spaces', force_win32=win32), true_fn)
402 402 nt.assert_equals(path.get_py_filename('foo with spaces.py', force_win32=win32), true_fn)
403 403 if win32:
404 404 nt.assert_equals(path.get_py_filename('"foo with spaces.py"', force_win32=True), true_fn)
405 405 nt.assert_equals(path.get_py_filename("'foo with spaces.py'", force_win32=True), true_fn)
406 406 else:
407 407 nt.assert_raises(IOError, path.get_py_filename, '"foo with spaces.py"', force_win32=False)
408 408 nt.assert_raises(IOError, path.get_py_filename, "'foo with spaces.py'", force_win32=False)
409
410 def test_unicode_in_filename():
411 try:
412 # these calls should not throw unicode encode exceptions
413 path.get_py_filename(u'fooéè.py', force_win32=False)
414 except IOError as ex:
415 str(ex)
General Comments 0
You need to be logged in to leave comments. Login now