13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
18
21
# TODO: Define arguments by objects, rather than just using names.
19
22
# Those objects can specify the expected type of the argument, which
74
69
class CommandRegistry(registry.Registry):
75
"""Special registry mapping command names to command classes.
77
:ivar overridden_registry: Look in this registry for commands being
78
overridden by this registry. This can be used to tell plugin commands
79
about the builtin they're decorating.
83
registry.Registry.__init__(self)
84
self.overridden_registry = None
85
# map from aliases to the real command that implements the name
88
def get(self, command_name):
89
real_name = self._alias_dict.get(command_name, command_name)
90
return registry.Registry.get(self, real_name)
93
72
def _get_name(command_name):
110
89
previous = self.get(k_unsquished)
113
if self.overridden_registry:
115
previous = self.overridden_registry.get(k_unsquished)
91
previous = _builtin_commands().get(k_unsquished)
118
92
info = CommandInfo.from_command(cmd)
120
94
registry.Registry.register(self, k_unsquished, cmd,
121
95
override_existing=decorate, info=info)
123
trace.warning('Two plugins defined the same command: %r' % k)
124
trace.warning('Not loading the one in %r' %
125
sys.modules[cmd.__module__])
126
trace.warning('Previously this command was registered from %r' %
127
sys.modules[previous.__module__])
128
for a in cmd.aliases:
129
self._alias_dict[a] = k_unsquished
97
trace.log_error('Two plugins defined the same command: %r' % k)
98
trace.log_error('Not loading the one in %r' %
99
sys.modules[cmd.__module__])
100
trace.log_error('Previously this command was registered from %r' %
101
sys.modules[previous.__module__])
132
104
def register_lazy(self, command_name, aliases, module_name):
139
111
key = self._get_name(command_name)
140
112
registry.Registry.register_lazy(self, key, module_name, command_name,
141
113
info=CommandInfo(aliases))
143
self._alias_dict[a] = key
146
116
plugin_cmds = CommandRegistry()
147
builtin_command_registry = CommandRegistry()
148
plugin_cmds.overridden_registry = builtin_command_registry
151
119
def register_command(cmd, decorate=False):
152
"""Register a plugin command.
154
Should generally be avoided in favor of lazy registration.
156
120
global plugin_cmds
157
121
return plugin_cmds.register(cmd, decorate)
165
129
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
132
def _builtin_commands():
170
"""Return a dict of {name: cmd_class} for builtin commands.
172
:deprecated: Use the builtin_command_registry registry instead
174
# return dict(name: cmd_class)
175
return dict(builtin_command_registry.items())
178
def _register_builtin_commands():
179
if builtin_command_registry.keys():
182
133
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
184
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
188
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
135
builtins = bzrlib.builtins.__dict__
136
for name in builtins:
191
137
if name.startswith("cmd_"):
192
138
real_name = _unsquish_command_name(name)
139
r[real_name] = builtins[name]
197
def _list_bzr_commands(names):
198
"""Find commands from bzr's core and plugins.
200
This is not the public interface, just the default hook called by all_command_names.
202
# to eliminate duplicates
203
names.update(builtin_command_names())
204
names.update(plugin_command_names())
208
def all_command_names():
209
"""Return a set of all command names."""
211
for hook in Command.hooks['list_commands']:
214
raise AssertionError(
215
'hook %s returned None' % Command.hooks.get_hook_name(hook))
219
143
def builtin_command_names():
220
"""Return list of builtin command names.
144
"""Return list of builtin command names."""
145
return _builtin_commands().keys()
222
Use of all_command_names() is encouraged rather than builtin_command_names
223
and/or plugin_command_names.
225
return builtin_command_registry.keys()
228
148
def plugin_command_names():
229
"""Returns command names from commands registered by plugins."""
230
149
return plugin_cmds.keys()
152
def _get_cmd_dict(plugins_override=True):
153
"""Return name->class mapping for all commands."""
154
d = _builtin_commands()
156
d.update(plugin_cmds.iteritems())
160
def get_all_cmds(plugins_override=True):
161
"""Return canonical name and class for all registered commands."""
162
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
233
166
def get_cmd_object(cmd_name, plugins_override=True):
234
"""Return the command object for a command.
167
"""Return the canonical name and command class for a command.
237
170
If true, plugin commands can override builtins.
242
175
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
246
"""Get a command object.
178
def _get_cmd_object(cmd_name, plugins_override=True):
179
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
180
from bzrlib.externalcommand import ExternalCommand
248
:param cmd_name: The name of the command.
249
:param plugins_override: Allow plugins to override builtins.
250
:param check_missing: Look up commands not found in the regular index via
251
the get_missing_command hook.
252
:return: A Command object instance
253
:raises KeyError: If no command is found.
255
182
# We want only 'ascii' command names, but the user may have typed
256
183
# in a Unicode name. In that case, they should just get a
257
184
# 'command not found' error later.
258
185
# In the future, we may actually support Unicode command names.
261
for hook in Command.hooks['get_command']:
262
cmd = hook(cmd, cmd_name)
263
if cmd is not None and not plugins_override and not cmd.plugin_name():
264
# We've found a non-plugin command, don't permit it to be
267
if cmd is None and check_missing:
268
for hook in Command.hooks['get_missing_command']:
275
# Allow plugins to extend commands
276
for hook in Command.hooks['extend_command']:
281
def _try_plugin_provider(cmd_name):
282
"""Probe for a plugin provider having cmd_name."""
284
plugin_metadata, provider = probe_for_provider(cmd_name)
285
raise errors.CommandAvailableInPlugin(cmd_name,
286
plugin_metadata, provider)
287
except errors.NoPluginAvailable:
291
def probe_for_provider(cmd_name):
292
"""Look for a provider for cmd_name.
294
:param cmd_name: The command name.
295
:return: plugin_metadata, provider for getting cmd_name.
296
:raises NoPluginAvailable: When no provider can supply the plugin.
298
# look for providers that provide this command but aren't installed
299
for provider in command_providers_registry:
187
# first look up this command under the specified name
301
return provider.plugin_for_command(cmd_name), provider
302
except errors.NoPluginAvailable:
190
return plugin_cmds.get(cmd_name)()
304
raise errors.NoPluginAvailable(cmd_name)
307
def _get_bzr_command(cmd_or_None, cmd_name):
308
"""Get a command from bzr's core."""
193
cmds = _get_cmd_dict(plugins_override=False)
310
cmd_class = builtin_command_registry.get(cmd_name)
195
return cmds[cmd_name]()
318
def _get_external_command(cmd_or_None, cmd_name):
319
"""Lookup a command that is a shell script."""
320
# Only do external command lookups when no command is found so far.
321
if cmd_or_None is not None:
323
from bzrlib.externalcommand import ExternalCommand
199
for key in plugin_cmds.keys():
200
info = plugin_cmds.get_info(key)
201
if cmd_name in info.aliases:
202
return plugin_cmds.get(key)()
203
# look for any command which claims this as an alias
204
for real_cmd_name, cmd_class in cmds.iteritems():
205
if cmd_name in cmd_class.aliases:
324
208
cmd_obj = ExternalCommand.find_command(cmd_name)
212
# look for plugins that provide this command but aren't installed
213
for provider in command_providers_registry:
215
plugin_metadata = provider.plugin_for_command(cmd_name)
216
except errors.NoPluginAvailable:
219
raise errors.CommandAvailableInPlugin(cmd_name,
220
plugin_metadata, provider)
329
def _get_plugin_command(cmd_or_None, cmd_name):
330
"""Get a command from bzr's plugins."""
332
return plugin_cmds.get(cmd_name)()
335
for key in plugin_cmds.keys():
336
info = plugin_cmds.get_info(key)
337
if cmd_name in info.aliases:
338
return plugin_cmds.get(key)()
342
225
class Command(object):
410
286
encoding_type = 'strict'
414
290
def __init__(self):
415
291
"""Construct an instance of this command."""
292
if self.__doc__ == Command.__doc__:
293
warn("No help message set for %r" % self)
416
294
# List of standard options directly supported
417
295
self.supported_std_options = []
420
def add_cleanup(self, cleanup_func, *args, **kwargs):
421
"""Register a function to call after self.run returns or raises.
423
Functions will be called in LIFO order.
425
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
427
def cleanup_now(self):
428
"""Execute and empty pending cleanup functions immediately.
430
After cleanup_now all registered cleanups are forgotten. add_cleanup
431
may be called again after cleanup_now; these cleanups will be called
432
after self.run returns or raises (or when cleanup_now is next called).
434
This is useful for releasing expensive or contentious resources (such
435
as write locks) before doing further work that does not require those
436
resources (such as writing results to self.outf). Note though, that
437
as it releases all resources, this may release locks that the command
438
wants to hold, so use should be done with care.
440
self._operation.cleanup_now()
442
@deprecated_method(deprecated_in((2, 1, 0)))
443
297
def _maybe_expand_globs(self, file_list):
444
298
"""Glob expand file_list if the platform does not do that itself.
446
Not used anymore, now that the bzr command-line parser globs on
449
300
:return: A possibly empty list of unicode paths.
451
302
Introduced in bzrlib 0.18.
306
if sys.platform == 'win32':
307
file_list = win32utils.glob_expand(file_list)
308
return list(file_list)
455
310
def _usage(self):
456
311
"""Return single-line grammar for this command.
473
328
def get_help_text(self, additional_see_also=None, plain=True,
474
see_also_as_links=False, verbose=True):
329
see_also_as_links=False):
475
330
"""Return a text string with help for this command.
477
332
:param additional_see_also: Additional help topics to be
478
333
cross-referenced.
479
334
:param plain: if False, raw help (reStructuredText) is
480
335
returned instead of plain text.
481
336
:param see_also_as_links: if True, convert items in 'See also'
482
337
list to internal links (used by bzr_man rstx generator)
483
:param verbose: if True, display the full help, otherwise
484
leave out the descriptive sections and just display
485
usage help (e.g. Purpose, Usage, Options) with a
486
message explaining how to obtain full help.
488
339
doc = self.help()
490
doc = "No help for this command."
341
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
492
343
# Extract the summary (purpose) and sections out from the text
493
purpose,sections,order = self._get_help_parts(doc)
344
purpose,sections = self._get_help_parts(doc)
495
346
# If a custom usage section was provided, use it
496
347
if sections.has_key('Usage'):
510
361
# Add the options
512
# XXX: optparse implicitly rewraps the help, and not always perfectly,
513
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
515
362
options = option.get_optparser(self.options()).format_option_help()
516
# XXX: According to the spec, ReST option lists actually don't support
517
# options like --1.9 so that causes syntax errors (in Sphinx at least).
518
# As that pattern always appears in the commands that break, we trap
519
# on that and then format that block of 'format' options as a literal
521
if not plain and options.find(' --1.9 ') != -1:
522
options = options.replace(' format:\n', ' format::\n\n', 1)
523
363
if options.startswith('Options:'):
524
364
result += ':' + options
525
365
elif options.startswith('options:'):
529
369
result += options
533
# Add the description, indenting it 2 spaces
534
# to match the indentation of the options
535
if sections.has_key(None):
536
text = sections.pop(None)
537
text = '\n '.join(text.splitlines())
538
result += ':%s:\n %s\n\n' % ('Description',text)
372
# Add the description, indenting it 2 spaces
373
# to match the indentation of the options
374
if sections.has_key(None):
375
text = sections.pop(None)
376
text = '\n '.join(text.splitlines())
377
result += ':%s:\n %s\n\n' % ('Description',text)
540
# Add the custom sections (e.g. Examples). Note that there's no need
541
# to indent these as they must be indented already in the source.
544
if sections.has_key(label):
545
result += ':%s:\n%s\n' % (label,sections[label])
548
result += ("See bzr help %s for more details and examples.\n\n"
379
# Add the custom sections (e.g. Examples). Note that there's no need
380
# to indent these as they must be indented already in the source.
382
labels = sorted(sections.keys())
384
result += ':%s:\n%s\n\n' % (label,sections[label])
551
386
# Add the aliases, source (plug-in) and see also links, if any
582
416
def _get_help_parts(text):
583
417
"""Split help text into a summary and named sections.
585
:return: (summary,sections,order) where summary is the top line and
419
:return: (summary,sections) where summary is the top line and
586
420
sections is a dictionary of the rest indexed by section name.
587
order is the order the section appear in the text.
588
421
A section starts with a heading line of the form ":xxx:".
589
422
Indented text on following lines is the section value.
590
423
All text found outside a named section is assigned to the
591
424
default section which is given the key of None.
593
def save_section(sections, order, label, section):
426
def save_section(sections, label, section):
594
427
if len(section) > 0:
595
428
if sections.has_key(label):
596
429
sections[label] += '\n' + section
599
431
sections[label] = section
601
433
lines = text.rstrip().splitlines()
602
434
summary = lines.pop(0)
605
436
label,section = None,''
606
437
for line in lines:
607
438
if line.startswith(':') and line.endswith(':') and len(line) > 2:
608
save_section(sections, order, label, section)
439
save_section(sections, label, section)
609
440
label,section = line[1:-1],''
610
441
elif (label is not None) and len(line) > 1 and not line[0].isspace():
611
save_section(sections, order, label, section)
442
save_section(sections, label, section)
612
443
label,section = None,line
614
445
if len(section) > 0:
615
446
section += '\n' + line
618
save_section(sections, order, label, section)
619
return summary, sections, order
449
save_section(sections, label, section)
450
return summary, sections
621
452
def get_help_topic(self):
622
453
"""Return the commands help topic - its name."""
652
483
def _setup_outf(self):
653
484
"""Return a file linked to stdout, which has proper encoding."""
654
self.outf = ui.ui_factory.make_output_stream(
655
encoding_type=self.encoding_type)
485
# Originally I was using self.stdout, but that looks
486
# *way* too much like sys.stdout
487
if self.encoding_type == 'exact':
488
# force sys.stdout to be binary stream on win32
489
if sys.platform == 'win32':
490
fileno = getattr(sys.stdout, 'fileno', None)
493
msvcrt.setmode(fileno(), os.O_BINARY)
494
self.outf = sys.stdout
497
output_encoding = osutils.get_terminal_encoding()
499
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
500
errors=self.encoding_type)
501
# For whatever reason codecs.getwriter() does not advertise its encoding
502
# it just returns the encoding of the wrapped file, which is completely
503
# bogus. So set the attribute, so we can find the correct encoding later.
504
self.outf.encoding = output_encoding
657
506
def run_argv_aliases(self, argv, alias_argv=None):
658
507
"""Parse the command line and run with extra aliases in alias_argv."""
509
warn("Passing None for [] is deprecated from bzrlib 0.10",
510
DeprecationWarning, stacklevel=2)
659
512
args, opts = parse_args(self, argv, alias_argv)
661
514
# Process the standard options
662
515
if 'help' in opts: # e.g. bzr add --help
663
516
sys.stdout.write(self.get_help_text())
665
if 'usage' in opts: # e.g. bzr add --usage
666
sys.stdout.write(self.get_help_text(verbose=False))
668
518
trace.set_verbosity_level(option._verbosity_level)
669
519
if 'verbose' in self.supported_std_options:
670
520
opts['verbose'] = trace.is_verbose()
689
539
return self.run(**all_cmd_args)
691
def _setup_run(self):
692
"""Wrap the defined run method on self with a cleanup.
694
This is called by __init__ to make the Command be able to be run
695
by just calling run(), as it could be before cleanups were added.
697
If a different form of cleanups are in use by your Command subclass,
698
you can override this method.
701
def run(*args, **kwargs):
702
self._operation = cleanup.OperationWithCleanups(class_run)
704
return self._operation.run_simple(*args, **kwargs)
709
@deprecated_method(deprecated_in((2, 2, 0)))
710
def run_direct(self, *args, **kwargs):
711
"""Deprecated thunk from bzrlib 2.1."""
712
return self.run(*args, **kwargs)
715
542
"""Actually run the command.
760
class CommandHooks(Hooks):
761
"""Hooks related to Command object creation/enumeration."""
764
"""Create the default hooks.
766
These are all empty initially, because by default nothing should get
770
self.create_hook(HookPoint('extend_command',
771
"Called after creating a command object to allow modifications "
772
"such as adding or removing options, docs etc. Called with the "
773
"new bzrlib.commands.Command object.", (1, 13), None))
774
self.create_hook(HookPoint('get_command',
775
"Called when creating a single command. Called with "
776
"(cmd_or_None, command_name). get_command should either return "
777
"the cmd_or_None parameter, or a replacement Command object that "
778
"should be used for the command. Note that the Command.hooks "
779
"hooks are core infrastructure. Many users will prefer to use "
780
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
782
self.create_hook(HookPoint('get_missing_command',
783
"Called when creating a single command if no command could be "
784
"found. Called with (command_name). get_missing_command should "
785
"either return None, or a Command object to be used for the "
786
"command.", (1, 17), None))
787
self.create_hook(HookPoint('list_commands',
788
"Called when enumerating commands. Called with a set of "
789
"cmd_name strings for all the commands found so far. This set "
790
" is safe to mutate - e.g. to remove a command. "
791
"list_commands should return the updated set of command names.",
794
Command.hooks = CommandHooks()
797
576
def parse_args(command, argv, alias_argv=None):
798
577
"""Parse command line.
800
579
Arguments and options are parsed at this level before being passed
801
580
down to specific command handlers. This routine knows, from a
802
581
lookup table, something about the available options, what optargs
866
645
tracer = trace.Trace(count=1, trace=0)
867
646
sys.settrace(tracer.globaltrace)
868
threading.settrace(tracer.globaltrace)
871
return exception_to_return_code(the_callable, *args, **kwargs)
874
results = tracer.results()
875
results.write_results(show_missing=1, summary=False,
648
ret = the_callable(*args, **kwargs)
651
results = tracer.results()
652
results.write_results(show_missing=1, summary=False,
879
656
def apply_profiled(the_callable, *args, **kwargs):
900
676
os.remove(pfname)
903
def exception_to_return_code(the_callable, *args, **kwargs):
904
"""UI level helper for profiling and coverage.
906
This transforms exceptions into a return value of 3. As such its only
907
relevant to the UI layer, and should never be called where catching
908
exceptions may be desirable.
911
return the_callable(*args, **kwargs)
912
except (KeyboardInterrupt, Exception), e:
913
# used to handle AssertionError and KeyboardInterrupt
914
# specially here, but hopefully they're handled ok by the logger now
915
exc_info = sys.exc_info()
916
exitcode = trace.report_exception(exc_info, sys.stderr)
917
if os.environ.get('BZR_PDB'):
918
print '**** entering debugger'
921
if sys.version_info[:2] < (2, 6):
923
# pdb.post_mortem(tb)
924
# but because pdb.post_mortem gives bad results for tracebacks
925
# from inside generators, we do it manually.
926
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
928
# Setup pdb on the traceback
931
p.setup(tb.tb_frame, tb)
932
# Point the debugger at the deepest frame of the stack
933
p.curindex = len(p.stack) - 1
934
p.curframe = p.stack[p.curindex][0]
935
# Start the pdb prompt.
936
p.print_stack_entry(p.stack[p.curindex])
944
679
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
945
680
from bzrlib.lsprof import profile
946
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
681
ret, stats = profile(the_callable, *args, **kwargs)
948
683
if filename is None:
973
708
config = bzrlib.config.GlobalConfig()
974
709
alias = config.get_alias(cmd)
976
return cmdline.split(alias)
711
return shlex_split_unicode(alias)
980
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
981
716
"""Execute a command.
983
:param argv: The command-line arguments, without the program name from
984
argv[0] These should already be decoded. All library/test code calling
985
run_bzr should be passing valid strings (don't need decoding).
986
:param load_plugins: What function to call when triggering plugin loading.
987
This function should take no arguments and cause all plugins to be
989
:param disable_plugins: What function to call when disabling plugin
990
loading. This function should take no arguments and cause all plugin
991
loading to be prohibited (so that code paths in your application that
992
know about some plugins possibly being present will fail to import
993
those plugins even if they are installed.)
994
:return: Returns a command exit code or raises an exception.
719
The command-line arguments, without the program name from argv[0]
720
These should already be decoded. All library/test code calling
721
run_bzr should be passing valid strings (don't need decoding).
723
Returns a command status or raises an exception.
996
725
Special master options: these must come before the command because
997
726
they control how the command is interpreted.
1060
782
argv_copy.append(a)
1063
debug.set_debug_flags_from_config()
787
from bzrlib.builtins import cmd_help
788
cmd_help().run_argv_aliases([])
791
if argv[0] == '--version':
792
from bzrlib.builtins import cmd_version
793
cmd_version().run_argv_aliases([])
1065
796
if not opt_no_plugins:
797
from bzrlib.plugin import load_plugins
800
from bzrlib.plugin import disable_plugins
1068
801
disable_plugins()
1072
get_cmd_object('help').run_argv_aliases([])
1075
if argv[0] == '--version':
1076
get_cmd_object('version').run_argv_aliases([])
1079
803
alias_argv = None
1081
805
if not opt_no_aliases:
1082
806
alias_argv = get_alias(argv[0])
808
user_encoding = osutils.get_user_encoding()
809
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1084
810
argv[0] = alias_argv.pop(0)
1086
812
cmd = argv.pop(0)
813
# We want only 'ascii' command names, but the user may have typed
814
# in a Unicode name. In that case, they should just get a
815
# 'command not found' error later.
1087
817
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1088
818
run = cmd_obj.run_argv_aliases
1089
819
run_argv = [argv, alias_argv]
1107
837
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1109
839
ret = run(*run_argv)
840
if 'memory' in debug.debug_flags:
841
trace.debug_memory('Process status after command:', short=False)
1112
844
# reset, in case we may do other commands later within the same
1113
845
# process. Commands that want to execute sub-commands must propagate
1114
846
# --verbose in their own way.
1115
if 'memory' in debug.debug_flags:
1116
trace.debug_memory('Process status after command:', short=False)
1117
847
option._verbosity_level = saved_verbosity_level
1120
849
def display_command(func):
1121
850
"""Decorator that suppresses pipe/interrupt errors."""
1122
851
def ignore_pipe(*args, **kwargs):
1137
866
return ignore_pipe
1140
def install_bzr_command_hooks():
1141
"""Install the hooks to supply bzr's own commands."""
1142
if _list_bzr_commands in Command.hooks["list_commands"]:
1144
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1146
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1148
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1149
"bzr plugin commands")
1150
Command.hooks.install_named_hook("get_command", _get_external_command,
1151
"bzr external command lookup")
1152
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1153
"bzr plugin-provider-db check")
1157
def _specified_or_unicode_argv(argv):
1158
# For internal or testing use, argv can be passed. Otherwise, get it from
1159
# the process arguments in a unicode-safe way.
1161
return osutils.get_unicode_argv()
1165
# ensure all arguments are unicode strings
1167
if isinstance(a, unicode):
1170
new_argv.append(a.decode('ascii'))
1171
except UnicodeDecodeError:
1172
raise errors.BzrError("argv should be list of unicode strings.")
1176
def main(argv=None):
1177
"""Main entry point of command-line interface.
1179
Typically `bzrlib.initialize` should be called first.
1181
:param argv: list of unicode command-line arguments similar to sys.argv.
1182
argv[0] is script name usually, it will be ignored.
1183
Don't pass here sys.argv because this list contains plain strings
1184
and not unicode; pass None instead.
1186
:return: exit code of bzr command.
1188
argv = _specified_or_unicode_argv(argv)
1189
_register_builtin_commands()
871
from bzrlib.ui.text import TextUIFactory
872
bzrlib.ui.ui_factory = TextUIFactory()
874
# Is this a final release version? If so, we should suppress warnings
875
if bzrlib.version_info[3] == 'final':
876
from bzrlib import symbol_versioning
877
symbol_versioning.suppress_deprecation_warnings(override=False)
879
user_encoding = osutils.get_user_encoding()
880
argv = [a.decode(user_encoding) for a in argv[1:]]
881
except UnicodeDecodeError:
882
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
1190
884
ret = run_bzr_catch_errors(argv)
1191
bzrlib.ui.ui_factory.log_transport_activity(
1192
display=('bytes' in debug.debug_flags))
1193
885
trace.mutter("return code %d", ret)
1197
889
def run_bzr_catch_errors(argv):
1198
"""Run a bzr command with parameters as described by argv.
1200
This function assumed that that UI layer is setup, that symbol deprecations
1201
are already applied, and that unicode decoding has already been performed on argv.
1203
# done here so that they're covered for every test run
1204
install_bzr_command_hooks()
1205
return exception_to_return_code(run_bzr, argv)
890
# Note: The except clause logic below should be kept in sync with the
891
# profile() routine in lsprof.py.
894
except (KeyboardInterrupt, Exception), e:
895
# used to handle AssertionError and KeyboardInterrupt
896
# specially here, but hopefully they're handled ok by the logger now
897
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
898
if os.environ.get('BZR_PDB'):
899
print '**** entering debugger'
901
pdb.post_mortem(sys.exc_traceback)
1208
905
def run_bzr_catch_user_errors(argv):
added
removed
bzrlib/commands.py
