117
109
raise BzrError("lstat/stat of (%r): %r" % (f, e))
119
def fancy_rename(old, new, rename_func, unlink_func):
120
"""A fancy rename, when you don't have atomic rename.
122
:param old: The old path, to rename from
123
:param new: The new path, to rename to
124
:param rename_func: The potentially non-atomic rename function
125
:param unlink_func: A way to delete the target file if the full rename succeeds
128
# sftp rename doesn't allow overwriting, so play tricks:
130
base = os.path.basename(new)
131
dirname = os.path.dirname(new)
132
tmp_name = u'tmp.%s.%.9f.%d.%d' % (base, time.time(), os.getpid(), random.randint(0, 0x7FFFFFFF))
133
tmp_name = pathjoin(dirname, tmp_name)
135
# Rename the file out of the way, but keep track if it didn't exist
136
# We don't want to grab just any exception
137
# something like EACCES should prevent us from continuing
138
# The downside is that the rename_func has to throw an exception
139
# with an errno = ENOENT, or NoSuchFile
142
rename_func(new, tmp_name)
143
except (NoSuchFile,), e:
146
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
147
# function raises an IOError with errno == None when a rename fails.
148
# This then gets caught here.
149
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
152
if (not hasattr(e, 'errno')
153
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
160
# This may throw an exception, in which case success will
162
rename_func(old, new)
166
# If the file used to exist, rename it back into place
167
# otherwise just delete it from the tmp location
169
unlink_func(tmp_name)
171
rename_func(tmp_name, new)
173
# Default is to just use the python builtins
174
abspath = os.path.abspath
175
realpath = os.path.realpath
176
pathjoin = os.path.join
177
normpath = os.path.normpath
179
mkdtemp = tempfile.mkdtemp
181
dirname = os.path.dirname
182
basename = os.path.basename
184
if os.name == "posix":
185
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
186
# choke on a Unicode string containing a relative path if
187
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
189
_fs_enc = sys.getfilesystemencoding()
191
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
194
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
196
if sys.platform == 'win32':
197
# We need to use the Unicode-aware os.path.abspath and
198
# os.path.realpath on Windows systems.
200
return os.path.abspath(path).replace('\\', '/')
203
return os.path.realpath(path).replace('\\', '/')
206
return os.path.join(*args).replace('\\', '/')
209
return os.path.normpath(path).replace('\\', '/')
212
return os.getcwdu().replace('\\', '/')
214
def mkdtemp(*args, **kwargs):
215
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
217
def rename(old, new):
218
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
221
111
def normalizepath(f):
222
112
if hasattr(os.path, 'realpath'):
226
116
[p,e] = os.path.split(f)
227
117
if e == "" or e == "." or e == "..":
230
return pathjoin(F(p), e)
120
return os.path.join(F(p), e)
233
123
def backup_file(fn):
234
124
"""Copy a file to a backup.
283
175
def is_inside(dir, fname):
284
176
"""True if fname is inside dir.
286
The parameters should typically be passed to osutils.normpath first, so
178
The parameters should typically be passed to os.path.normpath first, so
287
179
that . and .. and repeated slashes are eliminated, and the separators
288
180
are canonical for the platform.
290
182
The empty string as a dir name is taken as top-of-tree and matches
293
>>> is_inside('src', pathjoin('src', 'foo.c'))
185
>>> is_inside('src', os.path.join('src', 'foo.c'))
295
187
>>> is_inside('src', 'srccontrol')
297
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
189
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
299
191
>>> is_inside('foo.c', 'foo.c')
372
259
'sha1': s.hexdigest()}
263
"""Return per-user configuration directory.
265
By default this is ~/.bzr.conf/
267
TODO: Global option --config-dir to override this.
269
return os.path.join(os.path.expanduser("~"), ".bzr.conf")
273
"""Calculate automatic user identification.
275
Returns (realname, email).
277
Only used when none is set in the environment or the id file.
279
This previously used the FQDN as the default domain, but that can
280
be very slow on machines where DNS is broken. So now we simply
285
# XXX: Any good way to get real user name on win32?
290
w = pwd.getpwuid(uid)
291
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
292
username = w.pw_name.decode(bzrlib.user_encoding)
293
comma = gecos.find(',')
297
realname = gecos[:comma]
303
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
305
return realname, (username + '@' + socket.gethostname())
308
def _get_user_id(branch):
309
"""Return the full user id from a file or environment variable.
311
e.g. "John Hacker <jhacker@foo.org>"
314
A branch to use for a per-branch configuration, or None.
316
The following are searched in order:
319
2. .bzr/email for this branch.
323
v = os.environ.get('BZREMAIL')
325
return v.decode(bzrlib.user_encoding)
329
return (branch.controlfile("email", "r")
331
.decode(bzrlib.user_encoding)
334
if e.errno != errno.ENOENT:
340
return (open(os.path.join(config_dir(), "email"))
342
.decode(bzrlib.user_encoding)
345
if e.errno != errno.ENOENT:
348
v = os.environ.get('EMAIL')
350
return v.decode(bzrlib.user_encoding)
355
def username(branch):
356
"""Return email-style username.
358
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
360
TODO: Check it's reasonably well-formed.
362
v = _get_user_id(branch)
366
name, email = _auto_user_id()
368
return '%s <%s>' % (name, email)
373
def user_email(branch):
374
"""Return just the email component of a username."""
375
e = _get_user_id(branch)
377
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
379
raise BzrError("%r doesn't seem to contain "
380
"a reasonable email address" % e)
383
return _auto_user_id()[1]
375
386
def compare_files(a, b):
376
387
"""Returns true if equal in contents"""
496
502
if (f == '..') or (f == None) or (f == ''):
497
503
raise BzrError("sorry, %r not allowed in path" % f)
504
return os.path.join(*p)
501
507
def appendpath(p1, p2):
505
return pathjoin(p1, p2)
511
return os.path.join(p1, p2)
514
def _read_config_value(name):
515
"""Read a config value from the file ~/.bzr.conf/<name>
516
Return None if the file does not exist"""
518
f = file(os.path.join(config_dir(), name), "r")
519
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
521
if e.errno == errno.ENOENT:
508
526
def split_lines(s):
509
527
"""Split s into lines, but without removing the newline characters."""
510
528
return StringIO(s).readlines()
537
def contains_whitespace(s):
538
"""True if there are any whitespace characters in s."""
539
for ch in string.whitespace:
546
def contains_linebreaks(s):
547
"""True if there is any vertical whitespace in s."""
555
def relpath(base, path):
556
"""Return path relative to base, or raise exception.
558
The path may be either an absolute path or a path relative to the
559
current working directory.
561
os.path.commonprefix (python2.4) has a bad bug that it works just
562
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
563
avoids that problem."""
568
while len(head) >= len(base):
571
head, tail = os.path.split(head)
575
# XXX This should raise a NotChildPath exception, as its not tied
577
raise PathNotChild(rp, base)
585
def safe_unicode(unicode_or_utf8_string):
586
"""Coerce unicode_or_utf8_string into unicode.
588
If it is unicode, it is returned.
589
Otherwise it is decoded from utf-8. If a decoding error
590
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
591
as a BzrBadParameter exception.
593
if isinstance(unicode_or_utf8_string, unicode):
594
return unicode_or_utf8_string
596
return unicode_or_utf8_string.decode('utf8')
597
except UnicodeDecodeError:
598
raise BzrBadParameter(unicode_or_utf8_string)
601
def terminal_width():
602
"""Return estimated terminal width."""
604
# TODO: Do something smart on Windows?
606
# TODO: Is there anything that gets a better update when the window
607
# is resized while the program is running? We could use the Python termcap
610
return int(os.environ['COLUMNS'])
611
except (IndexError, KeyError, ValueError):
added
removed
bzrlib/osutils.py
