178
229
def _get_signing_policy(self):
179
230
"""Template method to override signature creation policy."""
234
def expand_options(self, string, env=None):
235
"""Expand option references in the string in the configuration context.
237
:param string: The string containing option to expand.
239
:param env: An option dict defining additional configuration options or
240
overriding existing ones.
242
:returns: The expanded string.
244
return self._expand_options_in_string(string, env)
246
def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
247
"""Expand options in a list of strings in the configuration context.
249
:param slist: A list of strings.
251
:param env: An option dict defining additional configuration options or
252
overriding existing ones.
254
:param _ref_stack: Private list containing the options being
255
expanded to detect loops.
257
:returns: The flatten list of expanded strings.
259
# expand options in each value separately flattening lists
262
value = self._expand_options_in_string(s, env, _ref_stack)
263
if isinstance(value, list):
269
def _expand_options_in_string(self, string, env=None, _ref_stack=None):
270
"""Expand options in the string in the configuration context.
272
:param string: The string to be expanded.
274
:param env: An option dict defining additional configuration options or
275
overriding existing ones.
277
:param _ref_stack: Private list containing the options being
278
expanded to detect loops.
280
:returns: The expanded string.
283
# Not much to expand there
285
if _ref_stack is None:
286
# What references are currently resolved (to detect loops)
288
if self.option_ref_re is None:
289
# We want to match the most embedded reference first (i.e. for
290
# '{{foo}}' we will get '{foo}',
291
# for '{bar{baz}}' we will get '{baz}'
292
self.option_ref_re = re.compile('({[^{}]+})')
294
# We need to iterate until no more refs appear ({{foo}} will need two
295
# iterations for example).
297
raw_chunks = self.option_ref_re.split(result)
298
if len(raw_chunks) == 1:
299
# Shorcut the trivial case: no refs
303
# Split will isolate refs so that every other chunk is a ref
305
for chunk in raw_chunks:
308
# Keep only non-empty strings (or we get bogus empty
309
# slots when a list value is involved).
314
if name in _ref_stack:
315
raise errors.OptionExpansionLoop(string, _ref_stack)
316
_ref_stack.append(name)
317
value = self._expand_option(name, env, _ref_stack)
319
raise errors.ExpandingUnknownOption(name, string)
320
if isinstance(value, list):
328
# Once a list appears as the result of an expansion, all
329
# callers will get a list result. This allows a consistent
330
# behavior even when some options in the expansion chain
331
# defined as strings (no comma in their value) but their
332
# expanded value is a list.
333
return self._expand_options_in_list(chunks, env, _ref_stack)
335
result = ''.join(chunks)
338
def _expand_option(self, name, env, _ref_stack):
339
if env is not None and name in env:
340
# Special case, values provided in env takes precedence over
344
# FIXME: This is a limited implementation, what we really need is a
345
# way to query the bzr config for the value of an option,
346
# respecting the scope rules (That is, once we implement fallback
347
# configs, getting the option value should restart from the top
348
# config, not the current one) -- vila 20101222
349
value = self.get_user_option(name, expand=False)
350
if isinstance(value, list):
351
value = self._expand_options_in_list(value, env, _ref_stack)
353
value = self._expand_options_in_string(value, env, _ref_stack)
181
356
def _get_user_option(self, option_name):
182
357
"""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.
360
def get_user_option(self, option_name, expand=None):
361
"""Get a generic option - no special process, no default.
363
:param option_name: The queried option.
365
:param expand: Whether options references should be expanded.
367
:returns: The value of the option.
370
expand = _get_expand_default_value()
371
value = self._get_user_option(option_name)
373
if isinstance(value, list):
374
value = self._expand_options_in_list(value)
375
elif isinstance(value, dict):
376
trace.warning('Cannot expand "%s":'
377
' Dicts do not support option expansion'
380
value = self._expand_options_in_string(value)
381
for hook in OldConfigHooks['get']:
382
hook(self, option_name, value)
385
def get_user_option_as_bool(self, option_name, expand=None, default=None):
386
"""Get a generic option as a boolean.
388
:param expand: Allow expanding references to other config values.
389
:param default: Default value if nothing is configured
192
390
:return None if the option doesn't exist or its value can't be
193
391
interpreted as a boolean. Returns True or False otherwise.
195
s = self._get_user_option(option_name)
393
s = self.get_user_option(option_name, expand=expand)
197
395
# The option doesn't exist
199
397
val = ui.bool_from_string(s)
201
399
# The value can't be interpreted as a boolean
572
def get_merge_tools(self):
574
for (oname, value, section, conf_id, parser) in self._get_options():
575
if oname.startswith('bzr.mergetool.'):
576
tool_name = oname[len('bzr.mergetool.'):]
577
tools[tool_name] = value
578
trace.mutter('loaded merge tools: %r' % tools)
581
def find_merge_tool(self, name):
582
# We fake a defaults mechanism here by checking if the given name can
583
# be found in the known_merge_tools if it's not found in the config.
584
# This should be done through the proposed config defaults mechanism
585
# when it becomes available in the future.
586
command_line = (self.get_user_option('bzr.mergetool.%s' % name,
588
or mergetools.known_merge_tools.get(name, None))
592
class _ConfigHooks(hooks.Hooks):
593
"""A dict mapping hook names and a list of callables for configs.
597
"""Create the default hooks.
599
These are all empty initially, because by default nothing should get
602
super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
603
self.add_hook('load',
604
'Invoked when a config store is loaded.'
605
' The signature is (store).',
607
self.add_hook('save',
608
'Invoked when a config store is saved.'
609
' The signature is (store).',
611
# The hooks for config options
613
'Invoked when a config option is read.'
614
' The signature is (stack, name, value).',
617
'Invoked when a config option is set.'
618
' The signature is (stack, name, value).',
620
self.add_hook('remove',
621
'Invoked when a config option is removed.'
622
' The signature is (stack, name).',
624
ConfigHooks = _ConfigHooks()
627
class _OldConfigHooks(hooks.Hooks):
628
"""A dict mapping hook names and a list of callables for configs.
632
"""Create the default hooks.
634
These are all empty initially, because by default nothing should get
637
super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
638
self.add_hook('load',
639
'Invoked when a config store is loaded.'
640
' The signature is (config).',
642
self.add_hook('save',
643
'Invoked when a config store is saved.'
644
' The signature is (config).',
646
# The hooks for config options
648
'Invoked when a config option is read.'
649
' The signature is (config, name, value).',
652
'Invoked when a config option is set.'
653
' The signature is (config, name, value).',
655
self.add_hook('remove',
656
'Invoked when a config option is removed.'
657
' The signature is (config, name).',
659
OldConfigHooks = _OldConfigHooks()
350
662
class IniBasedConfig(Config):
351
663
"""A configuration policy that draws from ini files."""
353
def __init__(self, get_filename):
665
def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
667
"""Base class for configuration files using an ini-like syntax.
669
:param file_name: The configuration file path.
354
671
super(IniBasedConfig, self).__init__()
355
self._get_filename = get_filename
672
self.file_name = file_name
673
if symbol_versioning.deprecated_passed(get_filename):
674
symbol_versioning.warn(
675
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
676
' Use file_name instead.',
679
if get_filename is not None:
680
self.file_name = get_filename()
682
self.file_name = file_name
356
684
self._parser = None
358
def _get_parser(self, file=None):
687
def from_string(cls, str_or_unicode, file_name=None, save=False):
688
"""Create a config object from a string.
690
:param str_or_unicode: A string representing the file content. This will
693
:param file_name: The configuration file path.
695
:param _save: Whether the file should be saved upon creation.
697
conf = cls(file_name=file_name)
698
conf._create_from_string(str_or_unicode, save)
701
def _create_from_string(self, str_or_unicode, save):
702
self._content = StringIO(str_or_unicode.encode('utf-8'))
703
# Some tests use in-memory configs, some other always need the config
704
# file to exist on disk.
706
self._write_config_file()
708
def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
359
709
if self._parser is not None:
360
710
return self._parser
362
input = self._get_filename()
711
if symbol_versioning.deprecated_passed(file):
712
symbol_versioning.warn(
713
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
714
' Use IniBasedConfig(_content=xxx) instead.',
717
if self._content is not None:
718
co_input = self._content
719
elif self.file_name is None:
720
raise AssertionError('We have no content to create the config')
722
co_input = self.file_name
366
self._parser = ConfigObj(input, encoding='utf-8')
724
self._parser = ConfigObj(co_input, encoding='utf-8')
367
725
except configobj.ConfigObjError, e:
368
726
raise errors.ParseConfigError(e.errors, e.config.filename)
727
except UnicodeDecodeError:
728
raise errors.ConfigContentError(self.file_name)
729
# Make sure self.reload() will use the right file name
730
self._parser.filename = self.file_name
731
for hook in OldConfigHooks['load']:
369
733
return self._parser
736
"""Reload the config file from disk."""
737
if self.file_name is None:
738
raise AssertionError('We need a file name to reload the config')
739
if self._parser is not None:
740
self._parser.reload()
741
for hook in ConfigHooks['load']:
371
744
def _get_matching_sections(self):
372
745
"""Return an ordered list of (section_name, extra_path) pairs.
1508
2207
configobj[name] = value
1510
2209
configobj.setdefault(section, {})[name] = value
2210
for hook in OldConfigHooks['set']:
2211
hook(self, name, value)
2212
self._set_configobj(configobj)
2214
def remove_option(self, option_name, section_name=None):
2215
configobj = self._get_configobj()
2216
if section_name is None:
2217
del configobj[option_name]
2219
del configobj[section_name][option_name]
2220
for hook in OldConfigHooks['remove']:
2221
hook(self, option_name)
1511
2222
self._set_configobj(configobj)
1513
2224
def _get_config_file(self):
1515
return StringIO(self._transport.get_bytes(self._filename))
2226
f = StringIO(self._transport.get_bytes(self._filename))
2227
for hook in OldConfigHooks['load']:
1516
2230
except errors.NoSuchFile:
1517
2231
return StringIO()
2233
def _external_url(self):
2234
return urlutils.join(self._transport.external_url(), self._filename)
1519
2236
def _get_configobj(self):
1520
return ConfigObj(self._get_config_file(), encoding='utf-8')
2237
f = self._get_config_file()
2240
conf = ConfigObj(f, encoding='utf-8')
2241
except configobj.ConfigObjError, e:
2242
raise errors.ParseConfigError(e.errors, self._external_url())
2243
except UnicodeDecodeError:
2244
raise errors.ConfigContentError(self._external_url())
1522
2249
def _set_configobj(self, configobj):
1523
2250
out_file = StringIO()
1524
2251
configobj.write(out_file)
1525
2252
out_file.seek(0)
1526
2253
self._transport.put_file(self._filename, out_file)
2254
for hook in OldConfigHooks['save']:
2258
class Option(object):
2259
"""An option definition.
2261
The option *values* are stored in config files and found in sections.
2263
Here we define various properties about the option itself, its default
2264
value, in which config files it can be stored, etc (TBC).
2267
def __init__(self, name, default=None):
2269
self.default = default
2271
def get_default(self):
2277
option_registry = registry.Registry()
2280
option_registry.register(
2281
'editor', Option('editor'),
2282
help='The command called to launch an editor to enter a message.')
2285
class Section(object):
2286
"""A section defines a dict of option name => value.
2288
This is merely a read-only dict which can add some knowledge about the
2289
options. It is *not* a python dict object though and doesn't try to mimic
2293
def __init__(self, section_id, options):
2294
self.id = section_id
2295
# We re-use the dict-like object received
2296
self.options = options
2298
def get(self, name, default=None):
2299
return self.options.get(name, default)
2302
# Mostly for debugging use
2303
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2306
_NewlyCreatedOption = object()
2307
"""Was the option created during the MutableSection lifetime"""
2310
class MutableSection(Section):
2311
"""A section allowing changes and keeping track of the original values."""
2313
def __init__(self, section_id, options):
2314
super(MutableSection, self).__init__(section_id, options)
2317
def set(self, name, value):
2318
if name not in self.options:
2319
# This is a new option
2320
self.orig[name] = _NewlyCreatedOption
2321
elif name not in self.orig:
2322
self.orig[name] = self.get(name, None)
2323
self.options[name] = value
2325
def remove(self, name):
2326
if name not in self.orig:
2327
self.orig[name] = self.get(name, None)
2328
del self.options[name]
2331
class Store(object):
2332
"""Abstract interface to persistent storage for configuration options."""
2334
readonly_section_class = Section
2335
mutable_section_class = MutableSection
2337
def is_loaded(self):
2338
"""Returns True if the Store has been loaded.
2340
This is used to implement lazy loading and ensure the persistent
2341
storage is queried only when needed.
2343
raise NotImplementedError(self.is_loaded)
2346
"""Loads the Store from persistent storage."""
2347
raise NotImplementedError(self.load)
2349
def _load_from_string(self, bytes):
2350
"""Create a store from a string in configobj syntax.
2352
:param bytes: A string representing the file content.
2354
raise NotImplementedError(self._load_from_string)
2357
"""Unloads the Store.
2359
This should make is_loaded() return False. This is used when the caller
2360
knows that the persistent storage has changed or may have change since
2363
raise NotImplementedError(self.unload)
2366
"""Saves the Store to persistent storage."""
2367
raise NotImplementedError(self.save)
2369
def external_url(self):
2370
raise NotImplementedError(self.external_url)
2372
def get_sections(self):
2373
"""Returns an ordered iterable of existing sections.
2375
:returns: An iterable of (name, dict).
2377
raise NotImplementedError(self.get_sections)
2379
def get_mutable_section(self, section_name=None):
2380
"""Returns the specified mutable section.
2382
:param section_name: The section identifier
2384
raise NotImplementedError(self.get_mutable_section)
2387
# Mostly for debugging use
2388
return "<config.%s(%s)>" % (self.__class__.__name__,
2389
self.external_url())
2392
class IniFileStore(Store):
2393
"""A config Store using ConfigObj for storage.
2395
:ivar transport: The transport object where the config file is located.
2397
:ivar file_name: The config file basename in the transport directory.
2399
:ivar _config_obj: Private member to hold the ConfigObj instance used to
2400
serialize/deserialize the config file.
2403
def __init__(self, transport, file_name):
2404
"""A config Store using ConfigObj for storage.
2406
:param transport: The transport object where the config file is located.
2408
:param file_name: The config file basename in the transport directory.
2410
super(IniFileStore, self).__init__()
2411
self.transport = transport
2412
self.file_name = file_name
2413
self._config_obj = None
2415
def is_loaded(self):
2416
return self._config_obj != None
2419
self._config_obj = None
2422
"""Load the store from the associated file."""
2423
if self.is_loaded():
2425
content = self.transport.get_bytes(self.file_name)
2426
self._load_from_string(content)
2427
for hook in ConfigHooks['load']:
2430
def _load_from_string(self, bytes):
2431
"""Create a config store from a string.
2433
:param bytes: A string representing the file content.
2435
if self.is_loaded():
2436
raise AssertionError('Already loaded: %r' % (self._config_obj,))
2437
co_input = StringIO(bytes)
2439
# The config files are always stored utf8-encoded
2440
self._config_obj = ConfigObj(co_input, encoding='utf-8')
2441
except configobj.ConfigObjError, e:
2442
self._config_obj = None
2443
raise errors.ParseConfigError(e.errors, self.external_url())
2444
except UnicodeDecodeError:
2445
raise errors.ConfigContentError(self.external_url())
2448
if not self.is_loaded():
2452
self._config_obj.write(out)
2453
self.transport.put_bytes(self.file_name, out.getvalue())
2454
for hook in ConfigHooks['save']:
2457
def external_url(self):
2458
# FIXME: external_url should really accepts an optional relpath
2459
# parameter (bug #750169) :-/ -- vila 2011-04-04
2460
# The following will do in the interim but maybe we don't want to
2461
# expose a path here but rather a config ID and its associated
2462
# object </hand wawe>.
2463
return urlutils.join(self.transport.external_url(), self.file_name)
2465
def get_sections(self):
2466
"""Get the configobj section in the file order.
2468
:returns: An iterable of (name, dict).
2470
# We need a loaded store
2473
except errors.NoSuchFile:
2474
# If the file doesn't exist, there is no sections
2476
cobj = self._config_obj
2478
yield self.readonly_section_class(None, cobj)
2479
for section_name in cobj.sections:
2480
yield self.readonly_section_class(section_name, cobj[section_name])
2482
def get_mutable_section(self, section_name=None):
2483
# We need a loaded store
2486
except errors.NoSuchFile:
2487
# The file doesn't exist, let's pretend it was empty
2488
self._load_from_string('')
2489
if section_name is None:
2490
section = self._config_obj
2492
section = self._config_obj.setdefault(section_name, {})
2493
return self.mutable_section_class(section_name, section)
2496
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
2497
# unlockable stores for use with objects that can already ensure the locking
2498
# (think branches). If different stores (not based on ConfigObj) are created,
2499
# they may face the same issue.
2502
class LockableIniFileStore(IniFileStore):
2503
"""A ConfigObjStore using locks on save to ensure store integrity."""
2505
def __init__(self, transport, file_name, lock_dir_name=None):
2506
"""A config Store using ConfigObj for storage.
2508
:param transport: The transport object where the config file is located.
2510
:param file_name: The config file basename in the transport directory.
2512
if lock_dir_name is None:
2513
lock_dir_name = 'lock'
2514
self.lock_dir_name = lock_dir_name
2515
super(LockableIniFileStore, self).__init__(transport, file_name)
2516
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
2518
def lock_write(self, token=None):
2519
"""Takes a write lock in the directory containing the config file.
2521
If the directory doesn't exist it is created.
2523
# FIXME: This doesn't check the ownership of the created directories as
2524
# ensure_config_dir_exists does. It should if the transport is local
2525
# -- vila 2011-04-06
2526
self.transport.create_prefix()
2527
return self._lock.lock_write(token)
2532
def break_lock(self):
2533
self._lock.break_lock()
2537
# We need to be able to override the undecorated implementation
2538
self.save_without_locking()
2540
def save_without_locking(self):
2541
super(LockableIniFileStore, self).save()
2544
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
2545
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
2546
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
2548
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
2549
# functions or a registry will make it easier and clearer for tests, focusing
2550
# on the relevant parts of the API that needs testing -- vila 20110503 (based
2551
# on a poolie's remark)
2552
class GlobalStore(LockableIniFileStore):
2554
def __init__(self, possible_transports=None):
2555
t = transport.get_transport(config_dir(),
2556
possible_transports=possible_transports)
2557
super(GlobalStore, self).__init__(t, 'bazaar.conf')
2560
class LocationStore(LockableIniFileStore):
2562
def __init__(self, possible_transports=None):
2563
t = transport.get_transport(config_dir(),
2564
possible_transports=possible_transports)
2565
super(LocationStore, self).__init__(t, 'locations.conf')
2568
class BranchStore(IniFileStore):
2570
def __init__(self, branch):
2571
super(BranchStore, self).__init__(branch.control_transport,
2573
self.branch = branch
2575
def lock_write(self, token=None):
2576
return self.branch.lock_write(token)
2579
return self.branch.unlock()
2583
# We need to be able to override the undecorated implementation
2584
self.save_without_locking()
2586
def save_without_locking(self):
2587
super(BranchStore, self).save()
2590
class SectionMatcher(object):
2591
"""Select sections into a given Store.
2593
This intended to be used to postpone getting an iterable of sections from a
2597
def __init__(self, store):
2600
def get_sections(self):
2601
# This is where we require loading the store so we can see all defined
2603
sections = self.store.get_sections()
2604
# Walk the revisions in the order provided
2609
def match(self, secion):
2610
raise NotImplementedError(self.match)
2613
class LocationSection(Section):
2615
def __init__(self, section, length, extra_path):
2616
super(LocationSection, self).__init__(section.id, section.options)
2617
self.length = length
2618
self.extra_path = extra_path
2620
def get(self, name, default=None):
2621
value = super(LocationSection, self).get(name, default)
2622
if value is not None:
2623
policy_name = self.get(name + ':policy', None)
2624
policy = _policy_value.get(policy_name, POLICY_NONE)
2625
if policy == POLICY_APPENDPATH:
2626
value = urlutils.join(value, self.extra_path)
2630
class LocationMatcher(SectionMatcher):
2632
def __init__(self, store, location):
2633
super(LocationMatcher, self).__init__(store)
2634
if location.startswith('file://'):
2635
location = urlutils.local_path_from_url(location)
2636
self.location = location
2638
def _get_matching_sections(self):
2639
"""Get all sections matching ``location``."""
2640
# We slightly diverge from LocalConfig here by allowing the no-name
2641
# section as the most generic one and the lower priority.
2642
no_name_section = None
2644
# Filter out the no_name_section so _iter_for_location_by_parts can be
2645
# used (it assumes all sections have a name).
2646
for section in self.store.get_sections():
2647
if section.id is None:
2648
no_name_section = section
2650
sections.append(section)
2651
# Unfortunately _iter_for_location_by_parts deals with section names so
2652
# we have to resync.
2653
filtered_sections = _iter_for_location_by_parts(
2654
[s.id for s in sections], self.location)
2655
iter_sections = iter(sections)
2656
matching_sections = []
2657
if no_name_section is not None:
2658
matching_sections.append(
2659
LocationSection(no_name_section, 0, self.location))
2660
for section_id, extra_path, length in filtered_sections:
2661
# a section id is unique for a given store so it's safe to iterate
2663
section = iter_sections.next()
2664
if section_id == section.id:
2665
matching_sections.append(
2666
LocationSection(section, length, extra_path))
2667
return matching_sections
2669
def get_sections(self):
2670
# Override the default implementation as we want to change the order
2671
matching_sections = self._get_matching_sections()
2672
# We want the longest (aka more specific) locations first
2673
sections = sorted(matching_sections,
2674
key=lambda section: (section.length, section.id),
2676
# Sections mentioning 'ignore_parents' restrict the selection
2677
for section in sections:
2678
# FIXME: We really want to use as_bool below -- vila 2011-04-07
2679
ignore = section.get('ignore_parents', None)
2680
if ignore is not None:
2681
ignore = ui.bool_from_string(ignore)
2684
# Finally, we have a valid section
2688
class Stack(object):
2689
"""A stack of configurations where an option can be defined"""
2691
def __init__(self, sections_def, store=None, mutable_section_name=None):
2692
"""Creates a stack of sections with an optional store for changes.
2694
:param sections_def: A list of Section or callables that returns an
2695
iterable of Section. This defines the Sections for the Stack and
2696
can be called repeatedly if needed.
2698
:param store: The optional Store where modifications will be
2699
recorded. If none is specified, no modifications can be done.
2701
:param mutable_section_name: The name of the MutableSection where
2702
changes are recorded. This requires the ``store`` parameter to be
2705
self.sections_def = sections_def
2707
self.mutable_section_name = mutable_section_name
2709
def get(self, name):
2710
"""Return the *first* option value found in the sections.
2712
This is where we guarantee that sections coming from Store are loaded
2713
lazily: the loading is delayed until we need to either check that an
2714
option exists or get its value, which in turn may require to discover
2715
in which sections it can be defined. Both of these (section and option
2716
existence) require loading the store (even partially).
2718
# FIXME: No caching of options nor sections yet -- vila 20110503
2720
# Ensuring lazy loading is achieved by delaying section matching (which
2721
# implies querying the persistent storage) until it can't be avoided
2722
# anymore by using callables to describe (possibly empty) section
2724
for section_or_callable in self.sections_def:
2725
# Each section can expand to multiple ones when a callable is used
2726
if callable(section_or_callable):
2727
sections = section_or_callable()
2729
sections = [section_or_callable]
2730
for section in sections:
2731
value = section.get(name)
2732
if value is not None:
2734
if value is not None:
2737
# If the option is registered, it may provide a default value
2739
opt = option_registry.get(name)
2744
value = opt.get_default()
2745
for hook in ConfigHooks['get']:
2746
hook(self, name, value)
2749
def _get_mutable_section(self):
2750
"""Get the MutableSection for the Stack.
2752
This is where we guarantee that the mutable section is lazily loaded:
2753
this means we won't load the corresponding store before setting a value
2754
or deleting an option. In practice the store will often be loaded but
2755
this allows helps catching some programming errors.
2757
section = self.store.get_mutable_section(self.mutable_section_name)
2760
def set(self, name, value):
2761
"""Set a new value for the option."""
2762
section = self._get_mutable_section()
2763
section.set(name, value)
2764
for hook in ConfigHooks['set']:
2765
hook(self, name, value)
2767
def remove(self, name):
2768
"""Remove an existing option."""
2769
section = self._get_mutable_section()
2770
section.remove(name)
2771
for hook in ConfigHooks['remove']:
2775
# Mostly for debugging use
2776
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
2779
class _CompatibleStack(Stack):
2780
"""Place holder for compatibility with previous design.
2782
This is intended to ease the transition from the Config-based design to the
2783
Stack-based design and should not be used nor relied upon by plugins.
2785
One assumption made here is that the daughter classes will all use Stores
2786
derived from LockableIniFileStore).
2788
It implements set() by re-loading the store before applying the
2789
modification and saving it.
2791
The long term plan being to implement a single write by store to save
2792
all modifications, this class should not be used in the interim.
2795
def set(self, name, value):
2798
super(_CompatibleStack, self).set(name, value)
2799
# Force a write to persistent storage
2803
class GlobalStack(_CompatibleStack):
2807
gstore = GlobalStore()
2808
super(GlobalStack, self).__init__([gstore.get_sections], gstore)
2811
class LocationStack(_CompatibleStack):
2813
def __init__(self, location):
2814
lstore = LocationStore()
2815
matcher = LocationMatcher(lstore, location)
2816
gstore = GlobalStore()
2817
super(LocationStack, self).__init__(
2818
[matcher.get_sections, gstore.get_sections], lstore)
2820
class BranchStack(_CompatibleStack):
2822
def __init__(self, branch):
2823
bstore = BranchStore(branch)
2824
lstore = LocationStore()
2825
matcher = LocationMatcher(lstore, branch.base)
2826
gstore = GlobalStore()
2827
super(BranchStack, self).__init__(
2828
[matcher.get_sections, bstore.get_sections, gstore.get_sections],
2830
self.branch = branch
2833
class cmd_config(commands.Command):
2834
__doc__ = """Display, set or remove a configuration option.
2836
Display the active value for a given option.
2838
If --all is specified, NAME is interpreted as a regular expression and all
2839
matching options are displayed mentioning their scope. The active value
2840
that bzr will take into account is the first one displayed for each option.
2842
If no NAME is given, --all .* is implied.
2844
Setting a value is achieved by using name=value without spaces. The value
2845
is set in the most relevant scope and can be checked by displaying the
2849
takes_args = ['name?']
2853
# FIXME: This should be a registry option so that plugins can register
2854
# their own config files (or not) -- vila 20101002
2855
commands.Option('scope', help='Reduce the scope to the specified'
2856
' configuration file',
2858
commands.Option('all',
2859
help='Display all the defined values for the matching options.',
2861
commands.Option('remove', help='Remove the option from'
2862
' the configuration file'),
2865
_see_also = ['configuration']
2867
@commands.display_command
2868
def run(self, name=None, all=False, directory=None, scope=None,
2870
if directory is None:
2872
directory = urlutils.normalize_url(directory)
2874
raise errors.BzrError(
2875
'--all and --remove are mutually exclusive.')
2877
# Delete the option in the given scope
2878
self._remove_config_option(name, directory, scope)
2880
# Defaults to all options
2881
self._show_matching_options('.*', directory, scope)
2884
name, value = name.split('=', 1)
2886
# Display the option(s) value(s)
2888
self._show_matching_options(name, directory, scope)
2890
self._show_value(name, directory, scope)
2893
raise errors.BzrError(
2894
'Only one option can be set.')
2895
# Set the option value
2896
self._set_config_option(name, value, directory, scope)
2898
def _get_configs(self, directory, scope=None):
2899
"""Iterate the configurations specified by ``directory`` and ``scope``.
2901
:param directory: Where the configurations are derived from.
2903
:param scope: A specific config to start from.
2905
if scope is not None:
2906
if scope == 'bazaar':
2907
yield GlobalConfig()
2908
elif scope == 'locations':
2909
yield LocationConfig(directory)
2910
elif scope == 'branch':
2911
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
2913
yield br.get_config()
2916
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
2918
yield br.get_config()
2919
except errors.NotBranchError:
2920
yield LocationConfig(directory)
2921
yield GlobalConfig()
2923
def _show_value(self, name, directory, scope):
2925
for c in self._get_configs(directory, scope):
2928
for (oname, value, section, conf_id, parser) in c._get_options():
2930
# Display only the first value and exit
2932
# FIXME: We need to use get_user_option to take policies
2933
# into account and we need to make sure the option exists
2934
# too (hence the two for loops), this needs a better API
2936
value = c.get_user_option(name)
2937
# Quote the value appropriately
2938
value = parser._quote(value)
2939
self.outf.write('%s\n' % (value,))
2943
raise errors.NoSuchConfigOption(name)
2945
def _show_matching_options(self, name, directory, scope):
2946
name = re.compile(name)
2947
# We want any error in the regexp to be raised *now* so we need to
2948
# avoid the delay introduced by the lazy regexp.
2949
name._compile_and_collapse()
2952
for c in self._get_configs(directory, scope):
2953
for (oname, value, section, conf_id, parser) in c._get_options():
2954
if name.search(oname):
2955
if cur_conf_id != conf_id:
2956
# Explain where the options are defined
2957
self.outf.write('%s:\n' % (conf_id,))
2958
cur_conf_id = conf_id
2960
if (section not in (None, 'DEFAULT')
2961
and cur_section != section):
2962
# Display the section if it's not the default (or only)
2964
self.outf.write(' [%s]\n' % (section,))
2965
cur_section = section
2966
self.outf.write(' %s = %s\n' % (oname, value))
2968
def _set_config_option(self, name, value, directory, scope):
2969
for conf in self._get_configs(directory, scope):
2970
conf.set_user_option(name, value)
2973
raise errors.NoSuchConfig(scope)
2975
def _remove_config_option(self, name, directory, scope):
2977
raise errors.BzrCommandError(
2978
'--remove expects an option to remove.')
2980
for conf in self._get_configs(directory, scope):
2981
for (section_name, section, conf_id) in conf._get_sections():
2982
if scope is not None and conf_id != scope:
2983
# Not the right configuration file
2986
if conf_id != conf.config_id():
2987
conf = self._get_configs(directory, conf_id).next()
2988
# We use the first section in the first config where the
2989
# option is defined to remove it
2990
conf.remove_user_option(name, section_name)
2995
raise errors.NoSuchConfig(scope)
2997
raise errors.NoSuchConfigOption(name)
3001
# We need adapters that can build a Store or a Stack in a test context. Test
3002
# classes, based on TestCaseWithTransport, can use the registry to parametrize
3003
# themselves. The builder will receive a test instance and should return a
3004
# ready-to-use store or stack. Plugins that define new store/stacks can also
3005
# register themselves here to be tested against the tests defined in
3006
# bzrlib.tests.test_config. Note that the builder can be called multiple times
3007
# for the same tests.
3009
# The registered object should be a callable receiving a test instance
3010
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
3012
test_store_builder_registry = registry.Registry()
3014
# The registered object should be a callable receiving a test instance
3015
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
3017
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
