This document describes the current stable version of Kombu (5.3). For development docs, go here.
Pattern matching registry - kombu.matcher
¶
Pattern matching registry.
- class kombu.matcher.MatcherRegistry[source]¶
Pattern matching function registry.
- exception MatcherNotInstalled¶
Matcher not installed/found.
- match(data: bytes, pattern: bytes, matcher: str | None = None, matcher_kwargs: dict[str, str] | None = None) bool [source]¶
Call the matcher.
- matcher_pattern_first = ['pcre']¶
- kombu.matcher.match(data: bytes, pattern: bytes, matcher: str | None = None, matcher_kwargs: dict[str, str] | None = None) bool ¶
- register(name, matcher):
- Register a new matching method.
- Parameters:
name – A convenient name for the mathing method.
matcher – A method that will be passed data and pattern.
- kombu.matcher.register(name: str, matcher: Callable[[str, str], bool]) None ¶
- 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.