2259
1441
configobj[name] = value
2261
1443
configobj.setdefault(section, {})[name] = value
2262
for hook in OldConfigHooks['set']:
2263
hook(self, name, value)
2264
self._set_configobj(configobj)
2266
def remove_option(self, option_name, section_name=None):
2267
configobj = self._get_configobj()
2268
if section_name is None:
2269
del configobj[option_name]
2271
del configobj[section_name][option_name]
2272
for hook in OldConfigHooks['remove']:
2273
hook(self, option_name)
2274
1444
self._set_configobj(configobj)
2276
1446
def _get_config_file(self):
2278
f = StringIO(self._transport.get_bytes(self._filename))
2279
for hook in OldConfigHooks['load']:
1448
return StringIO(self._transport.get_bytes(self._filename))
2282
1449
except errors.NoSuchFile:
2283
1450
return StringIO()
2284
except errors.PermissionDenied, e:
2285
trace.warning("Permission denied while trying to open "
2286
"configuration file %s.", urlutils.unescape_for_display(
2287
urlutils.join(self._transport.base, self._filename), "utf-8"))
2290
def _external_url(self):
2291
return urlutils.join(self._transport.external_url(), self._filename)
2293
1452
def _get_configobj(self):
2294
1453
f = self._get_config_file()
2297
conf = ConfigObj(f, encoding='utf-8')
2298
except configobj.ConfigObjError, e:
2299
raise errors.ParseConfigError(e.errors, self._external_url())
2300
except UnicodeDecodeError:
2301
raise errors.ConfigContentError(self._external_url())
1455
return ConfigObj(f, encoding='utf-8')
2306
1459
def _set_configobj(self, configobj):
2307
1460
out_file = StringIO()
2308
1461
configobj.write(out_file)
2309
1462
out_file.seek(0)
2310
1463
self._transport.put_file(self._filename, out_file)
2311
for hook in OldConfigHooks['save']:
2315
class Option(object):
2316
"""An option definition.
2318
The option *values* are stored in config files and found in sections.
2320
Here we define various properties about the option itself, its default
2321
value, how to convert it from stores, what to do when invalid values are
2322
encoutered, in which config files it can be stored.
2325
def __init__(self, name, default=None, default_from_env=None,
2327
from_unicode=None, invalid=None):
2328
"""Build an option definition.
2330
:param name: the name used to refer to the option.
2332
:param default: the default value to use when none exist in the config
2333
stores. This is either a string that ``from_unicode`` will convert
2334
into the proper type or a python object that can be stringified (so
2335
only the empty list is supported for example).
2337
:param default_from_env: A list of environment variables which can
2338
provide a default value. 'default' will be used only if none of the
2339
variables specified here are set in the environment.
2341
:param help: a doc string to explain the option to the user.
2343
:param from_unicode: a callable to convert the unicode string
2344
representing the option value in a store. This is not called for
2347
:param invalid: the action to be taken when an invalid value is
2348
encountered in a store. This is called only when from_unicode is
2349
invoked to convert a string and returns None or raise ValueError or
2350
TypeError. Accepted values are: None (ignore invalid values),
2351
'warning' (emit a warning), 'error' (emit an error message and
2354
if default_from_env is None:
2355
default_from_env = []
2357
# Convert the default value to a unicode string so all values are
2358
# strings internally before conversion (via from_unicode) is attempted.
2361
elif isinstance(default, list):
2362
# Only the empty list is supported
2364
raise AssertionError(
2365
'Only empty lists are supported as default values')
2367
elif isinstance(default, (str, unicode, bool, int, float)):
2368
# Rely on python to convert strings, booleans and integers
2369
self.default = u'%s' % (default,)
2371
# other python objects are not expected
2372
raise AssertionError('%r is not supported as a default value'
2374
self.default_from_env = default_from_env
2376
self.from_unicode = from_unicode
2377
if invalid and invalid not in ('warning', 'error'):
2378
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2379
self.invalid = invalid
2381
def convert_from_unicode(self, unicode_value):
2382
if self.from_unicode is None or unicode_value is None:
2383
# Don't convert or nothing to convert
2384
return unicode_value
2386
converted = self.from_unicode(unicode_value)
2387
except (ValueError, TypeError):
2388
# Invalid values are ignored
2390
if converted is None and self.invalid is not None:
2391
# The conversion failed
2392
if self.invalid == 'warning':
2393
trace.warning('Value "%s" is not valid for "%s"',
2394
unicode_value, self.name)
2395
elif self.invalid == 'error':
2396
raise errors.ConfigOptionValueError(self.name, unicode_value)
2399
def get_default(self):
2401
for var in self.default_from_env:
2403
# If the env variable is defined, its value is the default one
2404
value = os.environ[var]
2409
# Otherwise, fallback to the value defined at registration
2410
value = self.default
2413
def get_help_text(self, additional_see_also=None, plain=True):
2415
from bzrlib import help_topics
2416
result += help_topics._format_see_also(additional_see_also)
2418
result = help_topics.help_as_plain_text(result)
2422
# Predefined converters to get proper values from store
2424
def bool_from_store(unicode_str):
2425
return ui.bool_from_string(unicode_str)
2428
def int_from_store(unicode_str):
2429
return int(unicode_str)
2432
def float_from_store(unicode_str):
2433
return float(unicode_str)
2437
# Use a an empty dict to initialize an empty configobj avoiding all
2438
# parsing and encoding checks
2439
_list_converter_config = configobj.ConfigObj(
2440
{}, encoding='utf-8', list_values=True, interpolation=False)
2443
def list_from_store(unicode_str):
2444
if not isinstance(unicode_str, basestring):
2446
# Now inject our string directly as unicode. All callers got their value
2447
# from configobj, so values that need to be quoted are already properly
2449
_list_converter_config.reset()
2450
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2451
maybe_list = _list_converter_config['list']
2452
# ConfigObj return '' instead of u''. Use 'str' below to catch all cases.
2453
if isinstance(maybe_list, basestring):
2455
# A single value, most probably the user forgot (or didn't care to
2456
# add) the final ','
2459
# The empty string, convert to empty list
2462
# We rely on ConfigObj providing us with a list already
2467
class OptionRegistry(registry.Registry):
2468
"""Register config options by their name.
2470
This overrides ``registry.Registry`` to simplify registration by acquiring
2471
some information from the option object itself.
2474
def register(self, option):
2475
"""Register a new option to its name.
2477
:param option: The option to register. Its name is used as the key.
2479
super(OptionRegistry, self).register(option.name, option,
2482
def register_lazy(self, key, module_name, member_name):
2483
"""Register a new option to be loaded on request.
2485
:param key: the key to request the option later. Since the registration
2486
is lazy, it should be provided and match the option name.
2488
:param module_name: the python path to the module. Such as 'os.path'.
2490
:param member_name: the member of the module to return. If empty or
2491
None, get() will return the module itself.
2493
super(OptionRegistry, self).register_lazy(key,
2494
module_name, member_name)
2496
def get_help(self, key=None):
2497
"""Get the help text associated with the given key"""
2498
option = self.get(key)
2499
the_help = option.help
2500
if callable(the_help):
2501
return the_help(self, key)
2505
option_registry = OptionRegistry()
2508
# Registered options in lexicographical order
2510
option_registry.register(
2511
Option('bzr.workingtree.worth_saving_limit', default=10,
2512
from_unicode=int_from_store, invalid='warning',
2514
How many changes before saving the dirstate.
2516
-1 means that we will never rewrite the dirstate file for only
2517
stat-cache changes. Regardless of this setting, we will always rewrite
2518
the dirstate file if a file is added/removed/renamed/etc. This flag only
2519
affects the behavior of updating the dirstate file after we notice that
2520
a file has been touched.
2522
option_registry.register(
2523
Option('dirstate.fdatasync', default=True,
2524
from_unicode=bool_from_store,
2526
Flush dirstate changes onto physical disk?
2528
If true (default), working tree metadata changes are flushed through the
2529
OS buffers to physical disk. This is somewhat slower, but means data
2530
should not be lost if the machine crashes. See also repository.fdatasync.
2532
option_registry.register(
2533
Option('debug_flags', default=[], from_unicode=list_from_store,
2534
help='Debug flags to activate.'))
2535
option_registry.register(
2536
Option('default_format', default='2a',
2537
help='Format used when creating branches.'))
2538
option_registry.register(
2539
Option('dpush_strict', default=None,
2540
from_unicode=bool_from_store,
2542
The default value for ``dpush --strict``.
2544
If present, defines the ``--strict`` option default value for checking
2545
uncommitted changes before pushing into a different VCS without any
2546
custom bzr metadata.
2548
option_registry.register(
2550
help='The command called to launch an editor to enter a message.'))
2551
option_registry.register(
2552
Option('ignore_missing_extensions', default=False,
2553
from_unicode=bool_from_store,
2555
Control the missing extensions warning display.
2557
The warning will not be emitted if set to True.
2559
option_registry.register(
2561
help='Language to translate messages into.'))
2562
option_registry.register(
2563
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2565
Steal locks that appears to be dead.
2567
If set to True, bzr will check if a lock is supposed to be held by an
2568
active process from the same user on the same machine. If the user and
2569
machine match, but no process with the given PID is active, then bzr
2570
will automatically break the stale lock, and create a new lock for
2572
Otherwise, bzr will prompt as normal to break the lock.
2574
option_registry.register(
2575
Option('log_format', default='long',
2577
Log format to use when displaying revisions.
2579
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2580
may be provided by plugins.
2582
option_registry.register(
2583
Option('output_encoding',
2584
help= 'Unicode encoding for output'
2585
' (terminal encoding if not specified).'))
2586
option_registry.register(
2587
Option('push_strict', default=None,
2588
from_unicode=bool_from_store,
2590
The default value for ``push --strict``.
2592
If present, defines the ``--strict`` option default value for checking
2593
uncommitted changes before sending a merge directive.
2595
option_registry.register(
2596
Option('repository.fdatasync', default=True,
2597
from_unicode=bool_from_store,
2599
Flush repository changes onto physical disk?
2601
If true (default), repository changes are flushed through the OS buffers
2602
to physical disk. This is somewhat slower, but means data should not be
2603
lost if the machine crashes. See also dirstate.fdatasync.
2605
option_registry.register(
2606
Option('send_strict', default=None,
2607
from_unicode=bool_from_store,
2609
The default value for ``send --strict``.
2611
If present, defines the ``--strict`` option default value for checking
2612
uncommitted changes before pushing.
2615
option_registry.register(
2616
Option('serve.client_timeout',
2617
default=300.0, from_unicode=float_from_store,
2618
help="If we wait for a new request from a client for more than"
2619
" X seconds, consider the client idle, and hangup."))
2622
class Section(object):
2623
"""A section defines a dict of option name => value.
2625
This is merely a read-only dict which can add some knowledge about the
2626
options. It is *not* a python dict object though and doesn't try to mimic
2630
def __init__(self, section_id, options):
2631
self.id = section_id
2632
# We re-use the dict-like object received
2633
self.options = options
2635
def get(self, name, default=None):
2636
return self.options.get(name, default)
2639
# Mostly for debugging use
2640
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2643
_NewlyCreatedOption = object()
2644
"""Was the option created during the MutableSection lifetime"""
2647
class MutableSection(Section):
2648
"""A section allowing changes and keeping track of the original values."""
2650
def __init__(self, section_id, options):
2651
super(MutableSection, self).__init__(section_id, options)
2654
def set(self, name, value):
2655
if name not in self.options:
2656
# This is a new option
2657
self.orig[name] = _NewlyCreatedOption
2658
elif name not in self.orig:
2659
self.orig[name] = self.get(name, None)
2660
self.options[name] = value
2662
def remove(self, name):
2663
if name not in self.orig:
2664
self.orig[name] = self.get(name, None)
2665
del self.options[name]
2668
class CommandLineSection(MutableSection):
2669
"""A section used to carry command line overrides for the config options."""
2671
def __init__(self, opts=None):
2674
super(CommandLineSection, self).__init__('cmdline-overrides', opts)
2677
# The dict should be cleared but not replaced so it can be shared.
2678
self.options.clear()
2680
def _from_cmdline(self, overrides):
2681
# Reset before accepting new definitions
2683
for over in overrides:
2685
name, value = over.split('=', 1)
2687
raise errors.BzrCommandError(
2688
gettext("Invalid '%s', should be of the form 'name=value'")
2690
self.set(name, value)
2693
class Store(object):
2694
"""Abstract interface to persistent storage for configuration options."""
2696
readonly_section_class = Section
2697
mutable_section_class = MutableSection
2699
def is_loaded(self):
2700
"""Returns True if the Store has been loaded.
2702
This is used to implement lazy loading and ensure the persistent
2703
storage is queried only when needed.
2705
raise NotImplementedError(self.is_loaded)
2708
"""Loads the Store from persistent storage."""
2709
raise NotImplementedError(self.load)
2711
def _load_from_string(self, bytes):
2712
"""Create a store from a string in configobj syntax.
2714
:param bytes: A string representing the file content.
2716
raise NotImplementedError(self._load_from_string)
2719
"""Unloads the Store.
2721
This should make is_loaded() return False. This is used when the caller
2722
knows that the persistent storage has changed or may have change since
2725
raise NotImplementedError(self.unload)
2728
"""Saves the Store to persistent storage."""
2729
raise NotImplementedError(self.save)
2731
def external_url(self):
2732
raise NotImplementedError(self.external_url)
2734
def get_sections(self):
2735
"""Returns an ordered iterable of existing sections.
2737
:returns: An iterable of (name, dict).
2739
raise NotImplementedError(self.get_sections)
2741
def get_mutable_section(self, section_name=None):
2742
"""Returns the specified mutable section.
2744
:param section_name: The section identifier
2746
raise NotImplementedError(self.get_mutable_section)
2749
# Mostly for debugging use
2750
return "<config.%s(%s)>" % (self.__class__.__name__,
2751
self.external_url())
2754
class IniFileStore(Store):
2755
"""A config Store using ConfigObj for storage.
2757
:ivar transport: The transport object where the config file is located.
2759
:ivar file_name: The config file basename in the transport directory.
2761
:ivar _config_obj: Private member to hold the ConfigObj instance used to
2762
serialize/deserialize the config file.
2765
def __init__(self, transport, file_name):
2766
"""A config Store using ConfigObj for storage.
2768
:param transport: The transport object where the config file is located.
2770
:param file_name: The config file basename in the transport directory.
2772
super(IniFileStore, self).__init__()
2773
self.transport = transport
2774
self.file_name = file_name
2775
self._config_obj = None
2777
def is_loaded(self):
2778
return self._config_obj != None
2781
self._config_obj = None
2784
"""Load the store from the associated file."""
2785
if self.is_loaded():
2788
content = self.transport.get_bytes(self.file_name)
2789
except errors.PermissionDenied:
2790
trace.warning("Permission denied while trying to load "
2791
"configuration store %s.", self.external_url())
2793
self._load_from_string(content)
2794
for hook in ConfigHooks['load']:
2797
def _load_from_string(self, bytes):
2798
"""Create a config store from a string.
2800
:param bytes: A string representing the file content.
2802
if self.is_loaded():
2803
raise AssertionError('Already loaded: %r' % (self._config_obj,))
2804
co_input = StringIO(bytes)
2806
# The config files are always stored utf8-encoded
2807
self._config_obj = ConfigObj(co_input, encoding='utf-8',
2809
except configobj.ConfigObjError, e:
2810
self._config_obj = None
2811
raise errors.ParseConfigError(e.errors, self.external_url())
2812
except UnicodeDecodeError:
2813
raise errors.ConfigContentError(self.external_url())
2816
if not self.is_loaded():
2820
self._config_obj.write(out)
2821
self.transport.put_bytes(self.file_name, out.getvalue())
2822
for hook in ConfigHooks['save']:
2825
def external_url(self):
2826
# FIXME: external_url should really accepts an optional relpath
2827
# parameter (bug #750169) :-/ -- vila 2011-04-04
2828
# The following will do in the interim but maybe we don't want to
2829
# expose a path here but rather a config ID and its associated
2830
# object </hand wawe>.
2831
return urlutils.join(self.transport.external_url(), self.file_name)
2833
def get_sections(self):
2834
"""Get the configobj section in the file order.
2836
:returns: An iterable of (name, dict).
2838
# We need a loaded store
2841
except (errors.NoSuchFile, errors.PermissionDenied):
2842
# If the file can't be read, there is no sections
2844
cobj = self._config_obj
2846
yield self.readonly_section_class(None, cobj)
2847
for section_name in cobj.sections:
2848
yield self.readonly_section_class(section_name, cobj[section_name])
2850
def get_mutable_section(self, section_name=None):
2851
# We need a loaded store
2854
except errors.NoSuchFile:
2855
# The file doesn't exist, let's pretend it was empty
2856
self._load_from_string('')
2857
if section_name is None:
2858
section = self._config_obj
2860
section = self._config_obj.setdefault(section_name, {})
2861
return self.mutable_section_class(section_name, section)
2864
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
2865
# unlockable stores for use with objects that can already ensure the locking
2866
# (think branches). If different stores (not based on ConfigObj) are created,
2867
# they may face the same issue.
2870
class LockableIniFileStore(IniFileStore):
2871
"""A ConfigObjStore using locks on save to ensure store integrity."""
2873
def __init__(self, transport, file_name, lock_dir_name=None):
2874
"""A config Store using ConfigObj for storage.
2876
:param transport: The transport object where the config file is located.
2878
:param file_name: The config file basename in the transport directory.
2880
if lock_dir_name is None:
2881
lock_dir_name = 'lock'
2882
self.lock_dir_name = lock_dir_name
2883
super(LockableIniFileStore, self).__init__(transport, file_name)
2884
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
2886
def lock_write(self, token=None):
2887
"""Takes a write lock in the directory containing the config file.
2889
If the directory doesn't exist it is created.
2891
# FIXME: This doesn't check the ownership of the created directories as
2892
# ensure_config_dir_exists does. It should if the transport is local
2893
# -- vila 2011-04-06
2894
self.transport.create_prefix()
2895
return self._lock.lock_write(token)
2900
def break_lock(self):
2901
self._lock.break_lock()
2905
# We need to be able to override the undecorated implementation
2906
self.save_without_locking()
2908
def save_without_locking(self):
2909
super(LockableIniFileStore, self).save()
2912
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
2913
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
2914
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
2916
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
2917
# functions or a registry will make it easier and clearer for tests, focusing
2918
# on the relevant parts of the API that needs testing -- vila 20110503 (based
2919
# on a poolie's remark)
2920
class GlobalStore(LockableIniFileStore):
2922
def __init__(self, possible_transports=None):
2923
t = transport.get_transport_from_path(
2924
config_dir(), possible_transports=possible_transports)
2925
super(GlobalStore, self).__init__(t, 'bazaar.conf')
2928
class LocationStore(LockableIniFileStore):
2930
def __init__(self, possible_transports=None):
2931
t = transport.get_transport_from_path(
2932
config_dir(), possible_transports=possible_transports)
2933
super(LocationStore, self).__init__(t, 'locations.conf')
2936
class BranchStore(IniFileStore):
2938
def __init__(self, branch):
2939
super(BranchStore, self).__init__(branch.control_transport,
2941
self.branch = branch
2943
def lock_write(self, token=None):
2944
return self.branch.lock_write(token)
2947
return self.branch.unlock()
2951
# We need to be able to override the undecorated implementation
2952
self.save_without_locking()
2954
def save_without_locking(self):
2955
super(BranchStore, self).save()
2958
class ControlStore(LockableIniFileStore):
2960
def __init__(self, bzrdir):
2961
super(ControlStore, self).__init__(bzrdir.transport,
2963
lock_dir_name='branch_lock')
2966
class SectionMatcher(object):
2967
"""Select sections into a given Store.
2969
This is intended to be used to postpone getting an iterable of sections
2973
def __init__(self, store):
2976
def get_sections(self):
2977
# This is where we require loading the store so we can see all defined
2979
sections = self.store.get_sections()
2980
# Walk the revisions in the order provided
2985
def match(self, section):
2986
"""Does the proposed section match.
2988
:param section: A Section object.
2990
:returns: True if the section matches, False otherwise.
2992
raise NotImplementedError(self.match)
2995
class NameMatcher(SectionMatcher):
2997
def __init__(self, store, section_id):
2998
super(NameMatcher, self).__init__(store)
2999
self.section_id = section_id
3001
def match(self, section):
3002
return section.id == self.section_id
3005
class LocationSection(Section):
3007
def __init__(self, section, length, extra_path):
3008
super(LocationSection, self).__init__(section.id, section.options)
3009
self.length = length
3010
self.extra_path = extra_path
3012
def get(self, name, default=None):
3013
value = super(LocationSection, self).get(name, default)
3014
if value is not None:
3015
policy_name = self.get(name + ':policy', None)
3016
policy = _policy_value.get(policy_name, POLICY_NONE)
3017
if policy == POLICY_APPENDPATH:
3018
value = urlutils.join(value, self.extra_path)
3022
class LocationMatcher(SectionMatcher):
3024
def __init__(self, store, location):
3025
super(LocationMatcher, self).__init__(store)
3026
if location.startswith('file://'):
3027
location = urlutils.local_path_from_url(location)
3028
self.location = location
3030
def _get_matching_sections(self):
3031
"""Get all sections matching ``location``."""
3032
# We slightly diverge from LocalConfig here by allowing the no-name
3033
# section as the most generic one and the lower priority.
3034
no_name_section = None
3036
# Filter out the no_name_section so _iter_for_location_by_parts can be
3037
# used (it assumes all sections have a name).
3038
for section in self.store.get_sections():
3039
if section.id is None:
3040
no_name_section = section
3042
all_sections.append(section)
3043
# Unfortunately _iter_for_location_by_parts deals with section names so
3044
# we have to resync.
3045
filtered_sections = _iter_for_location_by_parts(
3046
[s.id for s in all_sections], self.location)
3047
iter_all_sections = iter(all_sections)
3048
matching_sections = []
3049
if no_name_section is not None:
3050
matching_sections.append(
3051
LocationSection(no_name_section, 0, self.location))
3052
for section_id, extra_path, length in filtered_sections:
3053
# a section id is unique for a given store so it's safe to take the
3054
# first matching section while iterating. Also, all filtered
3055
# sections are part of 'all_sections' and will always be found
3058
section = iter_all_sections.next()
3059
if section_id == section.id:
3060
matching_sections.append(
3061
LocationSection(section, length, extra_path))
3063
return matching_sections
3065
def get_sections(self):
3066
# Override the default implementation as we want to change the order
3067
matching_sections = self._get_matching_sections()
3068
# We want the longest (aka more specific) locations first
3069
sections = sorted(matching_sections,
3070
key=lambda section: (section.length, section.id),
3072
# Sections mentioning 'ignore_parents' restrict the selection
3073
for section in sections:
3074
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3075
ignore = section.get('ignore_parents', None)
3076
if ignore is not None:
3077
ignore = ui.bool_from_string(ignore)
3080
# Finally, we have a valid section
3084
class Stack(object):
3085
"""A stack of configurations where an option can be defined"""
3087
_option_ref_re = lazy_regex.lazy_compile('({[^{}]+})')
3088
"""Describes an exandable option reference.
3090
We want to match the most embedded reference first.
3092
I.e. for '{{foo}}' we will get '{foo}',
3093
for '{bar{baz}}' we will get '{baz}'
3096
def __init__(self, sections_def, store=None, mutable_section_name=None):
3097
"""Creates a stack of sections with an optional store for changes.
3099
:param sections_def: A list of Section or callables that returns an
3100
iterable of Section. This defines the Sections for the Stack and
3101
can be called repeatedly if needed.
3103
:param store: The optional Store where modifications will be
3104
recorded. If none is specified, no modifications can be done.
3106
:param mutable_section_name: The name of the MutableSection where
3107
changes are recorded. This requires the ``store`` parameter to be
3110
self.sections_def = sections_def
3112
self.mutable_section_name = mutable_section_name
3114
def get(self, name, expand=None):
3115
"""Return the *first* option value found in the sections.
3117
This is where we guarantee that sections coming from Store are loaded
3118
lazily: the loading is delayed until we need to either check that an
3119
option exists or get its value, which in turn may require to discover
3120
in which sections it can be defined. Both of these (section and option
3121
existence) require loading the store (even partially).
3123
:param name: The queried option.
3125
:param expand: Whether options references should be expanded.
3127
:returns: The value of the option.
3129
# FIXME: No caching of options nor sections yet -- vila 20110503
3131
expand = _get_expand_default_value()
3133
# Ensuring lazy loading is achieved by delaying section matching (which
3134
# implies querying the persistent storage) until it can't be avoided
3135
# anymore by using callables to describe (possibly empty) section
3137
for section_or_callable in self.sections_def:
3138
# Each section can expand to multiple ones when a callable is used
3139
if callable(section_or_callable):
3140
sections = section_or_callable()
3142
sections = [section_or_callable]
3143
for section in sections:
3144
value = section.get(name)
3145
if value is not None:
3147
if value is not None:
3149
# If the option is registered, it may provide additional info about
3152
opt = option_registry.get(name)
3156
def expand_and_convert(val):
3157
# This may need to be called twice if the value is None or ends up
3158
# being None during expansion or conversion.
3161
if isinstance(val, basestring):
3162
val = self._expand_options_in_string(val)
3164
trace.warning('Cannot expand "%s":'
3165
' %s does not support option expansion'
3166
% (name, type(val)))
3168
val = opt.convert_from_unicode(val)
3170
value = expand_and_convert(value)
3171
if opt is not None and value is None:
3172
# If the option is registered, it may provide a default value
3173
value = opt.get_default()
3174
value = expand_and_convert(value)
3175
for hook in ConfigHooks['get']:
3176
hook(self, name, value)
3179
def expand_options(self, string, env=None):
3180
"""Expand option references in the string in the configuration context.
3182
:param string: The string containing option(s) to expand.
3184
:param env: An option dict defining additional configuration options or
3185
overriding existing ones.
3187
:returns: The expanded string.
3189
return self._expand_options_in_string(string, env)
3191
def _expand_options_in_string(self, string, env=None, _refs=None):
3192
"""Expand options in the string in the configuration context.
3194
:param string: The string to be expanded.
3196
:param env: An option dict defining additional configuration options or
3197
overriding existing ones.
3199
:param _refs: Private list (FIFO) containing the options being expanded
3202
:returns: The expanded string.
3205
# Not much to expand there
3208
# What references are currently resolved (to detect loops)
3211
# We need to iterate until no more refs appear ({{foo}} will need two
3212
# iterations for example).
3214
raw_chunks = Stack._option_ref_re.split(result)
3215
if len(raw_chunks) == 1:
3216
# Shorcut the trivial case: no refs
3219
# Split will isolate refs so that every other chunk is a ref
3220
chunk_is_ref = False
3221
for chunk in raw_chunks:
3222
if not chunk_is_ref:
3223
chunks.append(chunk)
3228
raise errors.OptionExpansionLoop(string, _refs)
3230
value = self._expand_option(name, env, _refs)
3232
raise errors.ExpandingUnknownOption(name, string)
3233
chunks.append(value)
3235
chunk_is_ref = False
3236
result = ''.join(chunks)
3239
def _expand_option(self, name, env, _refs):
3240
if env is not None and name in env:
3241
# Special case, values provided in env takes precedence over
3245
# FIXME: This is a limited implementation, what we really need is a
3246
# way to query the bzr config for the value of an option,
3247
# respecting the scope rules (That is, once we implement fallback
3248
# configs, getting the option value should restart from the top
3249
# config, not the current one) -- vila 20101222
3250
value = self.get(name, expand=False)
3251
value = self._expand_options_in_string(value, env, _refs)
3254
def _get_mutable_section(self):
3255
"""Get the MutableSection for the Stack.
3257
This is where we guarantee that the mutable section is lazily loaded:
3258
this means we won't load the corresponding store before setting a value
3259
or deleting an option. In practice the store will often be loaded but
3260
this allows helps catching some programming errors.
3262
section = self.store.get_mutable_section(self.mutable_section_name)
3265
def set(self, name, value):
3266
"""Set a new value for the option."""
3267
section = self._get_mutable_section()
3268
section.set(name, value)
3269
for hook in ConfigHooks['set']:
3270
hook(self, name, value)
3272
def remove(self, name):
3273
"""Remove an existing option."""
3274
section = self._get_mutable_section()
3275
section.remove(name)
3276
for hook in ConfigHooks['remove']:
3280
# Mostly for debugging use
3281
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3283
def _get_overrides(self):
3284
# Hack around library_state.initialize never called
3285
if bzrlib.global_state is not None:
3286
return [bzrlib.global_state.cmdline_overrides]
3290
class _CompatibleStack(Stack):
3291
"""Place holder for compatibility with previous design.
3293
This is intended to ease the transition from the Config-based design to the
3294
Stack-based design and should not be used nor relied upon by plugins.
3296
One assumption made here is that the daughter classes will all use Stores
3297
derived from LockableIniFileStore).
3299
It implements set() by re-loading the store before applying the
3300
modification and saving it.
3302
The long term plan being to implement a single write by store to save
3303
all modifications, this class should not be used in the interim.
3306
def set(self, name, value):
3309
super(_CompatibleStack, self).set(name, value)
3310
# Force a write to persistent storage
3314
class GlobalStack(_CompatibleStack):
3315
"""Global options only stack."""
3319
gstore = GlobalStore()
3320
super(GlobalStack, self).__init__(
3321
[self._get_overrides, gstore.get_sections],
3325
class LocationStack(_CompatibleStack):
3326
"""Per-location options falling back to global options stack."""
3328
def __init__(self, location):
3329
"""Make a new stack for a location and global configuration.
3331
:param location: A URL prefix to """
3332
lstore = LocationStore()
3333
matcher = LocationMatcher(lstore, location)
3334
gstore = GlobalStore()
3335
super(LocationStack, self).__init__(
3336
[self._get_overrides,
3337
matcher.get_sections, gstore.get_sections],
3341
class BranchStack(_CompatibleStack):
3342
"""Per-location options falling back to branch then global options stack."""
3344
def __init__(self, branch):
3345
bstore = BranchStore(branch)
3346
lstore = LocationStore()
3347
matcher = LocationMatcher(lstore, branch.base)
3348
gstore = GlobalStore()
3349
super(BranchStack, self).__init__(
3350
[self._get_overrides,
3351
matcher.get_sections, bstore.get_sections, gstore.get_sections],
3353
self.branch = branch
3356
class RemoteControlStack(_CompatibleStack):
3357
"""Remote control-only options stack."""
3359
def __init__(self, bzrdir):
3360
cstore = ControlStore(bzrdir)
3361
super(RemoteControlStack, self).__init__(
3362
[cstore.get_sections],
3364
self.bzrdir = bzrdir
3367
class RemoteBranchStack(_CompatibleStack):
3368
"""Remote branch-only options stack."""
3370
def __init__(self, branch):
3371
bstore = BranchStore(branch)
3372
super(RemoteBranchStack, self).__init__(
3373
[bstore.get_sections],
3375
self.branch = branch
3378
class cmd_config(commands.Command):
3379
__doc__ = """Display, set or remove a configuration option.
3381
Display the active value for a given option.
3383
If --all is specified, NAME is interpreted as a regular expression and all
3384
matching options are displayed mentioning their scope. The active value
3385
that bzr will take into account is the first one displayed for each option.
3387
If no NAME is given, --all .* is implied.
3389
Setting a value is achieved by using name=value without spaces. The value
3390
is set in the most relevant scope and can be checked by displaying the
3394
takes_args = ['name?']
3398
# FIXME: This should be a registry option so that plugins can register
3399
# their own config files (or not) -- vila 20101002
3400
commands.Option('scope', help='Reduce the scope to the specified'
3401
' configuration file',
3403
commands.Option('all',
3404
help='Display all the defined values for the matching options.',
3406
commands.Option('remove', help='Remove the option from'
3407
' the configuration file'),
3410
_see_also = ['configuration']
3412
@commands.display_command
3413
def run(self, name=None, all=False, directory=None, scope=None,
3415
if directory is None:
3417
directory = urlutils.normalize_url(directory)
3419
raise errors.BzrError(
3420
'--all and --remove are mutually exclusive.')
3422
# Delete the option in the given scope
3423
self._remove_config_option(name, directory, scope)
3425
# Defaults to all options
3426
self._show_matching_options('.*', directory, scope)
3429
name, value = name.split('=', 1)
3431
# Display the option(s) value(s)
3433
self._show_matching_options(name, directory, scope)
3435
self._show_value(name, directory, scope)
3438
raise errors.BzrError(
3439
'Only one option can be set.')
3440
# Set the option value
3441
self._set_config_option(name, value, directory, scope)
3443
def _get_configs(self, directory, scope=None):
3444
"""Iterate the configurations specified by ``directory`` and ``scope``.
3446
:param directory: Where the configurations are derived from.
3448
:param scope: A specific config to start from.
3450
if scope is not None:
3451
if scope == 'bazaar':
3452
yield GlobalConfig()
3453
elif scope == 'locations':
3454
yield LocationConfig(directory)
3455
elif scope == 'branch':
3457
controldir.ControlDir.open_containing_tree_or_branch(
3459
yield br.get_config()
3463
controldir.ControlDir.open_containing_tree_or_branch(
3465
yield br.get_config()
3466
except errors.NotBranchError:
3467
yield LocationConfig(directory)
3468
yield GlobalConfig()
3470
def _show_value(self, name, directory, scope):
3472
for c in self._get_configs(directory, scope):
3475
for (oname, value, section, conf_id, parser) in c._get_options():
3477
# Display only the first value and exit
3479
# FIXME: We need to use get_user_option to take policies
3480
# into account and we need to make sure the option exists
3481
# too (hence the two for loops), this needs a better API
3483
value = c.get_user_option(name)
3484
# Quote the value appropriately
3485
value = parser._quote(value)
3486
self.outf.write('%s\n' % (value,))
3490
raise errors.NoSuchConfigOption(name)
3492
def _show_matching_options(self, name, directory, scope):
3493
name = lazy_regex.lazy_compile(name)
3494
# We want any error in the regexp to be raised *now* so we need to
3495
# avoid the delay introduced by the lazy regexp. But, we still do
3496
# want the nicer errors raised by lazy_regex.
3497
name._compile_and_collapse()
3500
for c in self._get_configs(directory, scope):
3501
for (oname, value, section, conf_id, parser) in c._get_options():
3502
if name.search(oname):
3503
if cur_conf_id != conf_id:
3504
# Explain where the options are defined
3505
self.outf.write('%s:\n' % (conf_id,))
3506
cur_conf_id = conf_id
3508
if (section not in (None, 'DEFAULT')
3509
and cur_section != section):
3510
# Display the section if it's not the default (or only)
3512
self.outf.write(' [%s]\n' % (section,))
3513
cur_section = section
3514
self.outf.write(' %s = %s\n' % (oname, value))
3516
def _set_config_option(self, name, value, directory, scope):
3517
for conf in self._get_configs(directory, scope):
3518
conf.set_user_option(name, value)
3521
raise errors.NoSuchConfig(scope)
3523
def _remove_config_option(self, name, directory, scope):
3525
raise errors.BzrCommandError(
3526
'--remove expects an option to remove.')
3528
for conf in self._get_configs(directory, scope):
3529
for (section_name, section, conf_id) in conf._get_sections():
3530
if scope is not None and conf_id != scope:
3531
# Not the right configuration file
3534
if conf_id != conf.config_id():
3535
conf = self._get_configs(directory, conf_id).next()
3536
# We use the first section in the first config where the
3537
# option is defined to remove it
3538
conf.remove_user_option(name, section_name)
3543
raise errors.NoSuchConfig(scope)
3545
raise errors.NoSuchConfigOption(name)
3549
# We need adapters that can build a Store or a Stack in a test context. Test
3550
# classes, based on TestCaseWithTransport, can use the registry to parametrize
3551
# themselves. The builder will receive a test instance and should return a
3552
# ready-to-use store or stack. Plugins that define new store/stacks can also
3553
# register themselves here to be tested against the tests defined in
3554
# bzrlib.tests.test_config. Note that the builder can be called multiple times
3555
# for the same tests.
3557
# The registered object should be a callable receiving a test instance
3558
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
3560
test_store_builder_registry = registry.Registry()
3562
# The registered object should be a callable receiving a test instance
3563
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
3565
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
