This document is for Kombu's development version, which can be significantly different from previous releases. Get the stable docs here: 4.5.
Pattern matching registry - kombu.matcher
¶
Pattern matching registry.
-
class
kombu.matcher.
MatcherRegistry
[source]¶ Pattern matching function registry.
-
exception
MatcherNotInstalled
¶ Matcher not installed/found.
-
matcher_pattern_first
= ['pcre']¶
-
exception
-
kombu.matcher.
match
(data, pattern, matcher=None, matcher_kwargs=None)¶ -
register(name, matcher):
-
Register a new matching method.
- Parameters
name – A convience name for the mathing method.
matcher – A method that will be passed data and pattern.
-
-
kombu.matcher.
register
(name, matcher)¶ -
unregister(name):
-
Unregister registered matching method.
- Parameters
name – Registered matching method name.
-
-
kombu.matcher.
registry
= <kombu.matcher.MatcherRegistry object>¶ -
match(data, pattern, matcher=default_matcher,
-
matcher_kwargs=None):
Match data by pattern using matcher.
- Parameters
data – The data that should be matched. Must be string.
pattern – The pattern that should be applied. Must be string.
- Keyword Arguments
matcher –
An optional string representing the mathcing method (for example, glob or pcre).
If
None
(default), then glob will be used.matcher_kwargs – Additional keyword arguments that will be passed to the specified matcher.
- Returns
True
if data matches pattern,False
otherwise.- Raises
MatcherNotInstalled – If the matching method requested is not available.
-
-
kombu.matcher.
unregister
(name)¶ Remove matcher by name from the registry.