← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

  • Committer: Aaron Bentley
  • Date: 2007-01-09 15:12:48 UTC
  • mto: This revision was merged to the branch mainline in revision 2240.
  • Revision ID: abentley@panoramicfeedback.com-20070109151248-nmc1xu326dp8g3u4
Improve text and naming

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/option.py
188
188
 
189
189
 
190
190
class RegistryOption(Option):
191
 
    """Option based on a registry"""
 
191
    """Option based on a registry
 
192
    
 
193
    The values for the options correspond to entries in the registry.  Input
 
194
    must be a registry key.  After validation, it is converted into an object
 
195
    using Registry.get or a caller-provided converter.
 
196
    """
192
197
 
193
198
    def validate_value(self, value):
194
199
        """Validate a value name"""
195
200
        if value not in self.registry:
196
 
            raise errors.BadOptionParam(self.name, value)
 
201
            raise errors.BadOptionValue(self.name, value)
197
202
 
198
203
    def convert(self, value):
199
204
        """Convert a value name into an output type"""
212
217
        :param help: Help for the option.
213
218
        :param registry: A Registry containing the values
214
219
        :param converter: Callable to invoke with the value name to produce
215
 
            the value.  If not supplied, registry.get is used.
 
220
            the value.  If not supplied, self.registry.get is used.
216
221
        :param value_switches: If true, each possible value is assigned its
217
222
            own switch.  For example, instead of '--format metaweave', 
218
223
            '--metaweave' can be used interchangeably.
250
255
            for key in sorted(self.registry.keys()):
251
256
                yield key, None, None, self.registry.get_help(key)
252
257
 
 
258
 
253
259
class OptionParser(optparse.OptionParser):
254
260
    """OptionParser that raises exceptions instead of exiting"""
255
261