14
19
# along with this program; if not, write to the Free Software
15
20
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
"""Bazaar-NG -- a free distributed version-control tool
24
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
26
Current limitation include:
28
* Metadata format is not stable yet -- you may need to
29
discard history in the future.
31
* No handling of subdirectories, symlinks or any non-text files.
33
* Insufficient error handling.
35
* Many commands unimplemented or partially implemented.
37
* Space-inefficient storage.
39
* No merge operators yet.
41
Interesting commands::
44
Show summary help screen
46
Show software version/licence/non-warranty.
48
Start versioning the current directory
52
Show revision history.
54
Show changes from last revision to working copy.
55
bzr commit -m 'MESSAGE'
56
Store current state as new revision.
57
bzr export REVNO DESTINATION
58
Export the branch state at a previous version.
60
Show summary of pending changes.
62
Make a file not versioned.
65
# not currently working:
67
# Run internal consistency checks.
69
# Show some information about this branch.
73
__copyright__ = "Copyright 2005 Canonical Development Ltd."
74
__author__ = "Martin Pool <mbp@canonical.com>"
75
__docformat__ = "restructuredtext en"
79
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
80
import traceback, socket, fnmatch, difflib
83
from pprint import pprint
86
from ElementTree import Element, ElementTree, SubElement
89
from bzrlib.store import ImmutableStore
22
90
from bzrlib.trace import mutter, note, log_error
23
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.osutils import quotefn
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
91
from bzrlib.errors import bailout, BzrError
92
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
93
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
94
from bzrlib.revision import Revision
95
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
29
def _squish_command_name(cmd):
30
return 'cmd_' + cmd.replace('-', '_')
33
def _unsquish_command_name(cmd):
34
assert cmd.startswith("cmd_")
35
return cmd[4:].replace('_','-')
37
def _parse_revision_str(revstr):
38
"""This handles a revision string -> revno.
40
There are several possibilities:
43
'234:345' -> [234, 345]
47
In the future we will also support:
48
'uuid:blah-blah-blah' -> ?
49
'hash:blahblahblah' -> ?
53
if revstr.find(':') != -1:
54
revs = revstr.split(':')
56
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
61
revs[0] = int(revs[0])
66
revs[1] = int(revs[1])
72
"""Find all python files which are plugins, and load their commands
73
to add to the list of "all commands"
75
The environment variable BZRPATH is considered a delimited set of
76
paths to look through. Each entry is searched for *.py files.
77
If a directory is found, it is also searched, but they are
78
not searched recursively. This allows you to revctl the plugins.
80
Inside the plugin should be a series of cmd_* function, which inherit from
81
the bzrlib.commands.Command class.
83
bzrpath = os.environ.get('BZRPLUGINPATH', '')
88
_platform_extensions = {
94
if _platform_extensions.has_key(sys.platform):
95
platform_extension = _platform_extensions[sys.platform]
97
platform_extension = None
98
for d in bzrpath.split(os.pathsep):
99
plugin_names = {} # This should really be a set rather than a dict
100
for f in os.listdir(d):
101
if f.endswith('.py'):
103
elif f.endswith('.pyc') or f.endswith('.pyo'):
105
elif platform_extension and f.endswith(platform_extension):
106
f = f[:-len(platform_extension)]
107
if f.endswidth('module'):
108
f = f[:-len('module')]
111
if not plugin_names.has_key(f):
112
plugin_names[f] = True
114
plugin_names = plugin_names.keys()
117
sys.path.insert(0, d)
118
for name in plugin_names:
122
if sys.modules.has_key(name):
123
old_module = sys.modules[name]
124
del sys.modules[name]
125
plugin = __import__(name, locals())
126
for k in dir(plugin):
127
if k.startswith('cmd_'):
128
k_unsquished = _unsquish_command_name(k)
129
if not plugin_cmds.has_key(k_unsquished):
130
plugin_cmds[k_unsquished] = getattr(plugin, k)
132
log_error('Two plugins defined the same command: %r' % k)
133
log_error('Not loading the one in %r in dir %r' % (name, d))
136
sys.modules[name] = old_module
137
except ImportError, e:
138
log_error('Unable to load plugin: %r from %r\n%s' % (name, d, e))
143
def _get_cmd_dict(include_plugins=True):
145
for k, v in globals().iteritems():
146
if k.startswith("cmd_"):
147
d[_unsquish_command_name(k)] = v
149
d.update(_find_plugins())
152
def get_all_cmds(include_plugins=True):
153
"""Return canonical name and class for all registered commands."""
154
for k, v in _get_cmd_dict(include_plugins=include_plugins).iteritems():
158
def get_cmd_class(cmd,include_plugins=True):
159
"""Return the canonical name and command class for a command.
161
cmd = str(cmd) # not unicode
163
# first look up this command under the specified name
164
cmds = _get_cmd_dict(include_plugins=include_plugins)
166
return cmd, cmds[cmd]
170
# look for any command which claims this as an alias
171
for cmdname, cmdclass in cmds.iteritems():
172
if cmd in cmdclass.aliases:
173
return cmdname, cmdclass
175
cmdclass = ExternalCommand.find_command(cmd)
179
raise BzrCommandError("unknown command %r" % cmd)
182
class Command(object):
183
"""Base class for commands.
185
The docstring for an actual command should give a single-line
186
summary, then a complete description of the command. A grammar
187
description will be inserted.
190
List of argument forms, marked with whether they are optional,
194
List of options that may be given for this command.
197
If true, this command isn't advertised.
206
def __init__(self, options, arguments):
207
"""Construct and run the command.
209
Sets self.status to the return value of run()."""
210
assert isinstance(options, dict)
211
assert isinstance(arguments, dict)
212
cmdargs = options.copy()
213
cmdargs.update(arguments)
214
assert self.__doc__ != Command.__doc__, \
215
("No help message set for %r" % self)
216
self.status = self.run(**cmdargs)
220
"""Override this in sub-classes.
222
This is invoked with the options and arguments bound to
225
Return 0 or None if the command was successful, or a shell
231
class ExternalCommand(Command):
232
"""Class to wrap external commands.
234
We cheat a little here, when get_cmd_class() calls us we actually give it back
235
an object we construct that has the appropriate path, help, options etc for the
238
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
239
method, which we override to call the Command.__init__ method. That then calls
240
our run method which is pretty straight forward.
242
The only wrinkle is that we have to map bzr's dictionary of options and arguments
243
back into command line options and arguments for the script.
246
def find_command(cls, cmd):
248
bzrpath = os.environ.get('BZRPATH', '')
250
for dir in bzrpath.split(os.pathsep):
251
path = os.path.join(dir, cmd)
252
if os.path.isfile(path):
253
return ExternalCommand(path)
257
find_command = classmethod(find_command)
259
def __init__(self, path):
262
# TODO: If either of these fail, we should detect that and
263
# assume that path is not really a bzr plugin after all.
265
pipe = os.popen('%s --bzr-usage' % path, 'r')
266
self.takes_options = pipe.readline().split()
267
self.takes_args = pipe.readline().split()
270
pipe = os.popen('%s --bzr-help' % path, 'r')
271
self.__doc__ = pipe.read()
274
def __call__(self, options, arguments):
275
Command.__init__(self, options, arguments)
278
def run(self, **kargs):
286
if OPTIONS.has_key(name):
288
opts.append('--%s' % name)
289
if value is not None and value is not True:
290
opts.append(str(value))
292
# it's an arg, or arg list
293
if type(value) is not list:
299
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
303
class cmd_status(Command):
98
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
99
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
101
## standard representation
102
NONE_STRING = '(none)'
106
## TODO: Perhaps a different version of inventory commands that
107
## returns iterators...
109
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
111
## TODO: Some kind of locking on branches. Perhaps there should be a
112
## parameter to the branch object saying whether we want a read or
113
## write lock; release it from destructor. Perhaps don't even need a
114
## read lock to look at immutable objects?
116
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
117
## to compare output?
119
## TODO: Is ElementTree really all that much better for our purposes?
120
## Perhaps using the standard MiniDOM would be enough?
127
######################################################################
131
def cmd_status(all=False):
304
132
"""Display status summary.
306
This reports on versioned and unknown files, reporting them
307
grouped by state. Possible states are:
310
Versioned in the working copy but not in the previous revision.
313
Versioned in the previous revision but removed or deleted
317
Path of this file changed from the previous revision;
318
the text may also have changed. This includes files whose
319
parent directory was renamed.
322
Text has changed since the previous revision.
325
Nothing about this file has changed since the previous revision.
326
Only shown with --all.
329
Not versioned and not matching an ignore pattern.
331
To see ignored files use 'bzr ignored'. For details in the
332
changes to file texts, use 'bzr diff'.
334
If no arguments are specified, the status of the entire working
335
directory is shown. Otherwise, only the status of the specified
336
files or directories is reported. If a directory is given, status
337
is reported for everything inside that directory.
339
takes_args = ['file*']
340
takes_options = ['all', 'show-ids']
341
aliases = ['st', 'stat']
343
def run(self, all=False, show_ids=False, file_list=None):
345
b = Branch(file_list[0])
346
file_list = [b.relpath(x) for x in file_list]
347
# special case: only one path was given and it's the root
349
if file_list == ['']:
354
status.show_status(b, show_unchanged=all, show_ids=show_ids,
355
specific_files=file_list)
358
class cmd_cat_revision(Command):
359
"""Write out metadata for a revision."""
362
takes_args = ['revision_id']
364
def run(self, revision_id):
365
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
368
class cmd_revno(Command):
369
"""Show current revision number.
371
This is equal to the number of revisions on this branch."""
373
print Branch('.').revno()
376
class cmd_add(Command):
377
"""Add specified files or directories.
379
In non-recursive mode, all the named items are added, regardless
380
of whether they were previously ignored. A warning is given if
381
any of the named files are already versioned.
383
In recursive mode (the default), files are treated the same way
384
but the behaviour for directories is different. Directories that
385
are already versioned do not give a warning. All directories,
386
whether already versioned or not, are searched for files or
387
subdirectories that are neither versioned or ignored, and these
388
are added. This search proceeds recursively into versioned
391
Therefore simply saying 'bzr add .' will version all files that
392
are currently unknown.
394
TODO: Perhaps adding a file whose directly is not versioned should
395
recursively add that parent, rather than giving an error?
397
takes_args = ['file+']
398
takes_options = ['verbose', 'no-recurse']
400
def run(self, file_list, verbose=False, no_recurse=False):
401
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
404
class cmd_relpath(Command):
405
"""Show path of a file relative to root"""
406
takes_args = ['filename']
409
def run(self, filename):
410
print Branch(filename).relpath(filename)
414
class cmd_inventory(Command):
415
"""Show inventory of the current working copy or a revision."""
416
takes_options = ['revision', 'show-ids']
418
def run(self, revision=None, show_ids=False):
421
inv = b.read_working_inventory()
423
inv = b.get_revision_inventory(b.lookup_revision(revision))
425
for path, entry in inv.entries():
427
print '%-50s %s' % (path, entry.file_id)
432
class cmd_move(Command):
433
"""Move files to a different directory.
438
The destination must be a versioned directory in the same branch.
440
takes_args = ['source$', 'dest']
441
def run(self, source_list, dest):
444
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
447
class cmd_rename(Command):
448
"""Change the name of an entry.
451
bzr rename frob.c frobber.c
452
bzr rename src/frob.c lib/frob.c
454
It is an error if the destination name exists.
456
See also the 'move' command, which moves files into a different
457
directory without changing their name.
459
TODO: Some way to rename multiple files without invoking bzr for each
461
takes_args = ['from_name', 'to_name']
463
def run(self, from_name, to_name):
465
b.rename_one(b.relpath(from_name), b.relpath(to_name))
471
class cmd_pull(Command):
472
"""Pull any changes from another branch into the current one.
474
If the location is omitted, the last-used location will be used.
475
Both the revision history and the working directory will be
478
This command only works on branches that have not diverged. Branches are
479
considered diverged if both branches have had commits without first
480
pulling from the other.
482
If branches have diverged, you can use 'bzr merge' to pull the text changes
483
from one into the other.
485
takes_args = ['location?']
487
def run(self, location=None):
488
from bzrlib.merge import merge
494
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
496
if errno == errno.ENOENT:
499
location = stored_loc
501
raise BzrCommandError("No pull location known or specified.")
502
from branch import find_branch, DivergedBranches
503
br_from = find_branch(location)
504
location = pull_loc(br_from)
505
old_revno = br_to.revno()
507
br_to.update_revisions(br_from)
508
except DivergedBranches:
509
raise BzrCommandError("These branches have diverged. Try merge.")
511
merge(('.', -1), ('.', old_revno), check_clean=False)
512
if location != stored_loc:
513
br_to.controlfile("x-pull", "wb").write(location + "\n")
517
class cmd_branch(Command):
518
"""Create a new copy of a branch.
520
If the TO_LOCATION is omitted, the last component of the
521
FROM_LOCATION will be used. In other words,
522
"branch ../foo/bar" will attempt to create ./bar.
524
takes_args = ['from_location', 'to_location?']
526
def run(self, from_location, to_location=None):
528
from bzrlib.merge import merge
530
if to_location is None:
531
to_location = os.path.basename(from_location)
532
# FIXME: If there's a trailing slash, keep removing them
533
# until we find the right bit
536
os.mkdir(to_location)
538
if e.errno == errno.EEXIST:
539
raise BzrCommandError('Target directory "%s" already exists.' %
541
if e.errno == errno.ENOENT:
542
raise BzrCommandError('Parent of "%s" does not exist.' %
546
br_to = Branch(to_location, init=True)
547
from branch import find_branch, DivergedBranches
549
br_from = find_branch(from_location)
551
if e.errno == errno.ENOENT:
552
raise BzrCommandError('Source location "%s" does not exist.' %
557
from_location = pull_loc(br_from)
558
br_to.update_revisions(br_from)
559
merge((to_location, -1), (to_location, 0), this_dir=to_location,
561
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
564
def pull_loc(branch):
565
# TODO: Should perhaps just make attribute be 'base' in
566
# RemoteBranch and Branch?
567
if hasattr(branch, "baseurl"):
568
return branch.baseurl
574
class cmd_renames(Command):
575
"""Show list of renamed files.
577
TODO: Option to show renames between two historical versions.
579
TODO: Only show renames under dir, rather than in the whole branch.
581
takes_args = ['dir?']
583
def run(self, dir='.'):
585
old_inv = b.basis_tree().inventory
586
new_inv = b.read_working_inventory()
588
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
590
for old_name, new_name in renames:
591
print "%s => %s" % (old_name, new_name)
594
class cmd_info(Command):
595
"""Show statistical information about a branch."""
596
takes_args = ['branch?']
598
def run(self, branch=None):
601
from branch import find_branch
602
b = find_branch(branch)
606
class cmd_remove(Command):
607
"""Make a file unversioned.
609
This makes bzr stop tracking changes to a versioned file. It does
610
not delete the working copy.
612
takes_args = ['file+']
613
takes_options = ['verbose']
615
def run(self, file_list, verbose=False):
616
b = Branch(file_list[0])
617
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
620
class cmd_file_id(Command):
621
"""Print file_id of a particular file or directory.
623
The file_id is assigned when the file is first added and remains the
624
same through all revisions where the file exists, even when it is
628
takes_args = ['filename']
629
def run(self, filename):
631
i = b.inventory.path2id(b.relpath(filename))
633
bailout("%r is not a versioned file" % filename)
638
class cmd_file_path(Command):
639
"""Print path of file_ids to a file or directory.
641
This prints one line for each directory down to the target,
642
starting at the branch root."""
644
takes_args = ['filename']
645
def run(self, filename):
648
fid = inv.path2id(b.relpath(filename))
650
bailout("%r is not a versioned file" % filename)
651
for fip in inv.get_idpath(fid):
655
class cmd_revision_history(Command):
656
"""Display list of revision ids on this branch."""
659
for patchid in Branch('.').revision_history():
663
class cmd_directories(Command):
664
"""Display list of versioned directories in this branch."""
666
for name, ie in Branch('.').read_working_inventory().directories():
673
class cmd_init(Command):
674
"""Make a directory into a versioned branch.
676
Use this to create an empty branch, or before importing an
679
Recipe for importing a tree of files:
684
bzr commit -m 'imported project'
687
Branch('.', init=True)
690
class cmd_diff(Command):
691
"""Show differences in working tree.
693
If files are listed, only the changes in those files are listed.
694
Otherwise, all changes for the tree are listed.
696
TODO: Given two revision arguments, show the difference between them.
698
TODO: Allow diff across branches.
700
TODO: Option to use external diff command; could be GNU diff, wdiff,
703
TODO: Python difflib is not exactly the same as unidiff; should
704
either fix it up or prefer to use an external diff.
706
TODO: If a directory is given, diff everything under that.
708
TODO: Selected-file diff is inefficient and doesn't show you
711
TODO: This probably handles non-Unix newlines poorly.
714
takes_args = ['file*']
715
takes_options = ['revision', 'diff-options']
716
aliases = ['di', 'dif']
718
def run(self, revision=None, file_list=None, diff_options=None):
719
from bzrlib.diff import show_diff
720
from bzrlib import find_branch
723
b = find_branch(file_list[0])
724
file_list = [b.relpath(f) for f in file_list]
725
if file_list == ['']:
726
# just pointing to top-of-tree
731
show_diff(b, revision, specific_files=file_list,
732
external_diff_options=diff_options)
738
class cmd_deleted(Command):
739
"""List files deleted in the working tree.
741
TODO: Show files deleted since a previous revision, or between two revisions.
743
def run(self, show_ids=False):
746
new = b.working_tree()
748
## TODO: Much more efficient way to do this: read in new
749
## directories with readdir, rather than stating each one. Same
750
## level of effort but possibly much less IO. (Or possibly not,
751
## if the directories are very large...)
753
for path, ie in old.inventory.iter_entries():
754
if not new.has_id(ie.file_id):
756
print '%-50s %s' % (path, ie.file_id)
761
class cmd_modified(Command):
762
"""List files modified in working tree."""
134
For each file there is a single line giving its file state and name.
135
The name is that in the current revision unless it is deleted or
136
missing, in which case the old name is shown.
138
:todo: Don't show unchanged files unless ``--all`` is given?
140
Branch('.').show_status(show_all=all)
144
######################################################################
146
def cmd_get_revision(revision_id):
147
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
150
def cmd_get_inventory(inventory_id):
151
"""Return inventory in XML by hash"""
152
Branch('.').get_inventory(inventory_hash).write_xml(sys.stdout)
155
def cmd_get_revision_inventory(revision_id):
156
"""Output inventory for a revision."""
158
b.get_revision_inventory(revision_id).write_xml(sys.stdout)
161
def cmd_get_file_text(text_id):
162
"""Get contents of a file by hash."""
163
sf = Branch('.').text_store[text_id]
164
pumpfile(sf, sys.stdout)
168
######################################################################
173
"""Show number of revisions on this branch"""
174
print Branch('.').revno()
177
def cmd_add(file_list, verbose=False):
178
"""Add specified files.
180
Fails if the files are already added.
182
Branch('.').add(file_list, verbose=verbose)
185
def cmd_inventory(revision=None):
186
"""Show inventory of the current working copy."""
187
## TODO: Also optionally show a previous inventory
188
## TODO: Format options
767
191
inv = b.read_working_inventory()
768
sc = statcache.update_cache(b, inv)
769
basis = b.basis_tree()
770
basis_inv = basis.inventory
772
# We used to do this through iter_entries(), but that's slow
773
# when most of the files are unmodified, as is usually the
774
# case. So instead we iterate by inventory entry, and only
775
# calculate paths as necessary.
777
for file_id in basis_inv:
778
cacheentry = sc.get(file_id)
779
if not cacheentry: # deleted
781
ie = basis_inv[file_id]
782
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
783
path = inv.id2path(file_id)
788
class cmd_added(Command):
789
"""List files added in working tree."""
793
wt = b.working_tree()
794
basis_inv = b.basis_tree().inventory
797
if file_id in basis_inv:
799
path = inv.id2path(file_id)
800
if not os.access(b.abspath(path), os.F_OK):
806
class cmd_root(Command):
807
"""Show the tree root directory.
809
The root is the nearest enclosing directory with a .bzr control
811
takes_args = ['filename?']
812
def run(self, filename=None):
813
"""Print the branch root."""
814
from branch import find_branch
815
b = find_branch(filename)
816
print getattr(b, 'base', None) or getattr(b, 'baseurl')
819
class cmd_log(Command):
193
inv = b.get_revision_inventory(b.lookup_revision(revision))
195
for path, entry in inv.iter_entries():
196
print '%-50s %s' % (entry.file_id, path)
202
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
203
print 'revision number:', b.revno()
204
print 'number of versioned files:', len(b.read_working_inventory())
207
def cmd_remove(file_list, verbose=False):
208
Branch('.').remove(file_list, verbose=verbose)
212
def cmd_file_id(filename):
213
i = Branch('.').read_working_inventory().path2id(filename)
215
bailout("%s is not a versioned file" % filename)
220
def cmd_find_filename(fileid):
221
n = find_filename(fileid)
223
bailout("%s is not a live file id" % fileid)
228
def cmd_revision_history():
229
for patchid in Branch('.').revision_history():
235
# TODO: Check we're not already in a working directory? At the
236
# moment you'll get an ugly error.
238
# TODO: What if we're in a subdirectory of a branch? Would like
239
# to allow that, but then the parent may need to understand that
240
# the children have disappeared, or should they be versioned in
243
# TODO: Take an argument/option for branch name.
244
Branch('.', init=True)
247
def cmd_diff(revision=None):
248
"""Show diff from basis to working copy.
250
:todo: Take one or two revision arguments, look up those trees,
253
:todo: Allow diff across branches.
255
:todo: Mangle filenames in diff to be more relevant.
257
:todo: Shouldn't be in the cmd function.
263
old_tree = b.basis_tree()
265
old_tree = b.revision_tree(b.lookup_revision(revision))
267
new_tree = b.working_tree()
268
old_inv = old_tree.inventory
269
new_inv = new_tree.inventory
271
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
275
DEVNULL = '/dev/null'
276
# Windows users, don't panic about this filename -- it is a
277
# special signal to GNU patch that the file should be created or
278
# deleted respectively.
280
# TODO: Generation of pseudo-diffs for added/deleted files could
281
# be usefully made into a much faster special case.
283
# TODO: Better to return them in sorted order I think.
285
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
288
# Don't show this by default; maybe do it if an option is passed
289
# idlabel = ' {%s}' % fid
292
# FIXME: Something about the diff format makes patch unhappy
293
# with newly-added files.
295
def diffit(*a, **kw):
296
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
299
if file_state in ['.', '?', 'I']:
301
elif file_state == 'A':
302
print '*** added %s %r' % (kind, new_name)
305
new_tree.get_file(fid).readlines(),
307
tofile=new_label + new_name + idlabel)
308
elif file_state == 'D':
309
assert isinstance(old_name, types.StringTypes)
310
print '*** deleted %s %r' % (kind, old_name)
312
diffit(old_tree.get_file(fid).readlines(), [],
313
fromfile=old_label + old_name + idlabel,
315
elif file_state in ['M', 'R']:
316
if file_state == 'M':
317
assert kind == 'file'
318
assert old_name == new_name
319
print '*** modified %s %r' % (kind, new_name)
320
elif file_state == 'R':
321
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
324
diffit(old_tree.get_file(fid).readlines(),
325
new_tree.get_file(fid).readlines(),
326
fromfile=old_label + old_name + idlabel,
327
tofile=new_label + new_name)
329
bailout("can't represent state %s {%s}" % (file_state, fid))
820
334
"""Show log of this branch.
822
To request a range of logs, you can use the command -r begin:end
823
-r revision requests a specific revision, -r :end or -r begin: are
826
TODO: Make --revision support uuid: and hash: [future tag:] notation.
336
:todo: Options for utc; to show ids; to limit range; etc.
830
takes_args = ['filename?']
831
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
833
def run(self, filename=None, timezone='original',
838
from bzrlib import show_log, find_branch
841
direction = (forward and 'forward') or 'reverse'
844
b = find_branch(filename)
845
fp = b.relpath(filename)
847
file_id = b.read_working_inventory().path2id(fp)
849
file_id = None # points to branch root
855
revision = [None, None]
856
elif isinstance(revision, int):
857
revision = [revision, revision]
862
assert len(revision) == 2
864
mutter('encoding log as %r' % bzrlib.user_encoding)
866
# use 'replace' so that we don't abort if trying to write out
867
# in e.g. the default C locale.
868
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
871
show_timezone=timezone,
876
start_revision=revision[0],
877
end_revision=revision[1])
881
class cmd_touching_revisions(Command):
882
"""Return revision-ids which affected a particular file.
884
A more user-friendly interface is "bzr log FILE"."""
886
takes_args = ["filename"]
887
def run(self, filename):
889
inv = b.read_working_inventory()
890
file_id = inv.path2id(b.relpath(filename))
891
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
892
print "%6d %s" % (revno, what)
895
class cmd_ls(Command):
338
Branch('.').write_log()
341
def cmd_ls(revision=None, verbose=False):
896
342
"""List files in a tree.
898
TODO: Take a revision or remote path and list that tree instead.
344
:todo: Take a revision or remote path and list that tree instead.
901
def run(self, revision=None, verbose=False):
904
tree = b.working_tree()
906
tree = b.revision_tree(b.lookup_revision(revision))
908
for fp, fc, kind, fid in tree.list_files():
910
if kind == 'directory':
917
print '%-8s %s%s' % (fc, fp, kindch)
348
tree = b.working_tree()
350
tree = b.revision_tree(b.lookup_revision(revision))
352
for fp, fc, kind, fid in tree.list_files():
354
if kind == 'directory':
923
class cmd_unknowns(Command):
924
"""List unknown files."""
926
for f in Branch('.').unknowns():
931
class cmd_ignore(Command):
932
"""Ignore a command or pattern.
934
To remove patterns from the ignore list, edit the .bzrignore file.
936
If the pattern contains a slash, it is compared to the whole path
937
from the branch root. Otherwise, it is comapred to only the last
938
component of the path.
940
Ignore patterns are case-insensitive on case-insensitive systems.
942
Note: wildcards must be quoted from the shell on Unix.
945
bzr ignore ./Makefile
948
takes_args = ['name_pattern']
950
def run(self, name_pattern):
951
from bzrlib.atomicfile import AtomicFile
955
ifn = b.abspath('.bzrignore')
957
if os.path.exists(ifn):
960
igns = f.read().decode('utf-8')
966
# TODO: If the file already uses crlf-style termination, maybe
967
# we should use that for the newly added lines?
969
if igns and igns[-1] != '\n':
971
igns += name_pattern + '\n'
974
f = AtomicFile(ifn, 'wt')
975
f.write(igns.encode('utf-8'))
980
inv = b.working_tree().inventory
981
if inv.path2id('.bzrignore'):
982
mutter('.bzrignore is already versioned')
984
mutter('need to make new .bzrignore file versioned')
985
b.add(['.bzrignore'])
989
class cmd_ignored(Command):
990
"""List ignored files and the patterns that matched them.
992
See also: bzr ignore"""
994
tree = Branch('.').working_tree()
995
for path, file_class, kind, file_id in tree.list_files():
996
if file_class != 'I':
998
## XXX: Slightly inefficient since this was already calculated
999
pat = tree.is_ignored(path)
1000
print '%-50s %s' % (path, pat)
1003
class cmd_lookup_revision(Command):
1004
"""Lookup the revision-id from a revision-number
1007
bzr lookup-revision 33
1010
takes_args = ['revno']
1012
def run(self, revno):
1016
raise BzrCommandError("not a valid revision-number: %r" % revno)
1018
print Branch('.').lookup_revision(revno)
1021
class cmd_export(Command):
1022
"""Export past revision to destination directory.
1024
If no revision is specified this exports the last committed revision."""
1025
takes_args = ['dest']
1026
takes_options = ['revision']
1027
def run(self, dest, revision=None):
1029
if revision == None:
1030
rh = b.revision_history()[-1]
1032
rh = b.lookup_revision(int(revision))
1033
t = b.revision_tree(rh)
1037
class cmd_cat(Command):
1038
"""Write a file's text from a previous revision."""
1040
takes_options = ['revision']
1041
takes_args = ['filename']
1043
def run(self, filename, revision=None):
1044
if revision == None:
1045
raise BzrCommandError("bzr cat requires a revision number")
1047
b.print_file(b.relpath(filename), int(revision))
1050
class cmd_local_time_offset(Command):
1051
"""Show the offset in seconds from GMT to local time."""
1054
print bzrlib.osutils.local_time_offset()
1058
class cmd_commit(Command):
1059
"""Commit changes into a new revision.
1061
If selected files are specified, only changes to those files are
1062
committed. If a directory is specified then its contents are also
1065
A selected-file commit may fail in some cases where the committed
1066
tree would be invalid, such as trying to commit a file in a
1067
newly-added directory that is not itself committed.
1069
TODO: Run hooks on tree to-be-committed, and after commit.
1071
TODO: Strict commit that fails if there are unknown or deleted files.
1073
takes_args = ['selected*']
1074
takes_options = ['message', 'file', 'verbose']
1075
aliases = ['ci', 'checkin']
1077
def run(self, message=None, file=None, verbose=True, selected_list=None):
1078
from bzrlib.commit import commit
1080
## Warning: shadows builtin file()
1081
if not message and not file:
1082
raise BzrCommandError("please specify a commit message",
1083
["use either --message or --file"])
1084
elif message and file:
1085
raise BzrCommandError("please specify either --message or --file")
361
print '%-8s %s%s' % (fc, fp, kindch)
368
"""List unknown files"""
369
for f in Branch('.').unknowns():
373
def cmd_lookup_revision(revno):
377
bailout("usage: lookup-revision REVNO",
378
["REVNO is a non-negative revision number for this branch"])
380
print Branch('.').lookup_revision(revno) or NONE_STRING
384
def cmd_export(revno, dest):
385
"""Export past revision to destination directory."""
387
rh = b.lookup_revision(int(revno))
388
t = b.revision_tree(rh)
393
######################################################################
394
# internal/test commands
398
"""Print a newly-generated UUID."""
403
def cmd_commit(message, verbose=False):
404
Branch('.').commit(message, verbose=verbose)
408
"""Check consistency of the branch."""
412
def cmd_is(pred, *rest):
413
"""Test whether PREDICATE is true."""
415
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
417
bailout("unknown predicate: %s" % quotefn(pred))
1089
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1092
commit(b, message, verbose=verbose, specific_files=selected_list)
1095
class cmd_check(Command):
1096
"""Validate consistency of branch history.
1098
This command checks various invariants about the branch storage to
1099
detect data corruption or bzr bugs.
1101
takes_args = ['dir?']
1102
def run(self, dir='.'):
1104
bzrlib.check.check(Branch(dir))
1108
class cmd_whoami(Command):
1109
"""Show bzr user id."""
1110
takes_options = ['email']
421
except BzrCheckError:
422
# by default we don't print the message so that this can
423
# be used from shell scripts without producing noise
428
print bzrlib.osutils.username()
431
def cmd_user_email():
432
print bzrlib.osutils.user_email()
435
def cmd_gen_revision_id():
437
print bzrlib.branch._gen_revision_id(time.time())
441
"""Run internal doctest suite"""
442
## -v, if present, is seen by doctest; the argument is just here
443
## so our parser doesn't complain
445
## TODO: --verbose option
1112
def run(self, email=False):
1114
print bzrlib.osutils.user_email()
1116
print bzrlib.osutils.username()
1119
class cmd_selftest(Command):
1120
"""Run internal test suite"""
1123
from bzrlib.selftest import selftest
1131
class cmd_version(Command):
1132
"""Show version of bzr."""
1137
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1138
# is bzrlib itself in a branch?
1139
bzrrev = bzrlib.get_bzr_revision()
1141
print " (bzr checkout, revision %d {%s})" % bzrrev
1142
print bzrlib.__copyright__
447
import bzr, doctest, bzrlib.store
448
bzrlib.trace.verbose = False
450
doctest.testmod(bzrlib.store)
451
doctest.testmod(bzrlib.inventory)
452
doctest.testmod(bzrlib.branch)
453
doctest.testmod(bzrlib.osutils)
454
doctest.testmod(bzrlib.tree)
456
# more strenuous tests;
458
doctest.testmod(bzrlib.tests)
461
######################################################################
466
# TODO: Specific help for particular commands
471
print "bzr (bazaar-ng) %s" % __version__
1143
473
print "http://bazaar-ng.org/"
1145
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1146
print "you may use, modify and redistribute it under the terms of the GNU"
1147
print "General Public License version 2 or later."
1150
class cmd_rocks(Command):
476
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
477
you may use, modify and redistribute it under the terms of the GNU
478
General Public License version 2 or later."""
1151
482
"""Statement of optimism."""
1154
print "it sure does!"
1156
def parse_spec(spec):
1158
>>> parse_spec(None)
1160
>>> parse_spec("./")
1162
>>> parse_spec("../@")
1164
>>> parse_spec("../f/@35")
1170
parsed = spec.split('/@')
1171
assert len(parsed) == 2
1175
parsed[1] = int(parsed[1])
1176
assert parsed[1] >=0
1178
parsed = [spec, None]
1183
class cmd_merge(Command):
1184
"""Perform a three-way merge of trees.
1186
The SPEC parameters are working tree or revision specifiers. Working trees
1187
are specified using standard paths or urls. No component of a directory
1188
path may begin with '@'.
1190
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1192
Revisions are specified using a dirname/@revno pair, where dirname is the
1193
branch directory and revno is the revision within that branch. If no revno
1194
is specified, the latest revision is used.
1196
Revision examples: './@127', 'foo/@', '../@1'
1198
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1199
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1202
merge refuses to run if there are any uncommitted changes, unless
1205
takes_args = ['other_spec', 'base_spec?']
1206
takes_options = ['force']
1208
def run(self, other_spec, base_spec=None, force=False):
1209
from bzrlib.merge import merge
1210
merge(parse_spec(other_spec), parse_spec(base_spec),
1211
check_clean=(not force))
1214
class cmd_revert(Command):
1215
"""Reverse all changes since the last commit.
1217
Only versioned files are affected.
1219
TODO: Store backups of any files that will be reverted, so
1220
that the revert can be undone.
1222
takes_options = ['revision']
1224
def run(self, revision=-1):
1225
from bzrlib.merge import merge
1226
merge(('.', revision), parse_spec('.'),
1231
class cmd_assert_fail(Command):
1232
"""Test reporting of assertion failures"""
1235
assert False, "always fails"
1238
class cmd_help(Command):
1239
"""Show help on a command or other topic.
1241
For a list of all available commands, say 'bzr help commands'."""
1242
takes_args = ['topic?']
1245
def run(self, topic=None):
1250
class cmd_update_stat_cache(Command):
1251
"""Update stat-cache mapping inodes to SHA-1 hashes.
1253
For testing only."""
1258
statcache.update_cache(b.base, b.read_working_inventory())
483
print "it sure does!"
487
######################################################################
1262
491
# list of all available options; the rhs can be either None for an