b.r._RulesSearcher(object) : class documentation

Part of bzrlib.rules View In Hierarchy

Known subclasses: bzrlib.rules._IniBasedRulesSearcher, bzrlib.rules._StackedRulesSearcher

An object that provides rule-based preferences.
Method get_items Return the preferences for a path as name,value tuples.
Method get_selected_items Return selected preferences for a path as name,value tuples.
Method get_single_value Get a single preference for a single file.
def get_items(self, path):
overridden in bzrlib.rules._IniBasedRulesSearcher, bzrlib.rules._StackedRulesSearcher
Return the preferences for a path as name,value tuples.
Parameterspathtree relative path
Returns() if no rule matched, otherwise a sequence of name,value tuples.
def get_selected_items(self, path, names):
overridden in bzrlib.rules._IniBasedRulesSearcher, bzrlib.rules._StackedRulesSearcher
Return selected preferences for a path as name,value tuples.
Parameterspathtree relative path
namesthe list of preferences to lookup
Returns() if no rule matched, otherwise a sequence of name,value tuples. The sequence is the same length as names, tuple order matches the order in names, and undefined preferences are given the value None.
def get_single_value(self, path, preference_name):
Get a single preference for a single file.
ReturnsThe string preference value, or None.
API Documentation for Bazaar, generated by pydoctor at 2022-06-16 00:25:16.