178
220
def _get_signing_policy(self):
179
221
"""Template method to override signature creation policy."""
225
def expand_options(self, string, env=None):
226
"""Expand option references in the string in the configuration context.
228
:param string: The string containing option to expand.
230
:param env: An option dict defining additional configuration options or
231
overriding existing ones.
233
:returns: The expanded string.
235
return self._expand_options_in_string(string, env)
237
def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
238
"""Expand options in a list of strings in the configuration context.
240
:param slist: A list of strings.
242
:param env: An option dict defining additional configuration options or
243
overriding existing ones.
245
:param _ref_stack: Private list containing the options being
246
expanded to detect loops.
248
:returns: The flatten list of expanded strings.
250
# expand options in each value separately flattening lists
253
value = self._expand_options_in_string(s, env, _ref_stack)
254
if isinstance(value, list):
260
def _expand_options_in_string(self, string, env=None, _ref_stack=None):
261
"""Expand options in the string in the configuration context.
263
:param string: The string to be expanded.
265
:param env: An option dict defining additional configuration options or
266
overriding existing ones.
268
:param _ref_stack: Private list containing the options being
269
expanded to detect loops.
271
:returns: The expanded string.
274
# Not much to expand there
276
if _ref_stack is None:
277
# What references are currently resolved (to detect loops)
279
if self.option_ref_re is None:
280
# We want to match the most embedded reference first (i.e. for
281
# '{{foo}}' we will get '{foo}',
282
# for '{bar{baz}}' we will get '{baz}'
283
self.option_ref_re = re.compile('({[^{}]+})')
285
# We need to iterate until no more refs appear ({{foo}} will need two
286
# iterations for example).
288
raw_chunks = self.option_ref_re.split(result)
289
if len(raw_chunks) == 1:
290
# Shorcut the trivial case: no refs
294
# Split will isolate refs so that every other chunk is a ref
296
for chunk in raw_chunks:
299
# Keep only non-empty strings (or we get bogus empty
300
# slots when a list value is involved).
305
if name in _ref_stack:
306
raise errors.OptionExpansionLoop(string, _ref_stack)
307
_ref_stack.append(name)
308
value = self._expand_option(name, env, _ref_stack)
310
raise errors.ExpandingUnknownOption(name, string)
311
if isinstance(value, list):
319
# Once a list appears as the result of an expansion, all
320
# callers will get a list result. This allows a consistent
321
# behavior even when some options in the expansion chain
322
# defined as strings (no comma in their value) but their
323
# expanded value is a list.
324
return self._expand_options_in_list(chunks, env, _ref_stack)
326
result = ''.join(chunks)
329
def _expand_option(self, name, env, _ref_stack):
330
if env is not None and name in env:
331
# Special case, values provided in env takes precedence over
335
# FIXME: This is a limited implementation, what we really need is a
336
# way to query the bzr config for the value of an option,
337
# respecting the scope rules (That is, once we implement fallback
338
# configs, getting the option value should restart from the top
339
# config, not the current one) -- vila 20101222
340
value = self.get_user_option(name, expand=False)
341
if isinstance(value, list):
342
value = self._expand_options_in_list(value, env, _ref_stack)
344
value = self._expand_options_in_string(value, env, _ref_stack)
181
347
def _get_user_option(self, option_name):
182
348
"""Template method to provide a user option."""
185
def get_user_option(self, option_name):
186
"""Get a generic option - no special process, no default."""
187
return self._get_user_option(option_name)
189
def get_user_option_as_bool(self, option_name):
190
"""Get a generic option as a boolean - no special process, no default.
351
def get_user_option(self, option_name, expand=None):
352
"""Get a generic option - no special process, no default.
354
:param option_name: The queried option.
356
:param expand: Whether options references should be expanded.
358
:returns: The value of the option.
361
expand = _get_expand_default_value()
362
value = self._get_user_option(option_name)
364
if isinstance(value, list):
365
value = self._expand_options_in_list(value)
366
elif isinstance(value, dict):
367
trace.warning('Cannot expand "%s":'
368
' Dicts do not support option expansion'
371
value = self._expand_options_in_string(value)
372
for hook in OldConfigHooks['get']:
373
hook(self, option_name, value)
376
def get_user_option_as_bool(self, option_name, expand=None, default=None):
377
"""Get a generic option as a boolean.
379
:param expand: Allow expanding references to other config values.
380
:param default: Default value if nothing is configured
192
381
:return None if the option doesn't exist or its value can't be
193
382
interpreted as a boolean. Returns True or False otherwise.
195
s = self._get_user_option(option_name)
384
s = self.get_user_option(option_name, expand=expand)
197
386
# The option doesn't exist
199
388
val = ui.bool_from_string(s)
201
390
# The value can't be interpreted as a boolean
540
def get_merge_tools(self):
542
for (oname, value, section, conf_id, parser) in self._get_options():
543
if oname.startswith('bzr.mergetool.'):
544
tool_name = oname[len('bzr.mergetool.'):]
545
tools[tool_name] = value
546
trace.mutter('loaded merge tools: %r' % tools)
549
def find_merge_tool(self, name):
550
# We fake a defaults mechanism here by checking if the given name can
551
# be found in the known_merge_tools if it's not found in the config.
552
# This should be done through the proposed config defaults mechanism
553
# when it becomes available in the future.
554
command_line = (self.get_user_option('bzr.mergetool.%s' % name,
556
or mergetools.known_merge_tools.get(name, None))
560
class _ConfigHooks(hooks.Hooks):
561
"""A dict mapping hook names and a list of callables for configs.
565
"""Create the default hooks.
567
These are all empty initially, because by default nothing should get
570
super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
571
self.add_hook('load',
572
'Invoked when a config store is loaded.'
573
' The signature is (store).',
575
self.add_hook('save',
576
'Invoked when a config store is saved.'
577
' The signature is (store).',
579
# The hooks for config options
581
'Invoked when a config option is read.'
582
' The signature is (stack, name, value).',
585
'Invoked when a config option is set.'
586
' The signature is (stack, name, value).',
588
self.add_hook('remove',
589
'Invoked when a config option is removed.'
590
' The signature is (stack, name).',
592
ConfigHooks = _ConfigHooks()
595
class _OldConfigHooks(hooks.Hooks):
596
"""A dict mapping hook names and a list of callables for configs.
600
"""Create the default hooks.
602
These are all empty initially, because by default nothing should get
605
super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
606
self.add_hook('load',
607
'Invoked when a config store is loaded.'
608
' The signature is (config).',
610
self.add_hook('save',
611
'Invoked when a config store is saved.'
612
' The signature is (config).',
614
# The hooks for config options
616
'Invoked when a config option is read.'
617
' The signature is (config, name, value).',
620
'Invoked when a config option is set.'
621
' The signature is (config, name, value).',
623
self.add_hook('remove',
624
'Invoked when a config option is removed.'
625
' The signature is (config, name).',
627
OldConfigHooks = _OldConfigHooks()
350
630
class IniBasedConfig(Config):
351
631
"""A configuration policy that draws from ini files."""
353
def __init__(self, get_filename):
633
def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
635
"""Base class for configuration files using an ini-like syntax.
637
:param file_name: The configuration file path.
354
639
super(IniBasedConfig, self).__init__()
355
self._get_filename = get_filename
640
self.file_name = file_name
641
if symbol_versioning.deprecated_passed(get_filename):
642
symbol_versioning.warn(
643
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
644
' Use file_name instead.',
647
if get_filename is not None:
648
self.file_name = get_filename()
650
self.file_name = file_name
356
652
self._parser = None
358
def _get_parser(self, file=None):
655
def from_string(cls, str_or_unicode, file_name=None, save=False):
656
"""Create a config object from a string.
658
:param str_or_unicode: A string representing the file content. This will
661
:param file_name: The configuration file path.
663
:param _save: Whether the file should be saved upon creation.
665
conf = cls(file_name=file_name)
666
conf._create_from_string(str_or_unicode, save)
669
def _create_from_string(self, str_or_unicode, save):
670
self._content = StringIO(str_or_unicode.encode('utf-8'))
671
# Some tests use in-memory configs, some other always need the config
672
# file to exist on disk.
674
self._write_config_file()
676
def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
359
677
if self._parser is not None:
360
678
return self._parser
362
input = self._get_filename()
679
if symbol_versioning.deprecated_passed(file):
680
symbol_versioning.warn(
681
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
682
' Use IniBasedConfig(_content=xxx) instead.',
685
if self._content is not None:
686
co_input = self._content
687
elif self.file_name is None:
688
raise AssertionError('We have no content to create the config')
690
co_input = self.file_name
366
self._parser = ConfigObj(input, encoding='utf-8')
692
self._parser = ConfigObj(co_input, encoding='utf-8')
367
693
except configobj.ConfigObjError, e:
368
694
raise errors.ParseConfigError(e.errors, e.config.filename)
695
# Make sure self.reload() will use the right file name
696
self._parser.filename = self.file_name
697
for hook in OldConfigHooks['load']:
369
699
return self._parser
702
"""Reload the config file from disk."""
703
if self.file_name is None:
704
raise AssertionError('We need a file name to reload the config')
705
if self._parser is not None:
706
self._parser.reload()
707
for hook in ConfigHooks['load']:
371
710
def _get_matching_sections(self):
372
711
"""Return an ordered list of (section_name, extra_path) pairs.
1508
2155
configobj[name] = value
1510
2157
configobj.setdefault(section, {})[name] = value
2158
for hook in OldConfigHooks['set']:
2159
hook(self, name, value)
2160
self._set_configobj(configobj)
2162
def remove_option(self, option_name, section_name=None):
2163
configobj = self._get_configobj()
2164
if section_name is None:
2165
del configobj[option_name]
2167
del configobj[section_name][option_name]
2168
for hook in OldConfigHooks['remove']:
2169
hook(self, option_name)
1511
2170
self._set_configobj(configobj)
1513
2172
def _get_config_file(self):
1515
return StringIO(self._transport.get_bytes(self._filename))
2174
f = StringIO(self._transport.get_bytes(self._filename))
2175
for hook in OldConfigHooks['load']:
1516
2178
except errors.NoSuchFile:
1517
2179
return StringIO()
1519
2181
def _get_configobj(self):
1520
return ConfigObj(self._get_config_file(), encoding='utf-8')
2182
f = self._get_config_file()
2184
return ConfigObj(f, encoding='utf-8')
1522
2188
def _set_configobj(self, configobj):
1523
2189
out_file = StringIO()
1524
2190
configobj.write(out_file)
1525
2191
out_file.seek(0)
1526
2192
self._transport.put_file(self._filename, out_file)
2193
for hook in OldConfigHooks['save']:
2197
class Option(object):
2198
"""An option definition.
2200
The option *values* are stored in config files and found in sections.
2202
Here we define various properties about the option itself, its default
2203
value, in which config files it can be stored, etc (TBC).
2206
def __init__(self, name, default=None):
2208
self.default = default
2210
def get_default(self):
2216
option_registry = registry.Registry()
2219
option_registry.register(
2220
'editor', Option('editor'),
2221
help='The command called to launch an editor to enter a message.')
2224
class Section(object):
2225
"""A section defines a dict of option name => value.
2227
This is merely a read-only dict which can add some knowledge about the
2228
options. It is *not* a python dict object though and doesn't try to mimic
2232
def __init__(self, section_id, options):
2233
self.id = section_id
2234
# We re-use the dict-like object received
2235
self.options = options
2237
def get(self, name, default=None):
2238
return self.options.get(name, default)
2241
# Mostly for debugging use
2242
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2245
_NewlyCreatedOption = object()
2246
"""Was the option created during the MutableSection lifetime"""
2249
class MutableSection(Section):
2250
"""A section allowing changes and keeping track of the original values."""
2252
def __init__(self, section_id, options):
2253
super(MutableSection, self).__init__(section_id, options)
2256
def set(self, name, value):
2257
if name not in self.options:
2258
# This is a new option
2259
self.orig[name] = _NewlyCreatedOption
2260
elif name not in self.orig:
2261
self.orig[name] = self.get(name, None)
2262
self.options[name] = value
2264
def remove(self, name):
2265
if name not in self.orig:
2266
self.orig[name] = self.get(name, None)
2267
del self.options[name]
2270
class Store(object):
2271
"""Abstract interface to persistent storage for configuration options."""
2273
readonly_section_class = Section
2274
mutable_section_class = MutableSection
2276
def is_loaded(self):
2277
"""Returns True if the Store has been loaded.
2279
This is used to implement lazy loading and ensure the persistent
2280
storage is queried only when needed.
2282
raise NotImplementedError(self.is_loaded)
2285
"""Loads the Store from persistent storage."""
2286
raise NotImplementedError(self.load)
2288
def _load_from_string(self, str_or_unicode):
2289
"""Create a store from a string in configobj syntax.
2291
:param str_or_unicode: A string representing the file content. This will
2292
be encoded to suit store needs internally.
2294
This is for tests and should not be used in production unless a
2295
convincing use case can be demonstrated :)
2297
raise NotImplementedError(self._load_from_string)
2300
"""Unloads the Store.
2302
This should make is_loaded() return False. This is used when the caller
2303
knows that the persistent storage has changed or may have change since
2306
raise NotImplementedError(self.unload)
2309
"""Saves the Store to persistent storage."""
2310
raise NotImplementedError(self.save)
2312
def external_url(self):
2313
raise NotImplementedError(self.external_url)
2315
def get_sections(self):
2316
"""Returns an ordered iterable of existing sections.
2318
:returns: An iterable of (name, dict).
2320
raise NotImplementedError(self.get_sections)
2322
def get_mutable_section(self, section_name=None):
2323
"""Returns the specified mutable section.
2325
:param section_name: The section identifier
2327
raise NotImplementedError(self.get_mutable_section)
2330
# Mostly for debugging use
2331
return "<config.%s(%s)>" % (self.__class__.__name__,
2332
self.external_url())
2335
class IniFileStore(Store):
2336
"""A config Store using ConfigObj for storage.
2338
:ivar transport: The transport object where the config file is located.
2340
:ivar file_name: The config file basename in the transport directory.
2342
:ivar _config_obj: Private member to hold the ConfigObj instance used to
2343
serialize/deserialize the config file.
2346
def __init__(self, transport, file_name):
2347
"""A config Store using ConfigObj for storage.
2349
:param transport: The transport object where the config file is located.
2351
:param file_name: The config file basename in the transport directory.
2353
super(IniFileStore, self).__init__()
2354
self.transport = transport
2355
self.file_name = file_name
2356
self._config_obj = None
2358
def is_loaded(self):
2359
return self._config_obj != None
2362
self._config_obj = None
2365
"""Load the store from the associated file."""
2366
if self.is_loaded():
2368
content = self.transport.get_bytes(self.file_name)
2369
self._load_from_string(content)
2370
for hook in ConfigHooks['load']:
2373
def _load_from_string(self, str_or_unicode):
2374
"""Create a config store from a string.
2376
:param str_or_unicode: A string representing the file content. This will
2377
be utf-8 encoded internally.
2379
This is for tests and should not be used in production unless a
2380
convincing use case can be demonstrated :)
2382
if self.is_loaded():
2383
raise AssertionError('Already loaded: %r' % (self._config_obj,))
2384
co_input = StringIO(str_or_unicode.encode('utf-8'))
2386
# The config files are always stored utf8-encoded
2387
self._config_obj = ConfigObj(co_input, encoding='utf-8')
2388
except configobj.ConfigObjError, e:
2389
self._config_obj = None
2390
raise errors.ParseConfigError(e.errors, self.external_url())
2393
if not self.is_loaded():
2397
self._config_obj.write(out)
2398
self.transport.put_bytes(self.file_name, out.getvalue())
2399
for hook in ConfigHooks['save']:
2402
def external_url(self):
2403
# FIXME: external_url should really accepts an optional relpath
2404
# parameter (bug #750169) :-/ -- vila 2011-04-04
2405
# The following will do in the interim but maybe we don't want to
2406
# expose a path here but rather a config ID and its associated
2407
# object </hand wawe>.
2408
return urlutils.join(self.transport.external_url(), self.file_name)
2410
def get_sections(self):
2411
"""Get the configobj section in the file order.
2413
:returns: An iterable of (name, dict).
2415
# We need a loaded store
2418
except errors.NoSuchFile:
2419
# If the file doesn't exist, there is no sections
2421
cobj = self._config_obj
2423
yield self.readonly_section_class(None, cobj)
2424
for section_name in cobj.sections:
2425
yield self.readonly_section_class(section_name, cobj[section_name])
2427
def get_mutable_section(self, section_name=None):
2428
# We need a loaded store
2431
except errors.NoSuchFile:
2432
# The file doesn't exist, let's pretend it was empty
2433
self._load_from_string('')
2434
if section_name is None:
2435
section = self._config_obj
2437
section = self._config_obj.setdefault(section_name, {})
2438
return self.mutable_section_class(section_name, section)
2441
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
2442
# unlockable stores for use with objects that can already ensure the locking
2443
# (think branches). If different stores (not based on ConfigObj) are created,
2444
# they may face the same issue.
2447
class LockableIniFileStore(IniFileStore):
2448
"""A ConfigObjStore using locks on save to ensure store integrity."""
2450
def __init__(self, transport, file_name, lock_dir_name=None):
2451
"""A config Store using ConfigObj for storage.
2453
:param transport: The transport object where the config file is located.
2455
:param file_name: The config file basename in the transport directory.
2457
if lock_dir_name is None:
2458
lock_dir_name = 'lock'
2459
self.lock_dir_name = lock_dir_name
2460
super(LockableIniFileStore, self).__init__(transport, file_name)
2461
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
2463
def lock_write(self, token=None):
2464
"""Takes a write lock in the directory containing the config file.
2466
If the directory doesn't exist it is created.
2468
# FIXME: This doesn't check the ownership of the created directories as
2469
# ensure_config_dir_exists does. It should if the transport is local
2470
# -- vila 2011-04-06
2471
self.transport.create_prefix()
2472
return self._lock.lock_write(token)
2477
def break_lock(self):
2478
self._lock.break_lock()
2482
# We need to be able to override the undecorated implementation
2483
self.save_without_locking()
2485
def save_without_locking(self):
2486
super(LockableIniFileStore, self).save()
2489
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
2490
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
2491
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
2493
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
2494
# functions or a registry will make it easier and clearer for tests, focusing
2495
# on the relevant parts of the API that needs testing -- vila 20110503 (based
2496
# on a poolie's remark)
2497
class GlobalStore(LockableIniFileStore):
2499
def __init__(self, possible_transports=None):
2500
t = transport.get_transport(config_dir(),
2501
possible_transports=possible_transports)
2502
super(GlobalStore, self).__init__(t, 'bazaar.conf')
2505
class LocationStore(LockableIniFileStore):
2507
def __init__(self, possible_transports=None):
2508
t = transport.get_transport(config_dir(),
2509
possible_transports=possible_transports)
2510
super(LocationStore, self).__init__(t, 'locations.conf')
2513
class BranchStore(IniFileStore):
2515
def __init__(self, branch):
2516
super(BranchStore, self).__init__(branch.control_transport,
2518
self.branch = branch
2520
def lock_write(self, token=None):
2521
return self.branch.lock_write(token)
2524
return self.branch.unlock()
2528
# We need to be able to override the undecorated implementation
2529
self.save_without_locking()
2531
def save_without_locking(self):
2532
super(BranchStore, self).save()
2535
class SectionMatcher(object):
2536
"""Select sections into a given Store.
2538
This intended to be used to postpone getting an iterable of sections from a
2542
def __init__(self, store):
2545
def get_sections(self):
2546
# This is where we require loading the store so we can see all defined
2548
sections = self.store.get_sections()
2549
# Walk the revisions in the order provided
2554
def match(self, secion):
2555
raise NotImplementedError(self.match)
2558
class LocationSection(Section):
2560
def __init__(self, section, length, extra_path):
2561
super(LocationSection, self).__init__(section.id, section.options)
2562
self.length = length
2563
self.extra_path = extra_path
2565
def get(self, name, default=None):
2566
value = super(LocationSection, self).get(name, default)
2567
if value is not None:
2568
policy_name = self.get(name + ':policy', None)
2569
policy = _policy_value.get(policy_name, POLICY_NONE)
2570
if policy == POLICY_APPENDPATH:
2571
value = urlutils.join(value, self.extra_path)
2575
class LocationMatcher(SectionMatcher):
2577
def __init__(self, store, location):
2578
super(LocationMatcher, self).__init__(store)
2579
if location.startswith('file://'):
2580
location = urlutils.local_path_from_url(location)
2581
self.location = location
2583
def _get_matching_sections(self):
2584
"""Get all sections matching ``location``."""
2585
# We slightly diverge from LocalConfig here by allowing the no-name
2586
# section as the most generic one and the lower priority.
2587
no_name_section = None
2589
# Filter out the no_name_section so _iter_for_location_by_parts can be
2590
# used (it assumes all sections have a name).
2591
for section in self.store.get_sections():
2592
if section.id is None:
2593
no_name_section = section
2595
sections.append(section)
2596
# Unfortunately _iter_for_location_by_parts deals with section names so
2597
# we have to resync.
2598
filtered_sections = _iter_for_location_by_parts(
2599
[s.id for s in sections], self.location)
2600
iter_sections = iter(sections)
2601
matching_sections = []
2602
if no_name_section is not None:
2603
matching_sections.append(
2604
LocationSection(no_name_section, 0, self.location))
2605
for section_id, extra_path, length in filtered_sections:
2606
# a section id is unique for a given store so it's safe to iterate
2608
section = iter_sections.next()
2609
if section_id == section.id:
2610
matching_sections.append(
2611
LocationSection(section, length, extra_path))
2612
return matching_sections
2614
def get_sections(self):
2615
# Override the default implementation as we want to change the order
2616
matching_sections = self._get_matching_sections()
2617
# We want the longest (aka more specific) locations first
2618
sections = sorted(matching_sections,
2619
key=lambda section: (section.length, section.id),
2621
# Sections mentioning 'ignore_parents' restrict the selection
2622
for section in sections:
2623
# FIXME: We really want to use as_bool below -- vila 2011-04-07
2624
ignore = section.get('ignore_parents', None)
2625
if ignore is not None:
2626
ignore = ui.bool_from_string(ignore)
2629
# Finally, we have a valid section
2633
class Stack(object):
2634
"""A stack of configurations where an option can be defined"""
2636
def __init__(self, sections_def, store=None, mutable_section_name=None):
2637
"""Creates a stack of sections with an optional store for changes.
2639
:param sections_def: A list of Section or callables that returns an
2640
iterable of Section. This defines the Sections for the Stack and
2641
can be called repeatedly if needed.
2643
:param store: The optional Store where modifications will be
2644
recorded. If none is specified, no modifications can be done.
2646
:param mutable_section_name: The name of the MutableSection where
2647
changes are recorded. This requires the ``store`` parameter to be
2650
self.sections_def = sections_def
2652
self.mutable_section_name = mutable_section_name
2654
def get(self, name):
2655
"""Return the *first* option value found in the sections.
2657
This is where we guarantee that sections coming from Store are loaded
2658
lazily: the loading is delayed until we need to either check that an
2659
option exists or get its value, which in turn may require to discover
2660
in which sections it can be defined. Both of these (section and option
2661
existence) require loading the store (even partially).
2663
# FIXME: No caching of options nor sections yet -- vila 20110503
2665
# Ensuring lazy loading is achieved by delaying section matching (which
2666
# implies querying the persistent storage) until it can't be avoided
2667
# anymore by using callables to describe (possibly empty) section
2669
for section_or_callable in self.sections_def:
2670
# Each section can expand to multiple ones when a callable is used
2671
if callable(section_or_callable):
2672
sections = section_or_callable()
2674
sections = [section_or_callable]
2675
for section in sections:
2676
value = section.get(name)
2677
if value is not None:
2679
if value is not None:
2682
# If the option is registered, it may provide a default value
2684
opt = option_registry.get(name)
2689
value = opt.get_default()
2690
for hook in ConfigHooks['get']:
2691
hook(self, name, value)
2694
def _get_mutable_section(self):
2695
"""Get the MutableSection for the Stack.
2697
This is where we guarantee that the mutable section is lazily loaded:
2698
this means we won't load the corresponding store before setting a value
2699
or deleting an option. In practice the store will often be loaded but
2700
this allows helps catching some programming errors.
2702
section = self.store.get_mutable_section(self.mutable_section_name)
2705
def set(self, name, value):
2706
"""Set a new value for the option."""
2707
section = self._get_mutable_section()
2708
section.set(name, value)
2709
for hook in ConfigHooks['set']:
2710
hook(self, name, value)
2712
def remove(self, name):
2713
"""Remove an existing option."""
2714
section = self._get_mutable_section()
2715
section.remove(name)
2716
for hook in ConfigHooks['remove']:
2720
# Mostly for debugging use
2721
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
2724
class _CompatibleStack(Stack):
2725
"""Place holder for compatibility with previous design.
2727
This is intended to ease the transition from the Config-based design to the
2728
Stack-based design and should not be used nor relied upon by plugins.
2730
One assumption made here is that the daughter classes will all use Stores
2731
derived from LockableIniFileStore).
2733
It implements set() by re-loading the store before applying the
2734
modification and saving it.
2736
The long term plan being to implement a single write by store to save
2737
all modifications, this class should not be used in the interim.
2740
def set(self, name, value):
2743
super(_CompatibleStack, self).set(name, value)
2744
# Force a write to persistent storage
2748
class GlobalStack(_CompatibleStack):
2752
gstore = GlobalStore()
2753
super(GlobalStack, self).__init__([gstore.get_sections], gstore)
2756
class LocationStack(_CompatibleStack):
2758
def __init__(self, location):
2759
lstore = LocationStore()
2760
matcher = LocationMatcher(lstore, location)
2761
gstore = GlobalStore()
2762
super(LocationStack, self).__init__(
2763
[matcher.get_sections, gstore.get_sections], lstore)
2765
class BranchStack(_CompatibleStack):
2767
def __init__(self, branch):
2768
bstore = BranchStore(branch)
2769
lstore = LocationStore()
2770
matcher = LocationMatcher(lstore, branch.base)
2771
gstore = GlobalStore()
2772
super(BranchStack, self).__init__(
2773
[matcher.get_sections, bstore.get_sections, gstore.get_sections],
2775
self.branch = branch
2778
class cmd_config(commands.Command):
2779
__doc__ = """Display, set or remove a configuration option.
2781
Display the active value for a given option.
2783
If --all is specified, NAME is interpreted as a regular expression and all
2784
matching options are displayed mentioning their scope. The active value
2785
that bzr will take into account is the first one displayed for each option.
2787
If no NAME is given, --all .* is implied.
2789
Setting a value is achieved by using name=value without spaces. The value
2790
is set in the most relevant scope and can be checked by displaying the
2794
takes_args = ['name?']
2798
# FIXME: This should be a registry option so that plugins can register
2799
# their own config files (or not) -- vila 20101002
2800
commands.Option('scope', help='Reduce the scope to the specified'
2801
' configuration file',
2803
commands.Option('all',
2804
help='Display all the defined values for the matching options.',
2806
commands.Option('remove', help='Remove the option from'
2807
' the configuration file'),
2810
_see_also = ['configuration']
2812
@commands.display_command
2813
def run(self, name=None, all=False, directory=None, scope=None,
2815
if directory is None:
2817
directory = urlutils.normalize_url(directory)
2819
raise errors.BzrError(
2820
'--all and --remove are mutually exclusive.')
2822
# Delete the option in the given scope
2823
self._remove_config_option(name, directory, scope)
2825
# Defaults to all options
2826
self._show_matching_options('.*', directory, scope)
2829
name, value = name.split('=', 1)
2831
# Display the option(s) value(s)
2833
self._show_matching_options(name, directory, scope)
2835
self._show_value(name, directory, scope)
2838
raise errors.BzrError(
2839
'Only one option can be set.')
2840
# Set the option value
2841
self._set_config_option(name, value, directory, scope)
2843
def _get_configs(self, directory, scope=None):
2844
"""Iterate the configurations specified by ``directory`` and ``scope``.
2846
:param directory: Where the configurations are derived from.
2848
:param scope: A specific config to start from.
2850
if scope is not None:
2851
if scope == 'bazaar':
2852
yield GlobalConfig()
2853
elif scope == 'locations':
2854
yield LocationConfig(directory)
2855
elif scope == 'branch':
2856
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
2858
yield br.get_config()
2861
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
2863
yield br.get_config()
2864
except errors.NotBranchError:
2865
yield LocationConfig(directory)
2866
yield GlobalConfig()
2868
def _show_value(self, name, directory, scope):
2870
for c in self._get_configs(directory, scope):
2873
for (oname, value, section, conf_id, parser) in c._get_options():
2875
# Display only the first value and exit
2877
# FIXME: We need to use get_user_option to take policies
2878
# into account and we need to make sure the option exists
2879
# too (hence the two for loops), this needs a better API
2881
value = c.get_user_option(name)
2882
# Quote the value appropriately
2883
value = parser._quote(value)
2884
self.outf.write('%s\n' % (value,))
2888
raise errors.NoSuchConfigOption(name)
2890
def _show_matching_options(self, name, directory, scope):
2891
name = re.compile(name)
2892
# We want any error in the regexp to be raised *now* so we need to
2893
# avoid the delay introduced by the lazy regexp.
2894
name._compile_and_collapse()
2897
for c in self._get_configs(directory, scope):
2898
for (oname, value, section, conf_id, parser) in c._get_options():
2899
if name.search(oname):
2900
if cur_conf_id != conf_id:
2901
# Explain where the options are defined
2902
self.outf.write('%s:\n' % (conf_id,))
2903
cur_conf_id = conf_id
2905
if (section not in (None, 'DEFAULT')
2906
and cur_section != section):
2907
# Display the section if it's not the default (or only)
2909
self.outf.write(' [%s]\n' % (section,))
2910
cur_section = section
2911
self.outf.write(' %s = %s\n' % (oname, value))
2913
def _set_config_option(self, name, value, directory, scope):
2914
for conf in self._get_configs(directory, scope):
2915
conf.set_user_option(name, value)
2918
raise errors.NoSuchConfig(scope)
2920
def _remove_config_option(self, name, directory, scope):
2922
raise errors.BzrCommandError(
2923
'--remove expects an option to remove.')
2925
for conf in self._get_configs(directory, scope):
2926
for (section_name, section, conf_id) in conf._get_sections():
2927
if scope is not None and conf_id != scope:
2928
# Not the right configuration file
2931
if conf_id != conf.config_id():
2932
conf = self._get_configs(directory, conf_id).next()
2933
# We use the first section in the first config where the
2934
# option is defined to remove it
2935
conf.remove_user_option(name, section_name)
2940
raise errors.NoSuchConfig(scope)
2942
raise errors.NoSuchConfigOption(name)
2946
# We need adapters that can build a Store or a Stack in a test context. Test
2947
# classes, based on TestCaseWithTransport, can use the registry to parametrize
2948
# themselves. The builder will receive a test instance and should return a
2949
# ready-to-use store or stack. Plugins that define new store/stacks can also
2950
# register themselves here to be tested against the tests defined in
2951
# bzrlib.tests.test_config. Note that the builder can be called multiple times
2952
# for the same tests.
2954
# The registered object should be a callable receiving a test instance
2955
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
2957
test_store_builder_registry = registry.Registry()
2959
# The registered object should be a callable receiving a test instance
2960
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
2962
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
