/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/rules.py

  • Committer: Martin
  • Date: 2017-06-10 01:57:00 UTC
  • mto: This revision was merged to the branch mainline in revision 6679.
  • Revision ID: gzlist@googlemail.com-20170610015700-o3xeuyaqry2obiay
Go back to native str for urls and many other py3 changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/rules.py
 
1
# Copyright (C) 2008, 2009, 2010 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 __future__ import absolute_import
 
23
 
 
24
import configobj
 
25
 
 
26
from . import (
 
27
    config,
 
28
    cmdline,
 
29
    errors,
 
30
    globbing,
 
31
    osutils,
 
32
    )
 
33
 
 
34
 
 
35
# Name of the file holding rules in a tree
 
36
RULES_TREE_FILENAME = ".bzrrules"
 
37
 
 
38
# Namespace prefix for per file preferences
 
39
FILE_PREFS_PREFIX = 'name '
 
40
FILE_PREFS_PREFIX_LEN = len(FILE_PREFS_PREFIX)
 
41
 
 
42
# The object providing default rules
 
43
_per_user_searcher = None
 
44
 
 
45
 
 
46
class _RulesSearcher(object):
 
47
    """An object that provides rule-based preferences."""
 
48
 
 
49
    def get_items(self, path):
 
50
        """Return the preferences for a path as name,value tuples.
 
51
 
 
52
        :param path: tree relative path
 
53
        :return: () if no rule matched, otherwise a sequence of name,value
 
54
          tuples.
 
55
        """
 
56
        raise NotImplementedError(self.get_items)
 
57
 
 
58
    def get_selected_items(self, path, names):
 
59
        """Return selected preferences for a path as name,value tuples.
 
60
 
 
61
        :param path: tree relative path
 
62
        :param names: the list of preferences to lookup
 
63
        :return: () if no rule matched, otherwise a sequence of name,value
 
64
          tuples. The sequence is the same length as names,
 
65
          tuple order matches the order in names, and
 
66
          undefined preferences are given the value None.
 
67
        """
 
68
        raise NotImplementedError(self.get_selected_items)
 
69
 
 
70
    def get_single_value(self, path, preference_name):
 
71
        """Get a single preference for a single file.
 
72
        
 
73
        :returns: The string preference value, or None.
 
74
        """
 
75
        for key, value in self.get_selected_items(path, [preference_name]):
 
76
            return value
 
77
        return None
 
78
 
 
79
 
 
80
class _IniBasedRulesSearcher(_RulesSearcher):
 
81
 
 
82
    def __init__(self, inifile):
 
83
        """Construct a _RulesSearcher based on an ini file.
 
84
 
 
85
        The content will be decoded as utf-8.
 
86
 
 
87
        :param inifile: the name of the file or a sequence of lines.
 
88
        """
 
89
        self._cfg = configobj.ConfigObj(inifile, encoding='utf-8')
 
90
        sections = self._cfg.keys()
 
91
        patterns = []
 
92
        self.pattern_to_section = {}
 
93
        for s in sections:
 
94
            if s.startswith(FILE_PREFS_PREFIX):
 
95
                file_patterns = cmdline.split(s[FILE_PREFS_PREFIX_LEN:])
 
96
                patterns.extend(file_patterns)
 
97
                for fp in file_patterns:
 
98
                    self.pattern_to_section[fp] = s
 
99
        if len(patterns) < len(sections):
 
100
            unknowns = [s for s in sections
 
101
                if not s.startswith(FILE_PREFS_PREFIX)]
 
102
            raise errors.UnknownRules(unknowns)
 
103
        elif patterns:
 
104
            self._globster = globbing._OrderedGlobster(patterns)
 
105
        else:
 
106
            self._globster = None
 
107
 
 
108
    def get_items(self, path):
 
109
        """See _RulesSearcher.get_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(all.items())
 
118
 
 
119
    def get_selected_items(self, path, names):
 
120
        """See _RulesSearcher.get_selected_items."""
 
121
        if self._globster is None:
 
122
            return ()
 
123
        pat = self._globster.match(path)
 
124
        if pat is None:
 
125
            return ()
 
126
        else:
 
127
            all = self._cfg[self.pattern_to_section[pat]]
 
128
            return tuple((k, all.get(k)) for k in names)
 
129
 
 
130
 
 
131
class _StackedRulesSearcher(_RulesSearcher):
 
132
 
 
133
    def __init__(self, searchers):
 
134
        """Construct a _RulesSearcher based on a stack of other ones.
 
135
 
 
136
        :param searchers: a sequence of searchers.
 
137
        """
 
138
        self.searchers = searchers
 
139
 
 
140
    def get_items(self, path):
 
141
        """See _RulesSearcher.get_items."""
 
142
        for searcher in self.searchers:
 
143
            result = searcher.get_items(path)
 
144
            if result:
 
145
                return result
 
146
        return ()
 
147
 
 
148
    def get_selected_items(self, path, names):
 
149
        """See _RulesSearcher.get_selected_items."""
 
150
        for searcher in self.searchers:
 
151
            result = searcher.get_selected_items(path, names)
 
152
            if result:
 
153
                return result
 
154
        return ()
 
155
 
 
156
 
 
157
def rules_filename():
 
158
    """Return the default rules filename."""
 
159
    return osutils.pathjoin(config.config_dir(), 'rules')
 
160
 
 
161
 
 
162
def reset_rules():
 
163
    global _per_user_searcher
 
164
    _per_user_searcher = _IniBasedRulesSearcher(rules_filename())
 
165
 
 
166
reset_rules()