113
109
raise BzrError("lstat/stat of (%r): %r" % (f, e))
115
def fancy_rename(old, new, rename_func, unlink_func):
116
"""A fancy rename, when you don't have atomic rename.
118
:param old: The old path, to rename from
119
:param new: The new path, to rename to
120
:param rename_func: The potentially non-atomic rename function
121
:param unlink_func: A way to delete the target file if the full rename succeeds
124
# sftp rename doesn't allow overwriting, so play tricks:
126
base = os.path.basename(new)
127
dirname = os.path.dirname(new)
128
tmp_name = u'tmp.%s.%.9f.%d.%d' % (base, time.time(), os.getpid(), random.randint(0, 0x7FFFFFFF))
129
tmp_name = pathjoin(dirname, tmp_name)
131
# Rename the file out of the way, but keep track if it didn't exist
132
# We don't want to grab just any exception
133
# something like EACCES should prevent us from continuing
134
# The downside is that the rename_func has to throw an exception
135
# with an errno = ENOENT, or NoSuchFile
138
rename_func(new, tmp_name)
139
except (NoSuchFile,), e:
142
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
143
# function raises an IOError with errno == None when a rename fails.
144
# This then gets caught here.
145
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
148
if (not hasattr(e, 'errno')
149
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
156
# This may throw an exception, in which case success will
158
rename_func(old, new)
162
# If the file used to exist, rename it back into place
163
# otherwise just delete it from the tmp location
165
unlink_func(tmp_name)
167
rename_func(tmp_name, new)
169
# Default is to just use the python builtins
170
abspath = os.path.abspath
171
realpath = os.path.realpath
172
pathjoin = os.path.join
173
normpath = os.path.normpath
175
mkdtemp = tempfile.mkdtemp
177
dirname = os.path.dirname
178
basename = os.path.basename
180
if os.name == "posix":
181
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
182
# choke on a Unicode string containing a relative path if
183
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
185
_fs_enc = sys.getfilesystemencoding()
187
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
190
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
192
if sys.platform == 'win32':
193
# We need to use the Unicode-aware os.path.abspath and
194
# os.path.realpath on Windows systems.
196
return os.path.abspath(path).replace('\\', '/')
199
return os.path.realpath(path).replace('\\', '/')
202
return os.path.join(*args).replace('\\', '/')
205
return os.path.normpath(path).replace('\\', '/')
208
return os.getcwdu().replace('\\', '/')
210
def mkdtemp(*args, **kwargs):
211
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
213
def rename(old, new):
214
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
217
111
def normalizepath(f):
218
112
if hasattr(os.path, 'realpath'):
222
116
[p,e] = os.path.split(f)
223
117
if e == "" or e == "." or e == "..":
226
return pathjoin(F(p), e)
120
return os.path.join(F(p), e)
229
123
def backup_file(fn):
230
124
"""Copy a file to a backup.
279
175
def is_inside(dir, fname):
280
176
"""True if fname is inside dir.
282
The parameters should typically be passed to osutils.normpath first, so
178
The parameters should typically be passed to os.path.normpath first, so
283
179
that . and .. and repeated slashes are eliminated, and the separators
284
180
are canonical for the platform.
286
182
The empty string as a dir name is taken as top-of-tree and matches
289
>>> is_inside('src', pathjoin('src', 'foo.c'))
185
>>> is_inside('src', os.path.join('src', 'foo.c'))
291
187
>>> is_inside('src', 'srccontrol')
293
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
189
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
295
191
>>> is_inside('foo.c', 'foo.c')
368
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]
371
386
def compare_files(a, b):
372
387
"""Returns true if equal in contents"""
492
502
if (f == '..') or (f == None) or (f == ''):
493
503
raise BzrError("sorry, %r not allowed in path" % f)
504
return os.path.join(*p)
497
507
def appendpath(p1, p2):
501
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:
504
526
def split_lines(s):
505
527
"""Split s into lines, but without removing the newline characters."""
506
528
return StringIO(s).readlines()
533
def contains_whitespace(s):
534
"""True if there are any whitespace characters in s."""
535
for ch in string.whitespace:
542
def contains_linebreaks(s):
543
"""True if there is any vertical whitespace in s."""
551
def relpath(base, path):
552
"""Return path relative to base, or raise exception.
554
The path may be either an absolute path or a path relative to the
555
current working directory.
557
os.path.commonprefix (python2.4) has a bad bug that it works just
558
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
559
avoids that problem."""
564
while len(head) >= len(base):
567
head, tail = os.path.split(head)
571
# XXX This should raise a NotChildPath exception, as its not tied
573
raise PathNotChild(rp, base)
581
def terminal_width():
582
"""Return estimated terminal width."""
584
# TODO: Do something smart on Windows?
586
# TODO: Is there anything that gets a better update when the window
587
# is resized while the program is running? We could use the Python termcap
590
return int(os.environ['COLUMNS'])
591
except (IndexError, KeyError, ValueError):
added
removed
bzrlib/osutils.py
