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
29
35
lazy_import(globals(), """
33
38
from warnings import warn
36
41
from bzrlib import (
49
from bzrlib.hooks import HookPoint, Hooks
50
# Compatibility - Option used to be in commands.
51
from bzrlib import registry
51
53
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
61
class CommandInfo(object):
62
"""Information about a command."""
64
def __init__(self, aliases):
65
"""The list of aliases for the command."""
66
self.aliases = aliases
69
def from_command(klass, command):
70
"""Factory to construct a CommandInfo from a command."""
71
return klass(command.aliases)
74
56
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
def _get_name(command_name):
94
if command_name.startswith("cmd_"):
95
return _unsquish_command_name(command_name)
99
58
def register(self, cmd, decorate=False):
100
59
"""Utility function to help register a command
105
64
Otherwise it is an error to try to override an existing command.
108
k_unsquished = self._get_name(k)
67
if k.startswith("cmd_"):
68
k_unsquished = _unsquish_command_name(k)
110
72
previous = self.get(k_unsquished)
113
if self.overridden_registry:
115
previous = self.overridden_registry.get(k_unsquished)
118
info = CommandInfo.from_command(cmd)
74
previous = _builtin_commands().get(k_unsquished)
120
76
registry.Registry.register(self, k_unsquished, cmd,
121
override_existing=decorate, info=info)
77
override_existing=decorate)
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
79
trace.log_error('Two plugins defined the same command: %r' % k)
80
trace.log_error('Not loading the one in %r' %
81
sys.modules[cmd.__module__])
82
trace.log_error('Previously this command was registered from %r' %
83
sys.modules[previous.__module__])
132
def register_lazy(self, command_name, aliases, module_name):
133
"""Register a command without loading its module.
135
:param command_name: The primary name of the command.
136
:param aliases: A list of aliases for the command.
137
:module_name: The module that the command lives in.
139
key = self._get_name(command_name)
140
registry.Registry.register_lazy(self, key, module_name, command_name,
141
info=CommandInfo(aliases))
143
self._alias_dict[a] = key
146
87
plugin_cmds = CommandRegistry()
147
builtin_command_registry = CommandRegistry()
148
plugin_cmds.overridden_registry = builtin_command_registry
151
90
def register_command(cmd, decorate=False):
152
"""Register a plugin command.
154
Should generally be avoided in favor of lazy registration.
156
91
global plugin_cmds
157
92
return plugin_cmds.register(cmd, decorate)
165
100
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
103
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
104
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():
106
builtins = bzrlib.builtins.__dict__
107
for name in builtins:
191
108
if name.startswith("cmd_"):
192
109
real_name = _unsquish_command_name(name)
110
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
114
def builtin_command_names():
220
"""Return list of builtin command names.
115
"""Return list of builtin command names."""
116
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
119
def plugin_command_names():
229
"""Returns command names from commands registered by plugins."""
230
120
return plugin_cmds.keys()
123
def _get_cmd_dict(plugins_override=True):
124
"""Return name->class mapping for all commands."""
125
d = _builtin_commands()
127
d.update(plugin_cmds.iteritems())
131
def get_all_cmds(plugins_override=True):
132
"""Return canonical name and class for all registered commands."""
133
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
233
137
def get_cmd_object(cmd_name, plugins_override=True):
234
"""Return the command object for a command.
138
"""Return the canonical name and command class for a command.
237
141
If true, plugin commands can override builtins.
242
146
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.
149
def _get_cmd_object(cmd_name, plugins_override=True):
150
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
151
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
153
# We want only 'ascii' command names, but the user may have typed
256
154
# in a Unicode name. In that case, they should just get a
257
155
# 'command not found' error later.
258
156
# 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:
301
return provider.plugin_for_command(cmd_name), provider
302
except errors.NoPluginAvailable:
304
raise errors.NoPluginAvailable(cmd_name)
307
def _get_bzr_command(cmd_or_None, cmd_name):
308
"""Get a command from bzr's core."""
310
cmd_class = builtin_command_registry.get(cmd_name)
158
# first look up this command under the specified name
159
cmds = _get_cmd_dict(plugins_override=plugins_override)
161
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
165
# look for any command which claims this as an alias
166
for real_cmd_name, cmd_class in cmds.iteritems():
167
if cmd_name in cmd_class.aliases:
324
170
cmd_obj = ExternalCommand.find_command(cmd_name)
174
# look for plugins that provide this command but aren't installed
175
for provider in command_providers_registry:
177
plugin_metadata = provider.plugin_for_command(cmd_name)
178
except errors.NoPluginAvailable:
181
raise errors.CommandAvailableInPlugin(cmd_name,
182
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
187
class Command(object):
404
248
encoding_type = 'strict'
408
252
def __init__(self):
409
253
"""Construct an instance of this command."""
410
254
if self.__doc__ == Command.__doc__:
411
255
warn("No help message set for %r" % self)
412
256
# List of standard options directly supported
413
257
self.supported_std_options = []
416
def add_cleanup(self, cleanup_func, *args, **kwargs):
417
"""Register a function to call after self.run returns or raises.
419
Functions will be called in LIFO order.
421
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
423
def cleanup_now(self):
424
"""Execute and empty pending cleanup functions immediately.
426
After cleanup_now all registered cleanups are forgotten. add_cleanup
427
may be called again after cleanup_now; these cleanups will be called
428
after self.run returns or raises (or when cleanup_now is next called).
430
This is useful for releasing expensive or contentious resources (such
431
as write locks) before doing further work that does not require those
432
resources (such as writing results to self.outf). Note though, that
433
as it releases all resources, this may release locks that the command
434
wants to hold, so use should be done with care.
436
self._operation.cleanup_now()
438
@deprecated_method(deprecated_in((2, 1, 0)))
439
259
def _maybe_expand_globs(self, file_list):
440
260
"""Glob expand file_list if the platform does not do that itself.
442
Not used anymore, now that the bzr command-line parser globs on
445
262
:return: A possibly empty list of unicode paths.
447
264
Introduced in bzrlib 0.18.
268
if sys.platform == 'win32':
269
file_list = win32utils.glob_expand(file_list)
270
return list(file_list)
451
272
def _usage(self):
452
273
"""Return single-line grammar for this command.
469
290
def get_help_text(self, additional_see_also=None, plain=True,
470
see_also_as_links=False, verbose=True):
291
see_also_as_links=False):
471
292
"""Return a text string with help for this command.
473
294
:param additional_see_also: Additional help topics to be
474
295
cross-referenced.
475
296
:param plain: if False, raw help (reStructuredText) is
476
297
returned instead of plain text.
477
298
:param see_also_as_links: if True, convert items in 'See also'
478
299
list to internal links (used by bzr_man rstx generator)
479
:param verbose: if True, display the full help, otherwise
480
leave out the descriptive sections and just display
481
usage help (e.g. Purpose, Usage, Options) with a
482
message explaining how to obtain full help.
484
301
doc = self.help()
486
303
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
488
305
# Extract the summary (purpose) and sections out from the text
489
purpose,sections,order = self._get_help_parts(doc)
306
purpose,sections = self._get_help_parts(doc)
491
308
# If a custom usage section was provided, use it
492
309
if sections.has_key('Usage'):
506
323
# Add the options
508
# XXX: optparse implicitly rewraps the help, and not always perfectly,
509
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
511
324
options = option.get_optparser(self.options()).format_option_help()
512
# XXX: According to the spec, ReST option lists actually don't support
513
# options like --1.9 so that causes syntax errors (in Sphinx at least).
514
# As that pattern always appears in the commands that break, we trap
515
# on that and then format that block of 'format' options as a literal
517
if not plain and options.find(' --1.9 ') != -1:
518
options = options.replace(' format:\n', ' format::\n\n', 1)
519
325
if options.startswith('Options:'):
520
326
result += ':' + options
521
327
elif options.startswith('options:'):
525
331
result += options
529
# Add the description, indenting it 2 spaces
530
# to match the indentation of the options
531
if sections.has_key(None):
532
text = sections.pop(None)
533
text = '\n '.join(text.splitlines())
534
result += ':%s:\n %s\n\n' % ('Description',text)
334
# Add the description, indenting it 2 spaces
335
# to match the indentation of the options
336
if sections.has_key(None):
337
text = sections.pop(None)
338
text = '\n '.join(text.splitlines())
339
result += ':%s:\n %s\n\n' % ('Description',text)
536
# Add the custom sections (e.g. Examples). Note that there's no need
537
# to indent these as they must be indented already in the source.
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
544
result += ("See bzr help %s for more details and examples.\n\n"
341
# Add the custom sections (e.g. Examples). Note that there's no need
342
# to indent these as they must be indented already in the source.
344
labels = sorted(sections.keys())
346
result += ':%s:\n%s\n\n' % (label,sections[label])
547
348
# Add the aliases, source (plug-in) and see also links, if any
578
378
def _get_help_parts(text):
579
379
"""Split help text into a summary and named sections.
581
:return: (summary,sections,order) where summary is the top line and
381
:return: (summary,sections) where summary is the top line and
582
382
sections is a dictionary of the rest indexed by section name.
583
order is the order the section appear in the text.
584
383
A section starts with a heading line of the form ":xxx:".
585
384
Indented text on following lines is the section value.
586
385
All text found outside a named section is assigned to the
587
386
default section which is given the key of None.
589
def save_section(sections, order, label, section):
388
def save_section(sections, label, section):
590
389
if len(section) > 0:
591
390
if sections.has_key(label):
592
391
sections[label] += '\n' + section
595
393
sections[label] = section
597
395
lines = text.rstrip().splitlines()
598
396
summary = lines.pop(0)
601
398
label,section = None,''
602
399
for line in lines:
603
400
if line.startswith(':') and line.endswith(':') and len(line) > 2:
604
save_section(sections, order, label, section)
401
save_section(sections, label, section)
605
402
label,section = line[1:-1],''
606
403
elif (label is not None) and len(line) > 1 and not line[0].isspace():
607
save_section(sections, order, label, section)
404
save_section(sections, label, section)
608
405
label,section = None,line
610
407
if len(section) > 0:
611
408
section += '\n' + line
614
save_section(sections, order, label, section)
615
return summary, sections, order
411
save_section(sections, label, section)
412
return summary, sections
617
414
def get_help_topic(self):
618
415
"""Return the commands help topic - its name."""
648
445
def _setup_outf(self):
649
446
"""Return a file linked to stdout, which has proper encoding."""
650
self.outf = ui.ui_factory.make_output_stream(
651
encoding_type=self.encoding_type)
447
# Originally I was using self.stdout, but that looks
448
# *way* too much like sys.stdout
449
if self.encoding_type == 'exact':
450
# force sys.stdout to be binary stream on win32
451
if sys.platform == 'win32':
452
fileno = getattr(sys.stdout, 'fileno', None)
455
msvcrt.setmode(fileno(), os.O_BINARY)
456
self.outf = sys.stdout
459
output_encoding = osutils.get_terminal_encoding()
461
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
462
errors=self.encoding_type)
463
# For whatever reason codecs.getwriter() does not advertise its encoding
464
# it just returns the encoding of the wrapped file, which is completely
465
# bogus. So set the attribute, so we can find the correct encoding later.
466
self.outf.encoding = output_encoding
653
468
def run_argv_aliases(self, argv, alias_argv=None):
654
469
"""Parse the command line and run with extra aliases in alias_argv."""
471
warn("Passing None for [] is deprecated from bzrlib 0.10",
472
DeprecationWarning, stacklevel=2)
655
474
args, opts = parse_args(self, argv, alias_argv)
657
476
# Process the standard options
658
477
if 'help' in opts: # e.g. bzr add --help
659
478
sys.stdout.write(self.get_help_text())
661
if 'usage' in opts: # e.g. bzr add --usage
662
sys.stdout.write(self.get_help_text(verbose=False))
664
480
trace.set_verbosity_level(option._verbosity_level)
665
481
if 'verbose' in self.supported_std_options:
666
482
opts['verbose'] = trace.is_verbose()
685
501
return self.run(**all_cmd_args)
687
def _setup_run(self):
688
"""Wrap the defined run method on self with a cleanup.
690
This is called by __init__ to make the Command be able to be run
691
by just calling run(), as it could be before cleanups were added.
693
If a different form of cleanups are in use by your Command subclass,
694
you can override this method.
697
def run(*args, **kwargs):
698
self._operation = cleanup.OperationWithCleanups(class_run)
700
return self._operation.run_simple(*args, **kwargs)
705
@deprecated_method(deprecated_in((2, 2, 0)))
706
def run_direct(self, *args, **kwargs):
707
"""Deprecated thunk from bzrlib 2.1."""
708
return self.run(*args, **kwargs)
711
504
"""Actually run the command.
716
509
Return 0 or None if the command was successful, or a non-zero
717
510
shell error code if not. It's OK for this method to allow
718
511
an exception to raise up.
720
This method is automatically wrapped by Command.__init__ with a
721
cleanup operation, stored as self._operation. This can be used
722
via self.add_cleanup to perform automatic cleanups at the end of
725
The argument for run are assembled by introspection. So for instance,
726
if your command takes an argument files, you would declare::
728
def run(self, files=None):
731
513
raise NotImplementedError('no implementation of command %r'
756
class CommandHooks(Hooks):
757
"""Hooks related to Command object creation/enumeration."""
760
"""Create the default hooks.
762
These are all empty initially, because by default nothing should get
766
self.create_hook(HookPoint('extend_command',
767
"Called after creating a command object to allow modifications "
768
"such as adding or removing options, docs etc. Called with the "
769
"new bzrlib.commands.Command object.", (1, 13), None))
770
self.create_hook(HookPoint('get_command',
771
"Called when creating a single command. Called with "
772
"(cmd_or_None, command_name). get_command should either return "
773
"the cmd_or_None parameter, or a replacement Command object that "
774
"should be used for the command. Note that the Command.hooks "
775
"hooks are core infrastructure. Many users will prefer to use "
776
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
778
self.create_hook(HookPoint('get_missing_command',
779
"Called when creating a single command if no command could be "
780
"found. Called with (command_name). get_missing_command should "
781
"either return None, or a Command object to be used for the "
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
784
"Called when enumerating commands. Called with a set of "
785
"cmd_name strings for all the commands found so far. This set "
786
" is safe to mutate - e.g. to remove a command. "
787
"list_commands should return the updated set of command names.",
790
Command.hooks = CommandHooks()
793
538
def parse_args(command, argv, alias_argv=None):
794
539
"""Parse command line.
796
541
Arguments and options are parsed at this level before being passed
797
542
down to specific command handlers. This routine knows, from a
798
543
lookup table, something about the available options, what optargs
862
607
tracer = trace.Trace(count=1, trace=0)
863
608
sys.settrace(tracer.globaltrace)
864
threading.settrace(tracer.globaltrace)
867
return exception_to_return_code(the_callable, *args, **kwargs)
870
results = tracer.results()
871
results.write_results(show_missing=1, summary=False,
610
ret = the_callable(*args, **kwargs)
613
results = tracer.results()
614
results.write_results(show_missing=1, summary=False,
875
618
def apply_profiled(the_callable, *args, **kwargs):
896
638
os.remove(pfname)
899
def exception_to_return_code(the_callable, *args, **kwargs):
900
"""UI level helper for profiling and coverage.
902
This transforms exceptions into a return value of 3. As such its only
903
relevant to the UI layer, and should never be called where catching
904
exceptions may be desirable.
907
return the_callable(*args, **kwargs)
908
except (KeyboardInterrupt, Exception), e:
909
# used to handle AssertionError and KeyboardInterrupt
910
# specially here, but hopefully they're handled ok by the logger now
911
exc_info = sys.exc_info()
912
exitcode = trace.report_exception(exc_info, sys.stderr)
913
if os.environ.get('BZR_PDB'):
914
print '**** entering debugger'
917
if sys.version_info[:2] < (2, 6):
919
# pdb.post_mortem(tb)
920
# but because pdb.post_mortem gives bad results for tracebacks
921
# from inside generators, we do it manually.
922
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
924
# Setup pdb on the traceback
927
p.setup(tb.tb_frame, tb)
928
# Point the debugger at the deepest frame of the stack
929
p.curindex = len(p.stack) - 1
930
p.curframe = p.stack[p.curindex][0]
931
# Start the pdb prompt.
932
p.print_stack_entry(p.stack[p.curindex])
940
641
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
642
from bzrlib.lsprof import profile
942
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
643
ret, stats = profile(the_callable, *args, **kwargs)
944
645
if filename is None:
969
670
config = bzrlib.config.GlobalConfig()
970
671
alias = config.get_alias(cmd)
972
return cmdline.split(alias)
673
return shlex_split_unicode(alias)
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
977
678
"""Execute a command.
979
:param argv: The command-line arguments, without the program name from
980
argv[0] These should already be decoded. All library/test code calling
981
run_bzr should be passing valid strings (don't need decoding).
982
:param load_plugins: What function to call when triggering plugin loading.
983
This function should take no arguments and cause all plugins to be
985
:param disable_plugins: What function to call when disabling plugin
986
loading. This function should take no arguments and cause all plugin
987
loading to be prohibited (so that code paths in your application that
988
know about some plugins possibly being present will fail to import
989
those plugins even if they are installed.)
990
:return: Returns a command exit code or raises an exception.
681
The command-line arguments, without the program name from argv[0]
682
These should already be decoded. All library/test code calling
683
run_bzr should be passing valid strings (don't need decoding).
685
Returns a command status or raises an exception.
992
687
Special master options: these must come before the command because
993
688
they control how the command is interpreted.
1109
799
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1111
801
ret = run(*run_argv)
802
if 'memory' in debug.debug_flags:
803
trace.debug_memory('Process status after command:', short=False)
1114
806
# reset, in case we may do other commands later within the same
1115
807
# process. Commands that want to execute sub-commands must propagate
1116
808
# --verbose in their own way.
1117
if 'memory' in debug.debug_flags:
1118
trace.debug_memory('Process status after command:', short=False)
1119
809
option._verbosity_level = saved_verbosity_level
1122
811
def display_command(func):
1123
812
"""Decorator that suppresses pipe/interrupt errors."""
1124
813
def ignore_pipe(*args, **kwargs):
1139
828
return ignore_pipe
1142
def install_bzr_command_hooks():
1143
"""Install the hooks to supply bzr's own commands."""
1144
if _list_bzr_commands in Command.hooks["list_commands"]:
1146
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1148
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1150
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1151
"bzr plugin commands")
1152
Command.hooks.install_named_hook("get_command", _get_external_command,
1153
"bzr external command lookup")
1154
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1155
"bzr plugin-provider-db check")
1159
def _specified_or_unicode_argv(argv):
1160
# For internal or testing use, argv can be passed. Otherwise, get it from
1161
# the process arguments in a unicode-safe way.
1163
return osutils.get_unicode_argv()
1167
# ensure all arguments are unicode strings
1169
if isinstance(a, unicode):
1172
new_argv.append(a.decode('ascii'))
1173
except UnicodeDecodeError:
1174
raise errors.BzrError("argv should be list of unicode strings.")
1178
def main(argv=None):
1179
"""Main entry point of command-line interface.
1181
Typically `bzrlib.initialize` should be called first.
1183
:param argv: list of unicode command-line arguments similar to sys.argv.
1184
argv[0] is script name usually, it will be ignored.
1185
Don't pass here sys.argv because this list contains plain strings
1186
and not unicode; pass None instead.
1188
:return: exit code of bzr command.
1190
argv = _specified_or_unicode_argv(argv)
1191
_register_builtin_commands()
833
from bzrlib.ui.text import TextUIFactory
834
bzrlib.ui.ui_factory = TextUIFactory()
836
# Is this a final release version? If so, we should suppress warnings
837
if bzrlib.version_info[3] == 'final':
838
from bzrlib import symbol_versioning
839
symbol_versioning.suppress_deprecation_warnings(override=False)
841
user_encoding = osutils.get_user_encoding()
842
argv = [a.decode(user_encoding) for a in argv[1:]]
843
except UnicodeDecodeError:
844
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
1192
846
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1195
847
trace.mutter("return code %d", ret)
1199
851
def run_bzr_catch_errors(argv):
1200
"""Run a bzr command with parameters as described by argv.
1202
This function assumed that that UI layer is setup, that symbol deprecations
1203
are already applied, and that unicode decoding has already been performed on argv.
1205
# done here so that they're covered for every test run
1206
install_bzr_command_hooks()
1207
return exception_to_return_code(run_bzr, argv)
852
# Note: The except clause logic below should be kept in sync with the
853
# profile() routine in lsprof.py.
856
except (KeyboardInterrupt, Exception), e:
857
# used to handle AssertionError and KeyboardInterrupt
858
# specially here, but hopefully they're handled ok by the logger now
859
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
860
if os.environ.get('BZR_PDB'):
861
print '**** entering debugger'
863
pdb.post_mortem(sys.exc_traceback)
1210
867
def run_bzr_catch_user_errors(argv):
added
removed
bzrlib/commands.py
