← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Matt Nordhoff
  • Date: 2009-06-23 05:12:07 UTC
  • mto: This revision was merged to the branch mainline in revision 4474.
  • Revision ID: mnordhoff@mattnordhoff.com-20090623051207-fksdtbzkwtnrw9dd
Update _add_text docstrings that still referred to add_text.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/config.py
146
146
class Config(object):
147
147
    """A configuration policy - what username, editor, gpg needs etc."""
148
148
 
149
 
    def __init__(self):
150
 
        super(Config, self).__init__()
151
 
 
152
149
    def get_editor(self):
153
150
        """Get the users pop up editor."""
154
151
        raise NotImplementedError
177
174
        """Get a generic option - no special process, no default."""
178
175
        return self._get_user_option(option_name)
179
176
 
180
 
    def get_user_option_as_bool(self, option_name):
181
 
        """Get a generic option as a boolean - no special process, no default.
182
 
 
183
 
        :return None if the option doesn't exist or its value can't be
184
 
            interpreted as a boolean. Returns True or False ortherwise.
185
 
        """
186
 
        s = self._get_user_option(option_name)
187
 
        return ui.bool_from_string(s)
188
 
 
189
177
    def gpg_signing_command(self):
190
178
        """What program should be used to sign signatures?"""
191
179
        result = self._gpg_signing_command()
208
196
        """See log_format()."""
209
197
        return None
210
198
 
 
199
    def __init__(self):
 
200
        super(Config, self).__init__()
 
201
 
211
202
    def post_commit(self):
212
203
        """An ordered list of python functions to call.
213
204
 
308
299
class IniBasedConfig(Config):
309
300
    """A configuration policy that draws from ini files."""
310
301
 
311
 
    def __init__(self, get_filename):
312
 
        super(IniBasedConfig, self).__init__()
313
 
        self._get_filename = get_filename
314
 
        self._parser = None
315
 
 
316
302
    def _get_parser(self, file=None):
317
303
        if self._parser is not None:
318
304
            return self._parser
395
381
        """See Config.log_format."""
396
382
        return self._get_user_option('log_format')
397
383
 
 
384
    def __init__(self, get_filename):
 
385
        super(IniBasedConfig, self).__init__()
 
386
        self._get_filename = get_filename
 
387
        self._parser = None
 
388
 
398
389
    def _post_commit(self):
399
390
        """See Config.post_commit."""
400
391
        return self._get_user_option('post_commit')
821
812
    return osutils.pathjoin(config_dir(), 'ignore')
822
813
 
823
814
 
824
 
def crash_dir():
825
 
    """Return the directory name to store crash files.
826
 
 
827
 
    This doesn't implicitly create it.
828
 
 
829
 
    On Windows it's in the config directory; elsewhere in the XDG cache directory.
830
 
    """
831
 
    if sys.platform == 'win32':
832
 
        return osutils.pathjoin(config_dir(), 'Crash')
833
 
    else:
834
 
        return osutils.pathjoin(xdg_cache_dir(), 'crash')
835
 
 
836
 
 
837
 
def xdg_cache_dir():
838
 
    # See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
839
 
    # Possibly this should be different on Windows?
840
 
    e = os.environ.get('XDG_CACHE_DIR', None)
841
 
    if e:
842
 
        return e
843
 
    else:
844
 
        return os.path.expanduser('~/.cache')
845
 
 
846
 
 
847
815
def _auto_user_id():
848
816
    """Calculate automatic user identification.
849
817
 
962
930
            return self._config.get_option(name, section, default)
963
931
        finally:
964
932
            self.branch.unlock()
 
933
        return result
965
934
 
966
935
    def set_option(self, value, name, section=None):
967
936
        """Set a per-branch configuration option"""