← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/rules.py

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/rules.py
 
1
# Copyright (C) 2008 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Rule-based definition of preferences for selected files in selected branches.
 
18
 
 
19
See ``bzr help rules`` for details.
 
20
"""
 
21
 
 
22
from bzrlib import (
 
23
    config,
 
24
    cmdline,
 
25
    errors,
 
26
    globbing,
 
27
    osutils,
 
28
    )
 
29
from bzrlib.util.configobj import configobj
 
30
 
 
31
 
 
32
# Name of the file holding rules in a tree
 
33
RULES_TREE_FILENAME = ".bzrrules"
 
34
 
 
35
# Namespace prefix for per file preferences
 
36
FILE_PREFS_PREFIX = 'name '
 
37
FILE_PREFS_PREFIX_LEN = len(FILE_PREFS_PREFIX)
 
38
 
 
39
# The object providing default rules
 
40
_per_user_searcher = None
 
41
 
 
42
 
 
43
class _RulesSearcher(object):
 
44
    """An object that provides rule-based preferences."""
 
45
 
 
46
    def get_items(self, path):
 
47
        """Return the preferences for a path as name,value tuples.
 
48
 
 
49
        :param path: tree relative path
 
50
        :return: () if no rule matched, otherwise a sequence of name,value
 
51
          tuples.
 
52
        """
 
53
        raise NotImplementedError(self.get_items)
 
54
 
 
55
    def get_selected_items(self, path, names):
 
56
        """Return selected preferences for a path as name,value tuples.
 
57
 
 
58
        :param path: tree relative path
 
59
        :param names: the list of preferences to lookup
 
60
        :return: () if no rule matched, otherwise a sequence of name,value
 
61
          tuples. The sequence is the same length as names,
 
62
          tuple order matches the order in names, and
 
63
          undefined preferences are given the value None.
 
64
        """
 
65
        raise NotImplementedError(self.get_selected_items)
 
66
 
 
67
 
 
68
class _IniBasedRulesSearcher(_RulesSearcher):
 
69
 
 
70
    def __init__(self, inifile):
 
71
        """Construct a _RulesSearcher based on an ini file.
 
72
 
 
73
        The content will be decoded as utf-8.
 
74
 
 
75
        :param inifile: the name of the file or a sequence of lines.
 
76
        """
 
77
        options = {'encoding': 'utf-8'}
 
78
        self._cfg = configobj.ConfigObj(inifile, options=options)
 
79
        sections = self._cfg.keys()
 
80
        patterns = []
 
81
        self.pattern_to_section = {}
 
82
        for s in sections:
 
83
            if s.startswith(FILE_PREFS_PREFIX):
 
84
                file_patterns = cmdline.split(s[FILE_PREFS_PREFIX_LEN:])
 
85
                patterns.extend(file_patterns)
 
86
                for fp in file_patterns:
 
87
                    self.pattern_to_section[fp] = s
 
88
        if len(patterns) < len(sections):
 
89
            unknowns = [s for s in sections
 
90
                if not s.startswith(FILE_PREFS_PREFIX)]
 
91
            raise errors.UnknownRules(unknowns)
 
92
        elif patterns:
 
93
            self._globster = globbing._OrderedGlobster(patterns)
 
94
        else:
 
95
            self._globster = None
 
96
 
 
97
    def get_items(self, path):
 
98
        """See _RulesSearcher.get_items."""
 
99
        if self._globster is None:
 
100
            return ()
 
101
        pat = self._globster.match(path)
 
102
        if pat is None:
 
103
            return ()
 
104
        else:
 
105
            all = self._cfg[self.pattern_to_section[pat]]
 
106
            return tuple(all.items())
 
107
 
 
108
    def get_selected_items(self, path, names):
 
109
        """See _RulesSearcher.get_selected_items."""
 
110
        if self._globster is None:
 
111
            return ()
 
112
        pat = self._globster.match(path)
 
113
        if pat is None:
 
114
            return ()
 
115
        else:
 
116
            all = self._cfg[self.pattern_to_section[pat]]
 
117
            return tuple((k, all.get(k)) for k in names)
 
118
 
 
119
 
 
120
class _StackedRulesSearcher(_RulesSearcher):
 
121
 
 
122
    def __init__(self, searchers):
 
123
        """Construct a _RulesSearcher based on a stack of other ones.
 
124
 
 
125
        :param searchers: a sequence of searchers.
 
126
        """
 
127
        self.searchers = searchers
 
128
 
 
129
    def get_items(self, path):
 
130
        """See _RulesSearcher.get_items."""
 
131
        for searcher in self.searchers:
 
132
            result = searcher.get_items(path)
 
133
            if result:
 
134
                return result
 
135
        return ()
 
136
 
 
137
    def get_selected_items(self, path, names):
 
138
        """See _RulesSearcher.get_selected_items."""
 
139
        for searcher in self.searchers:
 
140
            result = searcher.get_selected_items(path, names)
 
141
            if result:
 
142
                return result
 
143
        return ()
 
144
 
 
145
 
 
146
def rules_filename():
 
147
    """Return the default rules filename."""
 
148
    return osutils.pathjoin(config.config_dir(), 'rules')
 
149
 
 
150
 
 
151
def reset_rules():
 
152
    global _per_user_searcher
 
153
    _per_user_searcher = _IniBasedRulesSearcher(rules_filename())
 
154
 
 
155
reset_rules()