19
14
# along with this program; if not, write to the Free Software
20
15
# 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
# Show some information about this branch.
71
__copyright__ = "Copyright 2005 Canonical Development Ltd."
72
__author__ = "Martin Pool <mbp@canonical.com>"
73
__docformat__ = "restructuredtext en"
77
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
78
import traceback, socket, fnmatch, difflib
81
from pprint import pprint
86
from bzrlib.store import ImmutableStore
87
from bzrlib.trace import mutter, note, log_error
88
from bzrlib.errors import bailout, BzrError
89
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
90
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
91
from bzrlib.revision import Revision
92
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
95
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
96
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
98
## standard representation
99
NONE_STRING = '(none)'
103
## TODO: Perhaps a different version of inventory commands that
104
## returns iterators...
106
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
108
## TODO: Some kind of locking on branches. Perhaps there should be a
109
## parameter to the branch object saying whether we want a read or
110
## write lock; release it from destructor. Perhaps don't even need a
111
## read lock to look at immutable objects?
113
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
114
## to compare output?
116
## TODO: Some kind of global code to generate the right Branch object
117
## to work on. Almost, but not quite all, commands need one, and it
118
## can be taken either from their parameters or their working
121
## TODO: rename command, needed soon: check destination doesn't exist
122
## either in working copy or tree; move working copy; update
123
## inventory; write out
125
## TODO: move command; check destination is a directory and will not
128
## TODO: command to show renames, one per line, as to->from
133
def cmd_status(all=False):
22
from bzrlib.trace import mutter, note, log_error, warning
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.branch import find_branch
25
from bzrlib import BZRDIR
31
def register_command(cmd):
32
"Utility function to help register a command"
35
if k.startswith("cmd_"):
36
k_unsquished = _unsquish_command_name(k)
39
if not plugin_cmds.has_key(k_unsquished):
40
plugin_cmds[k_unsquished] = cmd
42
log_error('Two plugins defined the same command: %r' % k)
43
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
46
def _squish_command_name(cmd):
47
return 'cmd_' + cmd.replace('-', '_')
50
def _unsquish_command_name(cmd):
51
assert cmd.startswith("cmd_")
52
return cmd[4:].replace('_','-')
55
def _parse_revision_str(revstr):
56
"""This handles a revision string -> revno.
58
This always returns a list. The list will have one element for
60
It supports integers directly, but everything else it
61
defers for passing to Branch.get_revision_info()
63
>>> _parse_revision_str('234')
65
>>> _parse_revision_str('234..567')
67
>>> _parse_revision_str('..')
69
>>> _parse_revision_str('..234')
71
>>> _parse_revision_str('234..')
73
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
75
>>> _parse_revision_str('234....789') # Error?
77
>>> _parse_revision_str('revid:test@other.com-234234')
78
['revid:test@other.com-234234']
79
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
80
['revid:test@other.com-234234', 'revid:test@other.com-234235']
81
>>> _parse_revision_str('revid:test@other.com-234234..23')
82
['revid:test@other.com-234234', 23]
83
>>> _parse_revision_str('date:2005-04-12')
85
>>> _parse_revision_str('date:2005-04-12 12:24:33')
86
['date:2005-04-12 12:24:33']
87
>>> _parse_revision_str('date:2005-04-12T12:24:33')
88
['date:2005-04-12T12:24:33']
89
>>> _parse_revision_str('date:2005-04-12,12:24:33')
90
['date:2005-04-12,12:24:33']
91
>>> _parse_revision_str('-5..23')
93
>>> _parse_revision_str('-5')
95
>>> _parse_revision_str('123a')
97
>>> _parse_revision_str('abc')
101
old_format_re = re.compile('\d*:\d*')
102
m = old_format_re.match(revstr)
104
warning('Colon separator for revision numbers is deprecated.'
107
for rev in revstr.split(':'):
109
revs.append(int(rev))
114
for x in revstr.split('..'):
126
def _get_cmd_dict(plugins_override=True):
128
for k, v in globals().iteritems():
129
if k.startswith("cmd_"):
130
d[_unsquish_command_name(k)] = v
131
# If we didn't load plugins, the plugin_cmds dict will be empty
133
d.update(plugin_cmds)
135
d2 = plugin_cmds.copy()
141
def get_all_cmds(plugins_override=True):
142
"""Return canonical name and class for all registered commands."""
143
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
147
def get_cmd_class(cmd, plugins_override=True):
148
"""Return the canonical name and command class for a command.
150
cmd = str(cmd) # not unicode
152
# first look up this command under the specified name
153
cmds = _get_cmd_dict(plugins_override=plugins_override)
155
return cmd, cmds[cmd]
159
# look for any command which claims this as an alias
160
for cmdname, cmdclass in cmds.iteritems():
161
if cmd in cmdclass.aliases:
162
return cmdname, cmdclass
164
cmdclass = ExternalCommand.find_command(cmd)
168
raise BzrCommandError("unknown command %r" % cmd)
171
class Command(object):
172
"""Base class for commands.
174
The docstring for an actual command should give a single-line
175
summary, then a complete description of the command. A grammar
176
description will be inserted.
179
List of argument forms, marked with whether they are optional,
183
List of options that may be given for this command.
186
If true, this command isn't advertised.
195
def __init__(self, options, arguments):
196
"""Construct and run the command.
198
Sets self.status to the return value of run()."""
199
assert isinstance(options, dict)
200
assert isinstance(arguments, dict)
201
cmdargs = options.copy()
202
cmdargs.update(arguments)
203
assert self.__doc__ != Command.__doc__, \
204
("No help message set for %r" % self)
205
self.status = self.run(**cmdargs)
209
"""Override this in sub-classes.
211
This is invoked with the options and arguments bound to
214
Return 0 or None if the command was successful, or a shell
220
class ExternalCommand(Command):
221
"""Class to wrap external commands.
223
We cheat a little here, when get_cmd_class() calls us we actually give it back
224
an object we construct that has the appropriate path, help, options etc for the
227
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
228
method, which we override to call the Command.__init__ method. That then calls
229
our run method which is pretty straight forward.
231
The only wrinkle is that we have to map bzr's dictionary of options and arguments
232
back into command line options and arguments for the script.
235
def find_command(cls, cmd):
237
bzrpath = os.environ.get('BZRPATH', '')
239
for dir in bzrpath.split(os.pathsep):
240
path = os.path.join(dir, cmd)
241
if os.path.isfile(path):
242
return ExternalCommand(path)
246
find_command = classmethod(find_command)
248
def __init__(self, path):
251
pipe = os.popen('%s --bzr-usage' % path, 'r')
252
self.takes_options = pipe.readline().split()
254
for opt in self.takes_options:
255
if not opt in OPTIONS:
256
raise BzrError("Unknown option '%s' returned by external command %s"
259
# TODO: Is there any way to check takes_args is valid here?
260
self.takes_args = pipe.readline().split()
262
if pipe.close() is not None:
263
raise BzrError("Failed funning '%s --bzr-usage'" % path)
265
pipe = os.popen('%s --bzr-help' % path, 'r')
266
self.__doc__ = pipe.read()
267
if pipe.close() is not None:
268
raise BzrError("Failed funning '%s --bzr-help'" % path)
270
def __call__(self, options, arguments):
271
Command.__init__(self, options, arguments)
274
def run(self, **kargs):
281
optname = name.replace('_','-')
283
if OPTIONS.has_key(optname):
285
opts.append('--%s' % optname)
286
if value is not None and value is not True:
287
opts.append(str(value))
289
# it's an arg, or arg list
290
if type(value) is not list:
296
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
300
class cmd_status(Command):
134
301
"""Display status summary.
136
For each file there is a single line giving its file state and name.
137
The name is that in the current revision unless it is deleted or
138
missing, in which case the old name is shown.
140
:todo: Don't show unchanged files unless ``--all`` is given?
142
Branch('.').show_status(show_all=all)
146
######################################################################
148
def cmd_get_revision(revision_id):
149
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
152
def cmd_get_file_text(text_id):
153
"""Get contents of a file by hash."""
154
sf = Branch('.').text_store[text_id]
155
pumpfile(sf, sys.stdout)
159
######################################################################
164
"""Show number of revisions on this branch"""
165
print Branch('.').revno()
168
def cmd_add(file_list, verbose=False):
169
"""Add specified files.
171
Fails if the files are already added.
173
Branch('.').add(file_list, verbose=verbose)
176
def cmd_inventory(revision=None):
177
"""Show inventory of the current working copy."""
178
## TODO: Also optionally show a previous inventory
179
## TODO: Format options
303
This reports on versioned and unknown files, reporting them
304
grouped by state. Possible states are:
307
Versioned in the working copy but not in the previous revision.
310
Versioned in the previous revision but removed or deleted
314
Path of this file changed from the previous revision;
315
the text may also have changed. This includes files whose
316
parent directory was renamed.
319
Text has changed since the previous revision.
322
Nothing about this file has changed since the previous revision.
323
Only shown with --all.
326
Not versioned and not matching an ignore pattern.
328
To see ignored files use 'bzr ignored'. For details in the
329
changes to file texts, use 'bzr diff'.
331
If no arguments are specified, the status of the entire working
332
directory is shown. Otherwise, only the status of the specified
333
files or directories is reported. If a directory is given, status
334
is reported for everything inside that directory.
336
If a revision is specified, the changes since that revision are shown.
338
takes_args = ['file*']
339
takes_options = ['all', 'show-ids', 'revision']
340
aliases = ['st', 'stat']
342
def run(self, all=False, show_ids=False, file_list=None):
344
b = find_branch(file_list[0])
345
file_list = [b.relpath(x) for x in file_list]
346
# special case: only one path was given and it's the root
348
if file_list == ['']:
353
from bzrlib.status import show_status
354
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
from bzrlib.xml import pack_xml
366
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
369
class cmd_revno(Command):
370
"""Show current revision number.
372
This is equal to the number of revisions on this branch."""
374
print find_branch('.').revno()
376
class cmd_revision_info(Command):
377
"""Show revision number and revision id for a given revision identifier.
380
takes_args = ['revision_info*']
381
takes_options = ['revision']
382
def run(self, revision=None, revision_info_list=None):
383
from bzrlib.branch import find_branch
386
if revision is not None:
387
revs.extend(revision)
388
if revision_info_list is not None:
389
revs.extend(revision_info_list)
391
raise BzrCommandError('You must supply a revision identifier')
396
print '%4d %s' % b.get_revision_info(rev)
399
class cmd_add(Command):
400
"""Add specified files or directories.
402
In non-recursive mode, all the named items are added, regardless
403
of whether they were previously ignored. A warning is given if
404
any of the named files are already versioned.
406
In recursive mode (the default), files are treated the same way
407
but the behaviour for directories is different. Directories that
408
are already versioned do not give a warning. All directories,
409
whether already versioned or not, are searched for files or
410
subdirectories that are neither versioned or ignored, and these
411
are added. This search proceeds recursively into versioned
414
Therefore simply saying 'bzr add .' will version all files that
415
are currently unknown.
417
TODO: Perhaps adding a file whose directly is not versioned should
418
recursively add that parent, rather than giving an error?
420
takes_args = ['file+']
421
takes_options = ['verbose', 'no-recurse']
423
def run(self, file_list, verbose=False, no_recurse=False):
424
from bzrlib.add import smart_add
425
smart_add(file_list, verbose, not no_recurse)
429
class cmd_mkdir(Command):
430
"""Create a new versioned directory.
432
This is equivalent to creating the directory and then adding it.
434
takes_args = ['dir+']
436
def run(self, dir_list):
443
b.add([d], verbose=True)
446
class cmd_relpath(Command):
447
"""Show path of a file relative to root"""
448
takes_args = ['filename']
451
def run(self, filename):
452
print find_branch(filename).relpath(filename)
456
class cmd_inventory(Command):
457
"""Show inventory of the current working copy or a revision."""
458
takes_options = ['revision', 'show-ids']
460
def run(self, revision=None, show_ids=False):
463
inv = b.read_working_inventory()
465
if len(revision) > 1:
466
raise BzrCommandError('bzr inventory --revision takes'
467
' exactly one revision identifier')
468
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
470
for path, entry in inv.entries():
472
print '%-50s %s' % (path, entry.file_id)
477
class cmd_move(Command):
478
"""Move files to a different directory.
483
The destination must be a versioned directory in the same branch.
485
takes_args = ['source$', 'dest']
486
def run(self, source_list, dest):
489
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
492
class cmd_rename(Command):
493
"""Change the name of an entry.
496
bzr rename frob.c frobber.c
497
bzr rename src/frob.c lib/frob.c
499
It is an error if the destination name exists.
501
See also the 'move' command, which moves files into a different
502
directory without changing their name.
504
TODO: Some way to rename multiple files without invoking bzr for each
506
takes_args = ['from_name', 'to_name']
508
def run(self, from_name, to_name):
510
b.rename_one(b.relpath(from_name), b.relpath(to_name))
516
class cmd_pull(Command):
517
"""Pull any changes from another branch into the current one.
519
If the location is omitted, the last-used location will be used.
520
Both the revision history and the working directory will be
523
This command only works on branches that have not diverged. Branches are
524
considered diverged if both branches have had commits without first
525
pulling from the other.
527
If branches have diverged, you can use 'bzr merge' to pull the text changes
528
from one into the other.
530
takes_args = ['location?']
532
def run(self, location=None):
533
from bzrlib.merge import merge
535
from shutil import rmtree
538
br_to = find_branch('.')
541
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
543
if e.errno != errno.ENOENT:
546
if stored_loc is None:
547
raise BzrCommandError("No pull location known or specified.")
549
print "Using last location: %s" % stored_loc
550
location = stored_loc
551
cache_root = tempfile.mkdtemp()
552
from bzrlib.branch import DivergedBranches
553
br_from = find_branch(location)
554
location = pull_loc(br_from)
555
old_revno = br_to.revno()
557
from branch import find_cached_branch, DivergedBranches
558
br_from = find_cached_branch(location, cache_root)
559
location = pull_loc(br_from)
560
old_revno = br_to.revno()
562
br_to.update_revisions(br_from)
563
except DivergedBranches:
564
raise BzrCommandError("These branches have diverged."
567
merge(('.', -1), ('.', old_revno), check_clean=False)
568
if location != stored_loc:
569
br_to.controlfile("x-pull", "wb").write(location + "\n")
575
class cmd_branch(Command):
576
"""Create a new copy of a branch.
578
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
579
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
581
To retrieve the branch as of a particular revision, supply the --revision
582
parameter, as in "branch foo/bar -r 5".
584
takes_args = ['from_location', 'to_location?']
585
takes_options = ['revision']
587
def run(self, from_location, to_location=None, revision=None):
589
from bzrlib.merge import merge
590
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
591
find_cached_branch, Branch
592
from shutil import rmtree
593
from meta_store import CachedStore
595
cache_root = tempfile.mkdtemp()
597
if revision is not None:
598
if len(revision) > 1:
599
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
604
br_from = find_cached_branch(from_location, cache_root)
606
if e.errno == errno.ENOENT:
607
raise BzrCommandError('Source location "%s" does not'
608
' exist.' % to_location)
612
if to_location is None:
613
to_location = os.path.basename(from_location.rstrip("/\\"))
616
os.mkdir(to_location)
618
if e.errno == errno.EEXIST:
619
raise BzrCommandError('Target directory "%s" already'
620
' exists.' % to_location)
621
if e.errno == errno.ENOENT:
622
raise BzrCommandError('Parent of "%s" does not exist.' %
626
br_to = Branch(to_location, init=True)
628
br_to.set_root_id(br_from.get_root_id())
631
revno = br_to.lookup_revision(revision[0])
633
br_to.update_revisions(br_from, stop_revision=revno)
634
except NoSuchRevision:
636
msg = "The branch %s has no revision %d." % (from_location,
638
raise BzrCommandError(msg)
640
merge((to_location, -1), (to_location, 0), this_dir=to_location,
641
check_clean=False, ignore_zero=True)
642
from_location = pull_loc(br_from)
643
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
648
def pull_loc(branch):
649
# TODO: Should perhaps just make attribute be 'base' in
650
# RemoteBranch and Branch?
651
if hasattr(branch, "baseurl"):
652
return branch.baseurl
658
class cmd_renames(Command):
659
"""Show list of renamed files.
661
TODO: Option to show renames between two historical versions.
663
TODO: Only show renames under dir, rather than in the whole branch.
665
takes_args = ['dir?']
667
def run(self, dir='.'):
669
old_inv = b.basis_tree().inventory
670
new_inv = b.read_working_inventory()
672
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
674
for old_name, new_name in renames:
675
print "%s => %s" % (old_name, new_name)
678
class cmd_info(Command):
679
"""Show statistical information about a branch."""
680
takes_args = ['branch?']
682
def run(self, branch=None):
685
b = find_branch(branch)
689
class cmd_remove(Command):
690
"""Make a file unversioned.
692
This makes bzr stop tracking changes to a versioned file. It does
693
not delete the working copy.
695
takes_args = ['file+']
696
takes_options = ['verbose']
698
def run(self, file_list, verbose=False):
699
b = find_branch(file_list[0])
700
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
703
class cmd_file_id(Command):
704
"""Print file_id of a particular file or directory.
706
The file_id is assigned when the file is first added and remains the
707
same through all revisions where the file exists, even when it is
711
takes_args = ['filename']
712
def run(self, filename):
713
b = find_branch(filename)
714
i = b.inventory.path2id(b.relpath(filename))
716
raise BzrError("%r is not a versioned file" % filename)
721
class cmd_file_path(Command):
722
"""Print path of file_ids to a file or directory.
724
This prints one line for each directory down to the target,
725
starting at the branch root."""
727
takes_args = ['filename']
728
def run(self, filename):
729
b = find_branch(filename)
731
fid = inv.path2id(b.relpath(filename))
733
raise BzrError("%r is not a versioned file" % filename)
734
for fip in inv.get_idpath(fid):
738
class cmd_revision_history(Command):
739
"""Display list of revision ids on this branch."""
742
for patchid in find_branch('.').revision_history():
746
class cmd_directories(Command):
747
"""Display list of versioned directories in this branch."""
749
for name, ie in find_branch('.').read_working_inventory().directories():
756
class cmd_init(Command):
757
"""Make a directory into a versioned branch.
759
Use this to create an empty branch, or before importing an
762
Recipe for importing a tree of files:
767
bzr commit -m 'imported project'
770
from bzrlib.branch import Branch
771
Branch('.', init=True)
774
class cmd_diff(Command):
775
"""Show differences in working tree.
777
If files are listed, only the changes in those files are listed.
778
Otherwise, all changes for the tree are listed.
780
TODO: Given two revision arguments, show the difference between them.
782
TODO: Allow diff across branches.
784
TODO: Option to use external diff command; could be GNU diff, wdiff,
787
TODO: Python difflib is not exactly the same as unidiff; should
788
either fix it up or prefer to use an external diff.
790
TODO: If a directory is given, diff everything under that.
792
TODO: Selected-file diff is inefficient and doesn't show you
795
TODO: This probably handles non-Unix newlines poorly.
798
takes_args = ['file*']
799
takes_options = ['revision', 'diff-options']
800
aliases = ['di', 'dif']
802
def run(self, revision=None, file_list=None, diff_options=None):
803
from bzrlib.diff import show_diff
806
b = find_branch(file_list[0])
807
file_list = [b.relpath(f) for f in file_list]
808
if file_list == ['']:
809
# just pointing to top-of-tree
814
# TODO: Make show_diff support taking 2 arguments
816
if revision is not None:
817
if len(revision) != 1:
818
raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
819
base_rev = revision[0]
821
show_diff(b, base_rev, specific_files=file_list,
822
external_diff_options=diff_options)
828
class cmd_deleted(Command):
829
"""List files deleted in the working tree.
831
TODO: Show files deleted since a previous revision, or between two revisions.
833
def run(self, show_ids=False):
836
new = b.working_tree()
838
## TODO: Much more efficient way to do this: read in new
839
## directories with readdir, rather than stating each one. Same
840
## level of effort but possibly much less IO. (Or possibly not,
841
## if the directories are very large...)
843
for path, ie in old.inventory.iter_entries():
844
if not new.has_id(ie.file_id):
846
print '%-50s %s' % (path, ie.file_id)
851
class cmd_modified(Command):
852
"""List files modified in working tree."""
855
from bzrlib.diff import compare_trees
858
td = compare_trees(b.basis_tree(), b.working_tree())
860
for path, id, kind in td.modified:
865
class cmd_added(Command):
866
"""List files added in working tree."""
870
wt = b.working_tree()
871
basis_inv = b.basis_tree().inventory
874
if file_id in basis_inv:
876
path = inv.id2path(file_id)
877
if not os.access(b.abspath(path), os.F_OK):
883
class cmd_root(Command):
884
"""Show the tree root directory.
886
The root is the nearest enclosing directory with a .bzr control
888
takes_args = ['filename?']
889
def run(self, filename=None):
890
"""Print the branch root."""
891
b = find_branch(filename)
892
print getattr(b, 'base', None) or getattr(b, 'baseurl')
895
class cmd_log(Command):
896
"""Show log of this branch.
898
To request a range of logs, you can use the command -r begin:end
899
-r revision requests a specific revision, -r :end or -r begin: are
902
--message allows you to give a regular expression, which will be evaluated
903
so that only matching entries will be displayed.
905
TODO: Make --revision support uuid: and hash: [future tag:] notation.
909
takes_args = ['filename?']
910
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
912
def run(self, filename=None, timezone='original',
919
from bzrlib.branch import find_branch
920
from bzrlib.log import log_formatter, show_log
923
direction = (forward and 'forward') or 'reverse'
926
b = find_branch(filename)
927
fp = b.relpath(filename)
929
file_id = b.read_working_inventory().path2id(fp)
931
file_id = None # points to branch root
939
elif len(revision) == 1:
940
rev1 = rev2 = b.get_revision_info(revision[0])[0]
941
elif len(revision) == 2:
942
rev1 = b.get_revision_info(revision[0])[0]
943
rev2 = b.get_revision_info(revision[1])[0]
945
raise BzrCommandError('bzr log --revision takes one or two values.')
952
mutter('encoding log as %r' % bzrlib.user_encoding)
954
# use 'replace' so that we don't abort if trying to write out
955
# in e.g. the default C locale.
956
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
962
lf = log_formatter(log_format,
965
show_timezone=timezone)
978
class cmd_touching_revisions(Command):
979
"""Return revision-ids which affected a particular file.
981
A more user-friendly interface is "bzr log FILE"."""
983
takes_args = ["filename"]
984
def run(self, filename):
985
b = find_branch(filename)
182
986
inv = b.read_working_inventory()
184
inv = b.get_revision_inventory(b.lookup_revision(revision))
186
for path, entry in inv.iter_entries():
187
print '%-50s %s' % (entry.file_id, path)
193
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
195
def plural(n, base='', pl=None):
203
count_version_dirs = 0
205
count_status = {'A': 0, 'D': 0, 'M': 0, 'R': 0, '?': 0, 'I': 0, '.': 0}
206
for st_tup in bzrlib.diff_trees(b.basis_tree(), b.working_tree()):
208
count_status[fs] += 1
209
if fs not in ['I', '?'] and st_tup[4] == 'directory':
210
count_version_dirs += 1
213
print 'in the working tree:'
214
for name, fs in (('unchanged', '.'),
215
('modified', 'M'), ('added', 'A'), ('removed', 'D'),
216
('renamed', 'R'), ('unknown', '?'), ('ignored', 'I'),
218
print ' %5d %s' % (count_status[fs], name)
219
print ' %5d versioned subdirector%s' % (count_version_dirs,
220
plural(count_version_dirs, 'y', 'ies'))
223
print 'branch history:'
224
history = b.revision_history()
226
print ' %5d revision%s' % (revno, plural(revno))
229
committers.add(b.get_revision(rev).committer)
230
print ' %5d committer%s' % (len(committers), plural(len(committers)))
232
firstrev = b.get_revision(history[0])
233
age = int((time.time() - firstrev.timestamp) / 3600 / 24)
234
print ' %5d day%s old' % (age, plural(age))
235
print ' first revision: %s' % format_date(firstrev.timestamp,
238
lastrev = b.get_revision(history[-1])
239
print ' latest revision: %s' % format_date(lastrev.timestamp,
245
def cmd_remove(file_list, verbose=False):
246
Branch('.').remove(file_list, verbose=verbose)
250
def cmd_file_id(filename):
251
i = Branch('.').read_working_inventory().path2id(filename)
253
bailout("%s is not a versioned file" % filename)
258
def cmd_find_filename(fileid):
259
n = find_filename(fileid)
261
bailout("%s is not a live file id" % fileid)
266
def cmd_revision_history():
267
for patchid in Branch('.').revision_history():
273
# TODO: Check we're not already in a working directory? At the
274
# moment you'll get an ugly error.
276
# TODO: What if we're in a subdirectory of a branch? Would like
277
# to allow that, but then the parent may need to understand that
278
# the children have disappeared, or should they be versioned in
281
# TODO: Take an argument/option for branch name.
282
Branch('.', init=True)
285
def cmd_diff(revision=None):
286
"""Show diff from basis to working copy.
288
:todo: Take one or two revision arguments, look up those trees,
291
:todo: Allow diff across branches.
293
:todo: Mangle filenames in diff to be more relevant.
295
:todo: Shouldn't be in the cmd function.
301
old_tree = b.basis_tree()
303
old_tree = b.revision_tree(b.lookup_revision(revision))
305
new_tree = b.working_tree()
306
old_inv = old_tree.inventory
307
new_inv = new_tree.inventory
309
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
313
DEVNULL = '/dev/null'
314
# Windows users, don't panic about this filename -- it is a
315
# special signal to GNU patch that the file should be created or
316
# deleted respectively.
318
# TODO: Generation of pseudo-diffs for added/deleted files could
319
# be usefully made into a much faster special case.
321
# TODO: Better to return them in sorted order I think.
323
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
326
# Don't show this by default; maybe do it if an option is passed
327
# idlabel = ' {%s}' % fid
330
# FIXME: Something about the diff format makes patch unhappy
331
# with newly-added files.
333
def diffit(*a, **kw):
334
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
337
if file_state in ['.', '?', 'I']:
339
elif file_state == 'A':
340
print '*** added %s %r' % (kind, new_name)
343
new_tree.get_file(fid).readlines(),
345
tofile=new_label + new_name + idlabel)
346
elif file_state == 'D':
347
assert isinstance(old_name, types.StringTypes)
348
print '*** deleted %s %r' % (kind, old_name)
350
diffit(old_tree.get_file(fid).readlines(), [],
351
fromfile=old_label + old_name + idlabel,
353
elif file_state in ['M', 'R']:
354
if file_state == 'M':
355
assert kind == 'file'
356
assert old_name == new_name
357
print '*** modified %s %r' % (kind, new_name)
358
elif file_state == 'R':
359
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
362
diffit(old_tree.get_file(fid).readlines(),
363
new_tree.get_file(fid).readlines(),
364
fromfile=old_label + old_name + idlabel,
365
tofile=new_label + new_name)
367
bailout("can't represent state %s {%s}" % (file_state, fid))
371
def cmd_log(timezone='original'):
372
"""Show log of this branch.
374
:todo: Options for utc; to show ids; to limit range; etc.
376
Branch('.').write_log(show_timezone=timezone)
379
def cmd_ls(revision=None, verbose=False):
987
file_id = inv.path2id(b.relpath(filename))
988
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
989
print "%6d %s" % (revno, what)
992
class cmd_ls(Command):
380
993
"""List files in a tree.
382
:todo: Take a revision or remote path and list that tree instead.
386
tree = b.working_tree()
388
tree = b.revision_tree(b.lookup_revision(revision))
390
for fp, fc, kind, fid in tree.list_files():
392
if kind == 'directory':
399
print '%-8s %s%s' % (fc, fp, kindch)
406
"""List unknown files"""
407
for f in Branch('.').unknowns():
411
def cmd_lookup_revision(revno):
415
bailout("usage: lookup-revision REVNO",
416
["REVNO is a non-negative revision number for this branch"])
418
print Branch('.').lookup_revision(revno) or NONE_STRING
422
def cmd_export(revno, dest):
423
"""Export past revision to destination directory."""
425
rh = b.lookup_revision(int(revno))
426
t = b.revision_tree(rh)
431
######################################################################
432
# internal/test commands
436
"""Print a newly-generated UUID."""
441
def cmd_local_time_offset():
442
print bzrlib.osutils.local_time_offset()
446
def cmd_commit(message, verbose=False):
447
Branch('.').commit(message, verbose=verbose)
451
"""Check consistency of the branch."""
455
def cmd_is(pred, *rest):
456
"""Test whether PREDICATE is true."""
458
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
460
bailout("unknown predicate: %s" % quotefn(pred))
464
except BzrCheckError:
465
# by default we don't print the message so that this can
466
# be used from shell scripts without producing noise
471
print bzrlib.osutils.username()
474
def cmd_user_email():
475
print bzrlib.osutils.user_email()
478
def cmd_gen_revision_id():
480
print bzrlib.branch._gen_revision_id(time.time())
484
"""Run internal doctest suite"""
485
## -v, if present, is seen by doctest; the argument is just here
486
## so our parser doesn't complain
488
## TODO: --verbose option
490
import bzr, doctest, bzrlib.store
491
bzrlib.trace.verbose = False
493
doctest.testmod(bzrlib.store)
494
doctest.testmod(bzrlib.inventory)
495
doctest.testmod(bzrlib.branch)
496
doctest.testmod(bzrlib.osutils)
497
doctest.testmod(bzrlib.tree)
499
# more strenuous tests;
501
doctest.testmod(bzrlib.tests)
504
######################################################################
509
# TODO: Specific help for particular commands
514
print "bzr (bazaar-ng) %s" % __version__
995
TODO: Take a revision or remote path and list that tree instead.
998
def run(self, revision=None, verbose=False):
1000
if revision == None:
1001
tree = b.working_tree()
1003
tree = b.revision_tree(b.lookup_revision(revision))
1005
for fp, fc, kind, fid in tree.list_files():
1007
if kind == 'directory':
1009
elif kind == 'file':
1014
print '%-8s %s%s' % (fc, fp, kindch)
1020
class cmd_unknowns(Command):
1021
"""List unknown files."""
1023
from bzrlib.osutils import quotefn
1024
for f in find_branch('.').unknowns():
1029
class cmd_ignore(Command):
1030
"""Ignore a command or pattern.
1032
To remove patterns from the ignore list, edit the .bzrignore file.
1034
If the pattern contains a slash, it is compared to the whole path
1035
from the branch root. Otherwise, it is comapred to only the last
1036
component of the path.
1038
Ignore patterns are case-insensitive on case-insensitive systems.
1040
Note: wildcards must be quoted from the shell on Unix.
1043
bzr ignore ./Makefile
1044
bzr ignore '*.class'
1046
takes_args = ['name_pattern']
1048
def run(self, name_pattern):
1049
from bzrlib.atomicfile import AtomicFile
1052
b = find_branch('.')
1053
ifn = b.abspath('.bzrignore')
1055
if os.path.exists(ifn):
1058
igns = f.read().decode('utf-8')
1064
# TODO: If the file already uses crlf-style termination, maybe
1065
# we should use that for the newly added lines?
1067
if igns and igns[-1] != '\n':
1069
igns += name_pattern + '\n'
1072
f = AtomicFile(ifn, 'wt')
1073
f.write(igns.encode('utf-8'))
1078
inv = b.working_tree().inventory
1079
if inv.path2id('.bzrignore'):
1080
mutter('.bzrignore is already versioned')
1082
mutter('need to make new .bzrignore file versioned')
1083
b.add(['.bzrignore'])
1087
class cmd_ignored(Command):
1088
"""List ignored files and the patterns that matched them.
1090
See also: bzr ignore"""
1092
tree = find_branch('.').working_tree()
1093
for path, file_class, kind, file_id in tree.list_files():
1094
if file_class != 'I':
1096
## XXX: Slightly inefficient since this was already calculated
1097
pat = tree.is_ignored(path)
1098
print '%-50s %s' % (path, pat)
1101
class cmd_lookup_revision(Command):
1102
"""Lookup the revision-id from a revision-number
1105
bzr lookup-revision 33
1108
takes_args = ['revno']
1110
def run(self, revno):
1114
raise BzrCommandError("not a valid revision-number: %r" % revno)
1116
print find_branch('.').lookup_revision(revno)
1119
class cmd_export(Command):
1120
"""Export past revision to destination directory.
1122
If no revision is specified this exports the last committed revision.
1124
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1125
given, try to find the format with the extension. If no extension
1126
is found exports to a directory (equivalent to --format=dir).
1128
Root may be the top directory for tar, tgz and tbz2 formats. If none
1129
is given, the top directory will be the root name of the file."""
1130
# TODO: list known exporters
1131
takes_args = ['dest']
1132
takes_options = ['revision', 'format', 'root']
1133
def run(self, dest, revision=None, format=None, root=None):
1135
b = find_branch('.')
1136
if revision is None:
1137
rev_id = b.last_patch()
1139
if len(revision) != 1:
1140
raise BzrError('bzr export --revision takes exactly 1 argument')
1141
revno, rev_id = b.get_revision_info(revision[0])
1142
t = b.revision_tree(rev_id)
1143
root, ext = os.path.splitext(dest)
1145
if ext in (".tar",):
1147
elif ext in (".gz", ".tgz"):
1149
elif ext in (".bz2", ".tbz2"):
1153
t.export(dest, format, root)
1156
class cmd_cat(Command):
1157
"""Write a file's text from a previous revision."""
1159
takes_options = ['revision']
1160
takes_args = ['filename']
1162
def run(self, filename, revision=None):
1163
if revision == None:
1164
raise BzrCommandError("bzr cat requires a revision number")
1165
elif len(revision) != 1:
1166
raise BzrCommandError("bzr cat --revision takes exactly one number")
1167
b = find_branch('.')
1168
b.print_file(b.relpath(filename), revision[0])
1171
class cmd_local_time_offset(Command):
1172
"""Show the offset in seconds from GMT to local time."""
1175
print bzrlib.osutils.local_time_offset()
1179
class cmd_commit(Command):
1180
"""Commit changes into a new revision.
1182
If selected files are specified, only changes to those files are
1183
committed. If a directory is specified then its contents are also
1186
A selected-file commit may fail in some cases where the committed
1187
tree would be invalid, such as trying to commit a file in a
1188
newly-added directory that is not itself committed.
1190
TODO: Run hooks on tree to-be-committed, and after commit.
1192
TODO: Strict commit that fails if there are unknown or deleted files.
1194
takes_args = ['selected*']
1195
takes_options = ['message', 'file', 'verbose', 'unchanged']
1196
aliases = ['ci', 'checkin']
1198
def run(self, message=None, file=None, verbose=True, selected_list=None,
1200
from bzrlib.errors import PointlessCommit
1201
from bzrlib.osutils import get_text_message
1203
## Warning: shadows builtin file()
1204
if not message and not file:
1207
catcher = cStringIO.StringIO()
1208
sys.stdout = catcher
1209
cmd_status({"file_list":selected_list}, {})
1210
info = catcher.getvalue()
1212
message = get_text_message(info)
1215
raise BzrCommandError("please specify a commit message",
1216
["use either --message or --file"])
1217
elif message and file:
1218
raise BzrCommandError("please specify either --message or --file")
1222
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1224
b = find_branch('.')
1227
b.commit(message, verbose=verbose,
1228
specific_files=selected_list,
1229
allow_pointless=unchanged)
1230
except PointlessCommit:
1231
# FIXME: This should really happen before the file is read in;
1232
# perhaps prepare the commit; get the message; then actually commit
1233
raise BzrCommandError("no changes to commit",
1234
["use --unchanged to commit anyhow"])
1237
class cmd_check(Command):
1238
"""Validate consistency of branch history.
1240
This command checks various invariants about the branch storage to
1241
detect data corruption or bzr bugs.
1243
If given the --update flag, it will update some optional fields
1244
to help ensure data consistency.
1246
takes_args = ['dir?']
1248
def run(self, dir='.'):
1249
from bzrlib.check import check
1250
check(find_branch(dir))
1254
class cmd_upgrade(Command):
1255
"""Upgrade branch storage to current format.
1257
This should normally be used only after the check command tells
1260
takes_args = ['dir?']
1262
def run(self, dir='.'):
1263
from bzrlib.upgrade import upgrade
1264
upgrade(find_branch(dir))
1268
class cmd_whoami(Command):
1269
"""Show bzr user id."""
1270
takes_options = ['email']
1272
def run(self, email=False):
1274
print bzrlib.osutils.user_email()
1276
print bzrlib.osutils.username()
1279
class cmd_selftest(Command):
1280
"""Run internal test suite"""
1283
from bzrlib.selftest import selftest
1284
return int(not selftest())
1287
class cmd_version(Command):
1288
"""Show version of bzr."""
1293
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1294
# is bzrlib itself in a branch?
1295
bzrrev = bzrlib.get_bzr_revision()
1297
print " (bzr checkout, revision %d {%s})" % bzrrev
1298
print bzrlib.__copyright__
516
1299
print "http://bazaar-ng.org/"
519
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
520
you may use, modify and redistribute it under the terms of the GNU
521
General Public License version 2 or later."""
1301
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1302
print "you may use, modify and redistribute it under the terms of the GNU"
1303
print "General Public License version 2 or later."
1306
class cmd_rocks(Command):
525
1307
"""Statement of optimism."""
526
print "it sure does!"
530
######################################################################
1310
print "it sure does!"
1312
def parse_spec(spec):
1314
>>> parse_spec(None)
1316
>>> parse_spec("./")
1318
>>> parse_spec("../@")
1320
>>> parse_spec("../f/@35")
1322
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1323
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1328
parsed = spec.split('/@')
1329
assert len(parsed) == 2
1334
parsed[1] = int(parsed[1])
1336
pass # We can allow stuff like ./@revid:blahblahblah
1338
assert parsed[1] >=0
1340
parsed = [spec, None]
1345
class cmd_merge(Command):
1346
"""Perform a three-way merge of trees.
1348
The SPEC parameters are working tree or revision specifiers. Working trees
1349
are specified using standard paths or urls. No component of a directory
1350
path may begin with '@'.
1352
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1354
Revisions are specified using a dirname/@revno pair, where dirname is the
1355
branch directory and revno is the revision within that branch. If no revno
1356
is specified, the latest revision is used.
1358
Revision examples: './@127', 'foo/@', '../@1'
1360
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1361
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1364
merge refuses to run if there are any uncommitted changes, unless
1367
takes_args = ['other_spec', 'base_spec?']
1368
takes_options = ['force']
1370
def run(self, other_spec, base_spec=None, force=False):
1371
from bzrlib.merge import merge
1372
merge(parse_spec(other_spec), parse_spec(base_spec),
1373
check_clean=(not force))
1377
class cmd_revert(Command):
1378
"""Restore selected files from a previous revision.
1380
takes_args = ['file+']
1381
def run(self, file_list):
1382
from bzrlib.branch import find_branch
1387
b = find_branch(file_list[0])
1389
b.revert([b.relpath(f) for f in file_list])
1392
class cmd_merge_revert(Command):
1393
"""Reverse all changes since the last commit.
1395
Only versioned files are affected.
1397
TODO: Store backups of any files that will be reverted, so
1398
that the revert can be undone.
1400
takes_options = ['revision']
1402
def run(self, revision=None):
1403
from bzrlib.merge import merge
1404
if revision is None:
1406
elif len(revision) != 1:
1407
raise BzrCommandError('bzr merge-revert --revision takes exactly 1 argument')
1408
merge(('.', revision[0]), parse_spec('.'),
1413
class cmd_assert_fail(Command):
1414
"""Test reporting of assertion failures"""
1417
assert False, "always fails"
1420
class cmd_help(Command):
1421
"""Show help on a command or other topic.
1423
For a list of all available commands, say 'bzr help commands'."""
1424
takes_args = ['topic?']
1427
def run(self, topic=None):
1434
class cmd_plugins(Command):
1438
import bzrlib.plugin
1439
from inspect import getdoc
1440
from pprint import pprint
1441
for plugin in bzrlib.plugin.all_plugins:
1442
print plugin.__path__[0]
1445
print '\t', d.split('\n')[0]
1447
#pprint(bzrlib.plugin.all_plugins)
534
1451
# list of all available options; the rhs can be either None for an