84
34
assert cmd.startswith("cmd_")
85
35
return cmd[4:].replace('_','-')
88
def _builtin_commands():
89
import bzrlib.builtins
91
builtins = bzrlib.builtins.__dict__
93
if name.startswith("cmd_"):
94
real_name = _unsquish_command_name(name)
95
r[real_name] = builtins[name]
99
def builtin_command_names():
100
"""Return list of builtin command names."""
101
return _builtin_commands().keys()
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.
104
def plugin_command_names():
105
return plugin_cmds.keys()
108
def _get_cmd_dict(plugins_override=True):
109
"""Return name->class mapping for all commands."""
110
d = _builtin_commands()
112
d.update(plugin_cmds)
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())
116
def get_all_cmds(plugins_override=True):
152
def get_all_cmds(include_plugins=True):
117
153
"""Return canonical name and class for all registered commands."""
118
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
154
for k, v in _get_cmd_dict(include_plugins=include_plugins).iteritems():
122
def get_cmd_object(cmd_name, plugins_override=True):
158
def get_cmd_class(cmd,include_plugins=True):
123
159
"""Return the canonical name and command class for a command.
126
If true, plugin commands can override builtins.
128
from bzrlib.externalcommand import ExternalCommand
130
cmd_name = str(cmd_name) # not unicode
161
cmd = str(cmd) # not unicode
132
163
# first look up this command under the specified name
133
cmds = _get_cmd_dict(plugins_override=plugins_override)
164
cmds = _get_cmd_dict(include_plugins=include_plugins)
135
return cmds[cmd_name]()
166
return cmd, cmds[cmd]
139
170
# look for any command which claims this as an alias
140
for real_cmd_name, cmd_class in cmds.iteritems():
141
if cmd_name in cmd_class.aliases:
144
cmd_obj = ExternalCommand.find_command(cmd_name)
148
raise BzrCommandError("unknown command %r" % cmd_name)
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)
151
182
class Command(object):
152
183
"""Base class for commands.
154
Commands are the heart of the command-line bzr interface.
156
The command object mostly handles the mapping of command-line
157
parameters into one or more bzrlib operations, and of the results
160
Commands normally don't have any state. All their arguments are
161
passed in to the run method. (Subclasses may take a different
162
policy if the behaviour of the instance needs to depend on e.g. a
163
shell plugin and not just its Python class.)
165
185
The docstring for an actual command should give a single-line
166
186
summary, then a complete description of the command. A grammar
167
187
description will be inserted.
170
Other accepted names for this command.
173
190
List of argument forms, marked with whether they are optional,
178
['to_location', 'from_branch?', 'file*']
180
'to_location' is required
181
'from_branch' is optional
182
'file' can be specified 0 or more times
185
List of options that may be given for this command. These can
186
be either strings, referring to globally-defined options,
187
or option objects. Retrieve through options().
194
List of options that may be given for this command.
190
If true, this command isn't advertised. This is typically
191
for commands intended for expert users.
197
If true, this command isn't advertised.
195
202
takes_options = []
200
"""Construct an instance of this command."""
201
if self.__doc__ == Command.__doc__:
202
warn("No help message set for %r" % self)
205
"""Return dict of valid options for this command.
207
Maps from long option name to option object."""
209
r['help'] = Option.OPTIONS['help']
210
for o in self.takes_options:
211
if not isinstance(o, Option):
212
o = Option.OPTIONS[o]
216
@deprecated_method(zero_eight)
217
def run_argv(self, argv):
218
"""Parse command line and run.
220
See run_argv_aliases for the 0.8 and beyond api.
222
return self.run_argv_aliases(argv)
224
def run_argv_aliases(self, argv, alias_argv=None):
225
"""Parse the command line and run with extra aliases in alias_argv."""
226
args, opts = parse_args(self, argv, alias_argv)
227
if 'help' in opts: # e.g. bzr add --help
228
from bzrlib.help import help_on_command
229
help_on_command(self.name())
231
# XXX: This should be handled by the parser
232
allowed_names = self.options().keys()
234
if oname not in allowed_names:
235
raise BzrCommandError("option '--%s' is not allowed for"
236
" command %r" % (oname, self.name()))
237
# mix arguments and options into one dictionary
238
cmdargs = _match_argform(self.name(), self.takes_args, args)
240
for k, v in opts.items():
241
cmdopts[k.replace('-', '_')] = v
243
all_cmd_args = cmdargs.copy()
244
all_cmd_args.update(cmdopts)
246
return self.run(**all_cmd_args)
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)
249
"""Actually run the command.
220
"""Override this in sub-classes.
251
222
This is invoked with the options and arguments bound to
252
223
keyword parameters.
254
Return 0 or None if the command was successful, or a non-zero
255
shell error code if not. It's OK for this method to allow
256
an exception to raise up.
225
Return 0 or None if the command was successful, or a shell
258
raise NotImplementedError('no implementation of command %r'
262
"""Return help message for this class."""
263
from inspect import getdoc
264
if self.__doc__ is Command.__doc__:
269
return _unsquish_command_name(self.__class__.__name__)
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):
304
"""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."""
767
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):
820
"""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.
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):
896
"""List files in a tree.
898
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)
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")
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']
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__
1143
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):
1151
"""Statement of optimism."""
1154
print "it sure does!"
272
1156
def parse_spec(spec):
290
1172
if parsed[1] == "":
294
parsed[1] = int(parsed[1])
296
pass # We can allow stuff like ./@revid:blahblahblah
1175
parsed[1] = int(parsed[1])
1176
assert parsed[1] >=0
300
1178
parsed = [spec, None]
303
def parse_args(command, argv, alias_argv=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())
1262
# list of all available options; the rhs can be either None for an
1263
# option that takes no argument, or a constructor function that checks
1267
'diff-options': str,
1275
'revision': _parse_revision_str,
1292
def parse_args(argv):
304
1293
"""Parse command line.
306
1295
Arguments and options are parsed at this level before being passed
307
1296
down to specific command handlers. This routine knows, from a
308
1297
lookup table, something about the available options, what optargs
309
1298
they take, and which commands will accept them.
1300
>>> parse_args('--help'.split())
1301
([], {'help': True})
1302
>>> parse_args('--version'.split())
1303
([], {'version': True})
1304
>>> parse_args('status --all'.split())
1305
(['status'], {'all': True})
1306
>>> parse_args('commit --message=biter'.split())
1307
(['commit'], {'message': u'biter'})
311
# TODO: chop up this beast; make it a method of the Command
316
cmd_options = command.options()
318
proc_aliasarg = True # Are we processing alias_argv now?
319
for proc_argv in alias_argv, argv:
326
# We've received a standalone -- No more flags
330
# option names must not be unicode
334
mutter(" got option %r", a)
336
optname, optarg = a[2:].split('=', 1)
339
if optname not in cmd_options:
340
raise BzrOptionError('unknown long option %r for'
1312
# TODO: Maybe handle '--' to end options?
1317
# option names must not be unicode
1321
mutter(" got option %r" % a)
1323
optname, optarg = a[2:].split('=', 1)
345
if shortopt in Option.SHORT_OPTIONS:
346
# Multi-character options must have a space to delimit
348
# ^^^ what does this mean? mbp 20051014
349
optname = Option.SHORT_OPTIONS[shortopt].name
351
# Single character short options, can be chained,
352
# and have their value appended to their name
354
if shortopt not in Option.SHORT_OPTIONS:
355
# We didn't find the multi-character name, and we
356
# didn't find the single char name
357
raise BzrError('unknown short option %r' % a)
358
optname = Option.SHORT_OPTIONS[shortopt].name
361
# There are extra things on this option
362
# see if it is the value, or if it is another
364
optargfn = Option.OPTIONS[optname].type
366
# This option does not take an argument, so the
367
# next entry is another short option, pack it
369
proc_argv.insert(0, '-' + a[2:])
371
# This option takes an argument, so pack it
1326
if optname not in OPTIONS:
1327
bailout('unknown long option %r' % a)
1330
if shortopt not in SHORT_OPTIONS:
1331
bailout('unknown short option %r' % a)
1332
optname = SHORT_OPTIONS[shortopt]
1335
# XXX: Do we ever want to support this, e.g. for -r?
1336
bailout('repeated option %r' % a)
375
if optname not in cmd_options:
376
raise BzrOptionError('unknown short option %r for'
378
(shortopt, command.name()))
380
# XXX: Do we ever want to support this, e.g. for -r?
382
raise BzrError('repeated option %r' % a)
383
elif optname in alias_opts:
384
# Replace what's in the alias with what's in the real
386
del alias_opts[optname]
388
proc_argv.insert(0, a)
1338
optargfn = OPTIONS[optname]
1342
bailout('option %r needs an argument' % a)
391
raise BzrError('repeated option %r' % a)
393
option_obj = cmd_options[optname]
394
optargfn = option_obj.type
398
raise BzrError('option %r needs an argument' % a)
400
optarg = proc_argv.pop(0)
401
opts[optname] = optargfn(optarg)
403
alias_opts[optname] = optargfn(optarg)
406
raise BzrError('option %r takes no argument' % optname)
409
alias_opts[optname] = True
1344
optarg = argv.pop(0)
1345
opts[optname] = optargfn(optarg)
412
proc_aliasarg = False # Done with alias argv
1348
bailout('option %r takes no argument' % optname)
1349
opts[optname] = True
413
1353
return args, opts
416
1358
def _match_argform(cmd, takes_args, args):
461
def apply_profiled(the_callable, *args, **kwargs):
465
pffileno, pfname = tempfile.mkstemp()
467
prof = hotshot.Profile(pfname)
469
ret = prof.runcall(the_callable, *args, **kwargs) or 0
472
stats = hotshot.stats.load(pfname)
474
stats.sort_stats('cum') # 'time'
475
## XXX: Might like to write to stderr or the trace file instead but
476
## print_stats seems hardcoded to stdout
477
stats.print_stats(20)
484
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
485
from bzrlib.lsprof import profile
487
ret, stats = profile(the_callable, *args, **kwargs)
493
cPickle.dump(stats, open(filename, 'w'), 2)
494
print 'Profile data written to %r.' % filename
499
"""Return an expanded alias, or None if no alias exists"""
501
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
503
return alias.split(' ')
507
1403
def run_bzr(argv):
508
1404
"""Execute a command.
510
1406
This is similar to main(), but without all the trappings for
511
1407
logging and error handling.
514
The command-line arguments, without the program name from argv[0]
516
Returns a command status or raises an exception.
518
Special master options: these must come before the command because
519
they control how the command is interpreted.
522
Do not load plugin modules at all
528
Only use builtin commands. (Plugins are still allowed to change
532
Run under the Python hotshot profiler.
535
Run under the Python lsprof profiler.
537
1409
argv = [a.decode(bzrlib.user_encoding) for a in argv]
539
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
540
opt_no_aliases = False
541
opt_lsprof_file = None
543
# --no-plugins is handled specially at a very early stage. We need
544
# to load plugins before doing other command parsing so that they
545
# can override commands, but this needs to happen first.
553
elif a == '--lsprof':
555
elif a == '--lsprof-file':
556
opt_lsprof_file = argv[i + 1]
558
elif a == '--no-plugins':
559
opt_no_plugins = True
560
elif a == '--no-aliases':
561
opt_no_aliases = True
562
elif a == '--builtin':
564
elif a in ('--quiet', '-q'):
572
from bzrlib.builtins import cmd_help
573
cmd_help().run_argv_aliases([])
576
if argv[0] == '--version':
577
from bzrlib.builtins import show_version
581
if not opt_no_plugins:
582
from bzrlib.plugin import load_plugins
585
from bzrlib.plugin import disable_plugins
590
if not opt_no_aliases:
591
alias_argv = get_alias(argv[0])
593
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
594
argv[0] = alias_argv.pop(0)
596
cmd = str(argv.pop(0))
598
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
599
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
600
run = cmd_obj.run_argv
603
run = cmd_obj.run_argv_aliases
604
run_argv = [argv, alias_argv]
1411
include_plugins=True
608
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
610
ret = apply_profiled(run, *run_argv)
615
# reset, in case we may do other commands later within the same process
618
def display_command(func):
619
"""Decorator that suppresses pipe/interrupt errors."""
620
def ignore_pipe(*args, **kwargs):
1413
args, opts = parse_args(argv[1:])
1421
elif 'version' in opts:
1424
elif args and args[0] == 'builtin':
1425
include_plugins=False
1427
cmd = str(args.pop(0))
1434
canonical_cmd, cmd_class = get_cmd_class(cmd,include_plugins=include_plugins)
1437
if 'profile' in opts:
1443
# check options are reasonable
1444
allowed = cmd_class.takes_options
1446
if oname not in allowed:
1447
raise BzrCommandError("option '--%s' is not allowed for command %r"
1450
# mix arguments and options into one dictionary
1451
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1453
for k, v in opts.items():
1454
cmdopts[k.replace('-', '_')] = v
1457
import hotshot, tempfile
1458
pffileno, pfname = tempfile.mkstemp()
622
result = func(*args, **kwargs)
626
if not hasattr(e, 'errno'):
628
if e.errno != errno.EPIPE:
631
except KeyboardInterrupt:
1460
prof = hotshot.Profile(pfname)
1461
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1464
import hotshot.stats
1465
stats = hotshot.stats.load(pfname)
1467
stats.sort_stats('time')
1468
## XXX: Might like to write to stderr or the trace file instead but
1469
## print_stats seems hardcoded to stdout
1470
stats.print_stats(20)
1478
return cmd_class(cmdopts, cmdargs).status
1481
def _report_exception(summary, quiet=False):
1483
log_error('bzr: ' + summary)
1484
bzrlib.trace.log_exception()
1487
tb = sys.exc_info()[2]
1488
exinfo = traceback.extract_tb(tb)
1490
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1491
sys.stderr.write(' see ~/.bzr.log for debug information\n')
638
from bzrlib.ui.text import TextUIFactory
639
## bzrlib.trace.enable_default_logging()
640
bzrlib.trace.log_startup(argv)
641
bzrlib.ui.ui_factory = TextUIFactory()
642
ret = run_bzr_catch_errors(argv[1:])
643
mutter("return code %d", ret)
647
def run_bzr_catch_errors(argv):
1498
bzrlib.open_tracefile(argv)
652
# do this here inside the exception wrappers to catch EPIPE
655
# used to handle AssertionError and KeyboardInterrupt
656
# specially here, but hopefully they're handled ok by the logger now
658
if (isinstance(e, IOError)
659
and hasattr(e, 'errno')
660
and e.errno == errno.EPIPE):
661
bzrlib.trace.note('broken pipe')
664
bzrlib.trace.log_exception()
665
if os.environ.get('BZR_PDB'):
666
print '**** entering debugger'
668
pdb.post_mortem(sys.exc_traceback)
1503
return run_bzr(argv)
1505
# do this here inside the exception wrappers to catch EPIPE
1508
quiet = isinstance(e, (BzrCommandError))
1509
_report_exception('error: ' + e.args[0], quiet=quiet)
1512
# some explanation or hints
1515
except AssertionError, e:
1516
msg = 'assertion failed'
1518
msg += ': ' + str(e)
1519
_report_exception(msg)
1521
except KeyboardInterrupt, e:
1522
_report_exception('interrupted', quiet=True)
1524
except Exception, e:
1526
if (isinstance(e, IOError)
1527
and hasattr(e, 'errno')
1528
and e.errno == errno.EPIPE):
1532
msg = str(e).rstrip('\n')
1533
_report_exception(msg, quiet)
1536
bzrlib.trace.close_trace()
671
1539
if __name__ == '__main__':
672
1540
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
