API docs for “bzrlib.option”

Line #	Kind	Name	Docs
123	Function	get_merge_type	Attempt to find the merge class/factory associated with a string.
137	Class	Option	Description of a command line option
256	Class	ListOption	Option used to provide a list of values.
288	Class	RegistryOption	Option based on a registry
416	Class	OptionParser	OptionParser that raises exceptions instead of exiting
425	Function	get_optparser	Generate an optparse parser for bzrlib-style options
435	Function	custom_help	Clone a common option overriding the help.
487	Class	MergeTypeRegistry	Undocumented
36	Function	_parse_revision_str	This handles a revision string -> revno.
102	Function	_parse_change_str	Parse the revision string and return a tuple with left-most
120	Function	_parse_merge_type	Undocumented
443	Function	_standard_option	Register a standard option.
450	Function	_global_option	Register a global option.
455	Function	_global_registry_option	Undocumented
470	Function	_verbosity_level_callback	Undocumented

def _parse_revision_str(revstr):

This handles a revision string -> revno.

This always returns a list. The list will have one element for each revision specifier supplied.

>>> _parse_revision_str('234')
[<RevisionSpec_revno 234>]
>>> _parse_revision_str('234..567')
[<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
>>> _parse_revision_str('..')
[<RevisionSpec None>, <RevisionSpec None>]
>>> _parse_revision_str('..234')
[<RevisionSpec None>, <RevisionSpec_revno 234>]
>>> _parse_revision_str('234..')
[<RevisionSpec_revno 234>, <RevisionSpec None>]
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
[<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
>>> _parse_revision_str('234....789') #Error ?
[<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
>>> _parse_revision_str('revid:test@other.com-234234')
[<RevisionSpec_revid revid:test@other.com-234234>]
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
>>> _parse_revision_str('revid:test@other.com-234234..23')
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
>>> _parse_revision_str('date:2005-04-12')
[<RevisionSpec_date date:2005-04-12>]
>>> _parse_revision_str('date:2005-04-12 12:24:33')
[<RevisionSpec_date date:2005-04-12 12:24:33>]
>>> _parse_revision_str('date:2005-04-12T12:24:33')
[<RevisionSpec_date date:2005-04-12T12:24:33>]
>>> _parse_revision_str('date:2005-04-12,12:24:33')
[<RevisionSpec_date date:2005-04-12,12:24:33>]
>>> _parse_revision_str('-5..23')
[<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
>>> _parse_revision_str('-5')
[<RevisionSpec_revno -5>]
>>> _parse_revision_str('123a')
Traceback (most recent call last):
  ...
NoSuchRevisionSpec: No namespace registered for string: '123a'
>>> _parse_revision_str('abc')
Traceback (most recent call last):
  ...
NoSuchRevisionSpec: No namespace registered for string: 'abc'
>>> _parse_revision_str('branch:../branch2')
[<RevisionSpec_branch branch:../branch2>]
>>> _parse_revision_str('branch:../../branch2')
[<RevisionSpec_branch branch:../../branch2>]
>>> _parse_revision_str('branch:../../branch2..23')
[<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
>>> _parse_revision_str('branch:..\\branch2')
[<RevisionSpec_branch branch:..\branch2>]
>>> _parse_revision_str('branch:..\\..\\branch2..23')
[<RevisionSpec_branch branch:..\..\branch2>, <RevisionSpec_revno 23>]

def _parse_change_str(revstr):

Parse the revision string and return a tuple with left-most parent of the revision.

>>> _parse_change_str('123')
(<RevisionSpec_before before:123>, <RevisionSpec_revno 123>)
>>> _parse_change_str('123..124')
Traceback (most recent call last):
  ...
RangeInChangeOption: Option --change does not accept revision ranges

def _parse_merge_type(typestring):

Undocumented

def get_merge_type(typestring):

Attempt to find the merge class/factory associated with a string.

def get_optparser(options):

Generate an optparse parser for bzrlib-style options

def custom_help(name, help):

Clone a common option overriding the help.

def _standard_option(name, **kwargs):

Register a standard option.

def _global_option(name, **kwargs):

Register a global option.

def _global_registry_option(name, help, registry=None, **kwargs):

Undocumented

def _verbosity_level_callback(option, opt_str, value, parser):

Undocumented

Module b.option