178
230
def _get_signing_policy(self):
179
231
"""Template method to override signature creation policy."""
235
def expand_options(self, string, env=None):
236
"""Expand option references in the string in the configuration context.
238
:param string: The string containing option to expand.
240
:param env: An option dict defining additional configuration options or
241
overriding existing ones.
243
:returns: The expanded string.
245
return self._expand_options_in_string(string, env)
247
def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
248
"""Expand options in a list of strings in the configuration context.
250
:param slist: A list of strings.
252
:param env: An option dict defining additional configuration options or
253
overriding existing ones.
255
:param _ref_stack: Private list containing the options being
256
expanded to detect loops.
258
:returns: The flatten list of expanded strings.
260
# expand options in each value separately flattening lists
263
value = self._expand_options_in_string(s, env, _ref_stack)
264
if isinstance(value, list):
270
def _expand_options_in_string(self, string, env=None, _ref_stack=None):
271
"""Expand options in the string in the configuration context.
273
:param string: The string to be expanded.
275
:param env: An option dict defining additional configuration options or
276
overriding existing ones.
278
:param _ref_stack: Private list containing the options being
279
expanded to detect loops.
281
:returns: The expanded string.
284
# Not much to expand there
286
if _ref_stack is None:
287
# What references are currently resolved (to detect loops)
289
if self.option_ref_re is None:
290
# We want to match the most embedded reference first (i.e. for
291
# '{{foo}}' we will get '{foo}',
292
# for '{bar{baz}}' we will get '{baz}'
293
self.option_ref_re = re.compile('({[^{}]+})')
295
# We need to iterate until no more refs appear ({{foo}} will need two
296
# iterations for example).
298
raw_chunks = self.option_ref_re.split(result)
299
if len(raw_chunks) == 1:
300
# Shorcut the trivial case: no refs
304
# Split will isolate refs so that every other chunk is a ref
306
for chunk in raw_chunks:
309
# Keep only non-empty strings (or we get bogus empty
310
# slots when a list value is involved).
315
if name in _ref_stack:
316
raise errors.OptionExpansionLoop(string, _ref_stack)
317
_ref_stack.append(name)
318
value = self._expand_option(name, env, _ref_stack)
320
raise errors.ExpandingUnknownOption(name, string)
321
if isinstance(value, list):
329
# Once a list appears as the result of an expansion, all
330
# callers will get a list result. This allows a consistent
331
# behavior even when some options in the expansion chain
332
# defined as strings (no comma in their value) but their
333
# expanded value is a list.
334
return self._expand_options_in_list(chunks, env, _ref_stack)
336
result = ''.join(chunks)
339
def _expand_option(self, name, env, _ref_stack):
340
if env is not None and name in env:
341
# Special case, values provided in env takes precedence over
345
# FIXME: This is a limited implementation, what we really need is a
346
# way to query the bzr config for the value of an option,
347
# respecting the scope rules (That is, once we implement fallback
348
# configs, getting the option value should restart from the top
349
# config, not the current one) -- vila 20101222
350
value = self.get_user_option(name, expand=False)
351
if isinstance(value, list):
352
value = self._expand_options_in_list(value, env, _ref_stack)
354
value = self._expand_options_in_string(value, env, _ref_stack)
181
357
def _get_user_option(self, option_name):
182
358
"""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.
361
def get_user_option(self, option_name, expand=None):
362
"""Get a generic option - no special process, no default.
364
:param option_name: The queried option.
366
:param expand: Whether options references should be expanded.
368
:returns: The value of the option.
371
expand = _get_expand_default_value()
372
value = self._get_user_option(option_name)
374
if isinstance(value, list):
375
value = self._expand_options_in_list(value)
376
elif isinstance(value, dict):
377
trace.warning('Cannot expand "%s":'
378
' Dicts do not support option expansion'
381
value = self._expand_options_in_string(value)
382
for hook in OldConfigHooks['get']:
383
hook(self, option_name, value)
386
def get_user_option_as_bool(self, option_name, expand=None, default=None):
387
"""Get a generic option as a boolean.
389
:param expand: Allow expanding references to other config values.
390
:param default: Default value if nothing is configured
192
391
:return None if the option doesn't exist or its value can't be
193
392
interpreted as a boolean. Returns True or False otherwise.
195
s = self._get_user_option(option_name)
394
s = self.get_user_option(option_name, expand=expand)
197
396
# The option doesn't exist
199
398
val = ui.bool_from_string(s)
201
400
# The value can't be interpreted as a boolean
573
def get_merge_tools(self):
575
for (oname, value, section, conf_id, parser) in self._get_options():
576
if oname.startswith('bzr.mergetool.'):
577
tool_name = oname[len('bzr.mergetool.'):]
578
tools[tool_name] = value
579
trace.mutter('loaded merge tools: %r' % tools)
582
def find_merge_tool(self, name):
583
# We fake a defaults mechanism here by checking if the given name can
584
# be found in the known_merge_tools if it's not found in the config.
585
# This should be done through the proposed config defaults mechanism
586
# when it becomes available in the future.
587
command_line = (self.get_user_option('bzr.mergetool.%s' % name,
589
or mergetools.known_merge_tools.get(name, None))
593
class _ConfigHooks(hooks.Hooks):
594
"""A dict mapping hook names and a list of callables for configs.
598
"""Create the default hooks.
600
These are all empty initially, because by default nothing should get
603
super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
604
self.add_hook('load',
605
'Invoked when a config store is loaded.'
606
' The signature is (store).',
608
self.add_hook('save',
609
'Invoked when a config store is saved.'
610
' The signature is (store).',
612
# The hooks for config options
614
'Invoked when a config option is read.'
615
' The signature is (stack, name, value).',
618
'Invoked when a config option is set.'
619
' The signature is (stack, name, value).',
621
self.add_hook('remove',
622
'Invoked when a config option is removed.'
623
' The signature is (stack, name).',
625
ConfigHooks = _ConfigHooks()
628
class _OldConfigHooks(hooks.Hooks):
629
"""A dict mapping hook names and a list of callables for configs.
633
"""Create the default hooks.
635
These are all empty initially, because by default nothing should get
638
super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
639
self.add_hook('load',
640
'Invoked when a config store is loaded.'
641
' The signature is (config).',
643
self.add_hook('save',
644
'Invoked when a config store is saved.'
645
' The signature is (config).',
647
# The hooks for config options
649
'Invoked when a config option is read.'
650
' The signature is (config, name, value).',
653
'Invoked when a config option is set.'
654
' The signature is (config, name, value).',
656
self.add_hook('remove',
657
'Invoked when a config option is removed.'
658
' The signature is (config, name).',
660
OldConfigHooks = _OldConfigHooks()
350
663
class IniBasedConfig(Config):
351
664
"""A configuration policy that draws from ini files."""
353
def __init__(self, get_filename):
666
def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
668
"""Base class for configuration files using an ini-like syntax.
670
:param file_name: The configuration file path.
354
672
super(IniBasedConfig, self).__init__()
355
self._get_filename = get_filename
673
self.file_name = file_name
674
if symbol_versioning.deprecated_passed(get_filename):
675
symbol_versioning.warn(
676
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
677
' Use file_name instead.',
680
if get_filename is not None:
681
self.file_name = get_filename()
683
self.file_name = file_name
356
685
self._parser = None
358
def _get_parser(self, file=None):
688
def from_string(cls, str_or_unicode, file_name=None, save=False):
689
"""Create a config object from a string.
691
:param str_or_unicode: A string representing the file content. This will
694
:param file_name: The configuration file path.
696
:param _save: Whether the file should be saved upon creation.
698
conf = cls(file_name=file_name)
699
conf._create_from_string(str_or_unicode, save)
702
def _create_from_string(self, str_or_unicode, save):
703
self._content = StringIO(str_or_unicode.encode('utf-8'))
704
# Some tests use in-memory configs, some other always need the config
705
# file to exist on disk.
707
self._write_config_file()
709
def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
359
710
if self._parser is not None:
360
711
return self._parser
362
input = self._get_filename()
712
if symbol_versioning.deprecated_passed(file):
713
symbol_versioning.warn(
714
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
715
' Use IniBasedConfig(_content=xxx) instead.',
718
if self._content is not None:
719
co_input = self._content
720
elif self.file_name is None:
721
raise AssertionError('We have no content to create the config')
723
co_input = self.file_name
366
self._parser = ConfigObj(input, encoding='utf-8')
725
self._parser = ConfigObj(co_input, encoding='utf-8')
367
726
except configobj.ConfigObjError, e:
368
727
raise errors.ParseConfigError(e.errors, e.config.filename)
728
except UnicodeDecodeError:
729
raise errors.ConfigContentError(self.file_name)
730
# Make sure self.reload() will use the right file name
731
self._parser.filename = self.file_name
732
for hook in OldConfigHooks['load']:
369
734
return self._parser
737
"""Reload the config file from disk."""
738
if self.file_name is None:
739
raise AssertionError('We need a file name to reload the config')
740
if self._parser is not None:
741
self._parser.reload()
742
for hook in ConfigHooks['load']:
371
745
def _get_matching_sections(self):
372
746
"""Return an ordered list of (section_name, extra_path) pairs.
1508
2208
configobj[name] = value
1510
2210
configobj.setdefault(section, {})[name] = value
2211
for hook in OldConfigHooks['set']:
2212
hook(self, name, value)
2213
self._set_configobj(configobj)
2215
def remove_option(self, option_name, section_name=None):
2216
configobj = self._get_configobj()
2217
if section_name is None:
2218
del configobj[option_name]
2220
del configobj[section_name][option_name]
2221
for hook in OldConfigHooks['remove']:
2222
hook(self, option_name)
1511
2223
self._set_configobj(configobj)
1513
2225
def _get_config_file(self):
1515
return StringIO(self._transport.get_bytes(self._filename))
2227
f = StringIO(self._transport.get_bytes(self._filename))
2228
for hook in OldConfigHooks['load']:
1516
2231
except errors.NoSuchFile:
1517
2232
return StringIO()
2234
def _external_url(self):
2235
return urlutils.join(self._transport.external_url(), self._filename)
1519
2237
def _get_configobj(self):
1520
return ConfigObj(self._get_config_file(), encoding='utf-8')
2238
f = self._get_config_file()
2241
conf = ConfigObj(f, encoding='utf-8')
2242
except configobj.ConfigObjError, e:
2243
raise errors.ParseConfigError(e.errors, self._external_url())
2244
except UnicodeDecodeError:
2245
raise errors.ConfigContentError(self._external_url())
1522
2250
def _set_configobj(self, configobj):
1523
2251
out_file = StringIO()
1524
2252
configobj.write(out_file)
1525
2253
out_file.seek(0)
1526
2254
self._transport.put_file(self._filename, out_file)
2255
for hook in OldConfigHooks['save']:
2259
class Option(object):
2260
"""An option definition.
2262
The option *values* are stored in config files and found in sections.
2264
Here we define various properties about the option itself, its default
2265
value, in which config files it can be stored, etc (TBC).
2268
def __init__(self, name, default=None):
2270
self.default = default
2272
def get_default(self):
2278
option_registry = registry.Registry()
2281
option_registry.register(
2282
'editor', Option('editor'),
2283
help='The command called to launch an editor to enter a message.')
2285
option_registry.register(
2286
'dirstate.fdatasync', Option('dirstate.fdatasync', default=True),
2287
help='Flush dirstate changes onto physical disk?')
2289
option_registry.register(
2290
'repository.fdatasync',
2291
Option('repository.fdatasync', default=True),
2292
help='Flush repository changes onto physical disk?')
2295
class Section(object):
2296
"""A section defines a dict of option name => value.
2298
This is merely a read-only dict which can add some knowledge about the
2299
options. It is *not* a python dict object though and doesn't try to mimic
2303
def __init__(self, section_id, options):
2304
self.id = section_id
2305
# We re-use the dict-like object received
2306
self.options = options
2308
def get(self, name, default=None):
2309
return self.options.get(name, default)
2312
# Mostly for debugging use
2313
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2316
_NewlyCreatedOption = object()
2317
"""Was the option created during the MutableSection lifetime"""
2320
class MutableSection(Section):
2321
"""A section allowing changes and keeping track of the original values."""
2323
def __init__(self, section_id, options):
2324
super(MutableSection, self).__init__(section_id, options)
2327
def set(self, name, value):
2328
if name not in self.options:
2329
# This is a new option
2330
self.orig[name] = _NewlyCreatedOption
2331
elif name not in self.orig:
2332
self.orig[name] = self.get(name, None)
2333
self.options[name] = value
2335
def remove(self, name):
2336
if name not in self.orig:
2337
self.orig[name] = self.get(name, None)
2338
del self.options[name]
2341
class Store(object):
2342
"""Abstract interface to persistent storage for configuration options."""
2344
readonly_section_class = Section
2345
mutable_section_class = MutableSection
2347
def is_loaded(self):
2348
"""Returns True if the Store has been loaded.
2350
This is used to implement lazy loading and ensure the persistent
2351
storage is queried only when needed.
2353
raise NotImplementedError(self.is_loaded)
2356
"""Loads the Store from persistent storage."""
2357
raise NotImplementedError(self.load)
2359
def _load_from_string(self, bytes):
2360
"""Create a store from a string in configobj syntax.
2362
:param bytes: A string representing the file content.
2364
raise NotImplementedError(self._load_from_string)
2367
"""Unloads the Store.
2369
This should make is_loaded() return False. This is used when the caller
2370
knows that the persistent storage has changed or may have change since
2373
raise NotImplementedError(self.unload)
2376
"""Saves the Store to persistent storage."""
2377
raise NotImplementedError(self.save)
2379
def external_url(self):
2380
raise NotImplementedError(self.external_url)
2382
def get_sections(self):
2383
"""Returns an ordered iterable of existing sections.
2385
:returns: An iterable of (name, dict).
2387
raise NotImplementedError(self.get_sections)
2389
def get_mutable_section(self, section_name=None):
2390
"""Returns the specified mutable section.
2392
:param section_name: The section identifier
2394
raise NotImplementedError(self.get_mutable_section)
2397
# Mostly for debugging use
2398
return "<config.%s(%s)>" % (self.__class__.__name__,
2399
self.external_url())
2402
class IniFileStore(Store):
2403
"""A config Store using ConfigObj for storage.
2405
:ivar transport: The transport object where the config file is located.
2407
:ivar file_name: The config file basename in the transport directory.
2409
:ivar _config_obj: Private member to hold the ConfigObj instance used to
2410
serialize/deserialize the config file.
2413
def __init__(self, transport, file_name):
2414
"""A config Store using ConfigObj for storage.
2416
:param transport: The transport object where the config file is located.
2418
:param file_name: The config file basename in the transport directory.
2420
super(IniFileStore, self).__init__()
2421
self.transport = transport
2422
self.file_name = file_name
2423
self._config_obj = None
2425
def is_loaded(self):
2426
return self._config_obj != None
2429
self._config_obj = None
2432
"""Load the store from the associated file."""
2433
if self.is_loaded():
2435
content = self.transport.get_bytes(self.file_name)
2436
self._load_from_string(content)
2437
for hook in ConfigHooks['load']:
2440
def _load_from_string(self, bytes):
2441
"""Create a config store from a string.
2443
:param bytes: A string representing the file content.
2445
if self.is_loaded():
2446
raise AssertionError('Already loaded: %r' % (self._config_obj,))
2447
co_input = StringIO(bytes)
2449
# The config files are always stored utf8-encoded
2450
self._config_obj = ConfigObj(co_input, encoding='utf-8')
2451
except configobj.ConfigObjError, e:
2452
self._config_obj = None
2453
raise errors.ParseConfigError(e.errors, self.external_url())
2454
except UnicodeDecodeError:
2455
raise errors.ConfigContentError(self.external_url())
2458
if not self.is_loaded():
2462
self._config_obj.write(out)
2463
self.transport.put_bytes(self.file_name, out.getvalue())
2464
for hook in ConfigHooks['save']:
2467
def external_url(self):
2468
# FIXME: external_url should really accepts an optional relpath
2469
# parameter (bug #750169) :-/ -- vila 2011-04-04
2470
# The following will do in the interim but maybe we don't want to
2471
# expose a path here but rather a config ID and its associated
2472
# object </hand wawe>.
2473
return urlutils.join(self.transport.external_url(), self.file_name)
2475
def get_sections(self):
2476
"""Get the configobj section in the file order.
2478
:returns: An iterable of (name, dict).
2480
# We need a loaded store
2483
except errors.NoSuchFile:
2484
# If the file doesn't exist, there is no sections
2486
cobj = self._config_obj
2488
yield self.readonly_section_class(None, cobj)
2489
for section_name in cobj.sections:
2490
yield self.readonly_section_class(section_name, cobj[section_name])
2492
def get_mutable_section(self, section_name=None):
2493
# We need a loaded store
2496
except errors.NoSuchFile:
2497
# The file doesn't exist, let's pretend it was empty
2498
self._load_from_string('')
2499
if section_name is None:
2500
section = self._config_obj
2502
section = self._config_obj.setdefault(section_name, {})
2503
return self.mutable_section_class(section_name, section)
2506
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
2507
# unlockable stores for use with objects that can already ensure the locking
2508
# (think branches). If different stores (not based on ConfigObj) are created,
2509
# they may face the same issue.
2512
class LockableIniFileStore(IniFileStore):
2513
"""A ConfigObjStore using locks on save to ensure store integrity."""
2515
def __init__(self, transport, file_name, lock_dir_name=None):
2516
"""A config Store using ConfigObj for storage.
2518
:param transport: The transport object where the config file is located.
2520
:param file_name: The config file basename in the transport directory.
2522
if lock_dir_name is None:
2523
lock_dir_name = 'lock'
2524
self.lock_dir_name = lock_dir_name
2525
super(LockableIniFileStore, self).__init__(transport, file_name)
2526
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
2528
def lock_write(self, token=None):
2529
"""Takes a write lock in the directory containing the config file.
2531
If the directory doesn't exist it is created.
2533
# FIXME: This doesn't check the ownership of the created directories as
2534
# ensure_config_dir_exists does. It should if the transport is local
2535
# -- vila 2011-04-06
2536
self.transport.create_prefix()
2537
return self._lock.lock_write(token)
2542
def break_lock(self):
2543
self._lock.break_lock()
2547
# We need to be able to override the undecorated implementation
2548
self.save_without_locking()
2550
def save_without_locking(self):
2551
super(LockableIniFileStore, self).save()
2554
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
2555
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
2556
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
2558
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
2559
# functions or a registry will make it easier and clearer for tests, focusing
2560
# on the relevant parts of the API that needs testing -- vila 20110503 (based
2561
# on a poolie's remark)
2562
class GlobalStore(LockableIniFileStore):
2564
def __init__(self, possible_transports=None):
2565
t = transport.get_transport(config_dir(),
2566
possible_transports=possible_transports)
2567
super(GlobalStore, self).__init__(t, 'bazaar.conf')
2570
class LocationStore(LockableIniFileStore):
2572
def __init__(self, possible_transports=None):
2573
t = transport.get_transport(config_dir(),
2574
possible_transports=possible_transports)
2575
super(LocationStore, self).__init__(t, 'locations.conf')
2578
class BranchStore(IniFileStore):
2580
def __init__(self, branch):
2581
super(BranchStore, self).__init__(branch.control_transport,
2583
self.branch = branch
2585
def lock_write(self, token=None):
2586
return self.branch.lock_write(token)
2589
return self.branch.unlock()
2593
# We need to be able to override the undecorated implementation
2594
self.save_without_locking()
2596
def save_without_locking(self):
2597
super(BranchStore, self).save()
2600
class SectionMatcher(object):
2601
"""Select sections into a given Store.
2603
This intended to be used to postpone getting an iterable of sections from a
2607
def __init__(self, store):
2610
def get_sections(self):
2611
# This is where we require loading the store so we can see all defined
2613
sections = self.store.get_sections()
2614
# Walk the revisions in the order provided
2619
def match(self, secion):
2620
raise NotImplementedError(self.match)
2623
class LocationSection(Section):
2625
def __init__(self, section, length, extra_path):
2626
super(LocationSection, self).__init__(section.id, section.options)
2627
self.length = length
2628
self.extra_path = extra_path
2630
def get(self, name, default=None):
2631
value = super(LocationSection, self).get(name, default)
2632
if value is not None:
2633
policy_name = self.get(name + ':policy', None)
2634
policy = _policy_value.get(policy_name, POLICY_NONE)
2635
if policy == POLICY_APPENDPATH:
2636
value = urlutils.join(value, self.extra_path)
2640
class LocationMatcher(SectionMatcher):
2642
def __init__(self, store, location):
2643
super(LocationMatcher, self).__init__(store)
2644
if location.startswith('file://'):
2645
location = urlutils.local_path_from_url(location)
2646
self.location = location
2648
def _get_matching_sections(self):
2649
"""Get all sections matching ``location``."""
2650
# We slightly diverge from LocalConfig here by allowing the no-name
2651
# section as the most generic one and the lower priority.
2652
no_name_section = None
2654
# Filter out the no_name_section so _iter_for_location_by_parts can be
2655
# used (it assumes all sections have a name).
2656
for section in self.store.get_sections():
2657
if section.id is None:
2658
no_name_section = section
2660
sections.append(section)
2661
# Unfortunately _iter_for_location_by_parts deals with section names so
2662
# we have to resync.
2663
filtered_sections = _iter_for_location_by_parts(
2664
[s.id for s in sections], self.location)
2665
iter_sections = iter(sections)
2666
matching_sections = []
2667
if no_name_section is not None:
2668
matching_sections.append(
2669
LocationSection(no_name_section, 0, self.location))
2670
for section_id, extra_path, length in filtered_sections:
2671
# a section id is unique for a given store so it's safe to iterate
2673
section = iter_sections.next()
2674
if section_id == section.id:
2675
matching_sections.append(
2676
LocationSection(section, length, extra_path))
2677
return matching_sections
2679
def get_sections(self):
2680
# Override the default implementation as we want to change the order
2681
matching_sections = self._get_matching_sections()
2682
# We want the longest (aka more specific) locations first
2683
sections = sorted(matching_sections,
2684
key=lambda section: (section.length, section.id),
2686
# Sections mentioning 'ignore_parents' restrict the selection
2687
for section in sections:
2688
# FIXME: We really want to use as_bool below -- vila 2011-04-07
2689
ignore = section.get('ignore_parents', None)
2690
if ignore is not None:
2691
ignore = ui.bool_from_string(ignore)
2694
# Finally, we have a valid section
2698
class Stack(object):
2699
"""A stack of configurations where an option can be defined"""
2701
def __init__(self, sections_def, store=None, mutable_section_name=None):
2702
"""Creates a stack of sections with an optional store for changes.
2704
:param sections_def: A list of Section or callables that returns an
2705
iterable of Section. This defines the Sections for the Stack and
2706
can be called repeatedly if needed.
2708
:param store: The optional Store where modifications will be
2709
recorded. If none is specified, no modifications can be done.
2711
:param mutable_section_name: The name of the MutableSection where
2712
changes are recorded. This requires the ``store`` parameter to be
2715
self.sections_def = sections_def
2717
self.mutable_section_name = mutable_section_name
2719
def get(self, name):
2720
"""Return the *first* option value found in the sections.
2722
This is where we guarantee that sections coming from Store are loaded
2723
lazily: the loading is delayed until we need to either check that an
2724
option exists or get its value, which in turn may require to discover
2725
in which sections it can be defined. Both of these (section and option
2726
existence) require loading the store (even partially).
2728
# FIXME: No caching of options nor sections yet -- vila 20110503
2730
# Ensuring lazy loading is achieved by delaying section matching (which
2731
# implies querying the persistent storage) until it can't be avoided
2732
# anymore by using callables to describe (possibly empty) section
2734
for section_or_callable in self.sections_def:
2735
# Each section can expand to multiple ones when a callable is used
2736
if callable(section_or_callable):
2737
sections = section_or_callable()
2739
sections = [section_or_callable]
2740
for section in sections:
2741
value = section.get(name)
2742
if value is not None:
2744
if value is not None:
2747
# If the option is registered, it may provide a default value
2749
opt = option_registry.get(name)
2754
value = opt.get_default()
2755
for hook in ConfigHooks['get']:
2756
hook(self, name, value)
2759
def _get_mutable_section(self):
2760
"""Get the MutableSection for the Stack.
2762
This is where we guarantee that the mutable section is lazily loaded:
2763
this means we won't load the corresponding store before setting a value
2764
or deleting an option. In practice the store will often be loaded but
2765
this allows helps catching some programming errors.
2767
section = self.store.get_mutable_section(self.mutable_section_name)
2770
def set(self, name, value):
2771
"""Set a new value for the option."""
2772
section = self._get_mutable_section()
2773
section.set(name, value)
2774
for hook in ConfigHooks['set']:
2775
hook(self, name, value)
2777
def remove(self, name):
2778
"""Remove an existing option."""
2779
section = self._get_mutable_section()
2780
section.remove(name)
2781
for hook in ConfigHooks['remove']:
2785
# Mostly for debugging use
2786
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
2789
class _CompatibleStack(Stack):
2790
"""Place holder for compatibility with previous design.
2792
This is intended to ease the transition from the Config-based design to the
2793
Stack-based design and should not be used nor relied upon by plugins.
2795
One assumption made here is that the daughter classes will all use Stores
2796
derived from LockableIniFileStore).
2798
It implements set() by re-loading the store before applying the
2799
modification and saving it.
2801
The long term plan being to implement a single write by store to save
2802
all modifications, this class should not be used in the interim.
2805
def set(self, name, value):
2808
super(_CompatibleStack, self).set(name, value)
2809
# Force a write to persistent storage
2813
class GlobalStack(_CompatibleStack):
2817
gstore = GlobalStore()
2818
super(GlobalStack, self).__init__([gstore.get_sections], gstore)
2821
class LocationStack(_CompatibleStack):
2823
def __init__(self, location):
2824
"""Make a new stack for a location and global configuration.
2826
:param location: A URL prefix to """
2827
lstore = LocationStore()
2828
matcher = LocationMatcher(lstore, location)
2829
gstore = GlobalStore()
2830
super(LocationStack, self).__init__(
2831
[matcher.get_sections, gstore.get_sections], lstore)
2833
class BranchStack(_CompatibleStack):
2835
def __init__(self, branch):
2836
bstore = BranchStore(branch)
2837
lstore = LocationStore()
2838
matcher = LocationMatcher(lstore, branch.base)
2839
gstore = GlobalStore()
2840
super(BranchStack, self).__init__(
2841
[matcher.get_sections, bstore.get_sections, gstore.get_sections],
2843
self.branch = branch
2846
class cmd_config(commands.Command):
2847
__doc__ = """Display, set or remove a configuration option.
2849
Display the active value for a given option.
2851
If --all is specified, NAME is interpreted as a regular expression and all
2852
matching options are displayed mentioning their scope. The active value
2853
that bzr will take into account is the first one displayed for each option.
2855
If no NAME is given, --all .* is implied.
2857
Setting a value is achieved by using name=value without spaces. The value
2858
is set in the most relevant scope and can be checked by displaying the
2862
takes_args = ['name?']
2866
# FIXME: This should be a registry option so that plugins can register
2867
# their own config files (or not) -- vila 20101002
2868
commands.Option('scope', help='Reduce the scope to the specified'
2869
' configuration file',
2871
commands.Option('all',
2872
help='Display all the defined values for the matching options.',
2874
commands.Option('remove', help='Remove the option from'
2875
' the configuration file'),
2878
_see_also = ['configuration']
2880
@commands.display_command
2881
def run(self, name=None, all=False, directory=None, scope=None,
2883
if directory is None:
2885
directory = urlutils.normalize_url(directory)
2887
raise errors.BzrError(
2888
'--all and --remove are mutually exclusive.')
2890
# Delete the option in the given scope
2891
self._remove_config_option(name, directory, scope)
2893
# Defaults to all options
2894
self._show_matching_options('.*', directory, scope)
2897
name, value = name.split('=', 1)
2899
# Display the option(s) value(s)
2901
self._show_matching_options(name, directory, scope)
2903
self._show_value(name, directory, scope)
2906
raise errors.BzrError(
2907
'Only one option can be set.')
2908
# Set the option value
2909
self._set_config_option(name, value, directory, scope)
2911
def _get_configs(self, directory, scope=None):
2912
"""Iterate the configurations specified by ``directory`` and ``scope``.
2914
:param directory: Where the configurations are derived from.
2916
:param scope: A specific config to start from.
2918
if scope is not None:
2919
if scope == 'bazaar':
2920
yield GlobalConfig()
2921
elif scope == 'locations':
2922
yield LocationConfig(directory)
2923
elif scope == 'branch':
2924
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
2926
yield br.get_config()
2929
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
2931
yield br.get_config()
2932
except errors.NotBranchError:
2933
yield LocationConfig(directory)
2934
yield GlobalConfig()
2936
def _show_value(self, name, directory, scope):
2938
for c in self._get_configs(directory, scope):
2941
for (oname, value, section, conf_id, parser) in c._get_options():
2943
# Display only the first value and exit
2945
# FIXME: We need to use get_user_option to take policies
2946
# into account and we need to make sure the option exists
2947
# too (hence the two for loops), this needs a better API
2949
value = c.get_user_option(name)
2950
# Quote the value appropriately
2951
value = parser._quote(value)
2952
self.outf.write('%s\n' % (value,))
2956
raise errors.NoSuchConfigOption(name)
2958
def _show_matching_options(self, name, directory, scope):
2959
name = lazy_regex.lazy_compile(name)
2960
# We want any error in the regexp to be raised *now* so we need to
2961
# avoid the delay introduced by the lazy regexp. But, we still do
2962
# want the nicer errors raised by lazy_regex.
2963
name._compile_and_collapse()
2966
for c in self._get_configs(directory, scope):
2967
for (oname, value, section, conf_id, parser) in c._get_options():
2968
if name.search(oname):
2969
if cur_conf_id != conf_id:
2970
# Explain where the options are defined
2971
self.outf.write('%s:\n' % (conf_id,))
2972
cur_conf_id = conf_id
2974
if (section not in (None, 'DEFAULT')
2975
and cur_section != section):
2976
# Display the section if it's not the default (or only)
2978
self.outf.write(' [%s]\n' % (section,))
2979
cur_section = section
2980
self.outf.write(' %s = %s\n' % (oname, value))
2982
def _set_config_option(self, name, value, directory, scope):
2983
for conf in self._get_configs(directory, scope):
2984
conf.set_user_option(name, value)
2987
raise errors.NoSuchConfig(scope)
2989
def _remove_config_option(self, name, directory, scope):
2991
raise errors.BzrCommandError(
2992
'--remove expects an option to remove.')
2994
for conf in self._get_configs(directory, scope):
2995
for (section_name, section, conf_id) in conf._get_sections():
2996
if scope is not None and conf_id != scope:
2997
# Not the right configuration file
3000
if conf_id != conf.config_id():
3001
conf = self._get_configs(directory, conf_id).next()
3002
# We use the first section in the first config where the
3003
# option is defined to remove it
3004
conf.remove_user_option(name, section_name)
3009
raise errors.NoSuchConfig(scope)
3011
raise errors.NoSuchConfigOption(name)
3015
# We need adapters that can build a Store or a Stack in a test context. Test
3016
# classes, based on TestCaseWithTransport, can use the registry to parametrize
3017
# themselves. The builder will receive a test instance and should return a
3018
# ready-to-use store or stack. Plugins that define new store/stacks can also
3019
# register themselves here to be tested against the tests defined in
3020
# bzrlib.tests.test_config. Note that the builder can be called multiple times
3021
# for the same tests.
3023
# The registered object should be a callable receiving a test instance
3024
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
3026
test_store_builder_registry = registry.Registry()
3028
# The registered object should be a callable receiving a test instance
3029
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
3031
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
