# Copyright 2008-2015 Nokia Networks
# Copyright 2016- Robot Framework Foundation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import fnmatch
import re
from typing import Iterable, Iterator, Sequence
from .normalizing import normalize
[docs]
def eq(
str1: str,
str2: str,
ignore: Sequence[str] = (),
caseless: bool = True,
spaceless: bool = True,
) -> bool:
str1 = normalize(str1, ignore, caseless, spaceless)
str2 = normalize(str2, ignore, caseless, spaceless)
return str1 == str2
[docs]
class Matcher:
def __init__(
self,
pattern: str,
ignore: Sequence[str] = (),
caseless: bool = True,
spaceless: bool = True,
regexp: bool = False,
):
self.pattern = pattern
if caseless or spaceless or ignore:
self._normalize = lambda s: normalize(s, ignore, caseless, spaceless)
else:
self._normalize = lambda s: s
self._regexp = self._compile(self._normalize(pattern), regexp=regexp)
def _compile(self, pattern, regexp=False):
if not regexp:
pattern = fnmatch.translate(pattern)
return re.compile(pattern, re.DOTALL)
[docs]
def match(self, string: str) -> bool:
return self._regexp.match(self._normalize(string)) is not None
[docs]
def match_any(self, strings: Iterable[str]) -> bool:
return any(self.match(s) for s in strings)
def __bool__(self) -> bool:
return bool(self._normalize(self.pattern))
[docs]
class MultiMatcher(Iterable[Matcher]):
def __init__(
self,
patterns: Iterable[str] = (),
ignore: Sequence[str] = (),
caseless: bool = True,
spaceless: bool = True,
match_if_no_patterns: bool = False,
regexp: bool = False,
):
self.matchers = [
Matcher(pattern, ignore, caseless, spaceless, regexp)
for pattern in self._ensure_iterable(patterns)
]
self.match_if_no_patterns = match_if_no_patterns
def _ensure_iterable(self, patterns):
if patterns is None:
return ()
if isinstance(patterns, str):
return (patterns,)
return patterns
[docs]
def match(self, string: str) -> bool:
if self.matchers:
return any(m.match(string) for m in self.matchers)
return self.match_if_no_patterns
[docs]
def match_any(self, strings: Iterable[str]) -> bool:
return any(self.match(s) for s in strings)
def __len__(self) -> int:
return len(self.matchers)
def __iter__(self) -> Iterator[Matcher]:
return iter(self.matchers)