From d50602441977b26811a1c69532c54d2786f76142 Mon Sep 17 00:00:00 2001 From: Richard Date: Sun, 24 Apr 2022 15:17:31 -0400 Subject: [PATCH 01/85] updated to python 3, refactored code, added typehints --- .gitignore | 6 +- verbalexpressions/__init__.py | 2 +- verbalexpressions/verbal_expressions.py | 346 ++++++++++++++++++------ verbex.py | 41 +++ 4 files changed, 311 insertions(+), 84 deletions(-) create mode 100644 verbex.py diff --git a/.gitignore b/.gitignore index 8904a1f..ba0430d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1 @@ -venv -dist -build -*.py[co] -*.egg-info +__pycache__/ \ No newline at end of file diff --git a/verbalexpressions/__init__.py b/verbalexpressions/__init__.py index bc28e0a..233a1e0 100644 --- a/verbalexpressions/__init__.py +++ b/verbalexpressions/__init__.py @@ -1 +1 @@ -from verbalexpressions.verbal_expressions import VerEx, re_escape +from .verbal_expressions import VerbEx, re_escape diff --git a/verbalexpressions/verbal_expressions.py b/verbalexpressions/verbal_expressions.py index c1a22c8..eb65d10 100644 --- a/verbalexpressions/verbal_expressions.py +++ b/verbalexpressions/verbal_expressions.py @@ -1,133 +1,323 @@ +from __future__ import annotations + import re +from enum import Enum +from functools import wraps +from typing import Protocol + +try: + from beartype import beartype # type: ignore + from beartype.typing import ( # type: ignore + Any, + Callable, + Dict, + Iterator, + List, + Optional, + ParamSpec, + Tuple, + TypeVar, + Union, + cast, + runtime_checkable, + ) +except ModuleNotFoundError: + from typing import ( + Any, + Callable, + Dict, + Iterator, + List, + Optional, + ParamSpec, + Tuple, + TypeVar, + Union, + cast, + runtime_checkable, + ) + + __P = ParamSpec("__P") + __R = TypeVar("__R") + + def noop_dec(func: Callable[__P, __R]) -> Callable[__P, __R]: + return func + + beartype = noop_dec # type: ignore + + +P = ParamSpec("P") +R = TypeVar("R") + + +# work around for bug https://github.com/python/mypy/issues/12660 +@runtime_checkable +class HasIter(Protocol): + def __iter__(self) -> Iterator[Any]: + ... + + +# work around for bug https://github.com/python/mypy/issues/12660 +@runtime_checkable +class HasItems(Protocol): + def items(self) -> Tuple[str, Any]: + ... + + +class EscapedText(str): + def __new__(cls, value: str): + return str.__new__(cls, re.escape(value)) + + +def re_escape(func: Callable[P, R]) -> Callable[P, R]: + @wraps(func) + def inner(*args: P.args, **kwargs: P.kwargs) -> R: + escaped_args: List[Any] = [] + escaped_kwargs: Dict[str, Any] = {} + for arg in cast(HasIter, args): + if isinstance(arg, str): + escaped_args.append(EscapedText(re.escape(arg))) + else: + escaped_args.append(arg) + arg_k: str + arg_v: Any + for arg_k, arg_v in cast(HasItems, kwargs).items(): + if isinstance(arg_v, str): + escaped_kwargs[arg_k] = EscapedText(re.escape(str(arg_v))) + else: + escaped_kwargs[arg_k] = arg_v + return func(*escaped_args, **escaped_kwargs) # type: ignore + + return inner + + +class CharClass(Enum): + DIGIT = "\\d" + LETTER = "\\w" + UPPERCASE_LETTER = "\\u" + LOWERCASE_LETTER = "\\l" + WHITESPACE = "\\s" + TAB = "\\t" + + def __str__(self): + return self.value -def re_escape(fn): - def arg_escaped(this, *args): - t = [isinstance(a, VerEx) and a.s or re.escape(str(a)) for a in args] - return fn(this, *t) +class SpecialChar(Enum): + # does not work / should not be used in [ ] + LINEBREAK = "(\\n|(\\r\\n))" + START_OF_LINE = "^" + END_OF_LINE = "$" - return arg_escaped + def __str__(self): + return self.value -class VerEx(object): - """ - --- VerbalExpressions class --- - the following methods behave different from the original js lib! +CharClassOrChars = Union[str, CharClass] +EscapedCharClassOrSpecial = Union[str, CharClass, SpecialChar] +VerbexEscapedCharClassOrSpecial = Union["Verbex", EscapedCharClassOrSpecial] - - end_of_line - - start_of_line - - or - when you say you want `$`, `^` and `|`, we just insert it right there. - No other tricks. - And any string you inserted will be automatically grouped - except `tab` and `add`. +class Verbex: + """ + VerbalExpressions class. + the following methods do not try to match the original js lib! """ - def __init__(self): - self.s = [] - self.modifiers = {"I": 0, "M": 0, "A": 0} + @re_escape + @beartype + def __init__(self, modifiers: re.RegexFlag = re.RegexFlag(0)): + # self._parts: List[str] = [text] + self._parts: List[str] = [] + self._modifiers = modifiers - def __getattr__(self, attr): - """ any other function will be sent to the regex object """ - regex = self.regex() - return getattr(regex, attr) + @property + def modifiers(self) -> re.RegexFlag: + return self._modifiers def __str__(self): - return "".join(self.s) + """Return regex string representation.""" + return "".join(self._parts) + + @beartype + def __add(self, value: Union[str, List[str]]): + """ + Append a transformed value to internal expression to be compiled. - def add(self, value): + As possible, this method should be "private". + """ if isinstance(value, list): - self.s.extend(value) + self._parts.extend(value) else: - self.s.append(value) + self._parts.append(value) return self def regex(self): - """ get a regular expression object. """ + """get a regular expression object.""" return re.compile( str(self), - self.modifiers["I"] | self.modifiers["M"] | self.modifiers["A"], + self._modifiers, ) - compile = regex - - def source(self): - """ return the raw string """ - return str(self) + # allow VerbexEscapedCharClassOrSpecial - raw = value = source + @re_escape + @beartype + def _capture_group_with_name( + self, + name: str, + text: VerbexEscapedCharClassOrSpecial, + ) -> Verbex: + return self.__add(f"(?<{name}>{str(text)})") - # --------------------------------------------- + @re_escape + @beartype + def _capture_group_without_name( + self, + text: VerbexEscapedCharClassOrSpecial, + ) -> Verbex: + return self.__add(f"({str(text)})") - def anything(self): - return self.add("(.*)") + @re_escape + @beartype + def capture_group( + self, + /, + name_or_text: Union[ + Optional[str], VerbexEscapedCharClassOrSpecial + ] = None, + text: Optional[VerbexEscapedCharClassOrSpecial] = None, + ) -> Verbex: + if name_or_text is not None: + if text is None: + _text = name_or_text + return self._capture_group_without_name(_text) + if isinstance(name_or_text, str): + return self._capture_group_with_name(name_or_text, text) + raise ValueError("text must be specified with optional name") @re_escape - def anything_but(self, value): - return self.add("([^%s]*)" % value) + @beartype + def OR(self, text: VerbexEscapedCharClassOrSpecial): # noqa N802 + """`or` is a python keyword so we use `OR` instead.""" + self.__add("|") + self.find(text) - def end_of_line(self): - return self.add("$") + @re_escape + @beartype + def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + return self.__add(f"(?:{str(text)})*") @re_escape - def maybe(self, value): - return self.add("(%s)?" % value) + @beartype + def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + return self.__add(f"(?:{str(text)})+") - def start_of_line(self): - return self.add("^") + @re_escape + @beartype + def n_times(self, text: VerbexEscapedCharClassOrSpecial, n: int) -> Verbex: + return self.__add(f"(?:{str(text)}){{{n}}}") @re_escape - def find(self, value): - return self.add("(%s)" % value) + @beartype + def n_times_or_more( + self, text: VerbexEscapedCharClassOrSpecial, n: int + ) -> Verbex: + return self.__add(f"(?:{str(text)}){{{n},}}") - then = find + @re_escape + @beartype + def n_to_m_times( + self, text: VerbexEscapedCharClassOrSpecial, n: int, m: int + ) -> Verbex: + return self.__add(f"(?:{str(text)}){{{n},{m}}}") - # special characters and groups + @re_escape + def anything_but(self, text: EscapedCharClassOrSpecial): + return self.__add(f"[^{text}]*") @re_escape - def any(self, value): - return self.add("([%s])" % value) + @beartype + def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + # if isinstance(text, Verbex): + # return self.__add(f"(?:{str(text)})?") + return self.__add(f"(?:{str(text)})?") - any_of = any + @re_escape + @beartype + def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + return self.__add(str(text)) - def line_break(self): - return self.add(r"(\n|(\r\n))") + # only allow CharclassOrChars - br = line_break + @re_escape + @beartype + def any_of(self, text: CharClassOrChars) -> Verbex: + return self.__add(f"(?:[{text}])") @re_escape - def range(self, *args): - from_tos = [args[i : i + 2] for i in range(0, len(args), 2)] - return self.add("([%s])" % "".join(["-".join(i) for i in from_tos])) + @beartype + def not_any_of(self, text: CharClassOrChars) -> Verbex: + return self.__add(f"(?:[^{text}])") - def tab(self): - return self.add(r"\t") + # no text input - def word(self): - return self.add(r"(\w+)") + def anything(self) -> Verbex: + return self.__add(".*") - def OR(self, value=None): - """ `or` is a python keyword so we use `OR` instead. """ - self.add("|") - return self.find(value) if value else self + def asfew(self) -> Verbex: + return self.__add("?") - def replace(self, string, repl): - return self.sub(repl, string) + @beartype + def range(self, start: int, end: int) -> Verbex: + return self.__add( + "(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")" + ) - # --------------- modifiers ------------------------ + def word(self) -> Verbex: + return self.__add("(\\b\\w+\\b)") - # no global option. It depends on which method - # you called on the regex object. + # # --------------- modifiers ------------------------ - def with_any_case(self, value=False): - self.modifiers["I"] = re.I if value else 0 + def with_any_case(self) -> Verbex: + self._modifiers |= re.IGNORECASE return self - def search_one_line(self, value=False): - self.modifiers["M"] = re.M if value else 0 + def search_by_line(self) -> Verbex: + self._modifiers |= re.MULTILINE return self - def with_ascii(self, value=False): - self.modifiers["A"] = re.A if value else 0 + def with_ascii(self) -> Verbex: + self._modifiers |= re.ASCII return self + + +# left over notes from original version +# def __getattr__(self, attr): +# """ any other function will be sent to the regex object """ +# regex = self.regex() +# return getattr(regex, attr) + +# def range(self, start: int, end: int) -> Verbex: +# # this was the original? method +# from_tos = [args[i : i + 2] for i in range(0, len(args), 2)] +# return self.__add("([%s])" % "".join(["-".join(i) for i in from_tos])) + +# def replace(self, string, repl): +# return self.sub(repl, string) + + +t = ( + # Verbex().maybe(Verbex().find("tet")) + Verbex().capture_group( + "test", + Verbex().find("what to find"), + ) + # Verbex() + # .with_any_case() + # .maybe("test") + # .find(RegexEnum.DIGIT) + # .any("test") + # .range(10, 20) +) +print(t) diff --git a/verbex.py b/verbex.py new file mode 100644 index 0000000..8c2d9ce --- /dev/null +++ b/verbex.py @@ -0,0 +1,41 @@ +from verbalexpressions import VerEx, re_escape + +verbal_expression = VerEx() +# Create an example of how to test for correctly formed URLs +verbal_expression = VerEx() +tester = ( + verbal_expression.start_of_line() + .find("http") + .maybe("s") + .find("://") + .maybe("www.") + .anything_but(" ") + .end_of_line() +) + +# # Create an example URL +# test_url = "https://www.google.com" + +# # Test if the URL is valid +# if tester.match(test_url): +# print "Valid URL" + +# # Print the generated regex +# print tester.source() # => ^(http)(s)?(\:\/\/)(www\.)?([^\ ]*)$ + + +# # Create a test string +# replace_me = "Replace bird with a duck" + +# # Create an expression that looks for the word "bird" +# expression = VerEx().find('bird') + +# # Execute the expression in VerEx +# result_VerEx = expression.replace(replace_me, 'duck') +# print result_VerEx + +# # Or we can compile and use the regular expression using re +# import re +# regexp = expression.compile() +# result_re = regexp.sub('duck', replace_me) +# print result_re From 8a6cb18b9ecce9ae2340cb57dccdf332e9d246c3 Mon Sep 17 00:00:00 2001 From: Richard Date: Sun, 24 Apr 2022 15:19:11 -0400 Subject: [PATCH 02/85] removed test file --- verbex.py | 41 ----------------------------------------- 1 file changed, 41 deletions(-) delete mode 100644 verbex.py diff --git a/verbex.py b/verbex.py deleted file mode 100644 index 8c2d9ce..0000000 --- a/verbex.py +++ /dev/null @@ -1,41 +0,0 @@ -from verbalexpressions import VerEx, re_escape - -verbal_expression = VerEx() -# Create an example of how to test for correctly formed URLs -verbal_expression = VerEx() -tester = ( - verbal_expression.start_of_line() - .find("http") - .maybe("s") - .find("://") - .maybe("www.") - .anything_but(" ") - .end_of_line() -) - -# # Create an example URL -# test_url = "https://www.google.com" - -# # Test if the URL is valid -# if tester.match(test_url): -# print "Valid URL" - -# # Print the generated regex -# print tester.source() # => ^(http)(s)?(\:\/\/)(www\.)?([^\ ]*)$ - - -# # Create a test string -# replace_me = "Replace bird with a duck" - -# # Create an expression that looks for the word "bird" -# expression = VerEx().find('bird') - -# # Execute the expression in VerEx -# result_VerEx = expression.replace(replace_me, 'duck') -# print result_VerEx - -# # Or we can compile and use the regular expression using re -# import re -# regexp = expression.compile() -# result_re = regexp.sub('duck', replace_me) -# print result_re From 5a32898975df5547fcc0bb7a003faaf0267ef787 Mon Sep 17 00:00:00 2001 From: Richard Date: Sun, 1 May 2022 16:30:58 -0400 Subject: [PATCH 03/85] updated to python 3, using beartype, overal cleanup and improvement. --- .gitignore | 2 +- .pre-commit-config.yaml | 7 - .travis.yml | 3 - .vscode/settings.json | 16 + LICENSE.txt | 39 ++ README.md | 2 +- setup.py | 24 +- tests/test_verbal_expressions.py | 285 +++++++++++++++ tests/verbal_expressions_test.py | 263 -------------- verbalexpressions/__init__.py | 5 +- verbalexpressions/py.typed | 0 verbalexpressions/verbal_expressions.py | 461 ++++++++++++++++++------ 12 files changed, 715 insertions(+), 392 deletions(-) delete mode 100644 .pre-commit-config.yaml create mode 100644 .vscode/settings.json create mode 100644 LICENSE.txt create mode 100644 tests/test_verbal_expressions.py delete mode 100644 tests/verbal_expressions_test.py create mode 100644 verbalexpressions/py.typed diff --git a/.gitignore b/.gitignore index ba0430d..c18dd8d 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1 @@ -__pycache__/ \ No newline at end of file +__pycache__/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml deleted file mode 100644 index 877d718..0000000 --- a/.pre-commit-config.yaml +++ /dev/null @@ -1,7 +0,0 @@ -repos: -- repo: https://github.com/ambv/black - rev: stable - hooks: - - id: black - args: [--line-length=79] - language_version: python3.6 diff --git a/.travis.yml b/.travis.yml index deafd0f..51219d3 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,7 +1,5 @@ language: python python: - - "2.7" - - "3.5" - "3.6" - "3.7" - "3.8" @@ -9,4 +7,3 @@ python: # command to run tests script: python setup.py test - diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..19a66dd --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,16 @@ +{ + "python.testing.unittestArgs": [ + "-v", + "-s", + "./tests", + "-p", + "test*.py" + ], + "python.testing.pytestEnabled": false, + "python.testing.unittestEnabled": true, + "cSpell.words": [ + "pylance", + "pyright", + "Verbex" + ] +} diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..4b5ad82 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,39 @@ +Verbal Expressions +Copyright (C) 2022 Richard Broderick + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + + This file incorporates work covered by the following copyright and + permission notice: + + The MIT License (MIT) + + Copyright (c) 2017 jehna + + Permission is hereby granted, free of charge, to any person obtaining a copy of + this software and associated documentation files (the "Software"), to deal in + the Software without restriction, including without limitation the rights to + use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of + the Software, and to permit persons to whom the Software is furnished to do so, + subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS + FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR + COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER + IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index d94fbc6..90fe3d5 100644 --- a/README.md +++ b/README.md @@ -68,5 +68,5 @@ print result python setup.py develop python setup.py test ``` -## Other implementations +## Other implementations You can view all implementations on [VerbalExpressions.github.io](http://VerbalExpressions.github.io) diff --git a/setup.py b/setup.py index e76b29e..021a3c6 100755 --- a/setup.py +++ b/setup.py @@ -2,21 +2,27 @@ setup( name="VerbalExpressions", - version="0.0.2", - description="Make difficult regular expressions easy! Python port of the awesome VerbalExpressions repo - https://github.com/jehna/VerbalExpressions", - long_description="Please see https://github.com/VerbalExpressions/PythonVerbalExpressions/blob/master/README.md for more information!", - author="Victor Titor, Yan Wenjun, diogobeda, Mihai Ionut Vilcu, Peder Soholt, Sameer Raghuram, Kharms", + version="1.0.0", + description=( + "Make difficult regular expressions easy! Python port of the awesome" + " VerbalExpressions repo - https://github.com/jehna/VerbalExpressions" + ), + long_description=( + "Please see" + " https://github.com/VerbalExpressions/PythonVerbalExpressions/blob/master/README.md" + " for more information!" + ), + author=( + "Victor Titor, Yan Wenjun, diogobeda, Mihai Ionut Vilcu, Peder Soholt, Sameer" + " Raghuram, Kharms, Richard Broderick" + ), license="MIT", url="https://github.com/VerbalExpressions/PythonVerbalExpressions", test_suite="tests", packages=["verbalexpressions"], - tests_require=["six"], - extras_require={"dev": ["pre-commit", "black"]}, classifiers=[ - "License :: OSI Approved :: MIT License", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Programming Language :: Python", - "Programming Language :: Python :: 2.7", - "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", diff --git a/tests/test_verbal_expressions.py b/tests/test_verbal_expressions.py new file mode 100644 index 0000000..f9164e8 --- /dev/null +++ b/tests/test_verbal_expressions.py @@ -0,0 +1,285 @@ +# pyright: reportPrivateUsage=false +# flake8: noqa +# type: ignore +import re +import unittest + +from verbalexpressions import CharClass, SpecialChar, Verbex + + +class verbexTest(unittest.TestCase): + """Tests for verbal_expressions.py""" + + # def setUp(self): + # Verbex() = Verbex() + + # def tearDown(self): + # ... + # # Verbex() = None + # # self.exp = None + + def test_should_render_verbex_as_string(self): + self.assertEqual(str(Verbex()._add("^$")), "^$") # noqa + + def test_should_render_verbex_list_as_string(self): + self.assertEqual(str(Verbex()._add(["^", "[0-9]", "$"])), "^[0-9]$") # noqa + + def test_should_match_characters_in_range(self): + regex = Verbex().letter_range("a", "c").regex() + for character in ["a", "b", "c"]: + self.assertRegex(character, regex) + + def test_should_not_match_characters_outside_of_range(self): + regex = Verbex().letter_range("a", "c").regex() + self.assertNotRegex("d", regex) + + def test_should_match_start_of_line(self): + regex = Verbex().find(SpecialChar.START_OF_LINE).find("text ").regex() + self.assertRegex("text ", regex) + + def test_should_match_end_of_line(self): + regex = Verbex().find("test").find(SpecialChar.END_OF_LINE).regex() + self.assertRegex("IGNORE test", regex) + + def test_should_match_anything(self): + regex = Verbex().anything().regex() + self.assertIsNotNone(re.fullmatch(regex, "!@#$%¨&*()__+{}")) + + def test_should_match_anything_but_specified_element_when_element_is_not_found( # noqa: E501 + self, + ): + regex = Verbex().anything_but("X").find(" Files").regex() + self.assertRegex("Y Files", regex) + self.assertNotRegex("X Files", regex) + + def test_should_not_match_anything_but_specified_element_when_specified_element_is_found( # noqa: E501 + self, + ): + regex = Verbex().anything_but("X").regex() + self.assertRegex("Y Files", regex) + self.assertNotRegex("X", regex) + + def test_should_find_element(self): + regex = Verbex().find("Wally").regex() + self.assertRegex("Wally", regex) + self.assertNotRegex("Nally", regex) + + def test_should_not_find_missing_element(self): + regex = Verbex().find("Wally").regex() + self.assertNotRegex("Wall-e", regex) + + def test_should_match_when_maybe_element_is_present(self): + regex = ( + Verbex() + .start_of_line() + .find("Python2.") + .maybe("7") + .end_of_line() + .regex() # + ) + self.assertRegex("Python2.7", regex) + + def test_should_match_when_maybe_element_is_missing(self): + regex = ( + Verbex() + .start_of_line() + .find("Python2.") + .maybe("7") + .end_of_line() + .regex() # + ) + self.assertRegex("Python2.", regex) + + def test_should_match_on_any_when_element_is_found(self): + regex = ( + Verbex() + .start_of_line() + .any_of("Q") + .anything() + .end_of_line() + .regex() # E501 # + ) + self.assertRegex("Query", regex) + + def test_should_not_match_on_any_when_element_is_not_found(self): + regex = ( + Verbex() + .start_of_line() + .any_of("Q") + .anything() + .end_of_line() + .regex() # E501 # + ) + self.assertNotRegex("W", regex) + + def test_should_match_when_line_break_present(self): + regex = ( + Verbex() + .start_of_line() + .anything() + .line_break() + .anything() + .end_of_line() + .regex() + ) + self.assertRegex("Marco \n Polo", regex) + self.assertNotRegex("Marco Polo", regex) + + def test_should_match_when_line_break_and_carriage_return_present(self): + regex = ( + Verbex() + .start_of_line() + .anything() + .line_break() + .anything() + .end_of_line() + .regex() + ) + self.assertRegex("Marco \r\n Polo", regex) + + def test_should_not_match_when_line_break_is_missing(self): + regex = ( + Verbex() + .start_of_line() + .anything() + .line_break() + .anything() + .end_of_line() + .regex() + ) + self.assertNotRegex("Marco Polo", regex) + + def test_should_match_when_tab_present(self): + regex = ( + Verbex() + .start_of_line() + .anything() + .as_few() + .find("!") + .tab() + .end_of_line() + .regex() # E501 # + ) + self.assertRegex("One tab only!\t", regex) + self.assertNotRegex("One tab only!\t\t", regex) + + def test_should_not_match_when_tab_is_missing(self): + regex = Verbex().start_of_line().anything().tab().end_of_line().regex() + self.assertNotRegex("No tab here", regex) + + def test_should_match_when_word_present(self): + regex = Verbex().start_of_line().word().end_of_line().regex() + self.assertRegex("Oneword", regex) + + def test_not_match_when_two_words_are_present_instead_of_one(self): + regex = Verbex().start_of_line().word().end_of_line().regex() + self.assertNotRegex("Two words", regex) + + def test_should_match_when_or_condition_fulfilled(self): + regex = ( + Verbex() + .start_of_line() + .find("G") + .OR(Verbex().find("H")) + .anything() + .as_few() + .find("b") + .end_of_line() + .regex() + ) + self.assertRegex("Github", regex) + self.assertRegex("Hithub", regex) + + def test_should_not_match_when_or_condition_not_fulfilled(self): + regex = ( + Verbex() + .start_of_line() + .find("G") + .OR(Verbex().find("H")) + .anything() + .as_few() + .find("b") + .end_of_line() + .regex() + ) + self.assertNotRegex("ithub", regex) + + def test_should_match_on_upper_case_when_lower_case_is_given_and_any_case( + self, + ): + regex = ( + Verbex() + .start_of_line() + .find("THOR") + .end_of_line() + .with_any_case() + .regex() # E501 # + ) + self.assertRegex("thor", regex) + + def test_should_not_match_on_upper_case_when_lower_case_is_given( + self, + ): + regex = Verbex().start_of_line().find("THOR").end_of_line().regex() + self.assertNotRegex("thor", regex) + + def test_should_match_multiple_lines(self): + regex = ( + Verbex() + .start_of_line() + .anything() + .find("Pong") + .anything() + .end_of_line() + .search_by_line() + .regex() + ) + self.assertRegex("Ping \n Pong \n Ping", regex) + + def test_should_not_match_multiple_lines(self): + regex = ( + Verbex() + .start_of_line() + .anything() + .find("Pong") + .anything() + .end_of_line() + .regex() + ) + self.assertNotRegex("Ping \n Pong \n Ping", regex) + + def test_should_match_email_like(self): + regex = ( + Verbex() + .start_of_line() + .one_or_more(Verbex().any_of(CharClass.LETTER)) + .then("@") + .one_or_more(Verbex().any_of(CharClass.LETTER)) + .then(".") + .one_or_more(Verbex().any_of(CharClass.LETTER)) + .end_of_line() + .regex() + ) + self.assertRegex("mail@mail.com", regex) + + def test_should_match_url(self): + regex = ( + Verbex() + .start_of_line() + .then("http") + .maybe("s") + .then("://") + .maybe("www.") + .word() + .then(".") + .word() + .maybe("/") + .end_of_line() + .regex() + ) + self.assertRegex("https://www.google.com/", regex) + self.assertNotRegex("htps://www.google.com/", regex) + + +if __name__ == "__main__": + unittest.main() diff --git a/tests/verbal_expressions_test.py b/tests/verbal_expressions_test.py deleted file mode 100644 index 4996b2f..0000000 --- a/tests/verbal_expressions_test.py +++ /dev/null @@ -1,263 +0,0 @@ -# -*- encoding: utf-8 -*- - -import unittest -import re - -import six - -import verbalexpressions - - -class VerExTest(unittest.TestCase): - """ Tests for verbal_expressions.py """ - - if six.PY3: - assertNotRegexpMatches = unittest.TestCase.assertNotRegex - - def setUp(self): - self.v = verbalexpressions.VerEx() - - def tearDown(self): - self.v = None - self.exp = None - - def test_should_render_verex_as_string(self): - self.assertEqual(str(self.v.add("^$")), "^$") - - def test_should_render_verex_list_as_string(self): - self.assertEqual(str(self.v.add(["^", "[0-9]", "$"])), "^[0-9]$") - - def test_should_match_characters_in_range(self): - self.exp = self.v.start_of_line().range("a", "c").regex() - for character in ["a", "b", "c"]: - six.assertRegex(self, character, self.exp) - - def test_should_not_match_characters_outside_of_range(self): - self.exp = self.v.start_of_line().range("a", "c").regex() - self.assertNotRegexpMatches("d", self.exp) - - def test_should_match_characters_in_extended_range(self): - self.exp = self.v.start_of_line().range("a", "b", "X", "Z").regex() - for character in ["a", "b"]: - six.assertRegex(self, character, self.exp) - for character in ["X", "Y", "Z"]: - six.assertRegex(self, character, self.exp) - - def test_should_not_match_characters_outside_of_extended_range(self): - self.exp = self.v.start_of_line().range("a", "b", "X", "Z").regex() - self.assertNotRegexpMatches("c", self.exp) - self.assertNotRegexpMatches("W", self.exp) - - def test_should_match_start_of_line(self): - self.exp = self.v.start_of_line().regex() - six.assertRegex(self, "text ", self.exp, "Not started :(") - - def test_should_match_end_of_line(self): - self.exp = self.v.start_of_line().end_of_line().regex() - six.assertRegex(self, "", self.exp, "It's not the end!") - - def test_should_match_anything(self): - self.exp = self.v.start_of_line().anything().end_of_line().regex() - six.assertRegex( - self, "!@#$%¨&*()__+{}", self.exp, "Not so anything..." - ) - - def test_should_match_anything_but_specified_element_when_element_is_not_found( - self - ): - self.exp = ( - self.v.start_of_line().anything_but("X").end_of_line().regex() - ) - six.assertRegex(self, "Y Files", self.exp, "Found the X!") - - def test_should_not_match_anything_but_specified_element_when_specified_element_is_found( - self - ): - self.exp = ( - self.v.start_of_line().anything_but("X").end_of_line().regex() - ) - self.assertNotRegexpMatches("VerEX", self.exp, "Didn't found the X :(") - - def test_should_find_element(self): - self.exp = self.v.start_of_line().find("Wally").end_of_line().regex() - six.assertRegex(self, "Wally", self.exp, "404! Wally not Found!") - - def test_should_not_find_missing_element(self): - self.exp = self.v.start_of_line().find("Wally").end_of_line().regex() - self.assertNotRegexpMatches("Wall-e", self.exp, "DAFUQ is Wall-e?") - - def test_should_match_when_maybe_element_is_present(self): - self.exp = ( - self.v.start_of_line() - .find("Python2.") - .maybe("7") - .end_of_line() - .regex() - ) - six.assertRegex(self, "Python2.7", self.exp, "Version doesn't match!") - - def test_should_match_when_maybe_element_is_missing(self): - self.exp = ( - self.v.start_of_line() - .find("Python2.") - .maybe("7") - .end_of_line() - .regex() - ) - six.assertRegex(self, "Python2.", self.exp, "Version doesn't match!") - - def test_should_match_on_any_when_element_is_found(self): - self.exp = ( - self.v.start_of_line().any("Q").anything().end_of_line().regex() - ) - six.assertRegex(self, "Query", self.exp, "No match found!") - - def test_should_not_match_on_any_when_element_is_not_found(self): - self.exp = ( - self.v.start_of_line().any("Q").anything().end_of_line().regex() - ) - self.assertNotRegexpMatches("W", self.exp, "I've found it!") - - def test_should_match_when_line_break_present(self): - self.exp = ( - self.v.start_of_line() - .anything() - .line_break() - .anything() - .end_of_line() - .regex() - ) - six.assertRegex(self, "Marco \n Polo", self.exp, "Give me a break!!") - - def test_should_match_when_line_break_and_carriage_return_present(self): - self.exp = ( - self.v.start_of_line() - .anything() - .line_break() - .anything() - .end_of_line() - .regex() - ) - six.assertRegex(self, "Marco \r\n Polo", self.exp, "Give me a break!!") - - def test_should_not_match_when_line_break_is_missing(self): - self.exp = ( - self.v.start_of_line() - .anything() - .line_break() - .anything() - .end_of_line() - .regex() - ) - self.assertNotRegexpMatches( - "Marco Polo", self.exp, "There's a break here!" - ) - - def test_should_match_when_tab_present(self): - self.exp = ( - self.v.start_of_line().anything().tab().end_of_line().regex() - ) - six.assertRegex(self, "One tab only ", self.exp, "No tab here!") - - def test_should_not_match_when_tab_is_missing(self): - self.exp = ( - self.v.start_of_line().anything().tab().end_of_line().regex() - ) - self.assertFalse( - re.match(self.exp, "No tab here"), "There's a tab here!" - ) - - def test_should_match_when_word_present(self): - self.exp = ( - self.v.start_of_line().anything().word().end_of_line().regex() - ) - six.assertRegex(self, "Oneword", self.exp, "Not just a word!") - - def test_not_match_when_two_words_are_present_instead_of_one(self): - self.exp = ( - self.v.start_of_line().anything().tab().end_of_line().regex() - ) - self.assertFalse( - re.match(self.exp, "Two words"), "I've found two of them" - ) - - def test_should_match_when_or_condition_fulfilled(self): - self.exp = ( - self.v.start_of_line() - .anything() - .find("G") - .OR() - .find("h") - .end_of_line() - .regex() - ) - six.assertRegex(self, "Github", self.exp, "Octocat not found") - - def test_should_not_match_when_or_condition_not_fulfilled(self): - self.exp = ( - self.v.start_of_line() - .anything() - .find("G") - .OR() - .find("h") - .end_of_line() - .regex() - ) - self.assertFalse(re.match(self.exp, "Bitbucket"), "Bucket not found") - - def test_should_match_on_upper_case_when_lower_case_is_given_and_any_case_is_true( - self - ): - self.exp = ( - self.v.start_of_line() - .find("THOR") - .end_of_line() - .with_any_case(True) - .regex() - ) - six.assertRegex(self, "thor", self.exp, "Upper case Thor, please!") - - def test_should_match_multiple_lines(self): - self.exp = ( - self.v.start_of_line() - .anything() - .find("Pong") - .anything() - .end_of_line() - .search_one_line(True) - .regex() - ) - six.assertRegex( - self, "Ping \n Pong \n Ping", self.exp, "Pong didn't answer" - ) - - def test_should_match_email_address(self): - self.exp = ( - self.v.start_of_line() - .word() - .then("@") - .word() - .then(".") - .word() - .end_of_line() - .regex() - ) - six.assertRegex(self, "mail@mail.com", self.exp, "Not a valid email") - - def test_should_match_url(self): - self.exp = ( - self.v.start_of_line() - .then("http") - .maybe("s") - .then("://") - .maybe("www.") - .word() - .then(".") - .word() - .maybe("/") - .end_of_line() - .regex() - ) - six.assertRegex( - self, "https://www.google.com/", self.exp, "Not a valid email" - ) diff --git a/verbalexpressions/__init__.py b/verbalexpressions/__init__.py index 233a1e0..4a47efb 100644 --- a/verbalexpressions/__init__.py +++ b/verbalexpressions/__init__.py @@ -1 +1,4 @@ -from .verbal_expressions import VerbEx, re_escape +from .verbal_expressions import CharClass as CharClass +from .verbal_expressions import SpecialChar as SpecialChar +from .verbal_expressions import Verbex as Verbex +from .verbal_expressions import re_escape as re_escape diff --git a/verbalexpressions/py.typed b/verbalexpressions/py.typed new file mode 100644 index 0000000..e69de29 diff --git a/verbalexpressions/verbal_expressions.py b/verbalexpressions/verbal_expressions.py index eb65d10..a39f9d6 100644 --- a/verbalexpressions/verbal_expressions.py +++ b/verbalexpressions/verbal_expressions.py @@ -1,89 +1,117 @@ +"""Generate regular expressions from an easier fluent verbal form.""" from __future__ import annotations import re from enum import Enum from functools import wraps -from typing import Protocol +from typing import Pattern, Protocol, TypeAlias, TypeVar + +from beartype import beartype # type: ignore +from beartype.typing import ( # type: ignore + Any, + Callable, + Dict, + Iterator, + List, + Optional, + ParamSpec, + Tuple, + Union, + cast, + runtime_checkable, +) +from beartype.vale import Is # type: ignore try: - from beartype import beartype # type: ignore - from beartype.typing import ( # type: ignore - Any, - Callable, - Dict, - Iterator, - List, - Optional, - ParamSpec, - Tuple, - TypeVar, - Union, - cast, - runtime_checkable, - ) + from typing import Annotated # <--------------- if Python ≥ 3.9.0 except ModuleNotFoundError: - from typing import ( - Any, - Callable, - Dict, - Iterator, - List, - Optional, - ParamSpec, - Tuple, - TypeVar, - Union, - cast, - runtime_checkable, - ) + from typing_extensions import Annotated # type: ignore # <--- if Python < 3.9.0 + - __P = ParamSpec("__P") - __R = TypeVar("__R") +def _string_len_is_1(text: object) -> bool: + return isinstance(text, str) and len(text) == 1 - def noop_dec(func: Callable[__P, __R]) -> Callable[__P, __R]: - return func - beartype = noop_dec # type: ignore +Char = Annotated[str, Is[_string_len_is_1]] -P = ParamSpec("P") -R = TypeVar("R") +P = ParamSpec("P") # noqa VNE001 +R = TypeVar("R") # noqa VNE001 # work around for bug https://github.com/python/mypy/issues/12660 +# fixed in next version of mypy @runtime_checkable class HasIter(Protocol): + """Workaround for mypy P.args.""" + def __iter__(self) -> Iterator[Any]: + """Object can be iterated. + + Yields: + Next object. + """ ... # work around for bug https://github.com/python/mypy/issues/12660 +# fixed in next version of mypy @runtime_checkable class HasItems(Protocol): + """Workaround for mypy P.kwargs.""" + def items(self) -> Tuple[str, Any]: + """Object has items method. + + Returns: + The dict of items. + """ ... class EscapedText(str): - def __new__(cls, value: str): + """Text that has been escaped for regex. + + Arguments: + str -- Extend the string class. + """ + + def __new__(cls, value: str) -> EscapedText: + """Return a escaped regex string. + + Arguments: + value -- the string to escape + + Returns: + _description_ + """ return str.__new__(cls, re.escape(value)) def re_escape(func: Callable[P, R]) -> Callable[P, R]: + """Automatically escape any string parameters as EscapedText. + + Arguments: + func -- The function to decorate. + + Returns: + The decorated function. + """ + @wraps(func) - def inner(*args: P.args, **kwargs: P.kwargs) -> R: + def inner(*args: P.args, **kwargs: P.kwargs) -> R: # type: ignore escaped_args: List[Any] = [] escaped_kwargs: Dict[str, Any] = {} for arg in cast(HasIter, args): - if isinstance(arg, str): - escaped_args.append(EscapedText(re.escape(arg))) + if not isinstance(arg, EscapedText) and isinstance(arg, str): + escaped_args.append(EscapedText(arg)) else: escaped_args.append(arg) arg_k: str arg_v: Any for arg_k, arg_v in cast(HasItems, kwargs).items(): - if isinstance(arg_v, str): - escaped_kwargs[arg_k] = EscapedText(re.escape(str(arg_v))) + if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str): + escaped_kwargs[arg_k] = EscapedText(str(arg_v)) else: escaped_kwargs[arg_k] = arg_v return func(*escaped_args, **escaped_kwargs) # type: ignore @@ -92,6 +120,12 @@ def inner(*args: P.args, **kwargs: P.kwargs) -> R: class CharClass(Enum): + """Enum of character classes in regex. + + Arguments: + Enum -- Extends the Enum class. + """ + DIGIT = "\\d" LETTER = "\\w" UPPERCASE_LETTER = "\\u" @@ -99,48 +133,78 @@ class CharClass(Enum): WHITESPACE = "\\s" TAB = "\\t" - def __str__(self): + def __str__(self) -> str: + """To string method based on Enum value. + + Returns: + value of Enum + """ return self.value class SpecialChar(Enum): + """Enum of special charaters, shorthand. + + Arguments: + Enum -- Extends the Enum class. + """ + # does not work / should not be used in [ ] LINEBREAK = "(\\n|(\\r\\n))" START_OF_LINE = "^" END_OF_LINE = "$" + TAB = "\t" - def __str__(self): + def __str__(self) -> str: + """To string for special chars enum. + + Returns: + Return value of enum as string. + """ return self.value -CharClassOrChars = Union[str, CharClass] -EscapedCharClassOrSpecial = Union[str, CharClass, SpecialChar] -VerbexEscapedCharClassOrSpecial = Union["Verbex", EscapedCharClassOrSpecial] +CharClassOrChars: TypeAlias = Union[str, CharClass] +EscapedCharClassOrSpecial: TypeAlias = Union[str, CharClass, SpecialChar] +VerbexEscapedCharClassOrSpecial: TypeAlias = Union["Verbex", EscapedCharClassOrSpecial] class Verbex: """ VerbalExpressions class. + the following methods do not try to match the original js lib! """ + EMPTY_REGEX_FLAG = re.RegexFlag(0) + @re_escape @beartype - def __init__(self, modifiers: re.RegexFlag = re.RegexFlag(0)): + def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG): + """Create a Verbex object; setting any needed flags. + + Keyword Arguments: + modifiers -- Regex modifying flags (default: {re.RegexFlag(0)}) + """ # self._parts: List[str] = [text] self._parts: List[str] = [] self._modifiers = modifiers @property def modifiers(self) -> re.RegexFlag: + """Return the modifiers for this Verbex object. + + Returns: + The modifiers applied to this object. + """ return self._modifiers - def __str__(self): + def __str__(self) -> str: """Return regex string representation.""" return "".join(self._parts) @beartype - def __add(self, value: Union[str, List[str]]): + def _add(self, value: Union[str, List[str]]) -> Verbex: """ Append a transformed value to internal expression to be compiled. @@ -152,8 +216,8 @@ def __add(self, value: Union[str, List[str]]): self._parts.append(value) return self - def regex(self): - """get a regular expression object.""" + def regex(self) -> Pattern[str]: + """Get a regular expression object.""" return re.compile( str(self), self._modifiers, @@ -168,7 +232,7 @@ def _capture_group_with_name( name: str, text: VerbexEscapedCharClassOrSpecial, ) -> Verbex: - return self.__add(f"(?<{name}>{str(text)})") + return self._add(f"(?<{name}>{str(text)})") @re_escape @beartype @@ -176,18 +240,30 @@ def _capture_group_without_name( self, text: VerbexEscapedCharClassOrSpecial, ) -> Verbex: - return self.__add(f"({str(text)})") + return self._add(f"({str(text)})") @re_escape @beartype def capture_group( self, /, - name_or_text: Union[ - Optional[str], VerbexEscapedCharClassOrSpecial - ] = None, + name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None, text: Optional[VerbexEscapedCharClassOrSpecial] = None, ) -> Verbex: + """Create a capture group. + + Name is optional if not specified then the first argument is the text. + + Keyword Arguments: + name_or_text -- The name of the group / text to search for (default: {None}) + text -- The text to search for (default: {None}) + + Raises: + ValueError: If name is specified then text must be as well. + + Returns: + Verbex with added capture group. + """ if name_or_text is not None: if text is None: _text = name_or_text @@ -198,96 +274,284 @@ def capture_group( @re_escape @beartype - def OR(self, text: VerbexEscapedCharClassOrSpecial): # noqa N802 - """`or` is a python keyword so we use `OR` instead.""" - self.__add("|") - self.find(text) + def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: # noqa N802 + """`or` is a python keyword so we use `OR` instead. + + Arguments: + text -- Text to find or a Verbex object. + + Returns: + Modified Verbex object. + """ + return self._add("|").find(text) @re_escape @beartype def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: - return self.__add(f"(?:{str(text)})*") + """Find the text or Verbex object zero or more times. + + Arguments: + text -- The text / Verbex object to look for. + + Returns: + Modified Verbex object. + """ + return self._add(f"(?:{str(text)})*") @re_escape @beartype def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: - return self.__add(f"(?:{str(text)})+") + """Find the text or Verbex object one or more times. + + Arguments: + text -- The text / Verbex object to look for. + + Returns: + Modified Verbex object. + """ + return self._add(f"(?:{str(text)})+") @re_escape @beartype - def n_times(self, text: VerbexEscapedCharClassOrSpecial, n: int) -> Verbex: - return self.__add(f"(?:{str(text)}){{{n}}}") + def n_times( + self, + text: VerbexEscapedCharClassOrSpecial, + n: int, # noqa: VNE001 + ) -> Verbex: + """Find the text or Verbex object n or more times. + + Arguments: + text -- The text / Verbex object to look for. + + Returns: + Modified Verbex object. + """ + return self._add(f"(?:{str(text)}){{{n}}}") @re_escape @beartype def n_times_or_more( - self, text: VerbexEscapedCharClassOrSpecial, n: int + self, + text: VerbexEscapedCharClassOrSpecial, + n: int, # noqa: VNE001 ) -> Verbex: - return self.__add(f"(?:{str(text)}){{{n},}}") + """Find the text or Verbex object at least n times. + + Arguments: + text -- The text / Verbex object to look for. + + Returns: + Modified Verbex object. + """ + return self._add(f"(?:{str(text)}){{{n},}}") @re_escape @beartype def n_to_m_times( - self, text: VerbexEscapedCharClassOrSpecial, n: int, m: int + self, + text: VerbexEscapedCharClassOrSpecial, + n: int, # noqa: VNE001 + m: int, # noqa: VNE001 ) -> Verbex: - return self.__add(f"(?:{str(text)}){{{n},{m}}}") + """Find the text or Verbex object between n and m times. - @re_escape - def anything_but(self, text: EscapedCharClassOrSpecial): - return self.__add(f"[^{text}]*") + Arguments: + text -- The text / Verbex object to look for. + + Returns: + Modified Verbex object. + """ + return self._add(f"(?:{str(text)}){{{n},{m}}}") @re_escape @beartype def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: - # if isinstance(text, Verbex): - # return self.__add(f"(?:{str(text)})?") - return self.__add(f"(?:{str(text)})?") + """Possibly find the text / Verbex object. + + Arguments: + text -- The text / Verbex object to possibly find. + + Returns: + Modified Verbex object. + """ + return self._add(f"(?:{str(text)})?") @re_escape @beartype def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: - return self.__add(str(text)) + """Find the text or Verbex object. + + Arguments: + text -- The text / Verbex object to look for. + + Returns: + Modified Verbex object. + """ + return self._add(str(text)) + + @re_escape + @beartype + def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + """Synonym for find. + + Arguments: + text -- The text / Verbex object to look for. + + Returns: + Modified Verbex object. + """ + return self.find(text) # only allow CharclassOrChars @re_escape @beartype - def any_of(self, text: CharClassOrChars) -> Verbex: - return self.__add(f"(?:[{text}])") + def any_of(self, chargroup: CharClassOrChars) -> Verbex: + """Find anything in this group of chars or char class. + + Arguments: + text -- The characters to look for. + + Returns: + Modified Verbex object. + """ + return self._add(f"(?:[{chargroup}])") @re_escape @beartype def not_any_of(self, text: CharClassOrChars) -> Verbex: - return self.__add(f"(?:[^{text}])") + """Find anything but this group of chars or char class. + + Arguments: + text -- The characters to not look for. + + Returns: + Modified Verbex object. + """ + return self._add(f"(?:[^{text}])") + + @re_escape + def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex: + """Find anything one or more times but this group of chars or char class. + + Arguments: + text -- The characters to not look for. + + Returns: + Modified Verbex object. + """ + return self._add(f"[^{chargroup}]+") # no text input + def start_of_line(self) -> Verbex: + """Find the start of the line. + + Returns: + Modified Verbex object. + """ + return self.find(SpecialChar.START_OF_LINE) + + def end_of_line(self) -> Verbex: + """Find the end of the line. + + Returns: + Modified Verbex object. + """ + return self.find(SpecialChar.END_OF_LINE) + + def line_break(self) -> Verbex: + """Find a line break. + + Returns: + Modified Verbex object. + """ + return self.find(SpecialChar.LINEBREAK) + + def tab(self) -> Verbex: + """Find a tab. + + Returns: + Modified Verbex object. + """ + return self.find(SpecialChar.TAB) + def anything(self) -> Verbex: - return self.__add(".*") + """Find anything one or more time. - def asfew(self) -> Verbex: - return self.__add("?") + Returns: + Modified Verbex object. + """ + return self._add(".+") + + def as_few(self) -> Verbex: + """Modify previous search to not be greedy. + + Returns: + Modified Verbex object. + """ + return self._add("?") @beartype - def range(self, start: int, end: int) -> Verbex: - return self.__add( - "(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")" - ) + def number_range(self, start: int, end: int) -> Verbex: + """Generate a range of numbers. + + Arguments: + start -- Start of the range + end -- End of the range + + Returns: + Modified Verbex object. + """ + return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")") + + @beartype + def letter_range(self, start: Char, end: Char) -> Verbex: + """Generate a range of letters. + + Arguments: + start -- Start of the range + end -- End of the range + + Returns: + Modified Verbex object. + """ + return self._add(f"[{start}-{end}]") def word(self) -> Verbex: - return self.__add("(\\b\\w+\\b)") + """Find a word on word boundary. + + Returns: + Modified Verbex object. + """ + return self._add("(\\b\\w+\\b)") # # --------------- modifiers ------------------------ def with_any_case(self) -> Verbex: + """Modify Verbex object to be case insensitive. + + Returns: + Modified Verbex object. + """ self._modifiers |= re.IGNORECASE return self def search_by_line(self) -> Verbex: + """Search each line, ^ and $ match begining and end of line respectively. + + Returns: + Modified Verbex object. + """ self._modifiers |= re.MULTILINE return self def with_ascii(self) -> Verbex: + """Match ascii instead of unicode. + + Returns: + Modified Verbex object. + """ self._modifiers |= re.ASCII return self @@ -298,26 +562,9 @@ def with_ascii(self) -> Verbex: # regex = self.regex() # return getattr(regex, attr) -# def range(self, start: int, end: int) -> Verbex: -# # this was the original? method -# from_tos = [args[i : i + 2] for i in range(0, len(args), 2)] -# return self.__add("([%s])" % "".join(["-".join(i) for i in from_tos])) - # def replace(self, string, repl): # return self.sub(repl, string) -t = ( - # Verbex().maybe(Verbex().find("tet")) - Verbex().capture_group( - "test", - Verbex().find("what to find"), - ) - # Verbex() - # .with_any_case() - # .maybe("test") - # .find(RegexEnum.DIGIT) - # .any("test") - # .range(10, 20) -) -print(t) +if __name__ == "__main__": + pass From cb7ef0c03d30f111054aa15b7fff100e0c6fa0d6 Mon Sep 17 00:00:00 2001 From: Richard Date: Sun, 1 May 2022 22:23:34 -0400 Subject: [PATCH 04/85] added look arounds --- tests/test_verbal_expressions.py | 20 +++++++++++ verbalexpressions/verbal_expressions.py | 48 +++++++++++++++++++++++++ 2 files changed, 68 insertions(+) diff --git a/tests/test_verbal_expressions.py b/tests/test_verbal_expressions.py index f9164e8..a050a44 100644 --- a/tests/test_verbal_expressions.py +++ b/tests/test_verbal_expressions.py @@ -280,6 +280,26 @@ def test_should_match_url(self): self.assertRegex("https://www.google.com/", regex) self.assertNotRegex("htps://www.google.com/", regex) + def test_followed_by(self): + regex = Verbex().find("!").followed_by(":").regex() + self.assertRegex("!:", regex) + self.assertNotRegex("! :", regex) + + def test_not_followed_by(self): + regex = Verbex().find("!").not_followed_by(":").regex() + self.assertNotRegex("!:", regex) + self.assertRegex("! :", regex) + + def test_preceded_by(self): + regex = Verbex().preceded_by("!").find(":").regex() + self.assertRegex("!:", regex) + self.assertNotRegex("! :", regex) + + def test_not_preceded_by(self): + regex = Verbex().not_preceded_by("!").find(":").regex() + self.assertNotRegex("!:", regex) + self.assertRegex("! :", regex) + if __name__ == "__main__": unittest.main() diff --git a/verbalexpressions/verbal_expressions.py b/verbalexpressions/verbal_expressions.py index a39f9d6..dc8382e 100644 --- a/verbalexpressions/verbal_expressions.py +++ b/verbalexpressions/verbal_expressions.py @@ -402,6 +402,54 @@ def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: """ return self.find(text) + @re_escape + @beartype + def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + """Match if string is followed by text. + + Positive lookahead + + Returns: + Modified Verbex object. + """ + return self._add(f"(?={text})") + + @re_escape + @beartype + def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + """Match if string is not followed by text. + + Negative lookahead + + Returns: + Modified Verbex object. + """ + return self._add(f"(?!{text})") + + @re_escape + @beartype + def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + """Match if string is not preceded by text. + + Positive lookbehind + + Returns: + Modified Verbex object. + """ + return self._add(f"(?<={text})") + + @re_escape + @beartype + def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: + """Match if string is not preceded by text. + + Negative Lookbehind + + Returns: + Modified Verbex object. + """ + return self._add(f"(? Date: Sun, 1 May 2022 22:29:30 -0400 Subject: [PATCH 05/85] update readme --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 90fe3d5..12fb7f4 100644 --- a/README.md +++ b/README.md @@ -10,15 +10,15 @@ pip install VerbalExpressions ``` ## Usage ```python -from verbalexpressions import VerEx -verbal_expression = VerEx() +from verbalexpressions import Verbex +verbal_expression = Verbex() ``` ## Examples ### Testing if we have a valid URL ```python # Create an example of how to test for correctly formed URLs -verbal_expression = VerEx() +verbal_expression = Verbex() tester = (verbal_expression. start_of_line(). find('http'). @@ -45,11 +45,11 @@ print tester.source() # => ^(http)(s)?(\:\/\/)(www\.)?([^\ ]*)$ replace_me = "Replace bird with a duck" # Create an expression that looks for the word "bird" -expression = VerEx().find('bird') +expression = Verbex().find('bird') -# Execute the expression in VerEx -result_VerEx = expression.replace(replace_me, 'duck') -print result_VerEx +# Execute the expression in Verbex +result_Verbex = expression.replace(replace_me, 'duck') +print result_Verbex # Or we can compile and use the regular expression using re import re @@ -59,7 +59,7 @@ print result_re ``` ### Shorthand for string replace ```python -result = VerEx().find('red').replace('We have a red house', 'blue') +result = Verbex().find('red').replace('We have a red house', 'blue') print result ``` From 963c7b13c619ed440b8583a35525ce4951eb56ef Mon Sep 17 00:00:00 2001 From: rbroderi Date: Wed, 4 May 2022 20:38:25 -0400 Subject: [PATCH 06/85] Create main.yml --- .github/workflows/main.yml | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 .github/workflows/main.yml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..0a32f79 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,37 @@ +# This is a basic workflow to help you get started with Actions + +name: CI + +# Controls when the workflow will run +on: + # Triggers the workflow on push or pull request events but only for the master branch + push: + branches: [ master ] + pull_request: + branches: [ master ] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "build" + build: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v3 + + - name: Run .travis.yml build script + uses: ktomk/run-travis-yml@v1 + with: + file: .travis.yml + steps: | + install + script + allow-failure: false + env: + TRAVIS_PHP_VERSION: ${{ matrix.php-versions }} From 7234a88e625f50b44f299d2e3e6f084dacfe2e32 Mon Sep 17 00:00:00 2001 From: Richard Date: Wed, 4 May 2022 20:45:14 -0400 Subject: [PATCH 07/85] fix missing typealias for python 3.8: --- verbalexpressions/verbal_expressions.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/verbalexpressions/verbal_expressions.py b/verbalexpressions/verbal_expressions.py index dc8382e..00e10ef 100644 --- a/verbalexpressions/verbal_expressions.py +++ b/verbalexpressions/verbal_expressions.py @@ -4,7 +4,13 @@ import re from enum import Enum from functools import wraps -from typing import Pattern, Protocol, TypeAlias, TypeVar + +try: + from typing import TypeAlias +except ModuleNotFoundError: + from typing_extensions import TypeAlias + +from typing import Pattern, Protocol, TypeVar from beartype import beartype # type: ignore from beartype.typing import ( # type: ignore From fa247a0d37c304f01e939331ae30d1a047bb6e0e Mon Sep 17 00:00:00 2001 From: Richard Date: Wed, 4 May 2022 20:51:07 -0400 Subject: [PATCH 08/85] condense python version dependent imports --- verbalexpressions/verbal_expressions.py | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/verbalexpressions/verbal_expressions.py b/verbalexpressions/verbal_expressions.py index 00e10ef..ac48443 100644 --- a/verbalexpressions/verbal_expressions.py +++ b/verbalexpressions/verbal_expressions.py @@ -6,9 +6,9 @@ from functools import wraps try: - from typing import TypeAlias + from typing import Annotated, TypeAlias # <--------------- if Python ≥ 3.9.0 except ModuleNotFoundError: - from typing_extensions import TypeAlias + from typing_extensions import TypeAlias, Annotated # type: ignore # <--- if Python < 3.9.0 from typing import Pattern, Protocol, TypeVar @@ -28,11 +28,6 @@ ) from beartype.vale import Is # type: ignore -try: - from typing import Annotated # <--------------- if Python ≥ 3.9.0 -except ModuleNotFoundError: - from typing_extensions import Annotated # type: ignore # <--- if Python < 3.9.0 - def _string_len_is_1(text: object) -> bool: return isinstance(text, str) and len(text) == 1 From c74049aae4ca41f3f035846bdf3b01ca3ff1caea Mon Sep 17 00:00:00 2001 From: Richard Date: Wed, 4 May 2022 20:52:52 -0400 Subject: [PATCH 09/85] condense python version dependent imports --- verbalexpressions/verbal_expressions.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/verbalexpressions/verbal_expressions.py b/verbalexpressions/verbal_expressions.py index ac48443..366d669 100644 --- a/verbalexpressions/verbal_expressions.py +++ b/verbalexpressions/verbal_expressions.py @@ -7,7 +7,7 @@ try: from typing import Annotated, TypeAlias # <--------------- if Python ≥ 3.9.0 -except ModuleNotFoundError: +except (ModuleNotFoundError, ImportError): from typing_extensions import TypeAlias, Annotated # type: ignore # <--- if Python < 3.9.0 from typing import Pattern, Protocol, TypeVar From c63967025ebc339c7b8a91c69af4707f776418aa Mon Sep 17 00:00:00 2001 From: rbroderi Date: Wed, 4 May 2022 20:58:56 -0400 Subject: [PATCH 10/85] Update main.yml --- .github/workflows/main.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 0a32f79..a3ecc00 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -24,7 +24,8 @@ jobs: steps: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - uses: actions/checkout@v3 - + - name: Install xmllint + run: pip install typing-extensions - name: Run .travis.yml build script uses: ktomk/run-travis-yml@v1 with: From 1f461e52cfe050ea28c5ca3f7e54b866fe199fa8 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Wed, 4 May 2022 21:05:50 -0400 Subject: [PATCH 11/85] Update main.yml --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index a3ecc00..0383dc3 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -25,7 +25,7 @@ jobs: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - uses: actions/checkout@v3 - name: Install xmllint - run: pip install typing-extensions + run: pip install typing-extensions beartype - name: Run .travis.yml build script uses: ktomk/run-travis-yml@v1 with: From d38fe3c6f870df8487f32b7647855bfecc878ad9 Mon Sep 17 00:00:00 2001 From: Richard Date: Wed, 4 May 2022 21:08:38 -0400 Subject: [PATCH 12/85] condense python version dependent imports --- verbalexpressions/verbal_expressions.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/verbalexpressions/verbal_expressions.py b/verbalexpressions/verbal_expressions.py index 366d669..1287218 100644 --- a/verbalexpressions/verbal_expressions.py +++ b/verbalexpressions/verbal_expressions.py @@ -6,9 +6,13 @@ from functools import wraps try: - from typing import Annotated, TypeAlias # <--------------- if Python ≥ 3.9.0 + from typing import ( # <--------------- if Python ≥ 3.9.0 + Annotated, + ParamSpec, + TypeAlias, + ) except (ModuleNotFoundError, ImportError): - from typing_extensions import TypeAlias, Annotated # type: ignore # <--- if Python < 3.9.0 + from typing_extensions import TypeAlias, Annotated, ParamSpec # type: ignore # <--- if Python < 3.9.0 from typing import Pattern, Protocol, TypeVar @@ -20,7 +24,6 @@ Iterator, List, Optional, - ParamSpec, Tuple, Union, cast, From 6f8f1c5ffac19a54a7038031a517c1a59c4c825a Mon Sep 17 00:00:00 2001 From: Richard Date: Wed, 4 May 2022 21:25:17 -0400 Subject: [PATCH 13/85] adding github actions badge --- README.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/README.md b/README.md index 12fb7f4..3d88b26 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ PythonVerbalExpressions ======================= -[![Build Status](https://travis-ci.org/VerbalExpressions/PythonVerbalExpressions.svg?branch=master)](https://travis-ci.org/VerbalExpressions/PythonVerbalExpressions) +![Build Status](https://github.com/rbroderi/PythonVerbalExpressions/actions/workflows/main.yml/badge.svg?event=push) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) ## Installation @@ -57,11 +57,6 @@ regexp = expression.compile() result_re = regexp.sub('duck', replace_me) print result_re ``` -### Shorthand for string replace -```python -result = Verbex().find('red').replace('We have a red house', 'blue') -print result -``` ## Developer setup : running the tests ```bash From 9f4a8e431d32661638d0ea9648fe37adfa43c627 Mon Sep 17 00:00:00 2001 From: Richard Date: Wed, 4 May 2022 21:27:11 -0400 Subject: [PATCH 14/85] updated readme --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 3d88b26..74f3e16 100644 --- a/README.md +++ b/README.md @@ -47,11 +47,7 @@ replace_me = "Replace bird with a duck" # Create an expression that looks for the word "bird" expression = Verbex().find('bird') -# Execute the expression in Verbex -result_Verbex = expression.replace(replace_me, 'duck') -print result_Verbex - -# Or we can compile and use the regular expression using re +# Compile and use the regular expression using re import re regexp = expression.compile() result_re = regexp.sub('duck', replace_me) From 09a59fc436457fbab1099806c0533aac0d477401 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sat, 7 May 2022 20:25:24 -0400 Subject: [PATCH 15/85] Create GPL_LICENSE.txt --- GPL_LICENSE.txt | 674 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 674 insertions(+) create mode 100644 GPL_LICENSE.txt diff --git a/GPL_LICENSE.txt b/GPL_LICENSE.txt new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/GPL_LICENSE.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. From 8c8e673e89ce7950c5c1966465014e8d58d21aa1 Mon Sep 17 00:00:00 2001 From: Richard Date: Sat, 7 May 2022 20:47:10 -0400 Subject: [PATCH 16/85] change name and structure as fork --- GPL_LICENSE.txt => GPLv3_LICENSE.txt | 0 MANIFEST.IN | 3 +++ setup.py | 11 ++++++----- {verbalexpressions => verbex}/__init__.py | 0 {verbalexpressions => verbex}/py.typed | 0 .../verbal_expressions.py => verbex/verbex.py | 0 6 files changed, 9 insertions(+), 5 deletions(-) rename GPL_LICENSE.txt => GPLv3_LICENSE.txt (100%) create mode 100644 MANIFEST.IN rename {verbalexpressions => verbex}/__init__.py (100%) rename {verbalexpressions => verbex}/py.typed (100%) rename verbalexpressions/verbal_expressions.py => verbex/verbex.py (100%) diff --git a/GPL_LICENSE.txt b/GPLv3_LICENSE.txt similarity index 100% rename from GPL_LICENSE.txt rename to GPLv3_LICENSE.txt diff --git a/MANIFEST.IN b/MANIFEST.IN new file mode 100644 index 0000000..148cc7d --- /dev/null +++ b/MANIFEST.IN @@ -0,0 +1,3 @@ +include verbex/py.typed +include LICENSE.TXT +include GPLv3_LICESNSE.TXT \ No newline at end of file diff --git a/setup.py b/setup.py index 021a3c6..5ccd4b4 100755 --- a/setup.py +++ b/setup.py @@ -1,25 +1,25 @@ from setuptools import setup setup( - name="VerbalExpressions", + name="Verbex", version="1.0.0", description=( - "Make difficult regular expressions easy! Python port of the awesome" + "Make difficult regular expressions easy! Python fork based on of the awesome" " VerbalExpressions repo - https://github.com/jehna/VerbalExpressions" ), long_description=( "Please see" - " https://github.com/VerbalExpressions/PythonVerbalExpressions/blob/master/README.md" + " https://github.com/rbroderi/Verbex/blob/master/README.md" " for more information!" ), author=( "Victor Titor, Yan Wenjun, diogobeda, Mihai Ionut Vilcu, Peder Soholt, Sameer" " Raghuram, Kharms, Richard Broderick" ), - license="MIT", + license="GPLv3", url="https://github.com/VerbalExpressions/PythonVerbalExpressions", test_suite="tests", - packages=["verbalexpressions"], + packages=["verbex"], classifiers=[ "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Programming Language :: Python", @@ -29,4 +29,5 @@ "Topic :: Software Development :: Libraries", "Topic :: Text Processing", ], + include_package_data=True, ) diff --git a/verbalexpressions/__init__.py b/verbex/__init__.py similarity index 100% rename from verbalexpressions/__init__.py rename to verbex/__init__.py diff --git a/verbalexpressions/py.typed b/verbex/py.typed similarity index 100% rename from verbalexpressions/py.typed rename to verbex/py.typed diff --git a/verbalexpressions/verbal_expressions.py b/verbex/verbex.py similarity index 100% rename from verbalexpressions/verbal_expressions.py rename to verbex/verbex.py From 628509b12a779bee810460bdc6d860764d8a4acd Mon Sep 17 00:00:00 2001 From: Richard Date: Sat, 7 May 2022 20:49:28 -0400 Subject: [PATCH 17/85] update name in init.py --- verbex/__init__.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/verbex/__init__.py b/verbex/__init__.py index 4a47efb..fa3bafc 100644 --- a/verbex/__init__.py +++ b/verbex/__init__.py @@ -1,4 +1,3 @@ -from .verbal_expressions import CharClass as CharClass -from .verbal_expressions import SpecialChar as SpecialChar -from .verbal_expressions import Verbex as Verbex -from .verbal_expressions import re_escape as re_escape +from .verbex import CharClass as CharClass +from .verbex import SpecialChar as SpecialChar +from .verbex import Verbex as Verbex From eb3ce5398bf7d2b5fe200e8907cb4071552001ce Mon Sep 17 00:00:00 2001 From: Richard Date: Sat, 7 May 2022 20:51:20 -0400 Subject: [PATCH 18/85] update name in init.py --- tests/{test_verbal_expressions.py => test_verbex.py} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename tests/{test_verbal_expressions.py => test_verbex.py} (99%) diff --git a/tests/test_verbal_expressions.py b/tests/test_verbex.py similarity index 99% rename from tests/test_verbal_expressions.py rename to tests/test_verbex.py index a050a44..9b7f81c 100644 --- a/tests/test_verbal_expressions.py +++ b/tests/test_verbex.py @@ -4,7 +4,7 @@ import re import unittest -from verbalexpressions import CharClass, SpecialChar, Verbex +from verbex import CharClass, SpecialChar, Verbex class verbexTest(unittest.TestCase): From d48c248e8acf27b29467047bd2e035e42c5723ca Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sat, 7 May 2022 20:57:41 -0400 Subject: [PATCH 19/85] Update README.md --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 74f3e16..94abab5 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,25 @@ -PythonVerbalExpressions -======================= +Verbex: Python verbal based regular expressions +================================================ -![Build Status](https://github.com/rbroderi/PythonVerbalExpressions/actions/workflows/main.yml/badge.svg?event=push) +![Build Status](https://github.com/rbroderi/Verbex/actions/workflows/main.yml/badge.svg?event=push) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) ## Installation ```bash -pip install VerbalExpressions +pip install Verbex ``` ## Usage ```python -from verbalexpressions import Verbex -verbal_expression = Verbex() +from verbex import Verbex +verbex = Verbex() ``` ## Examples ### Testing if we have a valid URL ```python # Create an example of how to test for correctly formed URLs -verbal_expression = Verbex() -tester = (verbal_expression. +verbex = Verbex() +tester = (verbex. start_of_line(). find('http'). maybe('s'). @@ -33,11 +33,11 @@ tester = (verbal_expression. test_url = "https://www.google.com" # Test if the URL is valid -if tester.match(test_url): - print "Valid URL" +if re.match(test_url.regex,test_url): + print("Valid URL") # Print the generated regex -print tester.source() # => ^(http)(s)?(\:\/\/)(www\.)?([^\ ]*)$ +print(tester) # => ^(http)(s)?(\:\/\/)(www\.)?([^\ ]*)$ ``` ### Replacing strings ```python @@ -51,7 +51,7 @@ expression = Verbex().find('bird') import re regexp = expression.compile() result_re = regexp.sub('duck', replace_me) -print result_re +print(result_re) ``` ## Developer setup : running the tests From ada781c7c7f854d72cbcc9f315fed8d4c31098b8 Mon Sep 17 00:00:00 2001 From: Richard Date: Sat, 7 May 2022 21:11:37 -0400 Subject: [PATCH 20/85] update setup.py --- .gitignore | 4 ++++ dist/Verbex-1.0.0.win-amd64.zip | Bin 0 -> 12709 bytes setup.py | 12 +++++++----- 3 files changed, 11 insertions(+), 5 deletions(-) create mode 100644 dist/Verbex-1.0.0.win-amd64.zip diff --git a/.gitignore b/.gitignore index c18dd8d..a0dcaf0 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,5 @@ __pycache__/ +build/ +.mypy_cache/ +*.egg-info/ +.vscode/ \ No newline at end of file diff --git a/dist/Verbex-1.0.0.win-amd64.zip b/dist/Verbex-1.0.0.win-amd64.zip new file mode 100644 index 0000000000000000000000000000000000000000..0c3fa53a91fc9e507568fbaef876937471fe0957 GIT binary patch literal 12709 zcmbt*Wmud`)-CSt?gV#tZ`|G8T?4`039iB2gL@!2!QI`RKybTc&disYbLY#PduR7k z-Swktt*ZT&ytQk!f;1=?8qiNuDlS&}TjuXyFmJyK9xfL4b}USc3=02iIfQ>HCu3>! zo3eQSS6OFE7gIV1Lt|@0b5rNv)Fk~6HQh{|j7;5s1Hknk0Mz~lK*vPSNY6;;;K4%A z#7J*yZcb-uXJ-E!Scd-q`}cO~>pOTD8yZ`f>g)dx7!*)lK98%4`1 zxI{pKi6p`DP;go}xdZUY%MB`_6)R4)7%ka+fFzR~DSeu|K!R{7V>mkQkjXdq5is@K zSR1rLlDQM5LEw)IlyTE;`I8H4B+ToCh1^Nqx0;-pWZ9EIT4OxR+HeFUGgq2eA6d%Y8S|X>veMECMMsg!2t6r7tf0r%5BMvFIrm=_ZC{)Sv>MbwTD84!QU_OhF8KFBpVQ*H_E!d`_L}Ta-gDwMT&ovcqC-*L%Z0#^45x07(_dZ6<{+=PtdJ{+;p2^^_{~S0 zsLD{QWH{K-i8Qh22=2wu=U+rW0|^630d&>#tP4)ch_l0U5I0yS>tL{J!VjT2PT+$4 zW=z8*%_JPRyvG)@@QRfO&FQrn@d5{z`jGIuBm%GrO<0|IvP*0NYnnk&@c>Aj#1#cd zVuPE&T%ohfRuIVj&M#pcJlfE0Vm4bMEW~vPDcm*Nl@RNQeo7%|I?v?I%MK8MP13?r zlkC&1;n3qW-Q+vIk1$v66d&)32k7Q_C}h6L24CJNWy<90V0AyXB!LF(@uJ#=5X<|` zQ};^)9LfQ4@S@Ps(NeH3GJ=L?o;1rI=SUazG@L|9JOuM;q_?=2;HU=WX@nA& zL=8Wozodn4$@wZgl6lGA1I}J?b0h0C_O444SfhRA0Cs#CDA zX$8W{4By9;O4Yi0RKlD#enCd?sS!nr|&uBbPkOr*vz3C^F_lamIp};7}*F@&?+KEAzo5R zDvatlH`y(qlF_{3v>bwa{}lGgHtyb9mL23Wr!&ne4euwH0D~3WK z>;Y@y!I;Z^;Zu}3?a|OM>kJ!}q~M>rrFZ^JHsD#u*-B$gO7pD7#EHfWY#2bxe1fZ3llK>Y|5d zY2ttzmoTj%?baeFpDZH2y!##vi(oM|*|~xu#|c|5j5%(TGYFjKQMrZ^&r7jx@oahf z#onj-vGo!0bvC18o(Nt=g)hpnnuOnu|LXD^2}AM8tg*3eR*Nk5T8+S6(+buK}Dz|VB>;GJN=qgrmpIt7CoT4 zsb*=+y8t~fc0pX3>iP7*p8Ho}EGSm!q^q>Nl1L z*lKug`Sp^{Z2TYyCloFl9Nt-vba>0c#gUeTK*s-WZJC}wEG20D5nSGDO906|sor$!a z7G9&6nrnrQUw*X%2T{(=X04$-UmycWT(4%bNv*wXK|8O!DvS_x7)>FSBfM*!%d~cXU7>(lrEJEgG$@A6^07= zDB%(Vhfb?)tM8RV*+P}u!pfCmNByB8^Zkn%YR1+g&kV$wjnO;7j~vPf&xgw%`jEpu)n)h+?+Lk(X5)Q#jkL~qy zOFFjU0^Ta(J?0NcQut8b!H_ddnXs|~9HV;j9M?ls*@$Npn)n&sX)RRAKTuN7;E&UI zR>gsy+M*4LP|h}`171a>$B0+KlbiP~{|RFJ_1XD(%d9J~s!i*u`Kf zoa8!-egUrM&3YUfB#8)ps;8SXoK?PEzM_lDqX;sxLC745DevISXN2Dl{RYg=e_Rmz zbQ%2s#kO5?{)|E0xdT;pZ;z#pRw{e{$h&l+=n|wx$zQyCp!Z-gR=zm`C!Soo*%yc^} zO5BGb-7*kSyfAsmhu&H_p$_-|bO%ax*N3CzKw>WX(tNW2eo1P?nqMQ*I>%GT?a@;p z5oVn#fgwE<1>nPWN(LS?`QWC!9QY>rNl`wI@J*mU_84B%S z&Y=rY0fPtc*o^^Y<3c8bgWN;C%Gi^6(5FePgKuUd*TPNECP;1aD`5bUBxoj?jpqpx zEsea;ene)AKt9uG#Klu`x{O@$;p^BlO5B53?`~L&Y)^ul3p+7>6!#`Gla_Z^8*XRU+ z@*bPQ`;gk7cV%CJoNuMTqKal2;nYjgOvt)Vl7V4T`!^Y(38d>hDIOsqrNz1lIRQps zj(bWHBLUqnW4xUlw!Rl(L3;#88WvSoZ6$Oe`WH7ta{b7wa&kmOLt7kr>V{~O(a7!R zqVJ7@J4&r8v&j}~XpJ7FNk6tc9-yCxc@K*utZ89HG46fYq21~s@!1B5M{2?HuQumQ z38Ai=)!$&c5I?6QRS(?Vfo_JJ%X?rw`t(>?LeS)%R=xuNI-ubf6|2nUVyOwf9n1pW z68&F0py}&d+F82j>%Se*q-nm5t4`2J(@9BHDh!U$4Kh$GI*dusI*m!v(yK|(0vz01 zraqUz(@V&X$&3J(f|LTbjMNDsHi46bHQIIl>9F|os4v!I`09fJ1Vs7PAhEyNmS2b1 zzaJcp9sU*}pnD4uytUAHR$JErZ@_VFarvLq+wAY42EY4>#^kunT~N&*cC z6p5T(i2l|NqATuwTk#^FFef41ax8wI<0sD77}8Lu3aQisVmWd-yk$w%vdcs%g3H7u zDOCcc(g;FjFPQjx_q)|Pr+`7M?iC-w&6~iHA66SCOM%(#-G&~ zVH#}v*(bTR@yp<`MM$#C?W#{1-Dccyc&vN+9c)u-%Gr&gX54VwtUaUn8an#dmiUeJ zZ98l9>(9&i6?qKs{Ji2Y4jSLHikNG<#o`-0*qJJ>R$_%}#2{26Z!<0fntEPIZC=5H z&vJOy6%XXpG^7O=6&2ZK-U}_#Yu=D0Mop|L)Mnu8NMp%QZo3e!B9h_-rc)dMmvD8( zD<}tJVFw>y3R*2$CHHX()^=@5 zy{Ow30tGyuMD0~B7pFCM*Myu0cux?@>L=-bh8W%$g@ELm$Y&T}7ZN}^;W|n35 zW72Elg$yR9_VKyX?mhK3cO03IY0j3ZmNDyl)+pUPjTD4daIMVKtLeCBRgrqD&B~8) z98J*Pr^AnbQESX`!?j<~E9@V+WTsi~wKIToow{cG*s*(0RqPTdR7^G24iQ_BgjcNf zuEx^;9_%Tzr<4f}Ti%k2KvOyMQ*mP=oA8h6cfZg1q2(S+Dcb!!*j5veUX(AD5 z;b|`qt*(j`p<^kT>M#T>{NY`fd*_z!vKc;nzU^@|2?<0nRt!}cXdod-wiH#&K9N{F zQ7q=7@XU<8fsI1~kb=T=@S$Z54K7s`aGEEoL=BYnTDl43>G3qP(cEb2y{n>ov!1eV z>GhUM#Wv|rqO3;y3r~^~a+{w^PO!z4AypLTl&PO65wgFt0DH4FwRG~_ai|+zAi~gf zg1|79t*Zk)VYyYao0H!SCr1v>>vZ%B-fkU?!n)Y(NnBff$N0pAi+btN&gp9|D5~0uxF^z(Xn9 zeb|_Y3(*gDuUxN6tEzWYeyz4^>XIVXt)Qx+|DfMX3T6ynX<}rB*uY|jCmh2gyZz(4 z5Y|otD5)lrEigl;`c%QTi7_})b`EzYC4(62=kZ4;hXvSptXvfYh|;Yp22 zGsmKsera6zJbVnA>)XQ2Qa0`;M?pr9ZK0Z@m~}~?{O!TaQ zU%Oqp!K}%K>-CEvcw*n8WX(xc#<5LF)yJDBa(rx3GCb2Q1h210Str&9HC!QA?t@z| zl_(#%4gG*bY5lEi-Y^damZU|-V=^*61Fn~JcYM80>@3rqwFeZzOvun8>!rDtF zRv8dd6is_t%(VpB&nkYE^8o5|vr^kPo?BzBH-Lrg4Zx15V7Bly0LOMG^rR7?UW=wJ zr8!BYjKrQQY8BkH2YRUIv_rlw6(>3Z@L5pT4J#j-6MaG-`|NV_fTYRJCMQvM@iogFS>v z!5}k+TN;Uab%k07*lb8k3tx2Jc1AVRaB_UOjzJN)eUMJLLUm@@-hcPh`*a8Uw5w-! z1wxiBa*7>qrY!w6`zd&0uiKmL@J=m#1`>e_7AG;63kk4x-jgKKS4M&~s#GFkr+{^U zf-|PLs_VwdX_diWfN_nl{aJee<1Rp#wkpB;cxRA%h~E$4dx`>4LCeYvx zWaAXx;V>z9_xlNkpfO&X0SZrx_}JAZrYjh-(NiWcQo5~!`-nxmqiu5rIXT&OMjob@ zh;;!D0e&8PxonOaIHUYh%pOR7bc9(|*&^b5c$EZy1=*>%2!l+G*ZW|J&SEYzUEd}b z-x?Un&g@n)4E`7Y4d3yQjCuxitM%d;xl`k%OfuDV3P41mW=LU|M~WzCs;Iq@iDpbP zsCQ5?zmyQqRZfOSa&8pDQ~>39aimL_UFaq7NihASt_zrTj-5gx?ewb4M_MWaNjG~p zhRO-tA3(Fa8p|fbfj?qxxX7dtrb%l}+Gx3?vJ=U9M2BRx3IEk z|FG1omA-L~;3t&^m<)*@h?@@CXC?%gHk!R-#P)Oel#ZUj3t~KeT zn&oKaIO_Kw>+AF{-8(X6+3qb{(wT{1?80R!*mcoWQFDj z$xe*mnJPDUOMYxd5lgHmic@xOU92a}2cLv50EY0an6IeC_7lTfrBIb{AHcQnLsvjL zU|LXP+W@kI(ZXlk4Mgwb&%m{JE;$^y=^~)rB~Kz`dfns;;E@|FG%zx)W;HE&kkyN0 z?07z>ZZiWS{9)?OK(4(Y<#)E7o&CE!PwtoI4(@b)f02T8O7Ajvkt121Whmnp59t z@2Sw-;3+>*MTHuWMr`YW)%KcL+(mhZ4Oi{+`v@JR!l}`K9lE2AHuZ?cqDz>w#+9!J z5CJy1u%YDn-`PlbbEpGd`l{Aa5#ha0LzHXoyPsD^1VRdSXZHlb+Af$#rZm^7+*Si@ zp;uCRR%XjHesJVrnx6WfZK>g$LzeAIr2s)XN4U=|jT1Fi*JC!3e1Js1Z8mLdHiS-v zv_p%nUTAKCs;lVO4eui_O3BpfP&!?3!+C$*3TkU`&w(>20|-DeWi3Nn=T_NI(q=3~ z=-Wv}qk+*c2gwKF(724y2<*%W8`QCIN^z~OPQxgC4KmoW^P<|? zV`!2956dvAqQbp_4v3cMq9wkC{sB7z>cwvV5<(44b1YBHWf?B{x%aH_laEr#L?_AO z!5AA`F#U^fhKFQ*$qm~IHR|%GC*~t75&*~EH1X;qT2%MB-Q=G)}jh5pEB=Of+JoA}K5=3J{AFChSAu!!YQtAQpTqDb3R*88qnjnl@+8;w4>= zQ=_27b9_s7Q%eN}PiqdMToW>2qeq_5Le553nRweAvGEzPD@jrl(Ssej5N&A{~ct8S?iYHA06Ds2uh40t7NW4)Qvb6D427h+JJeusS}gDihBtkTx{4X9?MK zA+kZOPX~N1&%OAH(UK|Ht_4EcJECm(<=me+^^^|%dUl#p;x)1$_45l1cMM*ti58~J zz}^YkMR~q!64`N**rvT0*cZx^b7t6)N2B02M&ts4o|Mls*5}Q^G^)hs+*`9aIH%2k=Og8e&Ttm=WoGM zfO@h610N`5148?3^Lb9gaP~-zUyfUJh8sT$)ulm*InE%xFXm<0IPyKI2eGYz@Uc`g z3u%-*x;da~6e5+9$$t&bJT4B6d4V(Sf#=!dwsJ^%cT?hS`{f`VK4;{$QGr08A)$-%QsLR)>Vohst(TRf8T}I%% zxDx9Rhg-4gft3DsUNjZ@6qQB>0B`uv4LQuZ0=e-slBox@hjdNo#UD2Eo`cri?>Juf zyu{8tVSW5w5V(K5+eS#9!<)e2jdAvcG3nOJUYnrGQFZ;4!Kq1rLvX=foMH97nQ>M3 z>kuiT1!Qa}si@s5+$~#^bn4c%HptDqHV_2ri(`LeH3+WXeE6FCH83nO-Z+rXQ{COS zSTGv3L)2w?!HGE*o#uH2%q6*|!v3D%J;bK2X`hox9reiU>!DL3H;G=O&}H2&+2x{* z?G^>ZTX=wCOT`g1g)gqEg7u39>>#atHS@6834!{^-F`4m3`EIy1~(xqg>Gc4W!ADS zp1UOn3O!rbilhcCm(=kPyG;doSsQYq*)?fcZyEMiH&_Sh5$&%m0NlB4m1@24IJRsKAN3H=2;qIM?=(Js zQ^-2CrA%P6Zs>J4A?aaDqFe)$MYBbeP=!NNEWx+*arbTT96_tVB=Z7~ZxSiQK8T#_ zr;J-;(v~Bcf|yW{)X@l) zp59xoj?k6Rpc=BxiJ;-2_y00=)K88)(iEZI(g#*O$1GZlI7CCgpN$^5-A1M{`aT+4 zIDTa6h(mauJuxybM8nlS<9nq4sK#+OQx(d2&o!EMEdkd&WFVb?_05(CQW&#wl(%2V zhPBj+kSqH_{MGvp4tk-@DkqP2#OEm5AuX4mE35~`vOL^i*B*uA{VLA^UZGPlsxP$e zF$Lb=<1U{BFJo$M@~bXm*e>ea3n=HxpW>%>mnHzTUnoBLnf8FF5*b3`W_;xj=1qA& z$zf2m%?avD(8UOVd_2o%4Gmj6q&YsC%>!as5qO-X$13vUn$~=J92EV*_DJq7G@6X{ zoP(OL)bqF)5Y&1%=qE*@Fn?FQsy^;i0szK&jiSEEC^1?#qQ;o{K2IoG_>zlSC0joI zY7SJUUd1+BP62Y^(*f&#AFGOr^>}L$VrNgIsj_?}x<`;T2!^}_uL>Xopk=pY^>sMF z)@aoK|Aj8SN~WTJjdJ)SdqoM(&O~MEVT%%$QP2|yW>D}Ouhm1B4rIe zRV;W^V)A%1T1g!H=BIus?ZuO*aFPb_qgpiQ=rTB(t$G#Uja+XLg@UFVbp_!tBgsv> zttS8Iq&>W?m?9(unP^WcBC@6G|iyxF|0 z$_49GdLYVGaUA`4PPOH99ZzJ04jQeEUc4E?b2nv@HXvmvN6#U0DN*CqQMC$D%6}0y&bHW0RHJj?S^Spqd)W#Z^UV|_O}q0 zYX`AI60+uj@8CeYRuAl7>yFr*pc6M_lc=3x2r*F^IFnSoT~89_sd2#*`0Bu*I#l<^ zqf0Nh0v_%S3-3)1Lc!IFHj2HWSwDntj}?be7|KPcPP>YI>Nk3HNVwoh^_mc)x%|F{ zSnfo}wX{|fGyjN_b$!iWi?7J7o{W2=-)1G8v`KtpTn&A^^NpLUMXm}0_2gr#5cX#j zL09S^rviA>b|2}C8Y0^UPEMzj4PR)1htGE+xDjSI3&NI$yS>7t3(E!;oI7=KEl?bo zpX;0M*N9aFmF>d9%y5b#u-8VLsVX;$I#AkO4O`&Gds6W$mTlu<#1q!KAC;NbGxXD8;dtwagdq9K^ieaK#dl<@ zQMAhzzRJ?z0K`bjHsBCNkpqrIq+39PPRgrwKV_r6XKOQLL~16}kcv>SfarVKr@YBD z9Gq9|BnO!fXlUF`rb)WUK~1w+NU9Yftn^CQcHVzS(IzhEzY-fUj4Zv(Z4%)s#@4Lp zCN|Qs;lr>O7+G@(iVBOWcnzq)?(w2-wkC-w$uFm?Y1Eoma)n{|9+_`V&~fP2DA~7$ zhI^QOTruua`RbICto2#y%S=+OY+>H%u`XA#i#G+%b|8KJ&;w%r10v7yK&wv{s)dyc z`2?j*J2#8(;-}1J#_u5>FI#uu-z`A~#85j!Y*}2-X0UJ7K<~q02fHEZ4Fj6M18~9M zW!Ab2!X;r7*kry04Yj2{fxIIrdWLz|88pOTd`Xk)g^$|aJ>m?p;3bgO648c)cybgT|{@_-_ zaJp)ZEXz#cYFxoBL@U`BK`zuJqpCX@hc;gG^hkKe`R*O70$`jqr+w&LxUF)sfznpI zTimC_CN0Re#TPZsX6`S~s^5k761OwOF{#c%?z|HkT6_4u8`!|=vG$?!I!dN&hvN@S zB;N*WnZkwWV|*O)f2e^OSG*&7=e{3k-vib(dG97Ou@AnEygAB{FL1P#tZM3oskV`3 zU_j8z+r{7<_|c^|MSKgD^!sj{g8h>PiH62z{SQc4mYZNUAo8N!T?ONS@ENh}r;)S` z7FAv#HJ$c_bfrtO{5|L}1$^S*9VkWLTGBXm`8Y5B6iSOU(U1~Jg=T+ZrNRA1OawHy zQ!IjaJcEM59=N_N*ABOPyn?W?yW{{J4}{-416pF-Tj`@6eF zKmk^pmj&;Lo>PJ08G&m+kua@+!qGy|`td?^`Y8bbqzvdmvj`)Qx-@^AJxVj84DwW= zgllqAg_d{QbaMMqy(Igedbf;-LV22r*tl4jAju$hYJ&?g$P3l(ENfScXh2ya1slD4h;1VRrEvt(-lAh#5^Na$9+$%6+30`fu12q{ZnZvj_-F$vrA2 zwhuToDWc>yrM*xgXjBqG*3s(`1C>wSeTk{=Av#YI_LMLT*A9@HX`u8x{Hio9T`%}J z7LQAW0JXXaQyXX>9kR4Qhjvf`!k>oYCGE$s6P4FAuORpORqF^YD(Cu(vt>MMcat}A z3V?ik#!7~tsCxsGC7Rnt;~9GaQqT#_EyQBVxvLg3??-<(-~#6>;mn2TL(4q!ye*Eh zLNGF|SR}|E;5G}m_Jnk>gao$5GWrMd&ItwK{6c+)82VT5NVOKIxx5`+aDj?VFGaf^ z17fME7}!+P$W=}_=J2d&Wh&mPGj&Aya>nMQL2hdy+6#N`0xI4e=Tw(WHXioW@w!>k z5s3sbXia?y#jM)*#&&zMSBQ59EaqTkWN~X@Y3D8@UO1gZ@ql;HgfDZ2uDGTwBpdkKXQkXwz5IQucAP=| zf4VpOIh8qllbSxh4VkUCB>LYB9c6h{B@r>@pX1XuMhGE*5lQT}19leIsw|M?I=%-_LK#YrskFqgz__o>@JHED*ydU3 zN0X0Dq+@80{48g@JIkZo+j&;Lem3uQhfG@UM_E6(;H**wu$?i#Bz13m-3nr#q?*L* z;zR|~tENr*$SV5rp{{d4+5Jy*C4%P_8TzfGkZ%d_-*ni;-a+5S)Xmi9XP5uDI^6g< zF@ZtQfc|&c?;GQrApyPqoTvY!Nc~;CpEBS->}Ng7x9q#CsqxmT#{=VGdX{ssKyuL1wj__y2Qe@6ayx8uK% z^%4J~KmO;g{GYM^-EH?T?Bl|4jMk_m5wcBk%rVcYaa+Z*L=iCjIl4{)_aC z;`gM#9lHN+ga0%2pZE7))H-jg!S9CiZ>j&W+y9yF&wIizx)kdFg6^Moh(9y_c~Snw j81^RI|Nrjbzbw%T(%=w3aS`7>>EJ*>*FXOf0Q7$V*5Ma% literal 0 HcmV?d00001 diff --git a/setup.py b/setup.py index 5ccd4b4..f2dbd38 100755 --- a/setup.py +++ b/setup.py @@ -1,5 +1,10 @@ +from pathlib import Path + from setuptools import setup +SCRIPT_ROOT = Path(__file__).parent +long_description = (SCRIPT_ROOT / "README.md").read_text() + setup( name="Verbex", version="1.0.0", @@ -7,11 +12,8 @@ "Make difficult regular expressions easy! Python fork based on of the awesome" " VerbalExpressions repo - https://github.com/jehna/VerbalExpressions" ), - long_description=( - "Please see" - " https://github.com/rbroderi/Verbex/blob/master/README.md" - " for more information!" - ), + long_description=long_description, + long_description_content_type='text/markdown' author=( "Victor Titor, Yan Wenjun, diogobeda, Mihai Ionut Vilcu, Peder Soholt, Sameer" " Raghuram, Kharms, Richard Broderick" From 9ddf7a8dabf6bda1953753328eee78b4d05d56da Mon Sep 17 00:00:00 2001 From: Richard Date: Sat, 7 May 2022 21:13:25 -0400 Subject: [PATCH 21/85] update version to 1.0.1 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index f2dbd38..c6d64ca 100755 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ setup( name="Verbex", - version="1.0.0", + version="1.0.1", description=( "Make difficult regular expressions easy! Python fork based on of the awesome" " VerbalExpressions repo - https://github.com/jehna/VerbalExpressions" From ec5231fa276957a3310904cc6d9b126a75a3ffe6 Mon Sep 17 00:00:00 2001 From: Richard Date: Sat, 7 May 2022 21:17:27 -0400 Subject: [PATCH 22/85] push to pypi.org --- dist/Verbex-1.0.1.win-amd64.zip | Bin 0 -> 13388 bytes setup.py | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) create mode 100644 dist/Verbex-1.0.1.win-amd64.zip diff --git a/dist/Verbex-1.0.1.win-amd64.zip b/dist/Verbex-1.0.1.win-amd64.zip new file mode 100644 index 0000000000000000000000000000000000000000..0bee37f29b091b2fae1fa6a8d1c2f1fad2907640 GIT binary patch literal 13388 zcmbt)V|b-a)^2Ru9d>NnJGO0`opfy5w$(w$>7--Z>e#k(x(DAo^Pc&7=A5a0)!y}^ z)_qs4XJ4yot>>1P0tG_@`qi$>N|gUH_}drE&tG|WXLCDSW<~~j`Tunu!avQEwlMt7 zT)h8lu9Jnc39Y?>k(Gg&iPLW^N&bzctBIqbiQ8`gIR6cR>R$k88R;147-{X@ndulA z=uFJaXf13_?S2DG|8HRbwk|zAdv_xPBXbiyz5fA&0;>1V`-{s#euDgJ)Ia+lF8}4q ze|FE`!0g@WoZanBj6s3^{#2lVfJ#b~Z6YJ5)!>1E8u@{MX#O*(zarAvyRT`zIkR0zc?d=@wtKWiJZ8L|bljl5+I zT-?9VSb|_>C@3wA%pUmU?GE*WB@0fCC=Ka?zXYQ!30;~Se}YgMLl`>lknynFD41Ga ztTkE@@%)M6AaKkgMcj;Q!PMe9G1HF^MO;bU_Zl2oWQxKA98=oc;wxG!T8%0&D}ud; zEF`DhW-C0B+j+9_;wIdhWd1uM+C_u}Q`ObrhjZugmMF@v<1*z7!{+CPM2OFywePmAMy zd{T+;7gQS-XiOnYBWiu|wH*_cg9p7b*LYIRS)C&qm9jE7+Mb?iiYC~^ zJi29GsGlKU+L=i@A7ktxdZfKaz&=dLSm)|Isf>E(6r7790XK6Wqs5Cr)DsE%`F6m* z^mG6;N)_rLt;S9$se>~;5Bze_`?RFK{hgk%y*4L==bUIpJw#~}k=)SDpyawdQ}2o* z$bk9~;mcZ%7a+7$XFC+3kiu=X>Pyho*62olATxw44~nGmDg@u-3&4qLZD@64Bk z`cENiW)u3W1hMM)?6@7^U=Ma7I%HS=4q=TEXQL2@sWJ`OW#eaO9J2||lLQ}U*042} z&Ybx&&Vwb3giiV1pEB&SH<1c1I-u0C>alveCw-I0;*o`qPOHwXh8Ndy0NRvysA{D* zrlyH$6#^oU=!=fc-EoT!86&k!m;Ffbt}jUa7q7)AQ=tuU*wd8iYwjiXh6ipUT%b~6 z-{I871BuPewl}Y}DDnk3*Dg3kh9bLHihv{NPhFp9zB`xCL*8y#B3BZ@#~VrVnT+%!(i8j9YV98zynt4`(uAFW^v-qDYXu$Z3aQb10Z!0RTd(N z4sHT-hRiWpLLm1$y@j%KYeBb(T5kz66V)T6aMf;CLHt1URSZVcekE&Ov4;p~k`j`f zVw+(JgPx%7Cfo6OhPielk9jB=pq=L?mmZc0y1G-$lFrk{>V9rX0`=eHLA4DglJi}l z>X!o8R{-MRMWCaiBw?M&x+sx)z+U;!wL`*AX5zu!_gj%Y<G4_z?KWIZeW9*S{40$^;AHsmIbm6tA3HDP1Gw~lckQ7^y=d!Pa= z>MevFB9MjAh5e{NQ4%s{e9L#Y>=d<9UGiz5}mjsn9-5xM$uUkPz(a_A2=GfvKXd_=nk|>CVU@}L0OL_^8YEfQBDR7BZ z@e}$>TX>h9uEQdjmhIf(>=ZV4A_ZkP`fX`k?=F>4rM$_Vx7DP^f z5msk;V^+iciNDf9uksVL^Bn{nMAg@K0ovKuygOHzZPXf1Q?|El?R?G)kK62KDhH-& zVAlb6r#1ZeH*Mqt9?v>6)z%(9=a4hG)D~c~hpJ2$Uo)AXBrsrP!c9P{2^j==NF*pR zYT{gFwtz~<@<-Bg2_F4Y*rwXJdh3{Xkjov@Fp`KEmwRL3UHSYJJwW*EYd)_U2!gQr zuZsm?uJnaXQ{;Z6xK=cgEK@Qq*v$y&IYaC?Tc0Qm+*{Ik0e(xkSh%JEB7g1B{lWiv zmxNOB)mG0L(Z@NXvy$TG?5P)MN2u7`p*@(+20N}Iaeg)y|C-AX^>pu>JLx5fah#_C z%+-|PNMT|o65-d&!9%MtBbW1JD+z{KZX(F7R{$uRbPj;P;&^RbXNGkLe<1RrhkJSQ zfD89S+Sjyu^S}bq@c4@EM>H&grPO4nO7dJsY}rtzxJ`~gaO!8JS_(W*h5DtlmF+h> z@0#b!OzPv`)dBYh}D6u?&-4-Lm ztq$meHm{ssC4C1!+M{caJc?wnx!&)R@RUw94D(w9ULxgoqnkp5i>dCKRlrt>k z+XI{GsDYanU{c4&Fj(yCD9r1O7$?F8rS;QLG?9`d+Q!_wQ;yv@3g3@M{Li(CnA1kV zN^|7}WR=`nsk^%CK8zKnLU!oM38@5okAW*Q!X*kQKpg=a6;9de)wVKr)eN=h0@Y79 zOJP3v>w>Wf;QE}3I4ui6MmVuQB#v;7;>?g#~^#J9%>g8C0=Y! z=230-fwoUugw73OJd5}Hfx(@-2*(LFe_YQ{ZjF9I$tL9sbDsjY!A8CE0{V)>jIHah z#+pnCd;};VB$d@fVot194Mb43S>}g3nI6#qp0(m@N}-Ld=)hyPcafu_WwHB&1bx8N zToVMrbL=sYc1t_W-y9;^ps|U0q>*0#RXloCJgZ4p0n$El!detziS$di*75|w2x-=% zT3+@8BaJ}DuJ0y8fStwH&4#qKZgg#v=V4gd=AF_5m;%6c8|DJX(pb|16t)e;x?5D# zG(e}7bdDO#6U*R?MpzH5vJ!r!CqkXQXNlXY&P{3dL|-0r2Z8LO zkPx{xpdKH%$Q7{(c4oViT35>q*vF}Y-eO-v{6uhij&i_(5@G^4_bb1Z*C6GW;`%waucVQ?roL&qWiRjdoPiNv<=L_YFS ztm`DAO`k2nFqB*sF;b0f%n}zj6#8MP0O)ROT=kAJH(6^bLkv)5YsUShIcU{38dLrx z&q?GPa05^F^Uxr1c*siw?YzO9(*4RcZDc-qprJKF)@XD^2S)(|{C3DNFdN@-VeHFQ z)Dslz&Y?^6@Yv&?saE%b`U!p>e&N&iT2VwdYfm5cMlamPd3k8a5B8-Q$N0y+c&p2@ zQ)bZY`lndeO6=*qVQWhbY&$5ll?{fD6UEC>tS)? zJ`Bm0zOcfD@mm4(*6ImWm|x}tDCI*Rj-oxWnaEr7$^NHh$x$ml^$4q64{g_H5B@}~ zG5;Q}Rk{e07<-^;*O$~q)i-hNwQ-g)&H=-HCTYbae2e8+mac0dBL7Dc`|~ptn!(&d zXTm~ycb@S(eTv4#EP8v{rv~Nm7qh_3DXfEG)6rX@CTL@%Ho4VMfN&Btqx8n>B(bJ? zen>welX(EINfhGJDH&}>p4iB3>=^~_L9ACdta*+H!QF+eC?ASjlPU7m0X4?wmuBQU z)7c3ykHM0K-kmYEg|414_a(&3P?stJF|%3;>o+(_FDY?zt>m3z4jwBYNs0zmoC zO<{dV?XSBs??6uXl3e+1H>XUVfogYbEgGS zf0#DhVLB7NrX$r1JUoDI2A|8hV?BHKSXw|(=bcu)1OJhr;TM-E&*x#O3j9pW{C{@3 z|13e%)3dO(aMsiNnW9Ni4^OB}QcKZFN><4aj?xa&Qz_Vwi_-CCx< zl)}@A%Zy8p0+)f50k#a)K0s^&Ckd&yYyU&C_$$>H?J;=w#sC7M__-j_|8y;XB(Z-> z9F6S%QX!!ISt9tkLZdk?9ecb1hxMhE=RRN#e^RKouo3<+F@L1p_sK+xP!LLSG$2qU zGCD!Jds~RExKC{*OT0oHA81!%@%tPyIo_j5LL4h4QxAw_$z<_XBvi_;5+w<)5|<@a z2o%f0KPY*^#D~xDat|B|fRU7(t>${q|7C#?npJnH`JUu(Xyx^_2C_b%gh(5BL z^vGenWviiWy~R=tTfwNn1)-FyO31J(`#*}X8jx;us?J$TkWdcC&neT|6oyTY_9&I7 zmzhLa)0*vAdI3Ht=&GG$rFUOd`Y7n|%AmajxgH(?&4<{8Icn4n!OR=yh6oycQDuPn zYSYg)#ifN`4v#HNoKs<2bIRa4>x#o|)zfcplTus3W*9l^irZ%85y|_tqknyw&q&Xv zvsSO+yn;`GTOZHYGY;dR@e_-%nTBgDzW$S~iNabHR)~5uLKX5h!wR6O=bgm*9X#kP zm-~mpfvl>!l)#dL0-N+F!6iD4JJQ6+$u;@9418@VEV-#|=MQU$BzOVot-SiM;LrzxC{V zvAm`NtMW@0Zqb-E<;PBA^z>9zpFY&Fdd$?Z=3U0D`Xa#G7MDlGc-pZl-pU+ii_#3O zmRYivfwo>HTk7dy6BfOOir3WU*V+#SLTF(>%$6FrH3+`3fln+4u9dElc{>JaxiqC- z)Nc!d0$xud`>K|;vyxsL zCTSki;U~VSHs-qG+AZo9^^aaLQUB<*)rWJLzGaQ+*nOldaSjkHp&W0Ah%HRQE7AN| zYvK0@_L9|8#t4TkXF*Azp_G+b(wN99G$eyApjP574f5uQ-elO8ZIY6fW6yg=UOq~P z!Ur<<3B9_f^ELsNxnjM}$mb?a2^N#O2)t>lHo*m!Lfh~RB;3D)>^*8u?bRRpRr!Pr z^)nN7_2a0)L9YrC_Qw~bm+PTOInxo`eP^NZLk|za9<+e2N>xffjm%;k8UJca7VuuP zmm8_%h%UDKZ)X=77@u(1M0F;uDsEN0Oh>n*&aeh-=bwdvwSh0S*T691^w(wxg`tIJ zJl!?BDpLfHC8cXZ5wP$_cAX!cTDr?;dGUF-C(y*j5y4n6RHUJS1R+^dR51I5WAQ|= zn2N))GWG^G4hcXCi_*b|R@BuwRg}T0UnmpRQGV3XP9o1tq?wN8MN#ct7eAWzln8165=NQldBeknb{7FB{&R+v|!dZ9qbxnu_RVr^>a~j0VanOYrA!kIIS$9eHVrvEqpKt;T84Djg zSK96K$JII&GiQQ^N{w#i`{XL1ViY5Nf`HFNPz(hOsGwc_kBS8l7|aluP{RD~iaBm0 zMueP*zOZ{0y49N1y<>9gbzRd}+I$1==P<`Tao(SpfO_gX4|zkO@M}y2$jEmw)j!QAc zqL_SZT>LU}44UWD!o*xY;VMf`N{4N(lBM1otQrs?kh^!)*UkcP5pF5HoO(~loauJl`} z_L`R#Xicem80*{`z2kEF@O{%Pw*>vv^t?b)*p(?pj+SO@NRtxnMaie>bLz>Sb?{r) zD_59xnK0dcQ3Ma{dz9>X$*MTkX~~9ovqbioCPjlYog(mt29zH}dY}fYWJ-N-Kgz@_ zM(;yDBT-llmoFIP!@v?($}o=Q^zq5Z#9U)RhAMi(@Qp)vW`U>iHb>#OK5#3!2$-$z_xDC9^(hOCI}ype zJeot~s&lleG87svhMAvWl7Q4HESQ!)lxh2!uRJ_H_%Ywwfj*$wpQnPwnNzZ(8OTJrlV_&+iOotS!`6eFreZ0n zk5siA>nr-{c#@R^XCWn5WQ2ezK^LU&si9-%7b=d~AbT6txgJ$7o0cvvjO}0#VUp8J zkK>j_pk802)&n-brlo}~Ic+mjGeCd68fPLB3HN6HQ z%@IDujyF}3`kwO=G`ZL9#d`Rlnm!AOzzK_!n8%3(SU>Mc67DM}MjBHr6}FYfIzYi0 zS6I_=<>0W);48$q#n<|xHGuKpuR~LvV0FAR$Th_0i*T7DPgvNpI!_RZw3XP(6)@E} zjdwUg0^a>;l0I;p$9jO=!#qBAt%>m(hIH(d5sZX(>)T8miqf+ka%Yar>Txlle14P zj6`QnD=7xwo8N}dL~up}J-X$Ol3CePqvb48l^^7Q@FI=iqAvFo5sp+5J40iQ=wwi@ zz!E-5LGJ6^4EN-`NQ7yBit~~P=TO^_E8vqLx+xuJFsoc!`9zwTHRl)_N_`1eJ6HOu zN!%Ntxn1=Y}? zP7;}1XgrQrcJxR*Xnt=o{iIW!h?&LFB=l!pLeJRwL+~dQLQg2igd3AV{NPpU8{(a4 zfio2@@RowujAG_k4;06oy!u!Vn9tq`-vIPs+0oxoOY9~`w#uNY;68(E;)kq)bilNr z#>m+p0yD}+b>YOaovWjUu|!Huj|5^c-< zC4Hj;t4vTpT^EBEUst1iQJ=)N`SVvrE{fI-5ou9%7gY>u{f+tS%&4*a6dt{=$!t}~ z$`(PZ{{Fz~QjAF$V0s_ps88*3w&Cu*Xn0e39A957)=aWPL<~7BnE{McfxxS&NuPtN zsyQ<6G6;c0CU_`K5XNCwMu;}eRo^P^Wc=Ih6WQsx306) zz03zJ%~O3QTXpNzZpDvY4J=r%g>{_McyMlbuvP&kbE?4}Dmc1m5*g$To9m8!r@g0w z^Mj{+gq4-5KIRVpmbgHw}D%hr=Fi(HfV9W{#OSx7$5o0q;x z96U6`xSA684%$CTyo-kD9{L7$6x5T=?k$)Kn)+Cdh|?lW;!E#YQKq+I>0~GI(!n?@ zYY^R=PlmfhL+KssDi!KV<_pu2B{6_~Z-!{?87;E=-1l4KAUk?__mzT9kM>qa;iQgD zc^Zf7-6)s4Z5A34Qn4f!6gh}_3M2NR&|xU_cMx-4=9K1{(hO>JI}PizSFzHr=jky} zqIuqB+v(-P!k2Y>5za|zu(2Z#XhA1K%PhQY_SpE0*wrM-$*92&9SB#PY^-N~VXhFR zG2xCwxD2^R_gcY2dsOy@1%3kQ9(y@$ipkP%qJ%Ck9atS-RFsJ34Ciy zw2O)Ymn72TB+*SfQLt|mC+AGCqtAvxZ4AhT{5>gOX06Vfd3;wQdT`Hr^|6Cb7BdLt zd^B&ugZoV|AVXr_NcRv*@G|;5bD;@xhgK185|k}I0P4LB^j2N%?xWg--k#L z%^_n$NJMPc;O<$Qq*AwTwLtC`w16N`-yHfQYCv#(7sA%vZh>Km@Fsw?U+N!*W5K9Z z4^da-1SaR1wVM|ZFqdVUiu!wk_7I!8X1q_PwACVVZih|@UB!D1LsoRUWLAndwp-*8 z@8JOoEtN;mXx=u!A&mHB2L-Cj@Gv5Botl(GaDV^sa)I^4-XmD=g((+z-q4 zu=hmfQy`Vg)O*tX=G$QI}5~6rhbND0u2gO&H422I@=u{gt!$p|*O6)Xd&W zO}LJ@I^~c}Za6hNo!__Vqkb~v(WY>Nu}@LhLh+;1 zN9;liY>5&1!Rjt{8J7`$W9rA8kzzL978n)HCE5E?+@W_;%h;z{{5#janx z%>n8|(8U0Nd_F5+2?&oQ_CS7q?7bvgX5%FF{Q3k2o%9@x7+<(=QB>Tc0j)o6S7xa{)w z95ACw?I(ATj*FZC;FIeS^-n-iq2|5mY+*(D@lPk~HcYA;{h*h5!cU{LhJ%@J?L`lX zNt*{Q!GU%ypV+?FAF(<@CvM0jQ8~eUz(l3zNK*E4IZ2eG!Ua#@tp|hZP}!e|D!bb9 ze|j`1dNe)=0aq>FDDi@3`5d-AUJ^=fARDeS<06{bZ}@DVaKWAGIVnngb-9jM;YiE5 zyj~l<@Qjmvd&^gcufV02jC-foW+{}kNpxpa1AV+R%*ELvTMdDF64NS({RKt9g(}do z5Z-#hvUhH4>bSNmj_|oaMQa*Aq#`uUZJwZ6@7D#o%*;ID0a**4NZ^h zM9Kn6wxOY>IK|=E>toH7RU5?}DD5r=EpQV(srZ$QAN)K}?$LT*gI0Hf$_|&H+c%ea z*OAShu#SkaF(;?DNofij?&9>t64tw)l^B0y=%vHL@zfIvLh_dDp=LCT?a0)iXq7L1 zm!ZZ1h!U4?z#)nt`yUBQwSWemRMhBX=AeCIZ8Km%Y9>{e43{^D=zH6zxXUsaTu|sF z16lC@+PIrcoph0lnr6M2R44qQ$}?fxY5ya6o0zQMYHaujveXKfakz^pYqNr@=xE1= zH~n5fMC}zQDlDqPEua#+$CIkria5Hopn|rxQFB4j1&01IqQHuvBXl-7zIu^NZxS*`zv|qWsfi9nNHDFLIpi0J?&qC&Yp$MDF8(R_|<7b4zEkNebz9 zE@q#l%&caH%V77ntq1T+3y=X()XrcVW|y;B?0Z$v$1vEzZb&)<|0ZyMTrha)_3pwj z3D^Wy>2HBUZK*FHABl@!VLo;S4$&K3QKx$1qqcXC`oJdq=m+Ds+w6=O@<{cBP2f&_ z;rr+lIh3P+r6c_Ym(ba@^PKe=hq3|)LeKtP9@nnc>w9lM0!BJeiHeCw-;MUiXbd_2e z=GmgPxWapgR?=?*oTy2L)eqA4Z9Hb_5%3NR-8+_rz&PuU`_OrCTNR`OWvzJkxG#xK znviWvZ>k*4T;E<*E(P}zx3k1BDbIo*yb`{)_V8ZnTf^$I^r7=ONTh6s;SWqE-v?=$ zzy<4J#0>d8)xu0DJP>|#+Yhko0c)Cibd{dm2mgV*IYwW=f3%gXV&aLZx{;=@PteQL zMeh_4^M_hL@0uD;oD11ZCN7sLugR=m3_Z{!~~E1L5%nzq5L!ULqL z-M*Nvctu*U2OTPpPZYERrQlOX5~n5?=gF5sVV))uTq+^o>_?z6btxxV~$Irs{_0KN$|6bt!pThf}O57v+ySs)!{+63p zg&zrDQ-R?bfNMdKFs*>X(1OwW@q)GcDF6VZ4Cq1Aa6^##G(YP-3RA)ivQ)u@TQU;) zmXF)Cvip&}#QT}OTZV)o+|7inoXm`nq!2rGK}8s3MXC=Lb*qNdpv(~hjp&R4P#A=@ z@p+-}y%5NqH%1^-QcPFZk?`<_o=gdb;mlHsF0d#G^{6vS5k`bhMqAs=*Gy7d+qW=O zb`Fa>dnJi`h0A`Kif~K;A$}nWzQ})i1&{!-zy$i!Gr&K)%)jxF>hI)n#wPYAw#Fv5 zM(%pn7PeMSbk1(h+aP~p6L7m!4*&xKT7U)u68vx2Ms^i8>pU}!c)NANvU)DHaKe@D#cI`5#QB25oz-&YL9nIr8s4+V=8 z0bqb{E@j1mWb_@SLDX+(D2iuL_zXkIoC=yX3uYbGwP&sz^kyNQ$^YH568$Exp^+_s zl(LyNgJoPf$#X!l&KMFI;vGe)(-d5^6S5Ihe7Wlmsl#?Kw+w=(Ub2U_(P$gP_z<8E z4BrA5T&m_GVWjsXj=7r!!qTC!Sj#q+`aN7h;`Yzq2HB>|bAhPoV6m7qSd=Bj=H?GM zznv{eyzE~S`S5u#`21yxwrH=!KK@Tz(u=-n?Hl9QJV266<;_a@9YJJDQ99EA2&f6sC>$3 zd9f6f+coi#ZJ5D4qrF7+TQ=SP004IQ$-WBxepaYVD0gPWAmUS$gO0;Fh7bt5jaIiW z9cw>&y#{vGp&<^B_RajjSuT9-y!P_J#dd2>NW})=Y+VV{yLQ>tIm=a3d?lR@@B1PD z#au-zZrWMJfx$&A59wN{p?Bz^=ld=2x0k6`n}RPS&EL~|&qPdU;?VansVvE6o&x>u zC_D?*D3XeI1;jZ!RQ6b;cCy)*ZtRJ$*QoP@)}O$<)uWDEU#G^J5pNW4A0%Po8wudKFzJ@YZ2@$9UOac$>Y`uJLZ(it*teH>%??2NNU>Cbw`^p@1U@qH_hZHjUVuZsf} zNVkS2DTYNP=Bd7OK*{Y-Aw8V?9rwj&(Y=0@Y|JnAR z#oE6^`lV+7Yx{*1{d4#`q`%3&e+T$W-Tv413vlA+@OOZ}J7Q?&e~_M$ z|DN=>f8Bp|5B)RspRb{RP;38;2EY3||Cajim(oAe{rODzgN~2(zo7ev6XMT|e-6rj jFw+0j9Q}W9@Sj4oyc9UZFI>c*pLB2_pv<4hKtTTo_0)Sg literal 0 HcmV?d00001 diff --git a/setup.py b/setup.py index c6d64ca..a629f35 100755 --- a/setup.py +++ b/setup.py @@ -13,7 +13,7 @@ " VerbalExpressions repo - https://github.com/jehna/VerbalExpressions" ), long_description=long_description, - long_description_content_type='text/markdown' + long_description_content_type="text/markdown", author=( "Victor Titor, Yan Wenjun, diogobeda, Mihai Ionut Vilcu, Peder Soholt, Sameer" " Raghuram, Kharms, Richard Broderick" From 2950a5802632e2ae584e2f38cd63857e698a6740 Mon Sep 17 00:00:00 2001 From: Richard Date: Sat, 7 May 2022 21:19:56 -0400 Subject: [PATCH 23/85] update setup.py python versions --- setup.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/setup.py b/setup.py index a629f35..209b868 100755 --- a/setup.py +++ b/setup.py @@ -28,6 +28,9 @@ "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", "Topic :: Software Development :: Libraries", "Topic :: Text Processing", ], From b0f29e214d4144b14a42d678e697a30d062be2fd Mon Sep 17 00:00:00 2001 From: Richard Date: Sat, 7 May 2022 21:20:44 -0400 Subject: [PATCH 24/85] updated travis.yml with python versions --- .travis.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 51219d3..8622eeb 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,7 +3,9 @@ python: - "3.6" - "3.7" - "3.8" - - "3.9-dev" + - "3.9" + - "3.10" + - "3.11" # command to run tests script: python setup.py test From 1298138bab1e00f102e54a948073fa1d460704d6 Mon Sep 17 00:00:00 2001 From: Richard Date: Sat, 7 May 2022 21:36:04 -0400 Subject: [PATCH 25/85] updated manifest.in --- MANIFEST.IN | 2 +- dist/Verbex-1.0.1.win-amd64.zip | Bin 13388 -> 27015 bytes setup.py | 2 +- 3 files changed, 2 insertions(+), 2 deletions(-) diff --git a/MANIFEST.IN b/MANIFEST.IN index 148cc7d..e0d237d 100644 --- a/MANIFEST.IN +++ b/MANIFEST.IN @@ -1,3 +1,3 @@ include verbex/py.typed include LICENSE.TXT -include GPLv3_LICESNSE.TXT \ No newline at end of file +include GPLv3_LICENSE.txt \ No newline at end of file diff --git a/dist/Verbex-1.0.1.win-amd64.zip b/dist/Verbex-1.0.1.win-amd64.zip index 0bee37f29b091b2fae1fa6a8d1c2f1fad2907640..55088e92eca8c181efa4d5880dcda14826c639fd 100644 GIT binary patch delta 15425 zcmZv@V{~Rgw>28OW81cE+fK($IyRoLW81cE+qP|Ytgri=^WOWNaqs@I=Gbe`s!UFX_1H%Y#@)We5j?t6OOA`>D0lehDi{UFN}6mS!ab^7PZ|%B6>B!u9+8 z>fY&TOpr=DK)BMl(!^Fnx-CXv_-Of$*)p#*r+Befo;Dh8{K;){Pp!@sl zv6{8q8?#N5yL~_MxjBhi+AGdb@e&pI_0KY z$EBj7*yrV1L)+}@aNSk}Hbt-5;i~=8OT)w`fzI-iwkD#IvZI^sCS=?6&m~_~>o9@L z%G|{i^#uXoY^hwgz1>M`jy9yJ;@wi5!DM2j)0grhr1G-Pck7SVPqnEAn&}rfh7Y%` zc5fejE|2T$Ip{CltM$(D>JYDWrjA)X%PU@;xw8^D*CX|=5R0Y85s54!a7e2+i50V* z@%B@oZ>I&{i|Ky;H=_`a2A74$wd@uS+wRK=GXH)+jroi9Ui*EX>(CuiUd>F;+{4T( z`v$wnL@(MDcIXwpEtPl-2^cpx@x-?68JNq?v7SJY%h#V()2)v7SR60Rd-jr?Eq592 zZ+C@uh)wd+h`88=u=Egi{T^RAnkry#j#(OKhbo;DGQQwPVp$L#&7#W=n^Oy_fG=1* zAOn7YZ0H}-Y)*d9Jx%-@FbsGjoo;Z}S2Go)v$a{$ys&!8$ZNYvRgop zDds~Szy@=?W-6BMAw8vk#~n*NZ9lg_g*7UEFhxScd?qM5YN7|2bhmGSbtuPvbh%1* zBVZXC5dKC*`SoJ4FyCjfL$hx99jEd(7LNlsC3wKc@bvzZDga$4I*7_ta(f6Lv=;W$ z>pgc;P^PlMF<7kOq~41+>rL(yQ$~Y-?Or{~W3@fw3Jt7c+ZNbKcnQ{P0F&Xe#1Eg}z~ zJ8>PFoTJK%*q@XYgqnO1t$KUE{DrW-vJ+bK;X30hs?Ehh$6j;7JicUFQ*kzmgAj-} zw1SIYyS|ON*(zc(q5Di47SR^$6zA>%?^c7^ZKC(+C*w z?>%E`PySiQ>lp8@GK;emzti7G#<9SFpdN`3m*|+&k#3Vl#vXH;5{jP)gSi=<1wBhZ zA$14IWL26d_^+z3>tjDqY_{N|(8j|%=R>#89_d*27PI;J!$%eEkEs&T(~B2P7B=% zbz)-Vw=6z%)X{^ZB{p?>Xu2wrg<9R<8J zweUi2*>$67MLj0^91{f#sMqLh8t>O|B}Jd|R^>j92eXg~nER|NBYf#2awMxlp_4ai z3NBt_R$@F18|6yKx(P!UW4o;eke1tSME~NkS#AHuA77?geuX2utJY9>jvg)e6z>^_ z#*AYeQoU9IqS10rXsR8Kid7CM5~?}sA}$@39M$vL6yedB)%?F|=*l zV78bv!3Tm(EDE1;B;)Dl5nsC`LNUL$k;l)!&NmUdcPFmJn1-}+gx1Fj;N`t1x#+}K zH!(p}KqM%Ky2MWAQ~U^WDpkYOX(ZG0?6O(L*;f}1j3=v#Pl<(@6>^*tRrMr^LtZ0k z6dN?%N3u(!K?<8RAR+R7SgQ*PM1K=B4%H- zcam=Z(K?k|#E0(5sUYtm(>r%_eP(vit*TlvB=iCr0>$f|OK3C=tB6^LK+EDEq3%T; z<>8^?g=Sp^p<7>q6z`1hogWs>mUhM*CrFaUaGX-_tpz%4d2Fx>$Pk5;ewPS{GRQ9) z9XvcxwZZc++T5L?g}3v1Glvx7Ru!w=xPo317}N!eguy^0hQ%ljS2LkvM_jjg>fDCA zf+&G3L)K}|dV!YZlPl@(vC#A%U`0~*u^JaHO<={>6H@p4spGLOh&&KGN80Tt@Qxfp zXciPsL~T#%6b6)le+3E)Q3@wsy3 z&Rz+tsfe#G7|&6=j9`-2DcZ(bOS_FMrgjV^-D(GG57p1R9o3BRb30^bUN>IdBYd%S zN{+TiU7RBET;ib#d$@$tVxO@T@DazI%qK)X)r2)gnV&@Qw902_{YCuD0?j@fl)DkY zZS*R^m~fH>SULJWWZDnAC(rM+#Pe6UHI3%XsH*J^_a2xGC1Cg1*a+UuIv_D3CI0I4 z8Z-_289a)RELlrZ9B$d~TLlwx^^-HOuzl1O$h9ES~?M{zztTuzlGm%X~J{#WG3PREkDq@C~SgSSELk<DyC zqC|HR;HA6WgpWolBrePrJN<|F_=Pf#iNf1JTOlTW=>GSIXi?k;6$1@~IxV0dY66JK zCJc%vRi4z%S{oZ5LLVFTCgFu)P|!#2{?XN-#GMvj*1BDj; zP}!0?QS4&bo}#Xu(qudZ9}x&@L8JV>-4FoSe@-S0-QiRGIfdvh5Db*Jfm|c+@K`Sa z$Yp*K4O=NCub2`AS9Un|X^zv5O`ec>h zcdyM^4IN!R>iuz~H{6ra%-#?LtRXTNpatcz)0l`%91KLB^y75qLKW5?NRE^3Sl>a( zv$U$>{o9dtyUur)4U?vxjiDZ$TA}EkZgR7eu0Gh1p%T$hRa3RlWeh-~-xBm#oXng| zY2ZJLGzvAtdzW7Mi+uf6sOmOhC{E<@yEbE<@J)*S?zT7@BD4mCy4&}oBSZUq0Hq`*9Q*e z*<3VDEQ+RR^nGAbMtJ8HJC4Ipyp{!dzCQLdDlLG=)y{ea0O|Tp5Qu_%kAFunI>;MU zmie%5cj(5d_qpccz1$rXoO+l6KHgQ74X;p4Z0Ls5Ms?ZlKu6Dif#mVw$rCBeYjIw{D(MPucWicTd2fZtFlwdE=t z{gcSO4qP96h5?kAWIa{Gh`?3|b11Z5);rSgMT-7*ON{f zR>SmOSynA+bPDsRj|+{UMxs!upHNzi2AC~VL-d6TG~{UiiW6v4laK~iBQ&Q@TG@F) zhSXn$Os;6!xRxOlf}ec`aO+nxn<91)bQ%R}yQN`rAJdki#Pg)_UW|00_bs@ID5;E0 zf*Kc2`L_3cz!u4E$n)y0GPzff!{)AbR}!`LSM2s}6jb zO~&F=xK-mu^~=H%M66r%Xe)JzG(jykU1d?K-CpO!+GM!=>P|@wupGMKGSDRvlLo&X z#W-zPIZVVJ1sfk_g^f{$yFbSknM8b(rm`$z`^DHXEsR7XN^?Et=~Ug!r~oIHI7Wi% z1|1FBaw$?nif&|eza1bJwIL7UTE&trIM}quiJha|*|v3+@EOYLF(42~akN#(nK+6- z%F=Mpkx*gnDoNL5`J9$`(GEv%DiN7}z$Vd~`Q&fvwDi$f#9~E-;X_Ks+RlLDN1YYUB@e_^rI#o@<DCO+-@zTT^y{Z<9Or_^A(Tk| zz;Ak%*x=v?gq18Vv*qH&&Ec~9Oy&e3N#!?Sq^|cIMyrZYvZ}8Rcf|ImyzPEW%EvvL}Q1vZ0PcE>;+BjR?7tS zAZh0Y2qlG$704E9)?7YnFwqp_D50-~Lg%k-p%2O9)#pxx*uXgN?&R5Jvd0z*W^7{O|+ibL14%FB`agnKo)rMpUDUlz%9Q{+|!N!+I{%kW7B23EI z0~avId=jyHR@Uvl{(9NcFHIyhq^OPsiCc>L!a1iV%J&gO&rqwIMbY@D>g*I zg|94J4%)ikd77&++sG^qd$H=!T>CVF9{5PK{TW8vPp^r*->k&w#1QtjUWoj}woJul zP^d=3g|Ww%#~+!=dh(F){9SPcXvG&qzisk)&qUfw(ky`u9Bs%-W7Iq`XQ^KrIBZSC zm&&iWBiL2N>V74!8$1M}k^8VrDamUei_}*qCdJmd(UPd^=0peszch*O7afhq4+^7- z=5vrwxm2QHM2bq@|HpqS$}-o$SD1<_n@nH!*UTITlOiN`3Kw z1+)A^tz>slb*adYT>Xdwu&Fu!8PbwgE)d4{Ldaj=SB-*muk2*f2Y{CK>>zGx3rakM zfb&mBpxuN>LJBP{ze)Vvwi@+&PG6=t{6|%x0X0*E=tqeRqQ!HjOl@M-P~;%H7D)rB z&w&bviYxCPCyDvjqUwM)D?wOJFDL`G zf6~XQxVpAT9l$hFu4y$66*M?&<;w29q&0Z99Ty9v&DxDV4!;OM*MNGhNyqE)NueYI z`vY(-MdZ~xRz}3CqZC!KF%vCYHBeoZmKGBj3V)7=!&z!0IE{y=-emo%rx3nsDh#EB zhbYCokhD2K|MFD?XbrCovE5P6%~>xx)G==2IN{iGu=^!8TVX6Rj1`LBWxw-D2zj#; zjk*!L3?Ac^U=Xz6Wz1-okym5}<+}eF#gFI9s*h^jK6J4ZqDjJgCka0yFj_m*VroRr zZ8$O&Q*$7lPj6b}V1#y3$PWDVjnAv$utH1@P>eX^oYJHU4U-&Cw}G=q zlpbxSwQ)S{WyaQs9E94B$afq? z{YVv0AJ!upNMgq=oPfokO|!#>bN*ir4L0-kmrqL5dPKh?*_ z48M}%dw3&_`VZvxb8C@`PP|Fe7P>yZRI$K;bl}uzx#Ls2|4`qX6dW>Hqt?g@b9aHt z$-sBY;LcAs#PW;^gNER9OgGiMAG3XFP_K9cmh$(s&_Vu~(#=7RNpsWtBEelt&BY)m zX^MogL37M+Jj)l}hP#AqC!5Vxg_9T&{eUT3z=w|R=ONnHsl6r&4;RivinV8qB?tqh zDmn(dEb@ajF^j11Qp7;D{^^z4XxmMm#d~B{KJpu%5TUykP8&nD z(6rHqJNwa1%|ZYY+P&YWI`1Z3<{B2&IsXmm3%m+BDeWoII02CDYFh0eV+17vxD|qmE1)iY032fv zxL&BnJ093>-f`2KZm*q%2wi((C!`K8Av=7AH1D(}Ua{d=biv~nEENl~fLGss#JBB{ zEK`q|ShO{_whAGm*ae-Qzw@A~&VD1U!25A?fC*BFspclB1Ja|H6t6H$=4LiT^Oj;* z5(+t?FnQjad#7LHq-#i&KnhSOKoBKdPx05;Ft_AFwvQG9BD~1dzS@r?#8!xr2HXKU zjCIRtc7}0=CMog30MVR73uVbc%Vn>Ty8tC-7*^+)_)M2;*q;~`q%j&dlCzwf)^CDa zVwa_BL#^Q!MRX(kqQjE#L$YxZgmgBy7vB78i>ALa#4^jo=qflru-CH(0rHa7XyBaM zZ1`n@cHmZOtHX~XYj#~oGSuN+_VlG(YdHLJhL@Ud^9m-M-!aQdJd4iPb9RnTtg*jR zk2sIIBJlnm7(ip0gmA(K!a~UX9LjSd;Mu1{3d=^bR8sP6y>E~6b~a&|zueh;!>{KyM#*xb` zGge2eH1q<|%2l_tOroJY*9zroTXV3U4a(xSj*=8aMHi$TQQ4G>k_E6A$rW7Q&!`8( z-$kQjP2)nlAi<0vC7(!W+#L20cIr0W2jlZsXbbjoQEeNk4TlpJ0_w$x*W|&bRMu2C zQ%6s5sHwOTub0ijkf)NUFBDNz88(V9_LIDk#$Ypv9QSv9GG1x@yE%b7Qc?=(B6gnk z(CU2p(AZgmZ$}!iS;-Qj#&Z!?1PfM}tKL+0Ql2?_5(--$74q%Au?SI`C6}Nb;Mka% zbm9GWOVrIu6N)+C0k5Rsn=7P%K9h>j#`FCj&qrrBPLEa@xGV}mk_G*?f9LSy^U&z@m@)=Vs9P?U5d z2_#11wc}=a7~1H=h_4&H^9W>O*>7biN)cW{?0hLp=wsy2*$AD3jy#TS* z0j6;E6xB6++11??NKN|rV*iIoYE8vwiu1AP?r%hf#VbiL8+~wu==h64@UtF&T|Ex% z@fuJb#vaJ|A;O(b_Els7 z^Hak@?E0=B;D^cX_9qdKst`Z_j2WkkK;|$ z($!imiM2k#373g_4BD+j)eoT#NJ&7(CR|>#>#Q0uEoWhMlCn@5WL`y1HzoIcKJ}MM zrmaWKqsnEpwhL6ewPdS1vwQn&vsDZC&X`T(;ueOAzBsJD&>ovnRkTHaQ;jtl8 zhW8h+36)VW{Td0AgRB-&m4z(+#HQz1Q1A^TVTpTxB?5Mx{v3+QuUbZfpc31*GNO)bSAP740f#_)Na{B(}#!^yt|pCBgys#NA5w_CY3Z1 zO&_%~FJYIGoPkU?B0SYl>Uq2UwvlaOhy+-?rTb4_)h0YFIlazD>SCV5-4z#QG|Xv~ zsGz!uhL;+>0rn~(|I_Pu5p#;=VBU5`8YFHsz;fc58Sdn69gMZwHJqZ!Z4B*d(uhY_ z6oKj$^`o2@#?y~A6L~h>d^I$EJo|Vi$in+_tVlp;c`j8p zFu=g$Sx^$1p5rMfA@<#6yGp>ueMRc$Y-wnU(gOaia&6&JU2Ljx#53?q7f1UJ=}GD4 zfcI(S!8U5+Hpr1JH%4REV_;7xq}^IxsYc=rLgic_3}#e)83hI9tE|-UxU5=*JFqud z1cDXl!O!72pn*nBpqk4-oa`LcGdEDC{RDJ$JZ@p^2ZPul_HEz~@E#*-Q6iF71Bn+9 zVSRUu7ALv3;^5m}3`3@HJYx9~dnm6{!22bD+K{NN&17A;VV!a)K6NF|jd6pDC}On? zi)D53lA&t6h1SJFDjKG7QoO?3v%Ts0p5BpQJN!LkC-CQib9lDa0dk=V>hU+HF=R<4 z*^ALi+D=u=M5Ybs~IHECd%?JED{Cgz%iMWrn3SwENJYPD^~b=z>=jD zW-JLlLCRavlvx*kKUv^}H;yPN#C|&rI-~CO^@(A$PG2V2FHWoE1p#LJl*Hd?QyJRMe~b6rU(5Q)6Iy0uh?k1%8OeYqU!X1c4ZgIU}<61S3d zYhUsxQz*ttlXB%=)Ac3Pw<4iIKpUJv>TgFzz0ViP6#Y1g8D4~JZObQBe0a*eFShwaeI@)evt^u*Ag0&zK;jQ0ujl|4byq24hQrv^MH^%^g%MHl%G zxCEcC{>6@uMVP1+^i`mLuHJLzR3#whcBDDG@^;01-#IY16fp zBlj^($xZ%Y!0YY|y1n&4MzPp0@9--{OvD7-aNgtY4>lo+4b$xYcSF}%BOyyEFL*DF zoOAdP0xUxZImbhsrzdU%pB!mAm;3C#>(W=*3s~*yjQ;!FYQs`W z?6d@Zn*!6Eqpf>Sbgk4@fIchyhXUv4tHuz`9~PPEabpfthW1_NL~3jhbS6~KeB@}V zc~s8o3{r*1$|cv3vzKKVhqNFY>*>H_bTi_LS~^2HhesZ}5kkd?hVtkYKnj%T;iG)z z`Mz$=Vw`Rnk#6A^>#>kupTPo(~ni@ z%F@|4GP(*fk{kYMz+i3b-EVX54O?|{ltGw1zhKlw(T`wGs-uUW^$E^(=YDnWaOs$~ zW07L1kf{aK!Gnh$>nyt36y)RCV$0P&h}7XBm35mugFW0zk}!=`iG2~RdvG3e992DK0_kR0N7s)NiXmxx?|8puX>?g zeJJo;>ll?R0xOFf<|eKhpo9z4Qw|7Ydy$6TFbZvux#{;%2X~;G?XxkzrL18KTOc>B zf~o8HhMPTa5GA}eYp0d{*4?p`>k614YT?|Kdx;)+uxj$Ei$a+K3GErph+3xDYgi3e zM3(^bedxJs0RO{TunJpmi^xl$kpkXpp$psib94D$UCG;uL}2vQM>$*S0U%_5-|B|km2OT`cuJ9haICyD z#pPWLSW%)X8qHw-5&&g7PnXL65%}Ba!@3yGh~brOtks;ZR~Z<)$h{z`ByX}j9;@+H zxr%5LC9%pK`st#q3@MV~5ZBcC)utrjPGdm)iSCa!Wb9%<&2UgZk<=Oa%Hbv^i%9|D zdI5T&DPZ!b71DoyGX+i$XHAtH{>g>!W=+o>7X?-%GGzu;{808$IKv9r>?(L20rp^> zRMUctp)c(W%n2F!@&!r1D?=2YbgZsG|789JTQEkpIn$WT*BSI!p;^rz%j_q5*RsE8 z*gO7Na3VfJ>_K8gm?=HfO2VFU(tA;64wwEaKOk};ZVaCxjlRAI{~Iw(Gj(#^NNJe9 zJ{a;no&R8VnUt?|G|JN&2?N;$p=x0@1r;)}OZ2620)7ZKid#U%VFDx-jYs7DPZT>0V=H>8Qw_WE*2RE=7=P=G4^Rx_(DErn&;Y0Q74{_0#a3!KZqw2|t z41n&-AM^%yYC&@IYXlV6>FF6{Q5RMbAs@e6r($l$e?do4)3^3G`Mq_%x$;T z8D@~pqrB-CLHVz^6mP_mA;Zv$7Y<#X0)R!k8=F)a;vin!Z-Nm5aMzF4)&zo2^aV}X zFu_k0t|pzs-IENS86vey7Y{e;KRgEahdslh#tS4OwGs)OzSm0R3vPKVw3&?gb+RGj zqAsfkX>$8}#)MU?R_H@WvxO0k`VD2%s!uiHR`>FDy3xw{14*i}i^UhQ_EWPUxPYHT z4^<)9qyASkCQ3=yW5LWwGl43HBppO4+{|@NXO&GdW~;*Q>XveZi<#T4P@NV*!k6X^ z7a>NgeYk9%!k=en)sWLwUzsDD6d9||p|II{=3h76bE4bH4^A1CerqD;?V|j^M)jiz zx{+O#cqyIRBJ}qjXk0>TQTa#0%K&VVe$2+%s)Xx2abn0VE}!cYA$Jrvc5#F&_CCs# zW)qi%MxAS{ZH|0J$6#)|xM)l@9;vnW#hKZ&;p`a9Lp@d@I=FJg3nEUb0#9nYqoDXQ zCEF{*?<3mB)nRQBq~bmzcGp0LA600SOC`hw{fbkP%mVe4L0x6wb$O2o0|2|HBs5?q z)#2Ls&BKi*RWmlCkUTF^5 zK%0hW5m)kUcr@e%cyhfg#%@ER>(Qy>T>7Y$N#YdBpBnd2$Ni9%hYvqq9?MG6O!%OX zub&pRm)cib+DxVm(g{K+H?!WbUUU&=M4wcm6+}9`%MCF2V{LGKR zxp4W<6C#6F&at3)?NkbgdFX*2iM}|GtU?|i2DU%!e`6W7e37U-KL9i|8@z@HENRkR z7$3zS(8;!yPAyt52R~%+$vAHd@uc!Zm(9TLEQ`_HDJLk$i*ER8`JReCntdAyiBPez zc;4L?_EKg7s;CK$824D1LEFV8gf-ptG^#_&XRam$l`UFX!03L^t(Ib0CyA^E#t>|) zY&9f+NPap>HOuIyv5mW1@h&F0r0Y>SOsy$ zd;3|WdVb#8q7GPDu&W}PN=s~8J45hUiswR*BK1@Fo-ihdUKtbSB*VzrXcU#rSx>Y* z5eorhdlWdO-k1`or4`7^6}e?|Ig^}}wz$CAv9bvE0iHBu8=jJYAX3NCh8@MPr2 z8p@;JT6DMW)ypWxj5Sw{QKR~!!@0e-%s%?dd#Ndam zLTxp8WfUMTVSO$hwW4Tk%dfJPkZc^%J(x0d@9_#P0>9AeIG|>^k_CWh@GNA^=rCly z@Z0l1Q-f6GgyX@+Aw%z{slFKpN5e!%&00tW&If>~qr2_x%IwK9eM|3d<^ixX#c)%9 z@j6v9w6*o&^K^Z2H+T8=X5_%{<;FBaZ>E2{R|&|Osky0VAUH``LtFl?Z_P4qabxMM zYn|-gq`gK@>A4F((OA*9L+|nFFPaJjW_B*ZyDvCL0< zO>c=Xyd!HM@a@giLDcv3di-|o>YEIWZwWx_f1BEW(#OIRu6xhPG4~}CW}>^dboJmL zF`KK4i8-yeKfJtHGPgkFejj=VV-j5E^%D4I6zI|U;Lq8YT0ePuC}|`9e2P{ts_1AP zr9U|VyT3fPcID}L^>LVPZB5gkLFedQd|jIQk=)kK8vb@B8-C)Ge$*dcCl{+5kP0~N z2~_3R{|Q9I@$mg2O99bmLe*suvu4NPBd>>RfsMH#3d zkKcnoTe^Dj3Fz+<`~jLHkLwRMxCGoMM@R4!>z`7uMbhKQ_$eL<$HefX==fnWME$mK z`=Ez-CcW&I$z2;-x}w`Td|%t5HO@WzyGrg}rat0hhiEx?{tl|hWeCMBOrO(x8m6NI zl|}#w%LK!(ZImkN873q^DjhxlPGlIOmp&499r=QhGv58+6_o>m1)+|2E?{a};QYuG z+8Qv$Kkw6-v0&Wr+{2K{<3a-BlxNWg>;WxSth7I4eh-Z0eLtvja3yaoU%nGAiv6Ze z$g53eg69d>Uy53W2cP4EN>gUVNGj~g&}sKoT;j%jM3h2L^q-cf8wBuxCzR%@-xL!{8N9H&^V{U=h{(*v=Dp$0)u?C;43eci5HRjv}7b?88 zM*?~0BUE8_JpNO_~)a9QVdF+A0ys(ZmoObqCw}_GGyl1!C?dSalcI*H*n4R z(|FsiHhvg9q^rYwXasce>#>PXjy%;l#ePg>QI1gmNp+f0n+Uv+h0DJ>4-VQ1`230Kaz;H!sUV3_$rXdtH&xi1qBe!okfG z6l|~g4c;J8$W|#7_UUy8durrj!|1KUa+_;1IqG$x6T=i1gweog9c#4i$cZ zl}hyvM8@GZELY&D)2LuORKp!hO9yIHxH#;U-f)6K&79Z)J}z+BU?qQk;uTVXm>UjE zVnQBud;C&q`FgBrIDyw1XS5Z+zTCQ68anBC9a>q%0C-M3S7>BB>g2C{ZvY$4)J*3; z4$I;@!$x>&7?MB-kn=LgKt;TxI}+r$C?dxCV}rn=`O{H%SM^_1)gk zu(`7Hlb^#9OkMIJ>P^*Gpk>hUAK@RCUHN!79%uB*B044Pl#|_VoQPqnSLK`<#6rLu znxHV(0z!qaGXyH#>5Yi1v&7aY?Jh$%GU%-6S*7v2?F@6gov)}c3i|YZ^TyTOI(+?b zDmFPxN0P6FrN|rYRX7=0O}}+WLEzuZVUG7^;eCTC!*qEGZa>T3yEA=;7t;m=JCKRL z2Eg4Dk(Dh*KsLr*hB8Q(G}-o>&s;I+E#e|e0j_X|Y;6N4%NG#3Y^y#MAy}OjXjYSz zi03mR^1#r8W{U3kY|5}Iev)KA)sgCL3!C+8%&61fRX!rTaCauH0#RU48dxJhAStaJ z-Ww_OL!m^pu0g5IZN~rh%n|5_KN-2Q7Jj@qH&n^ud%A#e`|}O-AH@O`kZxceyecM* z{q+{;U-<$g5D>+GNfQ1eM)-TTELc^~?wk|VyIb-jq=3Ik8LVR~B&oe3NttnIJvNuL zabqMFbKgrO(xznd>m83L&%WZ*9fap8GtJ5DgZ59eMW~N}m0_f66;_Pd`AhXtce683 zN5Ol}^$k^$sorTgep7i+@=?p31@E}E)V=Q4mwP2aB!ht(4d=~oiI<>pNY19AdJ}ggE?D6Jaf78(_dTu zr#x)IT>#z8kA(Ax)^L*xLu;3yL~M6Nw|F@b9ic3wj%w&(65Jw;Y=#6mdBYEB2E+8< z4qtCL(d*iK749f}vAnoA(7I6bV%9r-UcB0M&dr0tw{a4@0B|?$TV69Q@d(nQ*k!}? zhc$8-6>YnDm-sqpC30LcCj3tc4L4ufQ#~>pA^^_8W4BQxL}PmR`M#V%W>Ksip_(Fe z!N+&)a6!J()po_eoXm4?_)V!AJ0YlR&&o1BLGi-E8S7fhmgw1M;~CN9AB34;?+3Sf zA?tPJvx525n7oAfon8pzd)M0_*K*56seJp_J#$S2LWxva&xVfu(%aqIp2OD0{Z|Q& zUx2#S2mNXgrFOxO4;mjd7oC@w3s~&dJ~I%or(e4HFmJNCV)Xo8m{ZhtG>VL^xy`3e z7o5JVD52dFC%9bGwH-=Dw3$QHYOauT+BY^kFd{ATH&bh`9B$pRWQ@>jo}Cq%nS8%n z2bxWD5Lg?|sJY(6L#dkOG`WN=_eCpm@yeN+Ri8g& zPAS9C(L5O^@1pU<->%8|5h#f2Q~o~vI5&b0G}GRw@{87+kO_)&34?FssM26QK@-3{ z9xoPM;)gV2kwre^J$>wqVy3wRMu0HEFb~`(u@tNW&56fY!-AXFF;4qa5gdXB$m16_oS%j#vz@`ENQYq<4wr zH5^cHiYeBu+3FwQyvr%GTtfxWJ_a<(=5q}^k$`sGG8ui6Kv*_V9#;4r?@@a@!l_96 zCA=Af4y2Gd>Bu`r@}N#TW)I3w(uO^tP5@~yd>q`v&S(l6j2rKS=0R5g^J;8 z;xyy?dsg|$h=c2RAva9#eM}qam&~=b5<*eX1N@(O@K3>1q6!4mzz*C4|5vrt@Qkp7 z{ts8l34#A&!W)GR(m#qzHx_j)7!Z&n3=ojezlf1g%Zvw5l#!s5k{4IVQs4Ns!HMXD zkqbyA?WpanEh+?mG9uJzv`qhzPA;C=NEy#wR9H8dP7EG@e{|y}`5M1?4Wh+|Np3zp zXMa4YNHANUskQtax^7Pfc}vU>6DXs;2V}u83HT92_lC-$P$4`&*rFm-R?it<1+e=rm?3>Z+R77eO_wsv^~JRZ-O;pD*zI7e`) zdW(4AAne(=Lsnd>mJ*R=FB&FvI7PzJp)uLZcGuRu-jIoBc6`R!7t3>jXy{>E4eBi@ zlcLK3QwvVsTRkavH!~q0ciy8pf8o)4bZ+mv7ng5nvoyV2us9BT18V`w&LLcQ2~GOq ziNU=*?byOMprfzN#cn!N*%S%FZq6iqCD~*{KxrOX;oD3p!I!p;e6ch^cj{1E_5wiF!0t<0jMv!qR>toLT=C?!Vec?k=Ti9% zamjT*$G0Uy4(etE~=ANtZ@Xa zQ0#R36dWcQDn4MlTWim#Fnf+x5e>bVcG=X_sV6D$Py1^$&Aa~4zQ$+Z$iM!5;yhih z%{kV31Z+8|Ng>Vu8%ubsnAOB^9BgLq>1}@u7GYPEq~VaTtUG&n>PUI2ms&Zt?w5r~ zapUl0c(9JzsmJ7WDsB+@7L#Zd6Fexu{f{DXqmSYNWFMLM7D1&k{X^-&{MPH7YMofP z(ufU~Hk{gtdF+}Ey4_l8A(&z`{`{~w-fDfpB!|*(A)Q0Kw)va-R`-NmOI13eHU8anrxp4a8;Q8@yhQ9gv>daLNm=-bpknLMkY;=&q<7fRDN(^yc+a?L0SBKRQKk!1d z5T)fJSMqr9q5^QA@SuSS+J315Fk8~?>9f?1RMi$XNuF@A+rM$=o^(kPc=C&jbzO7b zFA_9SzK7?Q7Vo%hXVHB=crDz9m)Y3muw6FixcOEOb33R9vFpwacZMb+{L)8qZLKi< zeib_3wHoOCoH}Tmhqt=HUV$Ce`P1A7%u%o(-r9&m2eK7)P=Yq+tNz1;H}REf1gll) zF)-v^w`1c?Iy?n5uEJG3{_=ZZM1vUa3;aKE4(h++9EIAnW4GV~7~z6%p6L@|bNqG*MZfxI-B(04#)zZE$PMl6M8iZot-QJujvF1) z;BjOVVow4B@#r$%-!vPFvcWx&9h3s+EBE`@59|{vDc%_kaCv4wMM)GF+@&o%~(nv+LmR){NE|#e@g$wW`9SfzZGEpUkT*@TlC-dl0e9a z3zEq8my=)sjF#ZQNC~p{KW~r;y^PEtwCw-=4Km>y7&?KNi5g@|` zM04rn@}LfCDYv9&hv|uQ6wz9S=;nI1>YV2}pFckD&-e3ve?On^>-&AZ-k;O`YQ0R@ zKLXU(Yyea?C(4D{K$ISbQu%{hRKAd?^23xhs{MKazFkMTu8;Eh-AIMx5DPUWg3Qp^ z^>d<%Ag|=veW#Sv$Jzj}4UC|Ba(o?k>?H5X-#Z*PyhZO{#sW@()vq^NZd`3pOET7| zBNdfD5$ue)w}XphQT*Wn)pmO<><+A?o<8rynnLRlO>Cn3B%yu0l*|h+d+Szw2eRz9 zrd^!nVwxF-I%$eMp&8spVGOf zj;^_0V^yDWo3WO3TeDH!Z|Kf@z1Fxcfk?x>-oM?kV%j`~q3x0X%c=)4CfW>9ycAGe|NQ{x;}J8B==9x}4bE;D?J?6(|A=YJc$`=x<*f^x zbe*P4J@8Cmkn}Ai0y%D_w-&Dg}T&8ft>wj|=kml@7|ba@rJ+cPvfLearFK z^!5Y)TnLp?NjI&^DRw?HV-#&06ees?q;^pr;(X_zPaVF%`JfQ!+neS{IupMpuT{%4Ucn}Z#F^Kw_Go%kMCrqz~ds|jyL zS`+F}#n#XMEyudKrU$Sb3~+i+b7qH|4h6MfVKL$AhrTc3TqTipZ#r9%ObkZX!YT+ z0XlgLa@Nzg_EJPOa;>SHU`hA?vA25PElOrd=bJO#+nB|dy$9f9n6&RUp)wlzF>h^~ z?_FC26FGOI%o9Uzx)F;|je(nA7np753KdK1u%(a2%r=5SK&6B>^xtdhZb|1q5qdDp zqLzxiZ6)Z*PBOG-A-=}&!+^KQThRX?f_wB#LRiAIkvGJJ9db7fjqfn5-)~wYi-fy} z&JT7f1mDySh7P@&8M{?_x@wfHct$Z!tsP1_!YNMr!Ed+_jS$O-Gt#PC8!suUUPa8D zbGI7Fj!ey#rL4YFYg>{mvwyx}*(@%+r|^k#$TgfWM#Wh7FJzp2Z<|sUY@1*H(#vma zD|G@FFka&FWIn#BSx(w6!$7@7qFL7?Pb8?W=l{voo5_*y%}l7$p8Re9(VbNMlt<(v zAxC(TXE`+TBmJ;l47^7=f3vhL8$Wxo42gd38`GZqyh_ zv?OG|gDu*Hw`wtyVMFCvYOl!t#(e0YRO&urKXv8(^@P@p7Sc2v5&tX7Q}1F@6-jVn z>?51hP)b!drKWZy=)_T%$Dgklj7%?~40D2^xm8KNd2d!bJC7n^E9!p=o|aP3DuP@% z`AvMK_`Lu?NkjnW>^7Zrj2`JjEA%C74VRS>$;2ycBxlQNFOX5freOQH0qN4G=_oAT z>C!n~=vqPv4x!2jPB z?1*Hmv=&bzsDMp#Re^}+r-C`!E*1FDX`h7}42eQOY}CN@bZf9AiU9fNmvAu(3u*fj zvI*K?7y|`4p!=D0ondUDdJa;1#A>P$0N8o~07*3zzFOl+`4?hI6bv+qMyi^*Mk64- zHeY+dz?^6+RrVKUR`H!OYYwK-%|I=t#pl9*n+$(eRbu1GP}{HMO<*Qd|1 Date: Sat, 7 May 2022 23:23:27 -0400 Subject: [PATCH 26/85] added documentation --- dist/Verbex-1.0.0.win-amd64.zip | Bin 12709 -> 0 bytes ...n-amd64.zip => Verbex-1.0.2.win-amd64.zip} | Bin 27015 -> 27017 bytes dist/Verbex-1.0.3.win-amd64.zip | Bin 0 -> 27010 bytes html/verbex/index.html | 68 + html/verbex/verbex.html | 2290 +++++++++++++++++ setup.py | 4 +- 6 files changed, 2360 insertions(+), 2 deletions(-) delete mode 100644 dist/Verbex-1.0.0.win-amd64.zip rename dist/{Verbex-1.0.1.win-amd64.zip => Verbex-1.0.2.win-amd64.zip} (88%) create mode 100644 dist/Verbex-1.0.3.win-amd64.zip create mode 100644 html/verbex/index.html create mode 100644 html/verbex/verbex.html diff --git a/dist/Verbex-1.0.0.win-amd64.zip b/dist/Verbex-1.0.0.win-amd64.zip deleted file mode 100644 index 0c3fa53a91fc9e507568fbaef876937471fe0957..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 12709 zcmbt*Wmud`)-CSt?gV#tZ`|G8T?4`039iB2gL@!2!QI`RKybTc&disYbLY#PduR7k z-Swktt*ZT&ytQk!f;1=?8qiNuDlS&}TjuXyFmJyK9xfL4b}USc3=02iIfQ>HCu3>! zo3eQSS6OFE7gIV1Lt|@0b5rNv)Fk~6HQh{|j7;5s1Hknk0Mz~lK*vPSNY6;;;K4%A z#7J*yZcb-uXJ-E!Scd-q`}cO~>pOTD8yZ`f>g)dx7!*)lK98%4`1 zxI{pKi6p`DP;go}xdZUY%MB`_6)R4)7%ka+fFzR~DSeu|K!R{7V>mkQkjXdq5is@K zSR1rLlDQM5LEw)IlyTE;`I8H4B+ToCh1^Nqx0;-pWZ9EIT4OxR+HeFUGgq2eA6d%Y8S|X>veMECMMsg!2t6r7tf0r%5BMvFIrm=_ZC{)Sv>MbwTD84!QU_OhF8KFBpVQ*H_E!d`_L}Ta-gDwMT&ovcqC-*L%Z0#^45x07(_dZ6<{+=PtdJ{+;p2^^_{~S0 zsLD{QWH{K-i8Qh22=2wu=U+rW0|^630d&>#tP4)ch_l0U5I0yS>tL{J!VjT2PT+$4 zW=z8*%_JPRyvG)@@QRfO&FQrn@d5{z`jGIuBm%GrO<0|IvP*0NYnnk&@c>Aj#1#cd zVuPE&T%ohfRuIVj&M#pcJlfE0Vm4bMEW~vPDcm*Nl@RNQeo7%|I?v?I%MK8MP13?r zlkC&1;n3qW-Q+vIk1$v66d&)32k7Q_C}h6L24CJNWy<90V0AyXB!LF(@uJ#=5X<|` zQ};^)9LfQ4@S@Ps(NeH3GJ=L?o;1rI=SUazG@L|9JOuM;q_?=2;HU=WX@nA& zL=8Wozodn4$@wZgl6lGA1I}J?b0h0C_O444SfhRA0Cs#CDA zX$8W{4By9;O4Yi0RKlD#enCd?sS!nr|&uBbPkOr*vz3C^F_lamIp};7}*F@&?+KEAzo5R zDvatlH`y(qlF_{3v>bwa{}lGgHtyb9mL23Wr!&ne4euwH0D~3WK z>;Y@y!I;Z^;Zu}3?a|OM>kJ!}q~M>rrFZ^JHsD#u*-B$gO7pD7#EHfWY#2bxe1fZ3llK>Y|5d zY2ttzmoTj%?baeFpDZH2y!##vi(oM|*|~xu#|c|5j5%(TGYFjKQMrZ^&r7jx@oahf z#onj-vGo!0bvC18o(Nt=g)hpnnuOnu|LXD^2}AM8tg*3eR*Nk5T8+S6(+buK}Dz|VB>;GJN=qgrmpIt7CoT4 zsb*=+y8t~fc0pX3>iP7*p8Ho}EGSm!q^q>Nl1L z*lKug`Sp^{Z2TYyCloFl9Nt-vba>0c#gUeTK*s-WZJC}wEG20D5nSGDO906|sor$!a z7G9&6nrnrQUw*X%2T{(=X04$-UmycWT(4%bNv*wXK|8O!DvS_x7)>FSBfM*!%d~cXU7>(lrEJEgG$@A6^07= zDB%(Vhfb?)tM8RV*+P}u!pfCmNByB8^Zkn%YR1+g&kV$wjnO;7j~vPf&xgw%`jEpu)n)h+?+Lk(X5)Q#jkL~qy zOFFjU0^Ta(J?0NcQut8b!H_ddnXs|~9HV;j9M?ls*@$Npn)n&sX)RRAKTuN7;E&UI zR>gsy+M*4LP|h}`171a>$B0+KlbiP~{|RFJ_1XD(%d9J~s!i*u`Kf zoa8!-egUrM&3YUfB#8)ps;8SXoK?PEzM_lDqX;sxLC745DevISXN2Dl{RYg=e_Rmz zbQ%2s#kO5?{)|E0xdT;pZ;z#pRw{e{$h&l+=n|wx$zQyCp!Z-gR=zm`C!Soo*%yc^} zO5BGb-7*kSyfAsmhu&H_p$_-|bO%ax*N3CzKw>WX(tNW2eo1P?nqMQ*I>%GT?a@;p z5oVn#fgwE<1>nPWN(LS?`QWC!9QY>rNl`wI@J*mU_84B%S z&Y=rY0fPtc*o^^Y<3c8bgWN;C%Gi^6(5FePgKuUd*TPNECP;1aD`5bUBxoj?jpqpx zEsea;ene)AKt9uG#Klu`x{O@$;p^BlO5B53?`~L&Y)^ul3p+7>6!#`Gla_Z^8*XRU+ z@*bPQ`;gk7cV%CJoNuMTqKal2;nYjgOvt)Vl7V4T`!^Y(38d>hDIOsqrNz1lIRQps zj(bWHBLUqnW4xUlw!Rl(L3;#88WvSoZ6$Oe`WH7ta{b7wa&kmOLt7kr>V{~O(a7!R zqVJ7@J4&r8v&j}~XpJ7FNk6tc9-yCxc@K*utZ89HG46fYq21~s@!1B5M{2?HuQumQ z38Ai=)!$&c5I?6QRS(?Vfo_JJ%X?rw`t(>?LeS)%R=xuNI-ubf6|2nUVyOwf9n1pW z68&F0py}&d+F82j>%Se*q-nm5t4`2J(@9BHDh!U$4Kh$GI*dusI*m!v(yK|(0vz01 zraqUz(@V&X$&3J(f|LTbjMNDsHi46bHQIIl>9F|os4v!I`09fJ1Vs7PAhEyNmS2b1 zzaJcp9sU*}pnD4uytUAHR$JErZ@_VFarvLq+wAY42EY4>#^kunT~N&*cC z6p5T(i2l|NqATuwTk#^FFef41ax8wI<0sD77}8Lu3aQisVmWd-yk$w%vdcs%g3H7u zDOCcc(g;FjFPQjx_q)|Pr+`7M?iC-w&6~iHA66SCOM%(#-G&~ zVH#}v*(bTR@yp<`MM$#C?W#{1-Dccyc&vN+9c)u-%Gr&gX54VwtUaUn8an#dmiUeJ zZ98l9>(9&i6?qKs{Ji2Y4jSLHikNG<#o`-0*qJJ>R$_%}#2{26Z!<0fntEPIZC=5H z&vJOy6%XXpG^7O=6&2ZK-U}_#Yu=D0Mop|L)Mnu8NMp%QZo3e!B9h_-rc)dMmvD8( zD<}tJVFw>y3R*2$CHHX()^=@5 zy{Ow30tGyuMD0~B7pFCM*Myu0cux?@>L=-bh8W%$g@ELm$Y&T}7ZN}^;W|n35 zW72Elg$yR9_VKyX?mhK3cO03IY0j3ZmNDyl)+pUPjTD4daIMVKtLeCBRgrqD&B~8) z98J*Pr^AnbQESX`!?j<~E9@V+WTsi~wKIToow{cG*s*(0RqPTdR7^G24iQ_BgjcNf zuEx^;9_%Tzr<4f}Ti%k2KvOyMQ*mP=oA8h6cfZg1q2(S+Dcb!!*j5veUX(AD5 z;b|`qt*(j`p<^kT>M#T>{NY`fd*_z!vKc;nzU^@|2?<0nRt!}cXdod-wiH#&K9N{F zQ7q=7@XU<8fsI1~kb=T=@S$Z54K7s`aGEEoL=BYnTDl43>G3qP(cEb2y{n>ov!1eV z>GhUM#Wv|rqO3;y3r~^~a+{w^PO!z4AypLTl&PO65wgFt0DH4FwRG~_ai|+zAi~gf zg1|79t*Zk)VYyYao0H!SCr1v>>vZ%B-fkU?!n)Y(NnBff$N0pAi+btN&gp9|D5~0uxF^z(Xn9 zeb|_Y3(*gDuUxN6tEzWYeyz4^>XIVXt)Qx+|DfMX3T6ynX<}rB*uY|jCmh2gyZz(4 z5Y|otD5)lrEigl;`c%QTi7_})b`EzYC4(62=kZ4;hXvSptXvfYh|;Yp22 zGsmKsera6zJbVnA>)XQ2Qa0`;M?pr9ZK0Z@m~}~?{O!TaQ zU%Oqp!K}%K>-CEvcw*n8WX(xc#<5LF)yJDBa(rx3GCb2Q1h210Str&9HC!QA?t@z| zl_(#%4gG*bY5lEi-Y^damZU|-V=^*61Fn~JcYM80>@3rqwFeZzOvun8>!rDtF zRv8dd6is_t%(VpB&nkYE^8o5|vr^kPo?BzBH-Lrg4Zx15V7Bly0LOMG^rR7?UW=wJ zr8!BYjKrQQY8BkH2YRUIv_rlw6(>3Z@L5pT4J#j-6MaG-`|NV_fTYRJCMQvM@iogFS>v z!5}k+TN;Uab%k07*lb8k3tx2Jc1AVRaB_UOjzJN)eUMJLLUm@@-hcPh`*a8Uw5w-! z1wxiBa*7>qrY!w6`zd&0uiKmL@J=m#1`>e_7AG;63kk4x-jgKKS4M&~s#GFkr+{^U zf-|PLs_VwdX_diWfN_nl{aJee<1Rp#wkpB;cxRA%h~E$4dx`>4LCeYvx zWaAXx;V>z9_xlNkpfO&X0SZrx_}JAZrYjh-(NiWcQo5~!`-nxmqiu5rIXT&OMjob@ zh;;!D0e&8PxonOaIHUYh%pOR7bc9(|*&^b5c$EZy1=*>%2!l+G*ZW|J&SEYzUEd}b z-x?Un&g@n)4E`7Y4d3yQjCuxitM%d;xl`k%OfuDV3P41mW=LU|M~WzCs;Iq@iDpbP zsCQ5?zmyQqRZfOSa&8pDQ~>39aimL_UFaq7NihASt_zrTj-5gx?ewb4M_MWaNjG~p zhRO-tA3(Fa8p|fbfj?qxxX7dtrb%l}+Gx3?vJ=U9M2BRx3IEk z|FG1omA-L~;3t&^m<)*@h?@@CXC?%gHk!R-#P)Oel#ZUj3t~KeT zn&oKaIO_Kw>+AF{-8(X6+3qb{(wT{1?80R!*mcoWQFDj z$xe*mnJPDUOMYxd5lgHmic@xOU92a}2cLv50EY0an6IeC_7lTfrBIb{AHcQnLsvjL zU|LXP+W@kI(ZXlk4Mgwb&%m{JE;$^y=^~)rB~Kz`dfns;;E@|FG%zx)W;HE&kkyN0 z?07z>ZZiWS{9)?OK(4(Y<#)E7o&CE!PwtoI4(@b)f02T8O7Ajvkt121Whmnp59t z@2Sw-;3+>*MTHuWMr`YW)%KcL+(mhZ4Oi{+`v@JR!l}`K9lE2AHuZ?cqDz>w#+9!J z5CJy1u%YDn-`PlbbEpGd`l{Aa5#ha0LzHXoyPsD^1VRdSXZHlb+Af$#rZm^7+*Si@ zp;uCRR%XjHesJVrnx6WfZK>g$LzeAIr2s)XN4U=|jT1Fi*JC!3e1Js1Z8mLdHiS-v zv_p%nUTAKCs;lVO4eui_O3BpfP&!?3!+C$*3TkU`&w(>20|-DeWi3Nn=T_NI(q=3~ z=-Wv}qk+*c2gwKF(724y2<*%W8`QCIN^z~OPQxgC4KmoW^P<|? zV`!2956dvAqQbp_4v3cMq9wkC{sB7z>cwvV5<(44b1YBHWf?B{x%aH_laEr#L?_AO z!5AA`F#U^fhKFQ*$qm~IHR|%GC*~t75&*~EH1X;qT2%MB-Q=G)}jh5pEB=Of+JoA}K5=3J{AFChSAu!!YQtAQpTqDb3R*88qnjnl@+8;w4>= zQ=_27b9_s7Q%eN}PiqdMToW>2qeq_5Le553nRweAvGEzPD@jrl(Ssej5N&A{~ct8S?iYHA06Ds2uh40t7NW4)Qvb6D427h+JJeusS}gDihBtkTx{4X9?MK zA+kZOPX~N1&%OAH(UK|Ht_4EcJECm(<=me+^^^|%dUl#p;x)1$_45l1cMM*ti58~J zz}^YkMR~q!64`N**rvT0*cZx^b7t6)N2B02M&ts4o|Mls*5}Q^G^)hs+*`9aIH%2k=Og8e&Ttm=WoGM zfO@h610N`5148?3^Lb9gaP~-zUyfUJh8sT$)ulm*InE%xFXm<0IPyKI2eGYz@Uc`g z3u%-*x;da~6e5+9$$t&bJT4B6d4V(Sf#=!dwsJ^%cT?hS`{f`VK4;{$QGr08A)$-%QsLR)>Vohst(TRf8T}I%% zxDx9Rhg-4gft3DsUNjZ@6qQB>0B`uv4LQuZ0=e-slBox@hjdNo#UD2Eo`cri?>Juf zyu{8tVSW5w5V(K5+eS#9!<)e2jdAvcG3nOJUYnrGQFZ;4!Kq1rLvX=foMH97nQ>M3 z>kuiT1!Qa}si@s5+$~#^bn4c%HptDqHV_2ri(`LeH3+WXeE6FCH83nO-Z+rXQ{COS zSTGv3L)2w?!HGE*o#uH2%q6*|!v3D%J;bK2X`hox9reiU>!DL3H;G=O&}H2&+2x{* z?G^>ZTX=wCOT`g1g)gqEg7u39>>#atHS@6834!{^-F`4m3`EIy1~(xqg>Gc4W!ADS zp1UOn3O!rbilhcCm(=kPyG;doSsQYq*)?fcZyEMiH&_Sh5$&%m0NlB4m1@24IJRsKAN3H=2;qIM?=(Js zQ^-2CrA%P6Zs>J4A?aaDqFe)$MYBbeP=!NNEWx+*arbTT96_tVB=Z7~ZxSiQK8T#_ zr;J-;(v~Bcf|yW{)X@l) zp59xoj?k6Rpc=BxiJ;-2_y00=)K88)(iEZI(g#*O$1GZlI7CCgpN$^5-A1M{`aT+4 zIDTa6h(mauJuxybM8nlS<9nq4sK#+OQx(d2&o!EMEdkd&WFVb?_05(CQW&#wl(%2V zhPBj+kSqH_{MGvp4tk-@DkqP2#OEm5AuX4mE35~`vOL^i*B*uA{VLA^UZGPlsxP$e zF$Lb=<1U{BFJo$M@~bXm*e>ea3n=HxpW>%>mnHzTUnoBLnf8FF5*b3`W_;xj=1qA& z$zf2m%?avD(8UOVd_2o%4Gmj6q&YsC%>!as5qO-X$13vUn$~=J92EV*_DJq7G@6X{ zoP(OL)bqF)5Y&1%=qE*@Fn?FQsy^;i0szK&jiSEEC^1?#qQ;o{K2IoG_>zlSC0joI zY7SJUUd1+BP62Y^(*f&#AFGOr^>}L$VrNgIsj_?}x<`;T2!^}_uL>Xopk=pY^>sMF z)@aoK|Aj8SN~WTJjdJ)SdqoM(&O~MEVT%%$QP2|yW>D}Ouhm1B4rIe zRV;W^V)A%1T1g!H=BIus?ZuO*aFPb_qgpiQ=rTB(t$G#Uja+XLg@UFVbp_!tBgsv> zttS8Iq&>W?m?9(unP^WcBC@6G|iyxF|0 z$_49GdLYVGaUA`4PPOH99ZzJ04jQeEUc4E?b2nv@HXvmvN6#U0DN*CqQMC$D%6}0y&bHW0RHJj?S^Spqd)W#Z^UV|_O}q0 zYX`AI60+uj@8CeYRuAl7>yFr*pc6M_lc=3x2r*F^IFnSoT~89_sd2#*`0Bu*I#l<^ zqf0Nh0v_%S3-3)1Lc!IFHj2HWSwDntj}?be7|KPcPP>YI>Nk3HNVwoh^_mc)x%|F{ zSnfo}wX{|fGyjN_b$!iWi?7J7o{W2=-)1G8v`KtpTn&A^^NpLUMXm}0_2gr#5cX#j zL09S^rviA>b|2}C8Y0^UPEMzj4PR)1htGE+xDjSI3&NI$yS>7t3(E!;oI7=KEl?bo zpX;0M*N9aFmF>d9%y5b#u-8VLsVX;$I#AkO4O`&Gds6W$mTlu<#1q!KAC;NbGxXD8;dtwagdq9K^ieaK#dl<@ zQMAhzzRJ?z0K`bjHsBCNkpqrIq+39PPRgrwKV_r6XKOQLL~16}kcv>SfarVKr@YBD z9Gq9|BnO!fXlUF`rb)WUK~1w+NU9Yftn^CQcHVzS(IzhEzY-fUj4Zv(Z4%)s#@4Lp zCN|Qs;lr>O7+G@(iVBOWcnzq)?(w2-wkC-w$uFm?Y1Eoma)n{|9+_`V&~fP2DA~7$ zhI^QOTruua`RbICto2#y%S=+OY+>H%u`XA#i#G+%b|8KJ&;w%r10v7yK&wv{s)dyc z`2?j*J2#8(;-}1J#_u5>FI#uu-z`A~#85j!Y*}2-X0UJ7K<~q02fHEZ4Fj6M18~9M zW!Ab2!X;r7*kry04Yj2{fxIIrdWLz|88pOTd`Xk)g^$|aJ>m?p;3bgO648c)cybgT|{@_-_ zaJp)ZEXz#cYFxoBL@U`BK`zuJqpCX@hc;gG^hkKe`R*O70$`jqr+w&LxUF)sfznpI zTimC_CN0Re#TPZsX6`S~s^5k761OwOF{#c%?z|HkT6_4u8`!|=vG$?!I!dN&hvN@S zB;N*WnZkwWV|*O)f2e^OSG*&7=e{3k-vib(dG97Ou@AnEygAB{FL1P#tZM3oskV`3 zU_j8z+r{7<_|c^|MSKgD^!sj{g8h>PiH62z{SQc4mYZNUAo8N!T?ONS@ENh}r;)S` z7FAv#HJ$c_bfrtO{5|L}1$^S*9VkWLTGBXm`8Y5B6iSOU(U1~Jg=T+ZrNRA1OawHy zQ!IjaJcEM59=N_N*ABOPyn?W?yW{{J4}{-416pF-Tj`@6eF zKmk^pmj&;Lo>PJ08G&m+kua@+!qGy|`td?^`Y8bbqzvdmvj`)Qx-@^AJxVj84DwW= zgllqAg_d{QbaMMqy(Igedbf;-LV22r*tl4jAju$hYJ&?g$P3l(ENfScXh2ya1slD4h;1VRrEvt(-lAh#5^Na$9+$%6+30`fu12q{ZnZvj_-F$vrA2 zwhuToDWc>yrM*xgXjBqG*3s(`1C>wSeTk{=Av#YI_LMLT*A9@HX`u8x{Hio9T`%}J z7LQAW0JXXaQyXX>9kR4Qhjvf`!k>oYCGE$s6P4FAuORpORqF^YD(Cu(vt>MMcat}A z3V?ik#!7~tsCxsGC7Rnt;~9GaQqT#_EyQBVxvLg3??-<(-~#6>;mn2TL(4q!ye*Eh zLNGF|SR}|E;5G}m_Jnk>gao$5GWrMd&ItwK{6c+)82VT5NVOKIxx5`+aDj?VFGaf^ z17fME7}!+P$W=}_=J2d&Wh&mPGj&Aya>nMQL2hdy+6#N`0xI4e=Tw(WHXioW@w!>k z5s3sbXia?y#jM)*#&&zMSBQ59EaqTkWN~X@Y3D8@UO1gZ@ql;HgfDZ2uDGTwBpdkKXQkXwz5IQucAP=| zf4VpOIh8qllbSxh4VkUCB>LYB9c6h{B@r>@pX1XuMhGE*5lQT}19leIsw|M?I=%-_LK#YrskFqgz__o>@JHED*ydU3 zN0X0Dq+@80{48g@JIkZo+j&;Lem3uQhfG@UM_E6(;H**wu$?i#Bz13m-3nr#q?*L* z;zR|~tENr*$SV5rp{{d4+5Jy*C4%P_8TzfGkZ%d_-*ni;-a+5S)Xmi9XP5uDI^6g< zF@ZtQfc|&c?;GQrApyPqoTvY!Nc~;CpEBS->}Ng7x9q#CsqxmT#{=VGdX{ssKyuL1wj__y2Qe@6ayx8uK% z^%4J~KmO;g{GYM^-EH?T?Bl|4jMk_m5wcBk%rVcYaa+Z*L=iCjIl4{)_aC z;`gM#9lHN+ga0%2pZE7))H-jg!S9CiZ>j&W+y9yF&wIizx)kdFg6^Moh(9y_c~Snw j81^RI|Nrjbzbw%T(%=w3aS`7>>EJ*>*FXOf0Q7$V*5Ma% diff --git a/dist/Verbex-1.0.1.win-amd64.zip b/dist/Verbex-1.0.2.win-amd64.zip similarity index 88% rename from dist/Verbex-1.0.1.win-amd64.zip rename to dist/Verbex-1.0.2.win-amd64.zip index 55088e92eca8c181efa4d5880dcda14826c639fd..f7a260975d7feda6972cb000aae92ba03f975d77 100644 GIT binary patch delta 1418 zcmYk6dpOf;9KelS$`}cAtJE|1xy)s9i=1SHjpjCTnc5biMTKhOWXH*NvMF;(M_Fm^ zOlKk~45zszgjR+W%B|2UoS&ZOJm+Wvm-=d zJGK1&u}(ypD}yNvK>&TFP#8t8vAU_6T_U|2xfjPJjVk2db1UQ;Fl>rTYTEMmNi&w; zEu423GunD2gB+oHgr5HRX#x6nUu|K~&}Q0bJWO^G;RH@U>o1ZZnzbiE%TH66Tz(+H zZeCc6$Iupi8<$S;1wox#U|*nB8mT3zqTlv6P}IpK$qad%(RMtWSsSWC>2fUR2fOU? zh>o^&XQYkQq9%`GyL?Pwo)48G79kcZ(f;T!_TjkH5``Gq{(=l}KDouR%qoQZ?bB1F zp2+y`+q94U4cKB|K@h}giE+jjTU)bDDQF;Fce*s9!~+%sam(=uK3;t%#;PoNu_o#f z!jU(wvHo0C;Xl<|hk{ZHm%!{|sf*Aeudu66(dM3+Wis)J8%sYv4}UhdRm+;tK3gJ@ zJ8uqcdEal?^dP$8UQT#0#r8=W!~kOnYSmM9z@_+vxlD;0AtM>Vs=LD5Pk;zV)fCt- zF!f2v^s4V`MjPwm>j#S<;?LsiPl_N19KP;hwNhE0SU=THD_;uU9i^ks}=YQ9CfbNX*M^;$0q#&u;BRjIkE_>57A-F*%eL z`Wa&Gdx9I2f;V|7=)1zpQorHuds7`+Kw8R27<|GAS&Ww#*C)QQ3|d}YwI>(_+Ke>) z9&k9ugT4=G5dc5J$lk0ngE-t-0If@H+OE#`*aqG3R#_NL)E|3G^&^?6yexaY(j^q? zz^cIM`NJ)^f#f1aziTDfkZ(43B867Zxww2rv57;u@i4lNyhdzLPDDEBpYCnuB$)Z+PtYS@bPs#Xar)4F&Y9ZLxC;d%c za}M?5&+(`BTFub+o}!(BwmhcpEdErX`F4k?#jH~;y+Lr7?s@)w&4b8myYA9Q5L_sy z#}9FRBt|W6gjKQ)O^+SmyXm~Dy(>UsGF)&|It|O>1VZy^?w@`O72Jt8!3J2lgyfNE zCOKT6(p)~<@E17t!>VJV2-v|5lkQ*TvS*$-X|F3BY~nO#&ot9xWsqH7FK7nS1+1ar zgR$e^@FRQ zpPy-C@A?X=Jd-l{;neKcLL1^Wr^~VR_V_u?0zI1DJn`1<7;;~zY9uXirFvoF-C^f$ ze4mXq*cs{j=t4-fY1Q;b2uZg7JZ(;T3Z6VRo?3ue%Hwgh;F3bx4G1mxMD&)>_$SE#4-gUnRuZu>b%7 delta 1386 zcmYk6dpOez7{|>u*^mz5Ou}*P#N#dwrL=>Tk&#_;+1TWoGn6n#r-=^XCu!;AHnb>X zb<9{4bEhHq5;;-Y`8m&Xo~QSZ&-Z=a@B8;BZ2*!w0FgtUmXQ2GYJ@9EcgLz5p{t!EKC+x zS?(3XRWr&01Xwfhu87m6{KTnlsHT@nZ3Z5~utI1snjWHnWsqYJfYSQS;qM%~v%AzC)rLV^O*?tJ)5GubuXu79*LoUQw+K|8=dXHj~B( zj5keI2usOYU&|+ER2MQyk^{->=#oo{67AiA3RF3aku09Bp9MU_?NeFMspO#@HC;nP z&7E^n#%o+=-B2BIfB<)ZvPgx}qMOVgSxiK2e`qG^P4Dkq$ynmEQAM8Jz6uVjIhSmF zYM7FWz5~~^<|_h9U3J405V`K?3$?{z7LVdrxrBN%`?`6xov!H&Z((1piz;>%N-vTq zfSHt;y!1E7r?;Ra>KYR$S3WJ6LC;E-*tEe7o9K2>=_pIv)L}|Y)$3d(x5e5njLpe3 znyjkT!>Q4+tJ_N2eUpiuR)dT}vBSo4b^bLZgWH*mo`K&I1kdlRt@NdST}x`JwnvEe*@?qut<8KDZbXyS$JsE6$(h0TizDS+t-PxG zlB$fc|Fjc-KsG-6sr>3E4 z#O{Jg1SfzgP@^V7cI-|0rSI=z=nZX?Qe!q6PaD?t=LCoNKdjgDbP4 zuroWtv705JY|k`=4&Psz66>Wi-H=bBhxI49i6z3@0myar%c1DLb7t}FRa&i|gBru0 zFuiZPJM{kU^Rzz}hF(5sVqLsUeM|0Tplv$p<{%+0=k;A3sA?xV$}9*0osxaio7*!T zatf3wC!Jd1p@-bRcs+BTJxxZQS)2xdSXjbBl*DGfG1zUVC=Bad#wlFm`6!n&vH5#T8IhtQ8iOf9M&qHX8)Rc5v zdr%!QLJjuEEiy5Q#40?u@`N?>25o?n+Cz>XjReU4`jlgj-?N`XBi?P=$4nEs;h5o& z^6M=6!V3so1oLZTaIzP;>B}*Q}PW+ zDlYamt8!N*-FhKYFEF$`B6Fg1;l(`zO}?i|jNqQsA2! zvJg#n1jS4BZ(5Y`ebk&6YG6WV6Rut_g7Y`AI)GhqSs6C=!Iwqg{C*LS|9WukX!t9Y z#IL`Q;&?-rR%g^>Ciu4YBf>(CQHwhBeZXXE*Ue;FTVeP`)#Qj$@>-og?n2KjyI=m| ziu$lzJ7(iqGsL=NCcTdJ;}LN|#%#GVKgk<*gpj*s*rrzJ@#$LX7c6Id+co`;ME0Xt zM9z}vWt)#S^qbWGw%Q|x19$n)<`cMdZr9S3iUI5i-H1OjS^5P$9p)L`u`B1W1?rIXQ6ZOWT9tbq&GD; zr?a#(v;Ti&p@8^`%2bnhW@mvJfq-tKfPm=!8(9fOSvMAaSt$`Qc@;5w7Y~;aUmfR7 z_0*fL%D)7PJ`Jj3G>(fovSWG`g{IsmmRgIFPFsFFhz(SRa3Hw4#SVU7TDzTBu#(gj zo?I0fRx%*ZzrC+r`-rC8em<@roS!#8o%~q3#%l%ox-_%R|NcBqZNA+vX?u z{I>sU{Z^Z4qM3b#WB7F6?)351=kmO{S%Ci5z24}atPS(tVCtIJv%KcjSvW6)b30b= z3A0#f9+Su+0*ADEmsm5~o$NdV`f*V!_XmVY80_3)F*!Esckp&LcnZH`^ zcRm!jjoc#@)XnuRJkGtbZ?cO_^`p&ThhO8{Qi;crfN_HpPwm*AgSqaW=n0g#e*axJ z-R|m)$MME|U@yzt_K@NJ@lfc5*di~FN{C;I$P8oG@AH$RsR8!kn5S`ZtkF3o;|qNv zmIdL_EV=5kIkTV&`i9j5GT@gD|4W+7$?vtViGK@*0dJ(!3(opxrh;_7u&OsCF?Ct9 z1MMI=uTFm(fEZ79=ig_F`B>m@gE?6@6HoV;nKroVfhC@CkYA+28k0DjCZSzjr^EX`p zxXiO?hI2#gMa_JK+kAq(9{J_a4q;U zBTfTkh9v>}3%4gKj5zTbX#S(!Ey#}Q&M<|$YWwjXDHwYmUh&Io_u>S=pv$V6ToD$3 z_0}>l)uZz){78$))0?~jP0mr{O&mzd3PMdjj8?mIQ29#OSltb+`FNA{9n;}zq2r)A zWu90ztEo62!$And8(zi5uie>7p-x2VhI3H$&|5u;?_M~*kUohp*VwqTv0jsA#y)eJ zGK${_!}(d=MSUwkVGW0=WHp*7_;0Fj8xy}!Y_{QJ&?Y0h7sGeXpXgZjmvi~~BgYjT zPNN_QfaZ8=ZuokWLR+-{A4@pXC-pwul7Os0KgebG&C_;l4G)j}+J&o{7 zlYE~OG<|2B6}uPf#Kp<)WFvzo@Lp-5Mf`z?Otgl`$@_GWE~ls6P5F=T_5-dP4LiE(X@WQKP$Ma!|vK6n(}=mHQ+S%t9t;;j5v7 z@O6O5iL3^NPTr^`v=qRs#CQ}j&XtsN8-Xsyc2`SUX}cL~$78eJ`GY^XO11h1M|NMU zq3{wrUi2m2HwlfIz&N6MqXI;u<&xA=KN=IS98@AyciclE5I|ceno_0aeuRbpMQgIDt!N5T#GRSY3&$o zfR&f`f#k9qU){t6Q2~*l66y*&l~3_A#JOAzQ>U3s&#T8~73V-*I5?54CNV7@W?sl? zK~&X?Bmo&f(kwP?x}AFFB^O0+2|ZY9eMv}vGe9`w#MN9cV#3q70ahZ%MC;v9Fg{Q0 zL=T}1i1zaOgTFgb&?|Q$gNSrhnn~=G^SES5>uYMCcVX42stypU`L)RuQuS zftDpOO5K|}#?w>98_l`~LbtIDDbWSrr!XRxE#sUyL69Va;UulmM+WkQ2XYvpSx6)iwF9Yh1X!-1(_bhp^V+%1>kMraBf7nfpb+9f{`3GN@jbi<3bk3d z92;CMm{!m2`)LnLZs(}`79z9<>biImQ) zU7yYwv$Wf$$EvB9sIHNf;~L)YFRb$}HLa=E&e0?KMPZZ%%eTgu2EV`6uJb-^CEfnq zNIJgPPTaX`5p`9GwMCP8YFANA@;W6uSb&VX=u&E@aMJBgu+DJ(g1d3er~vmPcIFM^ z^?kxuTj$hR2h`;m60a2=nuy0MI4$-$O95YT-04C>QIkD`}&sLvwuN@kOg&xQB1f{+Y=ikhP()@l#;ltTp?kgj)u zPnO0G@vD|5=X2|y^a{0hq-75M)byfzOK{K{#v>j334kg7ahxhx(}XDo27pnEve>`v z&($AHmFZ4<>+ZDRqmc@U3$w+~{v|$nrA%O=@G;OpuuJ z1;k_%0mYLpPwH;1jg1eXkBxep^vW`DZ^TzofX5V3D1m>(rV z-FAX~Z`u!`Vy^y)D?CEM&S*8LH7j1XWj_mp`i?Y;agI}$EBW*cBvFf>YOmmC51Ex? zOl}lrZ6YHtc*X=%JEX24|GcLkuXakfG10w~NSR?P3cEi^zrNmQV^H9N0!F3$pr7ElgkQ^u5iN2$f zS9wj<$Bz^3PJ`bb8zxO78$%;HwL-}Q-Sk#BU1O*rLp7qIs-|kO>x4gvep|>>X)1Fn zr9t34(m2%2K+Oy&mH0aVpK!O1sx>@P_E*`I?u<;I8ig4V4Tun0RM4^FF@Iqj1U+>l zcGxGdQtCzpT^J@&f?f+64!u6dUjv7MN?QwPxNY`(QKos0(@+XSXQQoM! z!k2ZYOE+G9z%3u|_5QHv%+u`iLq*x}8pXthZZuD_j0Tu3TSN4f3N-Ba;F=R?OOucWS0g;HL0Z{mNrp5~ zg-otw*0`P_9D<*H?k=EgK27W}bA+94$iRW44qZH{-??-S8QBoP11bvvD z+iry}dRkSO4hfQR(lZEYeosj_#-Ha{8Ti!(b!po@3o*uuK=kC#%TuG8Rs;Adn~cSm zaJ$B>>bHd@h*+=a@pk$OX_8uerpmHZr-RO^waIAZ^}UkXYWSw>P>)1h2K-J8R!2(-!3h`}*%BqO%H)GeVFcOU@&CP_Db8Rc50-RX#1PQ7;bS!Aw zl}H^ax{=kxPLNp4raXvS4NI=zaLYa?cAj!~$M$v7S2(NZkU%iS@pc1e@;Cx1%i#Sz zus`S2&M}@;we{^xIuAF=k22^MLbfvPGp4R=@v}M02jY@}Z8OSeZ|fEaWWFKiqE;^U zz322h3bV*vg~3g0IaIEG*G^C#1hDY3iAw**%tWUkXK3)Fh+fKNB8C*`DY=uIuf&tn z#3|8~K7BZTtyT_5@?K=)WtG6Ly-IR@F6}Y1X@%vp;Hp5e1I0sR3Nhr~q~F;}I6_ri zoTPM*UGBu3pMz8TA&HDy&G-@nSsTP-@&q*PW3oo!P*=d(hwX*Ng_!eq=+z|~WRknP*gaur7-|4&%B&otCjP#AZqgYiDiUNUZq4D72u(dJZOvXK};_8P(m6=5F|1TdS69I@DA!TgpIOy^1gu$eK53#~@QM~-n(;`_yd z$G|Mi>4lXDg*_CLY$?flp{s#4ms|WtD>gN^Q++AX;JYwgZ^M4sjJh`uHXjrzH1pE7`XxrSx5KRPVr9|A%!OT(o2pTZ#n^_#CCB3w@b;Op7 zBsGFj=tqRkvJ4;lA6I-t#=Z)-eQ#p|ejsrP-$V&;Y0<{L;`HL}nX-EZra`bX>~F^D zkq3=%`&{T~6{sn=PtNczd&8NcB_GE2A?f?QA%C#!Q}XGX=$csJhE^pXs6P^%fQhXq z)@{?sRN|yB`QDQvHp=dCiY8uBJ4#!k8gpaxq73#%0AIBs1I4f=J~3N-$T3JdytsHJZ`RfEjNROr4dW#9;v_=}m?5W}6&LdKyZhWU=`cNm5*?NsO?C(vXLxWOjk zS%VzT@P*FdwLof;y_u4qpI^_ioN>1B4lX*5%DI~077lC1mivQBRP77EF4oM(dEbVW z3I+mvI&8FA4%OJdaFMBn)kb6pDUlz&odVP3!6sM7{_ZdnB23FT02eXGeG##HRX6Ot z*}ZP-mnV}NQq;zSB&@`I<6KY^a`fV0;uc1t31YVrVPZ|<2){)N-@l|k z@MkcUlRw>B67`3J9ik4!x>lu5aNeNnzAD#D9nt+d*PNy+HAKOMuP$B<*?!o4UZ^wM z%r1?1wd&FYd>KIxeJ0!fj-VZ+*F-*ORbq5zhU%E@5VJT+%&Tp2oQPsW!jthy)IQ^o3iBX1Z! z0-}-ov`i~2=$wewS0^UL*16S^Xz1lchycGbNgNa%Ps9(2po-;llwNYJZ3+tGCA}P_ zagdU=UqKFNyYrlVe-=$B0c zsjdjF@kU0@cwsnIAf~ZOO{+<$ zkl}eNH+GK|t>N>Xgm@rr)?V~U_+@`|4XC%eOuRndG)gkCzy5CJh`f3y%7|DEl%gs& zW}+4A2CD1Q(qaN5kuQmGI4d0lXNmCCTdd!W6vEdn#o?6j5apPck~W9v-+qc(qks{% zd+LP+>t)9V#w{FY99s_dfaF#yjAe$2V$u8D4?YPYA9kW~cVgG!6TC7Ef;POYIqeGa zs_c+_kH6#iiF`SYG3`4?u9iYHDR>_wk;eo^fFmuYX5{>)V^c9TN7BX2mSqk`XlF&v zWOih`;$}v6;O`%NUJb`JVsgc(bIut}s_+QO$xItK2Sn-dR(g9fOJGWOEL!$=J10I;- ze8GwpSH@AUZ3Rp(bny>;is%Yc8^9TdUY}jDwve&%aHO7!wQV%%sjY^Gv7`71Z64z9 z$5qxO469m^j@oy0hDH$Cr>zS?QoKo3WsZyfVTim%H&Ra(2DV;dI=+Y-TLeq1h0~-z zBhQ2B={}yJ*xT9H@r_OCDZ?dM$IQ3uu_%4$=YFJ$h?Vh~N^Wiq(IX9qPG4UXh-{Z! z6J14Kn4U*Fw3B%^#v~U3l0Mkf(h(M{R=GCn3r&O_(|IP~W$!5pdF}LDeR9I^J0-D?H`-|MQ0^eV9;xKihcsiU z=kr??3mixXPK}m3F}?RM^@B;#5tB7)ovbi-52&0Be76kl;%rkq&$uvX7(T~rOWnr_ z+qVYwn$Jq%z7{&jUsJjT$O&m~dOsw%8>xjjQeZQ^bOtvHPl|6g7lW%!NDX=rzblbrM+y{eybreqV`*F+-?3B+e(swcZvX;uHVG7 z)VIO5xFaCV{v2vDN@lunkdaev$tIDIrUIM7#Gb=OlU*57GUVhkH{2*qZO2uqZpsDq zuwM2V5u00l)7%N(EG@fBTG(~|OzFWR?aLrwQmjKDp3|UZthguP3Upxh7rQd)czyvX z^?J5B(D)R~ROHD;J`5TQMR9g`7~Byx`rVJD_>mEi6VL4Jcd?B~nk( z?tGM6aw*qW3jq;cWadEa*D+!{#8?yV5FN&bkaI0j4IMNja$ii&MoVA!ELdta==J?q(uqc*n#M%B>aeMLKGpL&E2IB zzuK~?U6xpOg&18G=O^|??y$UMEgCqdHXDA0pgp*i+WP2|2*ADvNrpPI$AP|_3xLBf zXLzOQzNlcr`4hLQ#Ix*jvtaM^%o=Z(e$08?6NUFL0RW9<62=K13=1Lmd!)dbfaib` zDIyomQc20H{h>3#$HjzY@sjUlM2a8AZJ&L=8OhfwtTX)rdZXiJ9%FK3Ks#hoF@Z!T zQoW<&-31#>dn7Dew_fCQw}x>#fm~*lu{LV0sUL_|uC}dh8V%*8UMOGNnuGOxSQfW^ zoTMlwwkYkG%BE73EQq~CuITDvPCXRqF$P~A!&KgFS@;!3_*HH$!=Nuj<}L``SdEWJEP@j;q^ z%_ed>*z?VLqYdok1nx>pE2fLuecnfF@Et&7X9>Lu77`vmh<^S8>kBZkkU>$>jV6#7OVm!7=V9oek08Ej_9-BYLo@8f@S+#oBc_9H z8B-hJ53Qc5x3#C8IPo7h*$)z1A7YABPg4cp%dYRGL2A-3mIgjXQ)?=|P+UyJ_WmF; zEMH54+315K#3o)2gP->W>gsW5uQvHpOx2zCuv-XyIs!qLKm_p|=%kNOK#q$kSv0gO zMpt`Qo&bOfF!n(%ju7s3a<8L{n4g=L;y3mJewpm;d=c@eYRj|5)d-Y`OY4Wx*s&oE%AGTV`!%pQnnR;`Z&gxT7X;om4bsB_=%Pm*wEQ^ zBt567vA$RX3_Cz35C(-OMobw#UcshR#=-RKBuox-+C){Ba`=;5UgAN)H<5%T9s-pJ z*mVZ;D5k&b84W_p%x?^@3g?RvE}giD(9>m3aw!l;jL#dJ*BNM$#`j9d?Xtlfxvy5-mM`^QyMs zVae%rKT((R9PO>SDx+b}qQrzWOf|jM=?$^h2nC+qB#M|*tcLP-D$*cvqpc>No8eCH zHNaS_-M}fD+{MwZr;K^_#1N=nQ$NXhV?6%?n8>r~7TOzHel}x3D`A8{^(%dCw-f$R z<2k@HK^8ucV?_c&D{!r`fdK}d%z={7^qNdV33KSJ*i!;F9w<@2V9P*LlokkVm+Od( z>0wh%AfAI?xja5_%uLBN|CmJ{?w~gAfE?R)XEb&@0rrAI+N9Kz z-vRyv?=zwnB_e4zkaz_V*7v|@bC&BU4ZZ8fFl36vBbFa?fbu^3xbmkqBu;K3kSt&2FbI9vTBD#qQD$HA(Pf} zUSx&^js1Gf3g5V5DTNtNf=`h4UNU3WgFi?XJmrHUN(yn%34_k4dvkMY7^^do4Q9t_ zmAXX05f{PfZ48_er^JM#^G$h>44r&6cgsfW-BO^#igckXDFq@?aNht(cl?YnMn90t zqi&_UzCN7CZ6I+k+pzW{k1>T}tTw4s?l;|7L47X~8t#BINdM!+sQ2|MnWmpWF~^IL zt8MwLiVsh@KOt+4fy0YCd=i+rsP?t=qBX!iU%7^}kDeUdb)Wv{B=gwdAt!5trcWEwI$-sRR?Xs!{AsuETA?M6B*d6>8xC(sGPDcBGo`*N(wf zG9_XdMAUJ9#%z7{*h3ssYD-`Q@P-G2Zhs??Q9SnR2mD$I6EOidoX@1kqfMA%(=2=7 z{m4zuSlCM1E8c4}=K?;20L#c>-pL5(*{M52Giz~N9WQyP}@=W8eX|+NhKgJ1xP$mcT6Mc>De{T|2eafEE5@k;}_P1Vx@aMNTvBg-b^c~yY9IG0TO~T3r5PUb$z-Z?Ov}wi$^HSU=qL#s3jycg? zOl~<=b8zl=>^YD}m40D&w=yb?NHz`FAq9Dl(E={@LOB_WM8P+?%%Q<|xB3`vIY-%c7s5oK(k;zZ;WW z8ZH7FJm4}hZ6~6|(jn7}s6&U3JU3W$wJFFabH!F`eG#c6!>Sv$c!vA9l_X)BYnH2L z-4Mz{KNHI?a8{`9J&E#)s$$6^QHS$4)&&BHN$zY&FKZfvmHCt*>U~E0jkbE-B1(8~)z2yiY**RdL|iLUrB4xr})0*~gws%(8MqOX9)ig<5?E^QMp%;oKRQg;-I!02m_^SCZU z>^6ZHFih_8X^9Dqmsa}M%7Q5wguhLxsiVMRR9|F8EKA{5=V)@Ydrquqe^rctzSS#H zE#BaXVz-!B!fa9u7d29RAsr?-rovfr|nw5}h`ODt;vUB%Ec1Y<3;G zfdG5BL8@s%#xRg^4(5!EeD#W?-;*VZPdd?1q<^~jiY*u?+nQ}m=H~)>qR^@qh-LO0 zy=OI0G~xsQJTw^}A^tEqD#DZ=YAtDBIpw1yJC93$oj-ahVFI5agTAp3{|7NbGkto) zNNJS5F%9xxEfKQ zS@rZ(hVDBM^cHt!NpkCZ4)&H|23xBeQ&uG2Imv{q)w>6@mi-cswk75lEKYL*x`gvi zARo!Z$%BpgvcL9^$9>tgX2#0RDSHJg)*jo%&0S{p6yY5yMsG5a!N95<-bsaMX!k0a z`(C>X%rKj0Ws4m_rCmar4`SJfVR+Rmhb~W%MW;KPR0ZNNUcw)OF#>S6&-V5tf-m$X zP1y*+FBGm8ouj?eES@xUU~2m8i^HS1RBBS`bbQBL|z6|<_(b&*yN^7gv1%7sHIs`1OEm+=lW^B}mt zi5_dhu*U-L`j!3$Q(zux$TF$FmWX#ruKh!Pd2$!>W+M&8FLWHl( zn=ZqQ)(3FeyoA5b&ubxPYreC`wkWdJUBY2=^~}F-dly7^QXieOssjKb=AEMaz($SZ z2)fZd)p%*$J0kQCo@iV`fSAH#;ZbUB+1>~~ z*u{P`vgkMZ`SxKu<*9oX1vSPme=8pALVpjM~0Q)LkAmG@HCf2rOwbT^XOm zAJNHnl+G;LuZBNm@X0vuit(fhL|4tg?k!8vJSe9qCrfVm>iM2aK3n~o35ig#v3Nc_ zmiE);f@-Jjj@=FE>I*T_cKU9h-B_~!9Bs6F~(HEIPPs_3$my9h*Y*k6O)&=NuE@b z6bTkkFf@{bmRG_Vu^f;gAmvac@7HIRW z7r&m3!@*lTKD0@EYotUEeB;JtR`gZm4+bRUgoK}09u*O*+jPBjQ8C~XExB9z1F1T|w6PyWZv1vdK$3RW|g{P-{unpl^)F@=PiL=0ZtBt$EfDd=wRaB&!YNYS9t)qmRPk@Cj}0xI zQI&(_l*pNP8~lRD{0~zy4~Eq6UGB&6N$kuTZQ^s@amX^ zq>Y6{)T$D|c0hGIA=xCPM<`|Z{?j#D6n?SQNl@KtHH$x@!HbYFqvMGA(jTuwO$}0! z(@SzsGGH)0z6M3EtLzYAIk@ky>9k&0L*Io1cN9N@ zQ;tU)$1J_yrut?a98FVQb%3xcoKK>z-j4TcvuDf9ZN2-sNB`X!hTF!=x0$k$?d?zB z=bOv>g{${>BS(I3ccwXdGyS{$YX7{sy4ywug3~kr+UieZdyaXVJ4<&%`*iOX?G1Wb z-+kn%#+tr8dY^AM5C6M|>%E`f&@S~y?DHu{(MaK+iW{t=H^FTemmQ>=C?<_2=bj=JPpKFn>9WW9EFA=w`mryw9_g-Iv;9wD~@R;=&_xJE>`@l$ubBJP#)f6Q#5AujH$(c$Ro za>d*Nk^5uh1B^*n%* zSqg{&6RIAAIDkEev$%&S-k5|wIv8H#5Q zy?>s6Pl^uf5n?as*X)iSu)r-;GPsB+Bal{m|4WlX)9y(dQjCEL^5g^fi=~@4pMd@z z!C#;S@`S-qgR6(s*eIS-{WEGnG(CrD%pVK)PkM+K(yLyXe89-c zHQnyf2Vk4lIRE_L4Y_}v`Am!-q2=KD=TVWXFp4{v0q2hlOeaSwjUW=1DF(Y8lp5+e zCM5rKI(q)y=mY z(7$;7@7fsRmnxZR+A0_w0>*TsN&+;V`kU9t1(7IGu z((WPaC#ctRI=W5;3YB{wgLf<7eteS^yk{^~l!M*OTORcbFc>CA)d)LD{Y!S8jm!_Y ze2z9M>Hf-`WM(Za@j5(GkW=N0mNwVnlhw4T%uKlSz=aF1?2|y=`wCT=olO1~aJ>o3 zk9Zpk~)8!+N@WM#eyw zzn@z8;?wtk2v{0XA(B-Uotm-QcW& zr!@nqHcR!+luWQV(#_bPTYBHP%(B`FmOo(Xp5Qpu7)1MOV>7Cquf95+XpI~l1YgBS zZ%z8PCrKHm6sKhX0VcFNjg6o+i|V|4jm>v?fj8?EvWbzOgFcHqU3Wm1zGVmedFDpm zhR;IpY}c?rgI(DWe*ZFVL5_tO<>UNKRZ=t7i_01ZH%~~YgXRx-lSDCFwNS*D_dV>H zk*f`(j}FUSzRC2s_oYr8Q$z?x6Qgy!(S{d0`wG-p7;OtJrd69fpET`#qK^Fpieu-H z1AVcu5%&w(rlsEAeu-_qKI1k7#7pL_`*ljiW zahE<;IaVaXf+H$I)PO8{LKUuSTHWR&1{|WiO&0cH$DLHVPcSkLw_&9MM}tNc+mRaX zL`Ei1v%=+3zx1Xv6l(U=F7Qc_<0dQl%QLT#3dF)_a0(Ohxck$$O568SUDGMN)+D2? z_|4V!^~%U;*W1Y2I)>NOOO-~}lTP8<&nB?pT-|Kp)2J-I3v85^h9L=b5IHY{3{=zy zx)VX32abKa4_feGTEO_qp=BXH_dQIM$K|BP!p$Q6eeYo&VmO!-!y%BM3ju?Q_ z{wjPki_VIkRT{t7-Z0O{<(dkkXh81|Z$jOj8$+ih}Weh10S1%sa<4 z1pfUz=0qPB-glS^OxM@Y&hy;;d(#(qF>U`)M>6rZAh-u2vWn#>$mWEra0cnJ7TZDd zxoZZ!Wn5&bYupiA+u-TSC4?T^nlD8NR_7&}^;9L|#jL0TF!YeQl6yXz3aqN%B)QKG zqh$;3PYAEv-6`up6d05S)(8+tN^3_CMhb&aC{gVID7A&H#6Mnn0$qux zW7pQgPnQ>lDmi@5moV;se}Mjzq<{j_4K7f{q;a^}1_c7rg9HMi_-|N(|D*{16^ezb z>e*j#qWbhoeufqCwkZHJ|FR;4I2j%>u|lQwUT#bX|Li$vR$ZGC^>@f0{zeR+WJ zJZEP(n|;#$ZM6vZ6|gdlR;|H`GrM@LJ??FF;pr;+$h*0vN-@xY-O%2z@<8E>=f%Z=)`eOWv)&!> z=GAU+X&nx|OOW982Y1)L<2BO~k0LFJUp35p1dzk1XxlHkCN@ATk>ipv;eSbJxckwb z>5P1uE-jt20@}7k&%c__iKhP|%!T?qx;F}0Zz!J^EvCm6BrWdtLl{4}-G#VSS}sc! zI=tTeDM zqm6Okutw|d4*p0&Xk_$T^kBWG|61SxNdO8$J*j>joX>Lt`Aol>r`E`lZ{eOtu*$~a z-hRFfK&hGMG`WJU^g}Cg_0F4_S6@75POHGs(L9|b@1gO+->J*{6)cGATlq2jv@nJa zG}qazVn^#k$OOf?g26X-Ty3zJq{%#)C>C25fHY^3Lq6v-d*Xs(rnw77fH3;jkZ-b2 z5GUZtixB?RBCq$Iglgc^63aP6A7{Q`HhW0nH9W%^*uus8Yn_)!!wKk+*4ZI%CuQ%m z66j%f2Td^@l=I}CSPZZA-=k7U?+VF#G^o)OQ><6BJut{+k5gu~j>=#Aq*=C*Yv`E- zwCj$^=!*oxvWfDjD&SQPj<1E&jPGAE@{17%*XdGjl-}orHaZ}cYkMt>qNoq} zKO@Bd$z(D7Hxc50Qc(K(4xYw_#uldf`u_{M)D%?kKL9U~eHPAfXd2LZKIYZJXP*YUOF>WsT+NrjQEBbR~m@p29!+aWtJx+prf!6k!= zO{DNQCqgqK$Q*#LzMoMDtXQ$@#Ar#^f~1(_N$4{?1d@a+7$eYdCQK$hrol7{;%!h% zh*z(a$ARP4DHE35iWb&)h?#c@O1M)7U$i)L$dpCKI2UveB{y|8bz0S6Hid@ISxK%3 z%{O_a4-4cIB~5Q@N%Izfv}buXb>Q%cmmjq-<5()mjd`v{G>*eUN!)nXl1R;dzFz#- z^*8*j1z1S-n#^BOgsLofP7)Oq%#6;OpH5jCFhX?!?DpO=-2{5zt?R&!qWaz3L%kk#Vm5az-54mGylB<=Ci5CDnw+sHRMq*h4h+l-w0}%3Vmnra zM;QxcU6^GH(Pv&`r@Ds(9U@dr^d4?gDrkg2 z&R`2aUK5W4rw1JD)jmv*>>OAB!0!k=~f zN4iA#n*ZlL%RYA>vFNS`N)xjQb9it*Aay1YN#x?X=GJ<0eFs}ym+Bcsqx`R#S#m~| zpy(Ugx>NgL!n$MDR0H$afsFNl19rr z_%@s$Bchl$>^g-xsBx0dyE(S~`Zif?HCnIJ4iD|@{cnpeyX=>$#}?{fcf_Bs z>jd!rc2SIZf9NgM+IailLN4XgSb{B|t25uVWV5_Wp~J{Unu696G79mMNKv8JCAi5Q z0F}=aPG#idzXhhTFLZGaH?kZdRXSy$rw}o149EX+;}2B!2H|(8^V%{L0$~r@kqE`u z9En(@%qOROR5q2aP%$ey&I%s7LFl>JnJW)D0cd>!e<$6oJ<` z(|1AecggCjru=*JJ`8juTx#Li{fFKbE1@cRbvYjIk=qF6`lQ#B^q#~d!N(BhVZmss zI5``Uu;qUI+V2`{?{Y z_*u#7StI&DbSVzon$N%^+Nz71o^vYZteg}iLM$Nf)z9oWciIw7TY+n;4 zWZx1@=JFB-lVb;&Wrqp+Pw$>h1o} z4jJpv`JqfViGjQ5Jo)QzTwtr0O^lT`XjfG1G666zX>fb&G@GBGU)U^Izk@W`QmKG1 z#LEat<+Tx6l55pN;8krm1mLa~r?h~Vt@+#1=;Et-a9JE&6{zW0?cEWf&zRfmLLqoB zy~i@1=oSUq!^E1k_AxHBGMic?W49!8+I}lRIz-Reh`|F$>j!l<=J2OTbKW!xa$lKf z1+$I=_8EiiEnD`RGqwlObWJ}dVd>hB%Fkem#2>pb);Iw(ZEH|iwv;;_F)@qcdYz;z zG+;iMhBve#QX$8>x9X}#6pI{*>70qSj7hF->Jed5hl~+ozfyhDXCO4OTOUGfModV} zsKD@oSm8)|a=3NEl&QE1bs3S!H=~6sSn2;#3K&z^tlZo{^H(8vMCrFy1=(tP9|R1O zEbslr4=MvG5z-35nw7ev{FXDFxQK24ZBN1TfQTN6roL-fTqKeX&x46YFLXuC&bh*> z)~p^d_#iF1fSs{sX61qdVFp*E)^cRghp3lo71UQr*(r7H;aa6@#HYF>p5i|fU=@ok-#udhd;JM>5lUPkZDwtf8u57 zm+JJoX0D%x`Xxd9BN*do=Jo;zb)`rNFx*#8{&HLfMebL+N#mZNpkt}qBk@zLG9x}j?uA>gYj zF=YOZD2)f@8w$D1lmja#z%lb%f#Yd{Di7g?LJKd;H=~0p^)GVz&9BQ0o^1)B&#oAQ zQskR`nV=sLnOUN3FnL|E9oTG&N6v^-747R)xbq~)J9$`8=Tc%2f5tuxsNF>@I9i?S z-!A13RO<%6cdr9DkuL6(5k-AKWEv$Lchc6zC;nvVITn6N^uxB1*o|B%M!!k)Uqy8p zuqPRXQ>Y_EYp~B);oyWrzfKeZJs-@fKU3wW>HxAN#B1!#dFtCkx9nmu6t4=LMSFpp zd2>G|#)%`tKAY)Q4OdiNHXrGt3n@a3Y~XXIW2<^Nix__$hD`#q^IsOne?G*#L$Mv5 zyT(q=yq%co46bQj;T7N&zYjEsA$ZvM_;a-S;KCI9>fuV24AgyA`xljC+?ntTdFa$q2$ zbZ7Ei1bwh|MI8~C{R&F;I)bh2Kx{7h-F|iIz9Btr&950{o$syd_Tep%j5!lD#Jxoy zMH1%#wCMJkzW#re_SHdkFWJ_(yL)hVIA|c~!JUJG}pFeu7?yj!hEo<*qdz92!9OfM2{bIDuE~^|zY&jRn*?ulU z=66fsaD0Tp*q5>EOq#>u{&M)rfVOrvmBm5+u3B~Y!TkNFF}$6xW`ma^b?_!=O$rOa zK+!mOHrbW$qvTo|SwX$1>=yn4rs1gH4yl+@G9?BsBadhacOtzy5iQa^NUl!o#04?j z>des3b{KHpKGdUMnN5yBdGzJabZ-o)&$M?9xqm}F4R$FNk}$87vUx-~$yd}74BQ8d z48xe4t1GN3SQ=J#6}73mut+m|OZ%-y@lCggmZ{}v5(ZhNh`Kc)^Q}j5KGI^(=v<>n zUg~YaHXgq{xjQMC>6t%A%wzxou{aF{8i4|@jUY-^PF^V2%^p{GJm$7!@}sS@a^Y(E zmuzKJGeIvg34vwZ*M;<;HGkifdjfO1mWKL}H^qviUXWx$*?ABTj*!^9$_h^+^Vx&u z9u`(cyz>PQ&v61x$hZCs+OQz37Yb@}#8w zYutM3hFD|a=*`DsZ;S$33av`hDZf=R8r{oKd~CSi!9EW58W4?H(t7q;+-lumT0*i=u89sUA zfPv9IS4jNdt;^3%>_0Y+#t#1*kA&$tAjxwLjiP=JrHvtiz7fkb!#67P+@jOLP1UZ&SC+?8R zQ^^y}OM!~cVx>vWV&|kmB+7-MFH}4cqC+PH_?w<(Ea=WrWk&Bh4P4D!^X~W4j?&Uy z?(Urs9*7nil<$@_#c#PyyA*I9)6}un9wTYLS|fmv0x*iyq~rjqez#%(L&}vlwJ9qp z3c9b+Q>sk1IU(bNT`EP%g{I*)Oy(O_UceVhdg=$M$(?5iC$oQh<>BV;ChpeuXt_1wnUA+#r36;fMMjs|! z37f1vJ_yvb^e)W_8tdD(Rq9tC7Yi!!8xXzojKbNeeZwhguIU;{Y;b31s&7o-t^ zQi{ILIuEStdZMs-f(|&!;9pkSkyq1@5&EX2#3lPi_#3n46=m#)(M83o6k;72JcY4! z=NF5p6h!{XG&|r0yzSA7D(}rxN#1Y!uif&@BVu9o?9l9xaY>`5EBUdzda{A%(unV( zGv-QslNxiBjTLYQ`YxqqNo3Y#TNj;j@{505RK0C8!A?%Z^y$GIdUl~3s^4Tw{hSM& zTI2I59!}aOX87QqTxHvd+;u1V6$ z1wAtNez9PY%G)tO+odk?mC9ESgE>JZ zybCkTYC3LdWfWd&Qwqb}d!vlE$;czEYPA`zg!Z#~xxIsD>mMLhAY6vJj7s z*mXutX{HHD=?(%%G)05V7=jQ}Z?Ma{+Ad=dIf|F6jD0SWR1k3)a-r+iDq~y_X?2W_ zAVU3GsGh>7)W7?|e^))A!hFllP4{gdpPg^pkOvYxa}-5yzAjX+J)uc zUZO_ltNAI9K+dnsiW9oq{NX|-KCGSVy7lNJ1?LR`m$>ezb@3(0%WQB><_PbL-SoXE zxDNQK&LR{}l)>TzsVKb2gr~b!dr5-uzO-z4FbW>=z^3!9Q$uIbqyVwN`UsY!Bq|gq z4oDUrOc)lB0K)ANjU*DoW6ujoP1*XgvP%Mylba0PKd+&|3sQwzmPO=@q(O+ZjPPTn2l3V4t8H zU90Ze!z(YDQ{Sk zd1rpwY-0+iplA#y6{jFFU()40^+FZM+?k}hM6*-%I=&Pv55w4i#Q!ZB9BVc!CS-f> zt#URD4hIY_oaife<#e|JV^Ut!cZgfXdSzN=-9rjXRqf+vG?A`3WhK2ky`Itt!^Fy? zg9~H^7L)uTIPU4qAE^U5+eqM~>&Vxj3>~Wzg_=f#U-?1ga00Wo`-W>3VPix%^w4{! zKUjq(8^GlU4XGKV6@0oa%;?J6qxlL-@W~3JeFfkDi9CE(v9>{gI-Kp>43;zVQaI`Q zi{ny2`av$>W>}m^dRT@%62r8$cD7<*A2QRYft{mh#8sY#k{RCul%bS%#+>}HFv1Xq z)-yWDe+zI-sUH1$33xJSUgZUx#GCHC24x{cxB}icMvz4N!aKSsR`Glh03b?<`L3FD zzs&kbo?UW~fgERV7oC{cT!kFI6q{U-$*ZXVt+uEDy=5wZNstV-M?sjcuI2X{tmB5b zkCCo!D%6pG)%O*YLP2YR&Z3t#WO;#m2w-ZF#c?kA>vi2EzZA>Z__R=5$e9^Vy0%ti zP@M|XN&cJhV}{YLCFo1nGgpKqxe&cxaTE{yYmBsM>Cz~`xO8>2c`WzGI%UHn-CXGE zYK&zveMrLvDwQ6j{riM=r8UHAvOu#m;@guS{+2^b zB4oa>-P;|e(xWOg>_jH_aBBgRp~3Skh|MvY4Y4@DrGThXnlUT5Db(?`n7_HbCm8x@ z!B%c$m*S2iwajah`Dp>3y|O)iaV=X|4AK58VrhA6mk0 z;b8!c@AkrjL6m+eoUxGMAeJ@^e>|^IXw@G2k>Er<;1%v;GuR6(hvP)3C<{7nEJL|) zcbZR0z7mr%@ra+H%@XlcGzLnWO$?NMbv>zyz*EuUi&KK2RN%9dx74xmvvQP&Y|*`q zt6cZW=FAFaXNETL`*CSlWQPe0!!Xa!F+T%WYm$;ezB#QsJ)hn?zP`JRz<70iClhmy z>BO^!mQA?hLMd3vxh|T0h11=qR z#fkP5k)sVM7l_&^;_YA%3@a__y7KT?r3mKWToP+nXn(=E@zZ52i?QC{=;P}be1~$H zph%k2urN*X0c|a|kdFXgn;UBNyw~&Jiew4%wh6nAUb~ zL%-SWt(&vR%gZ&h^0PgLF2CY_CCG0tpUz#0WRzWq+XX9#jWPw2%Okr*R*mshlpBu< zHAvNXx($$Q%jY%I^{I3AsYH-!OK+sa5q$Jr@fitBsb;~pTF#%8KQx|8r35Y007G*% z19RKm6U2BD#q5ntG$Z06z24^wN(=L!XQa5tXMR8#_oF?|4|5K-3pxWo2w)!5b%wIe zuv3g>oLF@J$Vg`(f;9e-UZJODTggK~ZJW#Kyr-YHa{NIY zReIJd8kwv9=!uJoDw8%wUeWY8Duv)^0t-rhUYL3k(8ZaZ9fO37|B1e2Rq;H~+ptU#7xE=VILgC${4nk$ST@`YW z(Q7O;a8j+NG%fkj)$^Yt9#tf-6yp^N3u)-#FcIr%7R?$^*ww$SQRbs-7f9xDzY8~uCmg~YhG0i|U;pRTlCicw}+Vq?LG7k5G#>EE$^#VG|&@t68=4fj;4 z^vw5Mt)Wjt(_tDJjs#q~PBL_J>~PkP^_Z?zEtR?D-Fj7X;(gDl;vFYKaw9^t_BWkU z3-kaH=wV5v&{VH3IrbcO9|}+R9SV|`l&FDeL^keNtuKj3ofNm&@K$|)6RLxjJ3i#M z!L--Xq#jzEcZP6OyU?)%<7bnJ7(|tQ3Lt-(LGSO}Q?`_ditKe5s8V^``F&yVRbbBM z)Rqv`^IaDCxaKmQ>!P16{6a$4!c=j}1$P#%>7nn@ni|0|Y|*B40vN1QsN3}12x)D3 zHEtdGTUhMtdef$QL-<5kJFLj^+4=^!&m}FJAw5)i3C|L1<-=K5f;X3qkhTW5+ys5H zKtD87&LXU3KGp3wZPr|ro{dB-1_b?Lh-?UMjk8b<|F(?aJ{=3k1efyiB%Iu*_XcZr zp3JEd zmLXCV-AB2fyp;<^+sMD|351q&F zT5J2bv5Pv-lytjv)>?8#b#051cwDar`P}VNvB=Q!r19WrAS@Et@OMRagW)?MECe_b z>L&_P7_jX%ZH~T66tv%u4?&Vm3(VP#&*kJiEIEkrj>f+LZ z*HQseA)8X9sHx{l6Siqb1;8y&_*E2Vo^;?eqzW}_K~QuLsu;E&`?4n0(9&UT5T+>aAqwHJqKr9C)iM;yF23TR?Q&w16AP%&wJ zT>tXjd{`IZQMUnp;K6JPse+HzMQC8JDGqGV$4AO7lzgI;9?uLo5+h>4(E(d^6OaM# zqSO{uwGZYe{)cM820TT$2RkU}FNFXwtO}coX$`}vJvBjjKCwwY;t!b4HNxys2FX1U zkMqW1Zz$Z!Yz;*ArRzB;J}6+D1IvbB5^33dmypb(qOjO!d6Mq4G}xiyKo*IrXq~J^hsYJD;>>#+;j=jm(XBpVIH=>NKtmzfvuP%WS%Hj7!kpo zzf2UbTZ#&g6{2r9f__OTxqP>~7OCz}>ucx9P@+#$YGeTPLJnGy$NiimKXODqeus6J ztO@_^!bZWP&$^SE`)SKl{Kx~*``sf7-v#wLO8hj@D8b7JCm#fpPQCP{QMwF}%cm3` zO%ei<6R!LetJ8YcMcs~m3RDZ&$RG+ayG5jHK%GqD+NCzc)r>Y64CdqO-mr2A!gn(v zOKz9oh-5?~U^)+$c0y=dG+aD572?1C<&|_TXuJ2tkV0j~0l1j0)xK1L6lH>Vr4i0R#~+ z1*a^o!d8l%=vMQbMQi*wa}G3mwk{=cHF(a6BY}3SiVAWzRHRc&GKgNXTu-iu4l;w< z9UMTy>2=j|fhD-|7^O#O@!n@wCAlRX@zZDb932F< z0Edrys7Ei5y)SPxK7Lh9JG7;Z0a({`yP1%80pe(vpyaS@Q6)i0SV{%NmfmhYH6DXl zCAgHH(9w0Gx%fL_)4jA&OKjTm2{N z^L9FR*m@JC#?YH^e39tE@jY&l8Lrr{tUwJH`;^l#-yx0tPPQ_PCnW#QHR6f<7lJKhP+ zhxQItk>~Zz;3j(zK4=o_flMbFIFqbeV^>a*1~Qg$r48ypdhA2eTFW}YqLeq9HPO? zHPRr+WTW=?1ng+?6RwN#7j2BY*Cpc=RGvk+tMGV*ELl9bf%$5M*YDvVoeAvn^_to= z-EZ6lskhy@Vc1ve=Rv%Pj)gm7ye0eL_s4W=j+fD-M%a+y+SvK4f&4e)CUFiipV%7j zP6+GGJw8WQ={QA|9*Dng{;Q-y{~6Wb01^{!+MC%9QT!G0;b_&0 zX<4l={M^gX!*K1dfgG0(;=AOO^-X0UY6DSLEX8oe*B&VzThWsd~8_ z#46AeLdOVvhJtGWZI6T(o~`-a-5TcJn(PEYtL3fad%<(Q4Ot(~52i7c4+TxQh=1xe zx_5{<;ZO7&6=yg*T|zB(Wa6D$s*ISqCrG=z6s#gv;!}?&ywY#75{X+SyD~0^-{1Jk z$J-!Z27`I zk;2(|0}Gyw&ruC<+_)9hb+=1oszNGu!NFz(d7=1AL-ll}D|sy#%`S!wNF!Z|#3gJm zd_6F(vAVwpENlc6?tX)BUY!$ILN~v|+at%v9UWh%WX!3)iZYOhS?au3VOvhoPew#~ z`I%H0R-i~9Go@Z)L#`Y{yJ)sUj)4FuPF}Qvger#awYev}x zf#ozT+nS_h*R@uvX97Lb`P_u1YR9>u_I}H{RKchG5;FIlKQ3 zHTw>gfB#FPcN(UJl{3{St!y(NhtIc9sr9UY)7yp^#;lI&(s#5Muzct?&Dr5+5L_$@9J=P`ADBXE8owNc1GeZ0;QN zL5x}Mg?eSb+7{ODk?4sS!=LydNbU2XKi%L=SN0JprmcPBKJ_gDT`?GpzQdCuyq(mx za#2wqdxI^C|(} zXG)f2FDhDxIf1xut!5w@R4KBkR!g(mXi~`SncahE)zY z!II-Pd?wObG3A%SMxtxNhuAtT*rsofYCQFPt=~bX!dtQHsS>z!M}aq9F*S`{0;dKx zh*zbE+i7=vcLrU$o?Qh=&RX29)Dm%Ijy^Ov( z#FG7LZ!I2V>WQnil4M{&(*3fX#mWDp^K*pUHB5@r%_v3t2Mclyjn(Q4SUHZX0002R&(h3LYC77B{^K7#68D;hse6S)hS-=LIl1~*yl)6Hcr(goDMUq%x zfs|ssFPU=Rb}cRnmg^xN2{nJ8kcc~>564J;@KwwcM zEYt|%bCR#k7Ofd+3RR+T%q10tVgvO$ll=CFZu0F<-D^gqLHzZk0A3C@SW1|Us(@S^ zs$8`j%c=z<21t%Dp;~Mfb{%IM5shInLQ-*48f(= z&}!vz_;UcXw`2Y?T*8vKZi6w>8l#CIKg)La!ZDs;a1*mi*sg$~xc8Ogn88UMSQfdx z22N01qS*)~3dU;(=xWA=8Hf!vxx3;@y|#KihFPIIuv^jM+HlMFDU2>M@ln?-?an2j z&}50?z9rB`LY}0%QCuLQ{4t8BA%QPCvE!2a=N(L+vc-m=kcu@1TRo}a)7pg%D<9(F!kyk?pV)oP@kFCfJo2r``Q1`~#7BOU<0G#g zaRiD18`D;pr^O(2865-ao`Y^Ky32w@5&FH{nNSUB4klQ+T+A;R}b&V!}|)z3b= zBjV87-FVf5@fjV8E_(ihW}h8odMT;iIbNWtb6Ir66PY%ij$bE}w?!87r892@Nh5~7 z_36QWW0j{$J$h=|*3r~iUsOL39@#FZg0q}07jD>L6AjDYL5(@z=ROR`Uyc3H3_m9w040Hg8gtV^CcY_DF1xo)}N5wwEcIQNo#mRnt) zTqay8SO*ff1LDP8CFqU&HO%x3l|++(U#^|QJ7F8U=m6o!?-M5ixU==hFRP`g@8|n< zkqHojG|{BxWQRm?iNpP{u2Rt<1eF&nSZ#P#Rke!07G~u%NKC5~>^wRJ)@~Do=maMx zJAU&z`YdlGb;TW8mN%TX4r4pUGVJfl##NMAxR$XgV(nrO<9}6zX5C#Bw9l-k2Q~Q; z#ug-k>P(e;{)Kn{%!*_r&P;Kp$gtsEwXi)Rkpl;PSzo+sws=O<>pe?xv$g^RjIR%| z>qrX)Z}V2YzaG_k7jU^3x@K@6t%KwB8|J?9r4+=2gf71cZ_73_srmm(oKf2(Lo9~q$b_E;) z3+(^@M#eMab3y}q`eA1NB&hyfxgT$4{E>c?qkYc)Rfzq&vOnI?_#^!&`$N(F*Rp>V zasLkK$D0~|q#sBT&)MH0{X-7^JHQ`rZ2Xaa0FFFoe+T$mBma};@88_`CsD2Mk8%Gy zn*Zkojz2^HoeR!SXh*i+L;uMk=O^gjtM-3(ODy2`p#SLSziRmZIRxRr{!YdJv&O6c z9{4{s{Xc6B2ljWG{-3~%T>nLs@ApLa({gYHj=l7&)|LJ=A*Y^Ip zoc>Au^}nJ1=i>TTx?gSDPr7Qu|DvUTvT(mL{%S;iGS(RV7mR-~DT*@CFh6k7pMTQN KIdbD4|NaNF7TQ+; literal 0 HcmV?d00001 diff --git a/html/verbex/index.html b/html/verbex/index.html new file mode 100644 index 0000000..fa7fe2b --- /dev/null +++ b/html/verbex/index.html @@ -0,0 +1,68 @@ + + + + + + +verbex API documentation + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/html/verbex/verbex.html b/html/verbex/verbex.html new file mode 100644 index 0000000..639b601 --- /dev/null +++ b/html/verbex/verbex.html @@ -0,0 +1,2290 @@ + + + + + + +verbex.verbex API documentation + + + + + + + + + + + +
+
+
+

Module verbex.verbex

+
+
+

Generate regular expressions from an easier fluent verbal form.

+
+ +Expand source code + +
"""Generate regular expressions from an easier fluent verbal form."""
+from __future__ import annotations
+
+import re
+from enum import Enum
+from functools import wraps
+
+try:
+    from typing import (  # <--------------- if Python ≥ 3.9.0
+        Annotated,
+        ParamSpec,
+        TypeAlias,
+    )
+except (ModuleNotFoundError, ImportError):
+    from typing_extensions import TypeAlias, Annotated, ParamSpec  # type: ignore # <--- if Python < 3.9.0
+
+from typing import Pattern, Protocol, TypeVar
+
+from beartype import beartype  # type: ignore
+from beartype.typing import (  # type: ignore
+    Any,
+    Callable,
+    Dict,
+    Iterator,
+    List,
+    Optional,
+    Tuple,
+    Union,
+    cast,
+    runtime_checkable,
+)
+from beartype.vale import Is  # type: ignore
+
+
+def _string_len_is_1(text: object) -> bool:
+    return isinstance(text, str) and len(text) == 1
+
+
+Char = Annotated[str, Is[_string_len_is_1]]
+
+
+P = ParamSpec("P")  # noqa VNE001
+R = TypeVar("R")  # noqa VNE001
+
+
+# work around for bug https://github.com/python/mypy/issues/12660
+# fixed in next version of mypy
+@runtime_checkable
+class HasIter(Protocol):
+    """Workaround for mypy P.args."""
+
+    def __iter__(self) -> Iterator[Any]:
+        """Object can be iterated.
+
+        Yields:
+            Next object.
+        """
+        ...
+
+
+# work around for bug https://github.com/python/mypy/issues/12660
+# fixed in next version of mypy
+@runtime_checkable
+class HasItems(Protocol):
+    """Workaround for mypy P.kwargs."""
+
+    def items(self) -> Tuple[str, Any]:
+        """Object has items method.
+
+        Returns:
+            The dict of items.
+        """
+        ...
+
+
+class EscapedText(str):
+    """Text that has been escaped for regex.
+
+    Arguments:
+        str -- Extend the string class.
+    """
+
+    def __new__(cls, value: str) -> EscapedText:
+        """Return a escaped regex string.
+
+        Arguments:
+            value -- the string to escape
+
+        Returns:
+            _description_
+        """
+        return str.__new__(cls, re.escape(value))
+
+
+def re_escape(func: Callable[P, R]) -> Callable[P, R]:
+    """Automatically escape any string parameters as EscapedText.
+
+    Arguments:
+        func -- The function to decorate.
+
+    Returns:
+        The decorated function.
+    """
+
+    @wraps(func)
+    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
+        escaped_args: List[Any] = []
+        escaped_kwargs: Dict[str, Any] = {}
+        for arg in cast(HasIter, args):
+            if not isinstance(arg, EscapedText) and isinstance(arg, str):
+                escaped_args.append(EscapedText(arg))
+            else:
+                escaped_args.append(arg)
+        arg_k: str
+        arg_v: Any
+        for arg_k, arg_v in cast(HasItems, kwargs).items():
+            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
+                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
+            else:
+                escaped_kwargs[arg_k] = arg_v
+        return func(*escaped_args, **escaped_kwargs)  # type: ignore
+
+    return inner
+
+
+class CharClass(Enum):
+    """Enum of character classes in regex.
+
+    Arguments:
+        Enum -- Extends the Enum class.
+    """
+
+    DIGIT = "\\d"
+    LETTER = "\\w"
+    UPPERCASE_LETTER = "\\u"
+    LOWERCASE_LETTER = "\\l"
+    WHITESPACE = "\\s"
+    TAB = "\\t"
+
+    def __str__(self) -> str:
+        """To string method based on Enum value.
+
+        Returns:
+            value of Enum
+        """
+        return self.value
+
+
+class SpecialChar(Enum):
+    """Enum of special charaters, shorthand.
+
+    Arguments:
+        Enum -- Extends the Enum class.
+    """
+
+    # does not work  / should not be used in [ ]
+    LINEBREAK = "(\\n|(\\r\\n))"
+    START_OF_LINE = "^"
+    END_OF_LINE = "$"
+    TAB = "\t"
+
+    def __str__(self) -> str:
+        """To string for special chars enum.
+
+        Returns:
+            Return value of enum as string.
+        """
+        return self.value
+
+
+CharClassOrChars: TypeAlias = Union[str, CharClass]
+EscapedCharClassOrSpecial: TypeAlias = Union[str, CharClass, SpecialChar]
+VerbexEscapedCharClassOrSpecial: TypeAlias = Union["Verbex", EscapedCharClassOrSpecial]
+
+
+class Verbex:
+    """
+    VerbalExpressions class.
+
+    the following methods do not try to match the original js lib!
+    """
+
+    EMPTY_REGEX_FLAG = re.RegexFlag(0)
+
+    @re_escape
+    @beartype
+    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
+        """Create a Verbex object; setting any needed flags.
+
+        Keyword Arguments:
+            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
+        """
+        # self._parts: List[str] = [text]
+        self._parts: List[str] = []
+        self._modifiers = modifiers
+
+    @property
+    def modifiers(self) -> re.RegexFlag:
+        """Return the modifiers for this Verbex object.
+
+        Returns:
+            The modifiers applied to this object.
+        """
+        return self._modifiers
+
+    def __str__(self) -> str:
+        """Return regex string representation."""
+        return "".join(self._parts)
+
+    @beartype
+    def _add(self, value: Union[str, List[str]]) -> Verbex:
+        """
+        Append a transformed value to internal expression to be compiled.
+
+        As possible, this method should be "private".
+        """
+        if isinstance(value, list):
+            self._parts.extend(value)
+        else:
+            self._parts.append(value)
+        return self
+
+    def regex(self) -> Pattern[str]:
+        """Get a regular expression object."""
+        return re.compile(
+            str(self),
+            self._modifiers,
+        )
+
+    # allow VerbexEscapedCharClassOrSpecial
+
+    @re_escape
+    @beartype
+    def _capture_group_with_name(
+        self,
+        name: str,
+        text: VerbexEscapedCharClassOrSpecial,
+    ) -> Verbex:
+        return self._add(f"(?<{name}>{str(text)})")
+
+    @re_escape
+    @beartype
+    def _capture_group_without_name(
+        self,
+        text: VerbexEscapedCharClassOrSpecial,
+    ) -> Verbex:
+        return self._add(f"({str(text)})")
+
+    @re_escape
+    @beartype
+    def capture_group(
+        self,
+        /,
+        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
+        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
+    ) -> Verbex:
+        """Create a capture group.
+
+        Name is optional if not specified then the first argument is the text.
+
+        Keyword Arguments:
+            name_or_text -- The name of the group / text to search for (default: {None})
+            text -- The text to search for (default: {None})
+
+        Raises:
+            ValueError: If name is specified then text must be as well.
+
+        Returns:
+            Verbex with added capture group.
+        """
+        if name_or_text is not None:
+            if text is None:
+                _text = name_or_text
+                return self._capture_group_without_name(_text)
+            if isinstance(name_or_text, str):
+                return self._capture_group_with_name(name_or_text, text)
+        raise ValueError("text must be specified with optional name")
+
+    @re_escape
+    @beartype
+    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
+        """`or` is a python keyword so we use `OR` instead.
+
+        Arguments:
+            text -- Text to find or a Verbex object.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add("|").find(text)
+
+    @re_escape
+    @beartype
+    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Find the text or Verbex object zero or more times.
+
+        Arguments:
+            text -- The text / Verbex object to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:{str(text)})*")
+
+    @re_escape
+    @beartype
+    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Find the text or Verbex object one or more times.
+
+        Arguments:
+            text -- The text / Verbex object to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:{str(text)})+")
+
+    @re_escape
+    @beartype
+    def n_times(
+        self,
+        text: VerbexEscapedCharClassOrSpecial,
+        n: int,  # noqa: VNE001
+    ) -> Verbex:
+        """Find the text or Verbex object n or more times.
+
+        Arguments:
+            text -- The text / Verbex object to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:{str(text)}){{{n}}}")
+
+    @re_escape
+    @beartype
+    def n_times_or_more(
+        self,
+        text: VerbexEscapedCharClassOrSpecial,
+        n: int,  # noqa: VNE001
+    ) -> Verbex:
+        """Find the text or Verbex object at least n times.
+
+        Arguments:
+            text -- The text / Verbex object to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:{str(text)}){{{n},}}")
+
+    @re_escape
+    @beartype
+    def n_to_m_times(
+        self,
+        text: VerbexEscapedCharClassOrSpecial,
+        n: int,  # noqa: VNE001
+        m: int,  # noqa: VNE001
+    ) -> Verbex:
+        """Find the text or Verbex object between n and m times.
+
+        Arguments:
+            text -- The text / Verbex object to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:{str(text)}){{{n},{m}}}")
+
+    @re_escape
+    @beartype
+    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Possibly find the text / Verbex object.
+
+        Arguments:
+            text -- The text / Verbex object to possibly find.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:{str(text)})?")
+
+    @re_escape
+    @beartype
+    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Find the text or Verbex object.
+
+        Arguments:
+            text -- The text / Verbex object to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(str(text))
+
+    @re_escape
+    @beartype
+    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Synonym for find.
+
+        Arguments:
+            text -- The text / Verbex object to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self.find(text)
+
+    @re_escape
+    @beartype
+    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Match if string is followed by text.
+
+        Positive lookahead
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?={text})")
+
+    @re_escape
+    @beartype
+    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Match if string is not followed by text.
+
+        Negative lookahead
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?!{text})")
+
+    @re_escape
+    @beartype
+    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Match if string is not preceded by text.
+
+        Positive lookbehind
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?<={text})")
+
+    @re_escape
+    @beartype
+    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Match if string is not preceded by text.
+
+        Negative Lookbehind
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?<!{text})")
+
+    # only allow CharclassOrChars
+
+    @re_escape
+    @beartype
+    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
+        """Find anything in this group of chars or char class.
+
+        Arguments:
+            text -- The characters to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:[{chargroup}])")
+
+    @re_escape
+    @beartype
+    def not_any_of(self, text: CharClassOrChars) -> Verbex:
+        """Find anything but this group of chars or char class.
+
+        Arguments:
+            text -- The characters to not look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:[^{text}])")
+
+    @re_escape
+    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
+        """Find anything one or more times but this group of chars or char class.
+
+        Arguments:
+            text -- The characters to not look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"[^{chargroup}]+")
+
+    # no text input
+
+    def start_of_line(self) -> Verbex:
+        """Find the start of the line.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self.find(SpecialChar.START_OF_LINE)
+
+    def end_of_line(self) -> Verbex:
+        """Find the end of the line.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self.find(SpecialChar.END_OF_LINE)
+
+    def line_break(self) -> Verbex:
+        """Find a line break.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self.find(SpecialChar.LINEBREAK)
+
+    def tab(self) -> Verbex:
+        """Find a tab.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self.find(SpecialChar.TAB)
+
+    def anything(self) -> Verbex:
+        """Find anything one or more time.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(".+")
+
+    def as_few(self) -> Verbex:
+        """Modify previous search to not be greedy.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add("?")
+
+    @beartype
+    def number_range(self, start: int, end: int) -> Verbex:
+        """Generate a range of numbers.
+
+        Arguments:
+            start -- Start of the range
+            end -- End of the range
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
+
+    @beartype
+    def letter_range(self, start: Char, end: Char) -> Verbex:
+        """Generate a range of letters.
+
+        Arguments:
+            start -- Start of the range
+            end -- End of the range
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"[{start}-{end}]")
+
+    def word(self) -> Verbex:
+        """Find a word on word boundary.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add("(\\b\\w+\\b)")
+
+    # # --------------- modifiers ------------------------
+
+    def with_any_case(self) -> Verbex:
+        """Modify Verbex object to be case insensitive.
+
+        Returns:
+            Modified Verbex object.
+        """
+        self._modifiers |= re.IGNORECASE
+        return self
+
+    def search_by_line(self) -> Verbex:
+        """Search each line, ^ and $ match begining and end of line respectively.
+
+        Returns:
+            Modified Verbex object.
+        """
+        self._modifiers |= re.MULTILINE
+        return self
+
+    def with_ascii(self) -> Verbex:
+        """Match ascii instead of unicode.
+
+        Returns:
+            Modified Verbex object.
+        """
+        self._modifiers |= re.ASCII
+        return self
+
+
+# left over notes from original version
+# def __getattr__(self, attr):
+#     """ any other function will be sent to the regex object """
+#     regex = self.regex()
+#     return getattr(regex, attr)
+
+# def replace(self, string, repl):
+#     return self.sub(repl, string)
+
+
+if __name__ == "__main__":
+    pass
+
+
+
+
+
+
+
+

Functions

+
+
+def re_escape(func: Callable[P, R]) ‑> collections.abc.Callable[~P, ~R] +
+
+

Automatically escape any string parameters as EscapedText.

+

Arguments

+

func – The function to decorate.

+

Returns

+

The decorated function.

+
+ +Expand source code + +
def re_escape(func: Callable[P, R]) -> Callable[P, R]:
+    """Automatically escape any string parameters as EscapedText.
+
+    Arguments:
+        func -- The function to decorate.
+
+    Returns:
+        The decorated function.
+    """
+
+    @wraps(func)
+    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
+        escaped_args: List[Any] = []
+        escaped_kwargs: Dict[str, Any] = {}
+        for arg in cast(HasIter, args):
+            if not isinstance(arg, EscapedText) and isinstance(arg, str):
+                escaped_args.append(EscapedText(arg))
+            else:
+                escaped_args.append(arg)
+        arg_k: str
+        arg_v: Any
+        for arg_k, arg_v in cast(HasItems, kwargs).items():
+            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
+                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
+            else:
+                escaped_kwargs[arg_k] = arg_v
+        return func(*escaped_args, **escaped_kwargs)  # type: ignore
+
+    return inner
+
+
+
+
+
+

Classes

+
+
+class CharClass +(value, names=None, *, module=None, qualname=None, type=None, start=1) +
+
+

Enum of character classes in regex.

+

Arguments

+

Enum – Extends the Enum class.

+
+ +Expand source code + +
class CharClass(Enum):
+    """Enum of character classes in regex.
+
+    Arguments:
+        Enum -- Extends the Enum class.
+    """
+
+    DIGIT = "\\d"
+    LETTER = "\\w"
+    UPPERCASE_LETTER = "\\u"
+    LOWERCASE_LETTER = "\\l"
+    WHITESPACE = "\\s"
+    TAB = "\\t"
+
+    def __str__(self) -> str:
+        """To string method based on Enum value.
+
+        Returns:
+            value of Enum
+        """
+        return self.value
+
+

Ancestors

+
    +
  • enum.Enum
    • +
+

Class variables

+
+
var DIGIT
+
+
+
+
var LETTER
+
+
+
+
var LOWERCASE_LETTER
+
+
+
+
var TAB
+
+
+
+
var UPPERCASE_LETTER
+
+
+
+
var WHITESPACE
+
+
+
+
+
+
+class EscapedText +(value: str) +
+
+

Text that has been escaped for regex.

+

Arguments

+

str – Extend the string class.

+
+ +Expand source code + +
class EscapedText(str):
+    """Text that has been escaped for regex.
+
+    Arguments:
+        str -- Extend the string class.
+    """
+
+    def __new__(cls, value: str) -> EscapedText:
+        """Return a escaped regex string.
+
+        Arguments:
+            value -- the string to escape
+
+        Returns:
+            _description_
+        """
+        return str.__new__(cls, re.escape(value))
+
+

Ancestors

+
    +
  • builtins.str
    • +
+
+
+class HasItems +(*args, **kwargs) +
+
+

Workaround for mypy P.kwargs.

+
+ +Expand source code + +
@runtime_checkable
+class HasItems(Protocol):
+    """Workaround for mypy P.kwargs."""
+
+    def items(self) -> Tuple[str, Any]:
+        """Object has items method.
+
+        Returns:
+            The dict of items.
+        """
+        ...
+
+

Ancestors

+
    +
  • typing.Protocol
    • +
  • typing.Generic
    • +
+

Methods

+
+
+def items(self) ‑> tuple[str, typing.Any] +
+
+

Object has items method.

+

Returns

+

The dict of items.

+
+ +Expand source code + +
def items(self) -> Tuple[str, Any]:
+    """Object has items method.
+
+    Returns:
+        The dict of items.
+    """
+    ...
+
+
+
+
+
+class HasIter +(*args, **kwargs) +
+
+

Workaround for mypy P.args.

+
+ +Expand source code + +
@runtime_checkable
+class HasIter(Protocol):
+    """Workaround for mypy P.args."""
+
+    def __iter__(self) -> Iterator[Any]:
+        """Object can be iterated.
+
+        Yields:
+            Next object.
+        """
+        ...
+
+

Ancestors

+
    +
  • typing.Protocol
    • +
  • typing.Generic
    • +
+
+
+class SpecialChar +(value, names=None, *, module=None, qualname=None, type=None, start=1) +
+
+

Enum of special charaters, shorthand.

+

Arguments

+

Enum – Extends the Enum class.

+
+ +Expand source code + +
class SpecialChar(Enum):
+    """Enum of special charaters, shorthand.
+
+    Arguments:
+        Enum -- Extends the Enum class.
+    """
+
+    # does not work  / should not be used in [ ]
+    LINEBREAK = "(\\n|(\\r\\n))"
+    START_OF_LINE = "^"
+    END_OF_LINE = "$"
+    TAB = "\t"
+
+    def __str__(self) -> str:
+        """To string for special chars enum.
+
+        Returns:
+            Return value of enum as string.
+        """
+        return self.value
+
+

Ancestors

+
    +
  • enum.Enum
    • +
+

Class variables

+
+
var END_OF_LINE
+
+
+
+
var LINEBREAK
+
+
+
+
var START_OF_LINE
+
+
+
+
var TAB
+
+
+
+
+
+
+class Verbex +(modifiers: re.RegexFlag = ) +
+
+

VerbalExpressions class.

+

the following methods do not try to match the original js lib!

+

Create a Verbex object; setting any needed flags.

+

Keyword Arguments: +modifiers – Regex modifying flags (default: {re.RegexFlag(0)})

+
+ +Expand source code + +
class Verbex:
+    """
+    VerbalExpressions class.
+
+    the following methods do not try to match the original js lib!
+    """
+
+    EMPTY_REGEX_FLAG = re.RegexFlag(0)
+
+    @re_escape
+    @beartype
+    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
+        """Create a Verbex object; setting any needed flags.
+
+        Keyword Arguments:
+            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
+        """
+        # self._parts: List[str] = [text]
+        self._parts: List[str] = []
+        self._modifiers = modifiers
+
+    @property
+    def modifiers(self) -> re.RegexFlag:
+        """Return the modifiers for this Verbex object.
+
+        Returns:
+            The modifiers applied to this object.
+        """
+        return self._modifiers
+
+    def __str__(self) -> str:
+        """Return regex string representation."""
+        return "".join(self._parts)
+
+    @beartype
+    def _add(self, value: Union[str, List[str]]) -> Verbex:
+        """
+        Append a transformed value to internal expression to be compiled.
+
+        As possible, this method should be "private".
+        """
+        if isinstance(value, list):
+            self._parts.extend(value)
+        else:
+            self._parts.append(value)
+        return self
+
+    def regex(self) -> Pattern[str]:
+        """Get a regular expression object."""
+        return re.compile(
+            str(self),
+            self._modifiers,
+        )
+
+    # allow VerbexEscapedCharClassOrSpecial
+
+    @re_escape
+    @beartype
+    def _capture_group_with_name(
+        self,
+        name: str,
+        text: VerbexEscapedCharClassOrSpecial,
+    ) -> Verbex:
+        return self._add(f"(?<{name}>{str(text)})")
+
+    @re_escape
+    @beartype
+    def _capture_group_without_name(
+        self,
+        text: VerbexEscapedCharClassOrSpecial,
+    ) -> Verbex:
+        return self._add(f"({str(text)})")
+
+    @re_escape
+    @beartype
+    def capture_group(
+        self,
+        /,
+        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
+        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
+    ) -> Verbex:
+        """Create a capture group.
+
+        Name is optional if not specified then the first argument is the text.
+
+        Keyword Arguments:
+            name_or_text -- The name of the group / text to search for (default: {None})
+            text -- The text to search for (default: {None})
+
+        Raises:
+            ValueError: If name is specified then text must be as well.
+
+        Returns:
+            Verbex with added capture group.
+        """
+        if name_or_text is not None:
+            if text is None:
+                _text = name_or_text
+                return self._capture_group_without_name(_text)
+            if isinstance(name_or_text, str):
+                return self._capture_group_with_name(name_or_text, text)
+        raise ValueError("text must be specified with optional name")
+
+    @re_escape
+    @beartype
+    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
+        """`or` is a python keyword so we use `OR` instead.
+
+        Arguments:
+            text -- Text to find or a Verbex object.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add("|").find(text)
+
+    @re_escape
+    @beartype
+    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Find the text or Verbex object zero or more times.
+
+        Arguments:
+            text -- The text / Verbex object to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:{str(text)})*")
+
+    @re_escape
+    @beartype
+    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Find the text or Verbex object one or more times.
+
+        Arguments:
+            text -- The text / Verbex object to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:{str(text)})+")
+
+    @re_escape
+    @beartype
+    def n_times(
+        self,
+        text: VerbexEscapedCharClassOrSpecial,
+        n: int,  # noqa: VNE001
+    ) -> Verbex:
+        """Find the text or Verbex object n or more times.
+
+        Arguments:
+            text -- The text / Verbex object to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:{str(text)}){{{n}}}")
+
+    @re_escape
+    @beartype
+    def n_times_or_more(
+        self,
+        text: VerbexEscapedCharClassOrSpecial,
+        n: int,  # noqa: VNE001
+    ) -> Verbex:
+        """Find the text or Verbex object at least n times.
+
+        Arguments:
+            text -- The text / Verbex object to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:{str(text)}){{{n},}}")
+
+    @re_escape
+    @beartype
+    def n_to_m_times(
+        self,
+        text: VerbexEscapedCharClassOrSpecial,
+        n: int,  # noqa: VNE001
+        m: int,  # noqa: VNE001
+    ) -> Verbex:
+        """Find the text or Verbex object between n and m times.
+
+        Arguments:
+            text -- The text / Verbex object to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:{str(text)}){{{n},{m}}}")
+
+    @re_escape
+    @beartype
+    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Possibly find the text / Verbex object.
+
+        Arguments:
+            text -- The text / Verbex object to possibly find.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:{str(text)})?")
+
+    @re_escape
+    @beartype
+    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Find the text or Verbex object.
+
+        Arguments:
+            text -- The text / Verbex object to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(str(text))
+
+    @re_escape
+    @beartype
+    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Synonym for find.
+
+        Arguments:
+            text -- The text / Verbex object to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self.find(text)
+
+    @re_escape
+    @beartype
+    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Match if string is followed by text.
+
+        Positive lookahead
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?={text})")
+
+    @re_escape
+    @beartype
+    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Match if string is not followed by text.
+
+        Negative lookahead
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?!{text})")
+
+    @re_escape
+    @beartype
+    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Match if string is not preceded by text.
+
+        Positive lookbehind
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?<={text})")
+
+    @re_escape
+    @beartype
+    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+        """Match if string is not preceded by text.
+
+        Negative Lookbehind
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?<!{text})")
+
+    # only allow CharclassOrChars
+
+    @re_escape
+    @beartype
+    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
+        """Find anything in this group of chars or char class.
+
+        Arguments:
+            text -- The characters to look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:[{chargroup}])")
+
+    @re_escape
+    @beartype
+    def not_any_of(self, text: CharClassOrChars) -> Verbex:
+        """Find anything but this group of chars or char class.
+
+        Arguments:
+            text -- The characters to not look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"(?:[^{text}])")
+
+    @re_escape
+    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
+        """Find anything one or more times but this group of chars or char class.
+
+        Arguments:
+            text -- The characters to not look for.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"[^{chargroup}]+")
+
+    # no text input
+
+    def start_of_line(self) -> Verbex:
+        """Find the start of the line.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self.find(SpecialChar.START_OF_LINE)
+
+    def end_of_line(self) -> Verbex:
+        """Find the end of the line.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self.find(SpecialChar.END_OF_LINE)
+
+    def line_break(self) -> Verbex:
+        """Find a line break.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self.find(SpecialChar.LINEBREAK)
+
+    def tab(self) -> Verbex:
+        """Find a tab.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self.find(SpecialChar.TAB)
+
+    def anything(self) -> Verbex:
+        """Find anything one or more time.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(".+")
+
+    def as_few(self) -> Verbex:
+        """Modify previous search to not be greedy.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add("?")
+
+    @beartype
+    def number_range(self, start: int, end: int) -> Verbex:
+        """Generate a range of numbers.
+
+        Arguments:
+            start -- Start of the range
+            end -- End of the range
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
+
+    @beartype
+    def letter_range(self, start: Char, end: Char) -> Verbex:
+        """Generate a range of letters.
+
+        Arguments:
+            start -- Start of the range
+            end -- End of the range
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add(f"[{start}-{end}]")
+
+    def word(self) -> Verbex:
+        """Find a word on word boundary.
+
+        Returns:
+            Modified Verbex object.
+        """
+        return self._add("(\\b\\w+\\b)")
+
+    # # --------------- modifiers ------------------------
+
+    def with_any_case(self) -> Verbex:
+        """Modify Verbex object to be case insensitive.
+
+        Returns:
+            Modified Verbex object.
+        """
+        self._modifiers |= re.IGNORECASE
+        return self
+
+    def search_by_line(self) -> Verbex:
+        """Search each line, ^ and $ match begining and end of line respectively.
+
+        Returns:
+            Modified Verbex object.
+        """
+        self._modifiers |= re.MULTILINE
+        return self
+
+    def with_ascii(self) -> Verbex:
+        """Match ascii instead of unicode.
+
+        Returns:
+            Modified Verbex object.
+        """
+        self._modifiers |= re.ASCII
+        return self
+
+

Class variables

+
+
var EMPTY_REGEX_FLAG
+
+
+
+
+

Instance variables

+
+
var modifiers : re.RegexFlag
+
+

Return the modifiers for this Verbex object.

+

Returns

+

The modifiers applied to this object.

+
+ +Expand source code + +
@property
+def modifiers(self) -> re.RegexFlag:
+    """Return the modifiers for this Verbex object.
+
+    Returns:
+        The modifiers applied to this object.
+    """
+    return self._modifiers
+
+
+
+

Methods

+
+
+def OR(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex +
+
+

or is a python keyword so we use OR instead.

+

Arguments

+

text – Text to find or a Verbex object.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+@beartype
+def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
+    """`or` is a python keyword so we use `OR` instead.
+
+    Arguments:
+        text -- Text to find or a Verbex object.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add("|").find(text)
+
+
+
+def any_of(self, chargroup: Union[str, CharClass]) ‑> Verbex +
+
+

Find anything in this group of chars or char class.

+

Arguments

+

text – The characters to look for.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+@beartype
+def any_of(self, chargroup: CharClassOrChars) -> Verbex:
+    """Find anything in this group of chars or char class.
+
+    Arguments:
+        text -- The characters to look for.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(f"(?:[{chargroup}])")
+
+
+
+def anything(self) ‑> Verbex +
+
+

Find anything one or more time.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
def anything(self) -> Verbex:
+    """Find anything one or more time.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(".+")
+
+
+
+def anything_but(self, chargroup: EscapedCharClassOrSpecial) ‑> Verbex +
+
+

Find anything one or more times but this group of chars or char class.

+

Arguments

+

text – The characters to not look for.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
+    """Find anything one or more times but this group of chars or char class.
+
+    Arguments:
+        text -- The characters to not look for.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(f"[^{chargroup}]+")
+
+
+
+def as_few(self) ‑> Verbex +
+
+

Modify previous search to not be greedy.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
def as_few(self) -> Verbex:
+    """Modify previous search to not be greedy.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add("?")
+
+
+
+def capture_group(self, /, name_or_text: Union[str, ForwardRef(None), ForwardRef('Verbex'), CharClass, SpecialChar] = None, text: Union[str, ForwardRef(None), ForwardRef('Verbex'), CharClass, SpecialChar] = None) ‑> Verbex +
+
+

Create a capture group.

+

Name is optional if not specified then the first argument is the text.

+

Keyword Arguments: +name_or_text – The name of the group / text to search for (default: {None}) +text – The text to search for (default: {None})

+

Raises

+
+
ValueError
+
If name is specified then text must be as well.
+
+

Returns

+

Verbex with added capture group.

+
+ +Expand source code + +
@re_escape
+@beartype
+def capture_group(
+    self,
+    /,
+    name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
+    text: Optional[VerbexEscapedCharClassOrSpecial] = None,
+) -> Verbex:
+    """Create a capture group.
+
+    Name is optional if not specified then the first argument is the text.
+
+    Keyword Arguments:
+        name_or_text -- The name of the group / text to search for (default: {None})
+        text -- The text to search for (default: {None})
+
+    Raises:
+        ValueError: If name is specified then text must be as well.
+
+    Returns:
+        Verbex with added capture group.
+    """
+    if name_or_text is not None:
+        if text is None:
+            _text = name_or_text
+            return self._capture_group_without_name(_text)
+        if isinstance(name_or_text, str):
+            return self._capture_group_with_name(name_or_text, text)
+    raise ValueError("text must be specified with optional name")
+
+
+
+def end_of_line(self) ‑> Verbex +
+
+

Find the end of the line.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
def end_of_line(self) -> Verbex:
+    """Find the end of the line.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self.find(SpecialChar.END_OF_LINE)
+
+
+
+def find(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex +
+
+

Find the text or Verbex object.

+

Arguments

+

text – The text / Verbex object to look for.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+@beartype
+def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+    """Find the text or Verbex object.
+
+    Arguments:
+        text -- The text / Verbex object to look for.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(str(text))
+
+
+
+def followed_by(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex +
+
+

Match if string is followed by text.

+

Positive lookahead

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+@beartype
+def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+    """Match if string is followed by text.
+
+    Positive lookahead
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(f"(?={text})")
+
+
+
+def letter_range(self, start: typing.Annotated[str, Is[_string_len_is_1]], end: typing.Annotated[str, Is[_string_len_is_1]]) ‑> Verbex +
+
+

Generate a range of letters.

+

Arguments

+

start – Start of the range +end – End of the range

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@beartype
+def letter_range(self, start: Char, end: Char) -> Verbex:
+    """Generate a range of letters.
+
+    Arguments:
+        start -- Start of the range
+        end -- End of the range
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(f"[{start}-{end}]")
+
+
+
+def line_break(self) ‑> Verbex +
+
+

Find a line break.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
def line_break(self) -> Verbex:
+    """Find a line break.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self.find(SpecialChar.LINEBREAK)
+
+
+
+def maybe(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex +
+
+

Possibly find the text / Verbex object.

+

Arguments

+

text – The text / Verbex object to possibly find.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+@beartype
+def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+    """Possibly find the text / Verbex object.
+
+    Arguments:
+        text -- The text / Verbex object to possibly find.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(f"(?:{str(text)})?")
+
+
+
+def n_times(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar], n: int) ‑> Verbex +
+
+

Find the text or Verbex object n or more times.

+

Arguments

+

text – The text / Verbex object to look for.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+@beartype
+def n_times(
+    self,
+    text: VerbexEscapedCharClassOrSpecial,
+    n: int,  # noqa: VNE001
+) -> Verbex:
+    """Find the text or Verbex object n or more times.
+
+    Arguments:
+        text -- The text / Verbex object to look for.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(f"(?:{str(text)}){{{n}}}")
+
+
+
+def n_times_or_more(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar], n: int) ‑> Verbex +
+
+

Find the text or Verbex object at least n times.

+

Arguments

+

text – The text / Verbex object to look for.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+@beartype
+def n_times_or_more(
+    self,
+    text: VerbexEscapedCharClassOrSpecial,
+    n: int,  # noqa: VNE001
+) -> Verbex:
+    """Find the text or Verbex object at least n times.
+
+    Arguments:
+        text -- The text / Verbex object to look for.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(f"(?:{str(text)}){{{n},}}")
+
+
+
+def n_to_m_times(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar], n: int, m: int) ‑> Verbex +
+
+

Find the text or Verbex object between n and m times.

+

Arguments

+

text – The text / Verbex object to look for.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+@beartype
+def n_to_m_times(
+    self,
+    text: VerbexEscapedCharClassOrSpecial,
+    n: int,  # noqa: VNE001
+    m: int,  # noqa: VNE001
+) -> Verbex:
+    """Find the text or Verbex object between n and m times.
+
+    Arguments:
+        text -- The text / Verbex object to look for.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(f"(?:{str(text)}){{{n},{m}}}")
+
+
+
+def not_any_of(self, text: Union[str, CharClass]) ‑> Verbex +
+
+

Find anything but this group of chars or char class.

+

Arguments

+

text – The characters to not look for.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+@beartype
+def not_any_of(self, text: CharClassOrChars) -> Verbex:
+    """Find anything but this group of chars or char class.
+
+    Arguments:
+        text -- The characters to not look for.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(f"(?:[^{text}])")
+
+
+
+def not_followed_by(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex +
+
+

Match if string is not followed by text.

+

Negative lookahead

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+@beartype
+def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+    """Match if string is not followed by text.
+
+    Negative lookahead
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(f"(?!{text})")
+
+
+
+def not_preceded_by(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex +
+
+

Match if string is not preceded by text.

+

Negative Lookbehind

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+@beartype
+def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+    """Match if string is not preceded by text.
+
+    Negative Lookbehind
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(f"(?<!{text})")
+
+
+
+def number_range(self, start: int, end: int) ‑> Verbex +
+
+

Generate a range of numbers.

+

Arguments

+

start – Start of the range +end – End of the range

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@beartype
+def number_range(self, start: int, end: int) -> Verbex:
+    """Generate a range of numbers.
+
+    Arguments:
+        start -- Start of the range
+        end -- End of the range
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
+
+
+
+def one_or_more(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex +
+
+

Find the text or Verbex object one or more times.

+

Arguments

+

text – The text / Verbex object to look for.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+@beartype
+def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+    """Find the text or Verbex object one or more times.
+
+    Arguments:
+        text -- The text / Verbex object to look for.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(f"(?:{str(text)})+")
+
+
+
+def preceded_by(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex +
+
+

Match if string is not preceded by text.

+

Positive lookbehind

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+@beartype
+def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+    """Match if string is not preceded by text.
+
+    Positive lookbehind
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(f"(?<={text})")
+
+
+
+def regex(self) ‑> Pattern[str] +
+
+

Get a regular expression object.

+
+ +Expand source code + +
def regex(self) -> Pattern[str]:
+    """Get a regular expression object."""
+    return re.compile(
+        str(self),
+        self._modifiers,
+    )
+
+
+
+def search_by_line(self) ‑> Verbex +
+
+

Search each line, ^ and $ match begining and end of line respectively.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
def search_by_line(self) -> Verbex:
+    """Search each line, ^ and $ match begining and end of line respectively.
+
+    Returns:
+        Modified Verbex object.
+    """
+    self._modifiers |= re.MULTILINE
+    return self
+
+
+
+def start_of_line(self) ‑> Verbex +
+
+

Find the start of the line.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
def start_of_line(self) -> Verbex:
+    """Find the start of the line.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self.find(SpecialChar.START_OF_LINE)
+
+
+
+def tab(self) ‑> Verbex +
+
+

Find a tab.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
def tab(self) -> Verbex:
+    """Find a tab.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self.find(SpecialChar.TAB)
+
+
+
+def then(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex +
+
+

Synonym for find.

+

Arguments

+

text – The text / Verbex object to look for.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+@beartype
+def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+    """Synonym for find.
+
+    Arguments:
+        text -- The text / Verbex object to look for.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self.find(text)
+
+
+
+def with_any_case(self) ‑> Verbex +
+
+

Modify Verbex object to be case insensitive.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
def with_any_case(self) -> Verbex:
+    """Modify Verbex object to be case insensitive.
+
+    Returns:
+        Modified Verbex object.
+    """
+    self._modifiers |= re.IGNORECASE
+    return self
+
+
+
+def with_ascii(self) ‑> Verbex +
+
+

Match ascii instead of unicode.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
def with_ascii(self) -> Verbex:
+    """Match ascii instead of unicode.
+
+    Returns:
+        Modified Verbex object.
+    """
+    self._modifiers |= re.ASCII
+    return self
+
+
+
+def word(self) ‑> Verbex +
+
+

Find a word on word boundary.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
def word(self) -> Verbex:
+    """Find a word on word boundary.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add("(\\b\\w+\\b)")
+
+
+
+def zero_or_more(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex +
+
+

Find the text or Verbex object zero or more times.

+

Arguments

+

text – The text / Verbex object to look for.

+

Returns

+

Modified Verbex object.

+
+ +Expand source code + +
@re_escape
+@beartype
+def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+    """Find the text or Verbex object zero or more times.
+
+    Arguments:
+        text -- The text / Verbex object to look for.
+
+    Returns:
+        Modified Verbex object.
+    """
+    return self._add(f"(?:{str(text)})*")
+
+
+
+
+
+
+
+ +
+ + + \ No newline at end of file diff --git a/setup.py b/setup.py index a2f1f6a..34d1196 100755 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ setup( name="Verbex", - version="1.0.2", + version="1.0.3", description=( "Make difficult regular expressions easy! Python fork based on of the awesome" " VerbalExpressions repo - https://github.com/jehna/VerbalExpressions" @@ -19,7 +19,7 @@ " Raghuram, Kharms, Richard Broderick" ), license="GPLv3", - url="https://github.com/VerbalExpressions/PythonVerbalExpressions", + url="https://github.com/rbroderi/Verbex", test_suite="tests", packages=["verbex"], classifiers=[ From b15001486bff1055790ed3ceff7f8e9a2a15add6 Mon Sep 17 00:00:00 2001 From: Richard Date: Sat, 7 May 2022 23:45:42 -0400 Subject: [PATCH 27/85] switch to pdoc from pdoc3 --- builddoc.bat | 3 + html/index.html | 7 + html/search.js | 46 + html/verbex/index.html | 68 - html/verbex/verbex.html | 5317 +++++++++++++++++++++++---------------- 5 files changed, 3139 insertions(+), 2302 deletions(-) create mode 100644 builddoc.bat create mode 100644 html/index.html create mode 100644 html/search.js delete mode 100644 html/verbex/index.html diff --git a/builddoc.bat b/builddoc.bat new file mode 100644 index 0000000..e2920aa --- /dev/null +++ b/builddoc.bat @@ -0,0 +1,3 @@ +pushd "%~dp0" +pdoc verbex/verbex -o html +pause \ No newline at end of file diff --git a/html/index.html b/html/index.html new file mode 100644 index 0000000..0e34fd0 --- /dev/null +++ b/html/index.html @@ -0,0 +1,7 @@ + + + + + + + diff --git a/html/search.js b/html/search.js new file mode 100644 index 0000000..c09a00a --- /dev/null +++ b/html/search.js @@ -0,0 +1,46 @@ +window.pdocSearch = (function(){ +/** elasticlunr - http://weixsong.github.io * Copyright (C) 2017 Oliver Nightingale * Copyright (C) 2017 Wei Song * MIT Licensed */!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u0&&t.push(e);for(var i in n)"docs"!==i&&"df"!==i&&this.expandToken(e+i,t,n[i]);return t},t.InvertedIndex.prototype.toJSON=function(){return{root:this.root}},t.Configuration=function(e,n){var e=e||"";if(void 0==n||null==n)throw new Error("fields should not be null");this.config={};var i;try{i=JSON.parse(e),this.buildUserConfig(i,n)}catch(o){t.utils.warn("user configuration parse failed, will use default configuration"),this.buildDefaultConfig(n)}},t.Configuration.prototype.buildDefaultConfig=function(e){this.reset(),e.forEach(function(e){this.config[e]={boost:1,bool:"OR",expand:!1}},this)},t.Configuration.prototype.buildUserConfig=function(e,n){var i="OR",o=!1;if(this.reset(),"bool"in e&&(i=e.bool||i),"expand"in e&&(o=e.expand||o),"fields"in e)for(var r in e.fields)if(n.indexOf(r)>-1){var s=e.fields[r],u=o;void 0!=s.expand&&(u=s.expand),this.config[r]={boost:s.boost||0===s.boost?s.boost:1,bool:s.bool||i,expand:u}}else t.utils.warn("field name in user configuration not found in index instance fields");else this.addAllFields2UserConfig(i,o,n)},t.Configuration.prototype.addAllFields2UserConfig=function(e,t,n){n.forEach(function(n){this.config[n]={boost:1,bool:e,expand:t}},this)},t.Configuration.prototype.get=function(){return this.config},t.Configuration.prototype.reset=function(){this.config={}},lunr.SortedSet=function(){this.length=0,this.elements=[]},lunr.SortedSet.load=function(e){var t=new this;return t.elements=e,t.length=e.length,t},lunr.SortedSet.prototype.add=function(){var e,t;for(e=0;e1;){if(r===e)return o;e>r&&(t=o),r>e&&(n=o),i=n-t,o=t+Math.floor(i/2),r=this.elements[o]}return r===e?o:-1},lunr.SortedSet.prototype.locationFor=function(e){for(var t=0,n=this.elements.length,i=n-t,o=t+Math.floor(i/2),r=this.elements[o];i>1;)e>r&&(t=o),r>e&&(n=o),i=n-t,o=t+Math.floor(i/2),r=this.elements[o];return r>e?o:e>r?o+1:void 0},lunr.SortedSet.prototype.intersect=function(e){for(var t=new lunr.SortedSet,n=0,i=0,o=this.length,r=e.length,s=this.elements,u=e.elements;;){if(n>o-1||i>r-1)break;s[n]!==u[i]?s[n]u[i]&&i++:(t.add(s[n]),n++,i++)}return t},lunr.SortedSet.prototype.clone=function(){var e=new lunr.SortedSet;return e.elements=this.toArray(),e.length=e.elements.length,e},lunr.SortedSet.prototype.union=function(e){var t,n,i;this.length>=e.length?(t=this,n=e):(t=e,n=this),i=t.clone();for(var o=0,r=n.toArray();oGenerate regular expressions from an easier fluent verbal form.

\n"}, {"fullname": "verbex.verbex.P", "modulename": "verbex.verbex", "qualname": "P", "type": "variable", "doc": "

\n", "default_value": " = ~P"}, {"fullname": "verbex.verbex.HasIter", "modulename": "verbex.verbex", "qualname": "HasIter", "type": "class", "doc": "

Workaround for mypy P.args.

\n", "bases": "typing.Protocol"}, {"fullname": "verbex.verbex.HasIter.__init__", "modulename": "verbex.verbex", "qualname": "HasIter.__init__", "type": "function", "doc": "

\n", "signature": "(self, *args, **kwargs)", "funcdef": "def"}, {"fullname": "verbex.verbex.HasItems", "modulename": "verbex.verbex", "qualname": "HasItems", "type": "class", "doc": "

Workaround for mypy P.kwargs.

\n", "bases": "typing.Protocol"}, {"fullname": "verbex.verbex.HasItems.__init__", "modulename": "verbex.verbex", "qualname": "HasItems.__init__", "type": "function", "doc": "

\n", "signature": "(self, *args, **kwargs)", "funcdef": "def"}, {"fullname": "verbex.verbex.HasItems.items", "modulename": "verbex.verbex", "qualname": "HasItems.items", "type": "function", "doc": "

Object has items method.

\n\n

Returns:\n The dict of items.

\n", "signature": "(self) -> tuple[str, typing.Any]", "funcdef": "def"}, {"fullname": "verbex.verbex.EscapedText", "modulename": "verbex.verbex", "qualname": "EscapedText", "type": "class", "doc": "

Text that has been escaped for regex.

\n\n

Arguments:\n str -- Extend the string class.

\n", "bases": "builtins.str"}, {"fullname": "verbex.verbex.EscapedText.__init__", "modulename": "verbex.verbex", "qualname": "EscapedText.__init__", "type": "function", "doc": "

Return a escaped regex string.

\n\n

Arguments:\n value -- the string to escape

\n\n

Returns:\n _description_

\n", "signature": "(cls, value: str)", "funcdef": "def"}, {"fullname": "verbex.verbex.re_escape", "modulename": "verbex.verbex", "qualname": "re_escape", "type": "function", "doc": "

Automatically escape any string parameters as EscapedText.

\n\n

Arguments:\n func -- The function to decorate.

\n\n

Returns:\n The decorated function.

\n", "signature": "(\n func: collections.abc.Callable[~P, ~R]\n) -> collections.abc.Callable[~P, ~R]", "funcdef": "def"}, {"fullname": "verbex.verbex.CharClass", "modulename": "verbex.verbex", "qualname": "CharClass", "type": "class", "doc": "

Enum of character classes in regex.

\n\n

Arguments:\n Enum -- Extends the Enum class.

\n", "bases": "enum.Enum"}, {"fullname": "verbex.verbex.CharClass.DIGIT", "modulename": "verbex.verbex", "qualname": "CharClass.DIGIT", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.UPPERCASE_LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.UPPERCASE_LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.LOWERCASE_LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.LOWERCASE_LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.WHITESPACE", "modulename": "verbex.verbex", "qualname": "CharClass.WHITESPACE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.TAB", "modulename": "verbex.verbex", "qualname": "CharClass.TAB", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar", "modulename": "verbex.verbex", "qualname": "SpecialChar", "type": "class", "doc": "

Enum of special charaters, shorthand.

\n\n

Arguments:\n Enum -- Extends the Enum class.

\n", "bases": "enum.Enum"}, {"fullname": "verbex.verbex.SpecialChar.LINEBREAK", "modulename": "verbex.verbex", "qualname": "SpecialChar.LINEBREAK", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.START_OF_LINE", "modulename": "verbex.verbex", "qualname": "SpecialChar.START_OF_LINE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.END_OF_LINE", "modulename": "verbex.verbex", "qualname": "SpecialChar.END_OF_LINE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.TAB", "modulename": "verbex.verbex", "qualname": "SpecialChar.TAB", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClassOrChars", "modulename": "verbex.verbex", "qualname": "CharClassOrChars", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[str, verbex.verbex.CharClass]"}, {"fullname": "verbex.verbex.EscapedCharClassOrSpecial", "modulename": "verbex.verbex", "qualname": "EscapedCharClassOrSpecial", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]"}, {"fullname": "verbex.verbex.VerbexEscapedCharClassOrSpecial", "modulename": "verbex.verbex", "qualname": "VerbexEscapedCharClassOrSpecial", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[ForwardRef('Verbex'), str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]"}, {"fullname": "verbex.verbex.Verbex", "modulename": "verbex.verbex", "qualname": "Verbex", "type": "class", "doc": "

VerbalExpressions class.

\n\n

the following methods do not try to match the original js lib!

\n"}, {"fullname": "verbex.verbex.Verbex.__init__", "modulename": "verbex.verbex", "qualname": "Verbex.__init__", "type": "function", "doc": "

Create a Verbex object; setting any needed flags.

\n\n

Keyword Arguments:\n modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})

\n", "signature": "(self, modifiers: re.RegexFlag = )", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.EMPTY_REGEX_FLAG", "modulename": "verbex.verbex", "qualname": "Verbex.EMPTY_REGEX_FLAG", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.Verbex.modifiers", "modulename": "verbex.verbex", "qualname": "Verbex.modifiers", "type": "variable", "doc": "

Return the modifiers for this Verbex object.

\n\n

Returns:\n The modifiers applied to this object.

\n", "annotation": ": re.RegexFlag"}, {"fullname": "verbex.verbex.Verbex.regex", "modulename": "verbex.verbex", "qualname": "Verbex.regex", "type": "function", "doc": "

Get a regular expression object.

\n", "signature": "(self) -> Pattern[str]", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.capture_group", "modulename": "verbex.verbex", "qualname": "Verbex.capture_group", "type": "function", "doc": "

Create a capture group.

\n\n

Name is optional if not specified then the first argument is the text.

\n\n

Keyword Arguments:\n name_or_text -- The name of the group / text to search for (default: {None})\n text -- The text to search for (default: {None})

\n\n

Raises:\n ValueError: If name is specified then text must be as well.

\n\n

Returns:\n Verbex with added capture group.

\n", "signature": "(\n self,\n /,\n name_or_text: Union[str, NoneType, verbex.verbex.Verbex, verbex.verbex.CharClass, verbex.verbex.SpecialChar] = None,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar, NoneType] = None\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.OR", "modulename": "verbex.verbex", "qualname": "Verbex.OR", "type": "function", "doc": "

or is a python keyword so we use OR instead.

\n\n

Arguments:\n text -- Text to find or a Verbex object.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.zero_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.zero_or_more", "type": "function", "doc": "

Find the text or Verbex object zero or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.one_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.one_or_more", "type": "function", "doc": "

Find the text or Verbex object one or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_times", "modulename": "verbex.verbex", "qualname": "Verbex.n_times", "type": "function", "doc": "

Find the text or Verbex object n or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_times_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.n_times_or_more", "type": "function", "doc": "

Find the text or Verbex object at least n times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_to_m_times", "modulename": "verbex.verbex", "qualname": "Verbex.n_to_m_times", "type": "function", "doc": "

Find the text or Verbex object between n and m times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int,\n m: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.maybe", "modulename": "verbex.verbex", "qualname": "Verbex.maybe", "type": "function", "doc": "

Possibly find the text / Verbex object.

\n\n

Arguments:\n text -- The text / Verbex object to possibly find.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.find", "modulename": "verbex.verbex", "qualname": "Verbex.find", "type": "function", "doc": "

Find the text or Verbex object.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.then", "modulename": "verbex.verbex", "qualname": "Verbex.then", "type": "function", "doc": "

Synonym for find.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.followed_by", "modulename": "verbex.verbex", "qualname": "Verbex.followed_by", "type": "function", "doc": "

Match if string is followed by text.

\n\n

Positive lookahead

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_followed_by", "modulename": "verbex.verbex", "qualname": "Verbex.not_followed_by", "type": "function", "doc": "

Match if string is not followed by text.

\n\n

Negative lookahead

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.preceded_by", "modulename": "verbex.verbex", "qualname": "Verbex.preceded_by", "type": "function", "doc": "

Match if string is not preceded by text.

\n\n

Positive lookbehind

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_preceded_by", "modulename": "verbex.verbex", "qualname": "Verbex.not_preceded_by", "type": "function", "doc": "

Match if string is not preceded by text.

\n\n

Negative Lookbehind

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.any_of", "modulename": "verbex.verbex", "qualname": "Verbex.any_of", "type": "function", "doc": "

Find anything in this group of chars or char class.

\n\n

Arguments:\n text -- The characters to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n chargroup: Union[str, verbex.verbex.CharClass]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_any_of", "modulename": "verbex.verbex", "qualname": "Verbex.not_any_of", "type": "function", "doc": "

Find anything but this group of chars or char class.

\n\n

Arguments:\n text -- The characters to not look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[str, verbex.verbex.CharClass]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.anything_but", "modulename": "verbex.verbex", "qualname": "Verbex.anything_but", "type": "function", "doc": "

Find anything one or more times but this group of chars or char class.

\n\n

Arguments:\n text -- The characters to not look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n chargroup: Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.start_of_line", "modulename": "verbex.verbex", "qualname": "Verbex.start_of_line", "type": "function", "doc": "

Find the start of the line.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.end_of_line", "modulename": "verbex.verbex", "qualname": "Verbex.end_of_line", "type": "function", "doc": "

Find the end of the line.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.line_break", "modulename": "verbex.verbex", "qualname": "Verbex.line_break", "type": "function", "doc": "

Find a line break.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.tab", "modulename": "verbex.verbex", "qualname": "Verbex.tab", "type": "function", "doc": "

Find a tab.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.anything", "modulename": "verbex.verbex", "qualname": "Verbex.anything", "type": "function", "doc": "

Find anything one or more time.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.as_few", "modulename": "verbex.verbex", "qualname": "Verbex.as_few", "type": "function", "doc": "

Modify previous search to not be greedy.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.number_range", "modulename": "verbex.verbex", "qualname": "Verbex.number_range", "type": "function", "doc": "

Generate a range of numbers.

\n\n

Arguments:\n start -- Start of the range\n end -- End of the range

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self, start: int, end: int) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.letter_range", "modulename": "verbex.verbex", "qualname": "Verbex.letter_range", "type": "function", "doc": "

Generate a range of letters.

\n\n

Arguments:\n start -- Start of the range\n end -- End of the range

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n start: typing.Annotated[str, Is[_string_len_is_1]],\n end: typing.Annotated[str, Is[_string_len_is_1]]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.word", "modulename": "verbex.verbex", "qualname": "Verbex.word", "type": "function", "doc": "

Find a word on word boundary.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.with_any_case", "modulename": "verbex.verbex", "qualname": "Verbex.with_any_case", "type": "function", "doc": "

Modify Verbex object to be case insensitive.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.search_by_line", "modulename": "verbex.verbex", "qualname": "Verbex.search_by_line", "type": "function", "doc": "

Search each line, ^ and $ match begining and end of line respectively.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.with_ascii", "modulename": "verbex.verbex", "qualname": "Verbex.with_ascii", "type": "function", "doc": "

Match ascii instead of unicode.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}]; + + // mirrored in build-search-index.js (part 1) + // Also split on html tags. this is a cheap heuristic, but good enough. + elasticlunr.tokenizer.setSeperator(/[\s\-.;&_'"=,()]+|<[^>]*>/); + + let searchIndex; + if (docs._isPrebuiltIndex) { + console.info("using precompiled search index"); + searchIndex = elasticlunr.Index.load(docs); + } else { + console.time("building search index"); + // mirrored in build-search-index.js (part 2) + searchIndex = elasticlunr(function () { + this.pipeline.remove(elasticlunr.stemmer); + this.pipeline.remove(elasticlunr.stopWordFilter); + this.addField("qualname"); + this.addField("fullname"); + this.addField("annotation"); + this.addField("default_value"); + this.addField("signature"); + this.addField("bases"); + this.addField("doc"); + this.setRef("fullname"); + }); + for (let doc of docs) { + searchIndex.addDoc(doc); + } + console.timeEnd("building search index"); + } + + return (term) => searchIndex.search(term, { + fields: { + qualname: {boost: 4}, + fullname: {boost: 2}, + annotation: {boost: 2}, + default_value: {boost: 2}, + signature: {boost: 2}, + bases: {boost: 2}, + doc: {boost: 1}, + }, + expand: true + }); +})(); \ No newline at end of file diff --git a/html/verbex/index.html b/html/verbex/index.html deleted file mode 100644 index fa7fe2b..0000000 --- a/html/verbex/index.html +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - -verbex API documentation - - - - - - - - - - - -
-
-
-

Package verbex

-
-
-
- -Expand source code - -
from .verbex import CharClass as CharClass
-from .verbex import SpecialChar as SpecialChar
-from .verbex import Verbex as Verbex
-
-
-
-

Sub-modules

-
-
verbex.verbex
-
-

Generate regular expressions from an easier fluent verbal form.

-
-
-
-
-
-
-
-
-
-
- -
- - - \ No newline at end of file diff --git a/html/verbex/verbex.html b/html/verbex/verbex.html index 639b601..7d497c4 100644 --- a/html/verbex/verbex.html +++ b/html/verbex/verbex.html @@ -1,2290 +1,3139 @@ - - - -verbex.verbex API documentation - - - - - - - - - - + + + + verbex.verbex API documentation + + + + + + + -
-
-
-

Module verbex.verbex

-
-
-

Generate regular expressions from an easier fluent verbal form.

-
- -Expand source code - -
"""Generate regular expressions from an easier fluent verbal form."""
-from __future__ import annotations
+    
+    

+            

+                    

+verbex.verbex    

 
-import re
-from enum import Enum
-from functools import wraps
-
-try:
-    from typing import (  # <--------------- if Python ≥ 3.9.0
-        Annotated,
-        ParamSpec,
-        TypeAlias,
-    )
-except (ModuleNotFoundError, ImportError):
-    from typing_extensions import TypeAlias, Annotated, ParamSpec  # type: ignore # <--- if Python < 3.9.0
-
-from typing import Pattern, Protocol, TypeVar
-
-from beartype import beartype  # type: ignore
-from beartype.typing import (  # type: ignore
-    Any,
-    Callable,
-    Dict,
-    Iterator,
-    List,
-    Optional,
-    Tuple,
-    Union,
-    cast,
-    runtime_checkable,
-)
-from beartype.vale import Is  # type: ignore
-
-
-def _string_len_is_1(text: object) -> bool:
-    return isinstance(text, str) and len(text) == 1
-
-
-Char = Annotated[str, Is[_string_len_is_1]]
-
-
-P = ParamSpec("P")  # noqa VNE001
-R = TypeVar("R")  # noqa VNE001
-
-
-# work around for bug https://github.com/python/mypy/issues/12660
-# fixed in next version of mypy
-@runtime_checkable
-class HasIter(Protocol):
-    """Workaround for mypy P.args."""
-
-    def __iter__(self) -> Iterator[Any]:
-        """Object can be iterated.
-
-        Yields:
-            Next object.
-        """
-        ...
-
-
-# work around for bug https://github.com/python/mypy/issues/12660
-# fixed in next version of mypy
-@runtime_checkable
-class HasItems(Protocol):
-    """Workaround for mypy P.kwargs."""
-
-    def items(self) -> Tuple[str, Any]:
-        """Object has items method.
-
-        Returns:
-            The dict of items.
-        """
-        ...
+                        
Generate regular expressions from an easier fluent verbal form.

+

 
+                        

+            View Source
+            
  0"""Generate regular expressions from an easier fluent verbal form."""
+  1from __future__ import annotations
+  2
+  3import re
+  4from enum import Enum
+  5from functools import wraps
+  6
+  7try:
+  8    from typing import (  # <--------------- if Python ≥ 3.9.0
+  9        Annotated,
+ 10        ParamSpec,
+ 11        TypeAlias,
+ 12    )
+ 13except (ModuleNotFoundError, ImportError):
+ 14    from typing_extensions import TypeAlias, Annotated, ParamSpec  # type: ignore # <--- if Python < 3.9.0
+ 15
+ 16from typing import Pattern, Protocol, TypeVar
+ 17
+ 18from beartype import beartype  # type: ignore
+ 19from beartype.typing import (  # type: ignore
+ 20    Any,
+ 21    Callable,
+ 22    Dict,
+ 23    Iterator,
+ 24    List,
+ 25    Optional,
+ 26    Tuple,
+ 27    Union,
+ 28    cast,
+ 29    runtime_checkable,
+ 30)
+ 31from beartype.vale import Is  # type: ignore
+ 32
+ 33
+ 34def _string_len_is_1(text: object) -> bool:
+ 35    return isinstance(text, str) and len(text) == 1
+ 36
+ 37
+ 38Char = Annotated[str, Is[_string_len_is_1]]
+ 39
+ 40
+ 41P = ParamSpec("P")  # noqa VNE001
+ 42R = TypeVar("R")  # noqa VNE001
+ 43
+ 44
+ 45# work around for bug https://github.com/python/mypy/issues/12660
+ 46# fixed in next version of mypy
+ 47@runtime_checkable
+ 48class HasIter(Protocol):
+ 49    """Workaround for mypy P.args."""
+ 50
+ 51    def __iter__(self) -> Iterator[Any]:
+ 52        """Object can be iterated.
+ 53
+ 54        Yields:
+ 55            Next object.
+ 56        """
+ 57        ...
+ 58
+ 59
+ 60# work around for bug https://github.com/python/mypy/issues/12660
+ 61# fixed in next version of mypy
+ 62@runtime_checkable
+ 63class HasItems(Protocol):
+ 64    """Workaround for mypy P.kwargs."""
+ 65
+ 66    def items(self) -> Tuple[str, Any]:
+ 67        """Object has items method.
+ 68
+ 69        Returns:
+ 70            The dict of items.
+ 71        """
+ 72        ...
+ 73
+ 74
+ 75class EscapedText(str):
+ 76    """Text that has been escaped for regex.
+ 77
+ 78    Arguments:
+ 79        str -- Extend the string class.
+ 80    """
+ 81
+ 82    def __new__(cls, value: str) -> EscapedText:
+ 83        """Return a escaped regex string.
+ 84
+ 85        Arguments:
+ 86            value -- the string to escape
+ 87
+ 88        Returns:
+ 89            _description_
+ 90        """
+ 91        return str.__new__(cls, re.escape(value))
+ 92
+ 93
+ 94def re_escape(func: Callable[P, R]) -> Callable[P, R]:
+ 95    """Automatically escape any string parameters as EscapedText.
+ 96
+ 97    Arguments:
+ 98        func -- The function to decorate.
+ 99
+100    Returns:
+101        The decorated function.
+102    """
+103
+104    @wraps(func)
+105    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
+106        escaped_args: List[Any] = []
+107        escaped_kwargs: Dict[str, Any] = {}
+108        for arg in cast(HasIter, args):
+109            if not isinstance(arg, EscapedText) and isinstance(arg, str):
+110                escaped_args.append(EscapedText(arg))
+111            else:
+112                escaped_args.append(arg)
+113        arg_k: str
+114        arg_v: Any
+115        for arg_k, arg_v in cast(HasItems, kwargs).items():
+116            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
+117                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
+118            else:
+119                escaped_kwargs[arg_k] = arg_v
+120        return func(*escaped_args, **escaped_kwargs)  # type: ignore
+121
+122    return inner
+123
+124
+125class CharClass(Enum):
+126    """Enum of character classes in regex.
+127
+128    Arguments:
+129        Enum -- Extends the Enum class.
+130    """
+131
+132    DIGIT = "\\d"
+133    LETTER = "\\w"
+134    UPPERCASE_LETTER = "\\u"
+135    LOWERCASE_LETTER = "\\l"
+136    WHITESPACE = "\\s"
+137    TAB = "\\t"
+138
+139    def __str__(self) -> str:
+140        """To string method based on Enum value.
+141
+142        Returns:
+143            value of Enum
+144        """
+145        return self.value
+146
+147
+148class SpecialChar(Enum):
+149    """Enum of special charaters, shorthand.
+150
+151    Arguments:
+152        Enum -- Extends the Enum class.
+153    """
+154
+155    # does not work  / should not be used in [ ]
+156    LINEBREAK = "(\\n|(\\r\\n))"
+157    START_OF_LINE = "^"
+158    END_OF_LINE = "$"
+159    TAB = "\t"
+160
+161    def __str__(self) -> str:
+162        """To string for special chars enum.
+163
+164        Returns:
+165            Return value of enum as string.
+166        """
+167        return self.value
+168
+169
+170CharClassOrChars: TypeAlias = Union[str, CharClass]
+171EscapedCharClassOrSpecial: TypeAlias = Union[str, CharClass, SpecialChar]
+172VerbexEscapedCharClassOrSpecial: TypeAlias = Union["Verbex", EscapedCharClassOrSpecial]
+173
+174
+175class Verbex:
+176    """
+177    VerbalExpressions class.
+178
+179    the following methods do not try to match the original js lib!
+180    """
+181
+182    EMPTY_REGEX_FLAG = re.RegexFlag(0)
+183
+184    @re_escape
+185    @beartype
+186    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
+187        """Create a Verbex object; setting any needed flags.
+188
+189        Keyword Arguments:
+190            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
+191        """
+192        # self._parts: List[str] = [text]
+193        self._parts: List[str] = []
+194        self._modifiers = modifiers
+195
+196    @property
+197    def modifiers(self) -> re.RegexFlag:
+198        """Return the modifiers for this Verbex object.
+199
+200        Returns:
+201            The modifiers applied to this object.
+202        """
+203        return self._modifiers
+204
+205    def __str__(self) -> str:
+206        """Return regex string representation."""
+207        return "".join(self._parts)
+208
+209    @beartype
+210    def _add(self, value: Union[str, List[str]]) -> Verbex:
+211        """
+212        Append a transformed value to internal expression to be compiled.
+213
+214        As possible, this method should be "private".
+215        """
+216        if isinstance(value, list):
+217            self._parts.extend(value)
+218        else:
+219            self._parts.append(value)
+220        return self
+221
+222    def regex(self) -> Pattern[str]:
+223        """Get a regular expression object."""
+224        return re.compile(
+225            str(self),
+226            self._modifiers,
+227        )
+228
+229    # allow VerbexEscapedCharClassOrSpecial
+230
+231    @re_escape
+232    @beartype
+233    def _capture_group_with_name(
+234        self,
+235        name: str,
+236        text: VerbexEscapedCharClassOrSpecial,
+237    ) -> Verbex:
+238        return self._add(f"(?<{name}>{str(text)})")
+239
+240    @re_escape
+241    @beartype
+242    def _capture_group_without_name(
+243        self,
+244        text: VerbexEscapedCharClassOrSpecial,
+245    ) -> Verbex:
+246        return self._add(f"({str(text)})")
+247
+248    @re_escape
+249    @beartype
+250    def capture_group(
+251        self,
+252        /,
+253        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
+254        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
+255    ) -> Verbex:
+256        """Create a capture group.
+257
+258        Name is optional if not specified then the first argument is the text.
+259
+260        Keyword Arguments:
+261            name_or_text -- The name of the group / text to search for (default: {None})
+262            text -- The text to search for (default: {None})
+263
+264        Raises:
+265            ValueError: If name is specified then text must be as well.
+266
+267        Returns:
+268            Verbex with added capture group.
+269        """
+270        if name_or_text is not None:
+271            if text is None:
+272                _text = name_or_text
+273                return self._capture_group_without_name(_text)
+274            if isinstance(name_or_text, str):
+275                return self._capture_group_with_name(name_or_text, text)
+276        raise ValueError("text must be specified with optional name")
+277
+278    @re_escape
+279    @beartype
+280    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
+281        """`or` is a python keyword so we use `OR` instead.
+282
+283        Arguments:
+284            text -- Text to find or a Verbex object.
+285
+286        Returns:
+287            Modified Verbex object.
+288        """
+289        return self._add("|").find(text)
+290
+291    @re_escape
+292    @beartype
+293    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+294        """Find the text or Verbex object zero or more times.
+295
+296        Arguments:
+297            text -- The text / Verbex object to look for.
+298
+299        Returns:
+300            Modified Verbex object.
+301        """
+302        return self._add(f"(?:{str(text)})*")
+303
+304    @re_escape
+305    @beartype
+306    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+307        """Find the text or Verbex object one or more times.
+308
+309        Arguments:
+310            text -- The text / Verbex object to look for.
+311
+312        Returns:
+313            Modified Verbex object.
+314        """
+315        return self._add(f"(?:{str(text)})+")
+316
+317    @re_escape
+318    @beartype
+319    def n_times(
+320        self,
+321        text: VerbexEscapedCharClassOrSpecial,
+322        n: int,  # noqa: VNE001
+323    ) -> Verbex:
+324        """Find the text or Verbex object n or more times.
+325
+326        Arguments:
+327            text -- The text / Verbex object to look for.
+328
+329        Returns:
+330            Modified Verbex object.
+331        """
+332        return self._add(f"(?:{str(text)}){{{n}}}")
+333
+334    @re_escape
+335    @beartype
+336    def n_times_or_more(
+337        self,
+338        text: VerbexEscapedCharClassOrSpecial,
+339        n: int,  # noqa: VNE001
+340    ) -> Verbex:
+341        """Find the text or Verbex object at least n times.
+342
+343        Arguments:
+344            text -- The text / Verbex object to look for.
+345
+346        Returns:
+347            Modified Verbex object.
+348        """
+349        return self._add(f"(?:{str(text)}){{{n},}}")
+350
+351    @re_escape
+352    @beartype
+353    def n_to_m_times(
+354        self,
+355        text: VerbexEscapedCharClassOrSpecial,
+356        n: int,  # noqa: VNE001
+357        m: int,  # noqa: VNE001
+358    ) -> Verbex:
+359        """Find the text or Verbex object between n and m times.
+360
+361        Arguments:
+362            text -- The text / Verbex object to look for.
+363
+364        Returns:
+365            Modified Verbex object.
+366        """
+367        return self._add(f"(?:{str(text)}){{{n},{m}}}")
+368
+369    @re_escape
+370    @beartype
+371    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+372        """Possibly find the text / Verbex object.
+373
+374        Arguments:
+375            text -- The text / Verbex object to possibly find.
+376
+377        Returns:
+378            Modified Verbex object.
+379        """
+380        return self._add(f"(?:{str(text)})?")
+381
+382    @re_escape
+383    @beartype
+384    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+385        """Find the text or Verbex object.
+386
+387        Arguments:
+388            text -- The text / Verbex object to look for.
+389
+390        Returns:
+391            Modified Verbex object.
+392        """
+393        return self._add(str(text))
+394
+395    @re_escape
+396    @beartype
+397    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+398        """Synonym for find.
+399
+400        Arguments:
+401            text -- The text / Verbex object to look for.
+402
+403        Returns:
+404            Modified Verbex object.
+405        """
+406        return self.find(text)
+407
+408    @re_escape
+409    @beartype
+410    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+411        """Match if string is followed by text.
+412
+413        Positive lookahead
+414
+415        Returns:
+416            Modified Verbex object.
+417        """
+418        return self._add(f"(?={text})")
+419
+420    @re_escape
+421    @beartype
+422    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+423        """Match if string is not followed by text.
+424
+425        Negative lookahead
+426
+427        Returns:
+428            Modified Verbex object.
+429        """
+430        return self._add(f"(?!{text})")
+431
+432    @re_escape
+433    @beartype
+434    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+435        """Match if string is not preceded by text.
+436
+437        Positive lookbehind
+438
+439        Returns:
+440            Modified Verbex object.
+441        """
+442        return self._add(f"(?<={text})")
+443
+444    @re_escape
+445    @beartype
+446    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+447        """Match if string is not preceded by text.
+448
+449        Negative Lookbehind
+450
+451        Returns:
+452            Modified Verbex object.
+453        """
+454        return self._add(f"(?<!{text})")
+455
+456    # only allow CharclassOrChars
+457
+458    @re_escape
+459    @beartype
+460    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
+461        """Find anything in this group of chars or char class.
+462
+463        Arguments:
+464            text -- The characters to look for.
+465
+466        Returns:
+467            Modified Verbex object.
+468        """
+469        return self._add(f"(?:[{chargroup}])")
+470
+471    @re_escape
+472    @beartype
+473    def not_any_of(self, text: CharClassOrChars) -> Verbex:
+474        """Find anything but this group of chars or char class.
+475
+476        Arguments:
+477            text -- The characters to not look for.
+478
+479        Returns:
+480            Modified Verbex object.
+481        """
+482        return self._add(f"(?:[^{text}])")
+483
+484    @re_escape
+485    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
+486        """Find anything one or more times but this group of chars or char class.
+487
+488        Arguments:
+489            text -- The characters to not look for.
+490
+491        Returns:
+492            Modified Verbex object.
+493        """
+494        return self._add(f"[^{chargroup}]+")
+495
+496    # no text input
+497
+498    def start_of_line(self) -> Verbex:
+499        """Find the start of the line.
+500
+501        Returns:
+502            Modified Verbex object.
+503        """
+504        return self.find(SpecialChar.START_OF_LINE)
+505
+506    def end_of_line(self) -> Verbex:
+507        """Find the end of the line.
+508
+509        Returns:
+510            Modified Verbex object.
+511        """
+512        return self.find(SpecialChar.END_OF_LINE)
+513
+514    def line_break(self) -> Verbex:
+515        """Find a line break.
+516
+517        Returns:
+518            Modified Verbex object.
+519        """
+520        return self.find(SpecialChar.LINEBREAK)
+521
+522    def tab(self) -> Verbex:
+523        """Find a tab.
+524
+525        Returns:
+526            Modified Verbex object.
+527        """
+528        return self.find(SpecialChar.TAB)
+529
+530    def anything(self) -> Verbex:
+531        """Find anything one or more time.
+532
+533        Returns:
+534            Modified Verbex object.
+535        """
+536        return self._add(".+")
+537
+538    def as_few(self) -> Verbex:
+539        """Modify previous search to not be greedy.
+540
+541        Returns:
+542            Modified Verbex object.
+543        """
+544        return self._add("?")
+545
+546    @beartype
+547    def number_range(self, start: int, end: int) -> Verbex:
+548        """Generate a range of numbers.
+549
+550        Arguments:
+551            start -- Start of the range
+552            end -- End of the range
+553
+554        Returns:
+555            Modified Verbex object.
+556        """
+557        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
+558
+559    @beartype
+560    def letter_range(self, start: Char, end: Char) -> Verbex:
+561        """Generate a range of letters.
+562
+563        Arguments:
+564            start -- Start of the range
+565            end -- End of the range
+566
+567        Returns:
+568            Modified Verbex object.
+569        """
+570        return self._add(f"[{start}-{end}]")
+571
+572    def word(self) -> Verbex:
+573        """Find a word on word boundary.
+574
+575        Returns:
+576            Modified Verbex object.
+577        """
+578        return self._add("(\\b\\w+\\b)")
+579
+580    # # --------------- modifiers ------------------------
+581
+582    def with_any_case(self) -> Verbex:
+583        """Modify Verbex object to be case insensitive.
+584
+585        Returns:
+586            Modified Verbex object.
+587        """
+588        self._modifiers |= re.IGNORECASE
+589        return self
+590
+591    def search_by_line(self) -> Verbex:
+592        """Search each line, ^ and $ match begining and end of line respectively.
+593
+594        Returns:
+595            Modified Verbex object.
+596        """
+597        self._modifiers |= re.MULTILINE
+598        return self
+599
+600    def with_ascii(self) -> Verbex:
+601        """Match ascii instead of unicode.
+602
+603        Returns:
+604            Modified Verbex object.
+605        """
+606        self._modifiers |= re.ASCII
+607        return self
+608
+609
+610# left over notes from original version
+611# def __getattr__(self, attr):
+612#     """ any other function will be sent to the regex object """
+613#     regex = self.regex()
+614#     return getattr(regex, attr)
+615
+616# def replace(self, string, repl):
+617#     return self.sub(repl, string)
+618
+619
+620if __name__ == "__main__":
+621    pass
+

+
+        

+
+            

+                

+                                
#  
+
+        P = ~P
+    

+
+    
+    
+
+                

+                

+                                

+        #  
+
+                
@runtime_checkable

+
+        class
+        HasIter(typing.Protocol):
+    

+
+            

+            View Source
+            
48@runtime_checkable
+49class HasIter(Protocol):
+50    """Workaround for mypy P.args."""
+51
+52    def __iter__(self) -> Iterator[Any]:
+53        """Object can be iterated.
+54
+55        Yields:
+56            Next object.
+57        """
+58        ...
+

+
+        

+
+            
Workaround for mypy P.args.

+

 
-class EscapedText(str):
-    """Text that has been escaped for regex.
-
-    Arguments:
-        str -- Extend the string class.
-    """
 
-    def __new__(cls, value: str) -> EscapedText:
-        """Return a escaped regex string.
+                            

+                                        
#  
+
+        
+            HasIter(*args, **kwargs)
+    

+
+            

+            View Source
+            
1429def _no_init_or_replace_init(self, *args, **kwargs):
+1430    cls = type(self)
+1431
+1432    if cls._is_protocol:
+1433        raise TypeError('Protocols cannot be instantiated')
+1434
+1435    # Already using a custom `__init__`. No need to calculate correct
+1436    # `__init__` to call. This can lead to RecursionError. See bpo-45121.
+1437    if cls.__init__ is not _no_init_or_replace_init:
+1438        return
+1439
+1440    # Initially, `__init__` of a protocol subclass is set to `_no_init_or_replace_init`.
+1441    # The first instantiation of the subclass will call `_no_init_or_replace_init` which
+1442    # searches for a proper new `__init__` in the MRO. The new `__init__`
+1443    # replaces the subclass' old `__init__` (ie `_no_init_or_replace_init`). Subsequent
+1444    # instantiation of the protocol subclass will thus use the new
+1445    # `__init__` and no longer call `_no_init_or_replace_init`.
+1446    for base in cls.__mro__:
+1447        init = base.__dict__.get('__init__', _no_init_or_replace_init)
+1448        if init is not _no_init_or_replace_init:
+1449            cls.__init__ = init
+1450            break
+1451    else:
+1452        # should not happen
+1453        cls.__init__ = object.__init__
+1454
+1455    cls.__init__(self, *args, **kwargs)
+

+
+        

+
+    
+
+                            

+                

+                

+                                

+        #  
+
+                
@runtime_checkable

+
+        class
+        HasItems(typing.Protocol):
+    

+
+            

+            View Source
+            
63@runtime_checkable
+64class HasItems(Protocol):
+65    """Workaround for mypy P.kwargs."""
+66
+67    def items(self) -> Tuple[str, Any]:
+68        """Object has items method.
+69
+70        Returns:
+71            The dict of items.
+72        """
+73        ...
+

+
+        

+
+            
Workaround for mypy P.kwargs.

+

 
-        Arguments:
-            value -- the string to escape
 
-        Returns:
-            _description_
-        """
-        return str.__new__(cls, re.escape(value))
+                            

+                                        
#  
+
+        
+            HasItems(*args, **kwargs)
+    

+
+            

+            View Source
+            
1429def _no_init_or_replace_init(self, *args, **kwargs):
+1430    cls = type(self)
+1431
+1432    if cls._is_protocol:
+1433        raise TypeError('Protocols cannot be instantiated')
+1434
+1435    # Already using a custom `__init__`. No need to calculate correct
+1436    # `__init__` to call. This can lead to RecursionError. See bpo-45121.
+1437    if cls.__init__ is not _no_init_or_replace_init:
+1438        return
+1439
+1440    # Initially, `__init__` of a protocol subclass is set to `_no_init_or_replace_init`.
+1441    # The first instantiation of the subclass will call `_no_init_or_replace_init` which
+1442    # searches for a proper new `__init__` in the MRO. The new `__init__`
+1443    # replaces the subclass' old `__init__` (ie `_no_init_or_replace_init`). Subsequent
+1444    # instantiation of the protocol subclass will thus use the new
+1445    # `__init__` and no longer call `_no_init_or_replace_init`.
+1446    for base in cls.__mro__:
+1447        init = base.__dict__.get('__init__', _no_init_or_replace_init)
+1448        if init is not _no_init_or_replace_init:
+1449            cls.__init__ = init
+1450            break
+1451    else:
+1452        # should not happen
+1453        cls.__init__ = object.__init__
+1454
+1455    cls.__init__(self, *args, **kwargs)
+

+
+        

+
+    
+
+                            

+                            

+                                        
#  
+
+        
+            def
+            items(self) -> tuple[str, typing.Any]:
+    

+
+            

+            View Source
+            
67    def items(self) -> Tuple[str, Any]:
+68        """Object has items method.
+69
+70        Returns:
+71            The dict of items.
+72        """
+73        ...
+

+
+        

+
+            
Object has items method.

+
+
Returns:
+    The dict of items.

+

 
 
-def re_escape(func: Callable[P, R]) -> Callable[P, R]:
-    """Automatically escape any string parameters as EscapedText.
+                            

+                

+                

+                                

+        #  
+
+        
+        class
+        EscapedText(builtins.str):
+    

+
+            

+            View Source
+            
76class EscapedText(str):
+77    """Text that has been escaped for regex.
+78
+79    Arguments:
+80        str -- Extend the string class.
+81    """
+82
+83    def __new__(cls, value: str) -> EscapedText:
+84        """Return a escaped regex string.
+85
+86        Arguments:
+87            value -- the string to escape
+88
+89        Returns:
+90            _description_
+91        """
+92        return str.__new__(cls, re.escape(value))
+

+
+        

+
+            
Text that has been escaped for regex.

+
+
Arguments:
+    str -- Extend the string class.

+

 
-    Arguments:
-        func -- The function to decorate.
 
-    Returns:
-        The decorated function.
-    """
+                            

+                                        
#  
 
-    @wraps(func)
-    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
-        escaped_args: List[Any] = []
-        escaped_kwargs: Dict[str, Any] = {}
-        for arg in cast(HasIter, args):
-            if not isinstance(arg, EscapedText) and isinstance(arg, str):
-                escaped_args.append(EscapedText(arg))
-            else:
-                escaped_args.append(arg)
-        arg_k: str
-        arg_v: Any
-        for arg_k, arg_v in cast(HasItems, kwargs).items():
-            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
-                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
-            else:
-                escaped_kwargs[arg_k] = arg_v
-        return func(*escaped_args, **escaped_kwargs)  # type: ignore
+        
+            EscapedText(value: str)
+    

 
-    return inner
+            

+            View Source
+            
83    def __new__(cls, value: str) -> EscapedText:
+84        """Return a escaped regex string.
+85
+86        Arguments:
+87            value -- the string to escape
+88
+89        Returns:
+90            _description_
+91        """
+92        return str.__new__(cls, re.escape(value))
+

 
+        

 
-class CharClass(Enum):
-    """Enum of character classes in regex.
+            
Return a escaped regex string.

 
-    Arguments:
-        Enum -- Extends the Enum class.
-    """
+
Arguments:
+    value -- the string to escape

 
-    DIGIT = "\\d"
-    LETTER = "\\w"
-    UPPERCASE_LETTER = "\\u"
-    LOWERCASE_LETTER = "\\l"
-    WHITESPACE = "\\s"
-    TAB = "\\t"
+
Returns:
+    _description_

+

 
-    def __str__(self) -> str:
-        """To string method based on Enum value.
-
-        Returns:
-            value of Enum
-        """
-        return self.value
-
-
-class SpecialChar(Enum):
-    """Enum of special charaters, shorthand.
-
-    Arguments:
-        Enum -- Extends the Enum class.
-    """
-
-    # does not work  / should not be used in [ ]
-    LINEBREAK = "(\\n|(\\r\\n))"
-    START_OF_LINE = "^"
-    END_OF_LINE = "$"
-    TAB = "\t"
-
-    def __str__(self) -> str:
-        """To string for special chars enum.
-
-        Returns:
-            Return value of enum as string.
-        """
-        return self.value
-
-
-CharClassOrChars: TypeAlias = Union[str, CharClass]
-EscapedCharClassOrSpecial: TypeAlias = Union[str, CharClass, SpecialChar]
-VerbexEscapedCharClassOrSpecial: TypeAlias = Union["Verbex", EscapedCharClassOrSpecial]
-
-
-class Verbex:
-    """
-    VerbalExpressions class.
-
-    the following methods do not try to match the original js lib!
-    """
-
-    EMPTY_REGEX_FLAG = re.RegexFlag(0)
-
-    @re_escape
-    @beartype
-    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
-        """Create a Verbex object; setting any needed flags.
-
-        Keyword Arguments:
-            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
-        """
-        # self._parts: List[str] = [text]
-        self._parts: List[str] = []
-        self._modifiers = modifiers
-
-    @property
-    def modifiers(self) -> re.RegexFlag:
-        """Return the modifiers for this Verbex object.
-
-        Returns:
-            The modifiers applied to this object.
-        """
-        return self._modifiers
-
-    def __str__(self) -> str:
-        """Return regex string representation."""
-        return "".join(self._parts)
-
-    @beartype
-    def _add(self, value: Union[str, List[str]]) -> Verbex:
-        """
-        Append a transformed value to internal expression to be compiled.
-
-        As possible, this method should be "private".
-        """
-        if isinstance(value, list):
-            self._parts.extend(value)
-        else:
-            self._parts.append(value)
-        return self
-
-    def regex(self) -> Pattern[str]:
-        """Get a regular expression object."""
-        return re.compile(
-            str(self),
-            self._modifiers,
-        )
-
-    # allow VerbexEscapedCharClassOrSpecial
-
-    @re_escape
-    @beartype
-    def _capture_group_with_name(
-        self,
-        name: str,
-        text: VerbexEscapedCharClassOrSpecial,
-    ) -> Verbex:
-        return self._add(f"(?<{name}>{str(text)})")
-
-    @re_escape
-    @beartype
-    def _capture_group_without_name(
-        self,
-        text: VerbexEscapedCharClassOrSpecial,
-    ) -> Verbex:
-        return self._add(f"({str(text)})")
-
-    @re_escape
-    @beartype
-    def capture_group(
-        self,
-        /,
-        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
-        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
-    ) -> Verbex:
-        """Create a capture group.
-
-        Name is optional if not specified then the first argument is the text.
-
-        Keyword Arguments:
-            name_or_text -- The name of the group / text to search for (default: {None})
-            text -- The text to search for (default: {None})
-
-        Raises:
-            ValueError: If name is specified then text must be as well.
-
-        Returns:
-            Verbex with added capture group.
-        """
-        if name_or_text is not None:
-            if text is None:
-                _text = name_or_text
-                return self._capture_group_without_name(_text)
-            if isinstance(name_or_text, str):
-                return self._capture_group_with_name(name_or_text, text)
-        raise ValueError("text must be specified with optional name")
-
-    @re_escape
-    @beartype
-    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
-        """`or` is a python keyword so we use `OR` instead.
-
-        Arguments:
-            text -- Text to find or a Verbex object.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add("|").find(text)
-
-    @re_escape
-    @beartype
-    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Find the text or Verbex object zero or more times.
-
-        Arguments:
-            text -- The text / Verbex object to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:{str(text)})*")
-
-    @re_escape
-    @beartype
-    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Find the text or Verbex object one or more times.
-
-        Arguments:
-            text -- The text / Verbex object to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:{str(text)})+")
-
-    @re_escape
-    @beartype
-    def n_times(
-        self,
-        text: VerbexEscapedCharClassOrSpecial,
-        n: int,  # noqa: VNE001
-    ) -> Verbex:
-        """Find the text or Verbex object n or more times.
-
-        Arguments:
-            text -- The text / Verbex object to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:{str(text)}){{{n}}}")
-
-    @re_escape
-    @beartype
-    def n_times_or_more(
-        self,
-        text: VerbexEscapedCharClassOrSpecial,
-        n: int,  # noqa: VNE001
-    ) -> Verbex:
-        """Find the text or Verbex object at least n times.
-
-        Arguments:
-            text -- The text / Verbex object to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:{str(text)}){{{n},}}")
-
-    @re_escape
-    @beartype
-    def n_to_m_times(
-        self,
-        text: VerbexEscapedCharClassOrSpecial,
-        n: int,  # noqa: VNE001
-        m: int,  # noqa: VNE001
-    ) -> Verbex:
-        """Find the text or Verbex object between n and m times.
-
-        Arguments:
-            text -- The text / Verbex object to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:{str(text)}){{{n},{m}}}")
-
-    @re_escape
-    @beartype
-    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Possibly find the text / Verbex object.
-
-        Arguments:
-            text -- The text / Verbex object to possibly find.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:{str(text)})?")
-
-    @re_escape
-    @beartype
-    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Find the text or Verbex object.
-
-        Arguments:
-            text -- The text / Verbex object to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(str(text))
-
-    @re_escape
-    @beartype
-    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Synonym for find.
-
-        Arguments:
-            text -- The text / Verbex object to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self.find(text)
-
-    @re_escape
-    @beartype
-    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Match if string is followed by text.
-
-        Positive lookahead
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?={text})")
-
-    @re_escape
-    @beartype
-    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Match if string is not followed by text.
-
-        Negative lookahead
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?!{text})")
-
-    @re_escape
-    @beartype
-    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Match if string is not preceded by text.
-
-        Positive lookbehind
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?<={text})")
-
-    @re_escape
-    @beartype
-    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Match if string is not preceded by text.
-
-        Negative Lookbehind
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?<!{text})")
-
-    # only allow CharclassOrChars
-
-    @re_escape
-    @beartype
-    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
-        """Find anything in this group of chars or char class.
 
-        Arguments:
-            text -- The characters to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:[{chargroup}])")
-
-    @re_escape
-    @beartype
-    def not_any_of(self, text: CharClassOrChars) -> Verbex:
-        """Find anything but this group of chars or char class.
+                            

+                            

+                                
Inherited Members

+                                

+                                    
builtins.str

+                                
encode

+                
replace

+                
split

+                
rsplit

+                
join

+                
capitalize

+                
casefold

+                
title

+                
center

+                
count

+                
expandtabs

+                
find

+                
partition

+                
index

+                
ljust

+                
lower

+                
lstrip

+                
rfind

+                
rindex

+                
rjust

+                
rstrip

+                
rpartition

+                
splitlines

+                
strip

+                
swapcase

+                
translate

+                
upper

+                
startswith

+                
endswith

+                
removeprefix

+                
removesuffix

+                
isascii

+                
islower

+                
isupper

+                
istitle

+                
isspace

+                
isdecimal

+                
isdigit

+                
isnumeric

+                
isalpha

+                
isalnum

+                
isidentifier

+                
isprintable

+                
zfill

+                
format

+                
format_map

+                
maketrans

+
+            

+                                

+                            

+                

+                

+                            
#  
+
+        
+            def
+            re_escape(
+    func: collections.abc.Callable[~P, ~R]
+) -> collections.abc.Callable[~P, ~R]:
+    

+
+            

+            View Source
+            
 95def re_escape(func: Callable[P, R]) -> Callable[P, R]:
+ 96    """Automatically escape any string parameters as EscapedText.
+ 97
+ 98    Arguments:
+ 99        func -- The function to decorate.
+100
+101    Returns:
+102        The decorated function.
+103    """
+104
+105    @wraps(func)
+106    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
+107        escaped_args: List[Any] = []
+108        escaped_kwargs: Dict[str, Any] = {}
+109        for arg in cast(HasIter, args):
+110            if not isinstance(arg, EscapedText) and isinstance(arg, str):
+111                escaped_args.append(EscapedText(arg))
+112            else:
+113                escaped_args.append(arg)
+114        arg_k: str
+115        arg_v: Any
+116        for arg_k, arg_v in cast(HasItems, kwargs).items():
+117            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
+118                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
+119            else:
+120                escaped_kwargs[arg_k] = arg_v
+121        return func(*escaped_args, **escaped_kwargs)  # type: ignore
+122
+123    return inner
+

+
+        

+
+            
Automatically escape any string parameters as EscapedText.

+
+
Arguments:
+    func -- The function to decorate.

+
+
Returns:
+    The decorated function.

+

 
-        Arguments:
-            text -- The characters to not look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:[^{text}])")
 
-    @re_escape
-    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
-        """Find anything one or more times but this group of chars or char class.
+                

+                

+                                

+        #  
+
+        
+        class
+        CharClass(enum.Enum):
+    

+
+            

+            View Source
+            
126class CharClass(Enum):
+127    """Enum of character classes in regex.
+128
+129    Arguments:
+130        Enum -- Extends the Enum class.
+131    """
+132
+133    DIGIT = "\\d"
+134    LETTER = "\\w"
+135    UPPERCASE_LETTER = "\\u"
+136    LOWERCASE_LETTER = "\\l"
+137    WHITESPACE = "\\s"
+138    TAB = "\\t"
+139
+140    def __str__(self) -> str:
+141        """To string method based on Enum value.
+142
+143        Returns:
+144            value of Enum
+145        """
+146        return self.value
+

+
+        

+
+            
Enum of character classes in regex.

+
+
Arguments:
+    Enum -- Extends the Enum class.

+

 
-        Arguments:
-            text -- The characters to not look for.
 
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"[^{chargroup}]+")
+                            

+                                            
#  
+
+        DIGIT = <CharClass.DIGIT: '\\d'>
+    

+
+    
+    
+
+                            

+                            

+                                            
#  
+
+        LETTER = <CharClass.LETTER: '\\w'>
+    

+
+    
+    
+
+                            

+                            

+                                            
#  
+
+        UPPERCASE_LETTER = <CharClass.UPPERCASE_LETTER: '\\u'>
+    

+
+    
+    
+
+                            

+                            

+                                            
#  
+
+        LOWERCASE_LETTER = <CharClass.LOWERCASE_LETTER: '\\l'>
+    

+
+    
+    
+
+                            

+                            

+                                            
#  
+
+        WHITESPACE = <CharClass.WHITESPACE: '\\s'>
+    

+
+    
+    
+
+                            

+                            

+                                            
#  
+
+        TAB = <CharClass.TAB: '\\t'>
+    

+
+    
+    
+
+                            

+                            

+                                
Inherited Members

+                                

+                                    
enum.Enum

+                                
name

+                
value

+
+            

+                                

+                            

+                

+                

+                                

+        #  
+
+        
+        class
+        SpecialChar(enum.Enum):
+    

+
+            

+            View Source
+            
149class SpecialChar(Enum):
+150    """Enum of special charaters, shorthand.
+151
+152    Arguments:
+153        Enum -- Extends the Enum class.
+154    """
+155
+156    # does not work  / should not be used in [ ]
+157    LINEBREAK = "(\\n|(\\r\\n))"
+158    START_OF_LINE = "^"
+159    END_OF_LINE = "$"
+160    TAB = "\t"
+161
+162    def __str__(self) -> str:
+163        """To string for special chars enum.
+164
+165        Returns:
+166            Return value of enum as string.
+167        """
+168        return self.value
+

+
+        

+
+            
Enum of special charaters, shorthand.

+
+
Arguments:
+    Enum -- Extends the Enum class.

+

 
-    # no text input
 
-    def start_of_line(self) -> Verbex:
-        """Find the start of the line.
+                            

+                                            
#  
 
-        Returns:
-            Modified Verbex object.
-        """
-        return self.find(SpecialChar.START_OF_LINE)
+        LINEBREAK = <SpecialChar.LINEBREAK: '(\\n|(\\r\\n))'>
+    

+
+    
+    
+
+                            

+                            

+                                            
#  
+
+        START_OF_LINE = <SpecialChar.START_OF_LINE: '^'>
+    

+
+    
+    
+
+                            

+                            

+                                            
#  
+
+        END_OF_LINE = <SpecialChar.END_OF_LINE: '$'>
+    

+
+    
+    
+
+                            

+                            

+                                            
#  
+
+        TAB = <SpecialChar.TAB: '\t'>
+    

+
+    
+    
+
+                            

+                            

+                                
Inherited Members

+                                

+                                    
enum.Enum

+                                
name

+                
value

+
+            

+                                

+                            

+                

+                

+                                
#  
+
+        CharClassOrChars: TypeAlias = typing.Union[str, verbex.verbex.CharClass]
+    

+
+    
+    
+
+                

+                

+                                
#  
+
+        EscapedCharClassOrSpecial: TypeAlias = typing.Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]
+    

+
+    
+    
+
+                

+                

+                                
#  
+
+        VerbexEscapedCharClassOrSpecial: TypeAlias = typing.Union[ForwardRef('Verbex'), str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]
+    

+
+    
+    
+
+                

+                

+                                

+        #  
+
+        
+        class
+        Verbex:
+    

+
+            

+            View Source
+            
176class Verbex:
+177    """
+178    VerbalExpressions class.
+179
+180    the following methods do not try to match the original js lib!
+181    """
+182
+183    EMPTY_REGEX_FLAG = re.RegexFlag(0)
+184
+185    @re_escape
+186    @beartype
+187    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
+188        """Create a Verbex object; setting any needed flags.
+189
+190        Keyword Arguments:
+191            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
+192        """
+193        # self._parts: List[str] = [text]
+194        self._parts: List[str] = []
+195        self._modifiers = modifiers
+196
+197    @property
+198    def modifiers(self) -> re.RegexFlag:
+199        """Return the modifiers for this Verbex object.
+200
+201        Returns:
+202            The modifiers applied to this object.
+203        """
+204        return self._modifiers
+205
+206    def __str__(self) -> str:
+207        """Return regex string representation."""
+208        return "".join(self._parts)
+209
+210    @beartype
+211    def _add(self, value: Union[str, List[str]]) -> Verbex:
+212        """
+213        Append a transformed value to internal expression to be compiled.
+214
+215        As possible, this method should be "private".
+216        """
+217        if isinstance(value, list):
+218            self._parts.extend(value)
+219        else:
+220            self._parts.append(value)
+221        return self
+222
+223    def regex(self) -> Pattern[str]:
+224        """Get a regular expression object."""
+225        return re.compile(
+226            str(self),
+227            self._modifiers,
+228        )
+229
+230    # allow VerbexEscapedCharClassOrSpecial
+231
+232    @re_escape
+233    @beartype
+234    def _capture_group_with_name(
+235        self,
+236        name: str,
+237        text: VerbexEscapedCharClassOrSpecial,
+238    ) -> Verbex:
+239        return self._add(f"(?<{name}>{str(text)})")
+240
+241    @re_escape
+242    @beartype
+243    def _capture_group_without_name(
+244        self,
+245        text: VerbexEscapedCharClassOrSpecial,
+246    ) -> Verbex:
+247        return self._add(f"({str(text)})")
+248
+249    @re_escape
+250    @beartype
+251    def capture_group(
+252        self,
+253        /,
+254        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
+255        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
+256    ) -> Verbex:
+257        """Create a capture group.
+258
+259        Name is optional if not specified then the first argument is the text.
+260
+261        Keyword Arguments:
+262            name_or_text -- The name of the group / text to search for (default: {None})
+263            text -- The text to search for (default: {None})
+264
+265        Raises:
+266            ValueError: If name is specified then text must be as well.
+267
+268        Returns:
+269            Verbex with added capture group.
+270        """
+271        if name_or_text is not None:
+272            if text is None:
+273                _text = name_or_text
+274                return self._capture_group_without_name(_text)
+275            if isinstance(name_or_text, str):
+276                return self._capture_group_with_name(name_or_text, text)
+277        raise ValueError("text must be specified with optional name")
+278
+279    @re_escape
+280    @beartype
+281    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
+282        """`or` is a python keyword so we use `OR` instead.
+283
+284        Arguments:
+285            text -- Text to find or a Verbex object.
+286
+287        Returns:
+288            Modified Verbex object.
+289        """
+290        return self._add("|").find(text)
+291
+292    @re_escape
+293    @beartype
+294    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+295        """Find the text or Verbex object zero or more times.
+296
+297        Arguments:
+298            text -- The text / Verbex object to look for.
+299
+300        Returns:
+301            Modified Verbex object.
+302        """
+303        return self._add(f"(?:{str(text)})*")
+304
+305    @re_escape
+306    @beartype
+307    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+308        """Find the text or Verbex object one or more times.
+309
+310        Arguments:
+311            text -- The text / Verbex object to look for.
+312
+313        Returns:
+314            Modified Verbex object.
+315        """
+316        return self._add(f"(?:{str(text)})+")
+317
+318    @re_escape
+319    @beartype
+320    def n_times(
+321        self,
+322        text: VerbexEscapedCharClassOrSpecial,
+323        n: int,  # noqa: VNE001
+324    ) -> Verbex:
+325        """Find the text or Verbex object n or more times.
+326
+327        Arguments:
+328            text -- The text / Verbex object to look for.
+329
+330        Returns:
+331            Modified Verbex object.
+332        """
+333        return self._add(f"(?:{str(text)}){{{n}}}")
+334
+335    @re_escape
+336    @beartype
+337    def n_times_or_more(
+338        self,
+339        text: VerbexEscapedCharClassOrSpecial,
+340        n: int,  # noqa: VNE001
+341    ) -> Verbex:
+342        """Find the text or Verbex object at least n times.
+343
+344        Arguments:
+345            text -- The text / Verbex object to look for.
+346
+347        Returns:
+348            Modified Verbex object.
+349        """
+350        return self._add(f"(?:{str(text)}){{{n},}}")
+351
+352    @re_escape
+353    @beartype
+354    def n_to_m_times(
+355        self,
+356        text: VerbexEscapedCharClassOrSpecial,
+357        n: int,  # noqa: VNE001
+358        m: int,  # noqa: VNE001
+359    ) -> Verbex:
+360        """Find the text or Verbex object between n and m times.
+361
+362        Arguments:
+363            text -- The text / Verbex object to look for.
+364
+365        Returns:
+366            Modified Verbex object.
+367        """
+368        return self._add(f"(?:{str(text)}){{{n},{m}}}")
+369
+370    @re_escape
+371    @beartype
+372    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+373        """Possibly find the text / Verbex object.
+374
+375        Arguments:
+376            text -- The text / Verbex object to possibly find.
+377
+378        Returns:
+379            Modified Verbex object.
+380        """
+381        return self._add(f"(?:{str(text)})?")
+382
+383    @re_escape
+384    @beartype
+385    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+386        """Find the text or Verbex object.
+387
+388        Arguments:
+389            text -- The text / Verbex object to look for.
+390
+391        Returns:
+392            Modified Verbex object.
+393        """
+394        return self._add(str(text))
+395
+396    @re_escape
+397    @beartype
+398    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+399        """Synonym for find.
+400
+401        Arguments:
+402            text -- The text / Verbex object to look for.
+403
+404        Returns:
+405            Modified Verbex object.
+406        """
+407        return self.find(text)
+408
+409    @re_escape
+410    @beartype
+411    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+412        """Match if string is followed by text.
+413
+414        Positive lookahead
+415
+416        Returns:
+417            Modified Verbex object.
+418        """
+419        return self._add(f"(?={text})")
+420
+421    @re_escape
+422    @beartype
+423    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+424        """Match if string is not followed by text.
+425
+426        Negative lookahead
+427
+428        Returns:
+429            Modified Verbex object.
+430        """
+431        return self._add(f"(?!{text})")
+432
+433    @re_escape
+434    @beartype
+435    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+436        """Match if string is not preceded by text.
+437
+438        Positive lookbehind
+439
+440        Returns:
+441            Modified Verbex object.
+442        """
+443        return self._add(f"(?<={text})")
+444
+445    @re_escape
+446    @beartype
+447    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+448        """Match if string is not preceded by text.
+449
+450        Negative Lookbehind
+451
+452        Returns:
+453            Modified Verbex object.
+454        """
+455        return self._add(f"(?<!{text})")
+456
+457    # only allow CharclassOrChars
+458
+459    @re_escape
+460    @beartype
+461    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
+462        """Find anything in this group of chars or char class.
+463
+464        Arguments:
+465            text -- The characters to look for.
+466
+467        Returns:
+468            Modified Verbex object.
+469        """
+470        return self._add(f"(?:[{chargroup}])")
+471
+472    @re_escape
+473    @beartype
+474    def not_any_of(self, text: CharClassOrChars) -> Verbex:
+475        """Find anything but this group of chars or char class.
+476
+477        Arguments:
+478            text -- The characters to not look for.
+479
+480        Returns:
+481            Modified Verbex object.
+482        """
+483        return self._add(f"(?:[^{text}])")
+484
+485    @re_escape
+486    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
+487        """Find anything one or more times but this group of chars or char class.
+488
+489        Arguments:
+490            text -- The characters to not look for.
+491
+492        Returns:
+493            Modified Verbex object.
+494        """
+495        return self._add(f"[^{chargroup}]+")
+496
+497    # no text input
+498
+499    def start_of_line(self) -> Verbex:
+500        """Find the start of the line.
+501
+502        Returns:
+503            Modified Verbex object.
+504        """
+505        return self.find(SpecialChar.START_OF_LINE)
+506
+507    def end_of_line(self) -> Verbex:
+508        """Find the end of the line.
+509
+510        Returns:
+511            Modified Verbex object.
+512        """
+513        return self.find(SpecialChar.END_OF_LINE)
+514
+515    def line_break(self) -> Verbex:
+516        """Find a line break.
+517
+518        Returns:
+519            Modified Verbex object.
+520        """
+521        return self.find(SpecialChar.LINEBREAK)
+522
+523    def tab(self) -> Verbex:
+524        """Find a tab.
+525
+526        Returns:
+527            Modified Verbex object.
+528        """
+529        return self.find(SpecialChar.TAB)
+530
+531    def anything(self) -> Verbex:
+532        """Find anything one or more time.
+533
+534        Returns:
+535            Modified Verbex object.
+536        """
+537        return self._add(".+")
+538
+539    def as_few(self) -> Verbex:
+540        """Modify previous search to not be greedy.
+541
+542        Returns:
+543            Modified Verbex object.
+544        """
+545        return self._add("?")
+546
+547    @beartype
+548    def number_range(self, start: int, end: int) -> Verbex:
+549        """Generate a range of numbers.
+550
+551        Arguments:
+552            start -- Start of the range
+553            end -- End of the range
+554
+555        Returns:
+556            Modified Verbex object.
+557        """
+558        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
+559
+560    @beartype
+561    def letter_range(self, start: Char, end: Char) -> Verbex:
+562        """Generate a range of letters.
+563
+564        Arguments:
+565            start -- Start of the range
+566            end -- End of the range
+567
+568        Returns:
+569            Modified Verbex object.
+570        """
+571        return self._add(f"[{start}-{end}]")
+572
+573    def word(self) -> Verbex:
+574        """Find a word on word boundary.
+575
+576        Returns:
+577            Modified Verbex object.
+578        """
+579        return self._add("(\\b\\w+\\b)")
+580
+581    # # --------------- modifiers ------------------------
+582
+583    def with_any_case(self) -> Verbex:
+584        """Modify Verbex object to be case insensitive.
+585
+586        Returns:
+587            Modified Verbex object.
+588        """
+589        self._modifiers |= re.IGNORECASE
+590        return self
+591
+592    def search_by_line(self) -> Verbex:
+593        """Search each line, ^ and $ match begining and end of line respectively.
+594
+595        Returns:
+596            Modified Verbex object.
+597        """
+598        self._modifiers |= re.MULTILINE
+599        return self
+600
+601    def with_ascii(self) -> Verbex:
+602        """Match ascii instead of unicode.
+603
+604        Returns:
+605            Modified Verbex object.
+606        """
+607        self._modifiers |= re.ASCII
+608        return self
+

+
+        

+
+            
VerbalExpressions class.

 
-    def end_of_line(self) -> Verbex:
-        """Find the end of the line.
+
the following methods do not try to match the original js lib!

+

 
-        Returns:
-            Modified Verbex object.
-        """
-        return self.find(SpecialChar.END_OF_LINE)
 
-    def line_break(self) -> Verbex:
-        """Find a line break.
+                            

+                                        
#  
 
-        Returns:
-            Modified Verbex object.
-        """
-        return self.find(SpecialChar.LINEBREAK)
+                
@re_escape

+        
@beartype

 
-    def tab(self) -> Verbex:
-        """Find a tab.
+            Verbex(modifiers: re.RegexFlag = )
+    

+
+            

+            View Source
+            
185    @re_escape
+186    @beartype
+187    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
+188        """Create a Verbex object; setting any needed flags.
+189
+190        Keyword Arguments:
+191            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
+192        """
+193        # self._parts: List[str] = [text]
+194        self._parts: List[str] = []
+195        self._modifiers = modifiers
+

+
+        

+
+            
Create a Verbex object; setting any needed flags.

 
-        Returns:
-            Modified Verbex object.
-        """
-        return self.find(SpecialChar.TAB)
-
-    def anything(self) -> Verbex:
-        """Find anything one or more time.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(".+")
-
-    def as_few(self) -> Verbex:
-        """Modify previous search to not be greedy.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add("?")
-
-    @beartype
-    def number_range(self, start: int, end: int) -> Verbex:
-        """Generate a range of numbers.
-
-        Arguments:
-            start -- Start of the range
-            end -- End of the range
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
-
-    @beartype
-    def letter_range(self, start: Char, end: Char) -> Verbex:
-        """Generate a range of letters.
-
-        Arguments:
-            start -- Start of the range
-            end -- End of the range
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"[{start}-{end}]")
-
-    def word(self) -> Verbex:
-        """Find a word on word boundary.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add("(\\b\\w+\\b)")
-
-    # # --------------- modifiers ------------------------
-
-    def with_any_case(self) -> Verbex:
-        """Modify Verbex object to be case insensitive.
-
-        Returns:
-            Modified Verbex object.
-        """
-        self._modifiers |= re.IGNORECASE
-        return self
-
-    def search_by_line(self) -> Verbex:
-        """Search each line, ^ and $ match begining and end of line respectively.
-
-        Returns:
-            Modified Verbex object.
-        """
-        self._modifiers |= re.MULTILINE
-        return self
-
-    def with_ascii(self) -> Verbex:
-        """Match ascii instead of unicode.
-
-        Returns:
-            Modified Verbex object.
-        """
-        self._modifiers |= re.ASCII
-        return self
-
-
-# left over notes from original version
-# def __getattr__(self, attr):
-#     """ any other function will be sent to the regex object """
-#     regex = self.regex()
-#     return getattr(regex, attr)
-
-# def replace(self, string, repl):
-#     return self.sub(repl, string)
-
-
-if __name__ == "__main__":
-    pass
-
-
-
-
-
-
-
-

Functions

-
-
-def re_escape(func: Callable[P, R]) ‑> collections.abc.Callable[~P, ~R] -
-
-

Automatically escape any string parameters as EscapedText.

-

Arguments

-

func – The function to decorate.

-

Returns

-

The decorated function.

-
- -Expand source code - -
def re_escape(func: Callable[P, R]) -> Callable[P, R]:
-    """Automatically escape any string parameters as EscapedText.
-
-    Arguments:
-        func -- The function to decorate.
-
-    Returns:
-        The decorated function.
-    """
-
-    @wraps(func)
-    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
-        escaped_args: List[Any] = []
-        escaped_kwargs: Dict[str, Any] = {}
-        for arg in cast(HasIter, args):
-            if not isinstance(arg, EscapedText) and isinstance(arg, str):
-                escaped_args.append(EscapedText(arg))
-            else:
-                escaped_args.append(arg)
-        arg_k: str
-        arg_v: Any
-        for arg_k, arg_v in cast(HasItems, kwargs).items():
-            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
-                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
-            else:
-                escaped_kwargs[arg_k] = arg_v
-        return func(*escaped_args, **escaped_kwargs)  # type: ignore
-
-    return inner
-
-
-
-
-
-

Classes

-
-
-class CharClass -(value, names=None, *, module=None, qualname=None, type=None, start=1) -
-
-

Enum of character classes in regex.

-

Arguments

-

Enum – Extends the Enum class.

-
- -Expand source code - -
class CharClass(Enum):
-    """Enum of character classes in regex.
-
-    Arguments:
-        Enum -- Extends the Enum class.
-    """
-
-    DIGIT = "\\d"
-    LETTER = "\\w"
-    UPPERCASE_LETTER = "\\u"
-    LOWERCASE_LETTER = "\\l"
-    WHITESPACE = "\\s"
-    TAB = "\\t"
-
-    def __str__(self) -> str:
-        """To string method based on Enum value.
-
-        Returns:
-            value of Enum
-        """
-        return self.value
-
-

Ancestors

-
    -
  • enum.Enum
    • -
-

Class variables

-
-
var DIGIT
-
-
-
-
var LETTER
-
-
-
-
var LOWERCASE_LETTER
-
-
-
-
var TAB
-
-
-
-
var UPPERCASE_LETTER
-
-
-
-
var WHITESPACE
-
-
-
-
-
-
-class EscapedText -(value: str) -
-
-

Text that has been escaped for regex.

-

Arguments

-

str – Extend the string class.

-
- -Expand source code - -
class EscapedText(str):
-    """Text that has been escaped for regex.
-
-    Arguments:
-        str -- Extend the string class.
-    """
-
-    def __new__(cls, value: str) -> EscapedText:
-        """Return a escaped regex string.
-
-        Arguments:
-            value -- the string to escape
-
-        Returns:
-            _description_
-        """
-        return str.__new__(cls, re.escape(value))
-
-

Ancestors

-
    -
  • builtins.str
    • -
-
-
-class HasItems -(*args, **kwargs) -
-
-

Workaround for mypy P.kwargs.

-
- -Expand source code - -
@runtime_checkable
-class HasItems(Protocol):
-    """Workaround for mypy P.kwargs."""
-
-    def items(self) -> Tuple[str, Any]:
-        """Object has items method.
-
-        Returns:
-            The dict of items.
-        """
-        ...
-
-

Ancestors

-
    -
  • typing.Protocol
    • -
  • typing.Generic
    • -
-

Methods

-
-
-def items(self) ‑> tuple[str, typing.Any] -
-
-

Object has items method.

-

Returns

-

The dict of items.

-
- -Expand source code - -
def items(self) -> Tuple[str, Any]:
-    """Object has items method.
-
-    Returns:
-        The dict of items.
-    """
-    ...
-
-
-
-
-
-class HasIter -(*args, **kwargs) -
-
-

Workaround for mypy P.args.

-
- -Expand source code - -
@runtime_checkable
-class HasIter(Protocol):
-    """Workaround for mypy P.args."""
-
-    def __iter__(self) -> Iterator[Any]:
-        """Object can be iterated.
-
-        Yields:
-            Next object.
-        """
-        ...
-
-

Ancestors

-
    -
  • typing.Protocol
    • -
  • typing.Generic
    • -
-
-
-class SpecialChar -(value, names=None, *, module=None, qualname=None, type=None, start=1) -
-
-

Enum of special charaters, shorthand.

-

Arguments

-

Enum – Extends the Enum class.

-
- -Expand source code - -
class SpecialChar(Enum):
-    """Enum of special charaters, shorthand.
-
-    Arguments:
-        Enum -- Extends the Enum class.
-    """
-
-    # does not work  / should not be used in [ ]
-    LINEBREAK = "(\\n|(\\r\\n))"
-    START_OF_LINE = "^"
-    END_OF_LINE = "$"
-    TAB = "\t"
-
-    def __str__(self) -> str:
-        """To string for special chars enum.
-
-        Returns:
-            Return value of enum as string.
-        """
-        return self.value
-
-

Ancestors

-
    -
  • enum.Enum
    • -
-

Class variables

-
-
var END_OF_LINE
-
-
-
-
var LINEBREAK
-
-
-
-
var START_OF_LINE
-
-
-
-
var TAB
-
-
-
-
-
-
-class Verbex -(modifiers: re.RegexFlag = ) -
-
-

VerbalExpressions class.

-

the following methods do not try to match the original js lib!

-

Create a Verbex object; setting any needed flags.

Keyword Arguments: -modifiers – Regex modifying flags (default: {re.RegexFlag(0)})

-
- -Expand source code - -
class Verbex:
-    """
-    VerbalExpressions class.
-
-    the following methods do not try to match the original js lib!
-    """
-
-    EMPTY_REGEX_FLAG = re.RegexFlag(0)
-
-    @re_escape
-    @beartype
-    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
-        """Create a Verbex object; setting any needed flags.
-
-        Keyword Arguments:
-            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
-        """
-        # self._parts: List[str] = [text]
-        self._parts: List[str] = []
-        self._modifiers = modifiers
-
-    @property
-    def modifiers(self) -> re.RegexFlag:
-        """Return the modifiers for this Verbex object.
-
-        Returns:
-            The modifiers applied to this object.
-        """
-        return self._modifiers
-
-    def __str__(self) -> str:
-        """Return regex string representation."""
-        return "".join(self._parts)
-
-    @beartype
-    def _add(self, value: Union[str, List[str]]) -> Verbex:
-        """
-        Append a transformed value to internal expression to be compiled.
-
-        As possible, this method should be "private".
-        """
-        if isinstance(value, list):
-            self._parts.extend(value)
-        else:
-            self._parts.append(value)
-        return self
-
-    def regex(self) -> Pattern[str]:
-        """Get a regular expression object."""
-        return re.compile(
-            str(self),
-            self._modifiers,
-        )
-
-    # allow VerbexEscapedCharClassOrSpecial
-
-    @re_escape
-    @beartype
-    def _capture_group_with_name(
-        self,
-        name: str,
-        text: VerbexEscapedCharClassOrSpecial,
-    ) -> Verbex:
-        return self._add(f"(?<{name}>{str(text)})")
-
-    @re_escape
-    @beartype
-    def _capture_group_without_name(
-        self,
-        text: VerbexEscapedCharClassOrSpecial,
-    ) -> Verbex:
-        return self._add(f"({str(text)})")
-
-    @re_escape
-    @beartype
-    def capture_group(
-        self,
-        /,
-        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
-        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
-    ) -> Verbex:
-        """Create a capture group.
-
-        Name is optional if not specified then the first argument is the text.
-
-        Keyword Arguments:
-            name_or_text -- The name of the group / text to search for (default: {None})
-            text -- The text to search for (default: {None})
-
-        Raises:
-            ValueError: If name is specified then text must be as well.
-
-        Returns:
-            Verbex with added capture group.
-        """
-        if name_or_text is not None:
-            if text is None:
-                _text = name_or_text
-                return self._capture_group_without_name(_text)
-            if isinstance(name_or_text, str):
-                return self._capture_group_with_name(name_or_text, text)
-        raise ValueError("text must be specified with optional name")
-
-    @re_escape
-    @beartype
-    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
-        """`or` is a python keyword so we use `OR` instead.
-
-        Arguments:
-            text -- Text to find or a Verbex object.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add("|").find(text)
-
-    @re_escape
-    @beartype
-    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Find the text or Verbex object zero or more times.
-
-        Arguments:
-            text -- The text / Verbex object to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:{str(text)})*")
-
-    @re_escape
-    @beartype
-    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Find the text or Verbex object one or more times.
-
-        Arguments:
-            text -- The text / Verbex object to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:{str(text)})+")
-
-    @re_escape
-    @beartype
-    def n_times(
-        self,
-        text: VerbexEscapedCharClassOrSpecial,
-        n: int,  # noqa: VNE001
-    ) -> Verbex:
-        """Find the text or Verbex object n or more times.
-
-        Arguments:
-            text -- The text / Verbex object to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:{str(text)}){{{n}}}")
-
-    @re_escape
-    @beartype
-    def n_times_or_more(
-        self,
-        text: VerbexEscapedCharClassOrSpecial,
-        n: int,  # noqa: VNE001
-    ) -> Verbex:
-        """Find the text or Verbex object at least n times.
-
-        Arguments:
-            text -- The text / Verbex object to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:{str(text)}){{{n},}}")
-
-    @re_escape
-    @beartype
-    def n_to_m_times(
-        self,
-        text: VerbexEscapedCharClassOrSpecial,
-        n: int,  # noqa: VNE001
-        m: int,  # noqa: VNE001
-    ) -> Verbex:
-        """Find the text or Verbex object between n and m times.
-
-        Arguments:
-            text -- The text / Verbex object to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:{str(text)}){{{n},{m}}}")
-
-    @re_escape
-    @beartype
-    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Possibly find the text / Verbex object.
-
-        Arguments:
-            text -- The text / Verbex object to possibly find.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:{str(text)})?")
-
-    @re_escape
-    @beartype
-    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Find the text or Verbex object.
-
-        Arguments:
-            text -- The text / Verbex object to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(str(text))
-
-    @re_escape
-    @beartype
-    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Synonym for find.
-
-        Arguments:
-            text -- The text / Verbex object to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self.find(text)
-
-    @re_escape
-    @beartype
-    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Match if string is followed by text.
-
-        Positive lookahead
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?={text})")
-
-    @re_escape
-    @beartype
-    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Match if string is not followed by text.
-
-        Negative lookahead
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?!{text})")
-
-    @re_escape
-    @beartype
-    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Match if string is not preceded by text.
-
-        Positive lookbehind
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?<={text})")
-
-    @re_escape
-    @beartype
-    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-        """Match if string is not preceded by text.
-
-        Negative Lookbehind
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?<!{text})")
-
-    # only allow CharclassOrChars
-
-    @re_escape
-    @beartype
-    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
-        """Find anything in this group of chars or char class.
+    modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})

+
+
+
+                            
+                            

+                                            
#  
 
-        Arguments:
-            text -- The characters to look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:[{chargroup}])")
-
-    @re_escape
-    @beartype
-    def not_any_of(self, text: CharClassOrChars) -> Verbex:
-        """Find anything but this group of chars or char class.
+        EMPTY_REGEX_FLAG = 
+    

 
-        Arguments:
-            text -- The characters to not look for.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"(?:[^{text}])")
+    
+    
 
-    @re_escape
-    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
-        """Find anything one or more times but this group of chars or char class.
+                            

+                            

+                                            
#  
+
+        modifiers: re.RegexFlag
+    

+
+    
+            
Return the modifiers for this Verbex object.

+
+
Returns:
+    The modifiers applied to this object.

+

 
-        Arguments:
-            text -- The characters to not look for.
 
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"[^{chargroup}]+")
+                            

+                            

+                                        
#  
 
-    # no text input
+        
+            def
+            regex(self) -> Pattern[str]:
+    

 
-    def start_of_line(self) -> Verbex:
-        """Find the start of the line.
+            

+            View Source
+            
223    def regex(self) -> Pattern[str]:
+224        """Get a regular expression object."""
+225        return re.compile(
+226            str(self),
+227            self._modifiers,
+228        )
+

 
-        Returns:
-            Modified Verbex object.
-        """
-        return self.find(SpecialChar.START_OF_LINE)
+        

+
+            
Get a regular expression object.

+

+
+
+                            

+                            

+                                        
#  
+
+                
@re_escape

+        
@beartype

+
+            def
+            capture_group(
+    self,
+    /,
+    name_or_text: Union[str, NoneType, verbex.verbex.Verbex, verbex.verbex.CharClass, verbex.verbex.SpecialChar] = None,
+    text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar, NoneType] = None
+) -> verbex.verbex.Verbex:
+    

+
+            

+            View Source
+            
249    @re_escape
+250    @beartype
+251    def capture_group(
+252        self,
+253        /,
+254        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
+255        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
+256    ) -> Verbex:
+257        """Create a capture group.
+258
+259        Name is optional if not specified then the first argument is the text.
+260
+261        Keyword Arguments:
+262            name_or_text -- The name of the group / text to search for (default: {None})
+263            text -- The text to search for (default: {None})
+264
+265        Raises:
+266            ValueError: If name is specified then text must be as well.
+267
+268        Returns:
+269            Verbex with added capture group.
+270        """
+271        if name_or_text is not None:
+272            if text is None:
+273                _text = name_or_text
+274                return self._capture_group_without_name(_text)
+275            if isinstance(name_or_text, str):
+276                return self._capture_group_with_name(name_or_text, text)
+277        raise ValueError("text must be specified with optional name")
+

+
+        

+
+            
Create a capture group.

 
-    def end_of_line(self) -> Verbex:
-        """Find the end of the line.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self.find(SpecialChar.END_OF_LINE)
-
-    def line_break(self) -> Verbex:
-        """Find a line break.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self.find(SpecialChar.LINEBREAK)
-
-    def tab(self) -> Verbex:
-        """Find a tab.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self.find(SpecialChar.TAB)
-
-    def anything(self) -> Verbex:
-        """Find anything one or more time.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(".+")
-
-    def as_few(self) -> Verbex:
-        """Modify previous search to not be greedy.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add("?")
-
-    @beartype
-    def number_range(self, start: int, end: int) -> Verbex:
-        """Generate a range of numbers.
-
-        Arguments:
-            start -- Start of the range
-            end -- End of the range
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
-
-    @beartype
-    def letter_range(self, start: Char, end: Char) -> Verbex:
-        """Generate a range of letters.
-
-        Arguments:
-            start -- Start of the range
-            end -- End of the range
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add(f"[{start}-{end}]")
-
-    def word(self) -> Verbex:
-        """Find a word on word boundary.
-
-        Returns:
-            Modified Verbex object.
-        """
-        return self._add("(\\b\\w+\\b)")
-
-    # # --------------- modifiers ------------------------
-
-    def with_any_case(self) -> Verbex:
-        """Modify Verbex object to be case insensitive.
-
-        Returns:
-            Modified Verbex object.
-        """
-        self._modifiers |= re.IGNORECASE
-        return self
-
-    def search_by_line(self) -> Verbex:
-        """Search each line, ^ and $ match begining and end of line respectively.
-
-        Returns:
-            Modified Verbex object.
-        """
-        self._modifiers |= re.MULTILINE
-        return self
-
-    def with_ascii(self) -> Verbex:
-        """Match ascii instead of unicode.
-
-        Returns:
-            Modified Verbex object.
-        """
-        self._modifiers |= re.ASCII
-        return self
-
-

Class variables

-
-
var EMPTY_REGEX_FLAG
-
-
-
-
-

Instance variables

-
-
var modifiers : re.RegexFlag
-
-

Return the modifiers for this Verbex object.

-

Returns

-

The modifiers applied to this object.

-
- -Expand source code - -
@property
-def modifiers(self) -> re.RegexFlag:
-    """Return the modifiers for this Verbex object.
-
-    Returns:
-        The modifiers applied to this object.
-    """
-    return self._modifiers
-
-
-
-

Methods

-
-
-def OR(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex -
-
-

or is a python keyword so we use OR instead.

-

Arguments

-

text – Text to find or a Verbex object.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-@beartype
-def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
-    """`or` is a python keyword so we use `OR` instead.
-
-    Arguments:
-        text -- Text to find or a Verbex object.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add("|").find(text)
-
-
-
-def any_of(self, chargroup: Union[str, CharClass]) ‑> Verbex -
-
-

Find anything in this group of chars or char class.

-

Arguments

-

text – The characters to look for.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-@beartype
-def any_of(self, chargroup: CharClassOrChars) -> Verbex:
-    """Find anything in this group of chars or char class.
-
-    Arguments:
-        text -- The characters to look for.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(f"(?:[{chargroup}])")
-
-
-
-def anything(self) ‑> Verbex -
-
-

Find anything one or more time.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
def anything(self) -> Verbex:
-    """Find anything one or more time.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(".+")
-
-
-
-def anything_but(self, chargroup: EscapedCharClassOrSpecial) ‑> Verbex -
-
-

Find anything one or more times but this group of chars or char class.

-

Arguments

-

text – The characters to not look for.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
-    """Find anything one or more times but this group of chars or char class.
-
-    Arguments:
-        text -- The characters to not look for.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(f"[^{chargroup}]+")
-
-
-
-def as_few(self) ‑> Verbex -
-
-

Modify previous search to not be greedy.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
def as_few(self) -> Verbex:
-    """Modify previous search to not be greedy.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add("?")
-
-
-
-def capture_group(self, /, name_or_text: Union[str, ForwardRef(None), ForwardRef('Verbex'), CharClass, SpecialChar] = None, text: Union[str, ForwardRef(None), ForwardRef('Verbex'), CharClass, SpecialChar] = None) ‑> Verbex -
-
-

Create a capture group.

Name is optional if not specified then the first argument is the text.

+

Keyword Arguments: -name_or_text – The name of the group / text to search for (default: {None}) -text – The text to search for (default: {None})

-

Raises

-
-
ValueError
-
If name is specified then text must be as well.
-
-

Returns

-

Verbex with added capture group.

-
- -Expand source code - -
@re_escape
-@beartype
-def capture_group(
+    name_or_text -- The name of the group / text to search for (default: {None})
+    text -- The text to search for (default: {None})

+
+
Raises:
+    ValueError: If name is specified then text must be as well.

+
+
Returns:
+    Verbex with added capture group.

+
+
+
+                            
+                            

+                                        
#  
+
+                
@re_escape

+        
@beartype

+
+            def
+            OR(
     self,
-    /,
-    name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
-    text: Optional[VerbexEscapedCharClassOrSpecial] = None,
-) -> Verbex:
-    """Create a capture group.
-
-    Name is optional if not specified then the first argument is the text.
-
-    Keyword Arguments:
-        name_or_text -- The name of the group / text to search for (default: {None})
-        text -- The text to search for (default: {None})
-
-    Raises:
-        ValueError: If name is specified then text must be as well.
-
-    Returns:
-        Verbex with added capture group.
-    """
-    if name_or_text is not None:
-        if text is None:
-            _text = name_or_text
-            return self._capture_group_without_name(_text)
-        if isinstance(name_or_text, str):
-            return self._capture_group_with_name(name_or_text, text)
-    raise ValueError("text must be specified with optional name")
-
-
-
-def end_of_line(self) ‑> Verbex -
-
-

Find the end of the line.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
def end_of_line(self) -> Verbex:
-    """Find the end of the line.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self.find(SpecialChar.END_OF_LINE)
-
-
-
-def find(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex -
-
-

Find the text or Verbex object.

-

Arguments

-

text – The text / Verbex object to look for.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-@beartype
-def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-    """Find the text or Verbex object.
-
-    Arguments:
-        text -- The text / Verbex object to look for.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(str(text))
-
-
-
-def followed_by(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex -
-
-

Match if string is followed by text.

-

Positive lookahead

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-@beartype
-def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-    """Match if string is followed by text.
-
-    Positive lookahead
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(f"(?={text})")
-
-
-
-def letter_range(self, start: typing.Annotated[str, Is[_string_len_is_1]], end: typing.Annotated[str, Is[_string_len_is_1]]) ‑> Verbex -
-
-

Generate a range of letters.

-

Arguments

-

start – Start of the range -end – End of the range

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@beartype
-def letter_range(self, start: Char, end: Char) -> Verbex:
-    """Generate a range of letters.
-
-    Arguments:
-        start -- Start of the range
-        end -- End of the range
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(f"[{start}-{end}]")
-
-
-
-def line_break(self) ‑> Verbex -
-
-

Find a line break.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
def line_break(self) -> Verbex:
-    """Find a line break.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self.find(SpecialChar.LINEBREAK)
-
-
-
-def maybe(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex -
-
-

Possibly find the text / Verbex object.

-

Arguments

-

text – The text / Verbex object to possibly find.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-@beartype
-def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-    """Possibly find the text / Verbex object.
-
-    Arguments:
-        text -- The text / Verbex object to possibly find.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(f"(?:{str(text)})?")
-
-
-
-def n_times(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar], n: int) ‑> Verbex -
-
-

Find the text or Verbex object n or more times.

-

Arguments

-

text – The text / Verbex object to look for.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-@beartype
-def n_times(
+    text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]
+) -> verbex.verbex.Verbex:
+    
+
+            

+            View Source
+            
279    @re_escape
+280    @beartype
+281    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
+282        """`or` is a python keyword so we use `OR` instead.
+283
+284        Arguments:
+285            text -- Text to find or a Verbex object.
+286
+287        Returns:
+288            Modified Verbex object.
+289        """
+290        return self._add("|").find(text)
+

+
+        

+
+            
or is a python keyword so we use OR instead.

+
+
Arguments:
+    text -- Text to find or a Verbex object.

+
+
Returns:
+    Modified Verbex object.

+

+
+
+                            
+                            

+                                        
#  
+
+                
@re_escape

+        
@beartype

+
+            def
+            zero_or_more(
     self,
-    text: VerbexEscapedCharClassOrSpecial,
-    n: int,  # noqa: VNE001
-) -> Verbex:
-    """Find the text or Verbex object n or more times.
-
-    Arguments:
-        text -- The text / Verbex object to look for.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(f"(?:{str(text)}){{{n}}}")
-
-
-
-def n_times_or_more(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar], n: int) ‑> Verbex -
-
-

Find the text or Verbex object at least n times.

-

Arguments

-

text – The text / Verbex object to look for.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-@beartype
-def n_times_or_more(
+    text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]
+) -> verbex.verbex.Verbex:
+    
+
+            

+            View Source
+            
292    @re_escape
+293    @beartype
+294    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+295        """Find the text or Verbex object zero or more times.
+296
+297        Arguments:
+298            text -- The text / Verbex object to look for.
+299
+300        Returns:
+301            Modified Verbex object.
+302        """
+303        return self._add(f"(?:{str(text)})*")
+

+
+        

+
+            
Find the text or Verbex object zero or more times.

+
+
Arguments:
+    text -- The text / Verbex object to look for.

+
+
Returns:
+    Modified Verbex object.

+

+
+
+                            
+                            

+                                        
#  
+
+                
@re_escape

+        
@beartype

+
+            def
+            one_or_more(
     self,
-    text: VerbexEscapedCharClassOrSpecial,
-    n: int,  # noqa: VNE001
-) -> Verbex:
-    """Find the text or Verbex object at least n times.
-
-    Arguments:
-        text -- The text / Verbex object to look for.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(f"(?:{str(text)}){{{n},}}")
-
-
-
-def n_to_m_times(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar], n: int, m: int) ‑> Verbex -
-
-

Find the text or Verbex object between n and m times.

-

Arguments

-

text – The text / Verbex object to look for.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-@beartype
-def n_to_m_times(
+    text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]
+) -> verbex.verbex.Verbex:
+    
+
+            

+            View Source
+            
305    @re_escape
+306    @beartype
+307    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+308        """Find the text or Verbex object one or more times.
+309
+310        Arguments:
+311            text -- The text / Verbex object to look for.
+312
+313        Returns:
+314            Modified Verbex object.
+315        """
+316        return self._add(f"(?:{str(text)})+")
+

+
+        

+
+            
Find the text or Verbex object one or more times.

+
+
Arguments:
+    text -- The text / Verbex object to look for.

+
+
Returns:
+    Modified Verbex object.

+

+
+
+                            
+                            

+                                        
#  
+
+                
@re_escape

+        
@beartype

+
+            def
+            n_times(
     self,
-    text: VerbexEscapedCharClassOrSpecial,
-    n: int,  # noqa: VNE001
-    m: int,  # noqa: VNE001
-) -> Verbex:
-    """Find the text or Verbex object between n and m times.
-
-    Arguments:
-        text -- The text / Verbex object to look for.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(f"(?:{str(text)}){{{n},{m}}}")
-
-
-
-def not_any_of(self, text: Union[str, CharClass]) ‑> Verbex -
-
-

Find anything but this group of chars or char class.

-

Arguments

-

text – The characters to not look for.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-@beartype
-def not_any_of(self, text: CharClassOrChars) -> Verbex:
-    """Find anything but this group of chars or char class.
-
-    Arguments:
-        text -- The characters to not look for.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(f"(?:[^{text}])")
-
-
-
-def not_followed_by(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex -
-
-

Match if string is not followed by text.

+ text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar], + n: int +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
318    @re_escape
+319    @beartype
+320    def n_times(
+321        self,
+322        text: VerbexEscapedCharClassOrSpecial,
+323        n: int,  # noqa: VNE001
+324    ) -> Verbex:
+325        """Find the text or Verbex object n or more times.
+326
+327        Arguments:
+328            text -- The text / Verbex object to look for.
+329
+330        Returns:
+331            Modified Verbex object.
+332        """
+333        return self._add(f"(?:{str(text)}){{{n}}}")
+
+ +
+ +

Find the text or Verbex object n or more times.

+ +

Arguments: + text -- The text / Verbex object to look for.

+ +

Returns: + Modified Verbex object.

+
+ + + +
+
#   + +
@re_escape
+
@beartype
+ + def + n_times_or_more( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar], + n: int +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
335    @re_escape
+336    @beartype
+337    def n_times_or_more(
+338        self,
+339        text: VerbexEscapedCharClassOrSpecial,
+340        n: int,  # noqa: VNE001
+341    ) -> Verbex:
+342        """Find the text or Verbex object at least n times.
+343
+344        Arguments:
+345            text -- The text / Verbex object to look for.
+346
+347        Returns:
+348            Modified Verbex object.
+349        """
+350        return self._add(f"(?:{str(text)}){{{n},}}")
+
+ +
+ +

Find the text or Verbex object at least n times.

+ +

Arguments: + text -- The text / Verbex object to look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + n_to_m_times( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar], + n: int, + m: int +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
352    @re_escape
+353    @beartype
+354    def n_to_m_times(
+355        self,
+356        text: VerbexEscapedCharClassOrSpecial,
+357        n: int,  # noqa: VNE001
+358        m: int,  # noqa: VNE001
+359    ) -> Verbex:
+360        """Find the text or Verbex object between n and m times.
+361
+362        Arguments:
+363            text -- The text / Verbex object to look for.
+364
+365        Returns:
+366            Modified Verbex object.
+367        """
+368        return self._add(f"(?:{str(text)}){{{n},{m}}}")
+
+ +
+ +

Find the text or Verbex object between n and m times.

+ +

Arguments: + text -- The text / Verbex object to look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + maybe( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
370    @re_escape
+371    @beartype
+372    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+373        """Possibly find the text / Verbex object.
+374
+375        Arguments:
+376            text -- The text / Verbex object to possibly find.
+377
+378        Returns:
+379            Modified Verbex object.
+380        """
+381        return self._add(f"(?:{str(text)})?")
+
+ +
+ +

Possibly find the text / Verbex object.

+ +

Arguments: + text -- The text / Verbex object to possibly find.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + find( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
383    @re_escape
+384    @beartype
+385    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+386        """Find the text or Verbex object.
+387
+388        Arguments:
+389            text -- The text / Verbex object to look for.
+390
+391        Returns:
+392            Modified Verbex object.
+393        """
+394        return self._add(str(text))
+
+ +
+ +

Find the text or Verbex object.

+ +

Arguments: + text -- The text / Verbex object to look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + then( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
396    @re_escape
+397    @beartype
+398    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+399        """Synonym for find.
+400
+401        Arguments:
+402            text -- The text / Verbex object to look for.
+403
+404        Returns:
+405            Modified Verbex object.
+406        """
+407        return self.find(text)
+
+ +
+ +

Synonym for find.

+ +

Arguments: + text -- The text / Verbex object to look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + followed_by( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
409    @re_escape
+410    @beartype
+411    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+412        """Match if string is followed by text.
+413
+414        Positive lookahead
+415
+416        Returns:
+417            Modified Verbex object.
+418        """
+419        return self._add(f"(?={text})")
+
+ +
+ +

Match if string is followed by text.

+ +

Positive lookahead

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + not_followed_by( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
421    @re_escape
+422    @beartype
+423    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+424        """Match if string is not followed by text.
+425
+426        Negative lookahead
+427
+428        Returns:
+429            Modified Verbex object.
+430        """
+431        return self._add(f"(?!{text})")
+
+ +
+ +

Match if string is not followed by text.

+

Negative lookahead

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-@beartype
-def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-    """Match if string is not followed by text.
-
-    Negative lookahead
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(f"(?!{text})")
-
-
-
-def not_preceded_by(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex -
-
-

Match if string is not preceded by text.

-

Negative Lookbehind

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-@beartype
-def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-    """Match if string is not preceded by text.
-
-    Negative Lookbehind
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(f"(?<!{text})")
-
-
-
-def number_range(self, start: int, end: int) ‑> Verbex -
-
-

Generate a range of numbers.

-

Arguments

-

start – Start of the range -end – End of the range

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@beartype
-def number_range(self, start: int, end: int) -> Verbex:
-    """Generate a range of numbers.
-
-    Arguments:
-        start -- Start of the range
-        end -- End of the range
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
-
-
-
-def one_or_more(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex -
-
-

Find the text or Verbex object one or more times.

-

Arguments

-

text – The text / Verbex object to look for.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-@beartype
-def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-    """Find the text or Verbex object one or more times.
-
-    Arguments:
-        text -- The text / Verbex object to look for.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(f"(?:{str(text)})+")
-
-
-
-def preceded_by(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex -
-
-

Match if string is not preceded by text.

+ +

Returns: + Modified Verbex object.

+
+ + + +
+
#   + +
@re_escape
+
@beartype
+ + def + preceded_by( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
433    @re_escape
+434    @beartype
+435    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+436        """Match if string is not preceded by text.
+437
+438        Positive lookbehind
+439
+440        Returns:
+441            Modified Verbex object.
+442        """
+443        return self._add(f"(?<={text})")
+
+ +
+ +

Match if string is not preceded by text.

+

Positive lookbehind

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-@beartype
-def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-    """Match if string is not preceded by text.
-
-    Positive lookbehind
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(f"(?<={text})")
-
-
-
-def regex(self) ‑> Pattern[str] -
-
-

Get a regular expression object.

-
- -Expand source code - -
def regex(self) -> Pattern[str]:
-    """Get a regular expression object."""
-    return re.compile(
-        str(self),
-        self._modifiers,
-    )
-
-
-
-def search_by_line(self) ‑> Verbex -
-
-

Search each line, ^ and $ match begining and end of line respectively.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
def search_by_line(self) -> Verbex:
-    """Search each line, ^ and $ match begining and end of line respectively.
-
-    Returns:
-        Modified Verbex object.
-    """
-    self._modifiers |= re.MULTILINE
-    return self
-
-
-
-def start_of_line(self) ‑> Verbex -
-
-

Find the start of the line.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
def start_of_line(self) -> Verbex:
-    """Find the start of the line.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self.find(SpecialChar.START_OF_LINE)
-
-
-
-def tab(self) ‑> Verbex -
-
-

Find a tab.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
def tab(self) -> Verbex:
-    """Find a tab.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self.find(SpecialChar.TAB)
-
-
-
-def then(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex -
-
-

Synonym for find.

-

Arguments

-

text – The text / Verbex object to look for.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-@beartype
-def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-    """Synonym for find.
-
-    Arguments:
-        text -- The text / Verbex object to look for.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self.find(text)
-
-
-
-def with_any_case(self) ‑> Verbex -
-
-

Modify Verbex object to be case insensitive.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
def with_any_case(self) -> Verbex:
-    """Modify Verbex object to be case insensitive.
-
-    Returns:
-        Modified Verbex object.
-    """
-    self._modifiers |= re.IGNORECASE
-    return self
-
-
-
-def with_ascii(self) ‑> Verbex -
-
-

Match ascii instead of unicode.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
def with_ascii(self) -> Verbex:
-    """Match ascii instead of unicode.
-
-    Returns:
-        Modified Verbex object.
-    """
-    self._modifiers |= re.ASCII
-    return self
-
-
-
-def word(self) ‑> Verbex -
-
-

Find a word on word boundary.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
def word(self) -> Verbex:
-    """Find a word on word boundary.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add("(\\b\\w+\\b)")
-
-
-
-def zero_or_more(self, text: Union[ForwardRef('Verbex'), str, CharClass, SpecialChar]) ‑> Verbex -
-
-

Find the text or Verbex object zero or more times.

-

Arguments

-

text – The text / Verbex object to look for.

-

Returns

-

Modified Verbex object.

-
- -Expand source code - -
@re_escape
-@beartype
-def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-    """Find the text or Verbex object zero or more times.
-
-    Arguments:
-        text -- The text / Verbex object to look for.
-
-    Returns:
-        Modified Verbex object.
-    """
-    return self._add(f"(?:{str(text)})*")
-
-
-
-
-
-
-
- -
- + + + +
+
#   + +
@re_escape
+
@beartype
+ + def + not_preceded_by( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
445    @re_escape
+446    @beartype
+447    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+448        """Match if string is not preceded by text.
+449
+450        Negative Lookbehind
+451
+452        Returns:
+453            Modified Verbex object.
+454        """
+455        return self._add(f"(?<!{text})")
+
+ +
+ +

Match if string is not preceded by text.

+ +

Negative Lookbehind

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + any_of( + self, + chargroup: Union[str, verbex.verbex.CharClass] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
459    @re_escape
+460    @beartype
+461    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
+462        """Find anything in this group of chars or char class.
+463
+464        Arguments:
+465            text -- The characters to look for.
+466
+467        Returns:
+468            Modified Verbex object.
+469        """
+470        return self._add(f"(?:[{chargroup}])")
+
+ +
+ +

Find anything in this group of chars or char class.

+ +

Arguments: + text -- The characters to look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + not_any_of( + self, + text: Union[str, verbex.verbex.CharClass] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
472    @re_escape
+473    @beartype
+474    def not_any_of(self, text: CharClassOrChars) -> Verbex:
+475        """Find anything but this group of chars or char class.
+476
+477        Arguments:
+478            text -- The characters to not look for.
+479
+480        Returns:
+481            Modified Verbex object.
+482        """
+483        return self._add(f"(?:[^{text}])")
+
+ +
+ +

Find anything but this group of chars or char class.

+ +

Arguments: + text -- The characters to not look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+ + def + anything_but( + self, + chargroup: Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
485    @re_escape
+486    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
+487        """Find anything one or more times but this group of chars or char class.
+488
+489        Arguments:
+490            text -- The characters to not look for.
+491
+492        Returns:
+493            Modified Verbex object.
+494        """
+495        return self._add(f"[^{chargroup}]+")
+
+ +
+ +

Find anything one or more times but this group of chars or char class.

+ +

Arguments: + text -- The characters to not look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + start_of_line(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
499    def start_of_line(self) -> Verbex:
+500        """Find the start of the line.
+501
+502        Returns:
+503            Modified Verbex object.
+504        """
+505        return self.find(SpecialChar.START_OF_LINE)
+
+ +
+ +

Find the start of the line.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + end_of_line(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
507    def end_of_line(self) -> Verbex:
+508        """Find the end of the line.
+509
+510        Returns:
+511            Modified Verbex object.
+512        """
+513        return self.find(SpecialChar.END_OF_LINE)
+
+ +
+ +

Find the end of the line.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + line_break(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
515    def line_break(self) -> Verbex:
+516        """Find a line break.
+517
+518        Returns:
+519            Modified Verbex object.
+520        """
+521        return self.find(SpecialChar.LINEBREAK)
+
+ +
+ +

Find a line break.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + tab(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
523    def tab(self) -> Verbex:
+524        """Find a tab.
+525
+526        Returns:
+527            Modified Verbex object.
+528        """
+529        return self.find(SpecialChar.TAB)
+
+ +
+ +

Find a tab.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + anything(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
531    def anything(self) -> Verbex:
+532        """Find anything one or more time.
+533
+534        Returns:
+535            Modified Verbex object.
+536        """
+537        return self._add(".+")
+
+ +
+ +

Find anything one or more time.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + as_few(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
539    def as_few(self) -> Verbex:
+540        """Modify previous search to not be greedy.
+541
+542        Returns:
+543            Modified Verbex object.
+544        """
+545        return self._add("?")
+
+ +
+ +

Modify previous search to not be greedy.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@beartype
+ + def + number_range(self, start: int, end: int) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
547    @beartype
+548    def number_range(self, start: int, end: int) -> Verbex:
+549        """Generate a range of numbers.
+550
+551        Arguments:
+552            start -- Start of the range
+553            end -- End of the range
+554
+555        Returns:
+556            Modified Verbex object.
+557        """
+558        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
+
+ +
+ +

Generate a range of numbers.

+ +

Arguments: + start -- Start of the range + end -- End of the range

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@beartype
+ + def + letter_range( + self, + start: typing.Annotated[str, Is[_string_len_is_1]], + end: typing.Annotated[str, Is[_string_len_is_1]] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
560    @beartype
+561    def letter_range(self, start: Char, end: Char) -> Verbex:
+562        """Generate a range of letters.
+563
+564        Arguments:
+565            start -- Start of the range
+566            end -- End of the range
+567
+568        Returns:
+569            Modified Verbex object.
+570        """
+571        return self._add(f"[{start}-{end}]")
+
+ +
+ +

Generate a range of letters.

+ +

Arguments: + start -- Start of the range + end -- End of the range

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + word(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
573    def word(self) -> Verbex:
+574        """Find a word on word boundary.
+575
+576        Returns:
+577            Modified Verbex object.
+578        """
+579        return self._add("(\\b\\w+\\b)")
+
+ +
+ +

Find a word on word boundary.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + with_any_case(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
583    def with_any_case(self) -> Verbex:
+584        """Modify Verbex object to be case insensitive.
+585
+586        Returns:
+587            Modified Verbex object.
+588        """
+589        self._modifiers |= re.IGNORECASE
+590        return self
+
+ +
+ +

Modify Verbex object to be case insensitive.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + search_by_line(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
592    def search_by_line(self) -> Verbex:
+593        """Search each line, ^ and $ match begining and end of line respectively.
+594
+595        Returns:
+596            Modified Verbex object.
+597        """
+598        self._modifiers |= re.MULTILINE
+599        return self
+
+ +
+ +

Search each line, ^ and $ match begining and end of line respectively.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + with_ascii(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
601    def with_ascii(self) -> Verbex:
+602        """Match ascii instead of unicode.
+603
+604        Returns:
+605            Modified Verbex object.
+606        """
+607        self._modifiers |= re.ASCII
+608        return self
+
+ +
+ +

Match ascii instead of unicode.

+ +

Returns: + Modified Verbex object.

+
+ + +
+ + \ No newline at end of file From 15b1fca668801031277fc70ce5b146bdbbfff6d9 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sat, 7 May 2022 23:54:05 -0400 Subject: [PATCH 28/85] Set theme jekyll-theme-cayman --- docs/_config.yml | 1 + docs/index.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 docs/_config.yml create mode 100644 docs/index.md diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..c419263 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-cayman \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..8a582bc --- /dev/null +++ b/docs/index.md @@ -0,0 +1,37 @@ +## Welcome to GitHub Pages + +You can use the [editor on GitHub](https://github.com/rbroderi/Verbex/edit/master/docs/index.md) to maintain and preview the content for your website in Markdown files. + +Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files. + +### Markdown + +Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for + +```markdown +Syntax highlighted code block + +# Header 1 +## Header 2 +### Header 3 + +- Bulleted +- List + +1. Numbered +2. List + +**Bold** and _Italic_ and `Code` text + +[Link](url) and ![Image](src) +``` + +For more details see [Basic writing and formatting syntax](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). + +### Jekyll Themes + +Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/rbroderi/Verbex/settings/pages). The name of this theme is saved in the Jekyll `_config.yml` configuration file. + +### Support or Contact + +Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://support.github.com/contact) and we’ll help you sort it out. From 3e71c04f1e4b377998504138a1d36e3f8b31a60a Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sat, 7 May 2022 23:55:04 -0400 Subject: [PATCH 29/85] Delete docs directory --- docs/_config.yml | 1 - docs/index.md | 37 ------------------------------------- 2 files changed, 38 deletions(-) delete mode 100644 docs/_config.yml delete mode 100644 docs/index.md diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index c419263..0000000 --- a/docs/_config.yml +++ /dev/null @@ -1 +0,0 @@ -theme: jekyll-theme-cayman \ No newline at end of file diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 8a582bc..0000000 --- a/docs/index.md +++ /dev/null @@ -1,37 +0,0 @@ -## Welcome to GitHub Pages - -You can use the [editor on GitHub](https://github.com/rbroderi/Verbex/edit/master/docs/index.md) to maintain and preview the content for your website in Markdown files. - -Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files. - -### Markdown - -Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for - -```markdown -Syntax highlighted code block - -# Header 1 -## Header 2 -### Header 3 - -- Bulleted -- List - -1. Numbered -2. List - -**Bold** and _Italic_ and `Code` text - -[Link](url) and ![Image](src) -``` - -For more details see [Basic writing and formatting syntax](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). - -### Jekyll Themes - -Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/rbroderi/Verbex/settings/pages). The name of this theme is saved in the Jekyll `_config.yml` configuration file. - -### Support or Contact - -Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://support.github.com/contact) and we’ll help you sort it out. From 03f293e45d9e59eb198981f4f3c4f0c11802c6b4 Mon Sep 17 00:00:00 2001 From: Richard Date: Sat, 7 May 2022 23:55:29 -0400 Subject: [PATCH 30/85] add github pages --- builddoc.bat | 2 +- {html => docs}/index.html | 0 {html => docs}/search.js | 0 {html => docs}/verbex/verbex.html | 0 4 files changed, 1 insertion(+), 1 deletion(-) rename {html => docs}/index.html (100%) rename {html => docs}/search.js (100%) rename {html => docs}/verbex/verbex.html (100%) diff --git a/builddoc.bat b/builddoc.bat index e2920aa..8bc79f5 100644 --- a/builddoc.bat +++ b/builddoc.bat @@ -1,3 +1,3 @@ pushd "%~dp0" -pdoc verbex/verbex -o html +pdoc verbex/verbex -o docs pause \ No newline at end of file diff --git a/html/index.html b/docs/index.html similarity index 100% rename from html/index.html rename to docs/index.html diff --git a/html/search.js b/docs/search.js similarity index 100% rename from html/search.js rename to docs/search.js diff --git a/html/verbex/verbex.html b/docs/verbex/verbex.html similarity index 100% rename from html/verbex/verbex.html rename to docs/verbex/verbex.html From b7d2533ec68d12d637d495d0994f782230746836 Mon Sep 17 00:00:00 2001 From: Richard Date: Sat, 7 May 2022 23:58:28 -0400 Subject: [PATCH 31/85] update readme --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 94abab5..27acb3e 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,9 @@ pip install Verbex from verbex import Verbex verbex = Verbex() ``` + +## Documentation +[API]https://rbroderi.github.io/Verbex/verbex/verbex.html ## Examples ### Testing if we have a valid URL From 4bdd63aae010bb742a3b3876b59eb50f23e71ea7 Mon Sep 17 00:00:00 2001 From: Richard Date: Sat, 7 May 2022 23:59:10 -0400 Subject: [PATCH 32/85] update readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 27acb3e..e390a94 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ verbex = Verbex() ``` ## Documentation -[API]https://rbroderi.github.io/Verbex/verbex/verbex.html +[API](https://rbroderi.github.io/Verbex/verbex/verbex.html) ## Examples ### Testing if we have a valid URL From 66778e450b191717af03e2f8654328b09323d24e Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 09:16:17 -0400 Subject: [PATCH 33/85] remove travis.yaml dependency --- .github/workflows/main.yml | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 0383dc3..caf8baa 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -18,21 +18,22 @@ jobs: # This workflow contains a single job called "build" build: # The type of runner that the job will run on - runs-on: ubuntu-latest - + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: [ubuntu-latest, windows-latest] + python-versions: ['3.6','3.7','3.8','3.9','3.10', '3.11'] # Steps represent a sequence of tasks that will be executed as part of the job steps: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - uses: actions/checkout@v3 - - name: Install xmllint - run: pip install typing-extensions beartype - - name: Run .travis.yml build script - uses: ktomk/run-travis-yml@v1 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 with: - file: .travis.yml - steps: | - install - script - allow-failure: false - env: - TRAVIS_PHP_VERSION: ${{ matrix.php-versions }} + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install typing-extensions beartype + - name: Run tests + run: python setup.py test From c9f4e5165c060f6f1f3ce3d544ec8641afcba503 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 09:17:12 -0400 Subject: [PATCH 34/85] remove travis.yaml dependency --- .github/workflows/main.yml | 4 ++-- .travis.yml | 11 ----------- 2 files changed, 2 insertions(+), 13 deletions(-) delete mode 100644 .travis.yml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index caf8baa..1c901b4 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -33,7 +33,7 @@ jobs: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | - python -m pip install --upgrade pip - pip install typing-extensions beartype + python -m pip install --upgrade pip + pip install typing-extensions beartype - name: Run tests run: python setup.py test diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 8622eeb..0000000 --- a/.travis.yml +++ /dev/null @@ -1,11 +0,0 @@ -language: python -python: - - "3.6" - - "3.7" - - "3.8" - - "3.9" - - "3.10" - - "3.11" - -# command to run tests -script: python setup.py test From 7fd6e73ce2d3aedd4c4118759bd4945f608b69a1 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 10:16:58 -0400 Subject: [PATCH 35/85] switch config around, using setup.cfg and, tox --- .gitattributes | 50 ++++++++ .github/workflows/main.yml | 8 +- .gitignore | 19 ++- .pre-commit-config.yaml | 213 ++++++++++++++++++++++++++++++++ .yamllint | 6 + MANIFEST.IN | 2 +- builddoc.bat | 2 +- dist/Verbex-1.1.0.win-amd64.zip | Bin 0 -> 12788 bytes docs/search.js | 2 +- docs/verbex/verbex.html | 108 ++++++++-------- pyproject.toml | 30 +++++ requirements.in | 1 + requirements.txt | 8 ++ requirements_dev.in | 4 + requirements_dev.txt | 70 +++++++++++ setup.cfg | 24 ++++ setup.py | 38 +----- setup.py.old | 38 ++++++ verbex/verbex.py | 4 +- 19 files changed, 526 insertions(+), 101 deletions(-) create mode 100644 .gitattributes create mode 100644 .pre-commit-config.yaml create mode 100644 .yamllint create mode 100644 dist/Verbex-1.1.0.win-amd64.zip create mode 100644 pyproject.toml create mode 100644 requirements.in create mode 100644 requirements.txt create mode 100644 requirements_dev.in create mode 100644 requirements_dev.txt create mode 100644 setup.cfg create mode 100644 setup.py.old diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..72c1b76 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,50 @@ +# .gitattributes snippet to force users to use same line endings for project. +# +# Handle line endings automatically for files detected as text +# and leave all files detected as binary untouched. +* text=auto + +# +# The above will handle all files NOT found below +# https://help.github.com/articles/dealing-with-line-endings/ +# https://github.com/Danimoth/gitattributes/blob/master/Web.gitattributes + + + +# These files are text and should be normalized (Convert crlf => lf) +*.php text +*.css text +*.js text +*.json text +*.htm text +*.html text +*.xml text +*.txt text +*.ini text +*.inc text +*.pl text +*.rb text +*.py text +*.scm text +*.sql text +.htaccess text +*.sh text + +# These files are binary and should be left untouched +# (binary is a macro for -text -diff) +*.png binary +*.jpg binary +*.jpeg binary +*.gif binary +*.ico binary +*.mov binary +*.mp4 binary +*.mp3 binary +*.flv binary +*.fla binary +*.swf binary +*.gz binary +*.zip binary +*.7z binary +*.ttf binary +*.pyc binary diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 1c901b4..7a3605c 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -3,12 +3,12 @@ name: CI # Controls when the workflow will run -on: +on: # yamllint disable-line rule:truthy # Triggers the workflow on push or pull request events but only for the master branch push: - branches: [ master ] + branches: [master] pull_request: - branches: [ master ] + branches: [master] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: @@ -22,7 +22,7 @@ jobs: strategy: matrix: os: [ubuntu-latest, windows-latest] - python-versions: ['3.6','3.7','3.8','3.9','3.10', '3.11'] + python-versions: ['3.6', '3.7', '3.8', '3.9', '3.10', '3.11'] # Steps represent a sequence of tasks that will be executed as part of the job steps: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it diff --git a/.gitignore b/.gitignore index a0dcaf0..af4b16f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,20 @@ __pycache__/ build/ -.mypy_cache/ +.vscode/ +.tox/ +eggs/ +.eggs/ *.egg-info/ -.vscode/ \ No newline at end of file +~* +.mypy_cache/ +.pspp +.cache/ +.viminfo +.idea/ +desktop.ini +.gitconfig +.recommenders +.metadata/ +.venv/ +venv/ +__pycache__/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..ebae4e6 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,213 @@ +# See https://pre-commit.com for more information +# See https://pre-commit.com/hooks.html for more hooks +minimum_pre_commit_version: 1.21.0 +repos: + - repo: meta + hooks: + - id: check-hooks-apply + - id: check-useless-excludes + # - repo: local + # hooks: + # - id: verify_ascii + # name: "Check for non ascii chars in file names" + # entry: "./Src/Bash/verifyAscii.sh" + # language: script + # pass_filenames: false + # require_serial: true + # always_run: true + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.2.0 + hooks: + - id: trailing-whitespace + types: [file, text] + - id: end-of-file-fixer + types: [file, text] + - id: check-case-conflict + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.2.0 + hooks: + - id: check-merge-conflict + name: "Check for merge conflicts" + - id: check-yaml + name: "Yaml: Check files" + types: [file, yaml] + - repo: https://github.com/adrienverge/yamllint.git + rev: v1.26.3 # or higher tag + hooks: + - id: yamllint + name: "Yaml: Linting files" + args: [--format, parsable, --strict] + types: [file, yaml] + - repo: https://github.com/Lucas-C/pre-commit-hooks + rev: v1.1.13 + hooks: + - id: remove-tabs + name: "Python: Convert Tabs to 4 spaces" + args: ['--whitespaces-count', '4'] # defaults to: 4 + types: [file, python] +# seems to freeze with more than one file ?! + - repo: https://github.com/psf/black + rev: 22.3.0 + hooks: + - id: black + name: "Python: Formating files" + args: [--line-length=88, --preview, --safe] + types: [file, python] + - repo: https://github.com/asottile/blacken-docs + rev: v1.12.1 + hooks: + - id: blacken-docs + name: "Python: Formating code in docstrings" + additional_dependencies: [black==20.8b1] + types: [file, python] + - repo: https://github.com/pycqa/isort + rev: 5.10.1 + hooks: + - id: isort + name: "Python: Sorting imports" + types: [file, python] + args: + - "--multi-line=3" # makes this compatible with add-trailing-comma + - "--trailing-comma" # makes this compatible with add-trailing-comma + - "--profile" + - "black" + # - repo: local + # hooks: + # - id: python_file_name_check + # name: "Python: File name check" + # entry: "./Src/Bash/pythonCheckFilenames.sh" + # language: script + # pass_filenames: true + # types: [file, python] + # verbose: false + - repo: https://github.com/pycqa/flake8 + rev: '4.0.1' # old 4.0.1 seem to freeze? + hooks: + - id: flake8 + name: "Python: Linting files (flake8)" + args: # arguments to configure flake8 + # making isort line length compatible with black + - "--max-line-length=88" + - "--max-complexity=18" + # allowing these errors now that in the past we ignored. + # D100 Missing docstring in public module + # D103 Missing docstring in public function + # D104 Missing docstring in public package + # D105 Missing docstring in magic method + # D107 Missing docstring in __init__ + # D200 One-line docstring should fit on one line with quotes + # D205 1 blank line required between summary line and description + # D400 First line should end with a period + # D401 First line should be in imperative mood + # D403 First word of the first line should be properly capitalized + # these are errors that will be ignored by flake8 + # VNE002 variable name 'XXX' should be clarified + # W503 see https://www.flake8rules.com/rules/W503.html no longer best practice + # - "--ignore=VNE002,W503" + # removed cohesion as it was causing issues with enum type classes + # E203 spaces around ':' ignoring per https://github.com/psf/black/issues/315 + # PD005 and PD011 falsely flag on other add or values methods + - "--ignore=W503,E203, PD005, PD011" + # when checking with wemake - "--ignore=W503,E203, PD005, PD011, WPS226, WPS112, WPS204, Q000, WPS421, WPS305, WPS237, WPS529, E800, C812, WPS110, WPS360, WPS323" + additional_dependencies: + - flake8-blind-except + - flake8-assert-msg + - flake8-builtins + - flake8-docstrings +# - flake8-requirements # removed as there was issues with requirements creation tool + - flake8-implicit-str-concat + - flake8-mock + - flake8-variables-names + - pep8-naming + - flake8-bugbear + - flake8-executable + - flake8-raise + - flake8-pytest + - flake8-use-pathlib + - flake8-string-format + - flake8-colors + - flake8-tuple + - pandas-vet + # - wemake-python-styleguide + exclude: "setup[.]py|conf[.]py|__init__[.]py" + types: [file, python] + - repo: https://github.com/asottile/add-trailing-comma + rev: v2.2.3 + hooks: + - id: add-trailing-comma + name: "Python: Add trailing comma" + args: [--py36-plus] + types: [file, python] + # - repo: local + # hooks: + # - id: python_package_check + # name: "Python: Checking Package Structure" + # entry: "./Src/Bash/pythonCheckPackage.sh" + # language: script + # pass_filenames: false + # verbose: false + # require_serial: true + # types: [file, python] + - repo: https://github.com/pre-commit/mirrors-mypy + rev: 'v0.950' + hooks: + - id: mypy + name: "Python: Checking variable types" + args: [--ignore-missing-imports, --allow-redefinition] + exclude: "setup[.]py|conf[.]py" + additional_dependencies: + - pydantic + - types-all + - pandas-stubs + types: [file, python] + - repo: https://github.com/PyCQA/bandit + rev: '1.7.4' + hooks: + - id: bandit + name: "Python: Checking for potential security issues (bandit)" + args: + - "--skip=B404,B506,B607,B603,B701,B101,B602" + - repo: https://github.com/jazzband/pip-tools + rev: 6.6.0 + hooks: + - id: pip-compile + name: "Python: Compile any requirements.in to requirements.txt" + args: [--quiet, --no-allow-unsafe, requirements.in] + files: requirements[.]in + - id: pip-compile + name: "Python: Compile any requirements_dev.in to requirements_dev.txt" + args: [--quiet, --no-allow-unsafe, requirements_dev.in] + files: requirements_dev[.]in + - repo: https://github.com/Lucas-C/pre-commit-hooks-safety + rev: v1.2.4 + hooks: + - id: python-safety-dependencies-check + name: "Python: Checking requirements.txt files for vulnerablitites" + always_run: true + files: requirements.txt + args: [requirements.txt] + - id: python-safety-dependencies-check + name: "Python: Checking requirements_dev.txt files for vulnerablitites" + always_run: true + files: requirements_dev.txt + args: [requirements_dev.txt] + - repo: local + hooks: + - id: remove-en-dashes + name: Remove the EXTREMELY confusing unicode character U+2013 + language: system + entry: perl -pi* -e 's/\xe2\x80\x93/-/g && ($t = 1) && print STDERR $_; END{{exit $t}}' + types: [file] + types_or: [python, powershell, lua, jinja] + - repo: https://github.com/sirosen/texthooks + rev: 0.3.1 + hooks: + - id: fix-smartquotes + types: [file] + types_or: [python, powershell, lua, jinja] + - id: fix-ligatures + types: [file] + types_or: [python, powershell, lua, jinja] + - id: forbid-bidi-controls + types: [file] + types_or: [python, powershell, lua, jinja] diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..afbda05 --- /dev/null +++ b/.yamllint @@ -0,0 +1,6 @@ +extends: default +rules: + comments-indentation: disable + document-start: disable + new-lines: disable + line-length: disable diff --git a/MANIFEST.IN b/MANIFEST.IN index e0d237d..9714462 100644 --- a/MANIFEST.IN +++ b/MANIFEST.IN @@ -1,3 +1,3 @@ include verbex/py.typed include LICENSE.TXT -include GPLv3_LICENSE.txt \ No newline at end of file +include GPLv3_LICENSE.txt diff --git a/builddoc.bat b/builddoc.bat index 8bc79f5..c5f576f 100644 --- a/builddoc.bat +++ b/builddoc.bat @@ -1,3 +1,3 @@ pushd "%~dp0" pdoc verbex/verbex -o docs -pause \ No newline at end of file +pause diff --git a/dist/Verbex-1.1.0.win-amd64.zip b/dist/Verbex-1.1.0.win-amd64.zip new file mode 100644 index 0000000000000000000000000000000000000000..5c11901347bb1332b4914205efd0fcb1d8ef734f GIT binary patch literal 12788 zcmbt)WmsHG+AS8`-QCkbSf+^uofpuvN?dvJ%~PH+nlB)B`lgZoY9obR4Y?tC-n zK2!bd?){@`t+(D?y=$+%UL{#bC`_=Q%}lvO^&cmHe!>6vRq}ALu(xAn1~MuAulJE&dmPbz%u;@*gxYkFmUiNF*30L85sOuFj%l5g%Z`6 zHXB}nA0Y339E^V#%+k)%#lV2k!9(`-$b{OL*Rl*UGL=e0pBaXj=#?GDr2tOj(f~$v zDS(7S^HdEj5~Gy-xZG!OItV(6O=C4;=nZf+5lvmN|GB7tL=yiHlfZ%m2FA}11_tEZoGA`FrYJwSo@Yb|iw#OAZvnHE zJiGhF6HgR2A) zT5>3#XP$?`RTV1Ppqr7)EEFnH5Z6jq>}HwOEs)Z$<(OI)1)Z{TD;g(>bkQn!ghR69 zH_F3_GUVB0PhV}+S!S6|az$+^?NwJ{D&{(uVXr_3zAu>)C(pN3m@>9`-*KCF59Br) zjBvr0JbL$X$Mhh(cba9+1}4DYn*zHiKFzG*?HeEJxWJ}MnTI1&C7&>ddOAohy#Ox1 zq(QGP%XhcwLr)Hw1*#?-NNdVONqgU!H@eLho>WuI_1Fbm?v0>*#xZ~D67X8JsQ9#z zT3o7x7FoH;Mm%VgvFkgSL`4Eu|&&}xMwsZ`2o15KjLU5 zKvZC1@{wh2RmyfL2AvIsINiP%Fx>WxE8KR+waeWwlBYTzESMd39-KB%?&vk#EAk1l zqt7NEEfns;wM%Bz8nhIwXYyKPQil>TWr}3 z7zBe&48#pe=WA>l6k?Bh!sD9MFFk%kY75C)d}TQ?;eU@Sgls`hkJ^MaVj z4+dX8tnOU%*f}|Gr17!UP`4is2xT`cv5+`6#WuOJvQjE%zEHv%z1IepHgn<~2XHH# zP5aU|(e?PP+#J{=)`lrHtFN0WopzN;8ML`102mK=H(EKgLx zt~p(gP>RnPx0rvV9q)-@|DHneg(R3`6{p1crWKx~GzBJUJQLn@8`1#YToFzN0_t$T zqma4*q!Skg04znqzhq6%0e|@3^D_n-B6u{mryLnhV~xuI5)K6!=^(ClJcd);Tl>3% zQcI5a^;-^*qRg=IK9P;!h!m-g3=(y2-=%daBKolA=edHo5ShsXV}*zjrMUUjl~{0r z`alV}g*3tn^|SXVV*$E6M};4WY>=jW!AxaT94<8iYdkFq8Qd^o=;rJIMkz-IfcbcKiY1~%Yt^`j<#u$^#ewO-&?Dld?rL*nHsU$HVTY%M zBh7D4gAH9|+@vP^3MbR$Ornv9tcdPVkbGGA<-{XNpM1u+&auW`7}nqs;d`UZGze#- z1aiZmeryS!+*v6_O?eQiRsPdC(_Bv=r8}f)5kJ+gl2=2l8T0~t*?lOR$V%O$ua2Uw z%cNns=-bh&C{~CCZ?v$F^b3QE41lIlp~y90Zp;QhN#JoBE^>W47QM1;f&7nGy%EZ0J)Sd&$V!VKBX|Hkx zGW9#G=ZVe)*VbSs@`+`wo>dWH7_f7Kah&li7Sh>U;k%9r==tn)C83SZ4Dl-~qK zR?AdR85)|(*0c{^qNokLl}P*;{|0VU@Z6&IWogZY@pW&Kn z<{JhCKaoyh7WNy{p_6|~e>E^2jr2^4y{^-3%Wm3@#>2pDnvQL{&V_C5Ps)d2bmyrD zxiO$)S;;$~_`rF1926Qdug0!r>Bf`L8h%4vp5la9qACIh4_=r5;Y6FH_4#!v z%xteoQ-VPfsl|v%hXn<~y5G%pODs&pwP@TutBKJn2A&JJqk1m21x;dT8bC%$MX_uI z(FACM{fMUmUJ-$Tr=GmYKNgQ`;gB(4XyaTePyVGmjn)IMYFamncg98Gql9if8R34t zdL=iQs|6%uO+-#Dr9s)?vOuF%<&|T-ep$MzCjH_`3tBUlkU<2dknXDT*s)D;Yc~ua zypq0H$z&?%7z+Y(R zfFq5+k^N}CV^+;f`&@+WM!N25EW$eTVE52kEX-}gu6=i45)eE_JE%}bxHZT1 zcOx+}9dN;yX+S&^@+1XESMgFTUL$L5JNflGYRIe3g4Sg>Inp*oe@L{VZ^r!RET< zMy47w7S=bex!>yHul6h|zEhX+@?v8a}9`fbK2ZQsYdt2ihSbqj){e%IR1Y-wjt1;KXP6sTx(FUc+ zZZzF}IB<0^#_;15yIB+IFIn-Z=o{QT`hFv`sAm%ZMOqRnGHvu)Vekx0*dE+Y;G3PT z5*T0P76Kv%N;uH$pekcC+s3936_pqblzKc3es?fHDk%Wxh4KnTKp6)I?wBvs<$_hl z`zFpaOn|6T*T6uMlaq7lTaiP6U`6!X5s_|o`on1@6)#?f{^!TZW!Rj%r*a3%sn>kL zQTwr`&!zk4o}E#>V|T_bOf9?fN8SKA<%Cs;@uyE2&CdLc18X*sfUlY;*?li!*V?(w zbOFr)Z75KR*vfng2Xoaad)-qkmw%&bl=KviHLUsulbBihuL*wgzx zjH>Fx2Lw+Ta$kP2YjKYP*nISdI&^&5VD3?SA>twmr+cTHDX@fHEEdL0yut^NxC0#8 zSW=p;!=fNfMa0w=tr3;>q_6T3tGIeC`nysV7}woI_e5ujt|N7CPxi#nV2kp#7OfOA zmgmr|rBN8gx=1vO?_TyFsV-&^gJi@eW{xj`ERGqfN^XOZ%fzfNQq+`h3kq+;aP zMv-m3v;q?yfTPOwIq{h9Z6i8TT9=PiGt6hwtUur4aL5pTS#}UbZl}Js>ue4=upifB z>b>Zd@4?Pu9f-RV>@nzdxcU_Rm4}xgD@%_*_??1dSMN7LHka!CN?$_9b8lSPN#;5C zVhIABpMt4mDS2?Mg zbX()u+q4?k!;XY}0mNQ34=^z0RF+3VHEBZI&6x1hDK&ym42+wLYqj86E$3WV zbczu=F}5KF?Tqb>6<-SHaLFU--)%Tk^~Tz9t=kf|zNI_LlCoZ>?TH2fgC|16UKl#~u0j4mDyAXCU+WZX~D zYv++e*YN}5;>RKR_n>}Nrv?Upic1rRe~5pEAL{>yz%v=$+u1P&3mBi?k-ieTXNJT# zgfNC7Wt;^=r$eNRm)y*lR1tT zCO*y`*55CL?Cv0J?rS8WxPcHa|O-XG|Q&fySD0Dg4H)y^KO70sx#8O?|tQj6tq#KiN zfaEU3HHAijM9BxE_$@=1GL)1y*kE8NLSSIx|Nj~KQ}q6ppRYRh4g`a)UHpX4=#*qC zc_r^=4{}7MFd3Haws_)gwTnQDEW@$&Ho}PtFh}u0P|Mw3Fq2}rTyR-j^3(N}8I6|T zRL3bT+2zgB-O?T7i?R;n1VM`^Pctn{PhSq?E%4rG%6uMj~a9vAyhX z+}0kBmu^;{{a4m zLhV!xNSHrQR~1kjLPhu1D;KCl1VB`G4$dsesyZq;p*=#qlLM9T=;BtL0FEk7=#R>x zF(t~{5ZcP~gD1ab_hf%t?OFZS+0*&$xyM(ztJ*2|UTOnvXwNeG^t%RxUDnHw+= z$~32Ou;hVbYYwp=u>b^B%$GnVr`Y}vrij_Dp0L>{VS9W_2!xSgt1;8PM^OAu+UJ&l zE<(s}&AG(l^!x(@;$sN`*ZY>Qv>#ykp(}}&ln^kEn0egvcJ#GBe0+62oMXY~6|EJS z!8pyWQ>r0XRo7&d$*r)^Na&Ncq_$G;V#Wg+xZ07)(yH~~`U=8CV=lv)Gl7@BlJ5|&9xRVJ)o-t!#4 zO&?u#>Il+nAIP1AGPfhroCrg(jXulpVpBXVvVe0bL2;bdvIqSsJKLn7GV(y6QKG{VTM z#p>USwF}r#s%hGu6SG|z#rvYLpv|01m4AdAL*g$%h!v04gVLKKxy#35u*j2R;v}%P zfPhzo3H#Y12|cx2x@?kbzf1z-llO>hrzsDtjmg>}N0*&bo1OB^tBzKEow+?~xz0^F z2OG0GL0mssAYV$8zc{6)JKK;_z!x_CY%Jg*)t6TC>CrrJ2^tnWy=Of@9lUEca?ZIu zw1m_Rj0HI$6%8x^*$TNF5CJ2|9Rw^uge2gMjOm#sf|8PDb5dyx%XOfxhF89obm-f> zO$G%-LhF3=yy1TiJ-FAq62Vn)Fw7BxG1Cig__}%QAJ(~{IYZU9-*jXi~?@YW86e< z;iR(rKW}xv(Xh#~#m~ueOh?7ffy$Ee@_C~$T*2H5t369=T-H`zgz_ei85rZ+f(r}G z2V(eqqP~;qfX8Nqz(EZ0{azq&l{{*=tqV4uQ|(!5%!AI!*T z$L%m48(_AJ4KA9$8qPlau0-N}iQ)>R zRowy^*+kV)R>S!_cxu`p?S_q{rJNCbF4wP6b-W$qMcknw)lw=zBaqhhF23(Hr)VhDHzAwH$RVujfX+O_6opy7zu?5!v1BRKLUDp*Ijo z$nnt73ZV@tS{=5F%_s;{uc|&TPH>&83TOfdM;xN7In*D5&#+&{BFe?)2gZw2os?+} zkt5?ONPMQa=Q2%9vZ?>@eax1En!36|w3oAx+R8$K1EW*z2EEf`LGD$^!2A3C*@L7+ zLqaj&Gc3#N5&4FS<;a$Glx~bNCfbyn<(W^ft?X<>U6DgG8$W!9l)qA6j$&^>QUc|* zrw!~C?e1+Hi(xz-RBk`O*Voufci?rU`MG1{B}vEis#C9|ma}6Jm0_C~>+PbIWt6?5I0(phJ!0?12ag;3C>%C-u zO-$$j8WI8~XiGBWFvpdbR>zDpMY{%n>>vZs40j|h8bJ)H)ycvA1>3H&!{Sh(|! z*O^woS_pjnYEfp$XcElz6&?pr@ z7W8wNM)C*|Za`L_m=YX$7&C;=z{%p8N!h5JUa2@yq8kl%_ zl;}}JWWE@+F1wA3=(KBd!`oP!OmaCH`T)vtMFvKNF&wAru`&6voGjf`7Ko9%g}EhK z{oSjSBAjCEUFr!1kB|Msdv~KNpLe;X1OgXXDaVSE{bC;9f7xBuV?TJyB>xTaeI_)L z%p@YB#Oz^jlITJODQc8)u4uI4r7IlLUh_%CA|YXe`01O7`+?+&-Fb9_+V6MrPM`$B z70LszFJ#Z?$gq|bjrA}TLA1ru6WM2_oqri{UxRx8L$H>sb+6(?E11`=n!Vo`QNsqAs}mkn`|* zAKDIRlZ6&?b1SC!U8)PVW8+s-RwYL-@%g1(7v_+)E>QUa*2vN$Xr8JnAyhlKKB_8i z@FTA2#e-C!l!DCMt#}r4S}Y!6l7z&S+N?L1j?#EZi8T8O@wJjF0y2WsbY4_DTbCH| zwTdd)d0o_W4^%sr_tMhbq;$mxc+wtXN@bVaJalw0uln;Qrt9MK>L?oyFnyFsy+ddB zx$n_Qy>XqUFF`{@{>!f~`L?4)PSkiHTTEgz3Y}xUFr9MpE}9P@7`mhl@^QpuP0sob z2rl#9j)+!5bU-yki`s?hhb+Sl>3x9S9w2j1N{{80zVT;px+UPsO74ehCv_7qB5$La z3JFzV1B|*A8do=DhUUM~X|mCjKXZ+oAteP=hNp8dRVOmkpv@6>s4xxFm1wG#!I_x>;F@ok6RDvLpyOU2+vn^c-uTF^q-2d_C= z7UhrXwqYVxP}d@R)Oxps-pusAWi+Mfz;^v5njf7j7fZC`$Go$8cvyOeK&t9c_S=i_(9glt?wU8A=|(E|6R^}L zedh66dHuB{Rt1wde(*aPS}o%ALdzVx>9wGoPivu2pN*Yzgaik5Kbb%5+ULgC)cV3N zNXy7QQn_*NTyBa4KVvOOxL1|JxtzZ&4apRVe=OcmPn+M}#!=QVLF;7BLA+h9HpKKr zxNMN_ELFlvj`;??Ykb-td}75KH9uch%sI@OL5boIR0|N|+7)dJAGUx|kVJyT7CKD( z*mLYTrun+9+}Qb45aQKpjtwDV&54S8#_Ryqp1Xv|xW761TlKXFxNH;F4AV#hQH3f| zCmniW8tNO@{rRf4ywexNTS93zWcNMR5`isHKXl<3((;$p$5cV2Kz_#$LR+3OLf^id z33z|dP-8Chm#|W{<%^p4BPqk^Y=Se=(Ax-g!k9 z$mcz20kdZ)d}N|jOl=$y$=xHwq4Ip!B*5VgXv1C{suOT@N`Eo-;FQJ-L@N;NO^N;1 z=%#zpeJs9#$HB;JsAf&85>QRvJiC zp{dRT{CEv>kK>(oj{Y?_lt)uQz?14B7`!Hjrgg0G|k=0K@vx$c061X|=@x^o3ZZ1<;xOk+ z5FgE@!`a+MN@vtt+T2HiFCKlIBG@2f?z`1848%3%JE+I)FAr5b2nlLt4w0v;$Hzsn zMjg|ny-tThWJs|LTM)C6B-S2xHe)rOX#MScUem5ojSa4VCv$b3UK+*Dl{+e+PT9_1;Gsuq{xx{esUI?d%I@8lX4o5bLP>}sFgP$K^*T3axS7|*m5i0fiE)bmXwRLC=) zNup{2R5HIUN52Tp^CU7j^@1-H$vAnRaiYLJ*?54*ZL+zT~%*?g}2q zW%wSUM)V=)9DvzPu>=uLKzTO514fR3lr^~S%#~j?3`}?mnYDTbry(2P)EEy4(#$w4 zOGeqd2w5rhpjj*d$~JM%8sgmAwZCaHSfcF%bC8#NHmcI+BZbR4QZVmv?H_$m93npJ z^|DGJ%x)0Lawq;dNG z+^pm;iQmHn8Za!*1+pYgxN#<)m$m4d^0CErr_01P31dhsL8@T+h+|qw;;(hJE%KYf z&my5eV^iA0$gqCFsfuzGYaO(~3zK3M+R{NdOt!7m5a;Ruv5`RBU5LRhD$}t=&UT>- z#aascU7n0ilNI_H5dq{0?7QgQ$czdpoBT(jmz$xU!w+>*#DHrfc6ZPiwdv)k!>h#= z&6$D}*n>@BUFoN|tWW^F{wsT^DqC6%38c8q6OOIdon!O+q|8<5r{q_NI?N=^Gw&Z6 z{MU}CFGztPF{lSd{D3u;Jmj(t5yj!P19A_fO_h(QOD63RHdwnOPvKQj{9gBRC<_k| z$wCz*Ax<#)Kl~oGA;ReEI~e*4{wQ~``W#onQ>j->QIg@t9V1M%L{&(({hN|KaH-e; zrB~?5T^|ol-wZi>!1zF#Ek?7Rof0FOysbIqlX4E-=l8LE(~*g@{_4TJYYDs;3f6pn zR1ig8%pl(&U@zseZ@>5$7whn(8k=&a9|l^L(7(0k-D#C)vM~Gi$y*%NkAgy2OK8f> zU6EbBO!QYV#}2kSSaEKnrQnUccblo*0~z{c7QT5*6qvK2UF5?#?sk^AEDW9EJoPja%@ zt9l&UUtU3Upuq>xuyoNo>K{@okX+)Q-LG-Uy{ix-lq#qxCe8WIu6tI6!_8VPs04@I zDjnO6j5KK^hXe&%WLaK8^TH(itXFp{gqL$L@D|bY8v^$@)JCb+kpNi$SQhkBsm6(& z`pLU&#UbuhX+PC3r#1BE!qjNlv@oC*$F9QA(XX!q!dwyA>=KV#F^<+{6V&?Tod)*r zpX}EKmh=*X4sb_pY)Oz|R$;6>M1^lQja9suQ&E>1gIQEa&G`t4%2vtQBpTc?HTp&I z@z)sa+&5XAn?x|$u$X;^2NZjA(o%UiE3q7@jlY)HWOl%qoMs5sTq7v!&@Nh*zfXR} zfDRTvn%PCU2=mN+_`0X0#^IrK^?fK#muKSDay1k7 zhM3NtDE0CHOK86m|DBmg5)RJHL^N%bB%~mqh9!uvQZ{!(me5^5oDa@fr6RqGev=LR z5GEsNt$*8#sGgj__9>KpE`F<$=+L62ctgwJhGI#%&dVY7Q9Tak!G}w zPsrG=73_X)$4Km?6;LgPpq127k{I<`jHI$G@9&PYy;~E1oP0lgx}?N5Wg^>O*nlD1 z@9iG=!6?OC#2L+ok+h-hZk0||=uK5vs2O%qINI`9Gh^j?V+VS>s}T?4L~rU&H8Y8y z7y1om-&64C%a*i-JG%CbMebEJ^LyNHttP{L7 z6A3`})a@eYaEuwr&=+r1X?)C3XA2D%Q|-nh4kd?5dLZ86K%J`Ybn|u8UjBL%)a`c~ zZ%9Wc@`0Q1nq;Hq6kepW@q0F`?)lte(Hr`dz(57eTDv4!4xgGWf*f5gUj7wsr|*ME zEzP*$_4&4P9|6_(oFj~3EqiOH{q66V)t^80^@(A2pp^~)bIwlFLn*$US;-bu&Bm3D zuT%Ltx{UR5W?l1y4P_WpJRM(uR~`KB&O0;nsP;WLI@2~kytUdrQS%M&Q z3n}15*y~PgFlX;J9bX>~uwA5|rPFTlSurcav-j=!<2LvCG*om1wePFLBCF*p=98+2 zEgD8r1d`?exK->kd(`DmrbG#fCQcX$?!Y^8>aOVF6lOH$V|&BzYI42=3Drj5c~c(+ zsNaPSa{}+EsZWi*GsrzdCEPIIAycmnZof}`q@sQoH4KybSfHmU3c~vI_{uv|@Xe#n zR9aA3nQ3TA8eq6U6=|v>U40l#Ie}chMC_|-`~!(=*V~h&WMqjc-4vcQTT2dY7|-L0 zf`E7INx@FrlnKKHFjH@jYps$QdSP8G6}hG!y!Ft#gt&=Rm{SCI))*&n2b}bl8-UID zR(>H(%N}yHfwyY$wi<-d4@mkwde#0bHc#sFT|BFtdX)>ySneY5ypKE~&9*crTTXnL zTe$t-JB9q=1G{5FX-qSoG=n6my-_jRSG(N}19*46aWP!%pA|#S;x#@9+H8hs8F_PJ zub=1G!v&3O#W*~zZH1EHg&AOkk>J6}53EVvTGM9wujU$w`N|=shT^?tRziL^?xIA* z{6kGyImPpcKLQU@g=OGLGBORFrnj5k_VEX9!#wo|VP5TD`NpZ$b73}WqV z32a&6m6RA#U_pJeI`A^%443C~`|dCA0QBR9zbTQ3&pbF7*c~JonDBpiovr@wtK1|R zq!lC-vl3+Omw2zp>Z$91pR24sV#j zgUxlUI^3cyE3^*b1IQ8ZtK>7^2cGr0tHbkDwA^bu-t zUv#nM?Sc39#obWKMcn8`+;IOpU_#U90hdSkqY=5CYYVt4OUV%z220M>YE!#OnQt%M zw)^V?pZlBVTd(`ruY!}Zwir;%BzR}xI0mC{1|2Q>y0#kGynGhR*E3X)bQ#PqC^O!l ztn+PzO!<6Z>z- z-YBZ6h>E}YNo5<`ZPx=t3_0~kX#w6w?sqKi(% zPXz~du%`PMW^Lis&_Wb8QR{Y$1#qP?o<_Rdb!LlMa$Z-`Oy(t*h>yw^qMR6nM($8? zXu4IYM)wfI5pRHJuNSz)s(s(V>rCvpkZkHiV^n>fWIY{7M_E~h<>HTUF z6s#Oq$CRtfeH4%R}ufX0zVom*vrqm z(=XQMzZ>_ns`!uga~$oD(|@)^e;xaKsqfD!<3HNZu|JEN|9R{`+o``I{i~|uzmTH; z1Ja+y?5}{ohxW4y`H%K9w22?5|1PxuaJT*|>%Y_dtV;f){iLD(@mKhFG=IkZs|) P = ~P - - + +
@@ -907,7 +907,7 @@

#   - + HasIter(*args, **kwargs)
@@ -944,7 +944,7 @@

- +

@@ -982,7 +982,7 @@

#   - + HasItems(*args, **kwargs)
@@ -1019,13 +1019,13 @@

- +

#   - + def items(self) -> tuple[str, typing.Any]:
@@ -1056,7 +1056,7 @@

#   - + class EscapedText(builtins.str):
@@ -1094,7 +1094,7 @@

#   - + EscapedText(value: str)
@@ -1184,7 +1184,7 @@
Inherited Members
#   - + def re_escape( func: collections.abc.Callable[~P, ~R] @@ -1241,7 +1241,7 @@
Inherited Members
#   - + class CharClass(enum.Enum):
@@ -1286,8 +1286,8 @@
Inherited Members
DIGIT = <CharClass.DIGIT: '\\d'>
- - + +
@@ -1296,8 +1296,8 @@
Inherited Members
LETTER = <CharClass.LETTER: '\\w'>
- - + +

@@ -1306,8 +1306,8 @@
Inherited Members
UPPERCASE_LETTER = <CharClass.UPPERCASE_LETTER: '\\u'>
- - + +
@@ -1316,8 +1316,8 @@
Inherited Members
LOWERCASE_LETTER = <CharClass.LOWERCASE_LETTER: '\\l'>
- - + +
@@ -1326,8 +1326,8 @@
Inherited Members
WHITESPACE = <CharClass.WHITESPACE: '\\s'>
- - + +
@@ -1336,8 +1336,8 @@
Inherited Members
TAB = <CharClass.TAB: '\\t'>
- - + +
@@ -1355,7 +1355,7 @@
Inherited Members
#   - + class SpecialChar(enum.Enum):
@@ -1399,8 +1399,8 @@
Inherited Members
LINEBREAK = <SpecialChar.LINEBREAK: '(\\n|(\\r\\n))'>
- - + +
@@ -1409,8 +1409,8 @@
Inherited Members
START_OF_LINE = <SpecialChar.START_OF_LINE: '^'>
- - + +
@@ -1419,8 +1419,8 @@
Inherited Members
END_OF_LINE = <SpecialChar.END_OF_LINE: '$'>
- - + +
@@ -1429,8 +1429,8 @@
Inherited Members
TAB = <SpecialChar.TAB: '\t'>
- - + +
@@ -1450,8 +1450,8 @@
Inherited Members
CharClassOrChars: TypeAlias = typing.Union[str, verbex.verbex.CharClass]
- - + +
@@ -1460,8 +1460,8 @@
Inherited Members
EscapedCharClassOrSpecial: TypeAlias = typing.Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] - - + +
@@ -1470,15 +1470,15 @@
Inherited Members
VerbexEscapedCharClassOrSpecial: TypeAlias = typing.Union[ForwardRef('Verbex'), str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] - - + +
#   - + class Verbex:
@@ -1968,8 +1968,8 @@
Inherited Members
EMPTY_REGEX_FLAG = - - + +
@@ -1978,7 +1978,7 @@
Inherited Members
modifiers: re.RegexFlag
- +

Return the modifiers for this Verbex object.

Returns: @@ -1990,7 +1990,7 @@

Inherited Members
#   - + def regex(self) -> Pattern[str]:
@@ -2761,7 +2761,7 @@
Inherited Members
#   - + def start_of_line(self) -> verbex.verbex.Verbex:
@@ -2790,7 +2790,7 @@
Inherited Members
#   - + def end_of_line(self) -> verbex.verbex.Verbex:
@@ -2819,7 +2819,7 @@
Inherited Members
#   - + def line_break(self) -> verbex.verbex.Verbex:
@@ -2848,7 +2848,7 @@
Inherited Members
#   - + def tab(self) -> verbex.verbex.Verbex:
@@ -2877,7 +2877,7 @@
Inherited Members
#   - + def anything(self) -> verbex.verbex.Verbex:
@@ -2906,7 +2906,7 @@
Inherited Members
#   - + def as_few(self) -> verbex.verbex.Verbex:
@@ -3017,7 +3017,7 @@
Inherited Members
#   - + def word(self) -> verbex.verbex.Verbex:
@@ -3046,7 +3046,7 @@
Inherited Members
#   - + def with_any_case(self) -> verbex.verbex.Verbex:
@@ -3076,7 +3076,7 @@
Inherited Members
#   - + def search_by_line(self) -> verbex.verbex.Verbex:
@@ -3106,7 +3106,7 @@
Inherited Members
#   - + def with_ascii(self) -> verbex.verbex.Verbex:
@@ -3136,4 +3136,4 @@
Inherited Members
- \ No newline at end of file + diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..7fb5350 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,30 @@ +[build-system] +requires = [ "setuptools >= 35.0.2", "wheel >= 0.29.0"] +build-backend = "setuptools.build_meta" + +[tool.tox] +legacy_tox_ini = """ +[tox] +envlist = py36, py37, py38, py39, py310, py311 +isolated_build = true + +[testenv] +setenv = + PYTHONPATH = {toxinidir} +deps = -r{toxinidir}/requirements_dev.txt +commands = python -m unittest discover -v +""" + +[tool.isort] +profile = "black" +sections = ["FUTURE","STDLIB","THIRDPARTY","FIRSTPARTY","LOCALFOLDER"] + +[tool.mypy] +plugins = "pydantic.mypy" +follow_imports = "silent" +warn_redundant_casts = true +warn_unused_ignores = false +disallow_any_generics = true +check_untyped_defs = true +no_implicit_reexport = true +disallow_untyped_defs = true diff --git a/requirements.in b/requirements.in new file mode 100644 index 0000000..e370cca --- /dev/null +++ b/requirements.in @@ -0,0 +1 @@ +beartype diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..fd32cff --- /dev/null +++ b/requirements.txt @@ -0,0 +1,8 @@ +# +# This file is autogenerated by pip-compile with python 3.10 +# To update, run: +# +# pip-compile requirements.in +# +beartype==0.10.4 + # via -r requirements.in diff --git a/requirements_dev.in b/requirements_dev.in new file mode 100644 index 0000000..29b6f24 --- /dev/null +++ b/requirements_dev.in @@ -0,0 +1,4 @@ +tox +mypy>=0.950 +black +pre-commit diff --git a/requirements_dev.txt b/requirements_dev.txt new file mode 100644 index 0000000..520c051 --- /dev/null +++ b/requirements_dev.txt @@ -0,0 +1,70 @@ +# +# This file is autogenerated by pip-compile with python 3.10 +# To update, run: +# +# pip-compile requirements_dev.in +# +black==22.3.0 + # via -r requirements_dev.in +cfgv==3.3.1 + # via pre-commit +click==8.1.3 + # via black +colorama==0.4.4 + # via + # click + # tox +distlib==0.3.4 + # via virtualenv +filelock==3.6.0 + # via + # tox + # virtualenv +identify==2.5.0 + # via pre-commit +mypy==0.950 + # via -r requirements_dev.in +mypy-extensions==0.4.3 + # via + # black + # mypy +nodeenv==1.6.0 + # via pre-commit +packaging==21.3 + # via tox +pathspec==0.9.0 + # via black +platformdirs==2.5.2 + # via + # black + # virtualenv +pluggy==1.0.0 + # via tox +pre-commit==2.19.0 + # via -r requirements_dev.in +py==1.11.0 + # via tox +pyparsing==3.0.8 + # via packaging +pyyaml==6.0 + # via pre-commit +six==1.16.0 + # via + # tox + # virtualenv +toml==0.10.2 + # via + # pre-commit + # tox +tomli==2.0.1 + # via + # black + # mypy +tox==3.25.0 + # via -r requirements_dev.in +typing-extensions==4.2.0 + # via mypy +virtualenv==20.14.1 + # via + # pre-commit + # tox diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..62ab083 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,24 @@ +[metadata] +name = Verbex +version = 1.1.0 +author = Victor Titor, Yan Wenjun, diogobeda, Mihai Ionut Vilcu, Peder Soholt, Sameer Raghuram, Kharms, Richard Broderick +license = GPLv3 +description = Make difficult regular expressions easy! Python fork based on of the awesome VerbalExpressions repo - https://github.com/jehna/VerbalExpressions +url = https://github.com/rbroderi/Verbex +long_description = file: README.rst +long_description_content_type = text/markdown +classifiers = + License :: OSI Approved :: GNU General Public License v3 (GPLv3) + Programming Language :: Python + Programming Language :: Python :: 3.6 + Programming Language :: Python :: 3.7 + Programming Language :: Python :: 3.8 + Programming Language :: Python :: 3.9 + Programming Language :: Python :: 3.10 + Programming Language :: Python :: 3.11 + Topic :: Software Development :: Libraries + Topic :: Text Processing + +[options] +packages = verbex +include_package_data = True diff --git a/setup.py b/setup.py index 34d1196..7f1a176 100755 --- a/setup.py +++ b/setup.py @@ -1,38 +1,4 @@ -from pathlib import Path - from setuptools import setup -SCRIPT_ROOT = Path(__file__).parent -long_description = (SCRIPT_ROOT / "README.md").read_text() - -setup( - name="Verbex", - version="1.0.3", - description=( - "Make difficult regular expressions easy! Python fork based on of the awesome" - " VerbalExpressions repo - https://github.com/jehna/VerbalExpressions" - ), - long_description=long_description, - long_description_content_type="text/markdown", - author=( - "Victor Titor, Yan Wenjun, diogobeda, Mihai Ionut Vilcu, Peder Soholt, Sameer" - " Raghuram, Kharms, Richard Broderick" - ), - license="GPLv3", - url="https://github.com/rbroderi/Verbex", - test_suite="tests", - packages=["verbex"], - classifiers=[ - "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", - "Programming Language :: Python", - "Programming Language :: Python :: 3.6", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Topic :: Software Development :: Libraries", - "Topic :: Text Processing", - ], - include_package_data=True, -) +if __name__ == "__main__": + setup() diff --git a/setup.py.old b/setup.py.old new file mode 100644 index 0000000..34d1196 --- /dev/null +++ b/setup.py.old @@ -0,0 +1,38 @@ +from pathlib import Path + +from setuptools import setup + +SCRIPT_ROOT = Path(__file__).parent +long_description = (SCRIPT_ROOT / "README.md").read_text() + +setup( + name="Verbex", + version="1.0.3", + description=( + "Make difficult regular expressions easy! Python fork based on of the awesome" + " VerbalExpressions repo - https://github.com/jehna/VerbalExpressions" + ), + long_description=long_description, + long_description_content_type="text/markdown", + author=( + "Victor Titor, Yan Wenjun, diogobeda, Mihai Ionut Vilcu, Peder Soholt, Sameer" + " Raghuram, Kharms, Richard Broderick" + ), + license="GPLv3", + url="https://github.com/rbroderi/Verbex", + test_suite="tests", + packages=["verbex"], + classifiers=[ + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Programming Language :: Python", + "Programming Language :: Python :: 3.6", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Topic :: Software Development :: Libraries", + "Topic :: Text Processing", + ], + include_package_data=True, +) diff --git a/verbex/verbex.py b/verbex/verbex.py index 1287218..6f5f1e6 100644 --- a/verbex/verbex.py +++ b/verbex/verbex.py @@ -11,8 +11,8 @@ ParamSpec, TypeAlias, ) -except (ModuleNotFoundError, ImportError): - from typing_extensions import TypeAlias, Annotated, ParamSpec # type: ignore # <--- if Python < 3.9.0 +except ImportError: + from typing_extensions import TypeAlias, Annotated, ParamSpec # type: ignore # <--- if Python < 3.9.0 # noqa E501 from typing import Pattern, Protocol, TypeVar From ab9b9ac842d12d3fc6298a3e737bd15ae2c1fbe1 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 11:10:43 -0400 Subject: [PATCH 36/85] adde pre-commit hooks and pyproject.toml --- .pre-commit-config.yaml | 46 ++++++++++---------------- check_names.py | 71 +++++++++++++++++++++++++++++++++++++++++ pyproject.toml | 1 + setup.cfg | 2 +- 4 files changed, 89 insertions(+), 31 deletions(-) create mode 100644 check_names.py diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index ebae4e6..4fbd903 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -6,15 +6,6 @@ repos: hooks: - id: check-hooks-apply - id: check-useless-excludes - # - repo: local - # hooks: - # - id: verify_ascii - # name: "Check for non ascii chars in file names" - # entry: "./Src/Bash/verifyAscii.sh" - # language: script - # pass_filenames: false - # require_serial: true - # always_run: true - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.2.0 hooks: @@ -31,6 +22,13 @@ repos: - id: check-yaml name: "Yaml: Check files" types: [file, yaml] + - id: check-toml + name: "TOML: check toml syntax" + types: [file, toml] + - repo: https://github.com/python-jsonschema/check-jsonschema + rev: 0.14.3 + hooks: + - id: check-github-workflows - repo: https://github.com/adrienverge/yamllint.git rev: v1.26.3 # or higher tag hooks: @@ -45,7 +43,6 @@ repos: name: "Python: Convert Tabs to 4 spaces" args: ['--whitespaces-count', '4'] # defaults to: 4 types: [file, python] -# seems to freeze with more than one file ?! - repo: https://github.com/psf/black rev: 22.3.0 hooks: @@ -71,15 +68,15 @@ repos: - "--trailing-comma" # makes this compatible with add-trailing-comma - "--profile" - "black" - # - repo: local - # hooks: - # - id: python_file_name_check - # name: "Python: File name check" - # entry: "./Src/Bash/pythonCheckFilenames.sh" - # language: script - # pass_filenames: true - # types: [file, python] - # verbose: false + - repo: local + hooks: + - id: python_file_name_check + name: "Python: File name check" + entry: "python ./check_names.py" + language: python + pass_filenames: true + types: [file, python] + verbose: false - repo: https://github.com/pycqa/flake8 rev: '4.0.1' # old 4.0.1 seem to freeze? hooks: @@ -114,7 +111,6 @@ repos: - flake8-assert-msg - flake8-builtins - flake8-docstrings -# - flake8-requirements # removed as there was issues with requirements creation tool - flake8-implicit-str-concat - flake8-mock - flake8-variables-names @@ -138,16 +134,6 @@ repos: name: "Python: Add trailing comma" args: [--py36-plus] types: [file, python] - # - repo: local - # hooks: - # - id: python_package_check - # name: "Python: Checking Package Structure" - # entry: "./Src/Bash/pythonCheckPackage.sh" - # language: script - # pass_filenames: false - # verbose: false - # require_serial: true - # types: [file, python] - repo: https://github.com/pre-commit/mirrors-mypy rev: 'v0.950' hooks: diff --git a/check_names.py b/check_names.py new file mode 100644 index 0000000..b6d6eeb --- /dev/null +++ b/check_names.py @@ -0,0 +1,71 @@ +"""Checks module and package names for pep8 compliance.""" +import argparse +import re +from enum import IntEnum +from pathlib import Path + +try: + from exit_codes.exit_codes import ExitCode +except ImportError: + + class ExitCode(IntEnum): # type: ignore + """Redefine in case ExitCode is not installed.""" + + OS_FILE = 1 + DATA_ERR = 2 + OK = 0 + + +SHORT_NAME_LIMIT = 30 + + +def main() -> int: + """Check the file.""" + parser = argparse.ArgumentParser() + parser.add_argument("files", nargs="+") + args = parser.parse_args() + for file_to_check in args.files: + # verify file exists + file_path = Path(file_to_check) + if not file_path.exists(): + print("ERROR: the file doesn't exist") + return ExitCode.OS_FILE + module_name = file_path.stem + package_name = file_path.parent.name + # check length for module and package name + if len(module_name) > SHORT_NAME_LIMIT: + print(f"ERROR: '{module_name}' is longer than {SHORT_NAME_LIMIT}") + return ExitCode.DATA_ERR + if len(package_name) > SHORT_NAME_LIMIT: + print(f"ERROR: '{package_name}' is longer than {SHORT_NAME_LIMIT}") + return ExitCode.DATA_ERR + # check module name + if not re.fullmatch("[A-Za-z_]+", module_name): + if re.fullmatch("[A-Za-z0-9_]+", module_name): + print( + f"WARNING: '{module_name}' has numbers - allowing but note this is" + " not 'strictly' to pep 8 best practices", + ) + else: + print(f"ERROR: '{module_name}' is not all lowercase with underscores") + return ExitCode.DATA_ERR + # check package if exists + if package_name.strip() != "": + # check package name + if not re.fullmatch("[A-Za-z]+", package_name): + if re.fullmatch("[A-Za-z0-9]+", package_name): + print( + f"WARNING: '{package_name}' has numbers - allowing but note" + " this is not 'strictly' to pep 8 best practices", + ) + else: + print( + f"ERROR: '{package_name}' is not all lowercase with no" + " underscores", + ) + return ExitCode.DATA_ERR + return ExitCode.OK + + +if __name__ == "__main__": + raise SystemExit(main()) diff --git a/pyproject.toml b/pyproject.toml index 7fb5350..ef77986 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,6 +7,7 @@ legacy_tox_ini = """ [tox] envlist = py36, py37, py38, py39, py310, py311 isolated_build = true +skip_missing_interpreters = true [testenv] setenv = diff --git a/setup.cfg b/setup.cfg index 62ab083..1d9e5df 100644 --- a/setup.cfg +++ b/setup.cfg @@ -5,7 +5,7 @@ author = Victor Titor, Yan Wenjun, diogobeda, Mihai Ionut Vilcu, Peder Soholt, S license = GPLv3 description = Make difficult regular expressions easy! Python fork based on of the awesome VerbalExpressions repo - https://github.com/jehna/VerbalExpressions url = https://github.com/rbroderi/Verbex -long_description = file: README.rst +long_description = file: README.md long_description_content_type = text/markdown classifiers = License :: OSI Approved :: GNU General Public License v3 (GPLv3) From 27383e408747b331c56ba78f8a2cf1ab56c08d41 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 11:16:19 -0400 Subject: [PATCH 37/85] adde pre-commit hooks and pyproject.toml --- .github/workflows/main.yml | 2 +- setup.cfg | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 7a3605c..dee2a75 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -36,4 +36,4 @@ jobs: python -m pip install --upgrade pip pip install typing-extensions beartype - name: Run tests - run: python setup.py test + run: tox diff --git a/setup.cfg b/setup.cfg index 1d9e5df..0071b46 100644 --- a/setup.cfg +++ b/setup.cfg @@ -22,3 +22,7 @@ classifiers = [options] packages = verbex include_package_data = True + +[options.extras_require] +testing = + tox From 0befb3182f0619c5dbe0286144cfd9ccc78fe0ff Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 11:17:37 -0400 Subject: [PATCH 38/85] fix gha --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index dee2a75..f509aed 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -34,6 +34,6 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install typing-extensions beartype + pip install typing-extensions beartype tox - name: Run tests run: tox From aa1811bc650f220546e65303b1d9395d567cc7c8 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 11:25:40 -0400 Subject: [PATCH 39/85] fix gha --- .github/workflows/main.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index f509aed..50adf0d 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -28,12 +28,12 @@ jobs: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - uses: actions/checkout@v3 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v3 with: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | python -m pip install --upgrade pip - pip install typing-extensions beartype tox + pip install typing-extensions beartype tox tox-gh-actions - name: Run tests run: tox From a971431176b5127ee3113d5d79379e07af748440 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 11:27:30 -0400 Subject: [PATCH 40/85] fix gha --- .github/workflows/main.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 50adf0d..5d6456c 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -31,9 +31,11 @@ jobs: uses: actions/setup-python@v3 with: python-version: ${{ matrix.python-version }} + - name: Display Python version + run: python --version - name: Install dependencies run: | python -m pip install --upgrade pip pip install typing-extensions beartype tox tox-gh-actions - name: Run tests - run: tox + run: tox -v From 3e533665c03e1fd475f06dff2cdeab532c621b8e Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 11:33:36 -0400 Subject: [PATCH 41/85] fix gha --- .github/workflows/main.yml | 2 +- pyproject.toml | 9 ++++++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 5d6456c..ccf5173 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -22,7 +22,7 @@ jobs: strategy: matrix: os: [ubuntu-latest, windows-latest] - python-versions: ['3.6', '3.7', '3.8', '3.9', '3.10', '3.11'] + python-version: ['3.6', '3.7', '3.8', '3.9', '3.10', '3.11'] # Steps represent a sequence of tasks that will be executed as part of the job steps: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it diff --git a/pyproject.toml b/pyproject.toml index ef77986..450c78d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,14 @@ legacy_tox_ini = """ [tox] envlist = py36, py37, py38, py39, py310, py311 isolated_build = true -skip_missing_interpreters = true + +[gh-actions] +python = + 3.7: py37 + 3.8: py38 + 3.9: py39 + 3.10: py310 + 3.11: py311 [testenv] setenv = From c3ee46dd7b1729dedd915d69f164473f1f74fc16 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 11:37:14 -0400 Subject: [PATCH 42/85] fix gha --- .github/workflows/main.yml | 2 +- pyproject.toml | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index ccf5173..c37f0b3 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -22,7 +22,7 @@ jobs: strategy: matrix: os: [ubuntu-latest, windows-latest] - python-version: ['3.6', '3.7', '3.8', '3.9', '3.10', '3.11'] + python-version: ['3.6', '3.7', '3.8', '3.9', '3.10'] # Steps represent a sequence of tasks that will be executed as part of the job steps: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it diff --git a/pyproject.toml b/pyproject.toml index 450c78d..4c277e9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,8 +14,6 @@ python = 3.8: py38 3.9: py39 3.10: py310 - 3.11: py311 - [testenv] setenv = PYTHONPATH = {toxinidir} From 7d6f3e7c140982c97f037744a70ac3ba4a88eb38 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 12:11:20 -0400 Subject: [PATCH 43/85] use poseur for older python versions --- ...ive-20220508115341-c1a945c08ab1170c.tar.gz | Bin 0 -> 3764 bytes ...ive-20220508115432-8f4db45c4efcdff6.tar.gz | Bin 0 -> 3767 bytes ...ive-20220508115930-3a2864bd92a8e920.tar.gz | Bin 0 -> 3766 bytes pyproject.toml | 1 + verbex/verbex.py | 22 +++++++++++++++++- 5 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 archive/archive-20220508115341-c1a945c08ab1170c.tar.gz create mode 100644 archive/archive-20220508115432-8f4db45c4efcdff6.tar.gz create mode 100644 archive/archive-20220508115930-3a2864bd92a8e920.tar.gz diff --git a/archive/archive-20220508115341-c1a945c08ab1170c.tar.gz b/archive/archive-20220508115341-c1a945c08ab1170c.tar.gz new file mode 100644 index 0000000000000000000000000000000000000000..2767ac9201f05820b1eea51e22cbe091f2066617 GIT binary patch literal 3764 zcmV;l4omSLiwFpX=XYWP|6y`tXlZt3Eiy1NGB7nTI59CbGc++RV=-YlG&N%|IALNj zF*h({E_7jX0PS4ecH1@*&b7|zJD_qe#6+RxKc&&eZCyu6e45xkvYKv><+2b7S&S)? z1xedl#}BX%vM;tzvNHfkf|O**S<6jR^TL+E0WkB;FF;V{s=4~ZA-#OVsKfZ9rCbep z&HCSHY-pdceXX(HXg(sBkM7}0qL^}+{?Xs_THhq2*d4L$wdU4(W9|9ox9jG!_07to zhwE=~*-c9OgTDQg*@KOzn_CU%DW#hmPy3CnEqklkd_EXFH^cG&?f=bYbB6zKG&i4Z zJzCpb-`IM#)!5wF0RP`;u0MN38V~-z^s8E}zGgn-G-iae)5N2ku*;CMC~^ZoA_E?b z2=xi0k;^z4cnR}ka?W_4dSnprkqIMI1eIkCk~rbavWPnh10F*^KZt3J163-jjWbEj z{A85Uwc)dD9VEUT2Z0x*w=Oshp>xc~tqOrlP{rfW^-oih8X+s>#na+N+yOZp$HTxU z|NZxW$cFjcY={By+L3%Qr=B$(Qcg!lA+z(Q?l@#So=YRyWK`It&BB=MiD}!M2YiAj zi(SUdm(VHp@?o@j^ZAf@=*wEfJ@o_5lq?$mFC_PH!w>$Tq`lQxt5l}oa7g2raUaI! zK^)kDR~K`?r(BWu8Ra-t+9CU1VxdTFPC>gsEfF0{ly<4-(Z0vzx0kLR%TIeT+E~El zx3_Mj+7CiB59-Np-6TxA{_I1${AkmZnkPOcE6W}-`%F$_l(;>oUMApPG{J18;;;d+ zqL`z$Jmy<&WUbX=&|8ZH{SVBJ4f6Cm(g!1y+T{$4+9z)0`VcC7n+f7NfgudAaEHJk zqRAlJ+XPfo*&TutZRgrP2GTk(b6lSGfi$y*TJ^AMkW|(0_uCCnb_XbwCTrEs z z%?6Axa4(rdT%Y(L3wk(OF$o3)i7P)$Kwq&v8b#y{jZn9>)aVR}8bpO(fF+G19EKd4 zl%GZ-W(YE&49kT9EUOkVZy>-=jpZ23>ZFx9B=kBE8Ul;(LF2>~bj&d;8O^UQ^PDK} zgV#O^Bz0@*gJqvh)BGGj97PMGcy=*~qbo+pKoq_tO>Y*ALmJ6mWW+!u9mkHa`Vx@c zAtMgBGzuj8-2|tUtR2}jWKI|0sG-MXa$yUJhg5RWXAE+Tq!n^PE@GF8pB;Xhj3Di3 z+`v!-f@B+`tpmd_B3+A!SEPN!>q)nn8$Z zcqvP;WG_r(B1S=gK0cWsN(aX*m^&iSUR~!%fUN@+h73$|H5E?lL~v6y3MdI6qv)9k zi0V4xG9i@-a=+6rT@;gsAvjV^_f}{(j6yHwMQpKgux~~PU#v6XZH1=u7Q#^m!aA$V zyCp%A^WTkZ868OPqXyWMt2HeJZ3pAQe)o!yBbuQ8N+Mb8 z91|J*-tO(Uf9$k(enP}+y`KLO{&4tj7*gn??oOv`9lWxT5{Z73?d|=Sdh0hu)qSGo zFrw%vMPki4PirdaXUY@nRLE;-)?ZYQnY$fu{0M0vTL^+sVs#^PLPmH}QISRKs_bBX z=elk(CzbcGKxdb?8m}t*RI`XV+3h5=Pf42@rTG6|Yznls%>!jr;x1a+An?54BKN8Y z3{2P(EblS>LzQ6<1!ch9Qx}$nR}xBqp~Fx&4AyT4kU_UraPtygb%UV{u!_H-~- zz4GX3tzoE2AS-(0*L0DnFFkxWR_0VEqrh>v>F_3BA)|2 zJ07}G5${D-FZmcysdz3Z1k6qhb<_G#_iw8t-a(?|jq=r3d$<%R_6|2>a79}#($vR(m-m<7WqJRTajyd%s+~5O@WH1DzTpxFsz%BDF zLTrXq0PEt=^$JVzorr`1(BL+W#8~B0l|-OdHRSF&xK4FC?oiWd#hT!v4&fk*OVyeN zkSR9c9JTnV%&y1uKB{Uh_0hDRt6HcqSG3x56W|sAea&J3adJmBwX-Se1|Lu;){2}$ zjVUIqPZ1!q#{8y{W^anomdr^7i$+SgCpLFad60zGg&PkoAC`T!LLkVQz2r}bp72Gq9k_Vu8pek=|Tlbe4|{;5aN?~FR(s~+ts2% ztbkim02v(8%~xT*^?6cZ;NK5?Rt6&*$*HGGh!}9>uu25~&qCVQZXkO)QXsb==Y|3v9#M5Jwa2L1irNLoAFyQBcHSiqbMO z%6(m2BI*M!)H%;?)P?0)kJneX=X;`E&%7sWduqxv20HXCU1(JFmZdkFx&)D!K-d?YSG&$Goa-deU@4K0&^yl zGZhCaPRmh$n#O9?f?jf+3CuG)#~~LE4+kAp4J;I}bZ5+-F6@8XSl5;Nd%%B3Jy9Yz zz{#2NoG1W8!o?u@{h$LR04Af({0-8~1C;d-T&O&78|Zd*-8-2AopP_al^llO>c^^K z;>0olFNp5H7!Odpqkywd#aZX?m8*8K1tb7LK@>3^w&HXIA0R}x05=_VwKOOI?ghaa z2AicKj9I#+r?|%p8!-fgdqf##`*J{jvM|WLC4{|$f=8sw7A_L%X%K0p&nRz7`E&H* ze>qyYy1MeOudi>bo6HG5TOHAuc#KA`J_1kGFutxXhMq*#+?p4@l@dZAG^~FPy z(U+pftI=&7ZbZlZJIOVNa_3_#i<)=_ICleYsLyr37=OPovZBUXdJ_K&*=vU4q6p#& z?k*5K8vB7i9*I?E$zncZ%x+zy%ZCljvHIh?K<%A)HUX;{WsvW&ra$6;`H@xaSA!J@zKq4F-m8dXG?uH z1V>mlNH0Fgn*Ma8GHZH!e@K<>X$97ikc#ErI|^%S4}lj1llo&T7$^+!(Y4rJYLW6Y zpPduQD*MPi|+M1xTe?ej1wn zBwj9@Xyf+?>2K10XTquMQ3!8=@RL^gX(e0+=)|_m7X>lktJ&<6JWBY1+W7XvB+j2N z;@c=OSgPf@KFgmo-c$&SF6rY4?6%YrOgm;`7LM~6xe&~EZYKgha{e;}(9Ruc>>~?S zpEG(kpL;5(iJ-nWwzG3q8q+cDFTyR5-5Z@x8)HFo?gmMeKD|=`rjHNE7<0zUHs6HN(Ij#%!=Xh9^O$fsMYP(8iCqfm;sx*M=K%;FVzS`so!+e|@5R z89qN;By5T2jDauz_wj8Q%9rd|wO+5^>s>s7e_CPPgZUz)i1d>Bhnn?`Jr z*fO!rf=8{OFFs_&_Y85hbC)obPxE~gCoA_}?;mv9c<}n>!%;E-!t!r^>OYdPl2Q1B z#C7tU*mwR$9RlsMQ`eVgC!MrB5Sf-Ud_InHd*kIx{_f|u-91dVHw!NH8riOUvr>g< zf-ZeZj&dcwYX{Cf=yB(0cW-aHB$X8iHUo$p=Zs_eV(Qi3>>#dsmksFTiN{kG(>Ocz zSSR?!Xu)m8ia7KdK!oA>8$K7V=ZO;zcp66>ykzQ3q%v?6VMQ^A&D&BCdFal_ZVA2> z12u6|&0kUMaTa>i&f_rdAJj!_#-i@mNlZTZ&_8T zln|C6U&4R$-!|#9G%kO`DtN;GT`qujTn%R7|_H3)M@$efUe}l`y zeUK!yVtnz_{165Ha{Pbx?|(GF*`KN3|7dPB8$h?VwzbiG`2COjxURmEuhuO1J22H2 zslI9TdPlI3fl9>TP=`gmUdP2vE~nRf8Q5}p0+n;X&!P~raIY6}yVsM427A48QN5J^ ex)MPyhg@H6LC8 literal 0 HcmV?d00001 diff --git a/archive/archive-20220508115432-8f4db45c4efcdff6.tar.gz b/archive/archive-20220508115432-8f4db45c4efcdff6.tar.gz new file mode 100644 index 0000000000000000000000000000000000000000..e1e7f930d88b0c726493a97a750e8de04448c445 GIT binary patch literal 3767 zcmV;o4oLAIiwFp~=XYWP|6y`tXlZt3Eiy1NGB7nTI59CbG&3?SIA%0tVl*{lG-YOE zWM*bIE_7jX0PS4ecH1@*&b7|zJD_qe#6+Rx|3n*a>n2L#)5P|X-E?~_mxV;gVoZ@- zfV8c3`~dqP`(pbfI|G0uNJ*BQwcIo{FKh`M05jkG0t96*+si*3(95@sx{NCP+1yxdtUOLPb(JPCtng&K!q$!zko2^b5k6#yC)=qT4uA z)GSDbDP0RbtJZ!J^x`n|MSAOk(+E1peAKKExFl6PioD=7C8-gzL|!~CUc~E@gHb#P z1M=U0|A(yE&+UdB0Iwaz7jx@b(*fmlco?x>-gGpI*pBZ}p_;4;yX>(jCcARl7Uv-! zk~)B9JS@M!108$Qj0-vO%irLvR-VFr++71FhZqW&cLVx;t4N+P!aT)B(4(}!U79- z2@E2eEV8{#KsA+@18}14T-(P$S_fv1%hR5m0QCWoX4X)v9#k!os`|rTs{zVx1BKRP zt=b;HU#TpSi;$lY%EJU00=FdH|pG+OqANSIh& zS>4=hzzBWslDWhSNC2{+hocpfuuqV<^1~SPm7Y(9AaAKa-PTg0vlMC&6@CGh432OZ za$r+_DrC%%WKtQ92Lm`xO)$SN!B36l7|iOVnK>l%+LsyviwHpD#FKQ)wJRCTuO9PV zk@vxC4+T=Xwavk@&$exU2_O!|+$f%1jN|CZ5i$^^FDcWT2IGJV)r$-nh-Bi}mR4T^ z@@T+_3oeZU$$mG%sU&NO9*vlL1aQ>QV=}q0g~S7@xacwlIY!Y+IUyIZOU=&?KTU>^ zb_{M{C;~yUh0)f9VHi=aMdYk@I*Dmy0lNSj>-i9eAx0z+5~K$MQU;F&loSSpW{gRu z^h^d;6ZpeR&VpPT?8TuTYzESf3uN4r!O@urvJOiyu3eCgGh5A2lk;1a4tbE5bvx$R zW)`TA59*|SB5^1-Wt!Sa;&2FAya%^Ontcd-qg18{gBJr=6oeKOK3#pt0wRM3B~w0n z31H*0UWgv8dyYXP4N%j#SkU6w}I`BY+~O_87gUsiRPxJbtYFsF`_`#G&1s znB(x$mf)yfn8sv`f&hJdGDegRj#)5wM4-L8&XE9H2PzC1nC5CaoYsltrf3vU5>XI`c#HjN^1q?+li&~90UUd$J4zHzW`MhIV=GwE%Grt>DkQ3k>} ztE;;uM24U)ts+|mx_Q8H&S%1dBsT-3rahL-q4r84O$~A@sLCVC5z3y8_FH>wqKgJw z9Ksr}Z_JVfZ9a>{Se3lQPcFrfF~KJ9_+sTj%xYG6hfmVL80EM%mUZIi+oRb zWlJ>+)qJ$`qxv2fvH>X0tT^CnA@m=GX>?PWk#wnmhyzhdiYG(stZb>`KOifYH#fy_ z;KG*FnX<4J^r(+Io1!kED3sbT_<|V^py(ZdiQkdJmWUgI8K7Iq%7`rE6p8Q3CaAv> zp^BYjqJrPM-M!Y2?bgmuh`+cUpq*NM8B!_*4`_#^}C|# zK2viTQB0JCTyxISnojze^5i-d@>-hp=hb88Zu=ZRLK?^xf*_P!-Kd<95uQ|ZWHGvG zJDA;1veuTH!5ru7f!^}C%nAOn;= zZH!f~eR^7JSh^C(iXQbfT_l=IkHCwyIn~K9biKaEP+8`981qXrS_PYX$rHK%-bI zatbx3oUlGYfXo{6n^u~=DMni|BNfaWDdC>n+&$%C5;+%MJa7V7_SFi3AZG&a$(lcJ zQhRJO*wK5flgzZ>g=p^mYVG?MS2)x4->(oQxeIq~Rjtn#Doo-VOUDqwjGMQXA)$$uQ&vG%b?&q!$ipH9csS|=KHhKrp~eG z90Uv&hAL@hO5`p8=c#1`N;0-=PYK3v%AGKId%G~)7*WBiZg6VZ+bT0)QGbTUYSn^Xa-B)cGdss2=ME41ZCwq_6|hWa%$_dnJ!`C*%Kbg$zoVWg zQ5)doOnZ(9!H{qf;kWv! zYS}ok3cz!s`!B{r)b23k>~nE8`Fri@U2F*nKu{1xPKT{H9l-|(;uhehqb`>Q1;G6< zJi}nKP=ql{H_a6Hcy1$xfN+l}!)#v<$WP`5IdG(~cTn)iblJp3LOl&4&GZ@NO(}nd zUV^VjD_2)n!S(g^ZFQ45!56C|8WW#Ufy(+ilvKZ+mO^KEZ*C;_h3;O3T^3*9Q`kU0 zBpH4!db}Fm#^Hu^)V-5jbD(xUMyjZZr+{-e@J8lb_lxoOb0aHjtc54>Kass=D9(!@ zuHfzh!NXAy2BV=|WtJ@F3&!l$HM)A(z+9(0x(n3a%V!g?TGZROp2%h(-BEc{0o>n< zy>ljEp#xYBE!r)&uaJdXY#_mU+*v$Exaz+Fr#*H`?-!?UZ;MmJSq~rGEEc15mRYvc zWdm@8MT7L>v#jY4M=G*`AhQ9SNye?Y*P0J>wzpoM6&mXG!b93Qb3k@fMBHz6cYKwBaeZ<-+blq;%<}Wl z>?ZMI;Y1t1M@WBD_B$0$ZI4oT2ZSHD%Fip|GC;?+UA`)a0bj#rpX5;@2=&Hy5G8T` zd=cM9iNR7G-wRm&objeYSawMtM_{*wmSDy)6T5Jn$I69ZfqOd<@R9Q$A%Jo2$Y38? zaJrn)v)SBJNlhg6y|JC0voe^DX?GrOf$ZMcJlgruU@&#~Ik=n_8W#H`z|Oo=vMZcE zySR~AIo${gl5;OiMEdkj2beBCAY;rOEtczi1wNkll3|x|htuFR-P4e1Fu*aGtOwpEHJm`rpO3VJKg)W7RsHZl`nc1pXPt{Sqm^XlNeMn|vAK;`3oFMSE1R zd1A}hHVYoLg1-2W72h+&)y`eQP(ID~NuI3SeY3aUZsEb}n-52+00_&!*{T0f#Y#ru z4-(hOZ*t%HJADYW%TB#Oot<>k@<3)<&hYs-%I%L9FZuhQ-yQ8@y1iL&rB~7OyqlFO zMU!;tQ*x9m3A|qD-h&=@4qxu>PL`yy1i_{ck>i|kOkYgD`kNiZ)$g(aojUP&%3>O4 zrylDBzgSJUtyz(WUPFj5Jb%OI!t;H3!U0d?$b*+mpNZ54jv_2+=CFBN38D_&S=lYg zw`QOwZ|eCgnmx`UpZ4-NjQa<5*_yFvI=o1_HN2UU;yY8Gd}j<#aX9#1XVr0r)C(M^ zs+1DJ669<6kp%mT`2COdvETo|_x~S$|KlEh|KpkY`yZ==O2p+*hlx(7?cpYu+v&Utdun+Cm2=3?L8L}4ozA(e hUdsP*>~AX94-WZoJzNjh!*x&B{{X*kqrCu7002qpMUwyk literal 0 HcmV?d00001 diff --git a/archive/archive-20220508115930-3a2864bd92a8e920.tar.gz b/archive/archive-20220508115930-3a2864bd92a8e920.tar.gz new file mode 100644 index 0000000000000000000000000000000000000000..b60bea7a5240ba9b3103719c129b080a58387bce GIT binary patch literal 3766 zcmV;n4oUGJiwFqg=yzfQ|6y`tXlZt3Eiy1NGB7nTI59CbIWsUVGhs3~HZ)>nIWl25 zWjQi1E_7jX0PS4ecH1@*&b7|zJD_qe#6+Pb|0U7J+q#aD_%yM7WHsF$%Vi-FvKUh& z7bIE2~v_JXDv5P%?n!s2f)lXzW_m*tLEwthxGC-qYmSbmU1=Z zHS2$)v95i__GV+PvGs^tKDvi1iDJrO`bU4wYi)y!Vt2&0n_HV}jpmDu=WFJ(wT;T7 zhwCqKy`Z$|47S#vHa6BapKdgtH=e%eZ#JLW&)MdSHD`UWVfW2&{D1rZ*4EYx|6kwQ zc((bdxv{ps`E0YXvAz!ezutV-ctjcx{=f9ATCKieKI1fIgtODcqnxnIkh3Uq13w}I z9*hX}38RtAI2m{e^J8+(c%OP?5b%)+BUA*HWet)z;mop#I|>6HLq9)=X^aC^Dyoe$ zNzMFZl+v}~vuqtCz8wdF7p1o@I1Qn5%*U+?flE-u|({DfaSVw0ZOSka_6KTEso|1J0Bz8vidP_i)1x{z*xDv(cZ$;yQsL46tyA zz#yW@AlusnR8!dFPNS{;qU@v0j|35!;n zYg=0l7-8UEGKaW6@j({!aI|6)3$` zIW#FhjYP~4WI`F13jXQrH?CgwK`74jf2t9Hz> ztt?O)gBJr=j0i0#e75?K1w;l7N~C=B z62Qh`c7PtOdQLzi3{cTHS>r(e1#CJjSyq?+!n&~6xoUd)TwV&h=nj1az9XTsYGP3J9yqYQ*~ zR+o26h>Sp8N=2p&bc=vvozH~_Np1#6PJ1kvL+zD9njGX-P?bj%Ba}TG?YH(=M;8sY zID|1--{>U^+I$v?u`1ccPcFreFTpW0x1GKR7UH83X(i@sSLjzpvrZPUW= ztGzdSU68ig>p3!xy=!;7?T&1^kWD`y9=1EXJ4bCxznLidgI}iH^yJN7-tKkVM~6GR zZP^^j=I+jq@_Ss!2B0{-;()J((BBQx=q58G>C*@z4n!#-o(Qe;vZajwfUH>F+!Vus z3sX>M%EDUEr5@^RhPon2A=QS#7tDAFMeh(y{Eig1LYx510NqMdMr0MINIXY0LH(6P zve-E$GWfmQ+i(BaY47}mh}U{O{}cS-@ZT_`&_~^!PS-kkZ6PHR{U+Pn`>*uY?~1DX zOwD0L(NT)Tnsc7kRMO9sC)TNu*V3%Ns2($SJK*>c(m=Kl1fj(0M&^W!@T8(5i`G@y z!Tip3-DFNGA7FvbE^jqnRraZ75p%NJNoJptHZw}`|AW{RXlt7X%BaL$w6sCsdBH{Q zRS_7Nuq9aDWBP|G!yXFCfV-zIEDOoUh$H46bAILS{BynI`9RJLg#`A>={G0QU^_j3D=7o%3lmINC%$ z2YPlqbfY5Pi>zMqF`!cMTu=y@ofzt-^`Y+HR!O{tf|8O#Uq8SXbQDmz*dQ~f%vY_N z9|PB~X=+Ffd(x7r<0vaus~as!WU7;OzV5tbQFlZE2c{fz>PNW22N=m<2uQg;?l6H{ z=39i=45U7+prqhZw!9^XyK@^v& zH4PwBY`{5c@l%;ykLi6>)mrMKX+2l9P+_iUwdW?lEdct4#Q@^uj%sRWQ`8MUpirz8 zIfWWiOjw^HKxU2kO(V_T6r(MflL{7%lyFaM?w;}>39Sn^9$G#u`)Y+ikTZezM9rT! z$vw6??5MrgX=YmRLNxb5wf6nXE1c>2?^lSD*oC_`s>bIF6(sSEaxFuM&*Htn`Ydi& ziwdyrYl9cc}d?nCHz)n<~em za}Y3C7^mRsKdEhqC?drPsG6g#2UUMrs48PS+ zRl~%IWdL3f-G4D2pms+AXP=9+&fjZS?P3c^0D^)jVmfTa=?FeRh;9LHI_hd^PypNu zf-?*@OGOy7bW2Zhj~6y#2nhFxGR*e%fc#`(kbO%Cdj|!NNS7^KB-GO&(n_CE-jwp^ z=*9nfv~qQIwYo*eqm%qjkWY7{wK2648=te z#1-6KAb2$P1AjactIU$ce8HIAx<;1|8<=DD$9I9+d+}@nR*P!;){U|mNPk@3Q~>vP zWA~g1Sm+RzL(6u{?JH#A78^*g9=Dc{5w7}gz-gbI()-2f+uPz4a%SVBo8@AZ&N9!I z`fLb}uxyZCewH=;;YelH^zQzUD%;ZvtRo>6%e{9L*47>ZF9;^}$5t><7~-RAvAfhF zO0)bt zH2X=sTsYCj?-A19r2Wo>Q`w^s-U8t#t@86qxD3#VZI`bKV!&6k*(Z6F@B_8+?T1O6 zKVQVRQDU%E%X58}KWDtD5Efn1#}U|VsU?_p%)~4l=P`02nD5+91bpQDM+l&uJJQ%k z7OXyJ^lU!&R8SK^eQ#`M=d3iQW7=PYTOhkPHoH4NY7C|hzW|rBLc?;O1elq33U(uF zz%FiNR!ld>g5=x{k|=$8rvgkLACNKTjF-!Gz5<`jd&#KJxW%b|n(k?cSfTcg!0E)N zS>k2yg;64gKo6BeE)aZWP=e@tq(>()PVt~D=o`-?<^e#`EE6(FdsXs;R6nKXYhWer z8e%={ibJmwFl1by1hh@Vz#hhIuswz+L8gI?zM#;?kGFwa4*KVY8*<>4VDI|r6-{zv4uixukJb`~&alb;!FB^cp~f;rSar7p~`t6ApM9M;yFl>P)0Ea1>!hF^A3DQV@CQ&d6>F zz7+#CaZ}A-QS5ORdeqM2Fzz4JMQg^Q?(k94ui?#<6yKS0#XDnoio?S9I;)m7qONaQ zRjHH^mLOllk0h91#P5G>O#J>wbM4{xKknuCKc4Hq|FO2Y`K)PfZmz90UTi)52FPFF zvTz?H39T4k{4_sCfxjI8pZ)tE4RH2n>i0jkHr6*F7Brii>st@M|8XDJ)i?6hngxFc zrrILax2<092o^F>i8vhUu&CGTxVXvX^m?xXTP{zaat`=e6hap6^&)Qfdh*aaNX1OKlZ$*-vCem0LNcF6951J literal 0 HcmV?d00001 diff --git a/pyproject.toml b/pyproject.toml index 4c277e9..04d0fc5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -10,6 +10,7 @@ isolated_build = true [gh-actions] python = + 3.6: py36 3.7: py37 3.8: py38 3.9: py39 diff --git a/verbex/verbex.py b/verbex/verbex.py index 6f5f1e6..520a0db 100644 --- a/verbex/verbex.py +++ b/verbex/verbex.py @@ -173,6 +173,26 @@ def __str__(self) -> str: VerbexEscapedCharClassOrSpecial: TypeAlias = Union["Verbex", EscapedCharClassOrSpecial] +def _poseur_decorator(*poseur: Any) -> Any: + """Positional-only arguments runtime checker.""" + import functools + + def caller(func: Callable[P, R]) -> Callable[P, R]: # type: ignore + @functools.wraps(func) + def wrapper(*args: P.args, **kwargs: P.kwargs) -> R: + poseur_args = set(poseur).intersection(kwargs) # type: ignore + if poseur_args: + raise TypeError( + "%s() got some positional-only arguments passed as keyword" + " arguments: %r" % (func.__name__, ", ".join(poseur_args)), + ) + return func(*args, **kwargs) # type: ignore + + return wrapper + + return caller + + class Verbex: """ VerbalExpressions class. @@ -248,9 +268,9 @@ def _capture_group_without_name( @re_escape @beartype + @_poseur_decorator("self") def capture_group( self, - /, name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None, text: Optional[VerbexEscapedCharClassOrSpecial] = None, ) -> Verbex: From b576312dd3166c236fd7045f5f4cdc64a989a3e1 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 12:15:53 -0400 Subject: [PATCH 44/85] use poseur for older python versions --- .pre-commit-config.yaml | 2 +- pyproject.toml | 2 +- requirements_test.txt | 1 + 3 files changed, 3 insertions(+), 2 deletions(-) create mode 100644 requirements_test.txt diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4fbd903..bbf2403 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -55,7 +55,7 @@ repos: hooks: - id: blacken-docs name: "Python: Formating code in docstrings" - additional_dependencies: [black==20.8b1] + additional_dependencies: [black==22.3] types: [file, python] - repo: https://github.com/pycqa/isort rev: 5.10.1 diff --git a/pyproject.toml b/pyproject.toml index 04d0fc5..584c358 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -18,7 +18,7 @@ python = [testenv] setenv = PYTHONPATH = {toxinidir} -deps = -r{toxinidir}/requirements_dev.txt +deps = -r{toxinidir}/requirements_test.txt commands = python -m unittest discover -v """ diff --git a/requirements_test.txt b/requirements_test.txt new file mode 100644 index 0000000..b654c22 --- /dev/null +++ b/requirements_test.txt @@ -0,0 +1 @@ +tox \ No newline at end of file From fed69335277973f0fb622df46a3cec9b4c40b629 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 12:18:07 -0400 Subject: [PATCH 45/85] use poseur for older python versions --- .github/workflows/main.yml | 2 +- pyproject.toml | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index c37f0b3..f90a665 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -22,7 +22,7 @@ jobs: strategy: matrix: os: [ubuntu-latest, windows-latest] - python-version: ['3.6', '3.7', '3.8', '3.9', '3.10'] + python-version: ['3.7', '3.8', '3.9', '3.10'] # Steps represent a sequence of tasks that will be executed as part of the job steps: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it diff --git a/pyproject.toml b/pyproject.toml index 584c358..9dd6e66 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,12 +5,11 @@ build-backend = "setuptools.build_meta" [tool.tox] legacy_tox_ini = """ [tox] -envlist = py36, py37, py38, py39, py310, py311 +envlist = py37, py38, py39, py310, py311 isolated_build = true [gh-actions] python = - 3.6: py36 3.7: py37 3.8: py38 3.9: py39 From d28af7a819ea885241df665482d375a584788184 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 12:19:55 -0400 Subject: [PATCH 46/85] use beartype protocol instead --- verbex/verbex.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/verbex/verbex.py b/verbex/verbex.py index 520a0db..a1ca65a 100644 --- a/verbex/verbex.py +++ b/verbex/verbex.py @@ -14,7 +14,7 @@ except ImportError: from typing_extensions import TypeAlias, Annotated, ParamSpec # type: ignore # <--- if Python < 3.9.0 # noqa E501 -from typing import Pattern, Protocol, TypeVar +from typing import Pattern, TypeVar from beartype import beartype # type: ignore from beartype.typing import ( # type: ignore @@ -24,6 +24,7 @@ Iterator, List, Optional, + Protocol, Tuple, Union, cast, From 013d258b1696c7b07d5d17cc7e82b2d0cde214b9 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 12:22:08 -0400 Subject: [PATCH 47/85] use beartype protocol instead --- .github/workflows/main.yml | 2 +- requirements.in | 1 + requirements.txt | 2 ++ requirements_test.txt | 4 +++- 4 files changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index f90a665..a413918 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -36,6 +36,6 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install typing-extensions beartype tox tox-gh-actions + pip install tox tox-gh-actions - name: Run tests run: tox -v diff --git a/requirements.in b/requirements.in index e370cca..f8fe16b 100644 --- a/requirements.in +++ b/requirements.in @@ -1 +1,2 @@ beartype +typing-extensions diff --git a/requirements.txt b/requirements.txt index fd32cff..d94285e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,3 +6,5 @@ # beartype==0.10.4 # via -r requirements.in +typing-extensions==4.2.0 + # via -r requirements.in diff --git a/requirements_test.txt b/requirements_test.txt index b654c22..f52ea7a 100644 --- a/requirements_test.txt +++ b/requirements_test.txt @@ -1 +1,3 @@ -tox \ No newline at end of file +tox +typing-extensions +beartype From 5d8a4686155afb18dfd15fc548a2fdf2eb8fc6dd Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 12:25:13 -0400 Subject: [PATCH 48/85] us typing-extensions protocol if not in typing --- verbex/verbex.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/verbex/verbex.py b/verbex/verbex.py index a1ca65a..2362835 100644 --- a/verbex/verbex.py +++ b/verbex/verbex.py @@ -9,10 +9,11 @@ from typing import ( # <--------------- if Python ≥ 3.9.0 Annotated, ParamSpec, + Protocol, TypeAlias, ) except ImportError: - from typing_extensions import TypeAlias, Annotated, ParamSpec # type: ignore # <--- if Python < 3.9.0 # noqa E501 + from typing_extensions import TypeAlias, Protocol, Annotated, ParamSpec # type: ignore # <--- if Python < 3.9.0 # noqa E501 from typing import Pattern, TypeVar @@ -24,7 +25,6 @@ Iterator, List, Optional, - Protocol, Tuple, Union, cast, From f69a8f4c31410ffebd2bf86f35803d5a2c9382aa Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 12:28:08 -0400 Subject: [PATCH 49/85] use runtime checkable from typing-extensions for version 3.7 --- verbex/verbex.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/verbex/verbex.py b/verbex/verbex.py index 2362835..c383643 100644 --- a/verbex/verbex.py +++ b/verbex/verbex.py @@ -11,9 +11,10 @@ ParamSpec, Protocol, TypeAlias, + runtime_checkable, ) except ImportError: - from typing_extensions import TypeAlias, Protocol, Annotated, ParamSpec # type: ignore # <--- if Python < 3.9.0 # noqa E501 + from typing_extensions import TypeAlias, Protocol, Annotated, ParamSpec, runtime_checkable # type: ignore # <--- if Python < 3.9.0 # noqa E501 from typing import Pattern, TypeVar @@ -28,7 +29,6 @@ Tuple, Union, cast, - runtime_checkable, ) from beartype.vale import Is # type: ignore From 395b2b6d6b5449e8a5fd203bffeb4ad4d5b8dd4a Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 13:37:54 -0400 Subject: [PATCH 50/85] push to pypi.org --- MANIFEST.IN | 4 +- dist/Verbex-1.1.0.win-amd64.zip | Bin 12788 -> 27913 bytes setup.cfg | 1 - setup.py.old | 38 -- verbex/GPLv3_LICENSE.txt | 674 ++++++++++++++++++++++++++++++++ verbex/LICENSE.txt | 39 ++ 6 files changed, 715 insertions(+), 41 deletions(-) delete mode 100644 setup.py.old create mode 100644 verbex/GPLv3_LICENSE.txt create mode 100644 verbex/LICENSE.txt diff --git a/MANIFEST.IN b/MANIFEST.IN index 9714462..6ed0c64 100644 --- a/MANIFEST.IN +++ b/MANIFEST.IN @@ -1,3 +1,3 @@ include verbex/py.typed -include LICENSE.TXT -include GPLv3_LICENSE.txt +include verbex/LICENSE.TXT +include verbex/GPLv3_LICENSE.txt diff --git a/dist/Verbex-1.1.0.win-amd64.zip b/dist/Verbex-1.1.0.win-amd64.zip index 5c11901347bb1332b4914205efd0fcb1d8ef734f..374059f0fac7792baa899dd44959497e6369f7bf 100644 GIT binary patch delta 25705 zcmV)FK)=8AV~N@U3{Xo01QY-O0000+Y>^Bm0!D0+G%5l~Y>{9%0!VC;nm+G672h22zuM0f-TNW2jW1ig6G64FCW&KmY(NlR*I{lRg3qfBkaXHWL3|Pl3|y zjF>2L(wpnt>Ebr3qokfDwntXd>)0*}iIBvaB6$F5N9Xtf?m_Ow?n!QU0g@mkSyIM! z+wc!t0vEvUZ$I%N$8lbZNJyRvCdDKRxn$x)B85^x94R)I@r?0^39bSm**MHZl(I`9 zhdgBCSkBsx<1~oMfAhv!nn~e#ESM#+Orc*Cr#!`h8V%DXg{Br!Hp}UH@L9KxvuKpY zaj5cFSCS{tIhFHHgTX^o={yOdNlwyaY==F6Qhiu3X2_JK<1`+{Vc9a6C!!k$T$N2Si_%~wf4tFDj4t>v6#A9h5FbV& zN!bDM*po7r3j%oJLnTdM=Vf5q*5M@1QE9w4B>(+_zVW2CYSB) zF+jetKLu~wEA@K{q%C0Pv_9?mIZz)1X`%n7bL_Y*f7j&u!`@TSWgjSv%9>7p@qMGQ z!>(d^!MKbwUdCsN1$;Q5S{Sbje_RqK!m<3``~kk z0%_g0?ZJxA?RNW*0OCw-jN--BB8~x#P=H8IqfKuWj8m?3FE$e(l8s}ZtiA^1U@Djo zzKa4;zuVx{lJ(SxC&C{998L6?LN07!>6B|Oe}+OpGSajpCnPQL!SK_SlWYe0$>Iiv zVh{s+7-@YNMlkJKjAm`;lh{TUi7T+NQ3x>@VnhZZfjk(HvUseZq%mN;V2qeDGg(+I z;SV301-Z1?OJg(G8l*iR$YelK&|3|;yCRzuZ9PMi=678a@*shmc1*^dA|jt2 zf45lwoN%Z%6`Ja1X*`2;KZ4hD!#)JQc`j3e!ApQED#j}cU#&i50g*w2qS^qx1hDbN zC`OMqJr|%M12i;#(X*!R7gSu3m~QDD5mZCXN9Z*j6NOsr(If3gox-CChkj>iGQ-DM zf~R|7zM>cf0s8cOfhZpw(_QI^Kzn^tekr#&U+P$YG6$mroKfSRut)|ZCMz8dGPvR z0Ma^VXTFYOZ+e44udkb~bkn=z<6eKid(!jlmzkkI`f16_P`~`?hl4@yPX$q}248CB-Qz&|;VB&YAupQ>dU}C3ByiTp(|cDr6K|WI(H66cE-kUAMI`UNv=A z(q9$w73t3EWpq|agW6<@(5lV6Fi!gao;JRE)&`l0hx8VMJlmfJ9%vcl(&+CEk-e+rH;-w;E(X-=^j$6`$oglA#eVb?VfZrr7Tc1Oop50)Hh zUVlRzr1~4TV9FYNHC>&iL{f4*$_h&EBqfk`Qy2C9np zCJXO!3^4I90EK|r(NMQ-ZP=;FtBJQ!J~dLMgsmk46xLY2 zbo0WKW3**!s+dh9CA^~pjERi1#JdX8DdnhUB@mQMf8aY>u9i)Ddw2~y=7?aKnO3|I z&3)`Nzk7a-Gu?c9jVRFu@{Q|k9R3%DinH`qx$Z-Vt$Ba3SUWm6qEl|wR3y7iNnR{H zEtC!z`Jn-sbZecYm<$f%NYnu;M%k+Ws_0bYS0fc8sjN_Q2!b#S;%3@>BZF2hV+!+A zp|i+1e~>CI>Mrbrt!cT_hR>R;Y~z;iz+oFMb#OFd4;Fg#9^#_{>DRV$e~sm@s3*?!c}~9G zfdvv667FrVUyu4g0$>X6uix)4Jiu80IDl#dcQv=G_1@~V=+}EKv&)5$?0j_GHcqUA zfAWUt{#(cxwL60))u-ZY^YTYdN06dK23k){* ziZEvGj-B=%ZEVC45FQX^nC+?`je``A}#op|}+z6l9-K%gY(kr}F5Yd_6>~qoM z^=uo5oALSZPIAq$-VK@Sq9$Dd&fUP9*mFHB#@}s>EY(=|p2Yt|_FAC0DT26yy9)$Q z=20BYXSB+!Se(!XFl=FSf-gkz$0$IrocEKFc~=8j2}6!hM7E z{FAKdcSowQrZ*3VRNbC-m_8q-{dg31WZh}l5KJD;y?AUe#G4qjyVPOzD-yTnNEjrY z5^j+`kAO?Ibn|)kHi6}N3-%*mK<(Z>O!Fa(^ zy)cMGdG>f)AxvHJ;|T0_uO*muYpPwjo#vK8h{)eg1U!cRJp{0>(OK*xe+%AF3VyMk zdrs7hs2_~&;@Y6abjpXDa0_G)#^#{=y~SYe@EdTsDm2{hNkF^sPGVPiV{vsWvozft z3zEwq&QyMSX9CO+56Fb@=l9EXxdLCzd)aI#q$hba$@erUR+zmba60<5O1$FtketyF z=%ISZ4T7%@N)UZd?C3<}e^ltu^YMCZ82~iReL@Cl&tZ?5^D)1311s^srS)(?cepiR z$T*<{w9i}@d$_B?4h7y0Sq3)xf3BR@_;g}6nH+4a))6n@D~p0r>_31Wf4e992M5a~Y3x9-8AIf_6cW>yFh6-OF6Ww`W&)kQ1vwEZPm7z7 zErws*4!kz3&_&o7B8)75uyz%MA>DAm+cy`2WSK=i87jqM9*?5{uh zWoBKv0nmj|NduV>}9>%H^t+ovuBs*{7d_xan9b?>+U&goc&Pu zRi1V9_S7z_)rI}%rt5a?FW-H)Zr2xe^Z4Db#?GHyv#)8@qP08MY>TdQx$SDZqUCK? z$UAR^k!MCT-7?8f7h#i>#A;Q>3O@_WYuF)J=&tf z@>Sj0tSswimtUAu=jH!y8<%aDrNdJX8z*RUm20xn-u6q{&0gt_v~FhCbnYobT)K4^ zpjp?AX+1V@l)Brv#(pcRyanjbb@Q#g@SEscEnc(Ry6xWUS?!7p3t+@hdS}93jpr1lGRW6ZBQrWNkM!-JhPgs5)2W za!-$a)@1av8}Dcib|mEE3PDeN{)~=OKQ`I+^=n#a3((u1UZLx1+%_xdDJ&Op2+UxS zqHAs6(nK4loel znc`14U*p!UX+YbAImP)D6mE76or(6mq2-UCc1SgLfckEeb+|~g$)1En5)w){Q5f(5 ze?EJr*WEk{`O^wpTdc99eJ$q)#Z6(lQk;+!?*)W_D-+(hL_pPd*!@7BmHJN4zzsjFAUhUkf6Dnu9 z*Ya&tPH?zu+!IM2p$rf%;VgI69(RO8f5@8hBH+y0Z~7!(}L%kKR&>r75;A)}TNl`n*_!B!4+vkHEt3aOji} zz#@D`#>@v=%l(mUcO|X+5(I6(+C+{g)NLGAG4xYcFh-cW?b_*Kw>|OWE^Fy;e-&V1 z#JE*K3s!_eK2f%HM&W7?2rF048Ac^laQWZD^Mk^Gb3^dK(!kp7p80_ z6w+I*Z5hP9VPc|x6`o8OPw$C3%6bRVU;tDoiJ-l`I!0c^Fx|#>&qN)aBfV+P-kcNJ zklgE7*NE~3at4n$U#SRIkVkQQ<- zo2}>p=0L(z2bD+XZu-g`9%IDZc%jIdwus5Hk^t%-H~h#ptNJyW55xqGQAyX(RqfV_1THKikWxWkr8T*Ii=T{f7r`|N;@p{WPymX zhCrj=E$K?Du23wiEkU>gQ!q66drkzL)RU@Mp-q`;PwA zLSFV|9_?@cfNB`xeLM4CB#lP6w>gNkk%v7%V(Kx5#HtSmU*QObwFq6lBiTwf{{%v#C&=b< zUDoU`)KU;j0QVKe5ee?zOC#g=BQ8{-(zmj0Vg>lEtGap(e^`R2phT{Ehb^v}n4)8O z08)eyC)P~lI0y!^Qsl>qEn|8Vw{hARdYIpRy0^3I_xAGU`u*ZzadUl-hrhodb+#@l z*^%F$JR~}1BIYUIujis410S8V!eyc0R!+p=-nxuV74+TfvY;y{vuBm-Vp7vaL*L4< zXERmNLL}(6e+7_4tO;dC##eybk-Nu;PQiwaANI^x0>ai;AC0I}Z>eaFhu+$GMw{s) z;u+>SU3tqY#!g7(PUxwLzTnykU&$mIH4}nt4{Atd9KlPza#j`plSOmnKlQ^hc0y;60;1}yxz z%8&`T601ZdJ)OHRSwApv1!%o2fe8gXQDPH?$-q7+ykEuEApdK!Wd8~eV&n8FM#jue zRyD0f&)|0xMTILAVB)SS?5UTXEYGVOwWIXU0mp+^M9q7lhU}}T!R8(u+hGUT^1jq7e#ZSaLB4!{l z{Rea#{f}GqoyI)C^TrEF8;m&o6^3~6l!=9oJG<3$f)Ggampv)NAVIgMMWr67cqxR1Pi!+(gszN@SGm`W^&%7>Y$=lk z#X}0U12A&quwXl~Ut8GS9NrLPT0>6)KVe2_wu<{aIoW`JK^B^W+$I}&PeNn16a9j# zf4X9O{kn$9(N2u|L~I=h<%zqimzT+oRpB)%Ewn8v$Lbn31Oi-ZQsu!Zf`1WqmT*Pb zJCa+)`v*V6baYALjwzO2HtJQ9o+-g9ZKQ|L7Ya3z+2SFy#fJ{OfNfb=3RZayUN;J6 zuT}(7cG*ZB74BItCIk80?h5>CW;UPXG5dc}!xd`VSi{+?mGD95O zPsQ04jMK#+4k99kSK2zqPAmjtLw{{(4JM2?7vv?d>v;*+)9d_6;*U<$RZhi`m<0$5 zk&L51ZwGRo<6FX(DYJ@)(LpKQEdR@~1jq7`w_tn7&c-jA4FvB!Ox3K(?ZP81f4-g| zQut8>a>0Ki_q2c=CdMvS$YE0u^khnAV9olGbRPZeA0U^l&i9C3Og$=BnOKQoqgKp2 zmh^%oX8ToNW+B?P1sY1S{`%|@!H`P8GlTTlp!F61g#T>6G%%vU7>P^4qybLPZxtazXEh zk~capv*mIccco34*i|TT2A1n&=T= zbrK1c2m6BciPR7#5)0oR5)NOO07n)@cvf{%d!SIPC=}5pF@y*_AYx-Ceqg>yIlvP^GY}`ma7`vEe??MRno(dZaVW(%>ktH#h=mf*THuUlWifrufMK_;GjD@}ZP$d&@_f5j-$dh8xeQ2mJ^ z5&Sf}E=snl+Ij_zo(sF`ZOR`tVy|eI5V;#Omt>N1Qe%oX$UKHxi@7|A*|N+ z%YYhh6$Ed|Zfd+bMK*<)atkXY&pKv~ZC`mOmfc+;g*9ReOESrv(@=m( zVMwxQgxz+4Ue6%MfAA_H{*;D-+3!QSP0Inb#(6eCB(&y07avf(vBSLw+ZoyJWmtx+ zI+lA9pCJK^$ap;24;S`b){)%3f52|d$Z9~)gTv%~RTkR< zYYb!9UbY;1ed?T&(?a&U+zLHhv9dI&56KRz{=D1|(ZO1EGg7ayOG6n0fVlXLv&nt(a&u}>2g2x3HgFK z|3PN*mP6w}e~fwp;?xenN-`+q+9H=I#&z&#(=ZdMz7qCPrg!0U-VEb2qEni}MT~)n zhI5i08a3KSo7W+CrZm>pAQ_Rv2xV@vCt*4g+U&v&ZCUat%D$DL9F`!sSfVS2B$Wu6 zN0QO!xYiO^ucBDiz)?b}KIcd}8F6J=!FUd6$4&&8e=<0F9Cm@+Y6`K>R6_`cjXH%a zy28ydZAcKaZ$peF1#)z0Mvp3~DGuomFhMNA7qoPntXxl(zxh`ZgCN`)jUfV*DKj#k zO+uqdz zR{a)!e*i4}L8S<21Qt8qFoK*&qby+P;OGqkbdK^Tms!cbO9F8DbEB5+vES<C8yd5l@ZszQe^7M0yYmW%^b%j-`?LY z62AT2*JoWyKrPikdb^_%E`Ko9&#&5ne@P?C#rQBCN(&BQp=VZ%O&YfAJU? zJyrW?_Ba|IE>fy{unpH5fv&1r{|#jn(VAWg3<={I0qaP8Lfh|lHH2Oh1BJ18Al8I1 z2!BtB?UT3d)H41(O|*}wE{*gb7^-S*j00oA=PuMz9K58l7atT$sn&}KXM%~~ul8@p zC|1*4PSZ4ep>3+jevu4acFxADe?{o=aeG+6mN|d3>hfu}K6dKpjLXeCL*q%^g zMc$RuY~b>LwHIgG`TbB7cg&p-&PX-2@Pj<7xZ-7g_NKCWg&aH5(@4-W{R12#k7!&V zR+yY%oQWQEbslSkyba4Lf`nfaJmDk~mt_9%zCV=Y3=vDD=U^*}8%}&tf48k`eI-E_ zb7Z3hxWc6KMF}DTrYS#;RDF;ZLL0fDlEgC;-PB7DhB{Rr>X>O2C3~Y&y|Txw$xGCo zz}A)`roDvVIi$!1RRhNbf(3RIzd!WBQe1j(H7T6T_L{Sg5gH-Rid>rlgs8O>aZxQU z<4TRz5#S=veX*Ahb6K08f1~swY`n?Z7g8;RDVA4aJxlU~S2>w@c?;ZVd}*M(#yjbO zLS$OY64>t4olfr}I-8f^Q-l}CG;bh_n6ZxT<&%#IH)?G zFdv4Y*!6|gUP+pW4W~if(ZJAQ`955M09$fY-)BgDSVzo_Eix<6e|k#WZ6j zD^*zpz`$^-57vLB<;iC0NF)Fy8vTlSeRX=pkwNOIVwdgM^>LP-{?DH%#xz%%lo2K@ z2|1Kn4>9){Z3Vv&f78xSsZPBnV@1{J2fCaSx^x&QITA1q8c>9hi5jpa$qeNG{iGsH z5_(%=Oro9FD1>5}cQhh4+H7pn2t8FUDpnFciAuc;`;CI>Y#5N+L)wOIHBRVl_AT4M zTIR)zoW=Nb^28AuJ)g3@x7}q`;p0joC60&sia*3!$!y*?e-c0QtIL9-!ANq|Td5vk zn&lX6EC(d4NI_my?f+lToQY6t;J;U51x_tXeX;gP50mKtenI`!-erx1Zj(nub0+a8 zZ%pn)TQyQ*EtpA+ObIMWP$L|L%n77-ki$?X(`#{6-D+v1n9@up7v#z%1Y`Q8xUFdT z^l}0PC`4*Uf1M0IPLI=r9E1`6*Xd#EGo);}s}|qZQVpO{BVxU_uC(Ap65xJM_)=+3 zL+zOu{R(C=Qx!^*V_B=Z2QN`SOzzBASV#tvsiUgZ1&J1%(sLqRhu&p+bz0GpT-YH! zYK7#JMy-wlnA&hziBi^#&5NS-K_v+k*Q-_5vSlXje<)Jw$Y3C_AQhJIQL&1TE2kyw z$H5mJ8ki^ek#Z7wV(AUUpO(=sI>Go$^~RW;<&G5nl9}N+JyU6kq|({AW?$~(Tue*B zV2n~HxBlXVt4Af7iwr&ylDVs9|@G9%Rk?5dMgD9$CC#hpFXc_n`bT{&V6EsOl zFDITEe-iaD{E|aa+8)sE^du<><4NV8uy+9*a)?UE{!Ai6A`e*J0qrrGvp?rGSa_(g zYtt*xLarq8o#fg}PQ7nKO^j%31zxj`(U6gr3n(#uOH(ss=X zL$67*)xJg|a*c*>)YneLM6RxccnGXrh>VipV*()j1SBcaut%X87#ujnOOCS`m}8K9 ze+{k0AG#m8`)5gQOkAM7sb=J?~*n3#t%B4jTx#eZ@<&Er8$9ep;@` z83?u}Kw})#l(3o80!EJ^e-^HUUr61KILHf@RQzvW9+a|JQX#mdW7T;(1#PTcj>N!J z`@pnf-F|a>L9YnDBChQPZl1I{e{m2&>V@2qwyneHhOfsP00;?WvV-@fC$v3n(YXP5 zhzgmuN2#J4s~Jr;c16`g81xm(Q8j#HKp8B~Ld$q5iH6i#N*A?NM8trEisW2Un!~Bh zrDHdLm=6NwEK%mN&9q2#u^uGRssmA(hGM9A&DvKF!Ng_oTwEe>ohtVn|{~^7~CexTC}n{(Q(1F)B38N>-wVG2fNgW2hF7_ zXGg=ELkL?|j`R~*!vCWM$Icv8VRG(aeA^?HLy1e5`n^VceS3<>(1PD<0x6AXhe!{{ zbPPEMl`1yebyZ6OII#oif9;N&!6YdJV{f1G)`%vx=~^uB0miv-FO-|5!BoR^rwfYi zxV!mu9?F(d_!B?s)X@(s^fEJA!gE==oOkJAJ90U?&mJ*B_dA4;r8YuyKg_d{Z2}&e zmpn)f`)JkpuOFNc_j*s{b2e#{49jt35Ce#DMyhEEp^n{nZs`mVgY_Z&$` z`(8n`p+5s)LKJB;f2N7PLRy3q?+8$8@q>C=jIEz9>@4PG9-I%TPLkio1P9u|8kd&d zfX206`XIdN+s;6xD9ttbvI)tF`E&=H zkt7YIW<;9YV!JV!&C*Ph7OSU$tU)bC=mnRAlf?QCdY(|#f5w_FI|{pz$hWUjPitsH z-d5W^o6d6}oANQAWV}F!dy}j!>8c}G@RLd&VUkGuf;lJ;LGhd@Ab;%RCpcLUBf+X; zr7<{0rgH8rIoSmQ&MV^nE#kyV17uC-S z2E7L-PG?q#fB*694>+pyzBrG`1`e^96W~Kms8F10?pWg@>@f{y>kk_rTRh0N@*I!S@>IV7kf2q6*G!q*(<&cHEwrQQ?OpgtNq< z6&kBce=zjSZF_AJJq%$O0VE6Km*P?KbGjV8Y&_ZPG$c`#xOgAK05Daym48TjpJ!d9 zHxYbv4{+SbouiDf6l5aV0%99g)ivbI;CNEUsO|@+5w=QectW6<#>d6ER7;TY)5d+* zDWxIdy{!gib@3$0026;@8kzOT-w$g%Af4O6e{t=Z@3I|TqgLLW3m3|)Esj3$T!5{r zZ3ZW?+DFFd+T*&~r_ZV8l#-#N>xO1yGLUMnVApUlemIJN&>bLBZdAlJt~Ozvjqn87 zcaUon4b7WS3d-gU&aRw@_<_$6h05C)VE4*(SOA!F?UFh@Ub`1kYA;?-rUK$vSyG~) zf9L`V!S6U*f|A%8lzxv#mqeb`UT&B z&ue5X6s&_#gcl0f(q^V9my8e!_y#nne{ev!!x<975c)d1j!I6*EUuWM%t5kaU?>M0 ze|AuimGDnJ=BTMRsI+8V6T`9PHYs@WHdh%k!i|3|YZE8nt&tc2NHooB=y5fUKuUw* z{f`TFP>M?85oz5A_oIc5kvI!#baUF!%`iY2wq#5PN;)h9ID`hTn-)vFpgWHoJ3d<*vjZ{yUjps zy^+wz$D}BXjd#>P%E&`@zmJ-Tom#?;2{R)l@0x_F#|EI~7!k)8!~s4x!3dRvvPOnE zphnJ0dDM;^bX8TkSj94q134kA7r7D`3rvRKuTJEEHN}2eK!q>g2pjN0 zahgMJzVLb_Jj`oxL@w-|Yw1OoUUfnN)1>Xq{x{iA?3dPILP+JFhXY!DRe}jxc2Ks#k(%>S8>Z7vZ1Egr;7-E(exjvxf9oB&gyAGP1mnVt z9ceujBp)=GPPHI_?Fv;`5eEl+FXM)^+!vPe%xgY1La&c#8% zTs@A&MRO|*&kPn9na^bpxU@@g+*ffjQI{Sekn0JUV9uEF-?^y28x1DbmcO9t-Fl6Z zs{^xH{cT8|BQ8|yGjG~v7;>MZmVBsu?t4FFNDoFss8eXt{UgU>x^7eNvr;ohWLa$~}EX;|e*U| zVyNrGQDEmW3o;e0L}Ep%W~Q;Sk;k!TrOrRza&?nNz0#p@*e4b~X;;acHy8HSkG1q8 z=PHRh*3HBh-i%B}@KlKCa!1n*p@(GfWE_T*qFu98kZ*%u8&W(jPo{As`P5|LX)IbQWxi>)QX_|M2Z~fo zegE63*Ay6@$7#Xj#@XN|W3Ga^8(PB6VafD*OdK38lpbkKi;a;oHHgZnLFhBna@3O` zapH*we}Ih)CC~fET6&M{EgWsqz$+gp4s)66Mb_mc4t$G+6+XPGb4H#}f{%IH$<&Ri}m9>>1OREif&64_l3e}0NEB#`C1KT+u|LWGCKdUeIor^)b; zA|$H4504mn)M<1|((gql@i*-+LvcW@?#onMsaowG$KEX`PS3*FxyrA6U<>P%V*ifp z_vETf8aer64ZX(w<%x9m|PmeA%-6Z!Z}kNe?}Xq!8#iwhPIku{zy}>N~xPYcg7wYktcaN8TLn~ zOR9&YGJF~)zO-ZaMQrOf4)u!j7Q`}$j?Sn&DOfMD1Zh}~dfE%Q7&={J(j3pUJCP7tc+&#rTdN77Tav{o~i?qCAjs0Df4R(bPy&r&&4k9%Ax@sN;5|=c)cuG5u%EJqZVMkx^YulW z!jG0s!hWGsgNMmAeaP{tJDrs3u!D>ONK_t#X>8thAlD&;X$Et}wJ?QbTQHGPx|~){ zhOm2@>GTKH!B%g6xWI6$`|uefy6+pT*uLT~bLI8c+i#E*=7DaF;b~_Fqvx*67VBZe5V*96@2vgnyQzBxO^J^Q2_A`Gai024i$Ns z2-I=_FXqI3cb$B@e+srPdGr{e;{7-_fkF#ruy_)lrMF1HY!j7lMx~hArJ|p!lUQIt z8-M0UR|+4x7+@*5;GAe!H(+9^&h#~E!{)Jcn$epdFHq4PtxSBEVg?Vge(CcR|Eog4 zU{H=nq*UKjB4I?vL4Lw(qrsOav_AFdXEj~~-)cLV*k~rsf8~g?UenAj~ah@(ldQr3{8tQgiGsiSeBHf8>rj+`gd7Ludko@;Qhx1fCLN zpmabtCeqDeVO+4;1y8VchZyyy-f0qwW6yL(v7?*Yf}i}&*sCOetk6W9~`W%2Ow=JP`U-rRhkMZVg9Ew0~B?R>!t zf6f1WdpEzoCje;e#V3MzPJdinUtWEFPq0kwJ6hrT=D}Vq=w$TR!_CxSH+|Nx4q#~g zPxHIWkM!g0-QsFN_`+wkJ}e%tX$!{POd!Afd^Ni>x1aBBZ|>(8R!~Tb5W?>k_y4kV z0!8e9ex8Me2)ne#r`h%89D5~aHgrumf3E#{^BF3F&VBWMfD|BVZr{&8%r74nzt5+5 zlD4`3{AsTEzJH)a&Ft#RUe7NH-r3z(dq2PXeR0WnxSQY37I(nX<;~q4R=K$rGWzL4 zipxX78vV-l)ZX9DFBkX+{hjEM2;fRkb$w4~#nsX;bP+qFJH`qiPPs?( znHT{Cc;{A0~@Rx-GbfC@Hg-@3pjpFJc}M+unZq8@oS~VAD+CENfWA?rL`GB);IM=dAlM+m%0M3)@tQ>z_a;zwc+f zCFg(DayyYOy=)4%e?|r+3&V*tKz{M7P9^eI*4gE`{U@f={YpFV618vN`&IUR(C@YS zvW>xY{}R48KDgwf^ZuZw9HejPct-I>D>-Wi{)IODoVMYo-ipuubT;Aa$8(snhr zya>6c3@;lEuX`t+AXa$E5BDhyag+VjDC8qjx(=1i!^*nT3+r6DWENS(rMQDc?5KQj z_Me-s+qJ)Z_ucdJ^TlJ;U)0UxcfQ`^yI%>S8EW^?b(79E!4we@o*V#|Z;$iPdj$HL zy298fd@Ll}f1z}R4wq`mUFwKxnRS^)Tc%#j`LC^HKuFUWWm5i*E1!znfiW4jD5SDzo|S6@?C<}F{U-ly&MM4|teKl%Rr z>LM;TX6UFpSeUyK`$%MRz~8)ruyg2&4xxm%>2|AEe<>h@e1w)Z`yJwqoG-NDGlU*K zh9SJI1n56kpSC&=C&Hcxcv^e2W=kYwwxiJWTbnIk0Y+JP$M&tN_uoD*;`n3zjspYK zbFjfq$YLV8Sk`|`LgA!>%*Cdtwd7qLF?PL2NrMKg<7W{3C;eP=&P82ta7l8=_trS= zg%L22at^XFVD zvBMW+O$ho(ty?-SjKoBGK{7jR7r#vH|IjAg5{YEaP$JgU$YeVGu-9JO?PTyTcXonF z85<&?xwc3kK`2`~x#NzSEb256sb9^}#eGCeTNvrtS0g-YfdM|=?JHM+kSi2|HK*cx zs1tHoek5Omp*q}igZg1^$U+g#pWMasX8)S7{JMPHl^2_CThitHKTt~p1QY-O00;mu zNvKp;KT8GC0{{Rw2LJ#rlR*I{e@sb3MNU&iE>u`lg;c?A<2DdITVFBADFFnhO%DaO zMFGX8W1_NTNOIB~Wr?=9D~kq6#p}QCBPGY#6m3s7N5ePo&Aj2W(A%;l_Wh`ZF;aCV zn5pAg%Y9?%c6LV(KRrB9Cab2@H9cxo3oWZ}K~OZ(&{3rxQj0Hi zRy|c^M_SamsHRHEqvgX=rf#sRn(q8XP|0(#Yf2$_hdCW!~A)^5rgq>vD(pFG!#IA3{0Gaf{i)FegC`w-G zCCaiWDPDg=rfn3yiZ?Of$iuOffQ1-ccJ>U;!HQ+GCGw+39`oWAv}wVMgylIc(u^Wn zM_IvVn>fm7y~);T&Zb1UaD+tgAMM=vaiD9pu%&Dbq`qQ!29(;Gf12`5V2G8FZy;1s z1#|rWjDoUN-QEjB=CyBN#COyw8U+(Wur_*%b^;4zy_w9gS?*9N0@=f2# z7Cq@IrH@KuDuzxbF#bH{ zdfg)h_JtOS4&JfC>ta1jpY#;-#rSz7j@HG; z{R!<-_+@rM#9I@1w%i`A-mh~tfJ2j&1()pDht-h~QiYZy!&X>Z;LkNjzOt>BiaR_* z&{B)vRs`C2zNg2CIAYILBo-LVB4FVvv&fg-#fPoMTBRz^9AfvpcMW`i>oyYnbw;g2 zJwip5t8!=sz@JA{TY-M$leB@ONh-zwVJr}Q{``21b@z?*x2N@T%`Or=B!=chk|gGj zf+EcPH6Ht@vx$g1YHIAIo2v01(M9$=NcVp1!2TnzYW$Vb-81kLIlMfq==;_tRx(OGHpxZ?N2jOH9B49{#jLA)_Ev1IL` z8gdyhM4hkMB(7eY%&YZtLPFRHL8AwId!{hKjRYf*UqRPq2=Bkc^`VP?s(__YBUB@F zC3GPwBqS2Er=!SXj7A=_M5xOsOb@b8HAYaHPm2}Z%ZzR2%i+R~$#%t#i3uV--3*@H z9qS_n6M{$aQ}vRQ^|nfeU1BOx$5`GhY4xE}=>+!4hg0!jl1M)ONI-_NXblfda`C*6 zyckxDW}IM=n`4z#ocO4y%o-nbm=KjPIX21?m9W4J?dUgwWPMS~gxDgw$a4&#k|U5y zzY^I0=ilUB-|*$a&1!`J21Zc=@{Fkn`lSDvbkIE~BPYk-7?wp0+b>2UI=PkxNv&=V zQAvmbyNE)S0#&@I0ggXgiZ_tf(@IOIKD5Sg0AnignD67UOKv>r59e*5Gxia6G>*t+ z*)Fx_u#E5lv*xqxAL0X2=a_xCbrmn` z%=@9m(TtilyIaH1qVf#W;!IY{a{vA=+p6^P-vkeudj;F}Gk5|ummOuB7!69A2;M?X zfQ>B&BW+T5BK@NLW%w!`w;# z$sAcf*<4P4&YVHN!Q5K^T8D#?h4M}9wi#GN{L*}ewX-G75-Rtu(ASdzu#En-CBbrd zs!VTHnKyC#{MLCHBu%M5G_Q}cB>$j=qv8>mh6Zs^X;Mlh3r#vPM@$AC=k41T+`$o1 zw-1vOZb_(I5iS9^eQmI9r8k#o9yYz-f!L-DM7xpRJz*{>V?YL#846UdTIw;t)LPa zC+d*texH6zI{*3s=m99jV33O-U7y=wu&7D9c->k1i>CR|;;=Z3bmi;z<_9q~R_@sETUoc~kfe6x<+(2Vskk;2vSNMbrW1 zH0ZdW7mImtUrRl9k@9j1%5S{Gl98(baPD=YQyTpJQXS&tfvs$Z0di9P4e@)0u3z6> z^CnkvG01EohItRyN+Q73AKWNHgt7PTgqrNFjuwV-tOR59o3}J<874z_^6D3Jn&ad5 zdg{8GQ9cH5?;1g+UrcAjsfJQJ>vsM$aVdv{9@JB)=6@8kSjoSy>QTI__b_+#={Iu8 z!4UDbKecate~{wuQ)Ky8JZ3hlS1#XaM8vEyg~CZp#KLMiIJctCO2`{V;Nrb(xMtJ4 zXSiQ(c@tyRMn}l4^BWt;L}j>|Iw!=cChjGXACoAw1vmmhcWz*x>ED?B1646>?T%c{ zr?n9V(`8FMH@xAsFA&)6g-F-3@ z&eZYD%Z(!oJ<9cqL!uX@Zqy9Z;DLf@Msy0^e@PMw#yB;EiZT)yOPFr~0(XzH8!*0Kcx^?IZo-U-0WqU#&Uyw9zQJBZ~ zO%lDcPKceZ0m+n??t-ofqVwzQ@vk*I2XZGijf~>EMTVsAv61?q-jm42)P8c@mNa(? zO%X%dLiO@uzqb!3KmRmBd^yJEMrL83F~B^l`~nBkT8tD2?R46(#s zOwfe{ga2?S#+$mJLK560?igXSdvZ~~w3!|`fbZVRVTUOAp_p^xTq}89dBi2@g6pJ_ z)n|qO@@#5GaOw??&=p6f2wT`@wvy(01)I^~G+c z@a_d6kvr6;sqwzbhgM)4Nn^2;q+jFeTJZA-=rn3Xu{gN3TlBD#C@%UL& z=}8Qy#*zJC*Od~-tDvS&nkp~Rnc04KTp{uhaBjceMzcE?zJ>*+Ec8bxpRBv(0Gn*q0 zt~KLMY;2n$0R^Si!3^aiBt(9Wzo;;rNR(Bc+@v{ID0{kY!`!WGjxgC*#_g9(H}m4g;w@&@9kxrntfU z?lGC#uFIcIV+4vU8(|x3b5s@FggpwjgU7rk<1YwGPKkrFtt2uRuclGH+ki~0^~4e{ zP3Q}1m8Ia!3#zKagPqK;%DSR*T1$TT*>?Vz6*ZuXmMb7YOJXUGR8@p%a7f(CrCtYd zjwg{uK8u3+Tg~es&|_llX?@8o4h*T^A7tC7f^jPnW)u=HJ*ky`ISciVnnpL|k7L~# zgl`BuYHcor7#VGb;H<9Ei-Bk|N4Uf6X0|IxsuWGI#*hurX-j*&+*4a7fIXUT! z`$jprx#|4;0RcTI3KO~Qi(1&`>|K2Pg3bXxkGqoKbTUv-=cxx-6YPGD9c>Ha%~m1yt}8UQ2_aQ_)YwTT%?vJiI!Opg-AlD|#L-AS7kl+2$vFQUgg&*RH zxb;}C$MILTq`rew3=q&2KWSi}FgOvHqropsk^Tai(~7=?&M-ZL5X65dA|fcvWtSu9 zU_x{!tzOcD=)p!>R+z3Rahb(H_clMhhzhG)plbX!7c1h3VuQt? z3)UU11=tmb2yu&%r}E+3>Y9jG8iTs{O|FW#b`@l%h6qtc)knV*&9Rp(#oYKa8iJE2 zX`TA*{BMWstv3?1199hrc&CYhVsJ)SibqP7rL~p9EG^9`b~U?>M@lE?p9N8cM-TEV zN&}-b!lGDcib2Fy=swi&uG2S4lkoU<24c|sXF7)Lg`XpJqq60vE#6@6234FURpf+w zv8v-ufv>9@n2CYN1D^(Hfm7A37A4?F-4$Vuh}Fe#x)ZgmNO;Cr!C3}hjD8l3VHiRU zv;YK+lebSHu$>plw7!XK38Q*+csU%zzNtC2Ga~{LJ|MiLc0KUcMAA|4&d5(|T}=tM zn>6`Dg<#qRt~h@o#Bb%*5Q1E0Xa!C9!OobB;>vVn7LVJLh3f$61wbTKpP}{E zL8Aw&;?0WO8!FZJ*3reKupf^1DJz%y}d~aKB{_5y$;T&|)tR>+AIM!Mvn)|6 z2rCLxDR_(|l?=;R472H8a$Gv=*6FAE1(T-H`hv`d>4%YZFVk7P!#^-9{JzAFh=mZC zM-3}{a!JZgqJ6NAo*lAr38(J-(jjI@0|~s|0sBUEptimR3n~}}t%?mPCAxxr-?+@| zsuRYCuA=f|v|=4*Bm#D+&PrjF$-Q%M|IAQYyGMWA| z@gQ?v29z(I@%t7*Bt?J^hJ08t%<@?ycGFXAEh*9Mt1e|9AT7mj1qQ5`TU>+Cemr73 z{j9q*C2ENC9_M1-`yspzzfdh!{442FoCtSVFMhg~=$cqr`?w#?*Ya`C*K!sRlefh( z^%-2od3jw4i8Ym+|Ia00|1xI~+J(qN?Fb zdl#p*FgLYfa4hbHs0R68LX-Cz21G*zJX>3KzBQ%DWJ@KZoBc>{_wx?9liuCdc%Wz_ z)U|vPZ9sj5e*f+rCUR71mEOqSXbKYY;{srxa;;ndlQ6)5YV5#+eL@1=BNmt#h0W=f zIla~&_+ezXQ^@BdUs1^L)aiJoH{BMP;Wn0y%=SoX3Vsh3a}4t?1{uOi^E(EKwH}Qd zVj{!?Tq1xfdHOt*FHy#(k0Mzkr9M=*K~+5W;wt$8tn?W0e32x@pS0)0#zB&w$bkw& zH5uOF_koiG>WL~;009XjCRsT}$-dGodjvT)v6m3@9men~qQi@4Cu;hr{kfp{L^JXm zD=FML$ymp+67jZaF$bn*u}@jQcySB<*sAOIf7;HWAu#YSOC(}2#*CZ$Sp0=es}OyiheOe;%p1QnpFn(ksBuAn?_ zeifwb>h6LKWQ&^JZZpLE8~1|zNkiF1&|4%)X+;-DmkBd~C(0eSYOj3K_~o1CRzK~w z@9yW=cuWELV;@8=H!f&dZuC`$9)SMNUcHAjsarhwzB{`aGTzlthYz+~zA|~;j_eV zgR6S2IHfW**On1QSFCD%^o^Sb#GA=pgm!&ck^>6OY?`c z!btVWf!SOXt@)tWMnyySZn)H@u~w?8q-kJHNkdrg*mE}kq7RxoGjdK#9t$}LH!zGdoj2Y8;owTj5G(hM?u(Yrw_+ZEcp8EL zdN(nd8^puW^1X)GpDt->aSzAhay4@&m;Tkel^F|f{JuZ1_bZ1$lH^t$J$Er%VBh8w z=}>4VxxoTso+ik7?WjeEoRA#IKS-jtg}Jan);&y#0YwByC__23`BxVfSxllAZsCpx zg?6h@c&!ZwsmqA%%)6)aWcc63}|aJ z0yRMN{d*iscM;^9snBn+2dC)A!%@2a4OoWiGDPH?pOYo(SChu8-G8J8mf2~-H{47? zk0)i8IYEXS>iW+&4U5o9q^m>Et>>*x?U;m{8r(hCH9U(t+v?;){lsWgUabzVx9=01 zg(##{k*Ej+8!y&;W7eqYjMpek%E5j@xS2s+)*-Q6Kh~^9eQa{;vV+;EYh?L~v_ATP!;sR#*X%$z1!eQ(j zI_VDE1^FlCX{m>N*G}a=_<(kj$q>Fuq zub!CNp>8em&Ezq+Em$>Vi+L_Iq*!aX&M4m6{SqsI8BNq^kDl+MIogi5g%sT*56QkY z6dSO8KJTGe<`p!yhH*`8KYy1PeQ0;Ba4rc_QjQInidQW?eK8di*Y&d&rNx3WAK#ua zTIu3a2MvJoBmDtV_Uej#l4QOo0g}IrR<@RF1fM_%c^*IICEERT0zKQ`dbNTz0fhQ7 zT8I0oV5vp}WsCJeb)v0&gP9^3wb)0l$>xlA;h4-8B?oKex$BbRUO12BBjxgG)&U@q zcLe)uJsdNcpG5hoQNWGdha;p95@BCTI`KI|2RXknc(A#dm0(Dt*^IxXJ{FW83+!X^ z<-BC1+{*T-?}Pe3<+}h^;zC%^tuJ7kWl%#$8#EUn&uKJIT?RhT&@V^QUT>s1siW)j zeQnd)*dwRJ=uP-;Mmpz4LaMJgS_eRa9ANZ8GGuMB`N)qcy=|v0FQq*qd^)?56?uiu zg~#)qz+iSwE##2h(#0Nx@FCo1)u@PnzrSPtaUUOQLv5da6ImIUMxv+#-A~WEah$ z@5GmmgYcxNxj3~m^@TrZGr4IK3ZV1jl*RyC0>7@!-Qu&oX>*D5eSZKlF4ftBk2_KW zI7X&y&H+{my~w4>Y6tz0_M?onHq!{}AXdc_ z?k2i5`m;g5PTsE1h74Y|62S;QvmHGlEr`1g)z}6sg4<1a$emQDn!sqp0wl4$Agfli z&@txf+?<@<+cZHFAO%Pf+n%Hw2Uh?5A zDMIku@WmB9J-wjsN7HpM3caa~`bxH`ff!En2>zdC99}gJcD9(&ges==^RflAaocp> zzA&5sNwPJksKzE~3sq3MUS+i&-DQ&tHGvyA6WwtKF?jV+=0)IQ~@vm^I6(_qK#}%_Pyv7CmJsweC zK1JM^1smbO|0H&`Oa8-b`h54*&+#o0otM7oD#dsG?qk>V)t=on4sQ~OQSWYfx*r*2 z<9n!JlULZ6Cv-Z{#`oP@pf@5!F#S9MwJUD;oyp~3`fC5KGVl)@9Vlqn$mCK&F(7n! z!{jm{{ZYNWMjCr`x?3K@w`UTuF1*<07r4yA)t0C7CwRXB_1jU-c4>ZTco}Wp_+*1Y zN0F0+0HMN_!Lm7TQL7gTVY5gUI;g=7{a0eDJx>+hb+zN(M9&S=rb8YNGjd~ z1|kev7kW%0X<=mK-i%ma@HO&9_wRaWs?ejxfQpN)-e@V%EVFc9t+>n|ti0Qx%Ds@L zw0q-5RcR{+t_h;#{xa$~aW?L>!ug@XQMEoQh;@Y4>YV?2?qEZ zf7QUjz$Bo+z=*vDLf%2n=;=UO4(cm>n9rv~FA?ykbib8MB_6g;IeXppp*U57&q_TsR+;XDLnv&RH+A}(PqQeEVb-Fc;xs{^UZ%Jf zFwqtTc_tmUau-f9==(m@BI=ZfF8<5}Zyp;#g;4#-g!Et)R|)%TT`b5{wbl!;WDsekO*LmPA-vVYT3SS#xT-_H>$Z`((sS|xX;-gd$W~I5ZhZ? zK`a52$m35)Io+*;ua*uHj%BoK=rH%5X3+Y*W!9}x`tW&J-DhOez}H{krjskz^y~0A zWP0hi@hlFGD>>H%X@TG!yRd)jc_(!@!)pdOmm02!EllA!GG~?O?pCi%T9G?oQI?&#q;1VlYW9W1Ug3KbbiK9p0u%JbUr)PNqqq z|9(N--=y4^pHEg3ARdj%;0ik@w_-3iFts>-CQ`;#C%xfnVg5wu>uRg1x7T$`?q25Q zAX^tgtxL2`^oi9DJA`s3-N!C-n13!vlq)x%oRmG*^tTSl;1r(Mc@RK6Cx@KOC^mt* z9@urToYL2cZoA(GDza;**PFdXH@d4&J6`RuYZ)@OPq(>l-u%|iYFQemGw7Q628Z$> zlWI@1fki62hGkH8@{%`sd4zO6j!m|nSCCgm5_XxzAv?e5x>Xns{8F>;qD0S-zDEysBfXXGxM!7dyhmhW+ zw16AfPD#yWw9T#{D(S0&Fk4_+qlP8gFAt3NIErI0(iz_j9xc7K6J95o5|Uv^%5{0aUX@=SV{ zy-ORjF1zGBsHe7OL-W4c{+mh|PyG(o*ve>sdTi_#kmKmKZ$l}NDMK#CSc*WEey8A@ zUU=_(zuv_NT>BU8o7IzSk|lqcoObOn8>=8ZGk}c(P7gWhGyF!*dXH#?Q}D``gC9u* z>>odp>HGZ$R=)?`p_abPw!vt55~|S~E+$*rndQ4&7lw{PZIQ3Vd!n*@o%9DZ zj+~R3Ah)*moYlGAg3sx&lzSS2WXp%vP3ARra!6j2ZiPM2xlrz(l}z-bnFx%vR#Q`U zGuRFo@&a{~OusIxa!v{rOqCu|-l!in3@9m!^FD7k4Q>;hDyH z@!>9OqjM)n&&&eh<}^}n1_kV{%FZy#JT3)iB%y}l^99WqET6f0g|X7=>g6|mV6aZK zmqg_=zBp%x|RAG1BV*K5=LGBpsvHo&#e1m=ESg&zj zjMpah|6Lpzql<;JyN!#5>tBf+ccR(kSlNch6cYBBhO0N<{4JC!Z4a?zvP1t%k2?cm zU?(gLOu<{o29rD}PJP938;I$D`_0@XENrkWOAE?ciPFB@JXA~HOb|yKAVGQ|&?o#26*gujU(gt}Z z$O)Q%x}*dP>9}-(+H~1Yf6Ni%kG}X)4%_)$T``7bLj34KOcQt^*?K)ZLrob)+{9C4 z(>ac_B%A=P)*`g$wI~F;({%KD=W^BYbbRM~jLrKjI{q&*ZsAu9d|}Qe z6`6G;($Lq>?Y~!3kQgRpnw}hD42vlAuRNmvn+X!kzo<$7Rq=Xn3fd9*uNJ`H*h-Lb zHl{Z)lK*`KA!o;>_!r6HA9@u2ANVsnFU3E(0n{|G~jIEel;%Kz*X21fE9KxFg(OoyBq09ofiLdS-|h8abGfnl)x3-y1d CEc0pr delta 10702 zcmZX41#BI#vSp}YW@hdUGc$7DC<{%2; znuc4_d};VOMdk6s5+g!*TyO??8<>^U=@a;a$ivWsjJr8l0x6ZQYRq}_b_hcNq|rg9 z;al0VZ8vtjGC!7lxD~eZ(BP{$Ts4r;ic{q}>pBdsrdZh)-JD!@xmcNkxL&5}AltlQ znUo&1nQLZM5`4+VqhyjS+C!`883Dd*9#!z6JGk3q;V3ln)!yUb=d{|q9sg&nZ zfxQkL^rLK6g1pd5an{84N7qxq3p0=LNTe&a)EVgWndw#T@G{$i9ZXPQAQg5+Vva@A z$1fqwX_;M*vH(Z6Mj>$#^>Tz zC<;6bE!sj!S~gZf;kpeLrNk?GvSW*{nKK8&U=uUr250a$w~PpLM8D&4&lr@SeuHxYWIM&ny{h{%kkW8^U9TvLBON zPMVx$pIKjDFPFDiE@O*1?0`$3zwn6%xEC*^|L&OXc{{1JVD1<1#sN=6ixkGbb8Ixh zR>DQ+>edhJW}5g8`DE03NH%NredU_sX}oa%eUBOVZC&v#)obf{Q*D+T6M z!zFpWV~r;zLxD+}z=Su~fi#S_Sb~#@fI2qhB&=Zw>CBA*085n&DBIL`#2}Qj7&Q!8fWI9FZc;i9xc# z{YFNQB61LGX^A_S8{RmVHcK-&TIsMYe(67i8=zYCrPrbGEhCz^>|Y+GRGOGoTDxoHSN6$&9GUfTH6 zWRbDk_x<%K0S@sKNk&)bTM-%85&aIDB=!EIc_J#~QcU2s5G*k>g?7_amZM+{3d(m? z<*&LGc+&EtUChxcQGsB-UftqJ zC^6b~uHt!J-E{F_x-j%0M7*>E9nP#~Jg09Q@U(EGg{|qZVJnO~)MS6)WP4mlG?S2( z&>f3XPOE=kcqSW=&zm$j)j5d38onXiG|SEbakk4Kw+$O7SMkYRlvCAJMxfdidas!l z`-3PwAk9hys1B69o8ru&m*Fd3!q`RE8)p1;mGoR^j4H*xPuxd?*dUgD(87PxFOMiO z09q!5qc)lIVz&iIg3i-%>DjG~6mUzrB?uQVkIU@Tas526UW{O8Ij5%}Fh(}+ehhr{ zvg@apki^Em2EA{{YuhibF%3Cx6^PA;)YoAr@r!4#7ckn< zMy)VE1>#NT9c2fEZzlG;YoP|=<>{&b2i=__0ElI9C$;jKCWlGsTaO1@b)V~bo3G$# z4%yifBwMk8pE(x6f_M+mVxLFJu}RW*kye)^-LASqwG|g23XUIWLlQD`87|oiwzEu0 zQm1O8Hl7QcYOx_5M09VkR(V>mfy#~TEIj$7{0>W_JFZRcb=@wj9O<{id|G*tkGj!| z?7kTigL)V421}*+3{eRmJ%tJZ-3^{b(GeR3#R@yjQMIzQvqnZ{a&?^}cPQ$^-zAfN zCVYdN5Pir5ndcMwYHb}m|5W0Sl6nWZ&=y4Y<0FX4BWJU z9D4C5kj#ZoKf7elrFL(bo=nAw9PAO|J}~djB=uIEgL_4s2gb{tH?ck9k-9R~8L>=F z6b>G|p)mhKhot@Ed~tA? z-ECJK6fWvkGUbuo!e|`}&&|BAb}hXNO=4sgNJdIUv1Sa>0%(E#iKhx)6^VhTk+LH& znSg8Qm^o}@>r$>j{<|`r))TH~PA{5o-c|9Zq+TN#;ZdVTH4m7ZB_v~AWNtmBVa3Rr zV6%1gy;Gw>MTVLd{mMlfS}T^YVI-!o-iFE~=-f7>y$=QuQB7Z}Y&si!js=0apw)eM zb2iDcQqNItG$##rY3brou>-iSHRHXd(0XX156Clv*i@M`rdZ25FaZ%Uvd&k_A7}ZhWoU96q;KC-bZFq40-8em?jL zN_X(iR>OTl*_EE}qm^8)__T{J8!grlmW1Fn-baNp#;rSVd>)UL?Sc!rOJ~M2B~Mm# za+4^>;xo3Oj4N7$6(fh52#_O1H?U@F;t)5y!2O%j6s>aA9WF!mTL5lk&9R zs{x~#WQCy8)@eS3nqazSd4HrIU_evvJV7ok*)Yfkrx|H&SZijgGiPP{=9YKT2!DTQ zS@oytsCXXF*kFkVxy|W2H~x~fQKA1nuc=eJ<5P=;Vf*+yhel694mTUY)>*$7C?=*a z&XHx*PXHeb&Y$jkonKJn6`0LC23#_XJ*1uHViyM;bJ?Q~Fja25DF&Z%Kd=C8ic$icQBnan?@&!du1qTQ2oIlLVE&`^qt zi);0y#4%8)D(3sRXdegt>725vHy^{$$J@*rZ0_@Wr6c9+SN@Rbqd2pV@}q07?&yKZ zXA@VZwu7ZJAAr0{;s(Ujdv9i|ivZ*Brfn49j}}VK;HUV5PF^crU~6Cp2n9+BTZNF} zpmDrP`xgmrL$!^o%MvLBsIe7geq(kSstWu3p?ZD@(YCS7f!_ahLd^g^Fl5?@=kB+C zn@2Rj_GbXpsnh2+OTYRj5jRl;9Y`-ra22~$Je-AiogX0i3^=v5qBP%vMM0X4jIA%( zBr5OE*x)Btb@N^caHA{&nKV4c^v7h2Z6WpT&Gg68V2km$m#h~vR_4-erc)Tlxk|Q5 z9NZ0^sjXxZ(W}7EyzOZbaE}hM>%8LJ7e~L)}0T`xn+~9{1Qcixb zqVMzU>W479jm1*btp=qSO>rbD?(@cK!jlyk@u6LfK0l)Nwt4K;#R8rvsGf$rE_hVf z3jElcBfT|{=jcf6`WfN`@G}QCJdlIh1{`|#?ee#cl^}RSJkUEFY5(u4EyF>o|f@rOz-j0oZSvq55jI#s4xnL zm_4eGf^y)I_l_hDeyQk>oY+US2{0o|Vsut%Z-s{>4xznA8zU-40UZ>%_B(4Zv0*r> zJl_k?rGXBjGvzIXICY~!CauQnT~5bLkk zP)n+?lnFhE!o`DibOLg`QFiN@dz@&a61*zq?L5{Y6ei975_|1PJ+`=0x117xX1{cg zRug;7iI6{#*qi1R2BwnA>P)yUU3jk*6MinWPUxM1ac5<-9z474nj4EwDN;AqF4VA- zv9r1Ackv=Fc@#Zp+l6W%&YpYAjg^D&C_U^ZK`lf0V&lEKUB z&_U}VNm^8pahLgmq_MooXvXb(cC^kDE6vcRyv)la?#9m5wMVwXX08j~v)>#oRRERr z?q`CyI;@3CnVP+4E?uI&xDIG)ZeQkJ_=N=$-w474hLmvu44n>&$vkI;Vco1Lyl{yrp75a|VPp?S5o>326J%+`Q6PdG zgRE@z)tp(|kOs6lc7W|y6KFJmunCnI8bKHmx!>^!lv;|}-XR_V{-Dy68TAmRMM}{L zHYK$MO-U*Ci16LW;E2TmFlBJ$6iaPmr*3RgiEdJ+36iH6*9;m35~UD~0_;C8Ojxjg ztGSbRwrsxlvW%H<{9o8P6;L1 z$MQnJ6_oe+Hm3LA$MUy73zdL;ZkwyCe1y`%%97(zvdGxp4v+4euji|e8y^9n_03$B ztxGu}!>>6!g|wd~w$E~XhddHwQ!wHx2H(n5m1*;>L)88R$}*Ew4#KlMEzs+57=$6{ zbS9KhBgho6*Iy--6;&LIwr9|pRrrPo7IfBV4P^A!pDLk!`OH_WpN$2I2o&h40qR4k z=)QaBF)I@R5H(yvvdXe+&dM%8v}dT#^1w1)J=~fLz**G={aHl}resA2LPup`$jnJj zf6mE9|HesofA`5pzn@A^t#jUs^fub)p;gSqcd4(0e;>UKQcHaT@AAhtxw?nR$SI$$)hSf!;K{gkR-%PKL^XEj{m%{6rv++0S$E5U^QWtohg z)+bXj!+lgCiP7sbF4t|w3u|k-dCJ*i@7!UpGXJHk-9UE{bVx1Vy(8~vYu+G)>o3R5 zpV|^2L8;}zKB^q}o82G>i}{r5cRTsqL;<)Y4J)4hhd!VI-Yo|?_u2tkQu-0bk{pnR z1{R2Hja&(cgc0HiW-da6B;bmQ?Vlrpl9pq4R&5T?bEK|?S9y|h9Nc+I0S3n48Voa6 za8_$F=W;}WxK7O_QYevvR;UKHX!?m)Uk_qMo#8taVC5>xAuICSh_L(+JCr=>a(gP~ zxPRllo!X#1!Gxq3LWJNhUh;zZAZBV3+@im!&x!0+#uxzeyjAWFLmnIgKu*cWnC4mb zOs|)AL{K@KF@ZQZ>eD;7+?3G)!mV&BsG^@m{yDjz!8a)CSmVH_>sWWOCphVxpdaujJ@vpva=LjbAa+(*~}D~sl6i+En$eSl^p%EB(+@ambFmam}%8^fyTDc zb(FPm0ghf;wnzuzPNDMYV0A^kGym(WXAG&G&w_wzm~?Lk`Po&cA_FxYt;V=4e7v1{QRt4K3VNg?oNuwy(Y{; z8D#vtjH~T8TBBxr#@sBHuKa}p<+b${WYb^u$EW}vfxJpVaBSL$I9iVE>tRZO7AABc z4G94gv=te0xYPP)yHnI9m_T5jFKloUCM-S40WswvWR6oeVa?r zsof-KihEi<49DUIE;ri(BIn6v8?o1T`$(rRF2cUFzuOQNPx^-fLBI|TD^I~WXp3p% zkEP(xKb93njHV&nf8gQpnJBFa;tIw@Galv;&mm1S^0k%U!I^yB|Lj@JEOFGBM1=_! zLQytAtz77eKyQqk0HudI@~PZ{v(X#F$n47GFa>R{$_GjzNMHnOVo{JCAJd@XE$J6A zjTI0g-I>{ZW6N+9V9XJIG0&9Nfl|6UiyTx%^n9oQ;Mu4tm5D!~zQJ|j4{KuL6;Pr_ z6Os90)Vm%uub|UzE{^SC?J&vbW*Pt}r<52N6(@0=YbPfaCUdj((pVwJpO+U`X$=nU zQ%i74u@9)H6+M3rjU7Hutp7UTkroVEVWXTZN%4<;`|Z!p(wM2d7K025U(Yh(C*+rq-gKDzCs!N=bkj$>U!4##rrd!> zWfFt}hJx!dzMXf^$LZyVhoDkw!|N9uY??!y=w%$FA`x5mThXgti@+M*iZKACp%e!m z>^vo21#C+AeQqkky?2V~!u5mnBMx2Mn|C;Z$@VVMT~CL`T8VGC@N16hYE!IL%Z{3F zE+#r)Ocek=)j`|e$L*CUngO&NTa@~KQi$2ehR~i4q#HjXorLoe0_m5Cx#Au{F2U>P zcO28E2ruX5Rm}>x))wu>C2XW_NKM?~3rM>yFCuH-q6z?PkY&cvywp@fsrGSw)l}W# z$K5hYN2q|QMOk^f39RI_SiB-6iAn4A+28J*Wbl%cXpRyS>ZMc#Wre8eys7qg?=TYT zl~i*IdZ_7MsrId2Kr%8sq;#dncru>i$`yA!ymWLhUxo^%=Nb|U8Yr8NF@04?eZm%w zcwW#+eQ=%U?tr620c&6H`1fK&FVuM<+f3s!i(TTpF`aV@Zd;Eb7gPl64U>5!XTVp}%ZY>tg=4v!GtB|a$Kya;ZEJ@T*hS2d}&mD625g&c!*K_%u-``}` zjcX$1O}MRDK$0xsi8POil{JF96g%O8h729Z1yw=P&G8h!2nV1AWQ4h4T+qqiFI3^h1PX{v+r>+k6D6qP!Una{fH}fujihE;tl=uN96C+w0yf!bBgET<@Akp})^^|D;43u$n=M5+~iDzOu==*lyKocE*NtK45>d zRmhwbJ(#x8ApdD$8=q;@pU#b&HOA>@!BrzXEWKk8Rc#o@(``i9uMlbvtw*m6W7U^w zSn7*Giv;b0p?VVQq8S{2`29@nHVJy+HO_+!P(3iWcQXv?mx*((u+WHJuf^+uLta8% zy&wFtjI8_{l{?q|-HvF;2iCHrM@>1L>-FdAsBDSE&(dv;^reG692HGdv~HGM#HWo~ zBTPSpyC#|La%HTP*c0djlgpuy3v0IMrKN^at}(VuN|XR*^*~|n1F?>XF-sUlDI{2I zknm~x&;E0-Nv*FPl_oBiLJ(gza%~9_>n>D1G8cxa4m~7Arvfa|R9WB*#6kL8HJ`u{WBYPaOl?mHTAcH6r9;YzjJ(%3`?)<_t`{XPdit@ zy8rWsHtOS0M$r5N3Llv$4O0h4RO;XiakR3~Eg5jS58QT;fa(UEUDDr9zB;G#F{2d; z4W!1MG`s6v^qos=Be|Qzg_7|#Q!mYtU{n|6JEe{FZ5IlKw+`T~nxK);2L6x^0zKY2 zPhh13wG>+#Ji*U5F%LOGI=Kc9JW!r3fr0O8r(p0}oLV+jKV^$kV-u0lniOGnp%m=! z(jATPpPL_aeIq>vu0=O`gBOyFEF^Jr;isbHgG?8 z=W3^>#IPou(q+6aM?+;vv5eXfbC4uA-}ZOnG~a0h?0vt|ZceCWF%``c0976O>nN)9P4?#n_l-|1CNcA-d-{p!EKC zVO#lu(0P2O-x+G;Aad?87|4E>HJET3%BvN`95oJ9(d2%%Q2Ej{JnbcH-tHBWj%@N+ zXEH2AGw--2746_EY^~gnX1NNe*ulAKig)kSIniRULOWv4MPBRQuE|)65~=7)#eBha zc=JVZjQpiPz$S^Xu&Y)pxCZNx;Pl}sG29fOYkz#ukzGZVXHB3^0$QmI_{NikPz`MC zENyzb&gzlWeOxbGm3V;(GGtg;3}Q{1cIQgEu4pqb<7bcW%aDz05y6mLg;d4zmB6%? z!r$!aSP?LTUqC|tz@~J7k!AahQxokZ-acZB7cR{vysL|FnqpV2DZ$+ZWG8`mz7>aE zQK4gxTIfL+j1I3|U8Sw)*RSS?Sx|VFQ%Epr`cwJih!k>f#CG3u(R*!*+E^jA;73?vh{HCG1GR*XmnW7S7g} zSBsui@Bt`T3((Sp5Q>7hVWDB*Vd~xBQRz7@*6BqpHs$;f473_yKzl#vvc@Y#gyUxB z2}kXxkTBLNnhHx#RF5AM{eA4Yqn&Q{hY+N4muqppf#7z~<2~{g5K;vR^=xwhk9SSA zzOL~!{1*{_{53_RO+}P6ys^(gE44=u!=UW)iRW~Y1&AH(wh+$gpu5a}ntQ{c zcU6PK!&WP#42Rt=6W51~G-E7}1O;1SRar&z$t3ro-|!@imwPM0JJ`13U|+zpZ4KIyz2 z<7`VVQGHOsdHCq%-C;{`RX-{C7UiFuQxpDH6CP%cT@rz|HrdKpz17@> z-sxt{i#R=ywqMIa;_r?Ah&lKk^6RcGefgQLb9;qn1I^+E_k^6_@b~O4vjop^|<*2)_I(7Mv&TCaU&WF?c{#~YG1g<8N=HSH!p`eK`a^{y@P||m|bY)!_2u? zmlTMKufY6;oSOeon5F10b&K2j1|}OcRRt^M@O?ksA-b`S~~Xn~<0+yTXX} zT8|{HoBQ>;*h{w~g_KWHz^91!v-n8v;Zp{_0UThj#2{O@)AE;6cBa?B_v^Pkp6fZN zm`G~BFQ+BeYc(tvHLtrgjHC!8t$}bG*jEmyYrSSfiAtu<7>ORt&*aoSF`%(j7BrS~ z2csKxc|U^0TH_nOv^PO&P}mq3^D{N|rST1e{0CIxBg-=~_2$UlkF+-`YEbkTOxjzK zzLFRatM~1TPnOWPH{IFv;ED>fu(EW(SdkjiY*mKF7??^Txk8!vpTB|~61Sf37pp1A zlCyfLyylB6oSXV10?%7u#ee@n-9wJqi zRH6M%#%bJPXZ^J%=2m=b|In5-PkGv)C-nq7O~RO0B!hna+JJT2ca5bU-VHAO>g6>o z4^eo&H{Q@zJDQ7KXa1~R+@YIp;Q;uczSuAtv&?s`U@2-JRE*AzK9Gk|Am4!xE{3ba zhf?TOf@Z#u?M|q+u@4va)^)A}T=4jAtmFIUZWsw(xFJS32_Brn@TSz04Q*DyMxL>_ zpFC1p7~XdlWn|Elt1=Oj+sdZ|ea<~S@`kYjt#*QH1C*p35!Lb&t%}eZ-b6*IG-qb` zexn*dVxIeGp%--w$i_C%7Sy)RCnY(m$cp-HWB7C41+KvN3G~08*TBD@*JebbzDwX> zV9$_XU?P7dPb7&GwnTq1QVcSRl1kZ$at^D^h$EK}Z$z!D&`&df-sYEuVr^`8r)XaN zpA>d;&G_1^W<0SDhVAQt*sI9PL#PrTA3k9Qi38|F&_bgRvq!jsp%_Y(OR9)IsdIf8 zG@F!J!8kdiq0JKBQO41_fvOtG0OHlh3gc>)2|LY9}Ht3eM9c;2eEmmVX| zmJ-UZg`3&>NP4OJioortkm$Wy6d{!X$m0=_*R||&1x2ctx)dZ?EqnoPXf>9nIP?h- zbNs?A6g;KqNf2LEW}nIFfI?97xo>OYmt5JWmxS&mFB2++S%K6xY0Zvu8r6`Pk-1^V z+%?J;lyDkz__k_UbeyNJggdzQ4ODt=*&KYt6swVY#Mnh+1%a-k$pFQf4!Taz!snF+ zLsQ8Cgl@TwR(=f(@e=L*jr`$YOsUn=vCrP^^JwaAJZR!JeryQDoY?Yf*!2zmY+Qc- z!4j^{jR;JpS9)ra#W#*5IE&lEBIcv`yxc{a>BJ?8bUj~5vWdfK2SmJ_-9t2P& zvCPy4+59g_8Y|<}3I0t%B$AoQg6!h@?E9G!LoYp3+gH=vrK<9*l~I9n_9~fa=$46P zEFl-iI4g>#b#f-3pB5v?m=S9E3emRB8C(>Cu{0_PlEM}yLe~c_12y+U+~K7v?E&1+ z(aGkgmT&E0c?kfa3RPJO(&@0}g$482K!164)*r5oq|HO9%P9f5CLX^AK#AojtFu{p zT0mK`Q!C3XW^}RXgxQdwF18F`qwHP0I$DV07HYk&$w2OO#>*(z=k6SFE3SuXnwf%> zGKmSfVw4NRu&8}1PA&HuwU~ZlIO1*aoUJ0)IQ5%-yzZo~Td9_AG)A?L8Md=ghsAy5 z2A#7v6WU$>bUXhgLz#%Zf z{-Zxk_WHH|PDQH>@z1{x`ZaSNb=SumJw+sw{N>i4fr|b&&sCgqY}LDWB+V zMGWDI67NX-H?ahh*lUGJ`kxG1*WUxV{adB}*8h~|fWiO4VkD-C<0jTwBmQ6f|K_N` zz$E?y{@XVP9H9Qc*cgc!*5suB-<9xR*e05P*uNJ7O#Hv1j{Fan85so(1uWys-+914!2bbT;4(-6 diff --git a/setup.cfg b/setup.cfg index 0071b46..bf83e77 100644 --- a/setup.cfg +++ b/setup.cfg @@ -10,7 +10,6 @@ long_description_content_type = text/markdown classifiers = License :: OSI Approved :: GNU General Public License v3 (GPLv3) Programming Language :: Python - Programming Language :: Python :: 3.6 Programming Language :: Python :: 3.7 Programming Language :: Python :: 3.8 Programming Language :: Python :: 3.9 diff --git a/setup.py.old b/setup.py.old deleted file mode 100644 index 34d1196..0000000 --- a/setup.py.old +++ /dev/null @@ -1,38 +0,0 @@ -from pathlib import Path - -from setuptools import setup - -SCRIPT_ROOT = Path(__file__).parent -long_description = (SCRIPT_ROOT / "README.md").read_text() - -setup( - name="Verbex", - version="1.0.3", - description=( - "Make difficult regular expressions easy! Python fork based on of the awesome" - " VerbalExpressions repo - https://github.com/jehna/VerbalExpressions" - ), - long_description=long_description, - long_description_content_type="text/markdown", - author=( - "Victor Titor, Yan Wenjun, diogobeda, Mihai Ionut Vilcu, Peder Soholt, Sameer" - " Raghuram, Kharms, Richard Broderick" - ), - license="GPLv3", - url="https://github.com/rbroderi/Verbex", - test_suite="tests", - packages=["verbex"], - classifiers=[ - "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", - "Programming Language :: Python", - "Programming Language :: Python :: 3.6", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Topic :: Software Development :: Libraries", - "Topic :: Text Processing", - ], - include_package_data=True, -) diff --git a/verbex/GPLv3_LICENSE.txt b/verbex/GPLv3_LICENSE.txt new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/verbex/GPLv3_LICENSE.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/verbex/LICENSE.txt b/verbex/LICENSE.txt new file mode 100644 index 0000000..4b5ad82 --- /dev/null +++ b/verbex/LICENSE.txt @@ -0,0 +1,39 @@ +Verbal Expressions +Copyright (C) 2022 Richard Broderick + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + + This file incorporates work covered by the following copyright and + permission notice: + + The MIT License (MIT) + + Copyright (c) 2017 jehna + + Permission is hereby granted, free of charge, to any person obtaining a copy of + this software and associated documentation files (the "Software"), to deal in + the Software without restriction, including without limitation the rights to + use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of + the Software, and to permit persons to whom the Software is furnished to do so, + subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS + FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR + COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER + IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. From 82d23555912bb5b2e14cdea6d524d2c1a1c36563 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 17:23:55 -0400 Subject: [PATCH 51/85] added auto doc generate pre-commit hook --- .pre-commit-config.yaml | 16 + docs/index.html | 2 +- docs/search.js | 4 +- docs/verbex.html | 238 +++ docs/verbex/verbex.html | 3188 +++++++++++++++++++++------------------ requirements.in | 1 + requirements_dev.in | 1 + requirements_dev.txt | 10 + requirements_test.txt | 1 + setup.cfg | 2 +- verbex/__init__.py | 4 + 11 files changed, 1971 insertions(+), 1496 deletions(-) create mode 100644 docs/verbex.html diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index bbf2403..fdf4b5d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -11,8 +11,10 @@ repos: hooks: - id: trailing-whitespace types: [file, text] + exclude_types: [html, javascript] - id: end-of-file-fixer types: [file, text] + exclude_types: [html, javascript] - id: check-case-conflict - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.2.0 @@ -197,3 +199,17 @@ repos: - id: forbid-bidi-controls types: [file] types_or: [python, powershell, lua, jinja] + - repo: local + hooks: + - id: pdoc + name: "Generate Documentation" + description: 'Auto generating documentation with pdoc' + entry: pdoc + args: [verbex, -o, docs] + language: python + language_version: python3 + require_serial: true + types: [python] + pass_filenames: false + additional_dependencies: + - beartype diff --git a/docs/index.html b/docs/index.html index 0e34fd0..97569ec 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,6 +2,6 @@ - + diff --git a/docs/search.js b/docs/search.js index 8bdd7cb..87f83cf 100644 --- a/docs/search.js +++ b/docs/search.js @@ -1,6 +1,6 @@ window.pdocSearch = (function(){ /** elasticlunr - http://weixsong.github.io * Copyright (C) 2017 Oliver Nightingale * Copyright (C) 2017 Wei Song * MIT Licensed */!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u0&&t.push(e);for(var i in n)"docs"!==i&&"df"!==i&&this.expandToken(e+i,t,n[i]);return t},t.InvertedIndex.prototype.toJSON=function(){return{root:this.root}},t.Configuration=function(e,n){var e=e||"";if(void 0==n||null==n)throw new Error("fields should not be null");this.config={};var i;try{i=JSON.parse(e),this.buildUserConfig(i,n)}catch(o){t.utils.warn("user configuration parse failed, will use default configuration"),this.buildDefaultConfig(n)}},t.Configuration.prototype.buildDefaultConfig=function(e){this.reset(),e.forEach(function(e){this.config[e]={boost:1,bool:"OR",expand:!1}},this)},t.Configuration.prototype.buildUserConfig=function(e,n){var i="OR",o=!1;if(this.reset(),"bool"in e&&(i=e.bool||i),"expand"in e&&(o=e.expand||o),"fields"in e)for(var r in e.fields)if(n.indexOf(r)>-1){var s=e.fields[r],u=o;void 0!=s.expand&&(u=s.expand),this.config[r]={boost:s.boost||0===s.boost?s.boost:1,bool:s.bool||i,expand:u}}else t.utils.warn("field name in user configuration not found in index instance fields");else this.addAllFields2UserConfig(i,o,n)},t.Configuration.prototype.addAllFields2UserConfig=function(e,t,n){n.forEach(function(n){this.config[n]={boost:1,bool:e,expand:t}},this)},t.Configuration.prototype.get=function(){return this.config},t.Configuration.prototype.reset=function(){this.config={}},lunr.SortedSet=function(){this.length=0,this.elements=[]},lunr.SortedSet.load=function(e){var t=new this;return t.elements=e,t.length=e.length,t},lunr.SortedSet.prototype.add=function(){var e,t;for(e=0;e1;){if(r===e)return o;e>r&&(t=o),r>e&&(n=o),i=n-t,o=t+Math.floor(i/2),r=this.elements[o]}return r===e?o:-1},lunr.SortedSet.prototype.locationFor=function(e){for(var t=0,n=this.elements.length,i=n-t,o=t+Math.floor(i/2),r=this.elements[o];i>1;)e>r&&(t=o),r>e&&(n=o),i=n-t,o=t+Math.floor(i/2),r=this.elements[o];return r>e?o:e>r?o+1:void 0},lunr.SortedSet.prototype.intersect=function(e){for(var t=new lunr.SortedSet,n=0,i=0,o=this.length,r=e.length,s=this.elements,u=e.elements;;){if(n>o-1||i>r-1)break;s[n]!==u[i]?s[n]u[i]&&i++:(t.add(s[n]),n++,i++)}return t},lunr.SortedSet.prototype.clone=function(){var e=new lunr.SortedSet;return e.elements=this.toArray(),e.length=e.elements.length,e},lunr.SortedSet.prototype.union=function(e){var t,n,i;this.length>=e.length?(t=this,n=e):(t=e,n=this),i=t.clone();for(var o=0,r=n.toArray();oGenerate regular expressions from an easier fluent verbal form.

\n"}, {"fullname": "verbex.verbex.P", "modulename": "verbex.verbex", "qualname": "P", "type": "variable", "doc": "

\n", "default_value": " = ~P"}, {"fullname": "verbex.verbex.HasIter", "modulename": "verbex.verbex", "qualname": "HasIter", "type": "class", "doc": "

Workaround for mypy P.args.

\n", "bases": "typing.Protocol"}, {"fullname": "verbex.verbex.HasIter.__init__", "modulename": "verbex.verbex", "qualname": "HasIter.__init__", "type": "function", "doc": "

\n", "signature": "(self, *args, **kwargs)", "funcdef": "def"}, {"fullname": "verbex.verbex.HasItems", "modulename": "verbex.verbex", "qualname": "HasItems", "type": "class", "doc": "

Workaround for mypy P.kwargs.

\n", "bases": "typing.Protocol"}, {"fullname": "verbex.verbex.HasItems.__init__", "modulename": "verbex.verbex", "qualname": "HasItems.__init__", "type": "function", "doc": "

\n", "signature": "(self, *args, **kwargs)", "funcdef": "def"}, {"fullname": "verbex.verbex.HasItems.items", "modulename": "verbex.verbex", "qualname": "HasItems.items", "type": "function", "doc": "

Object has items method.

\n\n

Returns:\n The dict of items.

\n", "signature": "(self) -> tuple[str, typing.Any]", "funcdef": "def"}, {"fullname": "verbex.verbex.EscapedText", "modulename": "verbex.verbex", "qualname": "EscapedText", "type": "class", "doc": "

Text that has been escaped for regex.

\n\n

Arguments:\n str -- Extend the string class.

\n", "bases": "builtins.str"}, {"fullname": "verbex.verbex.EscapedText.__init__", "modulename": "verbex.verbex", "qualname": "EscapedText.__init__", "type": "function", "doc": "

Return a escaped regex string.

\n\n

Arguments:\n value -- the string to escape

\n\n

Returns:\n _description_

\n", "signature": "(cls, value: str)", "funcdef": "def"}, {"fullname": "verbex.verbex.re_escape", "modulename": "verbex.verbex", "qualname": "re_escape", "type": "function", "doc": "

Automatically escape any string parameters as EscapedText.

\n\n

Arguments:\n func -- The function to decorate.

\n\n

Returns:\n The decorated function.

\n", "signature": "(\n func: collections.abc.Callable[~P, ~R]\n) -> collections.abc.Callable[~P, ~R]", "funcdef": "def"}, {"fullname": "verbex.verbex.CharClass", "modulename": "verbex.verbex", "qualname": "CharClass", "type": "class", "doc": "

Enum of character classes in regex.

\n\n

Arguments:\n Enum -- Extends the Enum class.

\n", "bases": "enum.Enum"}, {"fullname": "verbex.verbex.CharClass.DIGIT", "modulename": "verbex.verbex", "qualname": "CharClass.DIGIT", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.UPPERCASE_LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.UPPERCASE_LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.LOWERCASE_LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.LOWERCASE_LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.WHITESPACE", "modulename": "verbex.verbex", "qualname": "CharClass.WHITESPACE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.TAB", "modulename": "verbex.verbex", "qualname": "CharClass.TAB", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar", "modulename": "verbex.verbex", "qualname": "SpecialChar", "type": "class", "doc": "

Enum of special charaters, shorthand.

\n\n

Arguments:\n Enum -- Extends the Enum class.

\n", "bases": "enum.Enum"}, {"fullname": "verbex.verbex.SpecialChar.LINEBREAK", "modulename": "verbex.verbex", "qualname": "SpecialChar.LINEBREAK", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.START_OF_LINE", "modulename": "verbex.verbex", "qualname": "SpecialChar.START_OF_LINE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.END_OF_LINE", "modulename": "verbex.verbex", "qualname": "SpecialChar.END_OF_LINE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.TAB", "modulename": "verbex.verbex", "qualname": "SpecialChar.TAB", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClassOrChars", "modulename": "verbex.verbex", "qualname": "CharClassOrChars", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[str, verbex.verbex.CharClass]"}, {"fullname": "verbex.verbex.EscapedCharClassOrSpecial", "modulename": "verbex.verbex", "qualname": "EscapedCharClassOrSpecial", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]"}, {"fullname": "verbex.verbex.VerbexEscapedCharClassOrSpecial", "modulename": "verbex.verbex", "qualname": "VerbexEscapedCharClassOrSpecial", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[ForwardRef('Verbex'), str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]"}, {"fullname": "verbex.verbex.Verbex", "modulename": "verbex.verbex", "qualname": "Verbex", "type": "class", "doc": "

VerbalExpressions class.

\n\n

the following methods do not try to match the original js lib!

\n"}, {"fullname": "verbex.verbex.Verbex.__init__", "modulename": "verbex.verbex", "qualname": "Verbex.__init__", "type": "function", "doc": "

Create a Verbex object; setting any needed flags.

\n\n

Keyword Arguments:\n modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})

\n", "signature": "(self, modifiers: re.RegexFlag = )", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.EMPTY_REGEX_FLAG", "modulename": "verbex.verbex", "qualname": "Verbex.EMPTY_REGEX_FLAG", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.Verbex.modifiers", "modulename": "verbex.verbex", "qualname": "Verbex.modifiers", "type": "variable", "doc": "

Return the modifiers for this Verbex object.

\n\n

Returns:\n The modifiers applied to this object.

\n", "annotation": ": re.RegexFlag"}, {"fullname": "verbex.verbex.Verbex.regex", "modulename": "verbex.verbex", "qualname": "Verbex.regex", "type": "function", "doc": "

Get a regular expression object.

\n", "signature": "(self) -> Pattern[str]", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.capture_group", "modulename": "verbex.verbex", "qualname": "Verbex.capture_group", "type": "function", "doc": "

Create a capture group.

\n\n

Name is optional if not specified then the first argument is the text.

\n\n

Keyword Arguments:\n name_or_text -- The name of the group / text to search for (default: {None})\n text -- The text to search for (default: {None})

\n\n

Raises:\n ValueError: If name is specified then text must be as well.

\n\n

Returns:\n Verbex with added capture group.

\n", "signature": "(\n self,\n /,\n name_or_text: Union[str, NoneType, verbex.verbex.Verbex, verbex.verbex.CharClass, verbex.verbex.SpecialChar] = None,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar, NoneType] = None\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.OR", "modulename": "verbex.verbex", "qualname": "Verbex.OR", "type": "function", "doc": "

or is a python keyword so we use OR instead.

\n\n

Arguments:\n text -- Text to find or a Verbex object.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.zero_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.zero_or_more", "type": "function", "doc": "

Find the text or Verbex object zero or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.one_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.one_or_more", "type": "function", "doc": "

Find the text or Verbex object one or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_times", "modulename": "verbex.verbex", "qualname": "Verbex.n_times", "type": "function", "doc": "

Find the text or Verbex object n or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_times_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.n_times_or_more", "type": "function", "doc": "

Find the text or Verbex object at least n times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_to_m_times", "modulename": "verbex.verbex", "qualname": "Verbex.n_to_m_times", "type": "function", "doc": "

Find the text or Verbex object between n and m times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int,\n m: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.maybe", "modulename": "verbex.verbex", "qualname": "Verbex.maybe", "type": "function", "doc": "

Possibly find the text / Verbex object.

\n\n

Arguments:\n text -- The text / Verbex object to possibly find.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.find", "modulename": "verbex.verbex", "qualname": "Verbex.find", "type": "function", "doc": "

Find the text or Verbex object.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.then", "modulename": "verbex.verbex", "qualname": "Verbex.then", "type": "function", "doc": "

Synonym for find.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.followed_by", "modulename": "verbex.verbex", "qualname": "Verbex.followed_by", "type": "function", "doc": "

Match if string is followed by text.

\n\n

Positive lookahead

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_followed_by", "modulename": "verbex.verbex", "qualname": "Verbex.not_followed_by", "type": "function", "doc": "

Match if string is not followed by text.

\n\n

Negative lookahead

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.preceded_by", "modulename": "verbex.verbex", "qualname": "Verbex.preceded_by", "type": "function", "doc": "

Match if string is not preceded by text.

\n\n

Positive lookbehind

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_preceded_by", "modulename": "verbex.verbex", "qualname": "Verbex.not_preceded_by", "type": "function", "doc": "

Match if string is not preceded by text.

\n\n

Negative Lookbehind

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.any_of", "modulename": "verbex.verbex", "qualname": "Verbex.any_of", "type": "function", "doc": "

Find anything in this group of chars or char class.

\n\n

Arguments:\n text -- The characters to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n chargroup: Union[str, verbex.verbex.CharClass]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_any_of", "modulename": "verbex.verbex", "qualname": "Verbex.not_any_of", "type": "function", "doc": "

Find anything but this group of chars or char class.

\n\n

Arguments:\n text -- The characters to not look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[str, verbex.verbex.CharClass]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.anything_but", "modulename": "verbex.verbex", "qualname": "Verbex.anything_but", "type": "function", "doc": "

Find anything one or more times but this group of chars or char class.

\n\n

Arguments:\n text -- The characters to not look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n chargroup: Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.start_of_line", "modulename": "verbex.verbex", "qualname": "Verbex.start_of_line", "type": "function", "doc": "

Find the start of the line.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.end_of_line", "modulename": "verbex.verbex", "qualname": "Verbex.end_of_line", "type": "function", "doc": "

Find the end of the line.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.line_break", "modulename": "verbex.verbex", "qualname": "Verbex.line_break", "type": "function", "doc": "

Find a line break.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.tab", "modulename": "verbex.verbex", "qualname": "Verbex.tab", "type": "function", "doc": "

Find a tab.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.anything", "modulename": "verbex.verbex", "qualname": "Verbex.anything", "type": "function", "doc": "

Find anything one or more time.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.as_few", "modulename": "verbex.verbex", "qualname": "Verbex.as_few", "type": "function", "doc": "

Modify previous search to not be greedy.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.number_range", "modulename": "verbex.verbex", "qualname": "Verbex.number_range", "type": "function", "doc": "

Generate a range of numbers.

\n\n

Arguments:\n start -- Start of the range\n end -- End of the range

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self, start: int, end: int) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.letter_range", "modulename": "verbex.verbex", "qualname": "Verbex.letter_range", "type": "function", "doc": "

Generate a range of letters.

\n\n

Arguments:\n start -- Start of the range\n end -- End of the range

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n start: typing.Annotated[str, Is[_string_len_is_1]],\n end: typing.Annotated[str, Is[_string_len_is_1]]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.word", "modulename": "verbex.verbex", "qualname": "Verbex.word", "type": "function", "doc": "

Find a word on word boundary.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.with_any_case", "modulename": "verbex.verbex", "qualname": "Verbex.with_any_case", "type": "function", "doc": "

Modify Verbex object to be case insensitive.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.search_by_line", "modulename": "verbex.verbex", "qualname": "Verbex.search_by_line", "type": "function", "doc": "

Search each line, ^ and $ match begining and end of line respectively.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.with_ascii", "modulename": "verbex.verbex", "qualname": "Verbex.with_ascii", "type": "function", "doc": "

Match ascii instead of unicode.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}]; + /** pdoc search index */const docs = [{"fullname": "verbex", "modulename": "verbex", "type": "module", "doc": "

\n"}, {"fullname": "verbex.verbex", "modulename": "verbex.verbex", "type": "module", "doc": "

Generate regular expressions from an easier fluent verbal form.

\n"}, {"fullname": "verbex.verbex.P", "modulename": "verbex.verbex", "qualname": "P", "type": "variable", "doc": "

\n", "default_value": " = ~P"}, {"fullname": "verbex.verbex.HasIter", "modulename": "verbex.verbex", "qualname": "HasIter", "type": "class", "doc": "

Workaround for mypy P.args.

\n", "bases": "typing.Protocol"}, {"fullname": "verbex.verbex.HasIter.__init__", "modulename": "verbex.verbex", "qualname": "HasIter.__init__", "type": "function", "doc": "

\n", "signature": "(self, *args, **kwargs)", "funcdef": "def"}, {"fullname": "verbex.verbex.HasItems", "modulename": "verbex.verbex", "qualname": "HasItems", "type": "class", "doc": "

Workaround for mypy P.kwargs.

\n", "bases": "typing.Protocol"}, {"fullname": "verbex.verbex.HasItems.__init__", "modulename": "verbex.verbex", "qualname": "HasItems.__init__", "type": "function", "doc": "

\n", "signature": "(self, *args, **kwargs)", "funcdef": "def"}, {"fullname": "verbex.verbex.HasItems.items", "modulename": "verbex.verbex", "qualname": "HasItems.items", "type": "function", "doc": "

Object has items method.

\n\n

Returns:\n The dict of items.

\n", "signature": "(self) -> tuple[str, typing.Any]", "funcdef": "def"}, {"fullname": "verbex.verbex.EscapedText", "modulename": "verbex.verbex", "qualname": "EscapedText", "type": "class", "doc": "

Text that has been escaped for regex.

\n\n

Arguments:\n str -- Extend the string class.

\n", "bases": "builtins.str"}, {"fullname": "verbex.verbex.EscapedText.__init__", "modulename": "verbex.verbex", "qualname": "EscapedText.__init__", "type": "function", "doc": "

Return a escaped regex string.

\n\n

Arguments:\n value -- the string to escape

\n\n

Returns:\n _description_

\n", "signature": "(cls, value: str)", "funcdef": "def"}, {"fullname": "verbex.verbex.re_escape", "modulename": "verbex.verbex", "qualname": "re_escape", "type": "function", "doc": "

Automatically escape any string parameters as EscapedText.

\n\n

Arguments:\n func -- The function to decorate.

\n\n

Returns:\n The decorated function.

\n", "signature": "(\n func: collections.abc.Callable[~P, ~R]\n) -> collections.abc.Callable[~P, ~R]", "funcdef": "def"}, {"fullname": "verbex.verbex.CharClass", "modulename": "verbex.verbex", "qualname": "CharClass", "type": "class", "doc": "

Enum of character classes in regex.

\n\n

Arguments:\n Enum -- Extends the Enum class.

\n", "bases": "enum.Enum"}, {"fullname": "verbex.verbex.CharClass.DIGIT", "modulename": "verbex.verbex", "qualname": "CharClass.DIGIT", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.UPPERCASE_LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.UPPERCASE_LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.LOWERCASE_LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.LOWERCASE_LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.WHITESPACE", "modulename": "verbex.verbex", "qualname": "CharClass.WHITESPACE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.TAB", "modulename": "verbex.verbex", "qualname": "CharClass.TAB", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar", "modulename": "verbex.verbex", "qualname": "SpecialChar", "type": "class", "doc": "

Enum of special charaters, shorthand.

\n\n

Arguments:\n Enum -- Extends the Enum class.

\n", "bases": "enum.Enum"}, {"fullname": "verbex.verbex.SpecialChar.LINEBREAK", "modulename": "verbex.verbex", "qualname": "SpecialChar.LINEBREAK", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.START_OF_LINE", "modulename": "verbex.verbex", "qualname": "SpecialChar.START_OF_LINE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.END_OF_LINE", "modulename": "verbex.verbex", "qualname": "SpecialChar.END_OF_LINE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.TAB", "modulename": "verbex.verbex", "qualname": "SpecialChar.TAB", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClassOrChars", "modulename": "verbex.verbex", "qualname": "CharClassOrChars", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[str, verbex.verbex.CharClass]"}, {"fullname": "verbex.verbex.EscapedCharClassOrSpecial", "modulename": "verbex.verbex", "qualname": "EscapedCharClassOrSpecial", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]"}, {"fullname": "verbex.verbex.VerbexEscapedCharClassOrSpecial", "modulename": "verbex.verbex", "qualname": "VerbexEscapedCharClassOrSpecial", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[ForwardRef('Verbex'), str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]"}, {"fullname": "verbex.verbex.Verbex", "modulename": "verbex.verbex", "qualname": "Verbex", "type": "class", "doc": "

VerbalExpressions class.

\n\n

the following methods do not try to match the original js lib!

\n"}, {"fullname": "verbex.verbex.Verbex.__init__", "modulename": "verbex.verbex", "qualname": "Verbex.__init__", "type": "function", "doc": "

Create a Verbex object; setting any needed flags.

\n\n

Keyword Arguments:\n modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})

\n", "signature": "(self, modifiers: re.RegexFlag = )", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.EMPTY_REGEX_FLAG", "modulename": "verbex.verbex", "qualname": "Verbex.EMPTY_REGEX_FLAG", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.Verbex.modifiers", "modulename": "verbex.verbex", "qualname": "Verbex.modifiers", "type": "variable", "doc": "

Return the modifiers for this Verbex object.

\n\n

Returns:\n The modifiers applied to this object.

\n", "annotation": ": re.RegexFlag"}, {"fullname": "verbex.verbex.Verbex.regex", "modulename": "verbex.verbex", "qualname": "Verbex.regex", "type": "function", "doc": "

Get a regular expression object.

\n", "signature": "(self) -> Pattern[str]", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.capture_group", "modulename": "verbex.verbex", "qualname": "Verbex.capture_group", "type": "function", "doc": "

Create a capture group.

\n\n

Name is optional if not specified then the first argument is the text.

\n\n

Keyword Arguments:\n name_or_text -- The name of the group / text to search for (default: {None})\n text -- The text to search for (default: {None})

\n\n

Raises:\n ValueError: If name is specified then text must be as well.

\n\n

Returns:\n Verbex with added capture group.

\n", "signature": "(\n self,\n name_or_text: Union[str, NoneType, verbex.verbex.Verbex, verbex.verbex.CharClass, verbex.verbex.SpecialChar] = None,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar, NoneType] = None\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.OR", "modulename": "verbex.verbex", "qualname": "Verbex.OR", "type": "function", "doc": "

or is a python keyword so we use OR instead.

\n\n

Arguments:\n text -- Text to find or a Verbex object.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.zero_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.zero_or_more", "type": "function", "doc": "

Find the text or Verbex object zero or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.one_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.one_or_more", "type": "function", "doc": "

Find the text or Verbex object one or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_times", "modulename": "verbex.verbex", "qualname": "Verbex.n_times", "type": "function", "doc": "

Find the text or Verbex object n or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_times_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.n_times_or_more", "type": "function", "doc": "

Find the text or Verbex object at least n times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_to_m_times", "modulename": "verbex.verbex", "qualname": "Verbex.n_to_m_times", "type": "function", "doc": "

Find the text or Verbex object between n and m times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int,\n m: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.maybe", "modulename": "verbex.verbex", "qualname": "Verbex.maybe", "type": "function", "doc": "

Possibly find the text / Verbex object.

\n\n

Arguments:\n text -- The text / Verbex object to possibly find.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.find", "modulename": "verbex.verbex", "qualname": "Verbex.find", "type": "function", "doc": "

Find the text or Verbex object.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.then", "modulename": "verbex.verbex", "qualname": "Verbex.then", "type": "function", "doc": "

Synonym for find.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.followed_by", "modulename": "verbex.verbex", "qualname": "Verbex.followed_by", "type": "function", "doc": "

Match if string is followed by text.

\n\n

Positive lookahead

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_followed_by", "modulename": "verbex.verbex", "qualname": "Verbex.not_followed_by", "type": "function", "doc": "

Match if string is not followed by text.

\n\n

Negative lookahead

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.preceded_by", "modulename": "verbex.verbex", "qualname": "Verbex.preceded_by", "type": "function", "doc": "

Match if string is not preceded by text.

\n\n

Positive lookbehind

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_preceded_by", "modulename": "verbex.verbex", "qualname": "Verbex.not_preceded_by", "type": "function", "doc": "

Match if string is not preceded by text.

\n\n

Negative Lookbehind

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.any_of", "modulename": "verbex.verbex", "qualname": "Verbex.any_of", "type": "function", "doc": "

Find anything in this group of chars or char class.

\n\n

Arguments:\n text -- The characters to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n chargroup: Union[str, verbex.verbex.CharClass]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_any_of", "modulename": "verbex.verbex", "qualname": "Verbex.not_any_of", "type": "function", "doc": "

Find anything but this group of chars or char class.

\n\n

Arguments:\n text -- The characters to not look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[str, verbex.verbex.CharClass]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.anything_but", "modulename": "verbex.verbex", "qualname": "Verbex.anything_but", "type": "function", "doc": "

Find anything one or more times but this group of chars or char class.

\n\n

Arguments:\n text -- The characters to not look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n chargroup: Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.start_of_line", "modulename": "verbex.verbex", "qualname": "Verbex.start_of_line", "type": "function", "doc": "

Find the start of the line.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.end_of_line", "modulename": "verbex.verbex", "qualname": "Verbex.end_of_line", "type": "function", "doc": "

Find the end of the line.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.line_break", "modulename": "verbex.verbex", "qualname": "Verbex.line_break", "type": "function", "doc": "

Find a line break.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.tab", "modulename": "verbex.verbex", "qualname": "Verbex.tab", "type": "function", "doc": "

Find a tab.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.anything", "modulename": "verbex.verbex", "qualname": "Verbex.anything", "type": "function", "doc": "

Find anything one or more time.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.as_few", "modulename": "verbex.verbex", "qualname": "Verbex.as_few", "type": "function", "doc": "

Modify previous search to not be greedy.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.number_range", "modulename": "verbex.verbex", "qualname": "Verbex.number_range", "type": "function", "doc": "

Generate a range of numbers.

\n\n

Arguments:\n start -- Start of the range\n end -- End of the range

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self, start: int, end: int) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.letter_range", "modulename": "verbex.verbex", "qualname": "Verbex.letter_range", "type": "function", "doc": "

Generate a range of letters.

\n\n

Arguments:\n start -- Start of the range\n end -- End of the range

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n start: typing.Annotated[str, Is[_string_len_is_1]],\n end: typing.Annotated[str, Is[_string_len_is_1]]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.word", "modulename": "verbex.verbex", "qualname": "Verbex.word", "type": "function", "doc": "

Find a word on word boundary.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.with_any_case", "modulename": "verbex.verbex", "qualname": "Verbex.with_any_case", "type": "function", "doc": "

Modify Verbex object to be case insensitive.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.search_by_line", "modulename": "verbex.verbex", "qualname": "Verbex.search_by_line", "type": "function", "doc": "

Search each line, ^ and $ match begining and end of line respectively.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.with_ascii", "modulename": "verbex.verbex", "qualname": "Verbex.with_ascii", "type": "function", "doc": "

Match ascii instead of unicode.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}]; // mirrored in build-search-index.js (part 1) // Also split on html tags. this is a cheap heuristic, but good enough. @@ -43,4 +43,4 @@ window.pdocSearch = (function(){ }, expand: true }); -})(); +})(); \ No newline at end of file diff --git a/docs/verbex.html b/docs/verbex.html new file mode 100644 index 0000000..189cab6 --- /dev/null +++ b/docs/verbex.html @@ -0,0 +1,238 @@ + + + + + + + verbex API documentation + + + + + + + + + +
+
+

+verbex

+ + +
+ View Source + 
0import importlib.metadata
+1
+2from .verbex import CharClass as CharClass
+3from .verbex import SpecialChar as SpecialChar
+4from .verbex import Verbex as Verbex
+5
+6__version__ = importlib.metadata.version("verbex")
+
+ +
+ +
+
+ + \ No newline at end of file diff --git a/docs/verbex/verbex.html b/docs/verbex/verbex.html index 16149cf..48f01fc 100644 --- a/docs/verbex/verbex.html +++ b/docs/verbex/verbex.html @@ -16,9 +16,16 @@

Generate regular expressions from an easier fluent verbal form.

@@ -247,617 +254,638 @@

8 from typing import ( # <--------------- if Python ≥ 3.9.0 9 Annotated, 10 ParamSpec, - 11 TypeAlias, - 12 ) - 13except (ModuleNotFoundError, ImportError): - 14 from typing_extensions import TypeAlias, Annotated, ParamSpec # type: ignore # <--- if Python < 3.9.0 - 15 - 16from typing import Pattern, Protocol, TypeVar + 11 Protocol, + 12 TypeAlias, + 13 runtime_checkable, + 14 ) + 15except ImportError: + 16 from typing_extensions import TypeAlias, Protocol, Annotated, ParamSpec, runtime_checkable # type: ignore # <--- if Python < 3.9.0 # noqa E501 17 - 18from beartype import beartype # type: ignore - 19from beartype.typing import ( # type: ignore - 20 Any, - 21 Callable, - 22 Dict, - 23 Iterator, - 24 List, - 25 Optional, - 26 Tuple, - 27 Union, - 28 cast, - 29 runtime_checkable, - 30) - 31from beartype.vale import Is # type: ignore - 32 + 18from typing import Pattern, TypeVar + 19 + 20from beartype import beartype # type: ignore + 21from beartype.typing import ( # type: ignore + 22 Any, + 23 Callable, + 24 Dict, + 25 Iterator, + 26 List, + 27 Optional, + 28 Tuple, + 29 Union, + 30 cast, + 31) + 32from beartype.vale import Is # type: ignore 33 - 34def _string_len_is_1(text: object) -> bool: - 35 return isinstance(text, str) and len(text) == 1 - 36 + 34 + 35def _string_len_is_1(text: object) -> bool: + 36 return isinstance(text, str) and len(text) == 1 37 - 38Char = Annotated[str, Is[_string_len_is_1]] - 39 + 38 + 39Char = Annotated[str, Is[_string_len_is_1]] 40 - 41P = ParamSpec("P") # noqa VNE001 - 42R = TypeVar("R") # noqa VNE001 - 43 + 41 + 42P = ParamSpec("P") # noqa VNE001 + 43R = TypeVar("R") # noqa VNE001 44 - 45# work around for bug https://github.com/python/mypy/issues/12660 - 46# fixed in next version of mypy - 47@runtime_checkable - 48class HasIter(Protocol): - 49 """Workaround for mypy P.args.""" - 50 - 51 def __iter__(self) -> Iterator[Any]: - 52 """Object can be iterated. - 53 - 54 Yields: - 55 Next object. - 56 """ - 57 ... - 58 + 45 + 46# work around for bug https://github.com/python/mypy/issues/12660 + 47# fixed in next version of mypy + 48@runtime_checkable + 49class HasIter(Protocol): + 50 """Workaround for mypy P.args.""" + 51 + 52 def __iter__(self) -> Iterator[Any]: + 53 """Object can be iterated. + 54 + 55 Yields: + 56 Next object. + 57 """ + 58 ... 59 - 60# work around for bug https://github.com/python/mypy/issues/12660 - 61# fixed in next version of mypy - 62@runtime_checkable - 63class HasItems(Protocol): - 64 """Workaround for mypy P.kwargs.""" - 65 - 66 def items(self) -> Tuple[str, Any]: - 67 """Object has items method. - 68 - 69 Returns: - 70 The dict of items. - 71 """ - 72 ... - 73 + 60 + 61# work around for bug https://github.com/python/mypy/issues/12660 + 62# fixed in next version of mypy + 63@runtime_checkable + 64class HasItems(Protocol): + 65 """Workaround for mypy P.kwargs.""" + 66 + 67 def items(self) -> Tuple[str, Any]: + 68 """Object has items method. + 69 + 70 Returns: + 71 The dict of items. + 72 """ + 73 ... 74 - 75class EscapedText(str): - 76 """Text that has been escaped for regex. - 77 - 78 Arguments: - 79 str -- Extend the string class. - 80 """ - 81 - 82 def __new__(cls, value: str) -> EscapedText: - 83 """Return a escaped regex string. - 84 - 85 Arguments: - 86 value -- the string to escape - 87 - 88 Returns: - 89 _description_ - 90 """ - 91 return str.__new__(cls, re.escape(value)) - 92 + 75 + 76class EscapedText(str): + 77 """Text that has been escaped for regex. + 78 + 79 Arguments: + 80 str -- Extend the string class. + 81 """ + 82 + 83 def __new__(cls, value: str) -> EscapedText: + 84 """Return a escaped regex string. + 85 + 86 Arguments: + 87 value -- the string to escape + 88 + 89 Returns: + 90 _description_ + 91 """ + 92 return str.__new__(cls, re.escape(value)) 93 - 94def re_escape(func: Callable[P, R]) -> Callable[P, R]: - 95 """Automatically escape any string parameters as EscapedText. - 96 - 97 Arguments: - 98 func -- The function to decorate. - 99 -100 Returns: -101 The decorated function. -102 """ -103 -104 @wraps(func) -105 def inner(*args: P.args, **kwargs: P.kwargs) -> R: # type: ignore -106 escaped_args: List[Any] = [] -107 escaped_kwargs: Dict[str, Any] = {} -108 for arg in cast(HasIter, args): -109 if not isinstance(arg, EscapedText) and isinstance(arg, str): -110 escaped_args.append(EscapedText(arg)) -111 else: -112 escaped_args.append(arg) -113 arg_k: str -114 arg_v: Any -115 for arg_k, arg_v in cast(HasItems, kwargs).items(): -116 if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str): -117 escaped_kwargs[arg_k] = EscapedText(str(arg_v)) -118 else: -119 escaped_kwargs[arg_k] = arg_v -120 return func(*escaped_args, **escaped_kwargs) # type: ignore -121 -122 return inner -123 + 94 + 95def re_escape(func: Callable[P, R]) -> Callable[P, R]: + 96 """Automatically escape any string parameters as EscapedText. + 97 + 98 Arguments: + 99 func -- The function to decorate. +100 +101 Returns: +102 The decorated function. +103 """ +104 +105 @wraps(func) +106 def inner(*args: P.args, **kwargs: P.kwargs) -> R: # type: ignore +107 escaped_args: List[Any] = [] +108 escaped_kwargs: Dict[str, Any] = {} +109 for arg in cast(HasIter, args): +110 if not isinstance(arg, EscapedText) and isinstance(arg, str): +111 escaped_args.append(EscapedText(arg)) +112 else: +113 escaped_args.append(arg) +114 arg_k: str +115 arg_v: Any +116 for arg_k, arg_v in cast(HasItems, kwargs).items(): +117 if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str): +118 escaped_kwargs[arg_k] = EscapedText(str(arg_v)) +119 else: +120 escaped_kwargs[arg_k] = arg_v +121 return func(*escaped_args, **escaped_kwargs) # type: ignore +122 +123 return inner 124 -125class CharClass(Enum): -126 """Enum of character classes in regex. -127 -128 Arguments: -129 Enum -- Extends the Enum class. -130 """ -131 -132 DIGIT = "\\d" -133 LETTER = "\\w" -134 UPPERCASE_LETTER = "\\u" -135 LOWERCASE_LETTER = "\\l" -136 WHITESPACE = "\\s" -137 TAB = "\\t" -138 -139 def __str__(self) -> str: -140 """To string method based on Enum value. -141 -142 Returns: -143 value of Enum -144 """ -145 return self.value -146 +125 +126class CharClass(Enum): +127 """Enum of character classes in regex. +128 +129 Arguments: +130 Enum -- Extends the Enum class. +131 """ +132 +133 DIGIT = "\\d" +134 LETTER = "\\w" +135 UPPERCASE_LETTER = "\\u" +136 LOWERCASE_LETTER = "\\l" +137 WHITESPACE = "\\s" +138 TAB = "\\t" +139 +140 def __str__(self) -> str: +141 """To string method based on Enum value. +142 +143 Returns: +144 value of Enum +145 """ +146 return self.value 147 -148class SpecialChar(Enum): -149 """Enum of special charaters, shorthand. -150 -151 Arguments: -152 Enum -- Extends the Enum class. -153 """ -154 -155 # does not work / should not be used in [ ] -156 LINEBREAK = "(\\n|(\\r\\n))" -157 START_OF_LINE = "^" -158 END_OF_LINE = "$" -159 TAB = "\t" -160 -161 def __str__(self) -> str: -162 """To string for special chars enum. -163 -164 Returns: -165 Return value of enum as string. -166 """ -167 return self.value -168 +148 +149class SpecialChar(Enum): +150 """Enum of special charaters, shorthand. +151 +152 Arguments: +153 Enum -- Extends the Enum class. +154 """ +155 +156 # does not work / should not be used in [ ] +157 LINEBREAK = "(\\n|(\\r\\n))" +158 START_OF_LINE = "^" +159 END_OF_LINE = "$" +160 TAB = "\t" +161 +162 def __str__(self) -> str: +163 """To string for special chars enum. +164 +165 Returns: +166 Return value of enum as string. +167 """ +168 return self.value 169 -170CharClassOrChars: TypeAlias = Union[str, CharClass] -171EscapedCharClassOrSpecial: TypeAlias = Union[str, CharClass, SpecialChar] -172VerbexEscapedCharClassOrSpecial: TypeAlias = Union["Verbex", EscapedCharClassOrSpecial] -173 +170 +171CharClassOrChars: TypeAlias = Union[str, CharClass] +172EscapedCharClassOrSpecial: TypeAlias = Union[str, CharClass, SpecialChar] +173VerbexEscapedCharClassOrSpecial: TypeAlias = Union["Verbex", EscapedCharClassOrSpecial] 174 -175class Verbex: -176 """ -177 VerbalExpressions class. -178 -179 the following methods do not try to match the original js lib! -180 """ -181 -182 EMPTY_REGEX_FLAG = re.RegexFlag(0) -183 -184 @re_escape -185 @beartype -186 def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG): -187 """Create a Verbex object; setting any needed flags. -188 -189 Keyword Arguments: -190 modifiers -- Regex modifying flags (default: {re.RegexFlag(0)}) -191 """ -192 # self._parts: List[str] = [text] -193 self._parts: List[str] = [] -194 self._modifiers = modifiers +175 +176def _poseur_decorator(*poseur: Any) -> Any: +177 """Positional-only arguments runtime checker.""" +178 import functools +179 +180 def caller(func: Callable[P, R]) -> Callable[P, R]: # type: ignore +181 @functools.wraps(func) +182 def wrapper(*args: P.args, **kwargs: P.kwargs) -> R: +183 poseur_args = set(poseur).intersection(kwargs) # type: ignore +184 if poseur_args: +185 raise TypeError( +186 "%s() got some positional-only arguments passed as keyword" +187 " arguments: %r" % (func.__name__, ", ".join(poseur_args)), +188 ) +189 return func(*args, **kwargs) # type: ignore +190 +191 return wrapper +192 +193 return caller +194 195 -196 @property -197 def modifiers(self) -> re.RegexFlag: -198 """Return the modifiers for this Verbex object. +196class Verbex: +197 """ +198 VerbalExpressions class. 199 -200 Returns: -201 The modifiers applied to this object. -202 """ -203 return self._modifiers +200 the following methods do not try to match the original js lib! +201 """ +202 +203 EMPTY_REGEX_FLAG = re.RegexFlag(0) 204 -205 def __str__(self) -> str: -206 """Return regex string representation.""" -207 return "".join(self._parts) -208 -209 @beartype -210 def _add(self, value: Union[str, List[str]]) -> Verbex: -211 """ -212 Append a transformed value to internal expression to be compiled. -213 -214 As possible, this method should be "private". -215 """ -216 if isinstance(value, list): -217 self._parts.extend(value) -218 else: -219 self._parts.append(value) -220 return self -221 -222 def regex(self) -> Pattern[str]: -223 """Get a regular expression object.""" -224 return re.compile( -225 str(self), -226 self._modifiers, -227 ) -228 -229 # allow VerbexEscapedCharClassOrSpecial -230 -231 @re_escape -232 @beartype -233 def _capture_group_with_name( -234 self, -235 name: str, -236 text: VerbexEscapedCharClassOrSpecial, -237 ) -> Verbex: -238 return self._add(f"(?<{name}>{str(text)})") -239 -240 @re_escape -241 @beartype -242 def _capture_group_without_name( -243 self, -244 text: VerbexEscapedCharClassOrSpecial, -245 ) -> Verbex: -246 return self._add(f"({str(text)})") -247 -248 @re_escape -249 @beartype -250 def capture_group( -251 self, -252 /, -253 name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None, -254 text: Optional[VerbexEscapedCharClassOrSpecial] = None, -255 ) -> Verbex: -256 """Create a capture group. -257 -258 Name is optional if not specified then the first argument is the text. -259 -260 Keyword Arguments: -261 name_or_text -- The name of the group / text to search for (default: {None}) -262 text -- The text to search for (default: {None}) -263 -264 Raises: -265 ValueError: If name is specified then text must be as well. -266 -267 Returns: -268 Verbex with added capture group. -269 """ -270 if name_or_text is not None: -271 if text is None: -272 _text = name_or_text -273 return self._capture_group_without_name(_text) -274 if isinstance(name_or_text, str): -275 return self._capture_group_with_name(name_or_text, text) -276 raise ValueError("text must be specified with optional name") -277 -278 @re_escape -279 @beartype -280 def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: # noqa N802 -281 """`or` is a python keyword so we use `OR` instead. -282 -283 Arguments: -284 text -- Text to find or a Verbex object. -285 -286 Returns: -287 Modified Verbex object. -288 """ -289 return self._add("|").find(text) -290 -291 @re_escape -292 @beartype -293 def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -294 """Find the text or Verbex object zero or more times. -295 -296 Arguments: -297 text -- The text / Verbex object to look for. +205 @re_escape +206 @beartype +207 def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG): +208 """Create a Verbex object; setting any needed flags. +209 +210 Keyword Arguments: +211 modifiers -- Regex modifying flags (default: {re.RegexFlag(0)}) +212 """ +213 # self._parts: List[str] = [text] +214 self._parts: List[str] = [] +215 self._modifiers = modifiers +216 +217 @property +218 def modifiers(self) -> re.RegexFlag: +219 """Return the modifiers for this Verbex object. +220 +221 Returns: +222 The modifiers applied to this object. +223 """ +224 return self._modifiers +225 +226 def __str__(self) -> str: +227 """Return regex string representation.""" +228 return "".join(self._parts) +229 +230 @beartype +231 def _add(self, value: Union[str, List[str]]) -> Verbex: +232 """ +233 Append a transformed value to internal expression to be compiled. +234 +235 As possible, this method should be "private". +236 """ +237 if isinstance(value, list): +238 self._parts.extend(value) +239 else: +240 self._parts.append(value) +241 return self +242 +243 def regex(self) -> Pattern[str]: +244 """Get a regular expression object.""" +245 return re.compile( +246 str(self), +247 self._modifiers, +248 ) +249 +250 # allow VerbexEscapedCharClassOrSpecial +251 +252 @re_escape +253 @beartype +254 def _capture_group_with_name( +255 self, +256 name: str, +257 text: VerbexEscapedCharClassOrSpecial, +258 ) -> Verbex: +259 return self._add(f"(?<{name}>{str(text)})") +260 +261 @re_escape +262 @beartype +263 def _capture_group_without_name( +264 self, +265 text: VerbexEscapedCharClassOrSpecial, +266 ) -> Verbex: +267 return self._add(f"({str(text)})") +268 +269 @re_escape +270 @beartype +271 @_poseur_decorator("self") +272 def capture_group( +273 self, +274 name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None, +275 text: Optional[VerbexEscapedCharClassOrSpecial] = None, +276 ) -> Verbex: +277 """Create a capture group. +278 +279 Name is optional if not specified then the first argument is the text. +280 +281 Keyword Arguments: +282 name_or_text -- The name of the group / text to search for (default: {None}) +283 text -- The text to search for (default: {None}) +284 +285 Raises: +286 ValueError: If name is specified then text must be as well. +287 +288 Returns: +289 Verbex with added capture group. +290 """ +291 if name_or_text is not None: +292 if text is None: +293 _text = name_or_text +294 return self._capture_group_without_name(_text) +295 if isinstance(name_or_text, str): +296 return self._capture_group_with_name(name_or_text, text) +297 raise ValueError("text must be specified with optional name") 298 -299 Returns: -300 Modified Verbex object. -301 """ -302 return self._add(f"(?:{str(text)})*") +299 @re_escape +300 @beartype +301 def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: # noqa N802 +302 """`or` is a python keyword so we use `OR` instead. 303 -304 @re_escape -305 @beartype -306 def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -307 """Find the text or Verbex object one or more times. -308 -309 Arguments: -310 text -- The text / Verbex object to look for. +304 Arguments: +305 text -- Text to find or a Verbex object. +306 +307 Returns: +308 Modified Verbex object. +309 """ +310 return self._add("|").find(text) 311 -312 Returns: -313 Modified Verbex object. -314 """ -315 return self._add(f"(?:{str(text)})+") +312 @re_escape +313 @beartype +314 def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +315 """Find the text or Verbex object zero or more times. 316 -317 @re_escape -318 @beartype -319 def n_times( -320 self, -321 text: VerbexEscapedCharClassOrSpecial, -322 n: int, # noqa: VNE001 -323 ) -> Verbex: -324 """Find the text or Verbex object n or more times. -325 -326 Arguments: -327 text -- The text / Verbex object to look for. -328 -329 Returns: -330 Modified Verbex object. -331 """ -332 return self._add(f"(?:{str(text)}){{{n}}}") -333 -334 @re_escape -335 @beartype -336 def n_times_or_more( -337 self, -338 text: VerbexEscapedCharClassOrSpecial, -339 n: int, # noqa: VNE001 -340 ) -> Verbex: -341 """Find the text or Verbex object at least n times. -342 -343 Arguments: -344 text -- The text / Verbex object to look for. -345 -346 Returns: -347 Modified Verbex object. -348 """ -349 return self._add(f"(?:{str(text)}){{{n},}}") -350 -351 @re_escape -352 @beartype -353 def n_to_m_times( -354 self, -355 text: VerbexEscapedCharClassOrSpecial, -356 n: int, # noqa: VNE001 -357 m: int, # noqa: VNE001 -358 ) -> Verbex: -359 """Find the text or Verbex object between n and m times. -360 -361 Arguments: -362 text -- The text / Verbex object to look for. +317 Arguments: +318 text -- The text / Verbex object to look for. +319 +320 Returns: +321 Modified Verbex object. +322 """ +323 return self._add(f"(?:{str(text)})*") +324 +325 @re_escape +326 @beartype +327 def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +328 """Find the text or Verbex object one or more times. +329 +330 Arguments: +331 text -- The text / Verbex object to look for. +332 +333 Returns: +334 Modified Verbex object. +335 """ +336 return self._add(f"(?:{str(text)})+") +337 +338 @re_escape +339 @beartype +340 def n_times( +341 self, +342 text: VerbexEscapedCharClassOrSpecial, +343 n: int, # noqa: VNE001 +344 ) -> Verbex: +345 """Find the text or Verbex object n or more times. +346 +347 Arguments: +348 text -- The text / Verbex object to look for. +349 +350 Returns: +351 Modified Verbex object. +352 """ +353 return self._add(f"(?:{str(text)}){{{n}}}") +354 +355 @re_escape +356 @beartype +357 def n_times_or_more( +358 self, +359 text: VerbexEscapedCharClassOrSpecial, +360 n: int, # noqa: VNE001 +361 ) -> Verbex: +362 """Find the text or Verbex object at least n times. 363 -364 Returns: -365 Modified Verbex object. -366 """ -367 return self._add(f"(?:{str(text)}){{{n},{m}}}") -368 -369 @re_escape -370 @beartype -371 def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -372 """Possibly find the text / Verbex object. -373 -374 Arguments: -375 text -- The text / Verbex object to possibly find. -376 -377 Returns: -378 Modified Verbex object. -379 """ -380 return self._add(f"(?:{str(text)})?") +364 Arguments: +365 text -- The text / Verbex object to look for. +366 +367 Returns: +368 Modified Verbex object. +369 """ +370 return self._add(f"(?:{str(text)}){{{n},}}") +371 +372 @re_escape +373 @beartype +374 def n_to_m_times( +375 self, +376 text: VerbexEscapedCharClassOrSpecial, +377 n: int, # noqa: VNE001 +378 m: int, # noqa: VNE001 +379 ) -> Verbex: +380 """Find the text or Verbex object between n and m times. 381 -382 @re_escape -383 @beartype -384 def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -385 """Find the text or Verbex object. -386 -387 Arguments: -388 text -- The text / Verbex object to look for. +382 Arguments: +383 text -- The text / Verbex object to look for. +384 +385 Returns: +386 Modified Verbex object. +387 """ +388 return self._add(f"(?:{str(text)}){{{n},{m}}}") 389 -390 Returns: -391 Modified Verbex object. -392 """ -393 return self._add(str(text)) +390 @re_escape +391 @beartype +392 def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +393 """Possibly find the text / Verbex object. 394 -395 @re_escape -396 @beartype -397 def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -398 """Synonym for find. -399 -400 Arguments: -401 text -- The text / Verbex object to look for. +395 Arguments: +396 text -- The text / Verbex object to possibly find. +397 +398 Returns: +399 Modified Verbex object. +400 """ +401 return self._add(f"(?:{str(text)})?") 402 -403 Returns: -404 Modified Verbex object. -405 """ -406 return self.find(text) +403 @re_escape +404 @beartype +405 def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +406 """Find the text or Verbex object. 407 -408 @re_escape -409 @beartype -410 def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -411 """Match if string is followed by text. -412 -413 Positive lookahead -414 -415 Returns: -416 Modified Verbex object. -417 """ -418 return self._add(f"(?={text})") -419 -420 @re_escape -421 @beartype -422 def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -423 """Match if string is not followed by text. -424 -425 Negative lookahead -426 -427 Returns: -428 Modified Verbex object. -429 """ -430 return self._add(f"(?!{text})") -431 -432 @re_escape -433 @beartype -434 def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -435 """Match if string is not preceded by text. -436 -437 Positive lookbehind -438 -439 Returns: -440 Modified Verbex object. -441 """ -442 return self._add(f"(?<={text})") -443 -444 @re_escape -445 @beartype -446 def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -447 """Match if string is not preceded by text. -448 -449 Negative Lookbehind -450 -451 Returns: -452 Modified Verbex object. -453 """ -454 return self._add(f"(?<!{text})") -455 -456 # only allow CharclassOrChars +408 Arguments: +409 text -- The text / Verbex object to look for. +410 +411 Returns: +412 Modified Verbex object. +413 """ +414 return self._add(str(text)) +415 +416 @re_escape +417 @beartype +418 def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +419 """Synonym for find. +420 +421 Arguments: +422 text -- The text / Verbex object to look for. +423 +424 Returns: +425 Modified Verbex object. +426 """ +427 return self.find(text) +428 +429 @re_escape +430 @beartype +431 def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +432 """Match if string is followed by text. +433 +434 Positive lookahead +435 +436 Returns: +437 Modified Verbex object. +438 """ +439 return self._add(f"(?={text})") +440 +441 @re_escape +442 @beartype +443 def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +444 """Match if string is not followed by text. +445 +446 Negative lookahead +447 +448 Returns: +449 Modified Verbex object. +450 """ +451 return self._add(f"(?!{text})") +452 +453 @re_escape +454 @beartype +455 def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +456 """Match if string is not preceded by text. 457 -458 @re_escape -459 @beartype -460 def any_of(self, chargroup: CharClassOrChars) -> Verbex: -461 """Find anything in this group of chars or char class. -462 -463 Arguments: -464 text -- The characters to look for. -465 -466 Returns: -467 Modified Verbex object. -468 """ -469 return self._add(f"(?:[{chargroup}])") -470 -471 @re_escape -472 @beartype -473 def not_any_of(self, text: CharClassOrChars) -> Verbex: -474 """Find anything but this group of chars or char class. -475 -476 Arguments: -477 text -- The characters to not look for. +458 Positive lookbehind +459 +460 Returns: +461 Modified Verbex object. +462 """ +463 return self._add(f"(?<={text})") +464 +465 @re_escape +466 @beartype +467 def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +468 """Match if string is not preceded by text. +469 +470 Negative Lookbehind +471 +472 Returns: +473 Modified Verbex object. +474 """ +475 return self._add(f"(?<!{text})") +476 +477 # only allow CharclassOrChars 478 -479 Returns: -480 Modified Verbex object. -481 """ -482 return self._add(f"(?:[^{text}])") +479 @re_escape +480 @beartype +481 def any_of(self, chargroup: CharClassOrChars) -> Verbex: +482 """Find anything in this group of chars or char class. 483 -484 @re_escape -485 def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex: -486 """Find anything one or more times but this group of chars or char class. -487 -488 Arguments: -489 text -- The characters to not look for. -490 -491 Returns: -492 Modified Verbex object. -493 """ -494 return self._add(f"[^{chargroup}]+") -495 -496 # no text input -497 -498 def start_of_line(self) -> Verbex: -499 """Find the start of the line. -500 -501 Returns: -502 Modified Verbex object. -503 """ -504 return self.find(SpecialChar.START_OF_LINE) -505 -506 def end_of_line(self) -> Verbex: -507 """Find the end of the line. +484 Arguments: +485 text -- The characters to look for. +486 +487 Returns: +488 Modified Verbex object. +489 """ +490 return self._add(f"(?:[{chargroup}])") +491 +492 @re_escape +493 @beartype +494 def not_any_of(self, text: CharClassOrChars) -> Verbex: +495 """Find anything but this group of chars or char class. +496 +497 Arguments: +498 text -- The characters to not look for. +499 +500 Returns: +501 Modified Verbex object. +502 """ +503 return self._add(f"(?:[^{text}])") +504 +505 @re_escape +506 def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex: +507 """Find anything one or more times but this group of chars or char class. 508 -509 Returns: -510 Modified Verbex object. -511 """ -512 return self.find(SpecialChar.END_OF_LINE) -513 -514 def line_break(self) -> Verbex: -515 """Find a line break. +509 Arguments: +510 text -- The characters to not look for. +511 +512 Returns: +513 Modified Verbex object. +514 """ +515 return self._add(f"[^{chargroup}]+") 516 -517 Returns: -518 Modified Verbex object. -519 """ -520 return self.find(SpecialChar.LINEBREAK) +517 # no text input +518 +519 def start_of_line(self) -> Verbex: +520 """Find the start of the line. 521 -522 def tab(self) -> Verbex: -523 """Find a tab. -524 -525 Returns: -526 Modified Verbex object. -527 """ -528 return self.find(SpecialChar.TAB) +522 Returns: +523 Modified Verbex object. +524 """ +525 return self.find(SpecialChar.START_OF_LINE) +526 +527 def end_of_line(self) -> Verbex: +528 """Find the end of the line. 529 -530 def anything(self) -> Verbex: -531 """Find anything one or more time. -532 -533 Returns: -534 Modified Verbex object. -535 """ -536 return self._add(".+") +530 Returns: +531 Modified Verbex object. +532 """ +533 return self.find(SpecialChar.END_OF_LINE) +534 +535 def line_break(self) -> Verbex: +536 """Find a line break. 537 -538 def as_few(self) -> Verbex: -539 """Modify previous search to not be greedy. -540 -541 Returns: -542 Modified Verbex object. -543 """ -544 return self._add("?") +538 Returns: +539 Modified Verbex object. +540 """ +541 return self.find(SpecialChar.LINEBREAK) +542 +543 def tab(self) -> Verbex: +544 """Find a tab. 545 -546 @beartype -547 def number_range(self, start: int, end: int) -> Verbex: -548 """Generate a range of numbers. -549 -550 Arguments: -551 start -- Start of the range -552 end -- End of the range +546 Returns: +547 Modified Verbex object. +548 """ +549 return self.find(SpecialChar.TAB) +550 +551 def anything(self) -> Verbex: +552 """Find anything one or more time. 553 554 Returns: 555 Modified Verbex object. 556 """ -557 return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")") +557 return self._add(".+") 558 -559 @beartype -560 def letter_range(self, start: Char, end: Char) -> Verbex: -561 """Generate a range of letters. -562 -563 Arguments: -564 start -- Start of the range -565 end -- End of the range +559 def as_few(self) -> Verbex: +560 """Modify previous search to not be greedy. +561 +562 Returns: +563 Modified Verbex object. +564 """ +565 return self._add("?") 566 -567 Returns: -568 Modified Verbex object. -569 """ -570 return self._add(f"[{start}-{end}]") -571 -572 def word(self) -> Verbex: -573 """Find a word on word boundary. +567 @beartype +568 def number_range(self, start: int, end: int) -> Verbex: +569 """Generate a range of numbers. +570 +571 Arguments: +572 start -- Start of the range +573 end -- End of the range 574 575 Returns: 576 Modified Verbex object. 577 """ -578 return self._add("(\\b\\w+\\b)") +578 return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")") 579 -580 # # --------------- modifiers ------------------------ -581 -582 def with_any_case(self) -> Verbex: -583 """Modify Verbex object to be case insensitive. -584 -585 Returns: -586 Modified Verbex object. -587 """ -588 self._modifiers |= re.IGNORECASE -589 return self -590 -591 def search_by_line(self) -> Verbex: -592 """Search each line, ^ and $ match begining and end of line respectively. -593 -594 Returns: -595 Modified Verbex object. -596 """ -597 self._modifiers |= re.MULTILINE -598 return self -599 -600 def with_ascii(self) -> Verbex: -601 """Match ascii instead of unicode. +580 @beartype +581 def letter_range(self, start: Char, end: Char) -> Verbex: +582 """Generate a range of letters. +583 +584 Arguments: +585 start -- Start of the range +586 end -- End of the range +587 +588 Returns: +589 Modified Verbex object. +590 """ +591 return self._add(f"[{start}-{end}]") +592 +593 def word(self) -> Verbex: +594 """Find a word on word boundary. +595 +596 Returns: +597 Modified Verbex object. +598 """ +599 return self._add("(\\b\\w+\\b)") +600 +601 # # --------------- modifiers ------------------------ 602 -603 Returns: -604 Modified Verbex object. -605 """ -606 self._modifiers |= re.ASCII -607 return self -608 -609 -610# left over notes from original version -611# def __getattr__(self, attr): -612# """ any other function will be sent to the regex object """ -613# regex = self.regex() -614# return getattr(regex, attr) -615 -616# def replace(self, string, repl): -617# return self.sub(repl, string) -618 -619 -620if __name__ == "__main__": -621 pass +603 def with_any_case(self) -> Verbex: +604 """Modify Verbex object to be case insensitive. +605 +606 Returns: +607 Modified Verbex object. +608 """ +609 self._modifiers |= re.IGNORECASE +610 return self +611 +612 def search_by_line(self) -> Verbex: +613 """Search each line, ^ and $ match begining and end of line respectively. +614 +615 Returns: +616 Modified Verbex object. +617 """ +618 self._modifiers |= re.MULTILINE +619 return self +620 +621 def with_ascii(self) -> Verbex: +622 """Match ascii instead of unicode. +623 +624 Returns: +625 Modified Verbex object. +626 """ +627 self._modifiers |= re.ASCII +628 return self +629 +630 +631# left over notes from original version +632# def __getattr__(self, attr): +633# """ any other function will be sent to the regex object """ +634# regex = self.regex() +635# return getattr(regex, attr) +636 +637# def replace(self, string, repl): +638# return self.sub(repl, string) +639 +640 +641if __name__ == "__main__": +642 pass @@ -869,8 +897,8 @@

P = ~P - - + +
@@ -885,17 +913,17 @@

View Source - 
48@runtime_checkable
-49class HasIter(Protocol):
-50    """Workaround for mypy P.args."""
-51
-52    def __iter__(self) -> Iterator[Any]:
-53        """Object can be iterated.
-54
-55        Yields:
-56            Next object.
-57        """
-58        ...
+            
49@runtime_checkable
+50class HasIter(Protocol):
+51    """Workaround for mypy P.args."""
+52
+53    def __iter__(self) -> Iterator[Any]:
+54        """Object can be iterated.
+55
+56        Yields:
+57            Next object.
+58        """
+59        ...
@@ -907,7 +935,7 @@

#   - + HasIter(*args, **kwargs)
@@ -944,7 +972,7 @@

- +

@@ -960,17 +988,17 @@

View Source - 
63@runtime_checkable
-64class HasItems(Protocol):
-65    """Workaround for mypy P.kwargs."""
-66
-67    def items(self) -> Tuple[str, Any]:
-68        """Object has items method.
-69
-70        Returns:
-71            The dict of items.
-72        """
-73        ...
+            
64@runtime_checkable
+65class HasItems(Protocol):
+66    """Workaround for mypy P.kwargs."""
+67
+68    def items(self) -> Tuple[str, Any]:
+69        """Object has items method.
+70
+71        Returns:
+72            The dict of items.
+73        """
+74        ...
@@ -982,7 +1010,7 @@

#   - + HasItems(*args, **kwargs)
@@ -1019,26 +1047,26 @@

- +

#   - + def items(self) -> tuple[str, typing.Any]:
View Source - 
67    def items(self) -> Tuple[str, Any]:
-68        """Object has items method.
-69
-70        Returns:
-71            The dict of items.
-72        """
-73        ...
+            
68    def items(self) -> Tuple[str, Any]:
+69        """Object has items method.
+70
+71        Returns:
+72            The dict of items.
+73        """
+74        ...
@@ -1056,30 +1084,30 @@

#   - + class EscapedText(builtins.str):
View Source - 
76class EscapedText(str):
-77    """Text that has been escaped for regex.
-78
-79    Arguments:
-80        str -- Extend the string class.
-81    """
-82
-83    def __new__(cls, value: str) -> EscapedText:
-84        """Return a escaped regex string.
-85
-86        Arguments:
-87            value -- the string to escape
-88
-89        Returns:
-90            _description_
-91        """
-92        return str.__new__(cls, re.escape(value))
+            
77class EscapedText(str):
+78    """Text that has been escaped for regex.
+79
+80    Arguments:
+81        str -- Extend the string class.
+82    """
+83
+84    def __new__(cls, value: str) -> EscapedText:
+85        """Return a escaped regex string.
+86
+87        Arguments:
+88            value -- the string to escape
+89
+90        Returns:
+91            _description_
+92        """
+93        return str.__new__(cls, re.escape(value))
@@ -1094,22 +1122,22 @@

#   - + EscapedText(value: str)
View Source - 
83    def __new__(cls, value: str) -> EscapedText:
-84        """Return a escaped regex string.
-85
-86        Arguments:
-87            value -- the string to escape
-88
-89        Returns:
-90            _description_
-91        """
-92        return str.__new__(cls, re.escape(value))
+            
84    def __new__(cls, value: str) -> EscapedText:
+85        """Return a escaped regex string.
+86
+87        Arguments:
+88            value -- the string to escape
+89
+90        Returns:
+91            _description_
+92        """
+93        return str.__new__(cls, re.escape(value))
@@ -1184,7 +1212,7 @@
Inherited Members
#   - + def re_escape( func: collections.abc.Callable[~P, ~R] @@ -1193,35 +1221,35 @@
Inherited Members
View Source - 
 95def re_escape(func: Callable[P, R]) -> Callable[P, R]:
- 96    """Automatically escape any string parameters as EscapedText.
- 97
- 98    Arguments:
- 99        func -- The function to decorate.
-100
-101    Returns:
-102        The decorated function.
-103    """
-104
-105    @wraps(func)
-106    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
-107        escaped_args: List[Any] = []
-108        escaped_kwargs: Dict[str, Any] = {}
-109        for arg in cast(HasIter, args):
-110            if not isinstance(arg, EscapedText) and isinstance(arg, str):
-111                escaped_args.append(EscapedText(arg))
-112            else:
-113                escaped_args.append(arg)
-114        arg_k: str
-115        arg_v: Any
-116        for arg_k, arg_v in cast(HasItems, kwargs).items():
-117            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
-118                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
-119            else:
-120                escaped_kwargs[arg_k] = arg_v
-121        return func(*escaped_args, **escaped_kwargs)  # type: ignore
-122
-123    return inner
+            
 96def re_escape(func: Callable[P, R]) -> Callable[P, R]:
+ 97    """Automatically escape any string parameters as EscapedText.
+ 98
+ 99    Arguments:
+100        func -- The function to decorate.
+101
+102    Returns:
+103        The decorated function.
+104    """
+105
+106    @wraps(func)
+107    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
+108        escaped_args: List[Any] = []
+109        escaped_kwargs: Dict[str, Any] = {}
+110        for arg in cast(HasIter, args):
+111            if not isinstance(arg, EscapedText) and isinstance(arg, str):
+112                escaped_args.append(EscapedText(arg))
+113            else:
+114                escaped_args.append(arg)
+115        arg_k: str
+116        arg_v: Any
+117        for arg_k, arg_v in cast(HasItems, kwargs).items():
+118            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
+119                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
+120            else:
+121                escaped_kwargs[arg_k] = arg_v
+122        return func(*escaped_args, **escaped_kwargs)  # type: ignore
+123
+124    return inner
@@ -1241,34 +1269,34 @@
Inherited Members
#   - + class CharClass(enum.Enum):
View Source - 
126class CharClass(Enum):
-127    """Enum of character classes in regex.
-128
-129    Arguments:
-130        Enum -- Extends the Enum class.
-131    """
-132
-133    DIGIT = "\\d"
-134    LETTER = "\\w"
-135    UPPERCASE_LETTER = "\\u"
-136    LOWERCASE_LETTER = "\\l"
-137    WHITESPACE = "\\s"
-138    TAB = "\\t"
-139
-140    def __str__(self) -> str:
-141        """To string method based on Enum value.
-142
-143        Returns:
-144            value of Enum
-145        """
-146        return self.value
+            
127class CharClass(Enum):
+128    """Enum of character classes in regex.
+129
+130    Arguments:
+131        Enum -- Extends the Enum class.
+132    """
+133
+134    DIGIT = "\\d"
+135    LETTER = "\\w"
+136    UPPERCASE_LETTER = "\\u"
+137    LOWERCASE_LETTER = "\\l"
+138    WHITESPACE = "\\s"
+139    TAB = "\\t"
+140
+141    def __str__(self) -> str:
+142        """To string method based on Enum value.
+143
+144        Returns:
+145            value of Enum
+146        """
+147        return self.value
@@ -1286,8 +1314,8 @@
Inherited Members
DIGIT = <CharClass.DIGIT: '\\d'>
- - + +
@@ -1296,8 +1324,8 @@
Inherited Members
LETTER = <CharClass.LETTER: '\\w'>
- - + +

@@ -1306,8 +1334,8 @@
Inherited Members
UPPERCASE_LETTER = <CharClass.UPPERCASE_LETTER: '\\u'>
- - + +
@@ -1316,8 +1344,8 @@
Inherited Members
LOWERCASE_LETTER = <CharClass.LOWERCASE_LETTER: '\\l'>
- - + +
@@ -1326,8 +1354,8 @@
Inherited Members
WHITESPACE = <CharClass.WHITESPACE: '\\s'>
- - + +
@@ -1336,8 +1364,8 @@
Inherited Members
TAB = <CharClass.TAB: '\\t'>
- - + +
@@ -1355,33 +1383,33 @@
Inherited Members
#   - + class SpecialChar(enum.Enum):
View Source - 
149class SpecialChar(Enum):
-150    """Enum of special charaters, shorthand.
-151
-152    Arguments:
-153        Enum -- Extends the Enum class.
-154    """
-155
-156    # does not work  / should not be used in [ ]
-157    LINEBREAK = "(\\n|(\\r\\n))"
-158    START_OF_LINE = "^"
-159    END_OF_LINE = "$"
-160    TAB = "\t"
-161
-162    def __str__(self) -> str:
-163        """To string for special chars enum.
-164
-165        Returns:
-166            Return value of enum as string.
-167        """
-168        return self.value
+            
150class SpecialChar(Enum):
+151    """Enum of special charaters, shorthand.
+152
+153    Arguments:
+154        Enum -- Extends the Enum class.
+155    """
+156
+157    # does not work  / should not be used in [ ]
+158    LINEBREAK = "(\\n|(\\r\\n))"
+159    START_OF_LINE = "^"
+160    END_OF_LINE = "$"
+161    TAB = "\t"
+162
+163    def __str__(self) -> str:
+164        """To string for special chars enum.
+165
+166        Returns:
+167            Return value of enum as string.
+168        """
+169        return self.value
@@ -1399,8 +1427,8 @@
Inherited Members
LINEBREAK = <SpecialChar.LINEBREAK: '(\\n|(\\r\\n))'>
- - + +
@@ -1409,8 +1437,8 @@
Inherited Members
START_OF_LINE = <SpecialChar.START_OF_LINE: '^'>
- - + +
@@ -1419,8 +1447,8 @@
Inherited Members
END_OF_LINE = <SpecialChar.END_OF_LINE: '$'>
- - + +
@@ -1429,8 +1457,8 @@
Inherited Members
TAB = <SpecialChar.TAB: '\t'>
- - + +
@@ -1450,8 +1478,8 @@
Inherited Members
CharClassOrChars: TypeAlias = typing.Union[str, verbex.verbex.CharClass]
- - + +
@@ -1460,8 +1488,8 @@
Inherited Members
EscapedCharClassOrSpecial: TypeAlias = typing.Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] - - + +
@@ -1470,454 +1498,454 @@
Inherited Members
VerbexEscapedCharClassOrSpecial: TypeAlias = typing.Union[ForwardRef('Verbex'), str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] - - + +
#   - + class Verbex:
View Source - 
176class Verbex:
-177    """
-178    VerbalExpressions class.
-179
-180    the following methods do not try to match the original js lib!
-181    """
-182
-183    EMPTY_REGEX_FLAG = re.RegexFlag(0)
-184
-185    @re_escape
-186    @beartype
-187    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
-188        """Create a Verbex object; setting any needed flags.
-189
-190        Keyword Arguments:
-191            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
-192        """
-193        # self._parts: List[str] = [text]
-194        self._parts: List[str] = []
-195        self._modifiers = modifiers
-196
-197    @property
-198    def modifiers(self) -> re.RegexFlag:
-199        """Return the modifiers for this Verbex object.
+            
197class Verbex:
+198    """
+199    VerbalExpressions class.
 200
-201        Returns:
-202            The modifiers applied to this object.
-203        """
-204        return self._modifiers
+201    the following methods do not try to match the original js lib!
+202    """
+203
+204    EMPTY_REGEX_FLAG = re.RegexFlag(0)
 205
-206    def __str__(self) -> str:
-207        """Return regex string representation."""
-208        return "".join(self._parts)
-209
-210    @beartype
-211    def _add(self, value: Union[str, List[str]]) -> Verbex:
-212        """
-213        Append a transformed value to internal expression to be compiled.
-214
-215        As possible, this method should be "private".
-216        """
-217        if isinstance(value, list):
-218            self._parts.extend(value)
-219        else:
-220            self._parts.append(value)
-221        return self
-222
-223    def regex(self) -> Pattern[str]:
-224        """Get a regular expression object."""
-225        return re.compile(
-226            str(self),
-227            self._modifiers,
-228        )
-229
-230    # allow VerbexEscapedCharClassOrSpecial
-231
-232    @re_escape
-233    @beartype
-234    def _capture_group_with_name(
-235        self,
-236        name: str,
-237        text: VerbexEscapedCharClassOrSpecial,
-238    ) -> Verbex:
-239        return self._add(f"(?<{name}>{str(text)})")
-240
-241    @re_escape
-242    @beartype
-243    def _capture_group_without_name(
-244        self,
-245        text: VerbexEscapedCharClassOrSpecial,
-246    ) -> Verbex:
-247        return self._add(f"({str(text)})")
-248
-249    @re_escape
-250    @beartype
-251    def capture_group(
-252        self,
-253        /,
-254        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
-255        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
-256    ) -> Verbex:
-257        """Create a capture group.
-258
-259        Name is optional if not specified then the first argument is the text.
-260
-261        Keyword Arguments:
-262            name_or_text -- The name of the group / text to search for (default: {None})
-263            text -- The text to search for (default: {None})
-264
-265        Raises:
-266            ValueError: If name is specified then text must be as well.
-267
-268        Returns:
-269            Verbex with added capture group.
-270        """
-271        if name_or_text is not None:
-272            if text is None:
-273                _text = name_or_text
-274                return self._capture_group_without_name(_text)
-275            if isinstance(name_or_text, str):
-276                return self._capture_group_with_name(name_or_text, text)
-277        raise ValueError("text must be specified with optional name")
-278
-279    @re_escape
-280    @beartype
-281    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
-282        """`or` is a python keyword so we use `OR` instead.
-283
-284        Arguments:
-285            text -- Text to find or a Verbex object.
-286
-287        Returns:
-288            Modified Verbex object.
-289        """
-290        return self._add("|").find(text)
-291
-292    @re_escape
-293    @beartype
-294    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-295        """Find the text or Verbex object zero or more times.
-296
-297        Arguments:
-298            text -- The text / Verbex object to look for.
+206    @re_escape
+207    @beartype
+208    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
+209        """Create a Verbex object; setting any needed flags.
+210
+211        Keyword Arguments:
+212            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
+213        """
+214        # self._parts: List[str] = [text]
+215        self._parts: List[str] = []
+216        self._modifiers = modifiers
+217
+218    @property
+219    def modifiers(self) -> re.RegexFlag:
+220        """Return the modifiers for this Verbex object.
+221
+222        Returns:
+223            The modifiers applied to this object.
+224        """
+225        return self._modifiers
+226
+227    def __str__(self) -> str:
+228        """Return regex string representation."""
+229        return "".join(self._parts)
+230
+231    @beartype
+232    def _add(self, value: Union[str, List[str]]) -> Verbex:
+233        """
+234        Append a transformed value to internal expression to be compiled.
+235
+236        As possible, this method should be "private".
+237        """
+238        if isinstance(value, list):
+239            self._parts.extend(value)
+240        else:
+241            self._parts.append(value)
+242        return self
+243
+244    def regex(self) -> Pattern[str]:
+245        """Get a regular expression object."""
+246        return re.compile(
+247            str(self),
+248            self._modifiers,
+249        )
+250
+251    # allow VerbexEscapedCharClassOrSpecial
+252
+253    @re_escape
+254    @beartype
+255    def _capture_group_with_name(
+256        self,
+257        name: str,
+258        text: VerbexEscapedCharClassOrSpecial,
+259    ) -> Verbex:
+260        return self._add(f"(?<{name}>{str(text)})")
+261
+262    @re_escape
+263    @beartype
+264    def _capture_group_without_name(
+265        self,
+266        text: VerbexEscapedCharClassOrSpecial,
+267    ) -> Verbex:
+268        return self._add(f"({str(text)})")
+269
+270    @re_escape
+271    @beartype
+272    @_poseur_decorator("self")
+273    def capture_group(
+274        self,
+275        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
+276        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
+277    ) -> Verbex:
+278        """Create a capture group.
+279
+280        Name is optional if not specified then the first argument is the text.
+281
+282        Keyword Arguments:
+283            name_or_text -- The name of the group / text to search for (default: {None})
+284            text -- The text to search for (default: {None})
+285
+286        Raises:
+287            ValueError: If name is specified then text must be as well.
+288
+289        Returns:
+290            Verbex with added capture group.
+291        """
+292        if name_or_text is not None:
+293            if text is None:
+294                _text = name_or_text
+295                return self._capture_group_without_name(_text)
+296            if isinstance(name_or_text, str):
+297                return self._capture_group_with_name(name_or_text, text)
+298        raise ValueError("text must be specified with optional name")
 299
-300        Returns:
-301            Modified Verbex object.
-302        """
-303        return self._add(f"(?:{str(text)})*")
+300    @re_escape
+301    @beartype
+302    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
+303        """`or` is a python keyword so we use `OR` instead.
 304
-305    @re_escape
-306    @beartype
-307    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-308        """Find the text or Verbex object one or more times.
-309
-310        Arguments:
-311            text -- The text / Verbex object to look for.
+305        Arguments:
+306            text -- Text to find or a Verbex object.
+307
+308        Returns:
+309            Modified Verbex object.
+310        """
+311        return self._add("|").find(text)
 312
-313        Returns:
-314            Modified Verbex object.
-315        """
-316        return self._add(f"(?:{str(text)})+")
+313    @re_escape
+314    @beartype
+315    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+316        """Find the text or Verbex object zero or more times.
 317
-318    @re_escape
-319    @beartype
-320    def n_times(
-321        self,
-322        text: VerbexEscapedCharClassOrSpecial,
-323        n: int,  # noqa: VNE001
-324    ) -> Verbex:
-325        """Find the text or Verbex object n or more times.
-326
-327        Arguments:
-328            text -- The text / Verbex object to look for.
-329
-330        Returns:
-331            Modified Verbex object.
-332        """
-333        return self._add(f"(?:{str(text)}){{{n}}}")
-334
-335    @re_escape
-336    @beartype
-337    def n_times_or_more(
-338        self,
-339        text: VerbexEscapedCharClassOrSpecial,
-340        n: int,  # noqa: VNE001
-341    ) -> Verbex:
-342        """Find the text or Verbex object at least n times.
-343
-344        Arguments:
-345            text -- The text / Verbex object to look for.
-346
-347        Returns:
-348            Modified Verbex object.
-349        """
-350        return self._add(f"(?:{str(text)}){{{n},}}")
-351
-352    @re_escape
-353    @beartype
-354    def n_to_m_times(
-355        self,
-356        text: VerbexEscapedCharClassOrSpecial,
-357        n: int,  # noqa: VNE001
-358        m: int,  # noqa: VNE001
-359    ) -> Verbex:
-360        """Find the text or Verbex object between n and m times.
-361
-362        Arguments:
-363            text -- The text / Verbex object to look for.
+318        Arguments:
+319            text -- The text / Verbex object to look for.
+320
+321        Returns:
+322            Modified Verbex object.
+323        """
+324        return self._add(f"(?:{str(text)})*")
+325
+326    @re_escape
+327    @beartype
+328    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+329        """Find the text or Verbex object one or more times.
+330
+331        Arguments:
+332            text -- The text / Verbex object to look for.
+333
+334        Returns:
+335            Modified Verbex object.
+336        """
+337        return self._add(f"(?:{str(text)})+")
+338
+339    @re_escape
+340    @beartype
+341    def n_times(
+342        self,
+343        text: VerbexEscapedCharClassOrSpecial,
+344        n: int,  # noqa: VNE001
+345    ) -> Verbex:
+346        """Find the text or Verbex object n or more times.
+347
+348        Arguments:
+349            text -- The text / Verbex object to look for.
+350
+351        Returns:
+352            Modified Verbex object.
+353        """
+354        return self._add(f"(?:{str(text)}){{{n}}}")
+355
+356    @re_escape
+357    @beartype
+358    def n_times_or_more(
+359        self,
+360        text: VerbexEscapedCharClassOrSpecial,
+361        n: int,  # noqa: VNE001
+362    ) -> Verbex:
+363        """Find the text or Verbex object at least n times.
 364
-365        Returns:
-366            Modified Verbex object.
-367        """
-368        return self._add(f"(?:{str(text)}){{{n},{m}}}")
-369
-370    @re_escape
-371    @beartype
-372    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-373        """Possibly find the text / Verbex object.
-374
-375        Arguments:
-376            text -- The text / Verbex object to possibly find.
-377
-378        Returns:
-379            Modified Verbex object.
-380        """
-381        return self._add(f"(?:{str(text)})?")
+365        Arguments:
+366            text -- The text / Verbex object to look for.
+367
+368        Returns:
+369            Modified Verbex object.
+370        """
+371        return self._add(f"(?:{str(text)}){{{n},}}")
+372
+373    @re_escape
+374    @beartype
+375    def n_to_m_times(
+376        self,
+377        text: VerbexEscapedCharClassOrSpecial,
+378        n: int,  # noqa: VNE001
+379        m: int,  # noqa: VNE001
+380    ) -> Verbex:
+381        """Find the text or Verbex object between n and m times.
 382
-383    @re_escape
-384    @beartype
-385    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-386        """Find the text or Verbex object.
-387
-388        Arguments:
-389            text -- The text / Verbex object to look for.
+383        Arguments:
+384            text -- The text / Verbex object to look for.
+385
+386        Returns:
+387            Modified Verbex object.
+388        """
+389        return self._add(f"(?:{str(text)}){{{n},{m}}}")
 390
-391        Returns:
-392            Modified Verbex object.
-393        """
-394        return self._add(str(text))
+391    @re_escape
+392    @beartype
+393    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+394        """Possibly find the text / Verbex object.
 395
-396    @re_escape
-397    @beartype
-398    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-399        """Synonym for find.
-400
-401        Arguments:
-402            text -- The text / Verbex object to look for.
+396        Arguments:
+397            text -- The text / Verbex object to possibly find.
+398
+399        Returns:
+400            Modified Verbex object.
+401        """
+402        return self._add(f"(?:{str(text)})?")
 403
-404        Returns:
-405            Modified Verbex object.
-406        """
-407        return self.find(text)
+404    @re_escape
+405    @beartype
+406    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+407        """Find the text or Verbex object.
 408
-409    @re_escape
-410    @beartype
-411    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-412        """Match if string is followed by text.
-413
-414        Positive lookahead
-415
-416        Returns:
-417            Modified Verbex object.
-418        """
-419        return self._add(f"(?={text})")
-420
-421    @re_escape
-422    @beartype
-423    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-424        """Match if string is not followed by text.
-425
-426        Negative lookahead
-427
-428        Returns:
-429            Modified Verbex object.
-430        """
-431        return self._add(f"(?!{text})")
-432
-433    @re_escape
-434    @beartype
-435    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-436        """Match if string is not preceded by text.
-437
-438        Positive lookbehind
-439
-440        Returns:
-441            Modified Verbex object.
-442        """
-443        return self._add(f"(?<={text})")
-444
-445    @re_escape
-446    @beartype
-447    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-448        """Match if string is not preceded by text.
-449
-450        Negative Lookbehind
-451
-452        Returns:
-453            Modified Verbex object.
-454        """
-455        return self._add(f"(?<!{text})")
-456
-457    # only allow CharclassOrChars
+409        Arguments:
+410            text -- The text / Verbex object to look for.
+411
+412        Returns:
+413            Modified Verbex object.
+414        """
+415        return self._add(str(text))
+416
+417    @re_escape
+418    @beartype
+419    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+420        """Synonym for find.
+421
+422        Arguments:
+423            text -- The text / Verbex object to look for.
+424
+425        Returns:
+426            Modified Verbex object.
+427        """
+428        return self.find(text)
+429
+430    @re_escape
+431    @beartype
+432    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+433        """Match if string is followed by text.
+434
+435        Positive lookahead
+436
+437        Returns:
+438            Modified Verbex object.
+439        """
+440        return self._add(f"(?={text})")
+441
+442    @re_escape
+443    @beartype
+444    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+445        """Match if string is not followed by text.
+446
+447        Negative lookahead
+448
+449        Returns:
+450            Modified Verbex object.
+451        """
+452        return self._add(f"(?!{text})")
+453
+454    @re_escape
+455    @beartype
+456    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+457        """Match if string is not preceded by text.
 458
-459    @re_escape
-460    @beartype
-461    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
-462        """Find anything in this group of chars or char class.
-463
-464        Arguments:
-465            text -- The characters to look for.
-466
-467        Returns:
-468            Modified Verbex object.
-469        """
-470        return self._add(f"(?:[{chargroup}])")
-471
-472    @re_escape
-473    @beartype
-474    def not_any_of(self, text: CharClassOrChars) -> Verbex:
-475        """Find anything but this group of chars or char class.
-476
-477        Arguments:
-478            text -- The characters to not look for.
+459        Positive lookbehind
+460
+461        Returns:
+462            Modified Verbex object.
+463        """
+464        return self._add(f"(?<={text})")
+465
+466    @re_escape
+467    @beartype
+468    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+469        """Match if string is not preceded by text.
+470
+471        Negative Lookbehind
+472
+473        Returns:
+474            Modified Verbex object.
+475        """
+476        return self._add(f"(?<!{text})")
+477
+478    # only allow CharclassOrChars
 479
-480        Returns:
-481            Modified Verbex object.
-482        """
-483        return self._add(f"(?:[^{text}])")
+480    @re_escape
+481    @beartype
+482    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
+483        """Find anything in this group of chars or char class.
 484
-485    @re_escape
-486    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
-487        """Find anything one or more times but this group of chars or char class.
-488
-489        Arguments:
-490            text -- The characters to not look for.
-491
-492        Returns:
-493            Modified Verbex object.
-494        """
-495        return self._add(f"[^{chargroup}]+")
-496
-497    # no text input
-498
-499    def start_of_line(self) -> Verbex:
-500        """Find the start of the line.
-501
-502        Returns:
-503            Modified Verbex object.
-504        """
-505        return self.find(SpecialChar.START_OF_LINE)
-506
-507    def end_of_line(self) -> Verbex:
-508        """Find the end of the line.
+485        Arguments:
+486            text -- The characters to look for.
+487
+488        Returns:
+489            Modified Verbex object.
+490        """
+491        return self._add(f"(?:[{chargroup}])")
+492
+493    @re_escape
+494    @beartype
+495    def not_any_of(self, text: CharClassOrChars) -> Verbex:
+496        """Find anything but this group of chars or char class.
+497
+498        Arguments:
+499            text -- The characters to not look for.
+500
+501        Returns:
+502            Modified Verbex object.
+503        """
+504        return self._add(f"(?:[^{text}])")
+505
+506    @re_escape
+507    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
+508        """Find anything one or more times but this group of chars or char class.
 509
-510        Returns:
-511            Modified Verbex object.
-512        """
-513        return self.find(SpecialChar.END_OF_LINE)
-514
-515    def line_break(self) -> Verbex:
-516        """Find a line break.
+510        Arguments:
+511            text -- The characters to not look for.
+512
+513        Returns:
+514            Modified Verbex object.
+515        """
+516        return self._add(f"[^{chargroup}]+")
 517
-518        Returns:
-519            Modified Verbex object.
-520        """
-521        return self.find(SpecialChar.LINEBREAK)
+518    # no text input
+519
+520    def start_of_line(self) -> Verbex:
+521        """Find the start of the line.
 522
-523    def tab(self) -> Verbex:
-524        """Find a tab.
-525
-526        Returns:
-527            Modified Verbex object.
-528        """
-529        return self.find(SpecialChar.TAB)
+523        Returns:
+524            Modified Verbex object.
+525        """
+526        return self.find(SpecialChar.START_OF_LINE)
+527
+528    def end_of_line(self) -> Verbex:
+529        """Find the end of the line.
 530
-531    def anything(self) -> Verbex:
-532        """Find anything one or more time.
-533
-534        Returns:
-535            Modified Verbex object.
-536        """
-537        return self._add(".+")
+531        Returns:
+532            Modified Verbex object.
+533        """
+534        return self.find(SpecialChar.END_OF_LINE)
+535
+536    def line_break(self) -> Verbex:
+537        """Find a line break.
 538
-539    def as_few(self) -> Verbex:
-540        """Modify previous search to not be greedy.
-541
-542        Returns:
-543            Modified Verbex object.
-544        """
-545        return self._add("?")
+539        Returns:
+540            Modified Verbex object.
+541        """
+542        return self.find(SpecialChar.LINEBREAK)
+543
+544    def tab(self) -> Verbex:
+545        """Find a tab.
 546
-547    @beartype
-548    def number_range(self, start: int, end: int) -> Verbex:
-549        """Generate a range of numbers.
-550
-551        Arguments:
-552            start -- Start of the range
-553            end -- End of the range
+547        Returns:
+548            Modified Verbex object.
+549        """
+550        return self.find(SpecialChar.TAB)
+551
+552    def anything(self) -> Verbex:
+553        """Find anything one or more time.
 554
 555        Returns:
 556            Modified Verbex object.
 557        """
-558        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
+558        return self._add(".+")
 559
-560    @beartype
-561    def letter_range(self, start: Char, end: Char) -> Verbex:
-562        """Generate a range of letters.
-563
-564        Arguments:
-565            start -- Start of the range
-566            end -- End of the range
+560    def as_few(self) -> Verbex:
+561        """Modify previous search to not be greedy.
+562
+563        Returns:
+564            Modified Verbex object.
+565        """
+566        return self._add("?")
 567
-568        Returns:
-569            Modified Verbex object.
-570        """
-571        return self._add(f"[{start}-{end}]")
-572
-573    def word(self) -> Verbex:
-574        """Find a word on word boundary.
+568    @beartype
+569    def number_range(self, start: int, end: int) -> Verbex:
+570        """Generate a range of numbers.
+571
+572        Arguments:
+573            start -- Start of the range
+574            end -- End of the range
 575
 576        Returns:
 577            Modified Verbex object.
 578        """
-579        return self._add("(\\b\\w+\\b)")
+579        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
 580
-581    # # --------------- modifiers ------------------------
-582
-583    def with_any_case(self) -> Verbex:
-584        """Modify Verbex object to be case insensitive.
-585
-586        Returns:
-587            Modified Verbex object.
-588        """
-589        self._modifiers |= re.IGNORECASE
-590        return self
-591
-592    def search_by_line(self) -> Verbex:
-593        """Search each line, ^ and $ match begining and end of line respectively.
-594
-595        Returns:
-596            Modified Verbex object.
-597        """
-598        self._modifiers |= re.MULTILINE
-599        return self
-600
-601    def with_ascii(self) -> Verbex:
-602        """Match ascii instead of unicode.
+581    @beartype
+582    def letter_range(self, start: Char, end: Char) -> Verbex:
+583        """Generate a range of letters.
+584
+585        Arguments:
+586            start -- Start of the range
+587            end -- End of the range
+588
+589        Returns:
+590            Modified Verbex object.
+591        """
+592        return self._add(f"[{start}-{end}]")
+593
+594    def word(self) -> Verbex:
+595        """Find a word on word boundary.
+596
+597        Returns:
+598            Modified Verbex object.
+599        """
+600        return self._add("(\\b\\w+\\b)")
+601
+602    # # --------------- modifiers ------------------------
 603
-604        Returns:
-605            Modified Verbex object.
-606        """
-607        self._modifiers |= re.ASCII
-608        return self
+604    def with_any_case(self) -> Verbex:
+605        """Modify Verbex object to be case insensitive.
+606
+607        Returns:
+608            Modified Verbex object.
+609        """
+610        self._modifiers |= re.IGNORECASE
+611        return self
+612
+613    def search_by_line(self) -> Verbex:
+614        """Search each line, ^ and $ match begining and end of line respectively.
+615
+616        Returns:
+617            Modified Verbex object.
+618        """
+619        self._modifiers |= re.MULTILINE
+620        return self
+621
+622    def with_ascii(self) -> Verbex:
+623        """Match ascii instead of unicode.
+624
+625        Returns:
+626            Modified Verbex object.
+627        """
+628        self._modifiers |= re.ASCII
+629        return self
@@ -1939,17 +1967,17 @@
Inherited Members
View Source - 
185    @re_escape
-186    @beartype
-187    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
-188        """Create a Verbex object; setting any needed flags.
-189
-190        Keyword Arguments:
-191            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
-192        """
-193        # self._parts: List[str] = [text]
-194        self._parts: List[str] = []
-195        self._modifiers = modifiers
+            
206    @re_escape
+207    @beartype
+208    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
+209        """Create a Verbex object; setting any needed flags.
+210
+211        Keyword Arguments:
+212            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
+213        """
+214        # self._parts: List[str] = [text]
+215        self._parts: List[str] = []
+216        self._modifiers = modifiers
@@ -1968,8 +1996,8 @@
Inherited Members
EMPTY_REGEX_FLAG = - - + +
@@ -1978,7 +2006,7 @@
Inherited Members
modifiers: re.RegexFlag
- +

Return the modifiers for this Verbex object.

Returns: @@ -1990,19 +2018,19 @@

Inherited Members
#   - + def regex(self) -> Pattern[str]:
View Source - 
223    def regex(self) -> Pattern[str]:
-224        """Get a regular expression object."""
-225        return re.compile(
-226            str(self),
-227            self._modifiers,
-228        )
+            
244    def regex(self) -> Pattern[str]:
+245        """Get a regular expression object."""
+246        return re.compile(
+247            str(self),
+248            self._modifiers,
+249        )
@@ -2021,7 +2049,6 @@
Inherited Members
def capture_group( self, - /, name_or_text: Union[str, NoneType, verbex.verbex.Verbex, verbex.verbex.CharClass, verbex.verbex.SpecialChar] = None, text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar, NoneType] = None ) -> verbex.verbex.Verbex: @@ -2029,35 +2056,35 @@
Inherited Members
View Source - 
249    @re_escape
-250    @beartype
-251    def capture_group(
-252        self,
-253        /,
-254        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
-255        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
-256    ) -> Verbex:
-257        """Create a capture group.
-258
-259        Name is optional if not specified then the first argument is the text.
-260
-261        Keyword Arguments:
-262            name_or_text -- The name of the group / text to search for (default: {None})
-263            text -- The text to search for (default: {None})
-264
-265        Raises:
-266            ValueError: If name is specified then text must be as well.
-267
-268        Returns:
-269            Verbex with added capture group.
-270        """
-271        if name_or_text is not None:
-272            if text is None:
-273                _text = name_or_text
-274                return self._capture_group_without_name(_text)
-275            if isinstance(name_or_text, str):
-276                return self._capture_group_with_name(name_or_text, text)
-277        raise ValueError("text must be specified with optional name")
+            
270    @re_escape
+271    @beartype
+272    @_poseur_decorator("self")
+273    def capture_group(
+274        self,
+275        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
+276        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
+277    ) -> Verbex:
+278        """Create a capture group.
+279
+280        Name is optional if not specified then the first argument is the text.
+281
+282        Keyword Arguments:
+283            name_or_text -- The name of the group / text to search for (default: {None})
+284            text -- The text to search for (default: {None})
+285
+286        Raises:
+287            ValueError: If name is specified then text must be as well.
+288
+289        Returns:
+290            Verbex with added capture group.
+291        """
+292        if name_or_text is not None:
+293            if text is None:
+294                _text = name_or_text
+295                return self._capture_group_without_name(_text)
+296            if isinstance(name_or_text, str):
+297                return self._capture_group_with_name(name_or_text, text)
+298        raise ValueError("text must be specified with optional name")
@@ -2094,18 +2121,18 @@
Inherited Members
View Source - 
279    @re_escape
-280    @beartype
-281    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
-282        """`or` is a python keyword so we use `OR` instead.
-283
-284        Arguments:
-285            text -- Text to find or a Verbex object.
-286
-287        Returns:
-288            Modified Verbex object.
-289        """
-290        return self._add("|").find(text)
+            
300    @re_escape
+301    @beartype
+302    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
+303        """`or` is a python keyword so we use `OR` instead.
+304
+305        Arguments:
+306            text -- Text to find or a Verbex object.
+307
+308        Returns:
+309            Modified Verbex object.
+310        """
+311        return self._add("|").find(text)
@@ -2136,18 +2163,18 @@
Inherited Members
View Source - 
292    @re_escape
-293    @beartype
-294    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-295        """Find the text or Verbex object zero or more times.
-296
-297        Arguments:
-298            text -- The text / Verbex object to look for.
-299
-300        Returns:
-301            Modified Verbex object.
-302        """
-303        return self._add(f"(?:{str(text)})*")
+            
313    @re_escape
+314    @beartype
+315    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+316        """Find the text or Verbex object zero or more times.
+317
+318        Arguments:
+319            text -- The text / Verbex object to look for.
+320
+321        Returns:
+322            Modified Verbex object.
+323        """
+324        return self._add(f"(?:{str(text)})*")
@@ -2178,18 +2205,18 @@
Inherited Members
View Source - 
305    @re_escape
-306    @beartype
-307    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-308        """Find the text or Verbex object one or more times.
-309
-310        Arguments:
-311            text -- The text / Verbex object to look for.
-312
-313        Returns:
-314            Modified Verbex object.
-315        """
-316        return self._add(f"(?:{str(text)})+")
+            
326    @re_escape
+327    @beartype
+328    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+329        """Find the text or Verbex object one or more times.
+330
+331        Arguments:
+332            text -- The text / Verbex object to look for.
+333
+334        Returns:
+335            Modified Verbex object.
+336        """
+337        return self._add(f"(?:{str(text)})+")
@@ -2221,22 +2248,22 @@
Inherited Members
View Source - 
318    @re_escape
-319    @beartype
-320    def n_times(
-321        self,
-322        text: VerbexEscapedCharClassOrSpecial,
-323        n: int,  # noqa: VNE001
-324    ) -> Verbex:
-325        """Find the text or Verbex object n or more times.
-326
-327        Arguments:
-328            text -- The text / Verbex object to look for.
-329
-330        Returns:
-331            Modified Verbex object.
-332        """
-333        return self._add(f"(?:{str(text)}){{{n}}}")
+            
339    @re_escape
+340    @beartype
+341    def n_times(
+342        self,
+343        text: VerbexEscapedCharClassOrSpecial,
+344        n: int,  # noqa: VNE001
+345    ) -> Verbex:
+346        """Find the text or Verbex object n or more times.
+347
+348        Arguments:
+349            text -- The text / Verbex object to look for.
+350
+351        Returns:
+352            Modified Verbex object.
+353        """
+354        return self._add(f"(?:{str(text)}){{{n}}}")
@@ -2268,22 +2295,22 @@
Inherited Members
View Source - 
335    @re_escape
-336    @beartype
-337    def n_times_or_more(
-338        self,
-339        text: VerbexEscapedCharClassOrSpecial,
-340        n: int,  # noqa: VNE001
-341    ) -> Verbex:
-342        """Find the text or Verbex object at least n times.
-343
-344        Arguments:
-345            text -- The text / Verbex object to look for.
-346
-347        Returns:
-348            Modified Verbex object.
-349        """
-350        return self._add(f"(?:{str(text)}){{{n},}}")
+            
356    @re_escape
+357    @beartype
+358    def n_times_or_more(
+359        self,
+360        text: VerbexEscapedCharClassOrSpecial,
+361        n: int,  # noqa: VNE001
+362    ) -> Verbex:
+363        """Find the text or Verbex object at least n times.
+364
+365        Arguments:
+366            text -- The text / Verbex object to look for.
+367
+368        Returns:
+369            Modified Verbex object.
+370        """
+371        return self._add(f"(?:{str(text)}){{{n},}}")
@@ -2316,23 +2343,23 @@
Inherited Members
View Source - 
352    @re_escape
-353    @beartype
-354    def n_to_m_times(
-355        self,
-356        text: VerbexEscapedCharClassOrSpecial,
-357        n: int,  # noqa: VNE001
-358        m: int,  # noqa: VNE001
-359    ) -> Verbex:
-360        """Find the text or Verbex object between n and m times.
-361
-362        Arguments:
-363            text -- The text / Verbex object to look for.
-364
-365        Returns:
-366            Modified Verbex object.
-367        """
-368        return self._add(f"(?:{str(text)}){{{n},{m}}}")
+            
373    @re_escape
+374    @beartype
+375    def n_to_m_times(
+376        self,
+377        text: VerbexEscapedCharClassOrSpecial,
+378        n: int,  # noqa: VNE001
+379        m: int,  # noqa: VNE001
+380    ) -> Verbex:
+381        """Find the text or Verbex object between n and m times.
+382
+383        Arguments:
+384            text -- The text / Verbex object to look for.
+385
+386        Returns:
+387            Modified Verbex object.
+388        """
+389        return self._add(f"(?:{str(text)}){{{n},{m}}}")
@@ -2363,18 +2390,18 @@
Inherited Members
View Source - 
370    @re_escape
-371    @beartype
-372    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-373        """Possibly find the text / Verbex object.
-374
-375        Arguments:
-376            text -- The text / Verbex object to possibly find.
-377
-378        Returns:
-379            Modified Verbex object.
-380        """
-381        return self._add(f"(?:{str(text)})?")
+            
391    @re_escape
+392    @beartype
+393    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+394        """Possibly find the text / Verbex object.
+395
+396        Arguments:
+397            text -- The text / Verbex object to possibly find.
+398
+399        Returns:
+400            Modified Verbex object.
+401        """
+402        return self._add(f"(?:{str(text)})?")
@@ -2405,18 +2432,18 @@
Inherited Members
View Source - 
383    @re_escape
-384    @beartype
-385    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-386        """Find the text or Verbex object.
-387
-388        Arguments:
-389            text -- The text / Verbex object to look for.
-390
-391        Returns:
-392            Modified Verbex object.
-393        """
-394        return self._add(str(text))
+            
404    @re_escape
+405    @beartype
+406    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+407        """Find the text or Verbex object.
+408
+409        Arguments:
+410            text -- The text / Verbex object to look for.
+411
+412        Returns:
+413            Modified Verbex object.
+414        """
+415        return self._add(str(text))
@@ -2447,18 +2474,18 @@
Inherited Members
View Source - 
396    @re_escape
-397    @beartype
-398    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-399        """Synonym for find.
-400
-401        Arguments:
-402            text -- The text / Verbex object to look for.
-403
-404        Returns:
-405            Modified Verbex object.
-406        """
-407        return self.find(text)
+            
417    @re_escape
+418    @beartype
+419    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+420        """Synonym for find.
+421
+422        Arguments:
+423            text -- The text / Verbex object to look for.
+424
+425        Returns:
+426            Modified Verbex object.
+427        """
+428        return self.find(text)
@@ -2489,17 +2516,17 @@
Inherited Members
View Source - 
409    @re_escape
-410    @beartype
-411    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-412        """Match if string is followed by text.
-413
-414        Positive lookahead
-415
-416        Returns:
-417            Modified Verbex object.
-418        """
-419        return self._add(f"(?={text})")
+            
430    @re_escape
+431    @beartype
+432    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+433        """Match if string is followed by text.
+434
+435        Positive lookahead
+436
+437        Returns:
+438            Modified Verbex object.
+439        """
+440        return self._add(f"(?={text})")
@@ -2529,17 +2556,17 @@
Inherited Members
View Source - 
421    @re_escape
-422    @beartype
-423    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-424        """Match if string is not followed by text.
-425
-426        Negative lookahead
-427
-428        Returns:
-429            Modified Verbex object.
-430        """
-431        return self._add(f"(?!{text})")
+            
442    @re_escape
+443    @beartype
+444    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+445        """Match if string is not followed by text.
+446
+447        Negative lookahead
+448
+449        Returns:
+450            Modified Verbex object.
+451        """
+452        return self._add(f"(?!{text})")
@@ -2569,17 +2596,17 @@
Inherited Members
View Source - 
433    @re_escape
-434    @beartype
-435    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-436        """Match if string is not preceded by text.
-437
-438        Positive lookbehind
-439
-440        Returns:
-441            Modified Verbex object.
-442        """
-443        return self._add(f"(?<={text})")
+            
454    @re_escape
+455    @beartype
+456    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+457        """Match if string is not preceded by text.
+458
+459        Positive lookbehind
+460
+461        Returns:
+462            Modified Verbex object.
+463        """
+464        return self._add(f"(?<={text})")
@@ -2609,17 +2636,17 @@
Inherited Members
View Source - 
445    @re_escape
-446    @beartype
-447    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-448        """Match if string is not preceded by text.
-449
-450        Negative Lookbehind
-451
-452        Returns:
-453            Modified Verbex object.
-454        """
-455        return self._add(f"(?<!{text})")
+            
466    @re_escape
+467    @beartype
+468    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+469        """Match if string is not preceded by text.
+470
+471        Negative Lookbehind
+472
+473        Returns:
+474            Modified Verbex object.
+475        """
+476        return self._add(f"(?<!{text})")
@@ -2649,18 +2676,18 @@
Inherited Members
View Source - 
459    @re_escape
-460    @beartype
-461    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
-462        """Find anything in this group of chars or char class.
-463
-464        Arguments:
-465            text -- The characters to look for.
-466
-467        Returns:
-468            Modified Verbex object.
-469        """
-470        return self._add(f"(?:[{chargroup}])")
+            
480    @re_escape
+481    @beartype
+482    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
+483        """Find anything in this group of chars or char class.
+484
+485        Arguments:
+486            text -- The characters to look for.
+487
+488        Returns:
+489            Modified Verbex object.
+490        """
+491        return self._add(f"(?:[{chargroup}])")
@@ -2691,18 +2718,18 @@
Inherited Members
View Source - 
472    @re_escape
-473    @beartype
-474    def not_any_of(self, text: CharClassOrChars) -> Verbex:
-475        """Find anything but this group of chars or char class.
-476
-477        Arguments:
-478            text -- The characters to not look for.
-479
-480        Returns:
-481            Modified Verbex object.
-482        """
-483        return self._add(f"(?:[^{text}])")
+            
493    @re_escape
+494    @beartype
+495    def not_any_of(self, text: CharClassOrChars) -> Verbex:
+496        """Find anything but this group of chars or char class.
+497
+498        Arguments:
+499            text -- The characters to not look for.
+500
+501        Returns:
+502            Modified Verbex object.
+503        """
+504        return self._add(f"(?:[^{text}])")
@@ -2732,17 +2759,17 @@
Inherited Members
View Source - 
485    @re_escape
-486    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
-487        """Find anything one or more times but this group of chars or char class.
-488
-489        Arguments:
-490            text -- The characters to not look for.
-491
-492        Returns:
-493            Modified Verbex object.
-494        """
-495        return self._add(f"[^{chargroup}]+")
+            
506    @re_escape
+507    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
+508        """Find anything one or more times but this group of chars or char class.
+509
+510        Arguments:
+511            text -- The characters to not look for.
+512
+513        Returns:
+514            Modified Verbex object.
+515        """
+516        return self._add(f"[^{chargroup}]+")
@@ -2761,20 +2788,20 @@
Inherited Members
#   - + def start_of_line(self) -> verbex.verbex.Verbex:
View Source - 
499    def start_of_line(self) -> Verbex:
-500        """Find the start of the line.
-501
-502        Returns:
-503            Modified Verbex object.
-504        """
-505        return self.find(SpecialChar.START_OF_LINE)
+            
520    def start_of_line(self) -> Verbex:
+521        """Find the start of the line.
+522
+523        Returns:
+524            Modified Verbex object.
+525        """
+526        return self.find(SpecialChar.START_OF_LINE)
@@ -2790,20 +2817,20 @@
Inherited Members
#   - + def end_of_line(self) -> verbex.verbex.Verbex:
View Source - 
507    def end_of_line(self) -> Verbex:
-508        """Find the end of the line.
-509
-510        Returns:
-511            Modified Verbex object.
-512        """
-513        return self.find(SpecialChar.END_OF_LINE)
+            
528    def end_of_line(self) -> Verbex:
+529        """Find the end of the line.
+530
+531        Returns:
+532            Modified Verbex object.
+533        """
+534        return self.find(SpecialChar.END_OF_LINE)
@@ -2819,20 +2846,20 @@
Inherited Members
#   - + def line_break(self) -> verbex.verbex.Verbex:
View Source - 
515    def line_break(self) -> Verbex:
-516        """Find a line break.
-517
-518        Returns:
-519            Modified Verbex object.
-520        """
-521        return self.find(SpecialChar.LINEBREAK)
+            
536    def line_break(self) -> Verbex:
+537        """Find a line break.
+538
+539        Returns:
+540            Modified Verbex object.
+541        """
+542        return self.find(SpecialChar.LINEBREAK)
@@ -2848,20 +2875,20 @@
Inherited Members
#   - + def tab(self) -> verbex.verbex.Verbex:
View Source - 
523    def tab(self) -> Verbex:
-524        """Find a tab.
-525
-526        Returns:
-527            Modified Verbex object.
-528        """
-529        return self.find(SpecialChar.TAB)
+            
544    def tab(self) -> Verbex:
+545        """Find a tab.
+546
+547        Returns:
+548            Modified Verbex object.
+549        """
+550        return self.find(SpecialChar.TAB)
@@ -2877,20 +2904,20 @@
Inherited Members
#   - + def anything(self) -> verbex.verbex.Verbex:
View Source - 
531    def anything(self) -> Verbex:
-532        """Find anything one or more time.
-533
-534        Returns:
-535            Modified Verbex object.
-536        """
-537        return self._add(".+")
+            
552    def anything(self) -> Verbex:
+553        """Find anything one or more time.
+554
+555        Returns:
+556            Modified Verbex object.
+557        """
+558        return self._add(".+")
@@ -2906,20 +2933,20 @@
Inherited Members
#   - + def as_few(self) -> verbex.verbex.Verbex:
View Source - 
539    def as_few(self) -> Verbex:
-540        """Modify previous search to not be greedy.
-541
-542        Returns:
-543            Modified Verbex object.
-544        """
-545        return self._add("?")
+            
560    def as_few(self) -> Verbex:
+561        """Modify previous search to not be greedy.
+562
+563        Returns:
+564            Modified Verbex object.
+565        """
+566        return self._add("?")
@@ -2943,18 +2970,18 @@
Inherited Members
View Source - 
547    @beartype
-548    def number_range(self, start: int, end: int) -> Verbex:
-549        """Generate a range of numbers.
-550
-551        Arguments:
-552            start -- Start of the range
-553            end -- End of the range
-554
-555        Returns:
-556            Modified Verbex object.
-557        """
-558        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
+            
568    @beartype
+569    def number_range(self, start: int, end: int) -> Verbex:
+570        """Generate a range of numbers.
+571
+572        Arguments:
+573            start -- Start of the range
+574            end -- End of the range
+575
+576        Returns:
+577            Modified Verbex object.
+578        """
+579        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
@@ -2986,18 +3013,18 @@
Inherited Members
View Source - 
560    @beartype
-561    def letter_range(self, start: Char, end: Char) -> Verbex:
-562        """Generate a range of letters.
-563
-564        Arguments:
-565            start -- Start of the range
-566            end -- End of the range
-567
-568        Returns:
-569            Modified Verbex object.
-570        """
-571        return self._add(f"[{start}-{end}]")
+            
581    @beartype
+582    def letter_range(self, start: Char, end: Char) -> Verbex:
+583        """Generate a range of letters.
+584
+585        Arguments:
+586            start -- Start of the range
+587            end -- End of the range
+588
+589        Returns:
+590            Modified Verbex object.
+591        """
+592        return self._add(f"[{start}-{end}]")
@@ -3017,20 +3044,20 @@
Inherited Members
#   - + def word(self) -> verbex.verbex.Verbex:
View Source - 
573    def word(self) -> Verbex:
-574        """Find a word on word boundary.
-575
-576        Returns:
-577            Modified Verbex object.
-578        """
-579        return self._add("(\\b\\w+\\b)")
+            
594    def word(self) -> Verbex:
+595        """Find a word on word boundary.
+596
+597        Returns:
+598            Modified Verbex object.
+599        """
+600        return self._add("(\\b\\w+\\b)")
@@ -3046,21 +3073,21 @@
Inherited Members
#   - + def with_any_case(self) -> verbex.verbex.Verbex:
View Source - 
583    def with_any_case(self) -> Verbex:
-584        """Modify Verbex object to be case insensitive.
-585
-586        Returns:
-587            Modified Verbex object.
-588        """
-589        self._modifiers |= re.IGNORECASE
-590        return self
+            
604    def with_any_case(self) -> Verbex:
+605        """Modify Verbex object to be case insensitive.
+606
+607        Returns:
+608            Modified Verbex object.
+609        """
+610        self._modifiers |= re.IGNORECASE
+611        return self
@@ -3076,21 +3103,21 @@
Inherited Members
#   - + def search_by_line(self) -> verbex.verbex.Verbex:
View Source - 
592    def search_by_line(self) -> Verbex:
-593        """Search each line, ^ and $ match begining and end of line respectively.
-594
-595        Returns:
-596            Modified Verbex object.
-597        """
-598        self._modifiers |= re.MULTILINE
-599        return self
+            
613    def search_by_line(self) -> Verbex:
+614        """Search each line, ^ and $ match begining and end of line respectively.
+615
+616        Returns:
+617            Modified Verbex object.
+618        """
+619        self._modifiers |= re.MULTILINE
+620        return self
@@ -3106,21 +3133,21 @@
Inherited Members
#   - + def with_ascii(self) -> verbex.verbex.Verbex:
View Source - 
601    def with_ascii(self) -> Verbex:
-602        """Match ascii instead of unicode.
-603
-604        Returns:
-605            Modified Verbex object.
-606        """
-607        self._modifiers |= re.ASCII
-608        return self
+            
622    def with_ascii(self) -> Verbex:
+623        """Match ascii instead of unicode.
+624
+625        Returns:
+626            Modified Verbex object.
+627        """
+628        self._modifiers |= re.ASCII
+629        return self
@@ -3135,5 +3162,182 @@
Inherited Members
- - + + \ No newline at end of file diff --git a/requirements.in b/requirements.in index f8fe16b..07ac3c6 100644 --- a/requirements.in +++ b/requirements.in @@ -1,2 +1,3 @@ beartype typing-extensions +importlib-metadata; python_version < '3.7' diff --git a/requirements_dev.in b/requirements_dev.in index 29b6f24..31f1e1e 100644 --- a/requirements_dev.in +++ b/requirements_dev.in @@ -2,3 +2,4 @@ tox mypy>=0.950 black pre-commit +pdoc diff --git a/requirements_dev.txt b/requirements_dev.txt index 520c051..ef02568 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -22,6 +22,12 @@ filelock==3.6.0 # virtualenv identify==2.5.0 # via pre-commit +jinja2==3.1.2 + # via pdoc +markupsafe==2.1.1 + # via + # jinja2 + # pdoc mypy==0.950 # via -r requirements_dev.in mypy-extensions==0.4.3 @@ -34,6 +40,8 @@ packaging==21.3 # via tox pathspec==0.9.0 # via black +pdoc==11.2.0 + # via -r requirements_dev.in platformdirs==2.5.2 # via # black @@ -44,6 +52,8 @@ pre-commit==2.19.0 # via -r requirements_dev.in py==1.11.0 # via tox +pygments==2.12.0 + # via pdoc pyparsing==3.0.8 # via packaging pyyaml==6.0 diff --git a/requirements_test.txt b/requirements_test.txt index f52ea7a..37fcfa7 100644 --- a/requirements_test.txt +++ b/requirements_test.txt @@ -1,3 +1,4 @@ tox typing-extensions beartype +importlib-metadata; python_version < '3.7' diff --git a/setup.cfg b/setup.cfg index bf83e77..a957fff 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = Verbex -version = 1.1.0 +version = 1.2.0 author = Victor Titor, Yan Wenjun, diogobeda, Mihai Ionut Vilcu, Peder Soholt, Sameer Raghuram, Kharms, Richard Broderick license = GPLv3 description = Make difficult regular expressions easy! Python fork based on of the awesome VerbalExpressions repo - https://github.com/jehna/VerbalExpressions diff --git a/verbex/__init__.py b/verbex/__init__.py index fa3bafc..566fb9a 100644 --- a/verbex/__init__.py +++ b/verbex/__init__.py @@ -1,3 +1,7 @@ +import importlib.metadata + from .verbex import CharClass as CharClass from .verbex import SpecialChar as SpecialChar from .verbex import Verbex as Verbex + +__version__ = importlib.metadata.version("verbex") From 2af09a04b35e2eae6ad9569a5ae6c118a9eb2c2c Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 17:25:40 -0400 Subject: [PATCH 52/85] added auto doc generate pre-commit hook --- .pre-commit-config.yaml | 1 + docs/index.html | 7 - docs/search.js | 46 - docs/verbex.html | 238 --- docs/verbex/verbex.html | 3343 --------------------------------------- 5 files changed, 1 insertion(+), 3634 deletions(-) delete mode 100644 docs/index.html delete mode 100644 docs/search.js delete mode 100644 docs/verbex.html delete mode 100644 docs/verbex/verbex.html diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index fdf4b5d..1f73439 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -213,3 +213,4 @@ repos: pass_filenames: false additional_dependencies: - beartype + stages: [post-commit] diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 97569ec..0000000 --- a/docs/index.html +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - diff --git a/docs/search.js b/docs/search.js deleted file mode 100644 index 87f83cf..0000000 --- a/docs/search.js +++ /dev/null @@ -1,46 +0,0 @@ -window.pdocSearch = (function(){ -/** elasticlunr - http://weixsong.github.io * Copyright (C) 2017 Oliver Nightingale * Copyright (C) 2017 Wei Song * MIT Licensed */!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u0&&t.push(e);for(var i in n)"docs"!==i&&"df"!==i&&this.expandToken(e+i,t,n[i]);return t},t.InvertedIndex.prototype.toJSON=function(){return{root:this.root}},t.Configuration=function(e,n){var e=e||"";if(void 0==n||null==n)throw new Error("fields should not be null");this.config={};var i;try{i=JSON.parse(e),this.buildUserConfig(i,n)}catch(o){t.utils.warn("user configuration parse failed, will use default configuration"),this.buildDefaultConfig(n)}},t.Configuration.prototype.buildDefaultConfig=function(e){this.reset(),e.forEach(function(e){this.config[e]={boost:1,bool:"OR",expand:!1}},this)},t.Configuration.prototype.buildUserConfig=function(e,n){var i="OR",o=!1;if(this.reset(),"bool"in e&&(i=e.bool||i),"expand"in e&&(o=e.expand||o),"fields"in e)for(var r in e.fields)if(n.indexOf(r)>-1){var s=e.fields[r],u=o;void 0!=s.expand&&(u=s.expand),this.config[r]={boost:s.boost||0===s.boost?s.boost:1,bool:s.bool||i,expand:u}}else t.utils.warn("field name in user configuration not found in index instance fields");else this.addAllFields2UserConfig(i,o,n)},t.Configuration.prototype.addAllFields2UserConfig=function(e,t,n){n.forEach(function(n){this.config[n]={boost:1,bool:e,expand:t}},this)},t.Configuration.prototype.get=function(){return this.config},t.Configuration.prototype.reset=function(){this.config={}},lunr.SortedSet=function(){this.length=0,this.elements=[]},lunr.SortedSet.load=function(e){var t=new this;return t.elements=e,t.length=e.length,t},lunr.SortedSet.prototype.add=function(){var e,t;for(e=0;e1;){if(r===e)return o;e>r&&(t=o),r>e&&(n=o),i=n-t,o=t+Math.floor(i/2),r=this.elements[o]}return r===e?o:-1},lunr.SortedSet.prototype.locationFor=function(e){for(var t=0,n=this.elements.length,i=n-t,o=t+Math.floor(i/2),r=this.elements[o];i>1;)e>r&&(t=o),r>e&&(n=o),i=n-t,o=t+Math.floor(i/2),r=this.elements[o];return r>e?o:e>r?o+1:void 0},lunr.SortedSet.prototype.intersect=function(e){for(var t=new lunr.SortedSet,n=0,i=0,o=this.length,r=e.length,s=this.elements,u=e.elements;;){if(n>o-1||i>r-1)break;s[n]!==u[i]?s[n]u[i]&&i++:(t.add(s[n]),n++,i++)}return t},lunr.SortedSet.prototype.clone=function(){var e=new lunr.SortedSet;return e.elements=this.toArray(),e.length=e.elements.length,e},lunr.SortedSet.prototype.union=function(e){var t,n,i;this.length>=e.length?(t=this,n=e):(t=e,n=this),i=t.clone();for(var o=0,r=n.toArray();o

\n"}, {"fullname": "verbex.verbex", "modulename": "verbex.verbex", "type": "module", "doc": "

Generate regular expressions from an easier fluent verbal form.

\n"}, {"fullname": "verbex.verbex.P", "modulename": "verbex.verbex", "qualname": "P", "type": "variable", "doc": "

\n", "default_value": " = ~P"}, {"fullname": "verbex.verbex.HasIter", "modulename": "verbex.verbex", "qualname": "HasIter", "type": "class", "doc": "

Workaround for mypy P.args.

\n", "bases": "typing.Protocol"}, {"fullname": "verbex.verbex.HasIter.__init__", "modulename": "verbex.verbex", "qualname": "HasIter.__init__", "type": "function", "doc": "

\n", "signature": "(self, *args, **kwargs)", "funcdef": "def"}, {"fullname": "verbex.verbex.HasItems", "modulename": "verbex.verbex", "qualname": "HasItems", "type": "class", "doc": "

Workaround for mypy P.kwargs.

\n", "bases": "typing.Protocol"}, {"fullname": "verbex.verbex.HasItems.__init__", "modulename": "verbex.verbex", "qualname": "HasItems.__init__", "type": "function", "doc": "

\n", "signature": "(self, *args, **kwargs)", "funcdef": "def"}, {"fullname": "verbex.verbex.HasItems.items", "modulename": "verbex.verbex", "qualname": "HasItems.items", "type": "function", "doc": "

Object has items method.

\n\n

Returns:\n The dict of items.

\n", "signature": "(self) -> tuple[str, typing.Any]", "funcdef": "def"}, {"fullname": "verbex.verbex.EscapedText", "modulename": "verbex.verbex", "qualname": "EscapedText", "type": "class", "doc": "

Text that has been escaped for regex.

\n\n

Arguments:\n str -- Extend the string class.

\n", "bases": "builtins.str"}, {"fullname": "verbex.verbex.EscapedText.__init__", "modulename": "verbex.verbex", "qualname": "EscapedText.__init__", "type": "function", "doc": "

Return a escaped regex string.

\n\n

Arguments:\n value -- the string to escape

\n\n

Returns:\n _description_

\n", "signature": "(cls, value: str)", "funcdef": "def"}, {"fullname": "verbex.verbex.re_escape", "modulename": "verbex.verbex", "qualname": "re_escape", "type": "function", "doc": "

Automatically escape any string parameters as EscapedText.

\n\n

Arguments:\n func -- The function to decorate.

\n\n

Returns:\n The decorated function.

\n", "signature": "(\n func: collections.abc.Callable[~P, ~R]\n) -> collections.abc.Callable[~P, ~R]", "funcdef": "def"}, {"fullname": "verbex.verbex.CharClass", "modulename": "verbex.verbex", "qualname": "CharClass", "type": "class", "doc": "

Enum of character classes in regex.

\n\n

Arguments:\n Enum -- Extends the Enum class.

\n", "bases": "enum.Enum"}, {"fullname": "verbex.verbex.CharClass.DIGIT", "modulename": "verbex.verbex", "qualname": "CharClass.DIGIT", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.UPPERCASE_LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.UPPERCASE_LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.LOWERCASE_LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.LOWERCASE_LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.WHITESPACE", "modulename": "verbex.verbex", "qualname": "CharClass.WHITESPACE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.TAB", "modulename": "verbex.verbex", "qualname": "CharClass.TAB", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar", "modulename": "verbex.verbex", "qualname": "SpecialChar", "type": "class", "doc": "

Enum of special charaters, shorthand.

\n\n

Arguments:\n Enum -- Extends the Enum class.

\n", "bases": "enum.Enum"}, {"fullname": "verbex.verbex.SpecialChar.LINEBREAK", "modulename": "verbex.verbex", "qualname": "SpecialChar.LINEBREAK", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.START_OF_LINE", "modulename": "verbex.verbex", "qualname": "SpecialChar.START_OF_LINE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.END_OF_LINE", "modulename": "verbex.verbex", "qualname": "SpecialChar.END_OF_LINE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.TAB", "modulename": "verbex.verbex", "qualname": "SpecialChar.TAB", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClassOrChars", "modulename": "verbex.verbex", "qualname": "CharClassOrChars", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[str, verbex.verbex.CharClass]"}, {"fullname": "verbex.verbex.EscapedCharClassOrSpecial", "modulename": "verbex.verbex", "qualname": "EscapedCharClassOrSpecial", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]"}, {"fullname": "verbex.verbex.VerbexEscapedCharClassOrSpecial", "modulename": "verbex.verbex", "qualname": "VerbexEscapedCharClassOrSpecial", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[ForwardRef('Verbex'), str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]"}, {"fullname": "verbex.verbex.Verbex", "modulename": "verbex.verbex", "qualname": "Verbex", "type": "class", "doc": "

VerbalExpressions class.

\n\n

the following methods do not try to match the original js lib!

\n"}, {"fullname": "verbex.verbex.Verbex.__init__", "modulename": "verbex.verbex", "qualname": "Verbex.__init__", "type": "function", "doc": "

Create a Verbex object; setting any needed flags.

\n\n

Keyword Arguments:\n modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})

\n", "signature": "(self, modifiers: re.RegexFlag = )", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.EMPTY_REGEX_FLAG", "modulename": "verbex.verbex", "qualname": "Verbex.EMPTY_REGEX_FLAG", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.Verbex.modifiers", "modulename": "verbex.verbex", "qualname": "Verbex.modifiers", "type": "variable", "doc": "

Return the modifiers for this Verbex object.

\n\n

Returns:\n The modifiers applied to this object.

\n", "annotation": ": re.RegexFlag"}, {"fullname": "verbex.verbex.Verbex.regex", "modulename": "verbex.verbex", "qualname": "Verbex.regex", "type": "function", "doc": "

Get a regular expression object.

\n", "signature": "(self) -> Pattern[str]", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.capture_group", "modulename": "verbex.verbex", "qualname": "Verbex.capture_group", "type": "function", "doc": "

Create a capture group.

\n\n

Name is optional if not specified then the first argument is the text.

\n\n

Keyword Arguments:\n name_or_text -- The name of the group / text to search for (default: {None})\n text -- The text to search for (default: {None})

\n\n

Raises:\n ValueError: If name is specified then text must be as well.

\n\n

Returns:\n Verbex with added capture group.

\n", "signature": "(\n self,\n name_or_text: Union[str, NoneType, verbex.verbex.Verbex, verbex.verbex.CharClass, verbex.verbex.SpecialChar] = None,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar, NoneType] = None\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.OR", "modulename": "verbex.verbex", "qualname": "Verbex.OR", "type": "function", "doc": "

or is a python keyword so we use OR instead.

\n\n

Arguments:\n text -- Text to find or a Verbex object.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.zero_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.zero_or_more", "type": "function", "doc": "

Find the text or Verbex object zero or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.one_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.one_or_more", "type": "function", "doc": "

Find the text or Verbex object one or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_times", "modulename": "verbex.verbex", "qualname": "Verbex.n_times", "type": "function", "doc": "

Find the text or Verbex object n or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_times_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.n_times_or_more", "type": "function", "doc": "

Find the text or Verbex object at least n times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_to_m_times", "modulename": "verbex.verbex", "qualname": "Verbex.n_to_m_times", "type": "function", "doc": "

Find the text or Verbex object between n and m times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int,\n m: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.maybe", "modulename": "verbex.verbex", "qualname": "Verbex.maybe", "type": "function", "doc": "

Possibly find the text / Verbex object.

\n\n

Arguments:\n text -- The text / Verbex object to possibly find.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.find", "modulename": "verbex.verbex", "qualname": "Verbex.find", "type": "function", "doc": "

Find the text or Verbex object.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.then", "modulename": "verbex.verbex", "qualname": "Verbex.then", "type": "function", "doc": "

Synonym for find.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.followed_by", "modulename": "verbex.verbex", "qualname": "Verbex.followed_by", "type": "function", "doc": "

Match if string is followed by text.

\n\n

Positive lookahead

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_followed_by", "modulename": "verbex.verbex", "qualname": "Verbex.not_followed_by", "type": "function", "doc": "

Match if string is not followed by text.

\n\n

Negative lookahead

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.preceded_by", "modulename": "verbex.verbex", "qualname": "Verbex.preceded_by", "type": "function", "doc": "

Match if string is not preceded by text.

\n\n

Positive lookbehind

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_preceded_by", "modulename": "verbex.verbex", "qualname": "Verbex.not_preceded_by", "type": "function", "doc": "

Match if string is not preceded by text.

\n\n

Negative Lookbehind

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.any_of", "modulename": "verbex.verbex", "qualname": "Verbex.any_of", "type": "function", "doc": "

Find anything in this group of chars or char class.

\n\n

Arguments:\n text -- The characters to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n chargroup: Union[str, verbex.verbex.CharClass]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_any_of", "modulename": "verbex.verbex", "qualname": "Verbex.not_any_of", "type": "function", "doc": "

Find anything but this group of chars or char class.

\n\n

Arguments:\n text -- The characters to not look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[str, verbex.verbex.CharClass]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.anything_but", "modulename": "verbex.verbex", "qualname": "Verbex.anything_but", "type": "function", "doc": "

Find anything one or more times but this group of chars or char class.

\n\n

Arguments:\n text -- The characters to not look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n chargroup: Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.start_of_line", "modulename": "verbex.verbex", "qualname": "Verbex.start_of_line", "type": "function", "doc": "

Find the start of the line.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.end_of_line", "modulename": "verbex.verbex", "qualname": "Verbex.end_of_line", "type": "function", "doc": "

Find the end of the line.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.line_break", "modulename": "verbex.verbex", "qualname": "Verbex.line_break", "type": "function", "doc": "

Find a line break.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.tab", "modulename": "verbex.verbex", "qualname": "Verbex.tab", "type": "function", "doc": "

Find a tab.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.anything", "modulename": "verbex.verbex", "qualname": "Verbex.anything", "type": "function", "doc": "

Find anything one or more time.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.as_few", "modulename": "verbex.verbex", "qualname": "Verbex.as_few", "type": "function", "doc": "

Modify previous search to not be greedy.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.number_range", "modulename": "verbex.verbex", "qualname": "Verbex.number_range", "type": "function", "doc": "

Generate a range of numbers.

\n\n

Arguments:\n start -- Start of the range\n end -- End of the range

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self, start: int, end: int) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.letter_range", "modulename": "verbex.verbex", "qualname": "Verbex.letter_range", "type": "function", "doc": "

Generate a range of letters.

\n\n

Arguments:\n start -- Start of the range\n end -- End of the range

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n start: typing.Annotated[str, Is[_string_len_is_1]],\n end: typing.Annotated[str, Is[_string_len_is_1]]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.word", "modulename": "verbex.verbex", "qualname": "Verbex.word", "type": "function", "doc": "

Find a word on word boundary.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.with_any_case", "modulename": "verbex.verbex", "qualname": "Verbex.with_any_case", "type": "function", "doc": "

Modify Verbex object to be case insensitive.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.search_by_line", "modulename": "verbex.verbex", "qualname": "Verbex.search_by_line", "type": "function", "doc": "

Search each line, ^ and $ match begining and end of line respectively.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.with_ascii", "modulename": "verbex.verbex", "qualname": "Verbex.with_ascii", "type": "function", "doc": "

Match ascii instead of unicode.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}]; - - // mirrored in build-search-index.js (part 1) - // Also split on html tags. this is a cheap heuristic, but good enough. - elasticlunr.tokenizer.setSeperator(/[\s\-.;&_'"=,()]+|<[^>]*>/); - - let searchIndex; - if (docs._isPrebuiltIndex) { - console.info("using precompiled search index"); - searchIndex = elasticlunr.Index.load(docs); - } else { - console.time("building search index"); - // mirrored in build-search-index.js (part 2) - searchIndex = elasticlunr(function () { - this.pipeline.remove(elasticlunr.stemmer); - this.pipeline.remove(elasticlunr.stopWordFilter); - this.addField("qualname"); - this.addField("fullname"); - this.addField("annotation"); - this.addField("default_value"); - this.addField("signature"); - this.addField("bases"); - this.addField("doc"); - this.setRef("fullname"); - }); - for (let doc of docs) { - searchIndex.addDoc(doc); - } - console.timeEnd("building search index"); - } - - return (term) => searchIndex.search(term, { - fields: { - qualname: {boost: 4}, - fullname: {boost: 2}, - annotation: {boost: 2}, - default_value: {boost: 2}, - signature: {boost: 2}, - bases: {boost: 2}, - doc: {boost: 1}, - }, - expand: true - }); -})(); \ No newline at end of file diff --git a/docs/verbex.html b/docs/verbex.html deleted file mode 100644 index 189cab6..0000000 --- a/docs/verbex.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - - - verbex API documentation - - - - - - - - - -
-
-

-verbex

- - -
- View Source - 
0import importlib.metadata
-1
-2from .verbex import CharClass as CharClass
-3from .verbex import SpecialChar as SpecialChar
-4from .verbex import Verbex as Verbex
-5
-6__version__ = importlib.metadata.version("verbex")
-
- -
- -
-
- - \ No newline at end of file diff --git a/docs/verbex/verbex.html b/docs/verbex/verbex.html deleted file mode 100644 index 48f01fc..0000000 --- a/docs/verbex/verbex.html +++ /dev/null @@ -1,3343 +0,0 @@ - - - - - - - verbex.verbex API documentation - - - - - - - - - -
-
-

-verbex.verbex

- -

Generate regular expressions from an easier fluent verbal form.

-
- -
- View Source - 
  0"""Generate regular expressions from an easier fluent verbal form."""
-  1from __future__ import annotations
-  2
-  3import re
-  4from enum import Enum
-  5from functools import wraps
-  6
-  7try:
-  8    from typing import (  # <--------------- if Python ≥ 3.9.0
-  9        Annotated,
- 10        ParamSpec,
- 11        Protocol,
- 12        TypeAlias,
- 13        runtime_checkable,
- 14    )
- 15except ImportError:
- 16    from typing_extensions import TypeAlias, Protocol, Annotated, ParamSpec, runtime_checkable  # type: ignore # <--- if Python < 3.9.0 # noqa E501
- 17
- 18from typing import Pattern, TypeVar
- 19
- 20from beartype import beartype  # type: ignore
- 21from beartype.typing import (  # type: ignore
- 22    Any,
- 23    Callable,
- 24    Dict,
- 25    Iterator,
- 26    List,
- 27    Optional,
- 28    Tuple,
- 29    Union,
- 30    cast,
- 31)
- 32from beartype.vale import Is  # type: ignore
- 33
- 34
- 35def _string_len_is_1(text: object) -> bool:
- 36    return isinstance(text, str) and len(text) == 1
- 37
- 38
- 39Char = Annotated[str, Is[_string_len_is_1]]
- 40
- 41
- 42P = ParamSpec("P")  # noqa VNE001
- 43R = TypeVar("R")  # noqa VNE001
- 44
- 45
- 46# work around for bug https://github.com/python/mypy/issues/12660
- 47# fixed in next version of mypy
- 48@runtime_checkable
- 49class HasIter(Protocol):
- 50    """Workaround for mypy P.args."""
- 51
- 52    def __iter__(self) -> Iterator[Any]:
- 53        """Object can be iterated.
- 54
- 55        Yields:
- 56            Next object.
- 57        """
- 58        ...
- 59
- 60
- 61# work around for bug https://github.com/python/mypy/issues/12660
- 62# fixed in next version of mypy
- 63@runtime_checkable
- 64class HasItems(Protocol):
- 65    """Workaround for mypy P.kwargs."""
- 66
- 67    def items(self) -> Tuple[str, Any]:
- 68        """Object has items method.
- 69
- 70        Returns:
- 71            The dict of items.
- 72        """
- 73        ...
- 74
- 75
- 76class EscapedText(str):
- 77    """Text that has been escaped for regex.
- 78
- 79    Arguments:
- 80        str -- Extend the string class.
- 81    """
- 82
- 83    def __new__(cls, value: str) -> EscapedText:
- 84        """Return a escaped regex string.
- 85
- 86        Arguments:
- 87            value -- the string to escape
- 88
- 89        Returns:
- 90            _description_
- 91        """
- 92        return str.__new__(cls, re.escape(value))
- 93
- 94
- 95def re_escape(func: Callable[P, R]) -> Callable[P, R]:
- 96    """Automatically escape any string parameters as EscapedText.
- 97
- 98    Arguments:
- 99        func -- The function to decorate.
-100
-101    Returns:
-102        The decorated function.
-103    """
-104
-105    @wraps(func)
-106    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
-107        escaped_args: List[Any] = []
-108        escaped_kwargs: Dict[str, Any] = {}
-109        for arg in cast(HasIter, args):
-110            if not isinstance(arg, EscapedText) and isinstance(arg, str):
-111                escaped_args.append(EscapedText(arg))
-112            else:
-113                escaped_args.append(arg)
-114        arg_k: str
-115        arg_v: Any
-116        for arg_k, arg_v in cast(HasItems, kwargs).items():
-117            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
-118                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
-119            else:
-120                escaped_kwargs[arg_k] = arg_v
-121        return func(*escaped_args, **escaped_kwargs)  # type: ignore
-122
-123    return inner
-124
-125
-126class CharClass(Enum):
-127    """Enum of character classes in regex.
-128
-129    Arguments:
-130        Enum -- Extends the Enum class.
-131    """
-132
-133    DIGIT = "\\d"
-134    LETTER = "\\w"
-135    UPPERCASE_LETTER = "\\u"
-136    LOWERCASE_LETTER = "\\l"
-137    WHITESPACE = "\\s"
-138    TAB = "\\t"
-139
-140    def __str__(self) -> str:
-141        """To string method based on Enum value.
-142
-143        Returns:
-144            value of Enum
-145        """
-146        return self.value
-147
-148
-149class SpecialChar(Enum):
-150    """Enum of special charaters, shorthand.
-151
-152    Arguments:
-153        Enum -- Extends the Enum class.
-154    """
-155
-156    # does not work  / should not be used in [ ]
-157    LINEBREAK = "(\\n|(\\r\\n))"
-158    START_OF_LINE = "^"
-159    END_OF_LINE = "$"
-160    TAB = "\t"
-161
-162    def __str__(self) -> str:
-163        """To string for special chars enum.
-164
-165        Returns:
-166            Return value of enum as string.
-167        """
-168        return self.value
-169
-170
-171CharClassOrChars: TypeAlias = Union[str, CharClass]
-172EscapedCharClassOrSpecial: TypeAlias = Union[str, CharClass, SpecialChar]
-173VerbexEscapedCharClassOrSpecial: TypeAlias = Union["Verbex", EscapedCharClassOrSpecial]
-174
-175
-176def _poseur_decorator(*poseur: Any) -> Any:
-177    """Positional-only arguments runtime checker."""
-178    import functools
-179
-180    def caller(func: Callable[P, R]) -> Callable[P, R]:  # type: ignore
-181        @functools.wraps(func)
-182        def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
-183            poseur_args = set(poseur).intersection(kwargs)  # type: ignore
-184            if poseur_args:
-185                raise TypeError(
-186                    "%s() got some positional-only arguments passed as keyword"
-187                    " arguments: %r" % (func.__name__, ", ".join(poseur_args)),
-188                )
-189            return func(*args, **kwargs)  # type: ignore
-190
-191        return wrapper
-192
-193    return caller
-194
-195
-196class Verbex:
-197    """
-198    VerbalExpressions class.
-199
-200    the following methods do not try to match the original js lib!
-201    """
-202
-203    EMPTY_REGEX_FLAG = re.RegexFlag(0)
-204
-205    @re_escape
-206    @beartype
-207    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
-208        """Create a Verbex object; setting any needed flags.
-209
-210        Keyword Arguments:
-211            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
-212        """
-213        # self._parts: List[str] = [text]
-214        self._parts: List[str] = []
-215        self._modifiers = modifiers
-216
-217    @property
-218    def modifiers(self) -> re.RegexFlag:
-219        """Return the modifiers for this Verbex object.
-220
-221        Returns:
-222            The modifiers applied to this object.
-223        """
-224        return self._modifiers
-225
-226    def __str__(self) -> str:
-227        """Return regex string representation."""
-228        return "".join(self._parts)
-229
-230    @beartype
-231    def _add(self, value: Union[str, List[str]]) -> Verbex:
-232        """
-233        Append a transformed value to internal expression to be compiled.
-234
-235        As possible, this method should be "private".
-236        """
-237        if isinstance(value, list):
-238            self._parts.extend(value)
-239        else:
-240            self._parts.append(value)
-241        return self
-242
-243    def regex(self) -> Pattern[str]:
-244        """Get a regular expression object."""
-245        return re.compile(
-246            str(self),
-247            self._modifiers,
-248        )
-249
-250    # allow VerbexEscapedCharClassOrSpecial
-251
-252    @re_escape
-253    @beartype
-254    def _capture_group_with_name(
-255        self,
-256        name: str,
-257        text: VerbexEscapedCharClassOrSpecial,
-258    ) -> Verbex:
-259        return self._add(f"(?<{name}>{str(text)})")
-260
-261    @re_escape
-262    @beartype
-263    def _capture_group_without_name(
-264        self,
-265        text: VerbexEscapedCharClassOrSpecial,
-266    ) -> Verbex:
-267        return self._add(f"({str(text)})")
-268
-269    @re_escape
-270    @beartype
-271    @_poseur_decorator("self")
-272    def capture_group(
-273        self,
-274        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
-275        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
-276    ) -> Verbex:
-277        """Create a capture group.
-278
-279        Name is optional if not specified then the first argument is the text.
-280
-281        Keyword Arguments:
-282            name_or_text -- The name of the group / text to search for (default: {None})
-283            text -- The text to search for (default: {None})
-284
-285        Raises:
-286            ValueError: If name is specified then text must be as well.
-287
-288        Returns:
-289            Verbex with added capture group.
-290        """
-291        if name_or_text is not None:
-292            if text is None:
-293                _text = name_or_text
-294                return self._capture_group_without_name(_text)
-295            if isinstance(name_or_text, str):
-296                return self._capture_group_with_name(name_or_text, text)
-297        raise ValueError("text must be specified with optional name")
-298
-299    @re_escape
-300    @beartype
-301    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
-302        """`or` is a python keyword so we use `OR` instead.
-303
-304        Arguments:
-305            text -- Text to find or a Verbex object.
-306
-307        Returns:
-308            Modified Verbex object.
-309        """
-310        return self._add("|").find(text)
-311
-312    @re_escape
-313    @beartype
-314    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-315        """Find the text or Verbex object zero or more times.
-316
-317        Arguments:
-318            text -- The text / Verbex object to look for.
-319
-320        Returns:
-321            Modified Verbex object.
-322        """
-323        return self._add(f"(?:{str(text)})*")
-324
-325    @re_escape
-326    @beartype
-327    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-328        """Find the text or Verbex object one or more times.
-329
-330        Arguments:
-331            text -- The text / Verbex object to look for.
-332
-333        Returns:
-334            Modified Verbex object.
-335        """
-336        return self._add(f"(?:{str(text)})+")
-337
-338    @re_escape
-339    @beartype
-340    def n_times(
-341        self,
-342        text: VerbexEscapedCharClassOrSpecial,
-343        n: int,  # noqa: VNE001
-344    ) -> Verbex:
-345        """Find the text or Verbex object n or more times.
-346
-347        Arguments:
-348            text -- The text / Verbex object to look for.
-349
-350        Returns:
-351            Modified Verbex object.
-352        """
-353        return self._add(f"(?:{str(text)}){{{n}}}")
-354
-355    @re_escape
-356    @beartype
-357    def n_times_or_more(
-358        self,
-359        text: VerbexEscapedCharClassOrSpecial,
-360        n: int,  # noqa: VNE001
-361    ) -> Verbex:
-362        """Find the text or Verbex object at least n times.
-363
-364        Arguments:
-365            text -- The text / Verbex object to look for.
-366
-367        Returns:
-368            Modified Verbex object.
-369        """
-370        return self._add(f"(?:{str(text)}){{{n},}}")
-371
-372    @re_escape
-373    @beartype
-374    def n_to_m_times(
-375        self,
-376        text: VerbexEscapedCharClassOrSpecial,
-377        n: int,  # noqa: VNE001
-378        m: int,  # noqa: VNE001
-379    ) -> Verbex:
-380        """Find the text or Verbex object between n and m times.
-381
-382        Arguments:
-383            text -- The text / Verbex object to look for.
-384
-385        Returns:
-386            Modified Verbex object.
-387        """
-388        return self._add(f"(?:{str(text)}){{{n},{m}}}")
-389
-390    @re_escape
-391    @beartype
-392    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-393        """Possibly find the text / Verbex object.
-394
-395        Arguments:
-396            text -- The text / Verbex object to possibly find.
-397
-398        Returns:
-399            Modified Verbex object.
-400        """
-401        return self._add(f"(?:{str(text)})?")
-402
-403    @re_escape
-404    @beartype
-405    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-406        """Find the text or Verbex object.
-407
-408        Arguments:
-409            text -- The text / Verbex object to look for.
-410
-411        Returns:
-412            Modified Verbex object.
-413        """
-414        return self._add(str(text))
-415
-416    @re_escape
-417    @beartype
-418    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-419        """Synonym for find.
-420
-421        Arguments:
-422            text -- The text / Verbex object to look for.
-423
-424        Returns:
-425            Modified Verbex object.
-426        """
-427        return self.find(text)
-428
-429    @re_escape
-430    @beartype
-431    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-432        """Match if string is followed by text.
-433
-434        Positive lookahead
-435
-436        Returns:
-437            Modified Verbex object.
-438        """
-439        return self._add(f"(?={text})")
-440
-441    @re_escape
-442    @beartype
-443    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-444        """Match if string is not followed by text.
-445
-446        Negative lookahead
-447
-448        Returns:
-449            Modified Verbex object.
-450        """
-451        return self._add(f"(?!{text})")
-452
-453    @re_escape
-454    @beartype
-455    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-456        """Match if string is not preceded by text.
-457
-458        Positive lookbehind
-459
-460        Returns:
-461            Modified Verbex object.
-462        """
-463        return self._add(f"(?<={text})")
-464
-465    @re_escape
-466    @beartype
-467    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-468        """Match if string is not preceded by text.
-469
-470        Negative Lookbehind
-471
-472        Returns:
-473            Modified Verbex object.
-474        """
-475        return self._add(f"(?<!{text})")
-476
-477    # only allow CharclassOrChars
-478
-479    @re_escape
-480    @beartype
-481    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
-482        """Find anything in this group of chars or char class.
-483
-484        Arguments:
-485            text -- The characters to look for.
-486
-487        Returns:
-488            Modified Verbex object.
-489        """
-490        return self._add(f"(?:[{chargroup}])")
-491
-492    @re_escape
-493    @beartype
-494    def not_any_of(self, text: CharClassOrChars) -> Verbex:
-495        """Find anything but this group of chars or char class.
-496
-497        Arguments:
-498            text -- The characters to not look for.
-499
-500        Returns:
-501            Modified Verbex object.
-502        """
-503        return self._add(f"(?:[^{text}])")
-504
-505    @re_escape
-506    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
-507        """Find anything one or more times but this group of chars or char class.
-508
-509        Arguments:
-510            text -- The characters to not look for.
-511
-512        Returns:
-513            Modified Verbex object.
-514        """
-515        return self._add(f"[^{chargroup}]+")
-516
-517    # no text input
-518
-519    def start_of_line(self) -> Verbex:
-520        """Find the start of the line.
-521
-522        Returns:
-523            Modified Verbex object.
-524        """
-525        return self.find(SpecialChar.START_OF_LINE)
-526
-527    def end_of_line(self) -> Verbex:
-528        """Find the end of the line.
-529
-530        Returns:
-531            Modified Verbex object.
-532        """
-533        return self.find(SpecialChar.END_OF_LINE)
-534
-535    def line_break(self) -> Verbex:
-536        """Find a line break.
-537
-538        Returns:
-539            Modified Verbex object.
-540        """
-541        return self.find(SpecialChar.LINEBREAK)
-542
-543    def tab(self) -> Verbex:
-544        """Find a tab.
-545
-546        Returns:
-547            Modified Verbex object.
-548        """
-549        return self.find(SpecialChar.TAB)
-550
-551    def anything(self) -> Verbex:
-552        """Find anything one or more time.
-553
-554        Returns:
-555            Modified Verbex object.
-556        """
-557        return self._add(".+")
-558
-559    def as_few(self) -> Verbex:
-560        """Modify previous search to not be greedy.
-561
-562        Returns:
-563            Modified Verbex object.
-564        """
-565        return self._add("?")
-566
-567    @beartype
-568    def number_range(self, start: int, end: int) -> Verbex:
-569        """Generate a range of numbers.
-570
-571        Arguments:
-572            start -- Start of the range
-573            end -- End of the range
-574
-575        Returns:
-576            Modified Verbex object.
-577        """
-578        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
-579
-580    @beartype
-581    def letter_range(self, start: Char, end: Char) -> Verbex:
-582        """Generate a range of letters.
-583
-584        Arguments:
-585            start -- Start of the range
-586            end -- End of the range
-587
-588        Returns:
-589            Modified Verbex object.
-590        """
-591        return self._add(f"[{start}-{end}]")
-592
-593    def word(self) -> Verbex:
-594        """Find a word on word boundary.
-595
-596        Returns:
-597            Modified Verbex object.
-598        """
-599        return self._add("(\\b\\w+\\b)")
-600
-601    # # --------------- modifiers ------------------------
-602
-603    def with_any_case(self) -> Verbex:
-604        """Modify Verbex object to be case insensitive.
-605
-606        Returns:
-607            Modified Verbex object.
-608        """
-609        self._modifiers |= re.IGNORECASE
-610        return self
-611
-612    def search_by_line(self) -> Verbex:
-613        """Search each line, ^ and $ match begining and end of line respectively.
-614
-615        Returns:
-616            Modified Verbex object.
-617        """
-618        self._modifiers |= re.MULTILINE
-619        return self
-620
-621    def with_ascii(self) -> Verbex:
-622        """Match ascii instead of unicode.
-623
-624        Returns:
-625            Modified Verbex object.
-626        """
-627        self._modifiers |= re.ASCII
-628        return self
-629
-630
-631# left over notes from original version
-632# def __getattr__(self, attr):
-633#     """ any other function will be sent to the regex object """
-634#     regex = self.regex()
-635#     return getattr(regex, attr)
-636
-637# def replace(self, string, repl):
-638#     return self.sub(repl, string)
-639
-640
-641if __name__ == "__main__":
-642    pass
-
- -
- -
-
-
#   - - P = ~P -
- - - - -
-
-
- #   - -
@runtime_checkable
- - class - HasIter(typing.Protocol): -
- -
- View Source - 
49@runtime_checkable
-50class HasIter(Protocol):
-51    """Workaround for mypy P.args."""
-52
-53    def __iter__(self) -> Iterator[Any]:
-54        """Object can be iterated.
-55
-56        Yields:
-57            Next object.
-58        """
-59        ...
-
- -
- -

Workaround for mypy P.args.

-
- - -
-
#   - - - HasIter(*args, **kwargs) -
- -
- View Source - 
1429def _no_init_or_replace_init(self, *args, **kwargs):
-1430    cls = type(self)
-1431
-1432    if cls._is_protocol:
-1433        raise TypeError('Protocols cannot be instantiated')
-1434
-1435    # Already using a custom `__init__`. No need to calculate correct
-1436    # `__init__` to call. This can lead to RecursionError. See bpo-45121.
-1437    if cls.__init__ is not _no_init_or_replace_init:
-1438        return
-1439
-1440    # Initially, `__init__` of a protocol subclass is set to `_no_init_or_replace_init`.
-1441    # The first instantiation of the subclass will call `_no_init_or_replace_init` which
-1442    # searches for a proper new `__init__` in the MRO. The new `__init__`
-1443    # replaces the subclass' old `__init__` (ie `_no_init_or_replace_init`). Subsequent
-1444    # instantiation of the protocol subclass will thus use the new
-1445    # `__init__` and no longer call `_no_init_or_replace_init`.
-1446    for base in cls.__mro__:
-1447        init = base.__dict__.get('__init__', _no_init_or_replace_init)
-1448        if init is not _no_init_or_replace_init:
-1449            cls.__init__ = init
-1450            break
-1451    else:
-1452        # should not happen
-1453        cls.__init__ = object.__init__
-1454
-1455    cls.__init__(self, *args, **kwargs)
-
- -
- - - -
-
-
-
- #   - -
@runtime_checkable
- - class - HasItems(typing.Protocol): -
- -
- View Source - 
64@runtime_checkable
-65class HasItems(Protocol):
-66    """Workaround for mypy P.kwargs."""
-67
-68    def items(self) -> Tuple[str, Any]:
-69        """Object has items method.
-70
-71        Returns:
-72            The dict of items.
-73        """
-74        ...
-
- -
- -

Workaround for mypy P.kwargs.

-
- - -
-
#   - - - HasItems(*args, **kwargs) -
- -
- View Source - 
1429def _no_init_or_replace_init(self, *args, **kwargs):
-1430    cls = type(self)
-1431
-1432    if cls._is_protocol:
-1433        raise TypeError('Protocols cannot be instantiated')
-1434
-1435    # Already using a custom `__init__`. No need to calculate correct
-1436    # `__init__` to call. This can lead to RecursionError. See bpo-45121.
-1437    if cls.__init__ is not _no_init_or_replace_init:
-1438        return
-1439
-1440    # Initially, `__init__` of a protocol subclass is set to `_no_init_or_replace_init`.
-1441    # The first instantiation of the subclass will call `_no_init_or_replace_init` which
-1442    # searches for a proper new `__init__` in the MRO. The new `__init__`
-1443    # replaces the subclass' old `__init__` (ie `_no_init_or_replace_init`). Subsequent
-1444    # instantiation of the protocol subclass will thus use the new
-1445    # `__init__` and no longer call `_no_init_or_replace_init`.
-1446    for base in cls.__mro__:
-1447        init = base.__dict__.get('__init__', _no_init_or_replace_init)
-1448        if init is not _no_init_or_replace_init:
-1449            cls.__init__ = init
-1450            break
-1451    else:
-1452        # should not happen
-1453        cls.__init__ = object.__init__
-1454
-1455    cls.__init__(self, *args, **kwargs)
-
- -
- - - -
-
-
#   - - - def - items(self) -> tuple[str, typing.Any]: -
- -
- View Source - 
68    def items(self) -> Tuple[str, Any]:
-69        """Object has items method.
-70
-71        Returns:
-72            The dict of items.
-73        """
-74        ...
-
- -
- -

Object has items method.

- -

Returns: - The dict of items.

-
- - -
-
-
-
- #   - - - class - EscapedText(builtins.str): -
- -
- View Source - 
77class EscapedText(str):
-78    """Text that has been escaped for regex.
-79
-80    Arguments:
-81        str -- Extend the string class.
-82    """
-83
-84    def __new__(cls, value: str) -> EscapedText:
-85        """Return a escaped regex string.
-86
-87        Arguments:
-88            value -- the string to escape
-89
-90        Returns:
-91            _description_
-92        """
-93        return str.__new__(cls, re.escape(value))
-
- -
- -

Text that has been escaped for regex.

- -

Arguments: - str -- Extend the string class.

-
- - -
-
#   - - - EscapedText(value: str) -
- -
- View Source - 
84    def __new__(cls, value: str) -> EscapedText:
-85        """Return a escaped regex string.
-86
-87        Arguments:
-88            value -- the string to escape
-89
-90        Returns:
-91            _description_
-92        """
-93        return str.__new__(cls, re.escape(value))
-
- -
- -

Return a escaped regex string.

- -

Arguments: - value -- the string to escape

- -

Returns: - _description_

-
- - -
-
-
Inherited Members
-
-
builtins.str
-
encode
-
replace
-
split
-
rsplit
-
join
-
capitalize
-
casefold
-
title
-
center
-
count
-
expandtabs
-
find
-
partition
-
index
-
ljust
-
lower
-
lstrip
-
rfind
-
rindex
-
rjust
-
rstrip
-
rpartition
-
splitlines
-
strip
-
swapcase
-
translate
-
upper
-
startswith
-
endswith
-
removeprefix
-
removesuffix
-
isascii
-
islower
-
isupper
-
istitle
-
isspace
-
isdecimal
-
isdigit
-
isnumeric
-
isalpha
-
isalnum
-
isidentifier
-
isprintable
-
zfill
-
format
-
format_map
-
maketrans
- -
-
-
-
-
-
#   - - - def - re_escape( - func: collections.abc.Callable[~P, ~R] -) -> collections.abc.Callable[~P, ~R]: -
- -
- View Source - 
 96def re_escape(func: Callable[P, R]) -> Callable[P, R]:
- 97    """Automatically escape any string parameters as EscapedText.
- 98
- 99    Arguments:
-100        func -- The function to decorate.
-101
-102    Returns:
-103        The decorated function.
-104    """
-105
-106    @wraps(func)
-107    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
-108        escaped_args: List[Any] = []
-109        escaped_kwargs: Dict[str, Any] = {}
-110        for arg in cast(HasIter, args):
-111            if not isinstance(arg, EscapedText) and isinstance(arg, str):
-112                escaped_args.append(EscapedText(arg))
-113            else:
-114                escaped_args.append(arg)
-115        arg_k: str
-116        arg_v: Any
-117        for arg_k, arg_v in cast(HasItems, kwargs).items():
-118            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
-119                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
-120            else:
-121                escaped_kwargs[arg_k] = arg_v
-122        return func(*escaped_args, **escaped_kwargs)  # type: ignore
-123
-124    return inner
-
- -
- -

Automatically escape any string parameters as EscapedText.

- -

Arguments: - func -- The function to decorate.

- -

Returns: - The decorated function.

-
- - -
-
-
- #   - - - class - CharClass(enum.Enum): -
- -
- View Source - 
127class CharClass(Enum):
-128    """Enum of character classes in regex.
-129
-130    Arguments:
-131        Enum -- Extends the Enum class.
-132    """
-133
-134    DIGIT = "\\d"
-135    LETTER = "\\w"
-136    UPPERCASE_LETTER = "\\u"
-137    LOWERCASE_LETTER = "\\l"
-138    WHITESPACE = "\\s"
-139    TAB = "\\t"
-140
-141    def __str__(self) -> str:
-142        """To string method based on Enum value.
-143
-144        Returns:
-145            value of Enum
-146        """
-147        return self.value
-
- -
- -

Enum of character classes in regex.

- -

Arguments: - Enum -- Extends the Enum class.

-
- - -
-
#   - - DIGIT = <CharClass.DIGIT: '\\d'> -
- - - - -
-
-
#   - - LETTER = <CharClass.LETTER: '\\w'> -
- - - - -
-
-
#   - - UPPERCASE_LETTER = <CharClass.UPPERCASE_LETTER: '\\u'> -
- - - - -
-
-
#   - - LOWERCASE_LETTER = <CharClass.LOWERCASE_LETTER: '\\l'> -
- - - - -
-
-
#   - - WHITESPACE = <CharClass.WHITESPACE: '\\s'> -
- - - - -
-
-
#   - - TAB = <CharClass.TAB: '\\t'> -
- - - - -
-
-
Inherited Members
-
-
enum.Enum
-
name
-
value
- -
-
-
-
-
-
- #   - - - class - SpecialChar(enum.Enum): -
- -
- View Source - 
150class SpecialChar(Enum):
-151    """Enum of special charaters, shorthand.
-152
-153    Arguments:
-154        Enum -- Extends the Enum class.
-155    """
-156
-157    # does not work  / should not be used in [ ]
-158    LINEBREAK = "(\\n|(\\r\\n))"
-159    START_OF_LINE = "^"
-160    END_OF_LINE = "$"
-161    TAB = "\t"
-162
-163    def __str__(self) -> str:
-164        """To string for special chars enum.
-165
-166        Returns:
-167            Return value of enum as string.
-168        """
-169        return self.value
-
- -
- -

Enum of special charaters, shorthand.

- -

Arguments: - Enum -- Extends the Enum class.

-
- - -
-
#   - - LINEBREAK = <SpecialChar.LINEBREAK: '(\\n|(\\r\\n))'> -
- - - - -
-
-
#   - - START_OF_LINE = <SpecialChar.START_OF_LINE: '^'> -
- - - - -
-
-
#   - - END_OF_LINE = <SpecialChar.END_OF_LINE: '$'> -
- - - - -
-
-
#   - - TAB = <SpecialChar.TAB: '\t'> -
- - - - -
-
-
Inherited Members
-
-
enum.Enum
-
name
-
value
- -
-
-
-
-
-
#   - - CharClassOrChars: TypeAlias = typing.Union[str, verbex.verbex.CharClass] -
- - - - -
-
-
#   - - EscapedCharClassOrSpecial: TypeAlias = typing.Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -
- - - - -
-
-
#   - - VerbexEscapedCharClassOrSpecial: TypeAlias = typing.Union[ForwardRef('Verbex'), str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -
- - - - -
-
-
- #   - - - class - Verbex: -
- -
- View Source - 
197class Verbex:
-198    """
-199    VerbalExpressions class.
-200
-201    the following methods do not try to match the original js lib!
-202    """
-203
-204    EMPTY_REGEX_FLAG = re.RegexFlag(0)
-205
-206    @re_escape
-207    @beartype
-208    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
-209        """Create a Verbex object; setting any needed flags.
-210
-211        Keyword Arguments:
-212            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
-213        """
-214        # self._parts: List[str] = [text]
-215        self._parts: List[str] = []
-216        self._modifiers = modifiers
-217
-218    @property
-219    def modifiers(self) -> re.RegexFlag:
-220        """Return the modifiers for this Verbex object.
-221
-222        Returns:
-223            The modifiers applied to this object.
-224        """
-225        return self._modifiers
-226
-227    def __str__(self) -> str:
-228        """Return regex string representation."""
-229        return "".join(self._parts)
-230
-231    @beartype
-232    def _add(self, value: Union[str, List[str]]) -> Verbex:
-233        """
-234        Append a transformed value to internal expression to be compiled.
-235
-236        As possible, this method should be "private".
-237        """
-238        if isinstance(value, list):
-239            self._parts.extend(value)
-240        else:
-241            self._parts.append(value)
-242        return self
-243
-244    def regex(self) -> Pattern[str]:
-245        """Get a regular expression object."""
-246        return re.compile(
-247            str(self),
-248            self._modifiers,
-249        )
-250
-251    # allow VerbexEscapedCharClassOrSpecial
-252
-253    @re_escape
-254    @beartype
-255    def _capture_group_with_name(
-256        self,
-257        name: str,
-258        text: VerbexEscapedCharClassOrSpecial,
-259    ) -> Verbex:
-260        return self._add(f"(?<{name}>{str(text)})")
-261
-262    @re_escape
-263    @beartype
-264    def _capture_group_without_name(
-265        self,
-266        text: VerbexEscapedCharClassOrSpecial,
-267    ) -> Verbex:
-268        return self._add(f"({str(text)})")
-269
-270    @re_escape
-271    @beartype
-272    @_poseur_decorator("self")
-273    def capture_group(
-274        self,
-275        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
-276        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
-277    ) -> Verbex:
-278        """Create a capture group.
-279
-280        Name is optional if not specified then the first argument is the text.
-281
-282        Keyword Arguments:
-283            name_or_text -- The name of the group / text to search for (default: {None})
-284            text -- The text to search for (default: {None})
-285
-286        Raises:
-287            ValueError: If name is specified then text must be as well.
-288
-289        Returns:
-290            Verbex with added capture group.
-291        """
-292        if name_or_text is not None:
-293            if text is None:
-294                _text = name_or_text
-295                return self._capture_group_without_name(_text)
-296            if isinstance(name_or_text, str):
-297                return self._capture_group_with_name(name_or_text, text)
-298        raise ValueError("text must be specified with optional name")
-299
-300    @re_escape
-301    @beartype
-302    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
-303        """`or` is a python keyword so we use `OR` instead.
-304
-305        Arguments:
-306            text -- Text to find or a Verbex object.
-307
-308        Returns:
-309            Modified Verbex object.
-310        """
-311        return self._add("|").find(text)
-312
-313    @re_escape
-314    @beartype
-315    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-316        """Find the text or Verbex object zero or more times.
-317
-318        Arguments:
-319            text -- The text / Verbex object to look for.
-320
-321        Returns:
-322            Modified Verbex object.
-323        """
-324        return self._add(f"(?:{str(text)})*")
-325
-326    @re_escape
-327    @beartype
-328    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-329        """Find the text or Verbex object one or more times.
-330
-331        Arguments:
-332            text -- The text / Verbex object to look for.
-333
-334        Returns:
-335            Modified Verbex object.
-336        """
-337        return self._add(f"(?:{str(text)})+")
-338
-339    @re_escape
-340    @beartype
-341    def n_times(
-342        self,
-343        text: VerbexEscapedCharClassOrSpecial,
-344        n: int,  # noqa: VNE001
-345    ) -> Verbex:
-346        """Find the text or Verbex object n or more times.
-347
-348        Arguments:
-349            text -- The text / Verbex object to look for.
-350
-351        Returns:
-352            Modified Verbex object.
-353        """
-354        return self._add(f"(?:{str(text)}){{{n}}}")
-355
-356    @re_escape
-357    @beartype
-358    def n_times_or_more(
-359        self,
-360        text: VerbexEscapedCharClassOrSpecial,
-361        n: int,  # noqa: VNE001
-362    ) -> Verbex:
-363        """Find the text or Verbex object at least n times.
-364
-365        Arguments:
-366            text -- The text / Verbex object to look for.
-367
-368        Returns:
-369            Modified Verbex object.
-370        """
-371        return self._add(f"(?:{str(text)}){{{n},}}")
-372
-373    @re_escape
-374    @beartype
-375    def n_to_m_times(
-376        self,
-377        text: VerbexEscapedCharClassOrSpecial,
-378        n: int,  # noqa: VNE001
-379        m: int,  # noqa: VNE001
-380    ) -> Verbex:
-381        """Find the text or Verbex object between n and m times.
-382
-383        Arguments:
-384            text -- The text / Verbex object to look for.
-385
-386        Returns:
-387            Modified Verbex object.
-388        """
-389        return self._add(f"(?:{str(text)}){{{n},{m}}}")
-390
-391    @re_escape
-392    @beartype
-393    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-394        """Possibly find the text / Verbex object.
-395
-396        Arguments:
-397            text -- The text / Verbex object to possibly find.
-398
-399        Returns:
-400            Modified Verbex object.
-401        """
-402        return self._add(f"(?:{str(text)})?")
-403
-404    @re_escape
-405    @beartype
-406    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-407        """Find the text or Verbex object.
-408
-409        Arguments:
-410            text -- The text / Verbex object to look for.
-411
-412        Returns:
-413            Modified Verbex object.
-414        """
-415        return self._add(str(text))
-416
-417    @re_escape
-418    @beartype
-419    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-420        """Synonym for find.
-421
-422        Arguments:
-423            text -- The text / Verbex object to look for.
-424
-425        Returns:
-426            Modified Verbex object.
-427        """
-428        return self.find(text)
-429
-430    @re_escape
-431    @beartype
-432    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-433        """Match if string is followed by text.
-434
-435        Positive lookahead
-436
-437        Returns:
-438            Modified Verbex object.
-439        """
-440        return self._add(f"(?={text})")
-441
-442    @re_escape
-443    @beartype
-444    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-445        """Match if string is not followed by text.
-446
-447        Negative lookahead
-448
-449        Returns:
-450            Modified Verbex object.
-451        """
-452        return self._add(f"(?!{text})")
-453
-454    @re_escape
-455    @beartype
-456    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-457        """Match if string is not preceded by text.
-458
-459        Positive lookbehind
-460
-461        Returns:
-462            Modified Verbex object.
-463        """
-464        return self._add(f"(?<={text})")
-465
-466    @re_escape
-467    @beartype
-468    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-469        """Match if string is not preceded by text.
-470
-471        Negative Lookbehind
-472
-473        Returns:
-474            Modified Verbex object.
-475        """
-476        return self._add(f"(?<!{text})")
-477
-478    # only allow CharclassOrChars
-479
-480    @re_escape
-481    @beartype
-482    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
-483        """Find anything in this group of chars or char class.
-484
-485        Arguments:
-486            text -- The characters to look for.
-487
-488        Returns:
-489            Modified Verbex object.
-490        """
-491        return self._add(f"(?:[{chargroup}])")
-492
-493    @re_escape
-494    @beartype
-495    def not_any_of(self, text: CharClassOrChars) -> Verbex:
-496        """Find anything but this group of chars or char class.
-497
-498        Arguments:
-499            text -- The characters to not look for.
-500
-501        Returns:
-502            Modified Verbex object.
-503        """
-504        return self._add(f"(?:[^{text}])")
-505
-506    @re_escape
-507    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
-508        """Find anything one or more times but this group of chars or char class.
-509
-510        Arguments:
-511            text -- The characters to not look for.
-512
-513        Returns:
-514            Modified Verbex object.
-515        """
-516        return self._add(f"[^{chargroup}]+")
-517
-518    # no text input
-519
-520    def start_of_line(self) -> Verbex:
-521        """Find the start of the line.
-522
-523        Returns:
-524            Modified Verbex object.
-525        """
-526        return self.find(SpecialChar.START_OF_LINE)
-527
-528    def end_of_line(self) -> Verbex:
-529        """Find the end of the line.
-530
-531        Returns:
-532            Modified Verbex object.
-533        """
-534        return self.find(SpecialChar.END_OF_LINE)
-535
-536    def line_break(self) -> Verbex:
-537        """Find a line break.
-538
-539        Returns:
-540            Modified Verbex object.
-541        """
-542        return self.find(SpecialChar.LINEBREAK)
-543
-544    def tab(self) -> Verbex:
-545        """Find a tab.
-546
-547        Returns:
-548            Modified Verbex object.
-549        """
-550        return self.find(SpecialChar.TAB)
-551
-552    def anything(self) -> Verbex:
-553        """Find anything one or more time.
-554
-555        Returns:
-556            Modified Verbex object.
-557        """
-558        return self._add(".+")
-559
-560    def as_few(self) -> Verbex:
-561        """Modify previous search to not be greedy.
-562
-563        Returns:
-564            Modified Verbex object.
-565        """
-566        return self._add("?")
-567
-568    @beartype
-569    def number_range(self, start: int, end: int) -> Verbex:
-570        """Generate a range of numbers.
-571
-572        Arguments:
-573            start -- Start of the range
-574            end -- End of the range
-575
-576        Returns:
-577            Modified Verbex object.
-578        """
-579        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
-580
-581    @beartype
-582    def letter_range(self, start: Char, end: Char) -> Verbex:
-583        """Generate a range of letters.
-584
-585        Arguments:
-586            start -- Start of the range
-587            end -- End of the range
-588
-589        Returns:
-590            Modified Verbex object.
-591        """
-592        return self._add(f"[{start}-{end}]")
-593
-594    def word(self) -> Verbex:
-595        """Find a word on word boundary.
-596
-597        Returns:
-598            Modified Verbex object.
-599        """
-600        return self._add("(\\b\\w+\\b)")
-601
-602    # # --------------- modifiers ------------------------
-603
-604    def with_any_case(self) -> Verbex:
-605        """Modify Verbex object to be case insensitive.
-606
-607        Returns:
-608            Modified Verbex object.
-609        """
-610        self._modifiers |= re.IGNORECASE
-611        return self
-612
-613    def search_by_line(self) -> Verbex:
-614        """Search each line, ^ and $ match begining and end of line respectively.
-615
-616        Returns:
-617            Modified Verbex object.
-618        """
-619        self._modifiers |= re.MULTILINE
-620        return self
-621
-622    def with_ascii(self) -> Verbex:
-623        """Match ascii instead of unicode.
-624
-625        Returns:
-626            Modified Verbex object.
-627        """
-628        self._modifiers |= re.ASCII
-629        return self
-
- -
- -

VerbalExpressions class.

- -

the following methods do not try to match the original js lib!

-
- - -
-
#   - -
@re_escape
-
@beartype
- - Verbex(modifiers: re.RegexFlag = ) -
- -
- View Source - 
206    @re_escape
-207    @beartype
-208    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
-209        """Create a Verbex object; setting any needed flags.
-210
-211        Keyword Arguments:
-212            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
-213        """
-214        # self._parts: List[str] = [text]
-215        self._parts: List[str] = []
-216        self._modifiers = modifiers
-
- -
- -

Create a Verbex object; setting any needed flags.

- -

Keyword Arguments: - modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})

-
- - -
-
-
#   - - EMPTY_REGEX_FLAG = -
- - - - -
-
-
#   - - modifiers: re.RegexFlag -
- - -

Return the modifiers for this Verbex object.

- -

Returns: - The modifiers applied to this object.

-
- - -
-
-
#   - - - def - regex(self) -> Pattern[str]: -
- -
- View Source - 
244    def regex(self) -> Pattern[str]:
-245        """Get a regular expression object."""
-246        return re.compile(
-247            str(self),
-248            self._modifiers,
-249        )
-
- -
- -

Get a regular expression object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - capture_group( - self, - name_or_text: Union[str, NoneType, verbex.verbex.Verbex, verbex.verbex.CharClass, verbex.verbex.SpecialChar] = None, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar, NoneType] = None -) -> verbex.verbex.Verbex: -
- -
- View Source - 
270    @re_escape
-271    @beartype
-272    @_poseur_decorator("self")
-273    def capture_group(
-274        self,
-275        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
-276        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
-277    ) -> Verbex:
-278        """Create a capture group.
-279
-280        Name is optional if not specified then the first argument is the text.
-281
-282        Keyword Arguments:
-283            name_or_text -- The name of the group / text to search for (default: {None})
-284            text -- The text to search for (default: {None})
-285
-286        Raises:
-287            ValueError: If name is specified then text must be as well.
-288
-289        Returns:
-290            Verbex with added capture group.
-291        """
-292        if name_or_text is not None:
-293            if text is None:
-294                _text = name_or_text
-295                return self._capture_group_without_name(_text)
-296            if isinstance(name_or_text, str):
-297                return self._capture_group_with_name(name_or_text, text)
-298        raise ValueError("text must be specified with optional name")
-
- -
- -

Create a capture group.

- -

Name is optional if not specified then the first argument is the text.

- -

Keyword Arguments: - name_or_text -- The name of the group / text to search for (default: {None}) - text -- The text to search for (default: {None})

- -

Raises: - ValueError: If name is specified then text must be as well.

- -

Returns: - Verbex with added capture group.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - OR( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
300    @re_escape
-301    @beartype
-302    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
-303        """`or` is a python keyword so we use `OR` instead.
-304
-305        Arguments:
-306            text -- Text to find or a Verbex object.
-307
-308        Returns:
-309            Modified Verbex object.
-310        """
-311        return self._add("|").find(text)
-
- -
- -

or is a python keyword so we use OR instead.

- -

Arguments: - text -- Text to find or a Verbex object.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - zero_or_more( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
313    @re_escape
-314    @beartype
-315    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-316        """Find the text or Verbex object zero or more times.
-317
-318        Arguments:
-319            text -- The text / Verbex object to look for.
-320
-321        Returns:
-322            Modified Verbex object.
-323        """
-324        return self._add(f"(?:{str(text)})*")
-
- -
- -

Find the text or Verbex object zero or more times.

- -

Arguments: - text -- The text / Verbex object to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - one_or_more( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
326    @re_escape
-327    @beartype
-328    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-329        """Find the text or Verbex object one or more times.
-330
-331        Arguments:
-332            text -- The text / Verbex object to look for.
-333
-334        Returns:
-335            Modified Verbex object.
-336        """
-337        return self._add(f"(?:{str(text)})+")
-
- -
- -

Find the text or Verbex object one or more times.

- -

Arguments: - text -- The text / Verbex object to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - n_times( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar], - n: int -) -> verbex.verbex.Verbex: -
- -
- View Source - 
339    @re_escape
-340    @beartype
-341    def n_times(
-342        self,
-343        text: VerbexEscapedCharClassOrSpecial,
-344        n: int,  # noqa: VNE001
-345    ) -> Verbex:
-346        """Find the text or Verbex object n or more times.
-347
-348        Arguments:
-349            text -- The text / Verbex object to look for.
-350
-351        Returns:
-352            Modified Verbex object.
-353        """
-354        return self._add(f"(?:{str(text)}){{{n}}}")
-
- -
- -

Find the text or Verbex object n or more times.

- -

Arguments: - text -- The text / Verbex object to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - n_times_or_more( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar], - n: int -) -> verbex.verbex.Verbex: -
- -
- View Source - 
356    @re_escape
-357    @beartype
-358    def n_times_or_more(
-359        self,
-360        text: VerbexEscapedCharClassOrSpecial,
-361        n: int,  # noqa: VNE001
-362    ) -> Verbex:
-363        """Find the text or Verbex object at least n times.
-364
-365        Arguments:
-366            text -- The text / Verbex object to look for.
-367
-368        Returns:
-369            Modified Verbex object.
-370        """
-371        return self._add(f"(?:{str(text)}){{{n},}}")
-
- -
- -

Find the text or Verbex object at least n times.

- -

Arguments: - text -- The text / Verbex object to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - n_to_m_times( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar], - n: int, - m: int -) -> verbex.verbex.Verbex: -
- -
- View Source - 
373    @re_escape
-374    @beartype
-375    def n_to_m_times(
-376        self,
-377        text: VerbexEscapedCharClassOrSpecial,
-378        n: int,  # noqa: VNE001
-379        m: int,  # noqa: VNE001
-380    ) -> Verbex:
-381        """Find the text or Verbex object between n and m times.
-382
-383        Arguments:
-384            text -- The text / Verbex object to look for.
-385
-386        Returns:
-387            Modified Verbex object.
-388        """
-389        return self._add(f"(?:{str(text)}){{{n},{m}}}")
-
- -
- -

Find the text or Verbex object between n and m times.

- -

Arguments: - text -- The text / Verbex object to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - maybe( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
391    @re_escape
-392    @beartype
-393    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-394        """Possibly find the text / Verbex object.
-395
-396        Arguments:
-397            text -- The text / Verbex object to possibly find.
-398
-399        Returns:
-400            Modified Verbex object.
-401        """
-402        return self._add(f"(?:{str(text)})?")
-
- -
- -

Possibly find the text / Verbex object.

- -

Arguments: - text -- The text / Verbex object to possibly find.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - find( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
404    @re_escape
-405    @beartype
-406    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-407        """Find the text or Verbex object.
-408
-409        Arguments:
-410            text -- The text / Verbex object to look for.
-411
-412        Returns:
-413            Modified Verbex object.
-414        """
-415        return self._add(str(text))
-
- -
- -

Find the text or Verbex object.

- -

Arguments: - text -- The text / Verbex object to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - then( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
417    @re_escape
-418    @beartype
-419    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-420        """Synonym for find.
-421
-422        Arguments:
-423            text -- The text / Verbex object to look for.
-424
-425        Returns:
-426            Modified Verbex object.
-427        """
-428        return self.find(text)
-
- -
- -

Synonym for find.

- -

Arguments: - text -- The text / Verbex object to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - followed_by( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
430    @re_escape
-431    @beartype
-432    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-433        """Match if string is followed by text.
-434
-435        Positive lookahead
-436
-437        Returns:
-438            Modified Verbex object.
-439        """
-440        return self._add(f"(?={text})")
-
- -
- -

Match if string is followed by text.

- -

Positive lookahead

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - not_followed_by( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
442    @re_escape
-443    @beartype
-444    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-445        """Match if string is not followed by text.
-446
-447        Negative lookahead
-448
-449        Returns:
-450            Modified Verbex object.
-451        """
-452        return self._add(f"(?!{text})")
-
- -
- -

Match if string is not followed by text.

- -

Negative lookahead

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - preceded_by( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
454    @re_escape
-455    @beartype
-456    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-457        """Match if string is not preceded by text.
-458
-459        Positive lookbehind
-460
-461        Returns:
-462            Modified Verbex object.
-463        """
-464        return self._add(f"(?<={text})")
-
- -
- -

Match if string is not preceded by text.

- -

Positive lookbehind

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - not_preceded_by( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
466    @re_escape
-467    @beartype
-468    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-469        """Match if string is not preceded by text.
-470
-471        Negative Lookbehind
-472
-473        Returns:
-474            Modified Verbex object.
-475        """
-476        return self._add(f"(?<!{text})")
-
- -
- -

Match if string is not preceded by text.

- -

Negative Lookbehind

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - any_of( - self, - chargroup: Union[str, verbex.verbex.CharClass] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
480    @re_escape
-481    @beartype
-482    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
-483        """Find anything in this group of chars or char class.
-484
-485        Arguments:
-486            text -- The characters to look for.
-487
-488        Returns:
-489            Modified Verbex object.
-490        """
-491        return self._add(f"(?:[{chargroup}])")
-
- -
- -

Find anything in this group of chars or char class.

- -

Arguments: - text -- The characters to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - not_any_of( - self, - text: Union[str, verbex.verbex.CharClass] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
493    @re_escape
-494    @beartype
-495    def not_any_of(self, text: CharClassOrChars) -> Verbex:
-496        """Find anything but this group of chars or char class.
-497
-498        Arguments:
-499            text -- The characters to not look for.
-500
-501        Returns:
-502            Modified Verbex object.
-503        """
-504        return self._add(f"(?:[^{text}])")
-
- -
- -

Find anything but this group of chars or char class.

- -

Arguments: - text -- The characters to not look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
- - def - anything_but( - self, - chargroup: Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
506    @re_escape
-507    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
-508        """Find anything one or more times but this group of chars or char class.
-509
-510        Arguments:
-511            text -- The characters to not look for.
-512
-513        Returns:
-514            Modified Verbex object.
-515        """
-516        return self._add(f"[^{chargroup}]+")
-
- -
- -

Find anything one or more times but this group of chars or char class.

- -

Arguments: - text -- The characters to not look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - start_of_line(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
520    def start_of_line(self) -> Verbex:
-521        """Find the start of the line.
-522
-523        Returns:
-524            Modified Verbex object.
-525        """
-526        return self.find(SpecialChar.START_OF_LINE)
-
- -
- -

Find the start of the line.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - end_of_line(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
528    def end_of_line(self) -> Verbex:
-529        """Find the end of the line.
-530
-531        Returns:
-532            Modified Verbex object.
-533        """
-534        return self.find(SpecialChar.END_OF_LINE)
-
- -
- -

Find the end of the line.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - line_break(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
536    def line_break(self) -> Verbex:
-537        """Find a line break.
-538
-539        Returns:
-540            Modified Verbex object.
-541        """
-542        return self.find(SpecialChar.LINEBREAK)
-
- -
- -

Find a line break.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - tab(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
544    def tab(self) -> Verbex:
-545        """Find a tab.
-546
-547        Returns:
-548            Modified Verbex object.
-549        """
-550        return self.find(SpecialChar.TAB)
-
- -
- -

Find a tab.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - anything(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
552    def anything(self) -> Verbex:
-553        """Find anything one or more time.
-554
-555        Returns:
-556            Modified Verbex object.
-557        """
-558        return self._add(".+")
-
- -
- -

Find anything one or more time.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - as_few(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
560    def as_few(self) -> Verbex:
-561        """Modify previous search to not be greedy.
-562
-563        Returns:
-564            Modified Verbex object.
-565        """
-566        return self._add("?")
-
- -
- -

Modify previous search to not be greedy.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@beartype
- - def - number_range(self, start: int, end: int) -> verbex.verbex.Verbex: -
- -
- View Source - 
568    @beartype
-569    def number_range(self, start: int, end: int) -> Verbex:
-570        """Generate a range of numbers.
-571
-572        Arguments:
-573            start -- Start of the range
-574            end -- End of the range
-575
-576        Returns:
-577            Modified Verbex object.
-578        """
-579        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
-
- -
- -

Generate a range of numbers.

- -

Arguments: - start -- Start of the range - end -- End of the range

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@beartype
- - def - letter_range( - self, - start: typing.Annotated[str, Is[_string_len_is_1]], - end: typing.Annotated[str, Is[_string_len_is_1]] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
581    @beartype
-582    def letter_range(self, start: Char, end: Char) -> Verbex:
-583        """Generate a range of letters.
-584
-585        Arguments:
-586            start -- Start of the range
-587            end -- End of the range
-588
-589        Returns:
-590            Modified Verbex object.
-591        """
-592        return self._add(f"[{start}-{end}]")
-
- -
- -

Generate a range of letters.

- -

Arguments: - start -- Start of the range - end -- End of the range

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - word(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
594    def word(self) -> Verbex:
-595        """Find a word on word boundary.
-596
-597        Returns:
-598            Modified Verbex object.
-599        """
-600        return self._add("(\\b\\w+\\b)")
-
- -
- -

Find a word on word boundary.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - with_any_case(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
604    def with_any_case(self) -> Verbex:
-605        """Modify Verbex object to be case insensitive.
-606
-607        Returns:
-608            Modified Verbex object.
-609        """
-610        self._modifiers |= re.IGNORECASE
-611        return self
-
- -
- -

Modify Verbex object to be case insensitive.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - search_by_line(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
613    def search_by_line(self) -> Verbex:
-614        """Search each line, ^ and $ match begining and end of line respectively.
-615
-616        Returns:
-617            Modified Verbex object.
-618        """
-619        self._modifiers |= re.MULTILINE
-620        return self
-
- -
- -

Search each line, ^ and $ match begining and end of line respectively.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - with_ascii(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
622    def with_ascii(self) -> Verbex:
-623        """Match ascii instead of unicode.
-624
-625        Returns:
-626            Modified Verbex object.
-627        """
-628        self._modifiers |= re.ASCII
-629        return self
-
- -
- -

Match ascii instead of unicode.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
- - \ No newline at end of file From cb25f044d72d2519809fb94e35fcf64abea71399 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 17:28:42 -0400 Subject: [PATCH 53/85] added auto doc generate pre-commit hook --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1f73439..14aad4e 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -203,7 +203,7 @@ repos: hooks: - id: pdoc name: "Generate Documentation" - description: 'Auto generating documentation with pdoc' + description: 'Auto generating documentation with PDOC' entry: pdoc args: [verbex, -o, docs] language: python From f7efcf5a7b0c0a21caaf6b7ee4d6c0b634d69ddd Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 17:31:32 -0400 Subject: [PATCH 54/85] added auto doc generate pre-commit hook --- verbex/verbex.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/verbex/verbex.py b/verbex/verbex.py index c383643..d47fd4d 100644 --- a/verbex/verbex.py +++ b/verbex/verbex.py @@ -45,7 +45,7 @@ def _string_len_is_1(text: object) -> bool: # work around for bug https://github.com/python/mypy/issues/12660 -# fixed in next version of mypy +# fixed in next version of mypy. @runtime_checkable class HasIter(Protocol): """Workaround for mypy P.args.""" From 38c60681fed3b7d7c7dcc775c1d6af0a65c25e16 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 17:34:11 -0400 Subject: [PATCH 55/85] added auto doc generate pre-commit hook --- .pre-commit-config.yaml | 1 - docs/index.html | 7 + docs/search.js | 46 + docs/verbex.html | 238 +++ docs/verbex/verbex.html | 3343 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 3634 insertions(+), 1 deletion(-) create mode 100644 docs/index.html create mode 100644 docs/search.js create mode 100644 docs/verbex.html create mode 100644 docs/verbex/verbex.html diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 14aad4e..f5d3702 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -213,4 +213,3 @@ repos: pass_filenames: false additional_dependencies: - beartype - stages: [post-commit] diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..97569ec --- /dev/null +++ b/docs/index.html @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/search.js b/docs/search.js new file mode 100644 index 0000000..87f83cf --- /dev/null +++ b/docs/search.js @@ -0,0 +1,46 @@ +window.pdocSearch = (function(){ +/** elasticlunr - http://weixsong.github.io * Copyright (C) 2017 Oliver Nightingale * Copyright (C) 2017 Wei Song * MIT Licensed */!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u0&&t.push(e);for(var i in n)"docs"!==i&&"df"!==i&&this.expandToken(e+i,t,n[i]);return t},t.InvertedIndex.prototype.toJSON=function(){return{root:this.root}},t.Configuration=function(e,n){var e=e||"";if(void 0==n||null==n)throw new Error("fields should not be null");this.config={};var i;try{i=JSON.parse(e),this.buildUserConfig(i,n)}catch(o){t.utils.warn("user configuration parse failed, will use default configuration"),this.buildDefaultConfig(n)}},t.Configuration.prototype.buildDefaultConfig=function(e){this.reset(),e.forEach(function(e){this.config[e]={boost:1,bool:"OR",expand:!1}},this)},t.Configuration.prototype.buildUserConfig=function(e,n){var i="OR",o=!1;if(this.reset(),"bool"in e&&(i=e.bool||i),"expand"in e&&(o=e.expand||o),"fields"in e)for(var r in e.fields)if(n.indexOf(r)>-1){var s=e.fields[r],u=o;void 0!=s.expand&&(u=s.expand),this.config[r]={boost:s.boost||0===s.boost?s.boost:1,bool:s.bool||i,expand:u}}else t.utils.warn("field name in user configuration not found in index instance fields");else this.addAllFields2UserConfig(i,o,n)},t.Configuration.prototype.addAllFields2UserConfig=function(e,t,n){n.forEach(function(n){this.config[n]={boost:1,bool:e,expand:t}},this)},t.Configuration.prototype.get=function(){return this.config},t.Configuration.prototype.reset=function(){this.config={}},lunr.SortedSet=function(){this.length=0,this.elements=[]},lunr.SortedSet.load=function(e){var t=new this;return t.elements=e,t.length=e.length,t},lunr.SortedSet.prototype.add=function(){var e,t;for(e=0;e1;){if(r===e)return o;e>r&&(t=o),r>e&&(n=o),i=n-t,o=t+Math.floor(i/2),r=this.elements[o]}return r===e?o:-1},lunr.SortedSet.prototype.locationFor=function(e){for(var t=0,n=this.elements.length,i=n-t,o=t+Math.floor(i/2),r=this.elements[o];i>1;)e>r&&(t=o),r>e&&(n=o),i=n-t,o=t+Math.floor(i/2),r=this.elements[o];return r>e?o:e>r?o+1:void 0},lunr.SortedSet.prototype.intersect=function(e){for(var t=new lunr.SortedSet,n=0,i=0,o=this.length,r=e.length,s=this.elements,u=e.elements;;){if(n>o-1||i>r-1)break;s[n]!==u[i]?s[n]u[i]&&i++:(t.add(s[n]),n++,i++)}return t},lunr.SortedSet.prototype.clone=function(){var e=new lunr.SortedSet;return e.elements=this.toArray(),e.length=e.elements.length,e},lunr.SortedSet.prototype.union=function(e){var t,n,i;this.length>=e.length?(t=this,n=e):(t=e,n=this),i=t.clone();for(var o=0,r=n.toArray();o

\n"}, {"fullname": "verbex.verbex", "modulename": "verbex.verbex", "type": "module", "doc": "

Generate regular expressions from an easier fluent verbal form.

\n"}, {"fullname": "verbex.verbex.P", "modulename": "verbex.verbex", "qualname": "P", "type": "variable", "doc": "

\n", "default_value": " = ~P"}, {"fullname": "verbex.verbex.HasIter", "modulename": "verbex.verbex", "qualname": "HasIter", "type": "class", "doc": "

Workaround for mypy P.args.

\n", "bases": "typing.Protocol"}, {"fullname": "verbex.verbex.HasIter.__init__", "modulename": "verbex.verbex", "qualname": "HasIter.__init__", "type": "function", "doc": "

\n", "signature": "(self, *args, **kwargs)", "funcdef": "def"}, {"fullname": "verbex.verbex.HasItems", "modulename": "verbex.verbex", "qualname": "HasItems", "type": "class", "doc": "

Workaround for mypy P.kwargs.

\n", "bases": "typing.Protocol"}, {"fullname": "verbex.verbex.HasItems.__init__", "modulename": "verbex.verbex", "qualname": "HasItems.__init__", "type": "function", "doc": "

\n", "signature": "(self, *args, **kwargs)", "funcdef": "def"}, {"fullname": "verbex.verbex.HasItems.items", "modulename": "verbex.verbex", "qualname": "HasItems.items", "type": "function", "doc": "

Object has items method.

\n\n

Returns:\n The dict of items.

\n", "signature": "(self) -> tuple[str, typing.Any]", "funcdef": "def"}, {"fullname": "verbex.verbex.EscapedText", "modulename": "verbex.verbex", "qualname": "EscapedText", "type": "class", "doc": "

Text that has been escaped for regex.

\n\n

Arguments:\n str -- Extend the string class.

\n", "bases": "builtins.str"}, {"fullname": "verbex.verbex.EscapedText.__init__", "modulename": "verbex.verbex", "qualname": "EscapedText.__init__", "type": "function", "doc": "

Return a escaped regex string.

\n\n

Arguments:\n value -- the string to escape

\n\n

Returns:\n _description_

\n", "signature": "(cls, value: str)", "funcdef": "def"}, {"fullname": "verbex.verbex.re_escape", "modulename": "verbex.verbex", "qualname": "re_escape", "type": "function", "doc": "

Automatically escape any string parameters as EscapedText.

\n\n

Arguments:\n func -- The function to decorate.

\n\n

Returns:\n The decorated function.

\n", "signature": "(\n func: collections.abc.Callable[~P, ~R]\n) -> collections.abc.Callable[~P, ~R]", "funcdef": "def"}, {"fullname": "verbex.verbex.CharClass", "modulename": "verbex.verbex", "qualname": "CharClass", "type": "class", "doc": "

Enum of character classes in regex.

\n\n

Arguments:\n Enum -- Extends the Enum class.

\n", "bases": "enum.Enum"}, {"fullname": "verbex.verbex.CharClass.DIGIT", "modulename": "verbex.verbex", "qualname": "CharClass.DIGIT", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.UPPERCASE_LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.UPPERCASE_LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.LOWERCASE_LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.LOWERCASE_LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.WHITESPACE", "modulename": "verbex.verbex", "qualname": "CharClass.WHITESPACE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.TAB", "modulename": "verbex.verbex", "qualname": "CharClass.TAB", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar", "modulename": "verbex.verbex", "qualname": "SpecialChar", "type": "class", "doc": "

Enum of special charaters, shorthand.

\n\n

Arguments:\n Enum -- Extends the Enum class.

\n", "bases": "enum.Enum"}, {"fullname": "verbex.verbex.SpecialChar.LINEBREAK", "modulename": "verbex.verbex", "qualname": "SpecialChar.LINEBREAK", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.START_OF_LINE", "modulename": "verbex.verbex", "qualname": "SpecialChar.START_OF_LINE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.END_OF_LINE", "modulename": "verbex.verbex", "qualname": "SpecialChar.END_OF_LINE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.TAB", "modulename": "verbex.verbex", "qualname": "SpecialChar.TAB", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClassOrChars", "modulename": "verbex.verbex", "qualname": "CharClassOrChars", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[str, verbex.verbex.CharClass]"}, {"fullname": "verbex.verbex.EscapedCharClassOrSpecial", "modulename": "verbex.verbex", "qualname": "EscapedCharClassOrSpecial", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]"}, {"fullname": "verbex.verbex.VerbexEscapedCharClassOrSpecial", "modulename": "verbex.verbex", "qualname": "VerbexEscapedCharClassOrSpecial", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[ForwardRef('Verbex'), str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]"}, {"fullname": "verbex.verbex.Verbex", "modulename": "verbex.verbex", "qualname": "Verbex", "type": "class", "doc": "

VerbalExpressions class.

\n\n

the following methods do not try to match the original js lib!

\n"}, {"fullname": "verbex.verbex.Verbex.__init__", "modulename": "verbex.verbex", "qualname": "Verbex.__init__", "type": "function", "doc": "

Create a Verbex object; setting any needed flags.

\n\n

Keyword Arguments:\n modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})

\n", "signature": "(self, modifiers: re.RegexFlag = )", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.EMPTY_REGEX_FLAG", "modulename": "verbex.verbex", "qualname": "Verbex.EMPTY_REGEX_FLAG", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.Verbex.modifiers", "modulename": "verbex.verbex", "qualname": "Verbex.modifiers", "type": "variable", "doc": "

Return the modifiers for this Verbex object.

\n\n

Returns:\n The modifiers applied to this object.

\n", "annotation": ": re.RegexFlag"}, {"fullname": "verbex.verbex.Verbex.regex", "modulename": "verbex.verbex", "qualname": "Verbex.regex", "type": "function", "doc": "

Get a regular expression object.

\n", "signature": "(self) -> Pattern[str]", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.capture_group", "modulename": "verbex.verbex", "qualname": "Verbex.capture_group", "type": "function", "doc": "

Create a capture group.

\n\n

Name is optional if not specified then the first argument is the text.

\n\n

Keyword Arguments:\n name_or_text -- The name of the group / text to search for (default: {None})\n text -- The text to search for (default: {None})

\n\n

Raises:\n ValueError: If name is specified then text must be as well.

\n\n

Returns:\n Verbex with added capture group.

\n", "signature": "(\n self,\n name_or_text: Union[str, NoneType, verbex.verbex.Verbex, verbex.verbex.CharClass, verbex.verbex.SpecialChar] = None,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar, NoneType] = None\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.OR", "modulename": "verbex.verbex", "qualname": "Verbex.OR", "type": "function", "doc": "

or is a python keyword so we use OR instead.

\n\n

Arguments:\n text -- Text to find or a Verbex object.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.zero_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.zero_or_more", "type": "function", "doc": "

Find the text or Verbex object zero or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.one_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.one_or_more", "type": "function", "doc": "

Find the text or Verbex object one or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_times", "modulename": "verbex.verbex", "qualname": "Verbex.n_times", "type": "function", "doc": "

Find the text or Verbex object n or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_times_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.n_times_or_more", "type": "function", "doc": "

Find the text or Verbex object at least n times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_to_m_times", "modulename": "verbex.verbex", "qualname": "Verbex.n_to_m_times", "type": "function", "doc": "

Find the text or Verbex object between n and m times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int,\n m: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.maybe", "modulename": "verbex.verbex", "qualname": "Verbex.maybe", "type": "function", "doc": "

Possibly find the text / Verbex object.

\n\n

Arguments:\n text -- The text / Verbex object to possibly find.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.find", "modulename": "verbex.verbex", "qualname": "Verbex.find", "type": "function", "doc": "

Find the text or Verbex object.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.then", "modulename": "verbex.verbex", "qualname": "Verbex.then", "type": "function", "doc": "

Synonym for find.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.followed_by", "modulename": "verbex.verbex", "qualname": "Verbex.followed_by", "type": "function", "doc": "

Match if string is followed by text.

\n\n

Positive lookahead

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_followed_by", "modulename": "verbex.verbex", "qualname": "Verbex.not_followed_by", "type": "function", "doc": "

Match if string is not followed by text.

\n\n

Negative lookahead

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.preceded_by", "modulename": "verbex.verbex", "qualname": "Verbex.preceded_by", "type": "function", "doc": "

Match if string is not preceded by text.

\n\n

Positive lookbehind

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_preceded_by", "modulename": "verbex.verbex", "qualname": "Verbex.not_preceded_by", "type": "function", "doc": "

Match if string is not preceded by text.

\n\n

Negative Lookbehind

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.any_of", "modulename": "verbex.verbex", "qualname": "Verbex.any_of", "type": "function", "doc": "

Find anything in this group of chars or char class.

\n\n

Arguments:\n text -- The characters to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n chargroup: Union[str, verbex.verbex.CharClass]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_any_of", "modulename": "verbex.verbex", "qualname": "Verbex.not_any_of", "type": "function", "doc": "

Find anything but this group of chars or char class.

\n\n

Arguments:\n text -- The characters to not look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[str, verbex.verbex.CharClass]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.anything_but", "modulename": "verbex.verbex", "qualname": "Verbex.anything_but", "type": "function", "doc": "

Find anything one or more times but this group of chars or char class.

\n\n

Arguments:\n text -- The characters to not look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n chargroup: Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.start_of_line", "modulename": "verbex.verbex", "qualname": "Verbex.start_of_line", "type": "function", "doc": "

Find the start of the line.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.end_of_line", "modulename": "verbex.verbex", "qualname": "Verbex.end_of_line", "type": "function", "doc": "

Find the end of the line.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.line_break", "modulename": "verbex.verbex", "qualname": "Verbex.line_break", "type": "function", "doc": "

Find a line break.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.tab", "modulename": "verbex.verbex", "qualname": "Verbex.tab", "type": "function", "doc": "

Find a tab.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.anything", "modulename": "verbex.verbex", "qualname": "Verbex.anything", "type": "function", "doc": "

Find anything one or more time.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.as_few", "modulename": "verbex.verbex", "qualname": "Verbex.as_few", "type": "function", "doc": "

Modify previous search to not be greedy.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.number_range", "modulename": "verbex.verbex", "qualname": "Verbex.number_range", "type": "function", "doc": "

Generate a range of numbers.

\n\n

Arguments:\n start -- Start of the range\n end -- End of the range

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self, start: int, end: int) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.letter_range", "modulename": "verbex.verbex", "qualname": "Verbex.letter_range", "type": "function", "doc": "

Generate a range of letters.

\n\n

Arguments:\n start -- Start of the range\n end -- End of the range

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n start: typing.Annotated[str, Is[_string_len_is_1]],\n end: typing.Annotated[str, Is[_string_len_is_1]]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.word", "modulename": "verbex.verbex", "qualname": "Verbex.word", "type": "function", "doc": "

Find a word on word boundary.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.with_any_case", "modulename": "verbex.verbex", "qualname": "Verbex.with_any_case", "type": "function", "doc": "

Modify Verbex object to be case insensitive.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.search_by_line", "modulename": "verbex.verbex", "qualname": "Verbex.search_by_line", "type": "function", "doc": "

Search each line, ^ and $ match begining and end of line respectively.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.with_ascii", "modulename": "verbex.verbex", "qualname": "Verbex.with_ascii", "type": "function", "doc": "

Match ascii instead of unicode.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}]; + + // mirrored in build-search-index.js (part 1) + // Also split on html tags. this is a cheap heuristic, but good enough. + elasticlunr.tokenizer.setSeperator(/[\s\-.;&_'"=,()]+|<[^>]*>/); + + let searchIndex; + if (docs._isPrebuiltIndex) { + console.info("using precompiled search index"); + searchIndex = elasticlunr.Index.load(docs); + } else { + console.time("building search index"); + // mirrored in build-search-index.js (part 2) + searchIndex = elasticlunr(function () { + this.pipeline.remove(elasticlunr.stemmer); + this.pipeline.remove(elasticlunr.stopWordFilter); + this.addField("qualname"); + this.addField("fullname"); + this.addField("annotation"); + this.addField("default_value"); + this.addField("signature"); + this.addField("bases"); + this.addField("doc"); + this.setRef("fullname"); + }); + for (let doc of docs) { + searchIndex.addDoc(doc); + } + console.timeEnd("building search index"); + } + + return (term) => searchIndex.search(term, { + fields: { + qualname: {boost: 4}, + fullname: {boost: 2}, + annotation: {boost: 2}, + default_value: {boost: 2}, + signature: {boost: 2}, + bases: {boost: 2}, + doc: {boost: 1}, + }, + expand: true + }); +})(); \ No newline at end of file diff --git a/docs/verbex.html b/docs/verbex.html new file mode 100644 index 0000000..189cab6 --- /dev/null +++ b/docs/verbex.html @@ -0,0 +1,238 @@ + + + + + + + verbex API documentation + + + + + + + + + +
+
+

+verbex

+ + +
+ View Source + 
0import importlib.metadata
+1
+2from .verbex import CharClass as CharClass
+3from .verbex import SpecialChar as SpecialChar
+4from .verbex import Verbex as Verbex
+5
+6__version__ = importlib.metadata.version("verbex")
+
+ +
+ +
+
+ + \ No newline at end of file diff --git a/docs/verbex/verbex.html b/docs/verbex/verbex.html new file mode 100644 index 0000000..59dc123 --- /dev/null +++ b/docs/verbex/verbex.html @@ -0,0 +1,3343 @@ + + + + + + + verbex.verbex API documentation + + + + + + + + + +
+
+

+verbex.verbex

+ +

Generate regular expressions from an easier fluent verbal form.

+
+ +
+ View Source + 
  0"""Generate regular expressions from an easier fluent verbal form."""
+  1from __future__ import annotations
+  2
+  3import re
+  4from enum import Enum
+  5from functools import wraps
+  6
+  7try:
+  8    from typing import (  # <--------------- if Python ≥ 3.9.0
+  9        Annotated,
+ 10        ParamSpec,
+ 11        Protocol,
+ 12        TypeAlias,
+ 13        runtime_checkable,
+ 14    )
+ 15except ImportError:
+ 16    from typing_extensions import TypeAlias, Protocol, Annotated, ParamSpec, runtime_checkable  # type: ignore # <--- if Python < 3.9.0 # noqa E501
+ 17
+ 18from typing import Pattern, TypeVar
+ 19
+ 20from beartype import beartype  # type: ignore
+ 21from beartype.typing import (  # type: ignore
+ 22    Any,
+ 23    Callable,
+ 24    Dict,
+ 25    Iterator,
+ 26    List,
+ 27    Optional,
+ 28    Tuple,
+ 29    Union,
+ 30    cast,
+ 31)
+ 32from beartype.vale import Is  # type: ignore
+ 33
+ 34
+ 35def _string_len_is_1(text: object) -> bool:
+ 36    return isinstance(text, str) and len(text) == 1
+ 37
+ 38
+ 39Char = Annotated[str, Is[_string_len_is_1]]
+ 40
+ 41
+ 42P = ParamSpec("P")  # noqa VNE001
+ 43R = TypeVar("R")  # noqa VNE001
+ 44
+ 45
+ 46# work around for bug https://github.com/python/mypy/issues/12660
+ 47# fixed in next version of mypy.
+ 48@runtime_checkable
+ 49class HasIter(Protocol):
+ 50    """Workaround for mypy P.args."""
+ 51
+ 52    def __iter__(self) -> Iterator[Any]:
+ 53        """Object can be iterated.
+ 54
+ 55        Yields:
+ 56            Next object.
+ 57        """
+ 58        ...
+ 59
+ 60
+ 61# work around for bug https://github.com/python/mypy/issues/12660
+ 62# fixed in next version of mypy
+ 63@runtime_checkable
+ 64class HasItems(Protocol):
+ 65    """Workaround for mypy P.kwargs."""
+ 66
+ 67    def items(self) -> Tuple[str, Any]:
+ 68        """Object has items method.
+ 69
+ 70        Returns:
+ 71            The dict of items.
+ 72        """
+ 73        ...
+ 74
+ 75
+ 76class EscapedText(str):
+ 77    """Text that has been escaped for regex.
+ 78
+ 79    Arguments:
+ 80        str -- Extend the string class.
+ 81    """
+ 82
+ 83    def __new__(cls, value: str) -> EscapedText:
+ 84        """Return a escaped regex string.
+ 85
+ 86        Arguments:
+ 87            value -- the string to escape
+ 88
+ 89        Returns:
+ 90            _description_
+ 91        """
+ 92        return str.__new__(cls, re.escape(value))
+ 93
+ 94
+ 95def re_escape(func: Callable[P, R]) -> Callable[P, R]:
+ 96    """Automatically escape any string parameters as EscapedText.
+ 97
+ 98    Arguments:
+ 99        func -- The function to decorate.
+100
+101    Returns:
+102        The decorated function.
+103    """
+104
+105    @wraps(func)
+106    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
+107        escaped_args: List[Any] = []
+108        escaped_kwargs: Dict[str, Any] = {}
+109        for arg in cast(HasIter, args):
+110            if not isinstance(arg, EscapedText) and isinstance(arg, str):
+111                escaped_args.append(EscapedText(arg))
+112            else:
+113                escaped_args.append(arg)
+114        arg_k: str
+115        arg_v: Any
+116        for arg_k, arg_v in cast(HasItems, kwargs).items():
+117            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
+118                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
+119            else:
+120                escaped_kwargs[arg_k] = arg_v
+121        return func(*escaped_args, **escaped_kwargs)  # type: ignore
+122
+123    return inner
+124
+125
+126class CharClass(Enum):
+127    """Enum of character classes in regex.
+128
+129    Arguments:
+130        Enum -- Extends the Enum class.
+131    """
+132
+133    DIGIT = "\\d"
+134    LETTER = "\\w"
+135    UPPERCASE_LETTER = "\\u"
+136    LOWERCASE_LETTER = "\\l"
+137    WHITESPACE = "\\s"
+138    TAB = "\\t"
+139
+140    def __str__(self) -> str:
+141        """To string method based on Enum value.
+142
+143        Returns:
+144            value of Enum
+145        """
+146        return self.value
+147
+148
+149class SpecialChar(Enum):
+150    """Enum of special charaters, shorthand.
+151
+152    Arguments:
+153        Enum -- Extends the Enum class.
+154    """
+155
+156    # does not work  / should not be used in [ ]
+157    LINEBREAK = "(\\n|(\\r\\n))"
+158    START_OF_LINE = "^"
+159    END_OF_LINE = "$"
+160    TAB = "\t"
+161
+162    def __str__(self) -> str:
+163        """To string for special chars enum.
+164
+165        Returns:
+166            Return value of enum as string.
+167        """
+168        return self.value
+169
+170
+171CharClassOrChars: TypeAlias = Union[str, CharClass]
+172EscapedCharClassOrSpecial: TypeAlias = Union[str, CharClass, SpecialChar]
+173VerbexEscapedCharClassOrSpecial: TypeAlias = Union["Verbex", EscapedCharClassOrSpecial]
+174
+175
+176def _poseur_decorator(*poseur: Any) -> Any:
+177    """Positional-only arguments runtime checker."""
+178    import functools
+179
+180    def caller(func: Callable[P, R]) -> Callable[P, R]:  # type: ignore
+181        @functools.wraps(func)
+182        def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
+183            poseur_args = set(poseur).intersection(kwargs)  # type: ignore
+184            if poseur_args:
+185                raise TypeError(
+186                    "%s() got some positional-only arguments passed as keyword"
+187                    " arguments: %r" % (func.__name__, ", ".join(poseur_args)),
+188                )
+189            return func(*args, **kwargs)  # type: ignore
+190
+191        return wrapper
+192
+193    return caller
+194
+195
+196class Verbex:
+197    """
+198    VerbalExpressions class.
+199
+200    the following methods do not try to match the original js lib!
+201    """
+202
+203    EMPTY_REGEX_FLAG = re.RegexFlag(0)
+204
+205    @re_escape
+206    @beartype
+207    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
+208        """Create a Verbex object; setting any needed flags.
+209
+210        Keyword Arguments:
+211            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
+212        """
+213        # self._parts: List[str] = [text]
+214        self._parts: List[str] = []
+215        self._modifiers = modifiers
+216
+217    @property
+218    def modifiers(self) -> re.RegexFlag:
+219        """Return the modifiers for this Verbex object.
+220
+221        Returns:
+222            The modifiers applied to this object.
+223        """
+224        return self._modifiers
+225
+226    def __str__(self) -> str:
+227        """Return regex string representation."""
+228        return "".join(self._parts)
+229
+230    @beartype
+231    def _add(self, value: Union[str, List[str]]) -> Verbex:
+232        """
+233        Append a transformed value to internal expression to be compiled.
+234
+235        As possible, this method should be "private".
+236        """
+237        if isinstance(value, list):
+238            self._parts.extend(value)
+239        else:
+240            self._parts.append(value)
+241        return self
+242
+243    def regex(self) -> Pattern[str]:
+244        """Get a regular expression object."""
+245        return re.compile(
+246            str(self),
+247            self._modifiers,
+248        )
+249
+250    # allow VerbexEscapedCharClassOrSpecial
+251
+252    @re_escape
+253    @beartype
+254    def _capture_group_with_name(
+255        self,
+256        name: str,
+257        text: VerbexEscapedCharClassOrSpecial,
+258    ) -> Verbex:
+259        return self._add(f"(?<{name}>{str(text)})")
+260
+261    @re_escape
+262    @beartype
+263    def _capture_group_without_name(
+264        self,
+265        text: VerbexEscapedCharClassOrSpecial,
+266    ) -> Verbex:
+267        return self._add(f"({str(text)})")
+268
+269    @re_escape
+270    @beartype
+271    @_poseur_decorator("self")
+272    def capture_group(
+273        self,
+274        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
+275        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
+276    ) -> Verbex:
+277        """Create a capture group.
+278
+279        Name is optional if not specified then the first argument is the text.
+280
+281        Keyword Arguments:
+282            name_or_text -- The name of the group / text to search for (default: {None})
+283            text -- The text to search for (default: {None})
+284
+285        Raises:
+286            ValueError: If name is specified then text must be as well.
+287
+288        Returns:
+289            Verbex with added capture group.
+290        """
+291        if name_or_text is not None:
+292            if text is None:
+293                _text = name_or_text
+294                return self._capture_group_without_name(_text)
+295            if isinstance(name_or_text, str):
+296                return self._capture_group_with_name(name_or_text, text)
+297        raise ValueError("text must be specified with optional name")
+298
+299    @re_escape
+300    @beartype
+301    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
+302        """`or` is a python keyword so we use `OR` instead.
+303
+304        Arguments:
+305            text -- Text to find or a Verbex object.
+306
+307        Returns:
+308            Modified Verbex object.
+309        """
+310        return self._add("|").find(text)
+311
+312    @re_escape
+313    @beartype
+314    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+315        """Find the text or Verbex object zero or more times.
+316
+317        Arguments:
+318            text -- The text / Verbex object to look for.
+319
+320        Returns:
+321            Modified Verbex object.
+322        """
+323        return self._add(f"(?:{str(text)})*")
+324
+325    @re_escape
+326    @beartype
+327    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+328        """Find the text or Verbex object one or more times.
+329
+330        Arguments:
+331            text -- The text / Verbex object to look for.
+332
+333        Returns:
+334            Modified Verbex object.
+335        """
+336        return self._add(f"(?:{str(text)})+")
+337
+338    @re_escape
+339    @beartype
+340    def n_times(
+341        self,
+342        text: VerbexEscapedCharClassOrSpecial,
+343        n: int,  # noqa: VNE001
+344    ) -> Verbex:
+345        """Find the text or Verbex object n or more times.
+346
+347        Arguments:
+348            text -- The text / Verbex object to look for.
+349
+350        Returns:
+351            Modified Verbex object.
+352        """
+353        return self._add(f"(?:{str(text)}){{{n}}}")
+354
+355    @re_escape
+356    @beartype
+357    def n_times_or_more(
+358        self,
+359        text: VerbexEscapedCharClassOrSpecial,
+360        n: int,  # noqa: VNE001
+361    ) -> Verbex:
+362        """Find the text or Verbex object at least n times.
+363
+364        Arguments:
+365            text -- The text / Verbex object to look for.
+366
+367        Returns:
+368            Modified Verbex object.
+369        """
+370        return self._add(f"(?:{str(text)}){{{n},}}")
+371
+372    @re_escape
+373    @beartype
+374    def n_to_m_times(
+375        self,
+376        text: VerbexEscapedCharClassOrSpecial,
+377        n: int,  # noqa: VNE001
+378        m: int,  # noqa: VNE001
+379    ) -> Verbex:
+380        """Find the text or Verbex object between n and m times.
+381
+382        Arguments:
+383            text -- The text / Verbex object to look for.
+384
+385        Returns:
+386            Modified Verbex object.
+387        """
+388        return self._add(f"(?:{str(text)}){{{n},{m}}}")
+389
+390    @re_escape
+391    @beartype
+392    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+393        """Possibly find the text / Verbex object.
+394
+395        Arguments:
+396            text -- The text / Verbex object to possibly find.
+397
+398        Returns:
+399            Modified Verbex object.
+400        """
+401        return self._add(f"(?:{str(text)})?")
+402
+403    @re_escape
+404    @beartype
+405    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+406        """Find the text or Verbex object.
+407
+408        Arguments:
+409            text -- The text / Verbex object to look for.
+410
+411        Returns:
+412            Modified Verbex object.
+413        """
+414        return self._add(str(text))
+415
+416    @re_escape
+417    @beartype
+418    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+419        """Synonym for find.
+420
+421        Arguments:
+422            text -- The text / Verbex object to look for.
+423
+424        Returns:
+425            Modified Verbex object.
+426        """
+427        return self.find(text)
+428
+429    @re_escape
+430    @beartype
+431    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+432        """Match if string is followed by text.
+433
+434        Positive lookahead
+435
+436        Returns:
+437            Modified Verbex object.
+438        """
+439        return self._add(f"(?={text})")
+440
+441    @re_escape
+442    @beartype
+443    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+444        """Match if string is not followed by text.
+445
+446        Negative lookahead
+447
+448        Returns:
+449            Modified Verbex object.
+450        """
+451        return self._add(f"(?!{text})")
+452
+453    @re_escape
+454    @beartype
+455    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+456        """Match if string is not preceded by text.
+457
+458        Positive lookbehind
+459
+460        Returns:
+461            Modified Verbex object.
+462        """
+463        return self._add(f"(?<={text})")
+464
+465    @re_escape
+466    @beartype
+467    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+468        """Match if string is not preceded by text.
+469
+470        Negative Lookbehind
+471
+472        Returns:
+473            Modified Verbex object.
+474        """
+475        return self._add(f"(?<!{text})")
+476
+477    # only allow CharclassOrChars
+478
+479    @re_escape
+480    @beartype
+481    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
+482        """Find anything in this group of chars or char class.
+483
+484        Arguments:
+485            text -- The characters to look for.
+486
+487        Returns:
+488            Modified Verbex object.
+489        """
+490        return self._add(f"(?:[{chargroup}])")
+491
+492    @re_escape
+493    @beartype
+494    def not_any_of(self, text: CharClassOrChars) -> Verbex:
+495        """Find anything but this group of chars or char class.
+496
+497        Arguments:
+498            text -- The characters to not look for.
+499
+500        Returns:
+501            Modified Verbex object.
+502        """
+503        return self._add(f"(?:[^{text}])")
+504
+505    @re_escape
+506    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
+507        """Find anything one or more times but this group of chars or char class.
+508
+509        Arguments:
+510            text -- The characters to not look for.
+511
+512        Returns:
+513            Modified Verbex object.
+514        """
+515        return self._add(f"[^{chargroup}]+")
+516
+517    # no text input
+518
+519    def start_of_line(self) -> Verbex:
+520        """Find the start of the line.
+521
+522        Returns:
+523            Modified Verbex object.
+524        """
+525        return self.find(SpecialChar.START_OF_LINE)
+526
+527    def end_of_line(self) -> Verbex:
+528        """Find the end of the line.
+529
+530        Returns:
+531            Modified Verbex object.
+532        """
+533        return self.find(SpecialChar.END_OF_LINE)
+534
+535    def line_break(self) -> Verbex:
+536        """Find a line break.
+537
+538        Returns:
+539            Modified Verbex object.
+540        """
+541        return self.find(SpecialChar.LINEBREAK)
+542
+543    def tab(self) -> Verbex:
+544        """Find a tab.
+545
+546        Returns:
+547            Modified Verbex object.
+548        """
+549        return self.find(SpecialChar.TAB)
+550
+551    def anything(self) -> Verbex:
+552        """Find anything one or more time.
+553
+554        Returns:
+555            Modified Verbex object.
+556        """
+557        return self._add(".+")
+558
+559    def as_few(self) -> Verbex:
+560        """Modify previous search to not be greedy.
+561
+562        Returns:
+563            Modified Verbex object.
+564        """
+565        return self._add("?")
+566
+567    @beartype
+568    def number_range(self, start: int, end: int) -> Verbex:
+569        """Generate a range of numbers.
+570
+571        Arguments:
+572            start -- Start of the range
+573            end -- End of the range
+574
+575        Returns:
+576            Modified Verbex object.
+577        """
+578        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
+579
+580    @beartype
+581    def letter_range(self, start: Char, end: Char) -> Verbex:
+582        """Generate a range of letters.
+583
+584        Arguments:
+585            start -- Start of the range
+586            end -- End of the range
+587
+588        Returns:
+589            Modified Verbex object.
+590        """
+591        return self._add(f"[{start}-{end}]")
+592
+593    def word(self) -> Verbex:
+594        """Find a word on word boundary.
+595
+596        Returns:
+597            Modified Verbex object.
+598        """
+599        return self._add("(\\b\\w+\\b)")
+600
+601    # # --------------- modifiers ------------------------
+602
+603    def with_any_case(self) -> Verbex:
+604        """Modify Verbex object to be case insensitive.
+605
+606        Returns:
+607            Modified Verbex object.
+608        """
+609        self._modifiers |= re.IGNORECASE
+610        return self
+611
+612    def search_by_line(self) -> Verbex:
+613        """Search each line, ^ and $ match begining and end of line respectively.
+614
+615        Returns:
+616            Modified Verbex object.
+617        """
+618        self._modifiers |= re.MULTILINE
+619        return self
+620
+621    def with_ascii(self) -> Verbex:
+622        """Match ascii instead of unicode.
+623
+624        Returns:
+625            Modified Verbex object.
+626        """
+627        self._modifiers |= re.ASCII
+628        return self
+629
+630
+631# left over notes from original version
+632# def __getattr__(self, attr):
+633#     """ any other function will be sent to the regex object """
+634#     regex = self.regex()
+635#     return getattr(regex, attr)
+636
+637# def replace(self, string, repl):
+638#     return self.sub(repl, string)
+639
+640
+641if __name__ == "__main__":
+642    pass
+
+ +
+ +
+
+
#   + + P = ~P +
+ + + + +
+
+
+ #   + +
@runtime_checkable
+ + class + HasIter(typing.Protocol): +
+ +
+ View Source + 
49@runtime_checkable
+50class HasIter(Protocol):
+51    """Workaround for mypy P.args."""
+52
+53    def __iter__(self) -> Iterator[Any]:
+54        """Object can be iterated.
+55
+56        Yields:
+57            Next object.
+58        """
+59        ...
+
+ +
+ +

Workaround for mypy P.args.

+
+ + +
+
#   + + + HasIter(*args, **kwargs) +
+ +
+ View Source + 
1429def _no_init_or_replace_init(self, *args, **kwargs):
+1430    cls = type(self)
+1431
+1432    if cls._is_protocol:
+1433        raise TypeError('Protocols cannot be instantiated')
+1434
+1435    # Already using a custom `__init__`. No need to calculate correct
+1436    # `__init__` to call. This can lead to RecursionError. See bpo-45121.
+1437    if cls.__init__ is not _no_init_or_replace_init:
+1438        return
+1439
+1440    # Initially, `__init__` of a protocol subclass is set to `_no_init_or_replace_init`.
+1441    # The first instantiation of the subclass will call `_no_init_or_replace_init` which
+1442    # searches for a proper new `__init__` in the MRO. The new `__init__`
+1443    # replaces the subclass' old `__init__` (ie `_no_init_or_replace_init`). Subsequent
+1444    # instantiation of the protocol subclass will thus use the new
+1445    # `__init__` and no longer call `_no_init_or_replace_init`.
+1446    for base in cls.__mro__:
+1447        init = base.__dict__.get('__init__', _no_init_or_replace_init)
+1448        if init is not _no_init_or_replace_init:
+1449            cls.__init__ = init
+1450            break
+1451    else:
+1452        # should not happen
+1453        cls.__init__ = object.__init__
+1454
+1455    cls.__init__(self, *args, **kwargs)
+
+ +
+ + + +
+
+
+
+ #   + +
@runtime_checkable
+ + class + HasItems(typing.Protocol): +
+ +
+ View Source + 
64@runtime_checkable
+65class HasItems(Protocol):
+66    """Workaround for mypy P.kwargs."""
+67
+68    def items(self) -> Tuple[str, Any]:
+69        """Object has items method.
+70
+71        Returns:
+72            The dict of items.
+73        """
+74        ...
+
+ +
+ +

Workaround for mypy P.kwargs.

+
+ + +
+
#   + + + HasItems(*args, **kwargs) +
+ +
+ View Source + 
1429def _no_init_or_replace_init(self, *args, **kwargs):
+1430    cls = type(self)
+1431
+1432    if cls._is_protocol:
+1433        raise TypeError('Protocols cannot be instantiated')
+1434
+1435    # Already using a custom `__init__`. No need to calculate correct
+1436    # `__init__` to call. This can lead to RecursionError. See bpo-45121.
+1437    if cls.__init__ is not _no_init_or_replace_init:
+1438        return
+1439
+1440    # Initially, `__init__` of a protocol subclass is set to `_no_init_or_replace_init`.
+1441    # The first instantiation of the subclass will call `_no_init_or_replace_init` which
+1442    # searches for a proper new `__init__` in the MRO. The new `__init__`
+1443    # replaces the subclass' old `__init__` (ie `_no_init_or_replace_init`). Subsequent
+1444    # instantiation of the protocol subclass will thus use the new
+1445    # `__init__` and no longer call `_no_init_or_replace_init`.
+1446    for base in cls.__mro__:
+1447        init = base.__dict__.get('__init__', _no_init_or_replace_init)
+1448        if init is not _no_init_or_replace_init:
+1449            cls.__init__ = init
+1450            break
+1451    else:
+1452        # should not happen
+1453        cls.__init__ = object.__init__
+1454
+1455    cls.__init__(self, *args, **kwargs)
+
+ +
+ + + +
+
+
#   + + + def + items(self) -> tuple[str, typing.Any]: +
+ +
+ View Source + 
68    def items(self) -> Tuple[str, Any]:
+69        """Object has items method.
+70
+71        Returns:
+72            The dict of items.
+73        """
+74        ...
+
+ +
+ +

Object has items method.

+ +

Returns: + The dict of items.

+
+ + +
+
+
+
+ #   + + + class + EscapedText(builtins.str): +
+ +
+ View Source + 
77class EscapedText(str):
+78    """Text that has been escaped for regex.
+79
+80    Arguments:
+81        str -- Extend the string class.
+82    """
+83
+84    def __new__(cls, value: str) -> EscapedText:
+85        """Return a escaped regex string.
+86
+87        Arguments:
+88            value -- the string to escape
+89
+90        Returns:
+91            _description_
+92        """
+93        return str.__new__(cls, re.escape(value))
+
+ +
+ +

Text that has been escaped for regex.

+ +

Arguments: + str -- Extend the string class.

+
+ + +
+
#   + + + EscapedText(value: str) +
+ +
+ View Source + 
84    def __new__(cls, value: str) -> EscapedText:
+85        """Return a escaped regex string.
+86
+87        Arguments:
+88            value -- the string to escape
+89
+90        Returns:
+91            _description_
+92        """
+93        return str.__new__(cls, re.escape(value))
+
+ +
+ +

Return a escaped regex string.

+ +

Arguments: + value -- the string to escape

+ +

Returns: + _description_

+
+ + +
+
+
Inherited Members
+
+
builtins.str
+
encode
+
replace
+
split
+
rsplit
+
join
+
capitalize
+
casefold
+
title
+
center
+
count
+
expandtabs
+
find
+
partition
+
index
+
ljust
+
lower
+
lstrip
+
rfind
+
rindex
+
rjust
+
rstrip
+
rpartition
+
splitlines
+
strip
+
swapcase
+
translate
+
upper
+
startswith
+
endswith
+
removeprefix
+
removesuffix
+
isascii
+
islower
+
isupper
+
istitle
+
isspace
+
isdecimal
+
isdigit
+
isnumeric
+
isalpha
+
isalnum
+
isidentifier
+
isprintable
+
zfill
+
format
+
format_map
+
maketrans
+ +
+
+
+
+
+
#   + + + def + re_escape( + func: collections.abc.Callable[~P, ~R] +) -> collections.abc.Callable[~P, ~R]: +
+ +
+ View Source + 
 96def re_escape(func: Callable[P, R]) -> Callable[P, R]:
+ 97    """Automatically escape any string parameters as EscapedText.
+ 98
+ 99    Arguments:
+100        func -- The function to decorate.
+101
+102    Returns:
+103        The decorated function.
+104    """
+105
+106    @wraps(func)
+107    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
+108        escaped_args: List[Any] = []
+109        escaped_kwargs: Dict[str, Any] = {}
+110        for arg in cast(HasIter, args):
+111            if not isinstance(arg, EscapedText) and isinstance(arg, str):
+112                escaped_args.append(EscapedText(arg))
+113            else:
+114                escaped_args.append(arg)
+115        arg_k: str
+116        arg_v: Any
+117        for arg_k, arg_v in cast(HasItems, kwargs).items():
+118            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
+119                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
+120            else:
+121                escaped_kwargs[arg_k] = arg_v
+122        return func(*escaped_args, **escaped_kwargs)  # type: ignore
+123
+124    return inner
+
+ +
+ +

Automatically escape any string parameters as EscapedText.

+ +

Arguments: + func -- The function to decorate.

+ +

Returns: + The decorated function.

+
+ + +
+
+
+ #   + + + class + CharClass(enum.Enum): +
+ +
+ View Source + 
127class CharClass(Enum):
+128    """Enum of character classes in regex.
+129
+130    Arguments:
+131        Enum -- Extends the Enum class.
+132    """
+133
+134    DIGIT = "\\d"
+135    LETTER = "\\w"
+136    UPPERCASE_LETTER = "\\u"
+137    LOWERCASE_LETTER = "\\l"
+138    WHITESPACE = "\\s"
+139    TAB = "\\t"
+140
+141    def __str__(self) -> str:
+142        """To string method based on Enum value.
+143
+144        Returns:
+145            value of Enum
+146        """
+147        return self.value
+
+ +
+ +

Enum of character classes in regex.

+ +

Arguments: + Enum -- Extends the Enum class.

+
+ + +
+
#   + + DIGIT = <CharClass.DIGIT: '\\d'> +
+ + + + +
+
+
#   + + LETTER = <CharClass.LETTER: '\\w'> +
+ + + + +
+
+
#   + + UPPERCASE_LETTER = <CharClass.UPPERCASE_LETTER: '\\u'> +
+ + + + +
+
+
#   + + LOWERCASE_LETTER = <CharClass.LOWERCASE_LETTER: '\\l'> +
+ + + + +
+
+
#   + + WHITESPACE = <CharClass.WHITESPACE: '\\s'> +
+ + + + +
+
+
#   + + TAB = <CharClass.TAB: '\\t'> +
+ + + + +
+
+
Inherited Members
+
+
enum.Enum
+
name
+
value
+ +
+
+
+
+
+
+ #   + + + class + SpecialChar(enum.Enum): +
+ +
+ View Source + 
150class SpecialChar(Enum):
+151    """Enum of special charaters, shorthand.
+152
+153    Arguments:
+154        Enum -- Extends the Enum class.
+155    """
+156
+157    # does not work  / should not be used in [ ]
+158    LINEBREAK = "(\\n|(\\r\\n))"
+159    START_OF_LINE = "^"
+160    END_OF_LINE = "$"
+161    TAB = "\t"
+162
+163    def __str__(self) -> str:
+164        """To string for special chars enum.
+165
+166        Returns:
+167            Return value of enum as string.
+168        """
+169        return self.value
+
+ +
+ +

Enum of special charaters, shorthand.

+ +

Arguments: + Enum -- Extends the Enum class.

+
+ + +
+
#   + + LINEBREAK = <SpecialChar.LINEBREAK: '(\\n|(\\r\\n))'> +
+ + + + +
+
+
#   + + START_OF_LINE = <SpecialChar.START_OF_LINE: '^'> +
+ + + + +
+
+
#   + + END_OF_LINE = <SpecialChar.END_OF_LINE: '$'> +
+ + + + +
+
+
#   + + TAB = <SpecialChar.TAB: '\t'> +
+ + + + +
+
+
Inherited Members
+
+
enum.Enum
+
name
+
value
+ +
+
+
+
+
+
#   + + CharClassOrChars: TypeAlias = typing.Union[str, verbex.verbex.CharClass] +
+ + + + +
+
+
#   + + EscapedCharClassOrSpecial: TypeAlias = typing.Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +
+ + + + +
+
+
#   + + VerbexEscapedCharClassOrSpecial: TypeAlias = typing.Union[ForwardRef('Verbex'), str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +
+ + + + +
+
+
+ #   + + + class + Verbex: +
+ +
+ View Source + 
197class Verbex:
+198    """
+199    VerbalExpressions class.
+200
+201    the following methods do not try to match the original js lib!
+202    """
+203
+204    EMPTY_REGEX_FLAG = re.RegexFlag(0)
+205
+206    @re_escape
+207    @beartype
+208    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
+209        """Create a Verbex object; setting any needed flags.
+210
+211        Keyword Arguments:
+212            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
+213        """
+214        # self._parts: List[str] = [text]
+215        self._parts: List[str] = []
+216        self._modifiers = modifiers
+217
+218    @property
+219    def modifiers(self) -> re.RegexFlag:
+220        """Return the modifiers for this Verbex object.
+221
+222        Returns:
+223            The modifiers applied to this object.
+224        """
+225        return self._modifiers
+226
+227    def __str__(self) -> str:
+228        """Return regex string representation."""
+229        return "".join(self._parts)
+230
+231    @beartype
+232    def _add(self, value: Union[str, List[str]]) -> Verbex:
+233        """
+234        Append a transformed value to internal expression to be compiled.
+235
+236        As possible, this method should be "private".
+237        """
+238        if isinstance(value, list):
+239            self._parts.extend(value)
+240        else:
+241            self._parts.append(value)
+242        return self
+243
+244    def regex(self) -> Pattern[str]:
+245        """Get a regular expression object."""
+246        return re.compile(
+247            str(self),
+248            self._modifiers,
+249        )
+250
+251    # allow VerbexEscapedCharClassOrSpecial
+252
+253    @re_escape
+254    @beartype
+255    def _capture_group_with_name(
+256        self,
+257        name: str,
+258        text: VerbexEscapedCharClassOrSpecial,
+259    ) -> Verbex:
+260        return self._add(f"(?<{name}>{str(text)})")
+261
+262    @re_escape
+263    @beartype
+264    def _capture_group_without_name(
+265        self,
+266        text: VerbexEscapedCharClassOrSpecial,
+267    ) -> Verbex:
+268        return self._add(f"({str(text)})")
+269
+270    @re_escape
+271    @beartype
+272    @_poseur_decorator("self")
+273    def capture_group(
+274        self,
+275        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
+276        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
+277    ) -> Verbex:
+278        """Create a capture group.
+279
+280        Name is optional if not specified then the first argument is the text.
+281
+282        Keyword Arguments:
+283            name_or_text -- The name of the group / text to search for (default: {None})
+284            text -- The text to search for (default: {None})
+285
+286        Raises:
+287            ValueError: If name is specified then text must be as well.
+288
+289        Returns:
+290            Verbex with added capture group.
+291        """
+292        if name_or_text is not None:
+293            if text is None:
+294                _text = name_or_text
+295                return self._capture_group_without_name(_text)
+296            if isinstance(name_or_text, str):
+297                return self._capture_group_with_name(name_or_text, text)
+298        raise ValueError("text must be specified with optional name")
+299
+300    @re_escape
+301    @beartype
+302    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
+303        """`or` is a python keyword so we use `OR` instead.
+304
+305        Arguments:
+306            text -- Text to find or a Verbex object.
+307
+308        Returns:
+309            Modified Verbex object.
+310        """
+311        return self._add("|").find(text)
+312
+313    @re_escape
+314    @beartype
+315    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+316        """Find the text or Verbex object zero or more times.
+317
+318        Arguments:
+319            text -- The text / Verbex object to look for.
+320
+321        Returns:
+322            Modified Verbex object.
+323        """
+324        return self._add(f"(?:{str(text)})*")
+325
+326    @re_escape
+327    @beartype
+328    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+329        """Find the text or Verbex object one or more times.
+330
+331        Arguments:
+332            text -- The text / Verbex object to look for.
+333
+334        Returns:
+335            Modified Verbex object.
+336        """
+337        return self._add(f"(?:{str(text)})+")
+338
+339    @re_escape
+340    @beartype
+341    def n_times(
+342        self,
+343        text: VerbexEscapedCharClassOrSpecial,
+344        n: int,  # noqa: VNE001
+345    ) -> Verbex:
+346        """Find the text or Verbex object n or more times.
+347
+348        Arguments:
+349            text -- The text / Verbex object to look for.
+350
+351        Returns:
+352            Modified Verbex object.
+353        """
+354        return self._add(f"(?:{str(text)}){{{n}}}")
+355
+356    @re_escape
+357    @beartype
+358    def n_times_or_more(
+359        self,
+360        text: VerbexEscapedCharClassOrSpecial,
+361        n: int,  # noqa: VNE001
+362    ) -> Verbex:
+363        """Find the text or Verbex object at least n times.
+364
+365        Arguments:
+366            text -- The text / Verbex object to look for.
+367
+368        Returns:
+369            Modified Verbex object.
+370        """
+371        return self._add(f"(?:{str(text)}){{{n},}}")
+372
+373    @re_escape
+374    @beartype
+375    def n_to_m_times(
+376        self,
+377        text: VerbexEscapedCharClassOrSpecial,
+378        n: int,  # noqa: VNE001
+379        m: int,  # noqa: VNE001
+380    ) -> Verbex:
+381        """Find the text or Verbex object between n and m times.
+382
+383        Arguments:
+384            text -- The text / Verbex object to look for.
+385
+386        Returns:
+387            Modified Verbex object.
+388        """
+389        return self._add(f"(?:{str(text)}){{{n},{m}}}")
+390
+391    @re_escape
+392    @beartype
+393    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+394        """Possibly find the text / Verbex object.
+395
+396        Arguments:
+397            text -- The text / Verbex object to possibly find.
+398
+399        Returns:
+400            Modified Verbex object.
+401        """
+402        return self._add(f"(?:{str(text)})?")
+403
+404    @re_escape
+405    @beartype
+406    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+407        """Find the text or Verbex object.
+408
+409        Arguments:
+410            text -- The text / Verbex object to look for.
+411
+412        Returns:
+413            Modified Verbex object.
+414        """
+415        return self._add(str(text))
+416
+417    @re_escape
+418    @beartype
+419    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+420        """Synonym for find.
+421
+422        Arguments:
+423            text -- The text / Verbex object to look for.
+424
+425        Returns:
+426            Modified Verbex object.
+427        """
+428        return self.find(text)
+429
+430    @re_escape
+431    @beartype
+432    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+433        """Match if string is followed by text.
+434
+435        Positive lookahead
+436
+437        Returns:
+438            Modified Verbex object.
+439        """
+440        return self._add(f"(?={text})")
+441
+442    @re_escape
+443    @beartype
+444    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+445        """Match if string is not followed by text.
+446
+447        Negative lookahead
+448
+449        Returns:
+450            Modified Verbex object.
+451        """
+452        return self._add(f"(?!{text})")
+453
+454    @re_escape
+455    @beartype
+456    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+457        """Match if string is not preceded by text.
+458
+459        Positive lookbehind
+460
+461        Returns:
+462            Modified Verbex object.
+463        """
+464        return self._add(f"(?<={text})")
+465
+466    @re_escape
+467    @beartype
+468    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+469        """Match if string is not preceded by text.
+470
+471        Negative Lookbehind
+472
+473        Returns:
+474            Modified Verbex object.
+475        """
+476        return self._add(f"(?<!{text})")
+477
+478    # only allow CharclassOrChars
+479
+480    @re_escape
+481    @beartype
+482    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
+483        """Find anything in this group of chars or char class.
+484
+485        Arguments:
+486            text -- The characters to look for.
+487
+488        Returns:
+489            Modified Verbex object.
+490        """
+491        return self._add(f"(?:[{chargroup}])")
+492
+493    @re_escape
+494    @beartype
+495    def not_any_of(self, text: CharClassOrChars) -> Verbex:
+496        """Find anything but this group of chars or char class.
+497
+498        Arguments:
+499            text -- The characters to not look for.
+500
+501        Returns:
+502            Modified Verbex object.
+503        """
+504        return self._add(f"(?:[^{text}])")
+505
+506    @re_escape
+507    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
+508        """Find anything one or more times but this group of chars or char class.
+509
+510        Arguments:
+511            text -- The characters to not look for.
+512
+513        Returns:
+514            Modified Verbex object.
+515        """
+516        return self._add(f"[^{chargroup}]+")
+517
+518    # no text input
+519
+520    def start_of_line(self) -> Verbex:
+521        """Find the start of the line.
+522
+523        Returns:
+524            Modified Verbex object.
+525        """
+526        return self.find(SpecialChar.START_OF_LINE)
+527
+528    def end_of_line(self) -> Verbex:
+529        """Find the end of the line.
+530
+531        Returns:
+532            Modified Verbex object.
+533        """
+534        return self.find(SpecialChar.END_OF_LINE)
+535
+536    def line_break(self) -> Verbex:
+537        """Find a line break.
+538
+539        Returns:
+540            Modified Verbex object.
+541        """
+542        return self.find(SpecialChar.LINEBREAK)
+543
+544    def tab(self) -> Verbex:
+545        """Find a tab.
+546
+547        Returns:
+548            Modified Verbex object.
+549        """
+550        return self.find(SpecialChar.TAB)
+551
+552    def anything(self) -> Verbex:
+553        """Find anything one or more time.
+554
+555        Returns:
+556            Modified Verbex object.
+557        """
+558        return self._add(".+")
+559
+560    def as_few(self) -> Verbex:
+561        """Modify previous search to not be greedy.
+562
+563        Returns:
+564            Modified Verbex object.
+565        """
+566        return self._add("?")
+567
+568    @beartype
+569    def number_range(self, start: int, end: int) -> Verbex:
+570        """Generate a range of numbers.
+571
+572        Arguments:
+573            start -- Start of the range
+574            end -- End of the range
+575
+576        Returns:
+577            Modified Verbex object.
+578        """
+579        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
+580
+581    @beartype
+582    def letter_range(self, start: Char, end: Char) -> Verbex:
+583        """Generate a range of letters.
+584
+585        Arguments:
+586            start -- Start of the range
+587            end -- End of the range
+588
+589        Returns:
+590            Modified Verbex object.
+591        """
+592        return self._add(f"[{start}-{end}]")
+593
+594    def word(self) -> Verbex:
+595        """Find a word on word boundary.
+596
+597        Returns:
+598            Modified Verbex object.
+599        """
+600        return self._add("(\\b\\w+\\b)")
+601
+602    # # --------------- modifiers ------------------------
+603
+604    def with_any_case(self) -> Verbex:
+605        """Modify Verbex object to be case insensitive.
+606
+607        Returns:
+608            Modified Verbex object.
+609        """
+610        self._modifiers |= re.IGNORECASE
+611        return self
+612
+613    def search_by_line(self) -> Verbex:
+614        """Search each line, ^ and $ match begining and end of line respectively.
+615
+616        Returns:
+617            Modified Verbex object.
+618        """
+619        self._modifiers |= re.MULTILINE
+620        return self
+621
+622    def with_ascii(self) -> Verbex:
+623        """Match ascii instead of unicode.
+624
+625        Returns:
+626            Modified Verbex object.
+627        """
+628        self._modifiers |= re.ASCII
+629        return self
+
+ +
+ +

VerbalExpressions class.

+ +

the following methods do not try to match the original js lib!

+
+ + +
+
#   + +
@re_escape
+
@beartype
+ + Verbex(modifiers: re.RegexFlag = ) +
+ +
+ View Source + 
206    @re_escape
+207    @beartype
+208    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
+209        """Create a Verbex object; setting any needed flags.
+210
+211        Keyword Arguments:
+212            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
+213        """
+214        # self._parts: List[str] = [text]
+215        self._parts: List[str] = []
+216        self._modifiers = modifiers
+
+ +
+ +

Create a Verbex object; setting any needed flags.

+ +

Keyword Arguments: + modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})

+
+ + +
+
+
#   + + EMPTY_REGEX_FLAG = +
+ + + + +
+
+
#   + + modifiers: re.RegexFlag +
+ + +

Return the modifiers for this Verbex object.

+ +

Returns: + The modifiers applied to this object.

+
+ + +
+
+
#   + + + def + regex(self) -> Pattern[str]: +
+ +
+ View Source + 
244    def regex(self) -> Pattern[str]:
+245        """Get a regular expression object."""
+246        return re.compile(
+247            str(self),
+248            self._modifiers,
+249        )
+
+ +
+ +

Get a regular expression object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + capture_group( + self, + name_or_text: Union[str, NoneType, verbex.verbex.Verbex, verbex.verbex.CharClass, verbex.verbex.SpecialChar] = None, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar, NoneType] = None +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
270    @re_escape
+271    @beartype
+272    @_poseur_decorator("self")
+273    def capture_group(
+274        self,
+275        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
+276        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
+277    ) -> Verbex:
+278        """Create a capture group.
+279
+280        Name is optional if not specified then the first argument is the text.
+281
+282        Keyword Arguments:
+283            name_or_text -- The name of the group / text to search for (default: {None})
+284            text -- The text to search for (default: {None})
+285
+286        Raises:
+287            ValueError: If name is specified then text must be as well.
+288
+289        Returns:
+290            Verbex with added capture group.
+291        """
+292        if name_or_text is not None:
+293            if text is None:
+294                _text = name_or_text
+295                return self._capture_group_without_name(_text)
+296            if isinstance(name_or_text, str):
+297                return self._capture_group_with_name(name_or_text, text)
+298        raise ValueError("text must be specified with optional name")
+
+ +
+ +

Create a capture group.

+ +

Name is optional if not specified then the first argument is the text.

+ +

Keyword Arguments: + name_or_text -- The name of the group / text to search for (default: {None}) + text -- The text to search for (default: {None})

+ +

Raises: + ValueError: If name is specified then text must be as well.

+ +

Returns: + Verbex with added capture group.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + OR( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
300    @re_escape
+301    @beartype
+302    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
+303        """`or` is a python keyword so we use `OR` instead.
+304
+305        Arguments:
+306            text -- Text to find or a Verbex object.
+307
+308        Returns:
+309            Modified Verbex object.
+310        """
+311        return self._add("|").find(text)
+
+ +
+ +

or is a python keyword so we use OR instead.

+ +

Arguments: + text -- Text to find or a Verbex object.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + zero_or_more( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
313    @re_escape
+314    @beartype
+315    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+316        """Find the text or Verbex object zero or more times.
+317
+318        Arguments:
+319            text -- The text / Verbex object to look for.
+320
+321        Returns:
+322            Modified Verbex object.
+323        """
+324        return self._add(f"(?:{str(text)})*")
+
+ +
+ +

Find the text or Verbex object zero or more times.

+ +

Arguments: + text -- The text / Verbex object to look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + one_or_more( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
326    @re_escape
+327    @beartype
+328    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+329        """Find the text or Verbex object one or more times.
+330
+331        Arguments:
+332            text -- The text / Verbex object to look for.
+333
+334        Returns:
+335            Modified Verbex object.
+336        """
+337        return self._add(f"(?:{str(text)})+")
+
+ +
+ +

Find the text or Verbex object one or more times.

+ +

Arguments: + text -- The text / Verbex object to look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + n_times( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar], + n: int +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
339    @re_escape
+340    @beartype
+341    def n_times(
+342        self,
+343        text: VerbexEscapedCharClassOrSpecial,
+344        n: int,  # noqa: VNE001
+345    ) -> Verbex:
+346        """Find the text or Verbex object n or more times.
+347
+348        Arguments:
+349            text -- The text / Verbex object to look for.
+350
+351        Returns:
+352            Modified Verbex object.
+353        """
+354        return self._add(f"(?:{str(text)}){{{n}}}")
+
+ +
+ +

Find the text or Verbex object n or more times.

+ +

Arguments: + text -- The text / Verbex object to look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + n_times_or_more( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar], + n: int +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
356    @re_escape
+357    @beartype
+358    def n_times_or_more(
+359        self,
+360        text: VerbexEscapedCharClassOrSpecial,
+361        n: int,  # noqa: VNE001
+362    ) -> Verbex:
+363        """Find the text or Verbex object at least n times.
+364
+365        Arguments:
+366            text -- The text / Verbex object to look for.
+367
+368        Returns:
+369            Modified Verbex object.
+370        """
+371        return self._add(f"(?:{str(text)}){{{n},}}")
+
+ +
+ +

Find the text or Verbex object at least n times.

+ +

Arguments: + text -- The text / Verbex object to look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + n_to_m_times( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar], + n: int, + m: int +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
373    @re_escape
+374    @beartype
+375    def n_to_m_times(
+376        self,
+377        text: VerbexEscapedCharClassOrSpecial,
+378        n: int,  # noqa: VNE001
+379        m: int,  # noqa: VNE001
+380    ) -> Verbex:
+381        """Find the text or Verbex object between n and m times.
+382
+383        Arguments:
+384            text -- The text / Verbex object to look for.
+385
+386        Returns:
+387            Modified Verbex object.
+388        """
+389        return self._add(f"(?:{str(text)}){{{n},{m}}}")
+
+ +
+ +

Find the text or Verbex object between n and m times.

+ +

Arguments: + text -- The text / Verbex object to look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + maybe( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
391    @re_escape
+392    @beartype
+393    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+394        """Possibly find the text / Verbex object.
+395
+396        Arguments:
+397            text -- The text / Verbex object to possibly find.
+398
+399        Returns:
+400            Modified Verbex object.
+401        """
+402        return self._add(f"(?:{str(text)})?")
+
+ +
+ +

Possibly find the text / Verbex object.

+ +

Arguments: + text -- The text / Verbex object to possibly find.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + find( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
404    @re_escape
+405    @beartype
+406    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+407        """Find the text or Verbex object.
+408
+409        Arguments:
+410            text -- The text / Verbex object to look for.
+411
+412        Returns:
+413            Modified Verbex object.
+414        """
+415        return self._add(str(text))
+
+ +
+ +

Find the text or Verbex object.

+ +

Arguments: + text -- The text / Verbex object to look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + then( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
417    @re_escape
+418    @beartype
+419    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+420        """Synonym for find.
+421
+422        Arguments:
+423            text -- The text / Verbex object to look for.
+424
+425        Returns:
+426            Modified Verbex object.
+427        """
+428        return self.find(text)
+
+ +
+ +

Synonym for find.

+ +

Arguments: + text -- The text / Verbex object to look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + followed_by( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
430    @re_escape
+431    @beartype
+432    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+433        """Match if string is followed by text.
+434
+435        Positive lookahead
+436
+437        Returns:
+438            Modified Verbex object.
+439        """
+440        return self._add(f"(?={text})")
+
+ +
+ +

Match if string is followed by text.

+ +

Positive lookahead

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + not_followed_by( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
442    @re_escape
+443    @beartype
+444    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+445        """Match if string is not followed by text.
+446
+447        Negative lookahead
+448
+449        Returns:
+450            Modified Verbex object.
+451        """
+452        return self._add(f"(?!{text})")
+
+ +
+ +

Match if string is not followed by text.

+ +

Negative lookahead

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + preceded_by( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
454    @re_escape
+455    @beartype
+456    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+457        """Match if string is not preceded by text.
+458
+459        Positive lookbehind
+460
+461        Returns:
+462            Modified Verbex object.
+463        """
+464        return self._add(f"(?<={text})")
+
+ +
+ +

Match if string is not preceded by text.

+ +

Positive lookbehind

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + not_preceded_by( + self, + text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
466    @re_escape
+467    @beartype
+468    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+469        """Match if string is not preceded by text.
+470
+471        Negative Lookbehind
+472
+473        Returns:
+474            Modified Verbex object.
+475        """
+476        return self._add(f"(?<!{text})")
+
+ +
+ +

Match if string is not preceded by text.

+ +

Negative Lookbehind

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + any_of( + self, + chargroup: Union[str, verbex.verbex.CharClass] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
480    @re_escape
+481    @beartype
+482    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
+483        """Find anything in this group of chars or char class.
+484
+485        Arguments:
+486            text -- The characters to look for.
+487
+488        Returns:
+489            Modified Verbex object.
+490        """
+491        return self._add(f"(?:[{chargroup}])")
+
+ +
+ +

Find anything in this group of chars or char class.

+ +

Arguments: + text -- The characters to look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+
@beartype
+ + def + not_any_of( + self, + text: Union[str, verbex.verbex.CharClass] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
493    @re_escape
+494    @beartype
+495    def not_any_of(self, text: CharClassOrChars) -> Verbex:
+496        """Find anything but this group of chars or char class.
+497
+498        Arguments:
+499            text -- The characters to not look for.
+500
+501        Returns:
+502            Modified Verbex object.
+503        """
+504        return self._add(f"(?:[^{text}])")
+
+ +
+ +

Find anything but this group of chars or char class.

+ +

Arguments: + text -- The characters to not look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@re_escape
+ + def + anything_but( + self, + chargroup: Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
506    @re_escape
+507    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
+508        """Find anything one or more times but this group of chars or char class.
+509
+510        Arguments:
+511            text -- The characters to not look for.
+512
+513        Returns:
+514            Modified Verbex object.
+515        """
+516        return self._add(f"[^{chargroup}]+")
+
+ +
+ +

Find anything one or more times but this group of chars or char class.

+ +

Arguments: + text -- The characters to not look for.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + start_of_line(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
520    def start_of_line(self) -> Verbex:
+521        """Find the start of the line.
+522
+523        Returns:
+524            Modified Verbex object.
+525        """
+526        return self.find(SpecialChar.START_OF_LINE)
+
+ +
+ +

Find the start of the line.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + end_of_line(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
528    def end_of_line(self) -> Verbex:
+529        """Find the end of the line.
+530
+531        Returns:
+532            Modified Verbex object.
+533        """
+534        return self.find(SpecialChar.END_OF_LINE)
+
+ +
+ +

Find the end of the line.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + line_break(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
536    def line_break(self) -> Verbex:
+537        """Find a line break.
+538
+539        Returns:
+540            Modified Verbex object.
+541        """
+542        return self.find(SpecialChar.LINEBREAK)
+
+ +
+ +

Find a line break.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + tab(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
544    def tab(self) -> Verbex:
+545        """Find a tab.
+546
+547        Returns:
+548            Modified Verbex object.
+549        """
+550        return self.find(SpecialChar.TAB)
+
+ +
+ +

Find a tab.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + anything(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
552    def anything(self) -> Verbex:
+553        """Find anything one or more time.
+554
+555        Returns:
+556            Modified Verbex object.
+557        """
+558        return self._add(".+")
+
+ +
+ +

Find anything one or more time.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + as_few(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
560    def as_few(self) -> Verbex:
+561        """Modify previous search to not be greedy.
+562
+563        Returns:
+564            Modified Verbex object.
+565        """
+566        return self._add("?")
+
+ +
+ +

Modify previous search to not be greedy.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@beartype
+ + def + number_range(self, start: int, end: int) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
568    @beartype
+569    def number_range(self, start: int, end: int) -> Verbex:
+570        """Generate a range of numbers.
+571
+572        Arguments:
+573            start -- Start of the range
+574            end -- End of the range
+575
+576        Returns:
+577            Modified Verbex object.
+578        """
+579        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
+
+ +
+ +

Generate a range of numbers.

+ +

Arguments: + start -- Start of the range + end -- End of the range

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + +
@beartype
+ + def + letter_range( + self, + start: typing.Annotated[str, Is[_string_len_is_1]], + end: typing.Annotated[str, Is[_string_len_is_1]] +) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
581    @beartype
+582    def letter_range(self, start: Char, end: Char) -> Verbex:
+583        """Generate a range of letters.
+584
+585        Arguments:
+586            start -- Start of the range
+587            end -- End of the range
+588
+589        Returns:
+590            Modified Verbex object.
+591        """
+592        return self._add(f"[{start}-{end}]")
+
+ +
+ +

Generate a range of letters.

+ +

Arguments: + start -- Start of the range + end -- End of the range

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + word(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
594    def word(self) -> Verbex:
+595        """Find a word on word boundary.
+596
+597        Returns:
+598            Modified Verbex object.
+599        """
+600        return self._add("(\\b\\w+\\b)")
+
+ +
+ +

Find a word on word boundary.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + with_any_case(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
604    def with_any_case(self) -> Verbex:
+605        """Modify Verbex object to be case insensitive.
+606
+607        Returns:
+608            Modified Verbex object.
+609        """
+610        self._modifiers |= re.IGNORECASE
+611        return self
+
+ +
+ +

Modify Verbex object to be case insensitive.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + search_by_line(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
613    def search_by_line(self) -> Verbex:
+614        """Search each line, ^ and $ match begining and end of line respectively.
+615
+616        Returns:
+617            Modified Verbex object.
+618        """
+619        self._modifiers |= re.MULTILINE
+620        return self
+
+ +
+ +

Search each line, ^ and $ match begining and end of line respectively.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
#   + + + def + with_ascii(self) -> verbex.verbex.Verbex: +
+ +
+ View Source + 
622    def with_ascii(self) -> Verbex:
+623        """Match ascii instead of unicode.
+624
+625        Returns:
+626            Modified Verbex object.
+627        """
+628        self._modifiers |= re.ASCII
+629        return self
+
+ +
+ +

Match ascii instead of unicode.

+ +

Returns: + Modified Verbex object.

+
+ + +
+
+
+ + \ No newline at end of file From f1d1caff6cb6e0eb7a2559c9fc167a909283b2bc Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 17:43:55 -0400 Subject: [PATCH 56/85] use importlib_metadata for python 3.7 --- docs/verbex.html | 17 ++++++++++------- verbex/__init__.py | 7 +++++-- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/docs/verbex.html b/docs/verbex.html index 189cab6..c89b400 100644 --- a/docs/verbex.html +++ b/docs/verbex.html @@ -44,13 +44,16 @@

View Source - 
0import importlib.metadata
-1
-2from .verbex import CharClass as CharClass
-3from .verbex import SpecialChar as SpecialChar
-4from .verbex import Verbex as Verbex
-5
-6__version__ = importlib.metadata.version("verbex")
+            
0try:
+1    from importlib.metadata import version
+2except ImportError:
+3    from importlib_metadata import version  # type: ignore
+4
+5from .verbex import CharClass as CharClass
+6from .verbex import SpecialChar as SpecialChar
+7from .verbex import Verbex as Verbex
+8
+9__version__ = version("verbex")
diff --git a/verbex/__init__.py b/verbex/__init__.py index 566fb9a..9d5e731 100644 --- a/verbex/__init__.py +++ b/verbex/__init__.py @@ -1,7 +1,10 @@ -import importlib.metadata +try: + from importlib.metadata import version +except ImportError: + from importlib_metadata import version # type: ignore from .verbex import CharClass as CharClass from .verbex import SpecialChar as SpecialChar from .verbex import Verbex as Verbex -__version__ = importlib.metadata.version("verbex") +__version__ = version("verbex") From a04e3cebddc9187338ac62c5256128b4b4095df5 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 17:52:35 -0400 Subject: [PATCH 57/85] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index e390a94..b9c53b1 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ Verbex: Python verbal based regular expressions ![Build Status](https://github.com/rbroderi/Verbex/actions/workflows/main.yml/badge.svg?event=push) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) +[![PyPI license](https://pypi.org/project/Verbex/)](https://www.gnu.org/licenses/gpl-3.0.en.html) ## Installation ```bash From 8bcc875dea72171ec3af63848222ca07e6f4c3da Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 18:00:28 -0400 Subject: [PATCH 58/85] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b9c53b1..2cb43f2 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,9 @@ Verbex: Python verbal based regular expressions ![Build Status](https://github.com/rbroderi/Verbex/actions/workflows/main.yml/badge.svg?event=push) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) -[![PyPI license](https://pypi.org/project/Verbex/)](https://www.gnu.org/licenses/gpl-3.0.en.html) +[![PyPI license](https://img.shields.io/pypi/l/verbex)](https://www.gnu.org/licenses/gpl-3.0.en.html) +[![PyPI pyversions](https://img.shields.io/pypi/pyversions/verbex)](https://pypi.python.org/pypi/ansicolortags/) +[![Generic badge](https://img.shields.io/badge/mypy-passed-green.svg)](https://shields.io/) ## Installation ```bash From cc9a299178bdfe494f8b6856739a6d40e706dfc6 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 22:04:37 -0400 Subject: [PATCH 59/85] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 2cb43f2..96f303c 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ Verbex: Python verbal based regular expressions [![PyPI license](https://img.shields.io/pypi/l/verbex)](https://www.gnu.org/licenses/gpl-3.0.en.html) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/verbex)](https://pypi.python.org/pypi/ansicolortags/) [![Generic badge](https://img.shields.io/badge/mypy-passed-green.svg)](https://shields.io/) +[![Generic badge](https://img.shields.io/badge/bandit-passed-green.svg)](https://shields.io/) ## Installation ```bash From 161b9211d07e3102e239bb0665bd6eeee82fee6a Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 22:07:26 -0400 Subject: [PATCH 60/85] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 96f303c..3a0a2b4 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,9 @@ Verbex: Python verbal based regular expressions [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) [![PyPI license](https://img.shields.io/pypi/l/verbex)](https://www.gnu.org/licenses/gpl-3.0.en.html) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/verbex)](https://pypi.python.org/pypi/ansicolortags/) -[![Generic badge](https://img.shields.io/badge/mypy-passed-green.svg)](https://shields.io/) -[![Generic badge](https://img.shields.io/badge/bandit-passed-green.svg)](https://shields.io/) +[![Generic badge](https://img.shields.io/badge/mypy-typed-purple.svg)](https://shields.io/) +[![Generic badge](https://img.shields.io/badge/bandit-checked-magenta.svg)](https://shields.io/) +[![Generic badge](https://img.shields.io/badge/flake8-linted-yellow.svg)](https://shields.io/) ## Installation ```bash From 10145fdf296c959f8b50f0855316d363f2d0e2a5 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 8 May 2022 22:11:03 -0400 Subject: [PATCH 61/85] Update README.md --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3a0a2b4..1e7daa8 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,10 @@ Verbex: Python verbal based regular expressions [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) [![PyPI license](https://img.shields.io/pypi/l/verbex)](https://www.gnu.org/licenses/gpl-3.0.en.html) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/verbex)](https://pypi.python.org/pypi/ansicolortags/) -[![Generic badge](https://img.shields.io/badge/mypy-typed-purple.svg)](https://shields.io/) -[![Generic badge](https://img.shields.io/badge/bandit-checked-magenta.svg)](https://shields.io/) -[![Generic badge](https://img.shields.io/badge/flake8-linted-yellow.svg)](https://shields.io/) +[![Generic badge](https://img.shields.io/badge/mypy-typed-purple.svg)](http://mypy-lang.org/) +[![Generic badge](https://img.shields.io/badge/beartype-runtime_typed-cyan.svg)](https://github.com/beartype/beartype) +[![Generic badge](https://img.shields.io/badge/bandit-checked-magenta.svg)](https://bandit.readthedocs.io/en/latest/) +[![Generic badge](https://img.shields.io/badge/flake8-linted-yellow.svg)](https://github.com/pycqa/flake8) ## Installation ```bash From fa07e9c2a8d1895032a72bd331e9e19039dc2b3b Mon Sep 17 00:00:00 2001 From: Richard Date: Wed, 11 May 2022 21:20:07 -0400 Subject: [PATCH 62/85] add pycln --- .pre-commit-config.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index f5d3702..516a623 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -52,6 +52,11 @@ repos: name: "Python: Formating files" args: [--line-length=88, --preview, --safe] types: [file, python] + - repo: https://github.com/hadialqattan/pycln + rev: v1.3.2 + hooks: + - id: pycln + name: "Python: remove unused imports." - repo: https://github.com/asottile/blacken-docs rev: v1.12.1 hooks: From e55e48e21e8f227012fca975e5aba37afaaa5d38 Mon Sep 17 00:00:00 2001 From: Richard Date: Wed, 11 May 2022 22:29:09 -0400 Subject: [PATCH 63/85] updated pre-commit tests --- .pre-commit-config.yaml | 15 +- .vscode/settings.json | 4 + check_names.py | 26 +- docs/verbex/verbex.html | 2881 ++++++++++++++++++++------------------- verbex/verbex.py | 11 +- 5 files changed, 1479 insertions(+), 1458 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 516a623..b6a5152 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -52,6 +52,12 @@ repos: name: "Python: Formating files" args: [--line-length=88, --preview, --safe] types: [file, python] + - repo: https://github.com/asottile/pyupgrade + rev: v2.32.1 + hooks: + - id: pyupgrade + name: "Python: upgrade syntax" + args: [--py37-plus] - repo: https://github.com/hadialqattan/pycln rev: v1.3.2 hooks: @@ -93,6 +99,7 @@ repos: # making isort line length compatible with black - "--max-line-length=88" - "--max-complexity=18" + - "--kwargs-max-positional-arguments=4" # allowing these errors now that in the past we ignored. # D100 Missing docstring in public module # D103 Missing docstring in public function @@ -131,7 +138,13 @@ repos: - flake8-colors - flake8-tuple - pandas-vet - # - wemake-python-styleguide + - flake8-length + - flake8-assertive + - flake8-warnings + - flake8-comprehensions + - flake8-simplify + - flake8-noqa + - flake8-force-keyword-arguments exclude: "setup[.]py|conf[.]py|__init__[.]py" types: [file, python] - repo: https://github.com/asottile/add-trailing-comma diff --git a/.vscode/settings.json b/.vscode/settings.json index 19a66dd..3a46794 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -12,5 +12,9 @@ "pylance", "pyright", "Verbex" + ], + "python.linting.flake8Enabled": true, + "python.linting.flake8Args": [ + "--ignore=E501" ] } diff --git a/check_names.py b/check_names.py index b6d6eeb..3525104 100644 --- a/check_names.py +++ b/check_names.py @@ -50,20 +50,18 @@ def main() -> int: print(f"ERROR: '{module_name}' is not all lowercase with underscores") return ExitCode.DATA_ERR # check package if exists - if package_name.strip() != "": - # check package name - if not re.fullmatch("[A-Za-z]+", package_name): - if re.fullmatch("[A-Za-z0-9]+", package_name): - print( - f"WARNING: '{package_name}' has numbers - allowing but note" - " this is not 'strictly' to pep 8 best practices", - ) - else: - print( - f"ERROR: '{package_name}' is not all lowercase with no" - " underscores", - ) - return ExitCode.DATA_ERR + # check package name + if package_name.strip() != "" and not re.fullmatch("[A-Za-z]+", package_name): + if re.fullmatch("[A-Za-z0-9]+", package_name): + print( + f"WARNING: '{package_name}' has numbers - allowing but note" + " this is not 'strictly' to pep 8 best practices", + ) + else: + print( + f"ERROR: '{package_name}' is not all lowercase with no underscores", + ) + return ExitCode.DATA_ERR return ExitCode.OK diff --git a/docs/verbex/verbex.html b/docs/verbex/verbex.html index 59dc123..17bbb44 100644 --- a/docs/verbex/verbex.html +++ b/docs/verbex/verbex.html @@ -261,631 +261,634 @@

15except ImportError: 16 from typing_extensions import TypeAlias, Protocol, Annotated, ParamSpec, runtime_checkable # type: ignore # <--- if Python < 3.9.0 # noqa E501 17 - 18from typing import Pattern, TypeVar + 18from typing import TYPE_CHECKING, Pattern, TypeVar 19 - 20from beartype import beartype # type: ignore - 21from beartype.typing import ( # type: ignore - 22 Any, - 23 Callable, - 24 Dict, - 25 Iterator, - 26 List, - 27 Optional, - 28 Tuple, - 29 Union, - 30 cast, - 31) - 32from beartype.vale import Is # type: ignore - 33 - 34 - 35def _string_len_is_1(text: object) -> bool: - 36 return isinstance(text, str) and len(text) == 1 + 20if TYPE_CHECKING: + 21 from typing import Protocol # noqa: F811 + 22 + 23from beartype import beartype # type: ignore + 24from beartype.typing import ( # type: ignore + 25 Any, + 26 Callable, + 27 Dict, + 28 Iterator, + 29 List, + 30 Optional, + 31 Tuple, + 32 Union, + 33 cast, + 34) + 35from beartype.vale import Is # type: ignore + 36 37 - 38 - 39Char = Annotated[str, Is[_string_len_is_1]] + 38def _string_len_is_1(text: object) -> bool: + 39 return isinstance(text, str) and len(text) == 1 40 41 - 42P = ParamSpec("P") # noqa VNE001 - 43R = TypeVar("R") # noqa VNE001 + 42Char = Annotated[str, Is[_string_len_is_1]] + 43 44 - 45 - 46# work around for bug https://github.com/python/mypy/issues/12660 - 47# fixed in next version of mypy. - 48@runtime_checkable - 49class HasIter(Protocol): - 50 """Workaround for mypy P.args.""" - 51 - 52 def __iter__(self) -> Iterator[Any]: - 53 """Object can be iterated. + 45P = ParamSpec("P") # noqa: VNE001 + 46R = TypeVar("R") # noqa: VNE001 + 47 + 48 + 49# work around for bug https://github.com/python/mypy/issues/12660 + 50# fixed in next version of mypy. + 51@runtime_checkable + 52class HasIter(Protocol): + 53 """Workaround for mypy P.args.""" 54 - 55 Yields: - 56 Next object. - 57 """ - 58 ... - 59 - 60 - 61# work around for bug https://github.com/python/mypy/issues/12660 - 62# fixed in next version of mypy - 63@runtime_checkable - 64class HasItems(Protocol): - 65 """Workaround for mypy P.kwargs.""" - 66 - 67 def items(self) -> Tuple[str, Any]: - 68 """Object has items method. + 55 def __iter__(self) -> Iterator[Any]: + 56 """Object can be iterated. + 57 + 58 Yields: + 59 Next object. + 60 """ + 61 ... + 62 + 63 + 64# work around for bug https://github.com/python/mypy/issues/12660 + 65# fixed in next version of mypy + 66@runtime_checkable + 67class HasItems(Protocol): + 68 """Workaround for mypy P.kwargs.""" 69 - 70 Returns: - 71 The dict of items. - 72 """ - 73 ... - 74 - 75 - 76class EscapedText(str): - 77 """Text that has been escaped for regex. + 70 def items(self) -> Tuple[str, Any]: + 71 """Object has items method. + 72 + 73 Returns: + 74 The dict of items. + 75 """ + 76 ... + 77 78 - 79 Arguments: - 80 str -- Extend the string class. - 81 """ - 82 - 83 def __new__(cls, value: str) -> EscapedText: - 84 """Return a escaped regex string. + 79class EscapedText(str): + 80 """Text that has been escaped for regex. + 81 + 82 Arguments: + 83 str -- Extend the string class. + 84 """ 85 - 86 Arguments: - 87 value -- the string to escape + 86 def __new__(cls, value: str) -> EscapedText: + 87 """Return a escaped regex string. 88 - 89 Returns: - 90 _description_ - 91 """ - 92 return str.__new__(cls, re.escape(value)) - 93 - 94 - 95def re_escape(func: Callable[P, R]) -> Callable[P, R]: - 96 """Automatically escape any string parameters as EscapedText. + 89 Arguments: + 90 value -- the string to escape + 91 + 92 Returns: + 93 _description_ + 94 """ + 95 return str.__new__(cls, re.escape(value)) + 96 97 - 98 Arguments: - 99 func -- The function to decorate. + 98def re_escape(func: Callable[P, R]) -> Callable[P, R]: + 99 """Automatically escape any string parameters as EscapedText. 100 -101 Returns: -102 The decorated function. -103 """ -104 -105 @wraps(func) -106 def inner(*args: P.args, **kwargs: P.kwargs) -> R: # type: ignore -107 escaped_args: List[Any] = [] -108 escaped_kwargs: Dict[str, Any] = {} -109 for arg in cast(HasIter, args): -110 if not isinstance(arg, EscapedText) and isinstance(arg, str): -111 escaped_args.append(EscapedText(arg)) -112 else: -113 escaped_args.append(arg) -114 arg_k: str -115 arg_v: Any -116 for arg_k, arg_v in cast(HasItems, kwargs).items(): -117 if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str): -118 escaped_kwargs[arg_k] = EscapedText(str(arg_v)) -119 else: -120 escaped_kwargs[arg_k] = arg_v -121 return func(*escaped_args, **escaped_kwargs) # type: ignore -122 -123 return inner -124 +101 Arguments: +102 func -- The function to decorate. +103 +104 Returns: +105 The decorated function. +106 """ +107 +108 @wraps(func) +109 def inner(*args: P.args, **kwargs: P.kwargs) -> R: # type: ignore +110 escaped_args: List[Any] = [] +111 escaped_kwargs: Dict[str, Any] = {} +112 for arg in cast(HasIter, args): +113 if not isinstance(arg, EscapedText) and isinstance(arg, str): +114 escaped_args.append(EscapedText(arg)) +115 else: +116 escaped_args.append(arg) +117 arg_k: str +118 arg_v: Any +119 for arg_k, arg_v in cast(HasItems, kwargs).items(): +120 if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str): +121 escaped_kwargs[arg_k] = EscapedText(str(arg_v)) +122 else: +123 escaped_kwargs[arg_k] = arg_v +124 return func(*escaped_args, **escaped_kwargs) # type: ignore 125 -126class CharClass(Enum): -127 """Enum of character classes in regex. +126 return inner +127 128 -129 Arguments: -130 Enum -- Extends the Enum class. -131 """ -132 -133 DIGIT = "\\d" -134 LETTER = "\\w" -135 UPPERCASE_LETTER = "\\u" -136 LOWERCASE_LETTER = "\\l" -137 WHITESPACE = "\\s" -138 TAB = "\\t" -139 -140 def __str__(self) -> str: -141 """To string method based on Enum value. +129class CharClass(Enum): +130 """Enum of character classes in regex. +131 +132 Arguments: +133 Enum -- Extends the Enum class. +134 """ +135 +136 DIGIT = "\\d" +137 LETTER = "\\w" +138 UPPERCASE_LETTER = "\\u" +139 LOWERCASE_LETTER = "\\l" +140 WHITESPACE = "\\s" +141 TAB = "\\t" 142 -143 Returns: -144 value of Enum -145 """ -146 return self.value -147 -148 -149class SpecialChar(Enum): -150 """Enum of special charaters, shorthand. +143 def __str__(self) -> str: +144 """To string method based on Enum value. +145 +146 Returns: +147 value of Enum +148 """ +149 return self.value +150 151 -152 Arguments: -153 Enum -- Extends the Enum class. -154 """ -155 -156 # does not work / should not be used in [ ] -157 LINEBREAK = "(\\n|(\\r\\n))" -158 START_OF_LINE = "^" -159 END_OF_LINE = "$" -160 TAB = "\t" -161 -162 def __str__(self) -> str: -163 """To string for special chars enum. +152class SpecialChar(Enum): +153 """Enum of special charaters, shorthand. +154 +155 Arguments: +156 Enum -- Extends the Enum class. +157 """ +158 +159 # does not work / should not be used in [ ] +160 LINEBREAK = "(\\n|(\\r\\n))" +161 START_OF_LINE = "^" +162 END_OF_LINE = "$" +163 TAB = "\t" 164 -165 Returns: -166 Return value of enum as string. -167 """ -168 return self.value -169 -170 -171CharClassOrChars: TypeAlias = Union[str, CharClass] -172EscapedCharClassOrSpecial: TypeAlias = Union[str, CharClass, SpecialChar] -173VerbexEscapedCharClassOrSpecial: TypeAlias = Union["Verbex", EscapedCharClassOrSpecial] -174 -175 -176def _poseur_decorator(*poseur: Any) -> Any: -177 """Positional-only arguments runtime checker.""" -178 import functools -179 -180 def caller(func: Callable[P, R]) -> Callable[P, R]: # type: ignore -181 @functools.wraps(func) -182 def wrapper(*args: P.args, **kwargs: P.kwargs) -> R: -183 poseur_args = set(poseur).intersection(kwargs) # type: ignore -184 if poseur_args: -185 raise TypeError( -186 "%s() got some positional-only arguments passed as keyword" -187 " arguments: %r" % (func.__name__, ", ".join(poseur_args)), -188 ) -189 return func(*args, **kwargs) # type: ignore -190 -191 return wrapper -192 -193 return caller -194 +165 def __str__(self) -> str: +166 """To string for special chars enum. +167 +168 Returns: +169 Return value of enum as string. +170 """ +171 return self.value +172 +173 +174CharClassOrChars: TypeAlias = Union[str, CharClass] +175EscapedCharClassOrSpecial: TypeAlias = Union[str, CharClass, SpecialChar] +176VerbexEscapedCharClassOrSpecial: TypeAlias = Union["Verbex", EscapedCharClassOrSpecial] +177 +178 +179def _poseur_decorator(*poseur: Any) -> Any: +180 """Positional-only arguments runtime checker.""" +181 import functools +182 +183 def caller(func: Callable[P, R]) -> Callable[P, R]: # type: ignore +184 @functools.wraps(func) +185 def wrapper(*args: P.args, **kwargs: P.kwargs) -> R: +186 poseur_args = set(poseur).intersection(kwargs) # type: ignore +187 if poseur_args: +188 raise TypeError( +189 "%s() got some positional-only arguments passed as keyword" +190 " arguments: %r" % (func.__name__, ", ".join(poseur_args)), +191 ) +192 return func(*args, **kwargs) # type: ignore +193 +194 return wrapper 195 -196class Verbex: -197 """ -198 VerbalExpressions class. -199 -200 the following methods do not try to match the original js lib! -201 """ +196 return caller +197 +198 +199class Verbex: +200 """ +201 VerbalExpressions class. 202 -203 EMPTY_REGEX_FLAG = re.RegexFlag(0) -204 -205 @re_escape -206 @beartype -207 def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG): -208 """Create a Verbex object; setting any needed flags. -209 -210 Keyword Arguments: -211 modifiers -- Regex modifying flags (default: {re.RegexFlag(0)}) -212 """ -213 # self._parts: List[str] = [text] -214 self._parts: List[str] = [] -215 self._modifiers = modifiers -216 -217 @property -218 def modifiers(self) -> re.RegexFlag: -219 """Return the modifiers for this Verbex object. -220 -221 Returns: -222 The modifiers applied to this object. -223 """ -224 return self._modifiers -225 -226 def __str__(self) -> str: -227 """Return regex string representation.""" -228 return "".join(self._parts) -229 -230 @beartype -231 def _add(self, value: Union[str, List[str]]) -> Verbex: -232 """ -233 Append a transformed value to internal expression to be compiled. -234 -235 As possible, this method should be "private". -236 """ -237 if isinstance(value, list): -238 self._parts.extend(value) -239 else: -240 self._parts.append(value) -241 return self -242 -243 def regex(self) -> Pattern[str]: -244 """Get a regular expression object.""" -245 return re.compile( -246 str(self), -247 self._modifiers, -248 ) -249 -250 # allow VerbexEscapedCharClassOrSpecial -251 -252 @re_escape -253 @beartype -254 def _capture_group_with_name( -255 self, -256 name: str, -257 text: VerbexEscapedCharClassOrSpecial, -258 ) -> Verbex: -259 return self._add(f"(?<{name}>{str(text)})") -260 -261 @re_escape -262 @beartype -263 def _capture_group_without_name( -264 self, -265 text: VerbexEscapedCharClassOrSpecial, -266 ) -> Verbex: -267 return self._add(f"({str(text)})") -268 -269 @re_escape -270 @beartype -271 @_poseur_decorator("self") -272 def capture_group( -273 self, -274 name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None, -275 text: Optional[VerbexEscapedCharClassOrSpecial] = None, -276 ) -> Verbex: -277 """Create a capture group. -278 -279 Name is optional if not specified then the first argument is the text. -280 -281 Keyword Arguments: -282 name_or_text -- The name of the group / text to search for (default: {None}) -283 text -- The text to search for (default: {None}) -284 -285 Raises: -286 ValueError: If name is specified then text must be as well. +203 the following methods do not try to match the original js lib! +204 """ +205 +206 EMPTY_REGEX_FLAG = re.RegexFlag(0) +207 +208 @re_escape +209 @beartype +210 def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG): +211 """Create a Verbex object; setting any needed flags. +212 +213 Keyword Arguments: +214 modifiers -- Regex modifying flags (default: {re.RegexFlag(0)}) +215 """ +216 # self._parts: List[str] = [text] +217 self._parts: List[str] = [] +218 self._modifiers = modifiers +219 +220 @property +221 def modifiers(self) -> re.RegexFlag: +222 """Return the modifiers for this Verbex object. +223 +224 Returns: +225 The modifiers applied to this object. +226 """ +227 return self._modifiers +228 +229 def __str__(self) -> str: +230 """Return regex string representation.""" +231 return "".join(self._parts) +232 +233 @beartype +234 def _add(self, value: Union[str, List[str]]) -> Verbex: +235 """ +236 Append a transformed value to internal expression to be compiled. +237 +238 As possible, this method should be "private". +239 """ +240 if isinstance(value, list): +241 self._parts.extend(value) +242 else: +243 self._parts.append(value) +244 return self +245 +246 def regex(self) -> Pattern[str]: +247 """Get a regular expression object.""" +248 return re.compile( +249 str(self), +250 self._modifiers, +251 ) +252 +253 # allow VerbexEscapedCharClassOrSpecial +254 +255 @re_escape +256 @beartype +257 def _capture_group_with_name( +258 self, +259 name: str, +260 text: VerbexEscapedCharClassOrSpecial, +261 ) -> Verbex: +262 return self._add(f"(?<{name}>{str(text)})") +263 +264 @re_escape +265 @beartype +266 def _capture_group_without_name( +267 self, +268 text: VerbexEscapedCharClassOrSpecial, +269 ) -> Verbex: +270 return self._add(f"({str(text)})") +271 +272 @re_escape +273 @beartype +274 @_poseur_decorator("self") +275 def capture_group( +276 self, +277 name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None, +278 text: Optional[VerbexEscapedCharClassOrSpecial] = None, +279 ) -> Verbex: +280 """Create a capture group. +281 +282 Name is optional if not specified then the first argument is the text. +283 +284 Keyword Arguments: +285 name_or_text -- The name of the group / text to search for (default: {None}) +286 text -- The text to search for (default: {None}) 287 -288 Returns: -289 Verbex with added capture group. -290 """ -291 if name_or_text is not None: -292 if text is None: -293 _text = name_or_text -294 return self._capture_group_without_name(_text) -295 if isinstance(name_or_text, str): -296 return self._capture_group_with_name(name_or_text, text) -297 raise ValueError("text must be specified with optional name") -298 -299 @re_escape -300 @beartype -301 def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: # noqa N802 -302 """`or` is a python keyword so we use `OR` instead. -303 -304 Arguments: -305 text -- Text to find or a Verbex object. +288 Raises: +289 ValueError: If name is specified then text must be as well. +290 +291 Returns: +292 Verbex with added capture group. +293 """ +294 if name_or_text is not None: +295 if text is None: +296 _text = name_or_text +297 return self._capture_group_without_name(_text) +298 if isinstance(name_or_text, str): +299 return self._capture_group_with_name(name_or_text, text) +300 raise ValueError("text must be specified with optional name") +301 +302 @re_escape +303 @beartype +304 def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: # noqa: N802 +305 """`or` is a python keyword so we use `OR` instead. 306 -307 Returns: -308 Modified Verbex object. -309 """ -310 return self._add("|").find(text) -311 -312 @re_escape -313 @beartype -314 def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -315 """Find the text or Verbex object zero or more times. -316 -317 Arguments: -318 text -- The text / Verbex object to look for. +307 Arguments: +308 text -- Text to find or a Verbex object. +309 +310 Returns: +311 Modified Verbex object. +312 """ +313 return self._add("|").find(text) +314 +315 @re_escape +316 @beartype +317 def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +318 """Find the text or Verbex object zero or more times. 319 -320 Returns: -321 Modified Verbex object. -322 """ -323 return self._add(f"(?:{str(text)})*") -324 -325 @re_escape -326 @beartype -327 def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -328 """Find the text or Verbex object one or more times. -329 -330 Arguments: -331 text -- The text / Verbex object to look for. +320 Arguments: +321 text -- The text / Verbex object to look for. +322 +323 Returns: +324 Modified Verbex object. +325 """ +326 return self._add(f"(?:{str(text)})*") +327 +328 @re_escape +329 @beartype +330 def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +331 """Find the text or Verbex object one or more times. 332 -333 Returns: -334 Modified Verbex object. -335 """ -336 return self._add(f"(?:{str(text)})+") -337 -338 @re_escape -339 @beartype -340 def n_times( -341 self, -342 text: VerbexEscapedCharClassOrSpecial, -343 n: int, # noqa: VNE001 -344 ) -> Verbex: -345 """Find the text or Verbex object n or more times. -346 -347 Arguments: -348 text -- The text / Verbex object to look for. +333 Arguments: +334 text -- The text / Verbex object to look for. +335 +336 Returns: +337 Modified Verbex object. +338 """ +339 return self._add(f"(?:{str(text)})+") +340 +341 @re_escape +342 @beartype +343 def n_times( +344 self, +345 text: VerbexEscapedCharClassOrSpecial, +346 n: int, # noqa: VNE001 +347 ) -> Verbex: +348 """Find the text or Verbex object n or more times. 349 -350 Returns: -351 Modified Verbex object. -352 """ -353 return self._add(f"(?:{str(text)}){{{n}}}") -354 -355 @re_escape -356 @beartype -357 def n_times_or_more( -358 self, -359 text: VerbexEscapedCharClassOrSpecial, -360 n: int, # noqa: VNE001 -361 ) -> Verbex: -362 """Find the text or Verbex object at least n times. -363 -364 Arguments: -365 text -- The text / Verbex object to look for. +350 Arguments: +351 text -- The text / Verbex object to look for. +352 +353 Returns: +354 Modified Verbex object. +355 """ +356 return self._add(f"(?:{str(text)}){{{n}}}") +357 +358 @re_escape +359 @beartype +360 def n_times_or_more( +361 self, +362 text: VerbexEscapedCharClassOrSpecial, +363 n: int, # noqa: VNE001 +364 ) -> Verbex: +365 """Find the text or Verbex object at least n times. 366 -367 Returns: -368 Modified Verbex object. -369 """ -370 return self._add(f"(?:{str(text)}){{{n},}}") -371 -372 @re_escape -373 @beartype -374 def n_to_m_times( -375 self, -376 text: VerbexEscapedCharClassOrSpecial, -377 n: int, # noqa: VNE001 -378 m: int, # noqa: VNE001 -379 ) -> Verbex: -380 """Find the text or Verbex object between n and m times. -381 -382 Arguments: -383 text -- The text / Verbex object to look for. +367 Arguments: +368 text -- The text / Verbex object to look for. +369 +370 Returns: +371 Modified Verbex object. +372 """ +373 return self._add(f"(?:{str(text)}){{{n},}}") +374 +375 @re_escape +376 @beartype +377 def n_to_m_times( +378 self, +379 text: VerbexEscapedCharClassOrSpecial, +380 n: int, # noqa: VNE001 +381 m: int, # noqa: VNE001 +382 ) -> Verbex: +383 """Find the text or Verbex object between n and m times. 384 -385 Returns: -386 Modified Verbex object. -387 """ -388 return self._add(f"(?:{str(text)}){{{n},{m}}}") -389 -390 @re_escape -391 @beartype -392 def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -393 """Possibly find the text / Verbex object. -394 -395 Arguments: -396 text -- The text / Verbex object to possibly find. +385 Arguments: +386 text -- The text / Verbex object to look for. +387 +388 Returns: +389 Modified Verbex object. +390 """ +391 return self._add(f"(?:{str(text)}){{{n},{m}}}") +392 +393 @re_escape +394 @beartype +395 def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +396 """Possibly find the text / Verbex object. 397 -398 Returns: -399 Modified Verbex object. -400 """ -401 return self._add(f"(?:{str(text)})?") -402 -403 @re_escape -404 @beartype -405 def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -406 """Find the text or Verbex object. -407 -408 Arguments: -409 text -- The text / Verbex object to look for. +398 Arguments: +399 text -- The text / Verbex object to possibly find. +400 +401 Returns: +402 Modified Verbex object. +403 """ +404 return self._add(f"(?:{str(text)})?") +405 +406 @re_escape +407 @beartype +408 def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +409 """Find the text or Verbex object. 410 -411 Returns: -412 Modified Verbex object. -413 """ -414 return self._add(str(text)) -415 -416 @re_escape -417 @beartype -418 def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -419 """Synonym for find. -420 -421 Arguments: -422 text -- The text / Verbex object to look for. +411 Arguments: +412 text -- The text / Verbex object to look for. +413 +414 Returns: +415 Modified Verbex object. +416 """ +417 return self._add(str(text)) +418 +419 @re_escape +420 @beartype +421 def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +422 """Synonym for find. 423 -424 Returns: -425 Modified Verbex object. -426 """ -427 return self.find(text) -428 -429 @re_escape -430 @beartype -431 def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -432 """Match if string is followed by text. -433 -434 Positive lookahead -435 -436 Returns: -437 Modified Verbex object. -438 """ -439 return self._add(f"(?={text})") -440 -441 @re_escape -442 @beartype -443 def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -444 """Match if string is not followed by text. -445 -446 Negative lookahead -447 -448 Returns: -449 Modified Verbex object. -450 """ -451 return self._add(f"(?!{text})") -452 -453 @re_escape -454 @beartype -455 def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -456 """Match if string is not preceded by text. -457 -458 Positive lookbehind -459 -460 Returns: -461 Modified Verbex object. -462 """ -463 return self._add(f"(?<={text})") -464 -465 @re_escape -466 @beartype -467 def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: -468 """Match if string is not preceded by text. -469 -470 Negative Lookbehind -471 -472 Returns: -473 Modified Verbex object. -474 """ -475 return self._add(f"(?<!{text})") -476 -477 # only allow CharclassOrChars -478 -479 @re_escape -480 @beartype -481 def any_of(self, chargroup: CharClassOrChars) -> Verbex: -482 """Find anything in this group of chars or char class. -483 -484 Arguments: -485 text -- The characters to look for. +424 Arguments: +425 text -- The text / Verbex object to look for. +426 +427 Returns: +428 Modified Verbex object. +429 """ +430 return self.find(text) +431 +432 @re_escape +433 @beartype +434 def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +435 """Match if string is followed by text. +436 +437 Positive lookahead +438 +439 Returns: +440 Modified Verbex object. +441 """ +442 return self._add(f"(?={text})") +443 +444 @re_escape +445 @beartype +446 def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +447 """Match if string is not followed by text. +448 +449 Negative lookahead +450 +451 Returns: +452 Modified Verbex object. +453 """ +454 return self._add(f"(?!{text})") +455 +456 @re_escape +457 @beartype +458 def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +459 """Match if string is not preceded by text. +460 +461 Positive lookbehind +462 +463 Returns: +464 Modified Verbex object. +465 """ +466 return self._add(f"(?<={text})") +467 +468 @re_escape +469 @beartype +470 def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: +471 """Match if string is not preceded by text. +472 +473 Negative Lookbehind +474 +475 Returns: +476 Modified Verbex object. +477 """ +478 return self._add(f"(?<!{text})") +479 +480 # only allow CharclassOrChars +481 +482 @re_escape +483 @beartype +484 def any_of(self, chargroup: CharClassOrChars) -> Verbex: +485 """Find anything in this group of chars or char class. 486 -487 Returns: -488 Modified Verbex object. -489 """ -490 return self._add(f"(?:[{chargroup}])") -491 -492 @re_escape -493 @beartype -494 def not_any_of(self, text: CharClassOrChars) -> Verbex: -495 """Find anything but this group of chars or char class. -496 -497 Arguments: -498 text -- The characters to not look for. +487 Arguments: +488 text -- The characters to look for. +489 +490 Returns: +491 Modified Verbex object. +492 """ +493 return self._add(f"(?:[{chargroup}])") +494 +495 @re_escape +496 @beartype +497 def not_any_of(self, text: CharClassOrChars) -> Verbex: +498 """Find anything but this group of chars or char class. 499 -500 Returns: -501 Modified Verbex object. -502 """ -503 return self._add(f"(?:[^{text}])") -504 -505 @re_escape -506 def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex: -507 """Find anything one or more times but this group of chars or char class. -508 -509 Arguments: -510 text -- The characters to not look for. +500 Arguments: +501 text -- The characters to not look for. +502 +503 Returns: +504 Modified Verbex object. +505 """ +506 return self._add(f"(?:[^{text}])") +507 +508 @re_escape +509 def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex: +510 """Find anything one or more times but this group of chars or char class. 511 -512 Returns: -513 Modified Verbex object. -514 """ -515 return self._add(f"[^{chargroup}]+") -516 -517 # no text input -518 -519 def start_of_line(self) -> Verbex: -520 """Find the start of the line. +512 Arguments: +513 text -- The characters to not look for. +514 +515 Returns: +516 Modified Verbex object. +517 """ +518 return self._add(f"[^{chargroup}]+") +519 +520 # no text input 521 -522 Returns: -523 Modified Verbex object. -524 """ -525 return self.find(SpecialChar.START_OF_LINE) -526 -527 def end_of_line(self) -> Verbex: -528 """Find the end of the line. +522 def start_of_line(self) -> Verbex: +523 """Find the start of the line. +524 +525 Returns: +526 Modified Verbex object. +527 """ +528 return self.find(SpecialChar.START_OF_LINE) 529 -530 Returns: -531 Modified Verbex object. -532 """ -533 return self.find(SpecialChar.END_OF_LINE) -534 -535 def line_break(self) -> Verbex: -536 """Find a line break. +530 def end_of_line(self) -> Verbex: +531 """Find the end of the line. +532 +533 Returns: +534 Modified Verbex object. +535 """ +536 return self.find(SpecialChar.END_OF_LINE) 537 -538 Returns: -539 Modified Verbex object. -540 """ -541 return self.find(SpecialChar.LINEBREAK) -542 -543 def tab(self) -> Verbex: -544 """Find a tab. +538 def line_break(self) -> Verbex: +539 """Find a line break. +540 +541 Returns: +542 Modified Verbex object. +543 """ +544 return self.find(SpecialChar.LINEBREAK) 545 -546 Returns: -547 Modified Verbex object. -548 """ -549 return self.find(SpecialChar.TAB) -550 -551 def anything(self) -> Verbex: -552 """Find anything one or more time. +546 def tab(self) -> Verbex: +547 """Find a tab. +548 +549 Returns: +550 Modified Verbex object. +551 """ +552 return self.find(SpecialChar.TAB) 553 -554 Returns: -555 Modified Verbex object. -556 """ -557 return self._add(".+") -558 -559 def as_few(self) -> Verbex: -560 """Modify previous search to not be greedy. +554 def anything(self) -> Verbex: +555 """Find anything one or more time. +556 +557 Returns: +558 Modified Verbex object. +559 """ +560 return self._add(".+") 561 -562 Returns: -563 Modified Verbex object. -564 """ -565 return self._add("?") -566 -567 @beartype -568 def number_range(self, start: int, end: int) -> Verbex: -569 """Generate a range of numbers. -570 -571 Arguments: -572 start -- Start of the range -573 end -- End of the range -574 -575 Returns: -576 Modified Verbex object. -577 """ -578 return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")") -579 -580 @beartype -581 def letter_range(self, start: Char, end: Char) -> Verbex: -582 """Generate a range of letters. -583 -584 Arguments: -585 start -- Start of the range -586 end -- End of the range -587 -588 Returns: -589 Modified Verbex object. -590 """ -591 return self._add(f"[{start}-{end}]") -592 -593 def word(self) -> Verbex: -594 """Find a word on word boundary. +562 def as_few(self) -> Verbex: +563 """Modify previous search to not be greedy. +564 +565 Returns: +566 Modified Verbex object. +567 """ +568 return self._add("?") +569 +570 @beartype +571 def number_range(self, start: int, end: int) -> Verbex: +572 """Generate a range of numbers. +573 +574 Arguments: +575 start -- Start of the range +576 end -- End of the range +577 +578 Returns: +579 Modified Verbex object. +580 """ +581 return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")") +582 +583 @beartype +584 def letter_range(self, start: Char, end: Char) -> Verbex: +585 """Generate a range of letters. +586 +587 Arguments: +588 start -- Start of the range +589 end -- End of the range +590 +591 Returns: +592 Modified Verbex object. +593 """ +594 return self._add(f"[{start}-{end}]") 595 -596 Returns: -597 Modified Verbex object. -598 """ -599 return self._add("(\\b\\w+\\b)") -600 -601 # # --------------- modifiers ------------------------ -602 -603 def with_any_case(self) -> Verbex: -604 """Modify Verbex object to be case insensitive. +596 def word(self) -> Verbex: +597 """Find a word on word boundary. +598 +599 Returns: +600 Modified Verbex object. +601 """ +602 return self._add("(\\b\\w+\\b)") +603 +604 # # --------------- modifiers ------------------------ 605 -606 Returns: -607 Modified Verbex object. -608 """ -609 self._modifiers |= re.IGNORECASE -610 return self -611 -612 def search_by_line(self) -> Verbex: -613 """Search each line, ^ and $ match begining and end of line respectively. +606 def with_any_case(self) -> Verbex: +607 """Modify Verbex object to be case insensitive. +608 +609 Returns: +610 Modified Verbex object. +611 """ +612 self._modifiers |= re.IGNORECASE +613 return self 614 -615 Returns: -616 Modified Verbex object. -617 """ -618 self._modifiers |= re.MULTILINE -619 return self -620 -621 def with_ascii(self) -> Verbex: -622 """Match ascii instead of unicode. +615 def search_by_line(self) -> Verbex: +616 """Search each line, ^ and $ match begining and end of line respectively. +617 +618 Returns: +619 Modified Verbex object. +620 """ +621 self._modifiers |= re.MULTILINE +622 return self 623 -624 Returns: -625 Modified Verbex object. -626 """ -627 self._modifiers |= re.ASCII -628 return self -629 -630 -631# left over notes from original version -632# def __getattr__(self, attr): -633# """ any other function will be sent to the regex object """ -634# regex = self.regex() -635# return getattr(regex, attr) -636 -637# def replace(self, string, repl): -638# return self.sub(repl, string) +624 def with_ascii(self) -> Verbex: +625 """Match ascii instead of unicode. +626 +627 Returns: +628 Modified Verbex object. +629 """ +630 self._modifiers |= re.ASCII +631 return self +632 +633 +634# left over notes from original version +635# def __getattr__(self, attr): +636# """ any other function will be sent to the regex object """ +637# regex = self.regex() +638# return getattr(regex, attr) 639 -640 -641if __name__ == "__main__": -642 pass +640# def replace(self, string, repl): +641# return self.sub(repl, string) +642 +643 +644if __name__ == "__main__": +645 pass @@ -913,17 +916,17 @@

View Source - 
49@runtime_checkable
-50class HasIter(Protocol):
-51    """Workaround for mypy P.args."""
-52
-53    def __iter__(self) -> Iterator[Any]:
-54        """Object can be iterated.
+            
52@runtime_checkable
+53class HasIter(Protocol):
+54    """Workaround for mypy P.args."""
 55
-56        Yields:
-57            Next object.
-58        """
-59        ...
+56    def __iter__(self) -> Iterator[Any]:
+57        """Object can be iterated.
+58
+59        Yields:
+60            Next object.
+61        """
+62        ...
@@ -988,17 +991,17 @@

View Source - 
64@runtime_checkable
-65class HasItems(Protocol):
-66    """Workaround for mypy P.kwargs."""
-67
-68    def items(self) -> Tuple[str, Any]:
-69        """Object has items method.
+            
67@runtime_checkable
+68class HasItems(Protocol):
+69    """Workaround for mypy P.kwargs."""
 70
-71        Returns:
-72            The dict of items.
-73        """
-74        ...
+71    def items(self) -> Tuple[str, Any]:
+72        """Object has items method.
+73
+74        Returns:
+75            The dict of items.
+76        """
+77        ...
@@ -1060,13 +1063,13 @@

View Source - 
68    def items(self) -> Tuple[str, Any]:
-69        """Object has items method.
-70
-71        Returns:
-72            The dict of items.
-73        """
-74        ...
+            
71    def items(self) -> Tuple[str, Any]:
+72        """Object has items method.
+73
+74        Returns:
+75            The dict of items.
+76        """
+77        ...
@@ -1091,23 +1094,23 @@

View Source - 
77class EscapedText(str):
-78    """Text that has been escaped for regex.
-79
-80    Arguments:
-81        str -- Extend the string class.
-82    """
-83
-84    def __new__(cls, value: str) -> EscapedText:
-85        """Return a escaped regex string.
+            
80class EscapedText(str):
+81    """Text that has been escaped for regex.
+82
+83    Arguments:
+84        str -- Extend the string class.
+85    """
 86
-87        Arguments:
-88            value -- the string to escape
+87    def __new__(cls, value: str) -> EscapedText:
+88        """Return a escaped regex string.
 89
-90        Returns:
-91            _description_
-92        """
-93        return str.__new__(cls, re.escape(value))
+90        Arguments:
+91            value -- the string to escape
+92
+93        Returns:
+94            _description_
+95        """
+96        return str.__new__(cls, re.escape(value))
@@ -1128,16 +1131,16 @@

View Source - 
84    def __new__(cls, value: str) -> EscapedText:
-85        """Return a escaped regex string.
-86
-87        Arguments:
-88            value -- the string to escape
+            
87    def __new__(cls, value: str) -> EscapedText:
+88        """Return a escaped regex string.
 89
-90        Returns:
-91            _description_
-92        """
-93        return str.__new__(cls, re.escape(value))
+90        Arguments:
+91            value -- the string to escape
+92
+93        Returns:
+94            _description_
+95        """
+96        return str.__new__(cls, re.escape(value))
@@ -1221,35 +1224,35 @@

Inherited Members
View Source - 
 96def re_escape(func: Callable[P, R]) -> Callable[P, R]:
- 97    """Automatically escape any string parameters as EscapedText.
- 98
- 99    Arguments:
-100        func -- The function to decorate.
+            
 99def re_escape(func: Callable[P, R]) -> Callable[P, R]:
+100    """Automatically escape any string parameters as EscapedText.
 101
-102    Returns:
-103        The decorated function.
-104    """
-105
-106    @wraps(func)
-107    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
-108        escaped_args: List[Any] = []
-109        escaped_kwargs: Dict[str, Any] = {}
-110        for arg in cast(HasIter, args):
-111            if not isinstance(arg, EscapedText) and isinstance(arg, str):
-112                escaped_args.append(EscapedText(arg))
-113            else:
-114                escaped_args.append(arg)
-115        arg_k: str
-116        arg_v: Any
-117        for arg_k, arg_v in cast(HasItems, kwargs).items():
-118            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
-119                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
-120            else:
-121                escaped_kwargs[arg_k] = arg_v
-122        return func(*escaped_args, **escaped_kwargs)  # type: ignore
-123
-124    return inner
+102    Arguments:
+103        func -- The function to decorate.
+104
+105    Returns:
+106        The decorated function.
+107    """
+108
+109    @wraps(func)
+110    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
+111        escaped_args: List[Any] = []
+112        escaped_kwargs: Dict[str, Any] = {}
+113        for arg in cast(HasIter, args):
+114            if not isinstance(arg, EscapedText) and isinstance(arg, str):
+115                escaped_args.append(EscapedText(arg))
+116            else:
+117                escaped_args.append(arg)
+118        arg_k: str
+119        arg_v: Any
+120        for arg_k, arg_v in cast(HasItems, kwargs).items():
+121            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
+122                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
+123            else:
+124                escaped_kwargs[arg_k] = arg_v
+125        return func(*escaped_args, **escaped_kwargs)  # type: ignore
+126
+127    return inner
@@ -1276,27 +1279,27 @@
Inherited Members
View Source - 
127class CharClass(Enum):
-128    """Enum of character classes in regex.
-129
-130    Arguments:
-131        Enum -- Extends the Enum class.
-132    """
-133
-134    DIGIT = "\\d"
-135    LETTER = "\\w"
-136    UPPERCASE_LETTER = "\\u"
-137    LOWERCASE_LETTER = "\\l"
-138    WHITESPACE = "\\s"
-139    TAB = "\\t"
-140
-141    def __str__(self) -> str:
-142        """To string method based on Enum value.
+            
130class CharClass(Enum):
+131    """Enum of character classes in regex.
+132
+133    Arguments:
+134        Enum -- Extends the Enum class.
+135    """
+136
+137    DIGIT = "\\d"
+138    LETTER = "\\w"
+139    UPPERCASE_LETTER = "\\u"
+140    LOWERCASE_LETTER = "\\l"
+141    WHITESPACE = "\\s"
+142    TAB = "\\t"
 143
-144        Returns:
-145            value of Enum
-146        """
-147        return self.value
+144    def __str__(self) -> str:
+145        """To string method based on Enum value.
+146
+147        Returns:
+148            value of Enum
+149        """
+150        return self.value
@@ -1390,26 +1393,26 @@
Inherited Members
View Source - 
150class SpecialChar(Enum):
-151    """Enum of special charaters, shorthand.
-152
-153    Arguments:
-154        Enum -- Extends the Enum class.
-155    """
-156
-157    # does not work  / should not be used in [ ]
-158    LINEBREAK = "(\\n|(\\r\\n))"
-159    START_OF_LINE = "^"
-160    END_OF_LINE = "$"
-161    TAB = "\t"
-162
-163    def __str__(self) -> str:
-164        """To string for special chars enum.
+            
153class SpecialChar(Enum):
+154    """Enum of special charaters, shorthand.
+155
+156    Arguments:
+157        Enum -- Extends the Enum class.
+158    """
+159
+160    # does not work  / should not be used in [ ]
+161    LINEBREAK = "(\\n|(\\r\\n))"
+162    START_OF_LINE = "^"
+163    END_OF_LINE = "$"
+164    TAB = "\t"
 165
-166        Returns:
-167            Return value of enum as string.
-168        """
-169        return self.value
+166    def __str__(self) -> str:
+167        """To string for special chars enum.
+168
+169        Returns:
+170            Return value of enum as string.
+171        """
+172        return self.value
@@ -1513,439 +1516,439 @@
Inherited Members
View Source - 
197class Verbex:
-198    """
-199    VerbalExpressions class.
-200
-201    the following methods do not try to match the original js lib!
-202    """
+            
200class Verbex:
+201    """
+202    VerbalExpressions class.
 203
-204    EMPTY_REGEX_FLAG = re.RegexFlag(0)
-205
-206    @re_escape
-207    @beartype
-208    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
-209        """Create a Verbex object; setting any needed flags.
-210
-211        Keyword Arguments:
-212            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
-213        """
-214        # self._parts: List[str] = [text]
-215        self._parts: List[str] = []
-216        self._modifiers = modifiers
-217
-218    @property
-219    def modifiers(self) -> re.RegexFlag:
-220        """Return the modifiers for this Verbex object.
-221
-222        Returns:
-223            The modifiers applied to this object.
-224        """
-225        return self._modifiers
-226
-227    def __str__(self) -> str:
-228        """Return regex string representation."""
-229        return "".join(self._parts)
-230
-231    @beartype
-232    def _add(self, value: Union[str, List[str]]) -> Verbex:
-233        """
-234        Append a transformed value to internal expression to be compiled.
-235
-236        As possible, this method should be "private".
-237        """
-238        if isinstance(value, list):
-239            self._parts.extend(value)
-240        else:
-241            self._parts.append(value)
-242        return self
-243
-244    def regex(self) -> Pattern[str]:
-245        """Get a regular expression object."""
-246        return re.compile(
-247            str(self),
-248            self._modifiers,
-249        )
-250
-251    # allow VerbexEscapedCharClassOrSpecial
-252
-253    @re_escape
-254    @beartype
-255    def _capture_group_with_name(
-256        self,
-257        name: str,
-258        text: VerbexEscapedCharClassOrSpecial,
-259    ) -> Verbex:
-260        return self._add(f"(?<{name}>{str(text)})")
-261
-262    @re_escape
-263    @beartype
-264    def _capture_group_without_name(
-265        self,
-266        text: VerbexEscapedCharClassOrSpecial,
-267    ) -> Verbex:
-268        return self._add(f"({str(text)})")
-269
-270    @re_escape
-271    @beartype
-272    @_poseur_decorator("self")
-273    def capture_group(
-274        self,
-275        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
-276        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
-277    ) -> Verbex:
-278        """Create a capture group.
-279
-280        Name is optional if not specified then the first argument is the text.
-281
-282        Keyword Arguments:
-283            name_or_text -- The name of the group / text to search for (default: {None})
-284            text -- The text to search for (default: {None})
-285
-286        Raises:
-287            ValueError: If name is specified then text must be as well.
+204    the following methods do not try to match the original js lib!
+205    """
+206
+207    EMPTY_REGEX_FLAG = re.RegexFlag(0)
+208
+209    @re_escape
+210    @beartype
+211    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
+212        """Create a Verbex object; setting any needed flags.
+213
+214        Keyword Arguments:
+215            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
+216        """
+217        # self._parts: List[str] = [text]
+218        self._parts: List[str] = []
+219        self._modifiers = modifiers
+220
+221    @property
+222    def modifiers(self) -> re.RegexFlag:
+223        """Return the modifiers for this Verbex object.
+224
+225        Returns:
+226            The modifiers applied to this object.
+227        """
+228        return self._modifiers
+229
+230    def __str__(self) -> str:
+231        """Return regex string representation."""
+232        return "".join(self._parts)
+233
+234    @beartype
+235    def _add(self, value: Union[str, List[str]]) -> Verbex:
+236        """
+237        Append a transformed value to internal expression to be compiled.
+238
+239        As possible, this method should be "private".
+240        """
+241        if isinstance(value, list):
+242            self._parts.extend(value)
+243        else:
+244            self._parts.append(value)
+245        return self
+246
+247    def regex(self) -> Pattern[str]:
+248        """Get a regular expression object."""
+249        return re.compile(
+250            str(self),
+251            self._modifiers,
+252        )
+253
+254    # allow VerbexEscapedCharClassOrSpecial
+255
+256    @re_escape
+257    @beartype
+258    def _capture_group_with_name(
+259        self,
+260        name: str,
+261        text: VerbexEscapedCharClassOrSpecial,
+262    ) -> Verbex:
+263        return self._add(f"(?<{name}>{str(text)})")
+264
+265    @re_escape
+266    @beartype
+267    def _capture_group_without_name(
+268        self,
+269        text: VerbexEscapedCharClassOrSpecial,
+270    ) -> Verbex:
+271        return self._add(f"({str(text)})")
+272
+273    @re_escape
+274    @beartype
+275    @_poseur_decorator("self")
+276    def capture_group(
+277        self,
+278        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
+279        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
+280    ) -> Verbex:
+281        """Create a capture group.
+282
+283        Name is optional if not specified then the first argument is the text.
+284
+285        Keyword Arguments:
+286            name_or_text -- The name of the group / text to search for (default: {None})
+287            text -- The text to search for (default: {None})
 288
-289        Returns:
-290            Verbex with added capture group.
-291        """
-292        if name_or_text is not None:
-293            if text is None:
-294                _text = name_or_text
-295                return self._capture_group_without_name(_text)
-296            if isinstance(name_or_text, str):
-297                return self._capture_group_with_name(name_or_text, text)
-298        raise ValueError("text must be specified with optional name")
-299
-300    @re_escape
-301    @beartype
-302    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
-303        """`or` is a python keyword so we use `OR` instead.
-304
-305        Arguments:
-306            text -- Text to find or a Verbex object.
+289        Raises:
+290            ValueError: If name is specified then text must be as well.
+291
+292        Returns:
+293            Verbex with added capture group.
+294        """
+295        if name_or_text is not None:
+296            if text is None:
+297                _text = name_or_text
+298                return self._capture_group_without_name(_text)
+299            if isinstance(name_or_text, str):
+300                return self._capture_group_with_name(name_or_text, text)
+301        raise ValueError("text must be specified with optional name")
+302
+303    @re_escape
+304    @beartype
+305    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa: N802
+306        """`or` is a python keyword so we use `OR` instead.
 307
-308        Returns:
-309            Modified Verbex object.
-310        """
-311        return self._add("|").find(text)
-312
-313    @re_escape
-314    @beartype
-315    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-316        """Find the text or Verbex object zero or more times.
-317
-318        Arguments:
-319            text -- The text / Verbex object to look for.
+308        Arguments:
+309            text -- Text to find or a Verbex object.
+310
+311        Returns:
+312            Modified Verbex object.
+313        """
+314        return self._add("|").find(text)
+315
+316    @re_escape
+317    @beartype
+318    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+319        """Find the text or Verbex object zero or more times.
 320
-321        Returns:
-322            Modified Verbex object.
-323        """
-324        return self._add(f"(?:{str(text)})*")
-325
-326    @re_escape
-327    @beartype
-328    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-329        """Find the text or Verbex object one or more times.
-330
-331        Arguments:
-332            text -- The text / Verbex object to look for.
+321        Arguments:
+322            text -- The text / Verbex object to look for.
+323
+324        Returns:
+325            Modified Verbex object.
+326        """
+327        return self._add(f"(?:{str(text)})*")
+328
+329    @re_escape
+330    @beartype
+331    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+332        """Find the text or Verbex object one or more times.
 333
-334        Returns:
-335            Modified Verbex object.
-336        """
-337        return self._add(f"(?:{str(text)})+")
-338
-339    @re_escape
-340    @beartype
-341    def n_times(
-342        self,
-343        text: VerbexEscapedCharClassOrSpecial,
-344        n: int,  # noqa: VNE001
-345    ) -> Verbex:
-346        """Find the text or Verbex object n or more times.
-347
-348        Arguments:
-349            text -- The text / Verbex object to look for.
+334        Arguments:
+335            text -- The text / Verbex object to look for.
+336
+337        Returns:
+338            Modified Verbex object.
+339        """
+340        return self._add(f"(?:{str(text)})+")
+341
+342    @re_escape
+343    @beartype
+344    def n_times(
+345        self,
+346        text: VerbexEscapedCharClassOrSpecial,
+347        n: int,  # noqa: VNE001
+348    ) -> Verbex:
+349        """Find the text or Verbex object n or more times.
 350
-351        Returns:
-352            Modified Verbex object.
-353        """
-354        return self._add(f"(?:{str(text)}){{{n}}}")
-355
-356    @re_escape
-357    @beartype
-358    def n_times_or_more(
-359        self,
-360        text: VerbexEscapedCharClassOrSpecial,
-361        n: int,  # noqa: VNE001
-362    ) -> Verbex:
-363        """Find the text or Verbex object at least n times.
-364
-365        Arguments:
-366            text -- The text / Verbex object to look for.
+351        Arguments:
+352            text -- The text / Verbex object to look for.
+353
+354        Returns:
+355            Modified Verbex object.
+356        """
+357        return self._add(f"(?:{str(text)}){{{n}}}")
+358
+359    @re_escape
+360    @beartype
+361    def n_times_or_more(
+362        self,
+363        text: VerbexEscapedCharClassOrSpecial,
+364        n: int,  # noqa: VNE001
+365    ) -> Verbex:
+366        """Find the text or Verbex object at least n times.
 367
-368        Returns:
-369            Modified Verbex object.
-370        """
-371        return self._add(f"(?:{str(text)}){{{n},}}")
-372
-373    @re_escape
-374    @beartype
-375    def n_to_m_times(
-376        self,
-377        text: VerbexEscapedCharClassOrSpecial,
-378        n: int,  # noqa: VNE001
-379        m: int,  # noqa: VNE001
-380    ) -> Verbex:
-381        """Find the text or Verbex object between n and m times.
-382
-383        Arguments:
-384            text -- The text / Verbex object to look for.
+368        Arguments:
+369            text -- The text / Verbex object to look for.
+370
+371        Returns:
+372            Modified Verbex object.
+373        """
+374        return self._add(f"(?:{str(text)}){{{n},}}")
+375
+376    @re_escape
+377    @beartype
+378    def n_to_m_times(
+379        self,
+380        text: VerbexEscapedCharClassOrSpecial,
+381        n: int,  # noqa: VNE001
+382        m: int,  # noqa: VNE001
+383    ) -> Verbex:
+384        """Find the text or Verbex object between n and m times.
 385
-386        Returns:
-387            Modified Verbex object.
-388        """
-389        return self._add(f"(?:{str(text)}){{{n},{m}}}")
-390
-391    @re_escape
-392    @beartype
-393    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-394        """Possibly find the text / Verbex object.
-395
-396        Arguments:
-397            text -- The text / Verbex object to possibly find.
+386        Arguments:
+387            text -- The text / Verbex object to look for.
+388
+389        Returns:
+390            Modified Verbex object.
+391        """
+392        return self._add(f"(?:{str(text)}){{{n},{m}}}")
+393
+394    @re_escape
+395    @beartype
+396    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+397        """Possibly find the text / Verbex object.
 398
-399        Returns:
-400            Modified Verbex object.
-401        """
-402        return self._add(f"(?:{str(text)})?")
-403
-404    @re_escape
-405    @beartype
-406    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-407        """Find the text or Verbex object.
-408
-409        Arguments:
-410            text -- The text / Verbex object to look for.
+399        Arguments:
+400            text -- The text / Verbex object to possibly find.
+401
+402        Returns:
+403            Modified Verbex object.
+404        """
+405        return self._add(f"(?:{str(text)})?")
+406
+407    @re_escape
+408    @beartype
+409    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+410        """Find the text or Verbex object.
 411
-412        Returns:
-413            Modified Verbex object.
-414        """
-415        return self._add(str(text))
-416
-417    @re_escape
-418    @beartype
-419    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-420        """Synonym for find.
-421
-422        Arguments:
-423            text -- The text / Verbex object to look for.
+412        Arguments:
+413            text -- The text / Verbex object to look for.
+414
+415        Returns:
+416            Modified Verbex object.
+417        """
+418        return self._add(str(text))
+419
+420    @re_escape
+421    @beartype
+422    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+423        """Synonym for find.
 424
-425        Returns:
-426            Modified Verbex object.
-427        """
-428        return self.find(text)
-429
-430    @re_escape
-431    @beartype
-432    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-433        """Match if string is followed by text.
-434
-435        Positive lookahead
-436
-437        Returns:
-438            Modified Verbex object.
-439        """
-440        return self._add(f"(?={text})")
-441
-442    @re_escape
-443    @beartype
-444    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-445        """Match if string is not followed by text.
-446
-447        Negative lookahead
-448
-449        Returns:
-450            Modified Verbex object.
-451        """
-452        return self._add(f"(?!{text})")
-453
-454    @re_escape
-455    @beartype
-456    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-457        """Match if string is not preceded by text.
-458
-459        Positive lookbehind
-460
-461        Returns:
-462            Modified Verbex object.
-463        """
-464        return self._add(f"(?<={text})")
-465
-466    @re_escape
-467    @beartype
-468    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-469        """Match if string is not preceded by text.
-470
-471        Negative Lookbehind
-472
-473        Returns:
-474            Modified Verbex object.
-475        """
-476        return self._add(f"(?<!{text})")
-477
-478    # only allow CharclassOrChars
-479
-480    @re_escape
-481    @beartype
-482    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
-483        """Find anything in this group of chars or char class.
-484
-485        Arguments:
-486            text -- The characters to look for.
+425        Arguments:
+426            text -- The text / Verbex object to look for.
+427
+428        Returns:
+429            Modified Verbex object.
+430        """
+431        return self.find(text)
+432
+433    @re_escape
+434    @beartype
+435    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+436        """Match if string is followed by text.
+437
+438        Positive lookahead
+439
+440        Returns:
+441            Modified Verbex object.
+442        """
+443        return self._add(f"(?={text})")
+444
+445    @re_escape
+446    @beartype
+447    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+448        """Match if string is not followed by text.
+449
+450        Negative lookahead
+451
+452        Returns:
+453            Modified Verbex object.
+454        """
+455        return self._add(f"(?!{text})")
+456
+457    @re_escape
+458    @beartype
+459    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+460        """Match if string is not preceded by text.
+461
+462        Positive lookbehind
+463
+464        Returns:
+465            Modified Verbex object.
+466        """
+467        return self._add(f"(?<={text})")
+468
+469    @re_escape
+470    @beartype
+471    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+472        """Match if string is not preceded by text.
+473
+474        Negative Lookbehind
+475
+476        Returns:
+477            Modified Verbex object.
+478        """
+479        return self._add(f"(?<!{text})")
+480
+481    # only allow CharclassOrChars
+482
+483    @re_escape
+484    @beartype
+485    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
+486        """Find anything in this group of chars or char class.
 487
-488        Returns:
-489            Modified Verbex object.
-490        """
-491        return self._add(f"(?:[{chargroup}])")
-492
-493    @re_escape
-494    @beartype
-495    def not_any_of(self, text: CharClassOrChars) -> Verbex:
-496        """Find anything but this group of chars or char class.
-497
-498        Arguments:
-499            text -- The characters to not look for.
+488        Arguments:
+489            text -- The characters to look for.
+490
+491        Returns:
+492            Modified Verbex object.
+493        """
+494        return self._add(f"(?:[{chargroup}])")
+495
+496    @re_escape
+497    @beartype
+498    def not_any_of(self, text: CharClassOrChars) -> Verbex:
+499        """Find anything but this group of chars or char class.
 500
-501        Returns:
-502            Modified Verbex object.
-503        """
-504        return self._add(f"(?:[^{text}])")
-505
-506    @re_escape
-507    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
-508        """Find anything one or more times but this group of chars or char class.
-509
-510        Arguments:
-511            text -- The characters to not look for.
+501        Arguments:
+502            text -- The characters to not look for.
+503
+504        Returns:
+505            Modified Verbex object.
+506        """
+507        return self._add(f"(?:[^{text}])")
+508
+509    @re_escape
+510    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
+511        """Find anything one or more times but this group of chars or char class.
 512
-513        Returns:
-514            Modified Verbex object.
-515        """
-516        return self._add(f"[^{chargroup}]+")
-517
-518    # no text input
-519
-520    def start_of_line(self) -> Verbex:
-521        """Find the start of the line.
+513        Arguments:
+514            text -- The characters to not look for.
+515
+516        Returns:
+517            Modified Verbex object.
+518        """
+519        return self._add(f"[^{chargroup}]+")
+520
+521    # no text input
 522
-523        Returns:
-524            Modified Verbex object.
-525        """
-526        return self.find(SpecialChar.START_OF_LINE)
-527
-528    def end_of_line(self) -> Verbex:
-529        """Find the end of the line.
+523    def start_of_line(self) -> Verbex:
+524        """Find the start of the line.
+525
+526        Returns:
+527            Modified Verbex object.
+528        """
+529        return self.find(SpecialChar.START_OF_LINE)
 530
-531        Returns:
-532            Modified Verbex object.
-533        """
-534        return self.find(SpecialChar.END_OF_LINE)
-535
-536    def line_break(self) -> Verbex:
-537        """Find a line break.
+531    def end_of_line(self) -> Verbex:
+532        """Find the end of the line.
+533
+534        Returns:
+535            Modified Verbex object.
+536        """
+537        return self.find(SpecialChar.END_OF_LINE)
 538
-539        Returns:
-540            Modified Verbex object.
-541        """
-542        return self.find(SpecialChar.LINEBREAK)
-543
-544    def tab(self) -> Verbex:
-545        """Find a tab.
+539    def line_break(self) -> Verbex:
+540        """Find a line break.
+541
+542        Returns:
+543            Modified Verbex object.
+544        """
+545        return self.find(SpecialChar.LINEBREAK)
 546
-547        Returns:
-548            Modified Verbex object.
-549        """
-550        return self.find(SpecialChar.TAB)
-551
-552    def anything(self) -> Verbex:
-553        """Find anything one or more time.
+547    def tab(self) -> Verbex:
+548        """Find a tab.
+549
+550        Returns:
+551            Modified Verbex object.
+552        """
+553        return self.find(SpecialChar.TAB)
 554
-555        Returns:
-556            Modified Verbex object.
-557        """
-558        return self._add(".+")
-559
-560    def as_few(self) -> Verbex:
-561        """Modify previous search to not be greedy.
+555    def anything(self) -> Verbex:
+556        """Find anything one or more time.
+557
+558        Returns:
+559            Modified Verbex object.
+560        """
+561        return self._add(".+")
 562
-563        Returns:
-564            Modified Verbex object.
-565        """
-566        return self._add("?")
-567
-568    @beartype
-569    def number_range(self, start: int, end: int) -> Verbex:
-570        """Generate a range of numbers.
-571
-572        Arguments:
-573            start -- Start of the range
-574            end -- End of the range
-575
-576        Returns:
-577            Modified Verbex object.
-578        """
-579        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
-580
-581    @beartype
-582    def letter_range(self, start: Char, end: Char) -> Verbex:
-583        """Generate a range of letters.
-584
-585        Arguments:
-586            start -- Start of the range
-587            end -- End of the range
-588
-589        Returns:
-590            Modified Verbex object.
-591        """
-592        return self._add(f"[{start}-{end}]")
-593
-594    def word(self) -> Verbex:
-595        """Find a word on word boundary.
+563    def as_few(self) -> Verbex:
+564        """Modify previous search to not be greedy.
+565
+566        Returns:
+567            Modified Verbex object.
+568        """
+569        return self._add("?")
+570
+571    @beartype
+572    def number_range(self, start: int, end: int) -> Verbex:
+573        """Generate a range of numbers.
+574
+575        Arguments:
+576            start -- Start of the range
+577            end -- End of the range
+578
+579        Returns:
+580            Modified Verbex object.
+581        """
+582        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
+583
+584    @beartype
+585    def letter_range(self, start: Char, end: Char) -> Verbex:
+586        """Generate a range of letters.
+587
+588        Arguments:
+589            start -- Start of the range
+590            end -- End of the range
+591
+592        Returns:
+593            Modified Verbex object.
+594        """
+595        return self._add(f"[{start}-{end}]")
 596
-597        Returns:
-598            Modified Verbex object.
-599        """
-600        return self._add("(\\b\\w+\\b)")
-601
-602    # # --------------- modifiers ------------------------
-603
-604    def with_any_case(self) -> Verbex:
-605        """Modify Verbex object to be case insensitive.
+597    def word(self) -> Verbex:
+598        """Find a word on word boundary.
+599
+600        Returns:
+601            Modified Verbex object.
+602        """
+603        return self._add("(\\b\\w+\\b)")
+604
+605    # # --------------- modifiers ------------------------
 606
-607        Returns:
-608            Modified Verbex object.
-609        """
-610        self._modifiers |= re.IGNORECASE
-611        return self
-612
-613    def search_by_line(self) -> Verbex:
-614        """Search each line, ^ and $ match begining and end of line respectively.
+607    def with_any_case(self) -> Verbex:
+608        """Modify Verbex object to be case insensitive.
+609
+610        Returns:
+611            Modified Verbex object.
+612        """
+613        self._modifiers |= re.IGNORECASE
+614        return self
 615
-616        Returns:
-617            Modified Verbex object.
-618        """
-619        self._modifiers |= re.MULTILINE
-620        return self
-621
-622    def with_ascii(self) -> Verbex:
-623        """Match ascii instead of unicode.
+616    def search_by_line(self) -> Verbex:
+617        """Search each line, ^ and $ match begining and end of line respectively.
+618
+619        Returns:
+620            Modified Verbex object.
+621        """
+622        self._modifiers |= re.MULTILINE
+623        return self
 624
-625        Returns:
-626            Modified Verbex object.
-627        """
-628        self._modifiers |= re.ASCII
-629        return self
+625    def with_ascii(self) -> Verbex:
+626        """Match ascii instead of unicode.
+627
+628        Returns:
+629            Modified Verbex object.
+630        """
+631        self._modifiers |= re.ASCII
+632        return self
@@ -1967,17 +1970,17 @@
Inherited Members
View Source - 
206    @re_escape
-207    @beartype
-208    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
-209        """Create a Verbex object; setting any needed flags.
-210
-211        Keyword Arguments:
-212            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
-213        """
-214        # self._parts: List[str] = [text]
-215        self._parts: List[str] = []
-216        self._modifiers = modifiers
+            
209    @re_escape
+210    @beartype
+211    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
+212        """Create a Verbex object; setting any needed flags.
+213
+214        Keyword Arguments:
+215            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
+216        """
+217        # self._parts: List[str] = [text]
+218        self._parts: List[str] = []
+219        self._modifiers = modifiers
@@ -2025,12 +2028,12 @@
Inherited Members
View Source - 
244    def regex(self) -> Pattern[str]:
-245        """Get a regular expression object."""
-246        return re.compile(
-247            str(self),
-248            self._modifiers,
-249        )
+            
247    def regex(self) -> Pattern[str]:
+248        """Get a regular expression object."""
+249        return re.compile(
+250            str(self),
+251            self._modifiers,
+252        )
@@ -2056,35 +2059,35 @@
Inherited Members
View Source - 
270    @re_escape
-271    @beartype
-272    @_poseur_decorator("self")
-273    def capture_group(
-274        self,
-275        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
-276        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
-277    ) -> Verbex:
-278        """Create a capture group.
-279
-280        Name is optional if not specified then the first argument is the text.
-281
-282        Keyword Arguments:
-283            name_or_text -- The name of the group / text to search for (default: {None})
-284            text -- The text to search for (default: {None})
-285
-286        Raises:
-287            ValueError: If name is specified then text must be as well.
+            
273    @re_escape
+274    @beartype
+275    @_poseur_decorator("self")
+276    def capture_group(
+277        self,
+278        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
+279        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
+280    ) -> Verbex:
+281        """Create a capture group.
+282
+283        Name is optional if not specified then the first argument is the text.
+284
+285        Keyword Arguments:
+286            name_or_text -- The name of the group / text to search for (default: {None})
+287            text -- The text to search for (default: {None})
 288
-289        Returns:
-290            Verbex with added capture group.
-291        """
-292        if name_or_text is not None:
-293            if text is None:
-294                _text = name_or_text
-295                return self._capture_group_without_name(_text)
-296            if isinstance(name_or_text, str):
-297                return self._capture_group_with_name(name_or_text, text)
-298        raise ValueError("text must be specified with optional name")
+289        Raises:
+290            ValueError: If name is specified then text must be as well.
+291
+292        Returns:
+293            Verbex with added capture group.
+294        """
+295        if name_or_text is not None:
+296            if text is None:
+297                _text = name_or_text
+298                return self._capture_group_without_name(_text)
+299            if isinstance(name_or_text, str):
+300                return self._capture_group_with_name(name_or_text, text)
+301        raise ValueError("text must be specified with optional name")
@@ -2121,18 +2124,18 @@
Inherited Members
View Source - 
300    @re_escape
-301    @beartype
-302    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa N802
-303        """`or` is a python keyword so we use `OR` instead.
-304
-305        Arguments:
-306            text -- Text to find or a Verbex object.
+            
303    @re_escape
+304    @beartype
+305    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa: N802
+306        """`or` is a python keyword so we use `OR` instead.
 307
-308        Returns:
-309            Modified Verbex object.
-310        """
-311        return self._add("|").find(text)
+308        Arguments:
+309            text -- Text to find or a Verbex object.
+310
+311        Returns:
+312            Modified Verbex object.
+313        """
+314        return self._add("|").find(text)
@@ -2163,18 +2166,18 @@
Inherited Members
View Source - 
313    @re_escape
-314    @beartype
-315    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-316        """Find the text or Verbex object zero or more times.
-317
-318        Arguments:
-319            text -- The text / Verbex object to look for.
+            
316    @re_escape
+317    @beartype
+318    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+319        """Find the text or Verbex object zero or more times.
 320
-321        Returns:
-322            Modified Verbex object.
-323        """
-324        return self._add(f"(?:{str(text)})*")
+321        Arguments:
+322            text -- The text / Verbex object to look for.
+323
+324        Returns:
+325            Modified Verbex object.
+326        """
+327        return self._add(f"(?:{str(text)})*")
@@ -2205,18 +2208,18 @@
Inherited Members
View Source - 
326    @re_escape
-327    @beartype
-328    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-329        """Find the text or Verbex object one or more times.
-330
-331        Arguments:
-332            text -- The text / Verbex object to look for.
+            
329    @re_escape
+330    @beartype
+331    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+332        """Find the text or Verbex object one or more times.
 333
-334        Returns:
-335            Modified Verbex object.
-336        """
-337        return self._add(f"(?:{str(text)})+")
+334        Arguments:
+335            text -- The text / Verbex object to look for.
+336
+337        Returns:
+338            Modified Verbex object.
+339        """
+340        return self._add(f"(?:{str(text)})+")
@@ -2248,22 +2251,22 @@
Inherited Members
View Source - 
339    @re_escape
-340    @beartype
-341    def n_times(
-342        self,
-343        text: VerbexEscapedCharClassOrSpecial,
-344        n: int,  # noqa: VNE001
-345    ) -> Verbex:
-346        """Find the text or Verbex object n or more times.
-347
-348        Arguments:
-349            text -- The text / Verbex object to look for.
+            
342    @re_escape
+343    @beartype
+344    def n_times(
+345        self,
+346        text: VerbexEscapedCharClassOrSpecial,
+347        n: int,  # noqa: VNE001
+348    ) -> Verbex:
+349        """Find the text or Verbex object n or more times.
 350
-351        Returns:
-352            Modified Verbex object.
-353        """
-354        return self._add(f"(?:{str(text)}){{{n}}}")
+351        Arguments:
+352            text -- The text / Verbex object to look for.
+353
+354        Returns:
+355            Modified Verbex object.
+356        """
+357        return self._add(f"(?:{str(text)}){{{n}}}")
@@ -2295,22 +2298,22 @@
Inherited Members
View Source - 
356    @re_escape
-357    @beartype
-358    def n_times_or_more(
-359        self,
-360        text: VerbexEscapedCharClassOrSpecial,
-361        n: int,  # noqa: VNE001
-362    ) -> Verbex:
-363        """Find the text or Verbex object at least n times.
-364
-365        Arguments:
-366            text -- The text / Verbex object to look for.
+            
359    @re_escape
+360    @beartype
+361    def n_times_or_more(
+362        self,
+363        text: VerbexEscapedCharClassOrSpecial,
+364        n: int,  # noqa: VNE001
+365    ) -> Verbex:
+366        """Find the text or Verbex object at least n times.
 367
-368        Returns:
-369            Modified Verbex object.
-370        """
-371        return self._add(f"(?:{str(text)}){{{n},}}")
+368        Arguments:
+369            text -- The text / Verbex object to look for.
+370
+371        Returns:
+372            Modified Verbex object.
+373        """
+374        return self._add(f"(?:{str(text)}){{{n},}}")
@@ -2343,23 +2346,23 @@
Inherited Members
View Source - 
373    @re_escape
-374    @beartype
-375    def n_to_m_times(
-376        self,
-377        text: VerbexEscapedCharClassOrSpecial,
-378        n: int,  # noqa: VNE001
-379        m: int,  # noqa: VNE001
-380    ) -> Verbex:
-381        """Find the text or Verbex object between n and m times.
-382
-383        Arguments:
-384            text -- The text / Verbex object to look for.
+            
376    @re_escape
+377    @beartype
+378    def n_to_m_times(
+379        self,
+380        text: VerbexEscapedCharClassOrSpecial,
+381        n: int,  # noqa: VNE001
+382        m: int,  # noqa: VNE001
+383    ) -> Verbex:
+384        """Find the text or Verbex object between n and m times.
 385
-386        Returns:
-387            Modified Verbex object.
-388        """
-389        return self._add(f"(?:{str(text)}){{{n},{m}}}")
+386        Arguments:
+387            text -- The text / Verbex object to look for.
+388
+389        Returns:
+390            Modified Verbex object.
+391        """
+392        return self._add(f"(?:{str(text)}){{{n},{m}}}")
@@ -2390,18 +2393,18 @@
Inherited Members
View Source - 
391    @re_escape
-392    @beartype
-393    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-394        """Possibly find the text / Verbex object.
-395
-396        Arguments:
-397            text -- The text / Verbex object to possibly find.
+            
394    @re_escape
+395    @beartype
+396    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+397        """Possibly find the text / Verbex object.
 398
-399        Returns:
-400            Modified Verbex object.
-401        """
-402        return self._add(f"(?:{str(text)})?")
+399        Arguments:
+400            text -- The text / Verbex object to possibly find.
+401
+402        Returns:
+403            Modified Verbex object.
+404        """
+405        return self._add(f"(?:{str(text)})?")
@@ -2432,18 +2435,18 @@
Inherited Members
View Source - 
404    @re_escape
-405    @beartype
-406    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-407        """Find the text or Verbex object.
-408
-409        Arguments:
-410            text -- The text / Verbex object to look for.
+            
407    @re_escape
+408    @beartype
+409    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+410        """Find the text or Verbex object.
 411
-412        Returns:
-413            Modified Verbex object.
-414        """
-415        return self._add(str(text))
+412        Arguments:
+413            text -- The text / Verbex object to look for.
+414
+415        Returns:
+416            Modified Verbex object.
+417        """
+418        return self._add(str(text))
@@ -2474,18 +2477,18 @@
Inherited Members
View Source - 
417    @re_escape
-418    @beartype
-419    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-420        """Synonym for find.
-421
-422        Arguments:
-423            text -- The text / Verbex object to look for.
+            
420    @re_escape
+421    @beartype
+422    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+423        """Synonym for find.
 424
-425        Returns:
-426            Modified Verbex object.
-427        """
-428        return self.find(text)
+425        Arguments:
+426            text -- The text / Verbex object to look for.
+427
+428        Returns:
+429            Modified Verbex object.
+430        """
+431        return self.find(text)
@@ -2516,17 +2519,17 @@
Inherited Members
View Source - 
430    @re_escape
-431    @beartype
-432    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-433        """Match if string is followed by text.
-434
-435        Positive lookahead
-436
-437        Returns:
-438            Modified Verbex object.
-439        """
-440        return self._add(f"(?={text})")
+            
433    @re_escape
+434    @beartype
+435    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+436        """Match if string is followed by text.
+437
+438        Positive lookahead
+439
+440        Returns:
+441            Modified Verbex object.
+442        """
+443        return self._add(f"(?={text})")
@@ -2556,17 +2559,17 @@
Inherited Members
View Source - 
442    @re_escape
-443    @beartype
-444    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-445        """Match if string is not followed by text.
-446
-447        Negative lookahead
-448
-449        Returns:
-450            Modified Verbex object.
-451        """
-452        return self._add(f"(?!{text})")
+            
445    @re_escape
+446    @beartype
+447    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+448        """Match if string is not followed by text.
+449
+450        Negative lookahead
+451
+452        Returns:
+453            Modified Verbex object.
+454        """
+455        return self._add(f"(?!{text})")
@@ -2596,17 +2599,17 @@
Inherited Members
View Source - 
454    @re_escape
-455    @beartype
-456    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-457        """Match if string is not preceded by text.
-458
-459        Positive lookbehind
-460
-461        Returns:
-462            Modified Verbex object.
-463        """
-464        return self._add(f"(?<={text})")
+            
457    @re_escape
+458    @beartype
+459    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+460        """Match if string is not preceded by text.
+461
+462        Positive lookbehind
+463
+464        Returns:
+465            Modified Verbex object.
+466        """
+467        return self._add(f"(?<={text})")
@@ -2636,17 +2639,17 @@
Inherited Members
View Source - 
466    @re_escape
-467    @beartype
-468    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-469        """Match if string is not preceded by text.
-470
-471        Negative Lookbehind
-472
-473        Returns:
-474            Modified Verbex object.
-475        """
-476        return self._add(f"(?<!{text})")
+            
469    @re_escape
+470    @beartype
+471    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
+472        """Match if string is not preceded by text.
+473
+474        Negative Lookbehind
+475
+476        Returns:
+477            Modified Verbex object.
+478        """
+479        return self._add(f"(?<!{text})")
@@ -2676,18 +2679,18 @@
Inherited Members
View Source - 
480    @re_escape
-481    @beartype
-482    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
-483        """Find anything in this group of chars or char class.
-484
-485        Arguments:
-486            text -- The characters to look for.
+            
483    @re_escape
+484    @beartype
+485    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
+486        """Find anything in this group of chars or char class.
 487
-488        Returns:
-489            Modified Verbex object.
-490        """
-491        return self._add(f"(?:[{chargroup}])")
+488        Arguments:
+489            text -- The characters to look for.
+490
+491        Returns:
+492            Modified Verbex object.
+493        """
+494        return self._add(f"(?:[{chargroup}])")
@@ -2718,18 +2721,18 @@
Inherited Members
View Source - 
493    @re_escape
-494    @beartype
-495    def not_any_of(self, text: CharClassOrChars) -> Verbex:
-496        """Find anything but this group of chars or char class.
-497
-498        Arguments:
-499            text -- The characters to not look for.
+            
496    @re_escape
+497    @beartype
+498    def not_any_of(self, text: CharClassOrChars) -> Verbex:
+499        """Find anything but this group of chars or char class.
 500
-501        Returns:
-502            Modified Verbex object.
-503        """
-504        return self._add(f"(?:[^{text}])")
+501        Arguments:
+502            text -- The characters to not look for.
+503
+504        Returns:
+505            Modified Verbex object.
+506        """
+507        return self._add(f"(?:[^{text}])")
@@ -2759,17 +2762,17 @@
Inherited Members
View Source - 
506    @re_escape
-507    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
-508        """Find anything one or more times but this group of chars or char class.
-509
-510        Arguments:
-511            text -- The characters to not look for.
+            
509    @re_escape
+510    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
+511        """Find anything one or more times but this group of chars or char class.
 512
-513        Returns:
-514            Modified Verbex object.
-515        """
-516        return self._add(f"[^{chargroup}]+")
+513        Arguments:
+514            text -- The characters to not look for.
+515
+516        Returns:
+517            Modified Verbex object.
+518        """
+519        return self._add(f"[^{chargroup}]+")
@@ -2795,13 +2798,13 @@
Inherited Members
View Source - 
520    def start_of_line(self) -> Verbex:
-521        """Find the start of the line.
-522
-523        Returns:
-524            Modified Verbex object.
-525        """
-526        return self.find(SpecialChar.START_OF_LINE)
+            
523    def start_of_line(self) -> Verbex:
+524        """Find the start of the line.
+525
+526        Returns:
+527            Modified Verbex object.
+528        """
+529        return self.find(SpecialChar.START_OF_LINE)
@@ -2824,13 +2827,13 @@
Inherited Members
View Source - 
528    def end_of_line(self) -> Verbex:
-529        """Find the end of the line.
-530
-531        Returns:
-532            Modified Verbex object.
-533        """
-534        return self.find(SpecialChar.END_OF_LINE)
+            
531    def end_of_line(self) -> Verbex:
+532        """Find the end of the line.
+533
+534        Returns:
+535            Modified Verbex object.
+536        """
+537        return self.find(SpecialChar.END_OF_LINE)
@@ -2853,13 +2856,13 @@
Inherited Members
View Source - 
536    def line_break(self) -> Verbex:
-537        """Find a line break.
-538
-539        Returns:
-540            Modified Verbex object.
-541        """
-542        return self.find(SpecialChar.LINEBREAK)
+            
539    def line_break(self) -> Verbex:
+540        """Find a line break.
+541
+542        Returns:
+543            Modified Verbex object.
+544        """
+545        return self.find(SpecialChar.LINEBREAK)
@@ -2882,13 +2885,13 @@
Inherited Members
View Source - 
544    def tab(self) -> Verbex:
-545        """Find a tab.
-546
-547        Returns:
-548            Modified Verbex object.
-549        """
-550        return self.find(SpecialChar.TAB)
+            
547    def tab(self) -> Verbex:
+548        """Find a tab.
+549
+550        Returns:
+551            Modified Verbex object.
+552        """
+553        return self.find(SpecialChar.TAB)
@@ -2911,13 +2914,13 @@
Inherited Members
View Source - 
552    def anything(self) -> Verbex:
-553        """Find anything one or more time.
-554
-555        Returns:
-556            Modified Verbex object.
-557        """
-558        return self._add(".+")
+            
555    def anything(self) -> Verbex:
+556        """Find anything one or more time.
+557
+558        Returns:
+559            Modified Verbex object.
+560        """
+561        return self._add(".+")
@@ -2940,13 +2943,13 @@
Inherited Members
View Source - 
560    def as_few(self) -> Verbex:
-561        """Modify previous search to not be greedy.
-562
-563        Returns:
-564            Modified Verbex object.
-565        """
-566        return self._add("?")
+            
563    def as_few(self) -> Verbex:
+564        """Modify previous search to not be greedy.
+565
+566        Returns:
+567            Modified Verbex object.
+568        """
+569        return self._add("?")
@@ -2970,18 +2973,18 @@
Inherited Members
View Source - 
568    @beartype
-569    def number_range(self, start: int, end: int) -> Verbex:
-570        """Generate a range of numbers.
-571
-572        Arguments:
-573            start -- Start of the range
-574            end -- End of the range
-575
-576        Returns:
-577            Modified Verbex object.
-578        """
-579        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
+            
571    @beartype
+572    def number_range(self, start: int, end: int) -> Verbex:
+573        """Generate a range of numbers.
+574
+575        Arguments:
+576            start -- Start of the range
+577            end -- End of the range
+578
+579        Returns:
+580            Modified Verbex object.
+581        """
+582        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
@@ -3013,18 +3016,18 @@
Inherited Members
View Source - 
581    @beartype
-582    def letter_range(self, start: Char, end: Char) -> Verbex:
-583        """Generate a range of letters.
-584
-585        Arguments:
-586            start -- Start of the range
-587            end -- End of the range
-588
-589        Returns:
-590            Modified Verbex object.
-591        """
-592        return self._add(f"[{start}-{end}]")
+            
584    @beartype
+585    def letter_range(self, start: Char, end: Char) -> Verbex:
+586        """Generate a range of letters.
+587
+588        Arguments:
+589            start -- Start of the range
+590            end -- End of the range
+591
+592        Returns:
+593            Modified Verbex object.
+594        """
+595        return self._add(f"[{start}-{end}]")
@@ -3051,13 +3054,13 @@
Inherited Members
View Source - 
594    def word(self) -> Verbex:
-595        """Find a word on word boundary.
-596
-597        Returns:
-598            Modified Verbex object.
-599        """
-600        return self._add("(\\b\\w+\\b)")
+            
597    def word(self) -> Verbex:
+598        """Find a word on word boundary.
+599
+600        Returns:
+601            Modified Verbex object.
+602        """
+603        return self._add("(\\b\\w+\\b)")
@@ -3080,14 +3083,14 @@
Inherited Members
View Source - 
604    def with_any_case(self) -> Verbex:
-605        """Modify Verbex object to be case insensitive.
-606
-607        Returns:
-608            Modified Verbex object.
-609        """
-610        self._modifiers |= re.IGNORECASE
-611        return self
+            
607    def with_any_case(self) -> Verbex:
+608        """Modify Verbex object to be case insensitive.
+609
+610        Returns:
+611            Modified Verbex object.
+612        """
+613        self._modifiers |= re.IGNORECASE
+614        return self
@@ -3110,14 +3113,14 @@
Inherited Members
View Source - 
613    def search_by_line(self) -> Verbex:
-614        """Search each line, ^ and $ match begining and end of line respectively.
-615
-616        Returns:
-617            Modified Verbex object.
-618        """
-619        self._modifiers |= re.MULTILINE
-620        return self
+            
616    def search_by_line(self) -> Verbex:
+617        """Search each line, ^ and $ match begining and end of line respectively.
+618
+619        Returns:
+620            Modified Verbex object.
+621        """
+622        self._modifiers |= re.MULTILINE
+623        return self
@@ -3140,14 +3143,14 @@
Inherited Members
View Source - 
622    def with_ascii(self) -> Verbex:
-623        """Match ascii instead of unicode.
-624
-625        Returns:
-626            Modified Verbex object.
-627        """
-628        self._modifiers |= re.ASCII
-629        return self
+            
625    def with_ascii(self) -> Verbex:
+626        """Match ascii instead of unicode.
+627
+628        Returns:
+629            Modified Verbex object.
+630        """
+631        self._modifiers |= re.ASCII
+632        return self
diff --git a/verbex/verbex.py b/verbex/verbex.py index d47fd4d..1a2d9ac 100644 --- a/verbex/verbex.py +++ b/verbex/verbex.py @@ -16,7 +16,10 @@ except ImportError: from typing_extensions import TypeAlias, Protocol, Annotated, ParamSpec, runtime_checkable # type: ignore # <--- if Python < 3.9.0 # noqa E501 -from typing import Pattern, TypeVar +from typing import TYPE_CHECKING, Pattern, TypeVar + +if TYPE_CHECKING: + from typing import Protocol # noqa: F811 from beartype import beartype # type: ignore from beartype.typing import ( # type: ignore @@ -40,8 +43,8 @@ def _string_len_is_1(text: object) -> bool: Char = Annotated[str, Is[_string_len_is_1]] -P = ParamSpec("P") # noqa VNE001 -R = TypeVar("R") # noqa VNE001 +P = ParamSpec("P") # noqa: VNE001 +R = TypeVar("R") # noqa: VNE001 # work around for bug https://github.com/python/mypy/issues/12660 @@ -299,7 +302,7 @@ def capture_group( @re_escape @beartype - def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: # noqa N802 + def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: # noqa: N802 """`or` is a python keyword so we use `OR` instead. Arguments: From 7f5b797ee56f2ca8f843795e80043d1d9d8c16ef Mon Sep 17 00:00:00 2001 From: "R. Broderick" Date: Sun, 28 Apr 2024 01:03:30 -0400 Subject: [PATCH 64/85] cleanup and move to new dev enviroment. Drop support for python versions < 3.10 --- .gitattributes | 51 +- .github/dependabot.yml | 7 + .github/workflows/black.yaml | 24 + .github/workflows/dapperdata.yaml | 24 + .github/workflows/gh_pages.yaml | 18 + .github/workflows/main.yml | 41 - .github/workflows/mypy.yaml | 24 + .github/workflows/pip-audit.yaml | 23 + .github/workflows/pypi.yaml | 93 + .github/workflows/pytest.yaml | 27 + .github/workflows/ruff.yaml | 24 + .github/workflows/tomlsort.yaml | 27 + .github/workflows/tox.yaml | 30 + .gitignore | 169 +- .pre-commit-config.yaml | 197 +- .python-version | 1 + .yamllint | 3 + CODE_OF_CONDUCT.md | 5 + GPLv3_LICENSE.txt | 674 ------ LICENSE.txt | 687 +++++- MANIFEST.IN | 3 - builddoc.bat | 3 - check_names.py | 69 - docs/Makefile | 20 + docs/_static/css/custom.css | 9 + docs/conf.py | 32 + docs/getting-started.rst | 6 + docs/index.html | 7 - docs/index.rst | 23 + docs/make.bat | 35 + docs/search.js | 46 - docs/source/modules.rst | 7 + docs/source/verbex.rst | 13 + docs/verbex.html | 241 -- docs/verbex/verbex.html | 3346 ---------------------------- justfile | 143 ++ pyproject.toml | 323 ++- setup.cfg | 27 - setup.py | 4 - {verbex => src/verbex}/__init__.py | 0 {verbex => src/verbex}/py.typed | 0 {verbex => src/verbex}/verbex.py | 444 ++-- verbex/GPLv3_LICENSE.txt | 674 ------ verbex/LICENSE.txt | 39 - 44 files changed, 2045 insertions(+), 5618 deletions(-) create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/black.yaml create mode 100644 .github/workflows/dapperdata.yaml create mode 100644 .github/workflows/gh_pages.yaml delete mode 100644 .github/workflows/main.yml create mode 100644 .github/workflows/mypy.yaml create mode 100644 .github/workflows/pip-audit.yaml create mode 100644 .github/workflows/pypi.yaml create mode 100644 .github/workflows/pytest.yaml create mode 100644 .github/workflows/ruff.yaml create mode 100644 .github/workflows/tomlsort.yaml create mode 100644 .github/workflows/tox.yaml create mode 100644 .python-version create mode 100644 CODE_OF_CONDUCT.md delete mode 100644 GPLv3_LICENSE.txt delete mode 100644 MANIFEST.IN delete mode 100644 builddoc.bat delete mode 100644 check_names.py create mode 100644 docs/Makefile create mode 100644 docs/_static/css/custom.css create mode 100644 docs/conf.py create mode 100644 docs/getting-started.rst delete mode 100644 docs/index.html create mode 100644 docs/index.rst create mode 100644 docs/make.bat delete mode 100644 docs/search.js create mode 100644 docs/source/modules.rst create mode 100644 docs/source/verbex.rst delete mode 100644 docs/verbex.html delete mode 100644 docs/verbex/verbex.html create mode 100644 justfile delete mode 100644 setup.cfg delete mode 100755 setup.py rename {verbex => src/verbex}/__init__.py (100%) rename {verbex => src/verbex}/py.typed (100%) rename {verbex => src/verbex}/verbex.py (56%) delete mode 100644 verbex/GPLv3_LICENSE.txt delete mode 100644 verbex/LICENSE.txt diff --git a/.gitattributes b/.gitattributes index 72c1b76..49f64d0 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,50 +1 @@ -# .gitattributes snippet to force users to use same line endings for project. -# -# Handle line endings automatically for files detected as text -# and leave all files detected as binary untouched. -* text=auto - -# -# The above will handle all files NOT found below -# https://help.github.com/articles/dealing-with-line-endings/ -# https://github.com/Danimoth/gitattributes/blob/master/Web.gitattributes - - - -# These files are text and should be normalized (Convert crlf => lf) -*.php text -*.css text -*.js text -*.json text -*.htm text -*.html text -*.xml text -*.txt text -*.ini text -*.inc text -*.pl text -*.rb text -*.py text -*.scm text -*.sql text -.htaccess text -*.sh text - -# These files are binary and should be left untouched -# (binary is a macro for -text -diff) -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.mov binary -*.mp4 binary -*.mp3 binary -*.flv binary -*.fla binary -*.swf binary -*.gz binary -*.zip binary -*.7z binary -*.ttf binary -*.pyc binary +stringdatadeque/_version.py export-subst diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..718572b --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,7 @@ +version: 2 + +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/workflows/black.yaml b/.github/workflows/black.yaml new file mode 100644 index 0000000..adc6081 --- /dev/null +++ b/.github/workflows/black.yaml @@ -0,0 +1,24 @@ +name: Black Formatting + +"on": + push: + pull_request: + +jobs: + black: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version-file: .python-version + cache: 'pip' + + - uses: taiki-e/install-action@just + + - name: Install Dependencies + run: just install + + - name: Test Formatting + run: just ruff_format_fixes diff --git a/.github/workflows/dapperdata.yaml b/.github/workflows/dapperdata.yaml new file mode 100644 index 0000000..f8c2a7f --- /dev/null +++ b/.github/workflows/dapperdata.yaml @@ -0,0 +1,24 @@ +name: Configuration File Formatting + +"on": + push: + pull_request: + +jobs: + dapperdata: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version-file: .python-version + cache: 'pip' + + - uses: taiki-e/install-action@just + + - name: Install Dependencies + run: just install + + - name: Test Formatting + run: just dapperdata_check diff --git a/.github/workflows/gh_pages.yaml b/.github/workflows/gh_pages.yaml new file mode 100644 index 0000000..ac6bda7 --- /dev/null +++ b/.github/workflows/gh_pages.yaml @@ -0,0 +1,18 @@ +name: Deploy Sphinx documentation to Pages + +"on": + push: + branches: [main] # branch to trigger deployment + +jobs: + pages: + runs-on: ubuntu-20.04 + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + permissions: + pages: write + id-token: write + steps: + - id: deployment + uses: sphinx-notes/pages@v3 diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml deleted file mode 100644 index a413918..0000000 --- a/.github/workflows/main.yml +++ /dev/null @@ -1,41 +0,0 @@ -# This is a basic workflow to help you get started with Actions - -name: CI - -# Controls when the workflow will run -on: # yamllint disable-line rule:truthy - # Triggers the workflow on push or pull request events but only for the master branch - push: - branches: [master] - pull_request: - branches: [master] - - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -# A workflow run is made up of one or more jobs that can run sequentially or in parallel -jobs: - # This workflow contains a single job called "build" - build: - # The type of runner that the job will run on - runs-on: ${{ matrix.os }} - strategy: - matrix: - os: [ubuntu-latest, windows-latest] - python-version: ['3.7', '3.8', '3.9', '3.10'] - # Steps represent a sequence of tasks that will be executed as part of the job - steps: - # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - - uses: actions/checkout@v3 - - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v3 - with: - python-version: ${{ matrix.python-version }} - - name: Display Python version - run: python --version - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install tox tox-gh-actions - - name: Run tests - run: tox -v diff --git a/.github/workflows/mypy.yaml b/.github/workflows/mypy.yaml new file mode 100644 index 0000000..a2ed158 --- /dev/null +++ b/.github/workflows/mypy.yaml @@ -0,0 +1,24 @@ +name: Mypy testing + +"on": + push: + pull_request: + +jobs: + mypy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version-file: .python-version + cache: 'pip' + + - uses: taiki-e/install-action@just + + - name: Install Dependencies + run: just install + + - name: Test Typing + run: just mypy diff --git a/.github/workflows/pip-audit.yaml b/.github/workflows/pip-audit.yaml new file mode 100644 index 0000000..4c9bfb2 --- /dev/null +++ b/.github/workflows/pip-audit.yaml @@ -0,0 +1,23 @@ +name: Pip-Audit + +"on": + push: + pull_request: + +jobs: + selftest: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version-file: .python-version + cache: 'pip' + + - uses: taiki-e/install-action@just + + - name: Install Dependencies + run: just install + + - uses: pypa/gh-action-pip-audit@v1.0.8 diff --git a/.github/workflows/pypi.yaml b/.github/workflows/pypi.yaml new file mode 100644 index 0000000..241e314 --- /dev/null +++ b/.github/workflows/pypi.yaml @@ -0,0 +1,93 @@ +name: Publish Python distribution to PyPI and TestPyPI + +"on": push + +jobs: + build: + name: Build distribution + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.x" + - name: Install pypa/build + run: >- + python3 -m + pip install + build + --user + - name: Build a binary wheel and a source tarball + run: python3 -m build + - name: Store the distribution packages + uses: actions/upload-artifact@v4 + with: + name: python-package-distributions + path: dist/ + + publish-to-pypi: + name: >- + Publish Python distribution to PyPI + if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes + needs: + - build + runs-on: ubuntu-latest + environment: + name: pypi + url: https://pypi.org/project/protocol-implements-decorator/ # Replace with your PyPI project name + permissions: + id-token: write # IMPORTANT: mandatory for trusted publishing + + steps: + - name: Download all the dists + uses: actions/download-artifact@v4 + with: + name: python-package-distributions + path: dist/ + - name: Publish distribution to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 + + github-release: + name: >- + Sign the Python distribution with Sigstore + and upload them to GitHub Release + needs: + - publish-to-pypi + runs-on: ubuntu-latest + + permissions: + contents: write # IMPORTANT: mandatory for making GitHub Releases + id-token: write # IMPORTANT: mandatory for sigstore + + steps: + - name: Download all the dists + uses: actions/download-artifact@v4 + with: + name: python-package-distributions + path: dist/ + - name: Sign the dists with Sigstore + uses: sigstore/gh-action-sigstore-python@v2.1.1 + with: + inputs: >- + ./dist/*.tar.gz + ./dist/*.whl + - name: Create GitHub Release + env: + GITHUB_TOKEN: ${{ github.token }} + run: >- + gh release create + '${{ github.ref_name }}' + --repo '${{ github.repository }}' + --notes "" + - name: Upload artifact signatures to GitHub Release + env: + GITHUB_TOKEN: ${{ github.token }} + # Upload to GitHub Release using the `gh` CLI. + # `dist/` contains the built packages, and the + # sigstore-produced signatures and certificates. + run: >- + gh release upload + '${{ github.ref_name }}' dist/** + --repo '${{ github.repository }}' diff --git a/.github/workflows/pytest.yaml b/.github/workflows/pytest.yaml new file mode 100644 index 0000000..fc12c26 --- /dev/null +++ b/.github/workflows/pytest.yaml @@ -0,0 +1,27 @@ +name: PyTest + +"on": + push: + pull_request: + +env: + COLUMNS: 120 + +jobs: + pytest: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version-file: .python-version + cache: 'pip' + + - uses: taiki-e/install-action@just + + - name: Install Dependencies + run: just install + + - name: Run Tests + run: just pytest diff --git a/.github/workflows/ruff.yaml b/.github/workflows/ruff.yaml new file mode 100644 index 0000000..72009ea --- /dev/null +++ b/.github/workflows/ruff.yaml @@ -0,0 +1,24 @@ +name: Ruff Linting + +"on": + push: + pull_request: + +jobs: + black: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version-file: .python-version + cache: 'pip' + + - uses: taiki-e/install-action@just + + - name: Install Dependencies + run: just install + + - name: Test Formatting + run: just ruff_check diff --git a/.github/workflows/tomlsort.yaml b/.github/workflows/tomlsort.yaml new file mode 100644 index 0000000..bf63104 --- /dev/null +++ b/.github/workflows/tomlsort.yaml @@ -0,0 +1,27 @@ +name: TOML Formatting + +"on": + push: + pull_request: + +jobs: + tomlsort: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version-file: .python-version + cache: 'pip' + + - uses: taiki-e/install-action@just + + - name: Install Dependencies + run: just install + + - name: Install toml-sort + run: pip install toml-sort + + - name: Test Typing + run: just tomlsort_check diff --git a/.github/workflows/tox.yaml b/.github/workflows/tox.yaml new file mode 100644 index 0000000..c33f979 --- /dev/null +++ b/.github/workflows/tox.yaml @@ -0,0 +1,30 @@ +name: TOX testing + +"on": + push: + pull_request: + +jobs: + tox: + runs-on: ubuntu-latest + env: + TOX_PARALLEL_NO_SPINNER: 1 # Removes logging spam + steps: + - name: Checkout and setup Pythons + uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: '3.10' + cache: 'pip' + - uses: actions/setup-python@v5 + with: + python-version: '3.11' + cache: 'pip' + - uses: actions/setup-python@v5 + with: + python-version: '3.12' + cache: 'pip' + - name: Install tox and run tests + run: | + pip install tox + tox --parallel diff --git a/.gitignore b/.gitignore index af4b16f..1b3a25f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,20 +1,161 @@ +# Byte-compiled / optimized / DLL files __pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python build/ -.vscode/ -.tox/ +develop-eggs/ +dist/ +downloads/ eggs/ .eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ *.egg-info/ -~* -.mypy_cache/ -.pspp -.cache/ -.viminfo -.idea/ -desktop.ini -.gitconfig -.recommenders -.metadata/ -.venv/ +.installed.cfg +*.egg +MANIFEST +*.bak + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +#.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +Pipfile.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ venv/ -__pycache__/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ +.vscode + +#cprofiler +*.prof + +#taskfile +task diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index b6a5152..71c0181 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,13 +1,18 @@ -# See https://pre-commit.com for more information -# See https://pre-commit.com/hooks.html for more hooks minimum_pre_commit_version: 1.21.0 repos: - repo: meta hooks: - - id: check-hooks-apply +# - id: check-hooks-apply - id: check-useless-excludes - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.2.0 + rev: v4.6.0 + hooks: + - id: check-ast + - id: check-json + - id: check-toml + - id: check-yaml + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.6.0 hooks: - id: trailing-whitespace types: [file, text] @@ -16,8 +21,9 @@ repos: types: [file, text] exclude_types: [html, javascript] - id: check-case-conflict + - id: mixed-line-ending - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.2.0 + rev: v4.6.0 hooks: - id: check-merge-conflict name: "Check for merge conflicts" @@ -28,134 +34,71 @@ repos: name: "TOML: check toml syntax" types: [file, toml] - repo: https://github.com/python-jsonschema/check-jsonschema - rev: 0.14.3 + rev: 0.28.2 hooks: - id: check-github-workflows - repo: https://github.com/adrienverge/yamllint.git - rev: v1.26.3 # or higher tag + rev: v1.35.1 # or higher tag hooks: - id: yamllint name: "Yaml: Linting files" args: [--format, parsable, --strict] types: [file, yaml] - repo: https://github.com/Lucas-C/pre-commit-hooks - rev: v1.1.13 + rev: v1.5.5 hooks: - id: remove-tabs name: "Python: Convert Tabs to 4 spaces" args: ['--whitespaces-count', '4'] # defaults to: 4 types: [file, python] - - repo: https://github.com/psf/black - rev: 22.3.0 - hooks: - - id: black - name: "Python: Formating files" - args: [--line-length=88, --preview, --safe] - types: [file, python] - repo: https://github.com/asottile/pyupgrade - rev: v2.32.1 + rev: v3.15.2 hooks: - id: pyupgrade name: "Python: upgrade syntax" - args: [--py37-plus] + args: [--py310-plus] - repo: https://github.com/hadialqattan/pycln - rev: v1.3.2 + rev: v2.4.0 hooks: - id: pycln name: "Python: remove unused imports." - - repo: https://github.com/asottile/blacken-docs - rev: v1.12.1 + - repo: https://github.com/rbroderi/precommithooks + rev: v1.0.2 hooks: - - id: blacken-docs - name: "Python: Formating code in docstrings" - additional_dependencies: [black==22.3] + - id: python_file_name_check + name: "Python: File name check" + args: ["--ignore-test-files"] + - repo: https://github.com/astral-sh/ruff-pre-commit + # Ruff version. + rev: v0.4.2 + hooks: + # Run the linter. + - id: ruff + name: "Python: Ruff" types: [file, python] - - repo: https://github.com/pycqa/isort - rev: 5.10.1 - hooks: - - id: isort - name: "Python: Sorting imports" + args: [--fix] + fail_fast: true + # Run the formatter. + - id: ruff-format + name: "Python: Ruff format" types: [file, python] - args: - - "--multi-line=3" # makes this compatible with add-trailing-comma - - "--trailing-comma" # makes this compatible with add-trailing-comma - - "--profile" - - "black" + fail_fast: true - repo: local hooks: - - id: python_file_name_check - name: "Python: File name check" - entry: "python ./check_names.py" - language: python - pass_filenames: true - types: [file, python] - verbose: false - - repo: https://github.com/pycqa/flake8 - rev: '4.0.1' # old 4.0.1 seem to freeze? - hooks: - - id: flake8 - name: "Python: Linting files (flake8)" - args: # arguments to configure flake8 - # making isort line length compatible with black - - "--max-line-length=88" - - "--max-complexity=18" - - "--kwargs-max-positional-arguments=4" - # allowing these errors now that in the past we ignored. - # D100 Missing docstring in public module - # D103 Missing docstring in public function - # D104 Missing docstring in public package - # D105 Missing docstring in magic method - # D107 Missing docstring in __init__ - # D200 One-line docstring should fit on one line with quotes - # D205 1 blank line required between summary line and description - # D400 First line should end with a period - # D401 First line should be in imperative mood - # D403 First word of the first line should be properly capitalized - # these are errors that will be ignored by flake8 - # VNE002 variable name 'XXX' should be clarified - # W503 see https://www.flake8rules.com/rules/W503.html no longer best practice - # - "--ignore=VNE002,W503" - # removed cohesion as it was causing issues with enum type classes - # E203 spaces around ':' ignoring per https://github.com/psf/black/issues/315 - # PD005 and PD011 falsely flag on other add or values methods - - "--ignore=W503,E203, PD005, PD011" - # when checking with wemake - "--ignore=W503,E203, PD005, PD011, WPS226, WPS112, WPS204, Q000, WPS421, WPS305, WPS237, WPS529, E800, C812, WPS110, WPS360, WPS323" - additional_dependencies: - - flake8-blind-except - - flake8-assert-msg - - flake8-builtins - - flake8-docstrings - - flake8-implicit-str-concat - - flake8-mock - - flake8-variables-names - - pep8-naming - - flake8-bugbear - - flake8-executable - - flake8-raise - - flake8-pytest - - flake8-use-pathlib - - flake8-string-format - - flake8-colors - - flake8-tuple - - pandas-vet - - flake8-length - - flake8-assertive - - flake8-warnings - - flake8-comprehensions - - flake8-simplify - - flake8-noqa - - flake8-force-keyword-arguments - exclude: "setup[.]py|conf[.]py|__init__[.]py" + - id: pylint + name: "Python: Pylint code with Perflint" + entry: python -m pylint + language: system types: [file, python] + args: [-rn, -sn, --load-plugins=perflint] - repo: https://github.com/asottile/add-trailing-comma - rev: v2.2.3 + rev: v3.1.0 hooks: - id: add-trailing-comma name: "Python: Add trailing comma" - args: [--py36-plus] types: [file, python] - repo: https://github.com/pre-commit/mirrors-mypy - rev: 'v0.950' + rev: 'v1.10.0' hooks: - id: mypy name: "Python: Checking variable types" @@ -167,36 +110,12 @@ repos: - pandas-stubs types: [file, python] - repo: https://github.com/PyCQA/bandit - rev: '1.7.4' + rev: '1.7.8' hooks: - id: bandit name: "Python: Checking for potential security issues (bandit)" args: - "--skip=B404,B506,B607,B603,B701,B101,B602" - - repo: https://github.com/jazzband/pip-tools - rev: 6.6.0 - hooks: - - id: pip-compile - name: "Python: Compile any requirements.in to requirements.txt" - args: [--quiet, --no-allow-unsafe, requirements.in] - files: requirements[.]in - - id: pip-compile - name: "Python: Compile any requirements_dev.in to requirements_dev.txt" - args: [--quiet, --no-allow-unsafe, requirements_dev.in] - files: requirements_dev[.]in - - repo: https://github.com/Lucas-C/pre-commit-hooks-safety - rev: v1.2.4 - hooks: - - id: python-safety-dependencies-check - name: "Python: Checking requirements.txt files for vulnerablitites" - always_run: true - files: requirements.txt - args: [requirements.txt] - - id: python-safety-dependencies-check - name: "Python: Checking requirements_dev.txt files for vulnerablitites" - always_run: true - files: requirements_dev.txt - args: [requirements_dev.txt] - repo: local hooks: - id: remove-en-dashes @@ -206,7 +125,7 @@ repos: types: [file] types_or: [python, powershell, lua, jinja] - repo: https://github.com/sirosen/texthooks - rev: 0.3.1 + rev: 0.6.6 hooks: - id: fix-smartquotes types: [file] @@ -217,17 +136,23 @@ repos: - id: forbid-bidi-controls types: [file] types_or: [python, powershell, lua, jinja] + fail_fast: true + - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks + rev: v2.13.0 + hooks: + - id: pretty-format-java + args: [--autofix] + - id: pretty-format-golang + args: [--autofix] + - id: pretty-format-ini + args: [--autofix] + - id: pretty-format-rust + args: [--autofix] - repo: local hooks: - - id: pdoc - name: "Generate Documentation" - description: 'Auto generating documentation with PDOC' - entry: pdoc - args: [verbex, -o, docs] - language: python - language_version: python3 - require_serial: true - types: [python] + - id: fixes + name: fixes + entry: just _fixes_no_ruff + language: system pass_filenames: false - additional_dependencies: - - beartype + verbose: true diff --git a/.python-version b/.python-version new file mode 100644 index 0000000..8531a3b --- /dev/null +++ b/.python-version @@ -0,0 +1 @@ +3.12.2 diff --git a/.yamllint b/.yamllint index afbda05..2ce5d39 100644 --- a/.yamllint +++ b/.yamllint @@ -4,3 +4,6 @@ rules: document-start: disable new-lines: disable line-length: disable + truthy: + level: warning + indentation: disable diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..a734e49 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,5 @@ +# Contributor Code of Conduct + +This project adheres to No Code of Conduct. We are all adults. We accept anyone's contributions. Nothing else matters. + +For more information please visit the [No Code of Conduct](https://github.com/domgetter/NCoC) homepage. diff --git a/GPLv3_LICENSE.txt b/GPLv3_LICENSE.txt deleted file mode 100644 index f288702..0000000 --- a/GPLv3_LICENSE.txt +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/LICENSE.txt b/LICENSE.txt index 4b5ad82..ba81a44 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,18 +1,681 @@ Verbal Expressions Copyright (C) 2022 Richard Broderick -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see . + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + This file incorporates work covered by the following copyright and permission notice: diff --git a/MANIFEST.IN b/MANIFEST.IN deleted file mode 100644 index 6ed0c64..0000000 --- a/MANIFEST.IN +++ /dev/null @@ -1,3 +0,0 @@ -include verbex/py.typed -include verbex/LICENSE.TXT -include verbex/GPLv3_LICENSE.txt diff --git a/builddoc.bat b/builddoc.bat deleted file mode 100644 index c5f576f..0000000 --- a/builddoc.bat +++ /dev/null @@ -1,3 +0,0 @@ -pushd "%~dp0" -pdoc verbex/verbex -o docs -pause diff --git a/check_names.py b/check_names.py deleted file mode 100644 index 3525104..0000000 --- a/check_names.py +++ /dev/null @@ -1,69 +0,0 @@ -"""Checks module and package names for pep8 compliance.""" -import argparse -import re -from enum import IntEnum -from pathlib import Path - -try: - from exit_codes.exit_codes import ExitCode -except ImportError: - - class ExitCode(IntEnum): # type: ignore - """Redefine in case ExitCode is not installed.""" - - OS_FILE = 1 - DATA_ERR = 2 - OK = 0 - - -SHORT_NAME_LIMIT = 30 - - -def main() -> int: - """Check the file.""" - parser = argparse.ArgumentParser() - parser.add_argument("files", nargs="+") - args = parser.parse_args() - for file_to_check in args.files: - # verify file exists - file_path = Path(file_to_check) - if not file_path.exists(): - print("ERROR: the file doesn't exist") - return ExitCode.OS_FILE - module_name = file_path.stem - package_name = file_path.parent.name - # check length for module and package name - if len(module_name) > SHORT_NAME_LIMIT: - print(f"ERROR: '{module_name}' is longer than {SHORT_NAME_LIMIT}") - return ExitCode.DATA_ERR - if len(package_name) > SHORT_NAME_LIMIT: - print(f"ERROR: '{package_name}' is longer than {SHORT_NAME_LIMIT}") - return ExitCode.DATA_ERR - # check module name - if not re.fullmatch("[A-Za-z_]+", module_name): - if re.fullmatch("[A-Za-z0-9_]+", module_name): - print( - f"WARNING: '{module_name}' has numbers - allowing but note this is" - " not 'strictly' to pep 8 best practices", - ) - else: - print(f"ERROR: '{module_name}' is not all lowercase with underscores") - return ExitCode.DATA_ERR - # check package if exists - # check package name - if package_name.strip() != "" and not re.fullmatch("[A-Za-z]+", package_name): - if re.fullmatch("[A-Za-z0-9]+", package_name): - print( - f"WARNING: '{package_name}' has numbers - allowing but note" - " this is not 'strictly' to pep 8 best practices", - ) - else: - print( - f"ERROR: '{package_name}' is not all lowercase with no underscores", - ) - return ExitCode.DATA_ERR - return ExitCode.OK - - -if __name__ == "__main__": - raise SystemExit(main()) diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css new file mode 100644 index 0000000..c3defb4 --- /dev/null +++ b/docs/_static/css/custom.css @@ -0,0 +1,9 @@ +@import 'theme.css'; + +.toctree-l4 { + font-size: 1.2em !important +} + +.toctree-l4>a { + padding: 0em 1.618em 0em 5.663em !important +} diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..da968d7 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,32 @@ +# type:ignore # noqa: PGH003, INP001 +"""Configuration file for the Sphinx documentation builder. + +For the full list of built-in configuration values, see the documentation: +https://www.sphinx-doc.org/en/master/usage/configuration.html + +-- Project information ----------------------------------------------------- +https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information +""" + +import os +import sys + +from sphinx_pyproject import SphinxConfig + +sys.path.insert(0, os.path.abspath("../src")) # noqa: PTH100 +config = SphinxConfig("../pyproject.toml", globalns=globals()) + + +# def setup(app) -> None: +# """Set up the Sphinx application. + +# Args: +# ---- +# app: The Sphinx application object. + +# Returns: +# ------- +# None + +# """ +# app.add_css_file("source/custom.css") diff --git a/docs/getting-started.rst b/docs/getting-started.rst new file mode 100644 index 0000000..0cc088c --- /dev/null +++ b/docs/getting-started.rst @@ -0,0 +1,6 @@ +Getting started +=============== + +This is where you describe how to get set up on a clean install, including the +commands necessary to get the raw data (using the `sync_data_from_s3` command, +for example), and then how to make the cleaned, final data sets. diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 97569ec..0000000 --- a/docs/index.html +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..2451d8d --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,23 @@ +.. StringDataDeque documentation master file, created by + sphinx-quickstart on Sun Mar 24 15:35:24 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Verbex's documentation! +=========================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + getting-started + source/modules + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..32bb245 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/search.js b/docs/search.js deleted file mode 100644 index 87f83cf..0000000 --- a/docs/search.js +++ /dev/null @@ -1,46 +0,0 @@ -window.pdocSearch = (function(){ -/** elasticlunr - http://weixsong.github.io * Copyright (C) 2017 Oliver Nightingale * Copyright (C) 2017 Wei Song * MIT Licensed */!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u0&&t.push(e);for(var i in n)"docs"!==i&&"df"!==i&&this.expandToken(e+i,t,n[i]);return t},t.InvertedIndex.prototype.toJSON=function(){return{root:this.root}},t.Configuration=function(e,n){var e=e||"";if(void 0==n||null==n)throw new Error("fields should not be null");this.config={};var i;try{i=JSON.parse(e),this.buildUserConfig(i,n)}catch(o){t.utils.warn("user configuration parse failed, will use default configuration"),this.buildDefaultConfig(n)}},t.Configuration.prototype.buildDefaultConfig=function(e){this.reset(),e.forEach(function(e){this.config[e]={boost:1,bool:"OR",expand:!1}},this)},t.Configuration.prototype.buildUserConfig=function(e,n){var i="OR",o=!1;if(this.reset(),"bool"in e&&(i=e.bool||i),"expand"in e&&(o=e.expand||o),"fields"in e)for(var r in e.fields)if(n.indexOf(r)>-1){var s=e.fields[r],u=o;void 0!=s.expand&&(u=s.expand),this.config[r]={boost:s.boost||0===s.boost?s.boost:1,bool:s.bool||i,expand:u}}else t.utils.warn("field name in user configuration not found in index instance fields");else this.addAllFields2UserConfig(i,o,n)},t.Configuration.prototype.addAllFields2UserConfig=function(e,t,n){n.forEach(function(n){this.config[n]={boost:1,bool:e,expand:t}},this)},t.Configuration.prototype.get=function(){return this.config},t.Configuration.prototype.reset=function(){this.config={}},lunr.SortedSet=function(){this.length=0,this.elements=[]},lunr.SortedSet.load=function(e){var t=new this;return t.elements=e,t.length=e.length,t},lunr.SortedSet.prototype.add=function(){var e,t;for(e=0;e1;){if(r===e)return o;e>r&&(t=o),r>e&&(n=o),i=n-t,o=t+Math.floor(i/2),r=this.elements[o]}return r===e?o:-1},lunr.SortedSet.prototype.locationFor=function(e){for(var t=0,n=this.elements.length,i=n-t,o=t+Math.floor(i/2),r=this.elements[o];i>1;)e>r&&(t=o),r>e&&(n=o),i=n-t,o=t+Math.floor(i/2),r=this.elements[o];return r>e?o:e>r?o+1:void 0},lunr.SortedSet.prototype.intersect=function(e){for(var t=new lunr.SortedSet,n=0,i=0,o=this.length,r=e.length,s=this.elements,u=e.elements;;){if(n>o-1||i>r-1)break;s[n]!==u[i]?s[n]u[i]&&i++:(t.add(s[n]),n++,i++)}return t},lunr.SortedSet.prototype.clone=function(){var e=new lunr.SortedSet;return e.elements=this.toArray(),e.length=e.elements.length,e},lunr.SortedSet.prototype.union=function(e){var t,n,i;this.length>=e.length?(t=this,n=e):(t=e,n=this),i=t.clone();for(var o=0,r=n.toArray();o

\n"}, {"fullname": "verbex.verbex", "modulename": "verbex.verbex", "type": "module", "doc": "

Generate regular expressions from an easier fluent verbal form.

\n"}, {"fullname": "verbex.verbex.P", "modulename": "verbex.verbex", "qualname": "P", "type": "variable", "doc": "

\n", "default_value": " = ~P"}, {"fullname": "verbex.verbex.HasIter", "modulename": "verbex.verbex", "qualname": "HasIter", "type": "class", "doc": "

Workaround for mypy P.args.

\n", "bases": "typing.Protocol"}, {"fullname": "verbex.verbex.HasIter.__init__", "modulename": "verbex.verbex", "qualname": "HasIter.__init__", "type": "function", "doc": "

\n", "signature": "(self, *args, **kwargs)", "funcdef": "def"}, {"fullname": "verbex.verbex.HasItems", "modulename": "verbex.verbex", "qualname": "HasItems", "type": "class", "doc": "

Workaround for mypy P.kwargs.

\n", "bases": "typing.Protocol"}, {"fullname": "verbex.verbex.HasItems.__init__", "modulename": "verbex.verbex", "qualname": "HasItems.__init__", "type": "function", "doc": "

\n", "signature": "(self, *args, **kwargs)", "funcdef": "def"}, {"fullname": "verbex.verbex.HasItems.items", "modulename": "verbex.verbex", "qualname": "HasItems.items", "type": "function", "doc": "

Object has items method.

\n\n

Returns:\n The dict of items.

\n", "signature": "(self) -> tuple[str, typing.Any]", "funcdef": "def"}, {"fullname": "verbex.verbex.EscapedText", "modulename": "verbex.verbex", "qualname": "EscapedText", "type": "class", "doc": "

Text that has been escaped for regex.

\n\n

Arguments:\n str -- Extend the string class.

\n", "bases": "builtins.str"}, {"fullname": "verbex.verbex.EscapedText.__init__", "modulename": "verbex.verbex", "qualname": "EscapedText.__init__", "type": "function", "doc": "

Return a escaped regex string.

\n\n

Arguments:\n value -- the string to escape

\n\n

Returns:\n _description_

\n", "signature": "(cls, value: str)", "funcdef": "def"}, {"fullname": "verbex.verbex.re_escape", "modulename": "verbex.verbex", "qualname": "re_escape", "type": "function", "doc": "

Automatically escape any string parameters as EscapedText.

\n\n

Arguments:\n func -- The function to decorate.

\n\n

Returns:\n The decorated function.

\n", "signature": "(\n func: collections.abc.Callable[~P, ~R]\n) -> collections.abc.Callable[~P, ~R]", "funcdef": "def"}, {"fullname": "verbex.verbex.CharClass", "modulename": "verbex.verbex", "qualname": "CharClass", "type": "class", "doc": "

Enum of character classes in regex.

\n\n

Arguments:\n Enum -- Extends the Enum class.

\n", "bases": "enum.Enum"}, {"fullname": "verbex.verbex.CharClass.DIGIT", "modulename": "verbex.verbex", "qualname": "CharClass.DIGIT", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.UPPERCASE_LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.UPPERCASE_LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.LOWERCASE_LETTER", "modulename": "verbex.verbex", "qualname": "CharClass.LOWERCASE_LETTER", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.WHITESPACE", "modulename": "verbex.verbex", "qualname": "CharClass.WHITESPACE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClass.TAB", "modulename": "verbex.verbex", "qualname": "CharClass.TAB", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar", "modulename": "verbex.verbex", "qualname": "SpecialChar", "type": "class", "doc": "

Enum of special charaters, shorthand.

\n\n

Arguments:\n Enum -- Extends the Enum class.

\n", "bases": "enum.Enum"}, {"fullname": "verbex.verbex.SpecialChar.LINEBREAK", "modulename": "verbex.verbex", "qualname": "SpecialChar.LINEBREAK", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.START_OF_LINE", "modulename": "verbex.verbex", "qualname": "SpecialChar.START_OF_LINE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.END_OF_LINE", "modulename": "verbex.verbex", "qualname": "SpecialChar.END_OF_LINE", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.SpecialChar.TAB", "modulename": "verbex.verbex", "qualname": "SpecialChar.TAB", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.CharClassOrChars", "modulename": "verbex.verbex", "qualname": "CharClassOrChars", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[str, verbex.verbex.CharClass]"}, {"fullname": "verbex.verbex.EscapedCharClassOrSpecial", "modulename": "verbex.verbex", "qualname": "EscapedCharClassOrSpecial", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]"}, {"fullname": "verbex.verbex.VerbexEscapedCharClassOrSpecial", "modulename": "verbex.verbex", "qualname": "VerbexEscapedCharClassOrSpecial", "type": "variable", "doc": "

\n", "annotation": ": TypeAlias", "default_value": " = typing.Union[ForwardRef('Verbex'), str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]"}, {"fullname": "verbex.verbex.Verbex", "modulename": "verbex.verbex", "qualname": "Verbex", "type": "class", "doc": "

VerbalExpressions class.

\n\n

the following methods do not try to match the original js lib!

\n"}, {"fullname": "verbex.verbex.Verbex.__init__", "modulename": "verbex.verbex", "qualname": "Verbex.__init__", "type": "function", "doc": "

Create a Verbex object; setting any needed flags.

\n\n

Keyword Arguments:\n modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})

\n", "signature": "(self, modifiers: re.RegexFlag = )", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.EMPTY_REGEX_FLAG", "modulename": "verbex.verbex", "qualname": "Verbex.EMPTY_REGEX_FLAG", "type": "variable", "doc": "

\n", "default_value": " = "}, {"fullname": "verbex.verbex.Verbex.modifiers", "modulename": "verbex.verbex", "qualname": "Verbex.modifiers", "type": "variable", "doc": "

Return the modifiers for this Verbex object.

\n\n

Returns:\n The modifiers applied to this object.

\n", "annotation": ": re.RegexFlag"}, {"fullname": "verbex.verbex.Verbex.regex", "modulename": "verbex.verbex", "qualname": "Verbex.regex", "type": "function", "doc": "

Get a regular expression object.

\n", "signature": "(self) -> Pattern[str]", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.capture_group", "modulename": "verbex.verbex", "qualname": "Verbex.capture_group", "type": "function", "doc": "

Create a capture group.

\n\n

Name is optional if not specified then the first argument is the text.

\n\n

Keyword Arguments:\n name_or_text -- The name of the group / text to search for (default: {None})\n text -- The text to search for (default: {None})

\n\n

Raises:\n ValueError: If name is specified then text must be as well.

\n\n

Returns:\n Verbex with added capture group.

\n", "signature": "(\n self,\n name_or_text: Union[str, NoneType, verbex.verbex.Verbex, verbex.verbex.CharClass, verbex.verbex.SpecialChar] = None,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar, NoneType] = None\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.OR", "modulename": "verbex.verbex", "qualname": "Verbex.OR", "type": "function", "doc": "

or is a python keyword so we use OR instead.

\n\n

Arguments:\n text -- Text to find or a Verbex object.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.zero_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.zero_or_more", "type": "function", "doc": "

Find the text or Verbex object zero or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.one_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.one_or_more", "type": "function", "doc": "

Find the text or Verbex object one or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_times", "modulename": "verbex.verbex", "qualname": "Verbex.n_times", "type": "function", "doc": "

Find the text or Verbex object n or more times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_times_or_more", "modulename": "verbex.verbex", "qualname": "Verbex.n_times_or_more", "type": "function", "doc": "

Find the text or Verbex object at least n times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.n_to_m_times", "modulename": "verbex.verbex", "qualname": "Verbex.n_to_m_times", "type": "function", "doc": "

Find the text or Verbex object between n and m times.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar],\n n: int,\n m: int\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.maybe", "modulename": "verbex.verbex", "qualname": "Verbex.maybe", "type": "function", "doc": "

Possibly find the text / Verbex object.

\n\n

Arguments:\n text -- The text / Verbex object to possibly find.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.find", "modulename": "verbex.verbex", "qualname": "Verbex.find", "type": "function", "doc": "

Find the text or Verbex object.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.then", "modulename": "verbex.verbex", "qualname": "Verbex.then", "type": "function", "doc": "

Synonym for find.

\n\n

Arguments:\n text -- The text / Verbex object to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.followed_by", "modulename": "verbex.verbex", "qualname": "Verbex.followed_by", "type": "function", "doc": "

Match if string is followed by text.

\n\n

Positive lookahead

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_followed_by", "modulename": "verbex.verbex", "qualname": "Verbex.not_followed_by", "type": "function", "doc": "

Match if string is not followed by text.

\n\n

Negative lookahead

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.preceded_by", "modulename": "verbex.verbex", "qualname": "Verbex.preceded_by", "type": "function", "doc": "

Match if string is not preceded by text.

\n\n

Positive lookbehind

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_preceded_by", "modulename": "verbex.verbex", "qualname": "Verbex.not_preceded_by", "type": "function", "doc": "

Match if string is not preceded by text.

\n\n

Negative Lookbehind

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.any_of", "modulename": "verbex.verbex", "qualname": "Verbex.any_of", "type": "function", "doc": "

Find anything in this group of chars or char class.

\n\n

Arguments:\n text -- The characters to look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n chargroup: Union[str, verbex.verbex.CharClass]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.not_any_of", "modulename": "verbex.verbex", "qualname": "Verbex.not_any_of", "type": "function", "doc": "

Find anything but this group of chars or char class.

\n\n

Arguments:\n text -- The characters to not look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n text: Union[str, verbex.verbex.CharClass]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.anything_but", "modulename": "verbex.verbex", "qualname": "Verbex.anything_but", "type": "function", "doc": "

Find anything one or more times but this group of chars or char class.

\n\n

Arguments:\n text -- The characters to not look for.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n chargroup: Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.start_of_line", "modulename": "verbex.verbex", "qualname": "Verbex.start_of_line", "type": "function", "doc": "

Find the start of the line.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.end_of_line", "modulename": "verbex.verbex", "qualname": "Verbex.end_of_line", "type": "function", "doc": "

Find the end of the line.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.line_break", "modulename": "verbex.verbex", "qualname": "Verbex.line_break", "type": "function", "doc": "

Find a line break.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.tab", "modulename": "verbex.verbex", "qualname": "Verbex.tab", "type": "function", "doc": "

Find a tab.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.anything", "modulename": "verbex.verbex", "qualname": "Verbex.anything", "type": "function", "doc": "

Find anything one or more time.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.as_few", "modulename": "verbex.verbex", "qualname": "Verbex.as_few", "type": "function", "doc": "

Modify previous search to not be greedy.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.number_range", "modulename": "verbex.verbex", "qualname": "Verbex.number_range", "type": "function", "doc": "

Generate a range of numbers.

\n\n

Arguments:\n start -- Start of the range\n end -- End of the range

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self, start: int, end: int) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.letter_range", "modulename": "verbex.verbex", "qualname": "Verbex.letter_range", "type": "function", "doc": "

Generate a range of letters.

\n\n

Arguments:\n start -- Start of the range\n end -- End of the range

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(\n self,\n start: typing.Annotated[str, Is[_string_len_is_1]],\n end: typing.Annotated[str, Is[_string_len_is_1]]\n) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.word", "modulename": "verbex.verbex", "qualname": "Verbex.word", "type": "function", "doc": "

Find a word on word boundary.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.with_any_case", "modulename": "verbex.verbex", "qualname": "Verbex.with_any_case", "type": "function", "doc": "

Modify Verbex object to be case insensitive.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.search_by_line", "modulename": "verbex.verbex", "qualname": "Verbex.search_by_line", "type": "function", "doc": "

Search each line, ^ and $ match begining and end of line respectively.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}, {"fullname": "verbex.verbex.Verbex.with_ascii", "modulename": "verbex.verbex", "qualname": "Verbex.with_ascii", "type": "function", "doc": "

Match ascii instead of unicode.

\n\n

Returns:\n Modified Verbex object.

\n", "signature": "(self) -> verbex.verbex.Verbex", "funcdef": "def"}]; - - // mirrored in build-search-index.js (part 1) - // Also split on html tags. this is a cheap heuristic, but good enough. - elasticlunr.tokenizer.setSeperator(/[\s\-.;&_'"=,()]+|<[^>]*>/); - - let searchIndex; - if (docs._isPrebuiltIndex) { - console.info("using precompiled search index"); - searchIndex = elasticlunr.Index.load(docs); - } else { - console.time("building search index"); - // mirrored in build-search-index.js (part 2) - searchIndex = elasticlunr(function () { - this.pipeline.remove(elasticlunr.stemmer); - this.pipeline.remove(elasticlunr.stopWordFilter); - this.addField("qualname"); - this.addField("fullname"); - this.addField("annotation"); - this.addField("default_value"); - this.addField("signature"); - this.addField("bases"); - this.addField("doc"); - this.setRef("fullname"); - }); - for (let doc of docs) { - searchIndex.addDoc(doc); - } - console.timeEnd("building search index"); - } - - return (term) => searchIndex.search(term, { - fields: { - qualname: {boost: 4}, - fullname: {boost: 2}, - annotation: {boost: 2}, - default_value: {boost: 2}, - signature: {boost: 2}, - bases: {boost: 2}, - doc: {boost: 1}, - }, - expand: true - }); -})(); \ No newline at end of file diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..4415b88 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +Verbex +=============== + +.. toctree:: + :maxdepth: 4 + + verbex diff --git a/docs/source/verbex.rst b/docs/source/verbex.rst new file mode 100644 index 0000000..bb97781 --- /dev/null +++ b/docs/source/verbex.rst @@ -0,0 +1,13 @@ +verbex package +======================= + +Submodules +---------- + +verbex module +------------------------------------------- + +.. automodule:: verbex + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/verbex.html b/docs/verbex.html deleted file mode 100644 index c89b400..0000000 --- a/docs/verbex.html +++ /dev/null @@ -1,241 +0,0 @@ - - - - - - - verbex API documentation - - - - - - - - - -
-
-

-verbex

- - -
- View Source - 
0try:
-1    from importlib.metadata import version
-2except ImportError:
-3    from importlib_metadata import version  # type: ignore
-4
-5from .verbex import CharClass as CharClass
-6from .verbex import SpecialChar as SpecialChar
-7from .verbex import Verbex as Verbex
-8
-9__version__ = version("verbex")
-
- -
- -
-
- - \ No newline at end of file diff --git a/docs/verbex/verbex.html b/docs/verbex/verbex.html deleted file mode 100644 index 17bbb44..0000000 --- a/docs/verbex/verbex.html +++ /dev/null @@ -1,3346 +0,0 @@ - - - - - - - verbex.verbex API documentation - - - - - - - - - -
-
-

-verbex.verbex

- -

Generate regular expressions from an easier fluent verbal form.

-
- -
- View Source - 
  0"""Generate regular expressions from an easier fluent verbal form."""
-  1from __future__ import annotations
-  2
-  3import re
-  4from enum import Enum
-  5from functools import wraps
-  6
-  7try:
-  8    from typing import (  # <--------------- if Python ≥ 3.9.0
-  9        Annotated,
- 10        ParamSpec,
- 11        Protocol,
- 12        TypeAlias,
- 13        runtime_checkable,
- 14    )
- 15except ImportError:
- 16    from typing_extensions import TypeAlias, Protocol, Annotated, ParamSpec, runtime_checkable  # type: ignore # <--- if Python < 3.9.0 # noqa E501
- 17
- 18from typing import TYPE_CHECKING, Pattern, TypeVar
- 19
- 20if TYPE_CHECKING:
- 21    from typing import Protocol  # noqa: F811
- 22
- 23from beartype import beartype  # type: ignore
- 24from beartype.typing import (  # type: ignore
- 25    Any,
- 26    Callable,
- 27    Dict,
- 28    Iterator,
- 29    List,
- 30    Optional,
- 31    Tuple,
- 32    Union,
- 33    cast,
- 34)
- 35from beartype.vale import Is  # type: ignore
- 36
- 37
- 38def _string_len_is_1(text: object) -> bool:
- 39    return isinstance(text, str) and len(text) == 1
- 40
- 41
- 42Char = Annotated[str, Is[_string_len_is_1]]
- 43
- 44
- 45P = ParamSpec("P")  # noqa: VNE001
- 46R = TypeVar("R")  # noqa: VNE001
- 47
- 48
- 49# work around for bug https://github.com/python/mypy/issues/12660
- 50# fixed in next version of mypy.
- 51@runtime_checkable
- 52class HasIter(Protocol):
- 53    """Workaround for mypy P.args."""
- 54
- 55    def __iter__(self) -> Iterator[Any]:
- 56        """Object can be iterated.
- 57
- 58        Yields:
- 59            Next object.
- 60        """
- 61        ...
- 62
- 63
- 64# work around for bug https://github.com/python/mypy/issues/12660
- 65# fixed in next version of mypy
- 66@runtime_checkable
- 67class HasItems(Protocol):
- 68    """Workaround for mypy P.kwargs."""
- 69
- 70    def items(self) -> Tuple[str, Any]:
- 71        """Object has items method.
- 72
- 73        Returns:
- 74            The dict of items.
- 75        """
- 76        ...
- 77
- 78
- 79class EscapedText(str):
- 80    """Text that has been escaped for regex.
- 81
- 82    Arguments:
- 83        str -- Extend the string class.
- 84    """
- 85
- 86    def __new__(cls, value: str) -> EscapedText:
- 87        """Return a escaped regex string.
- 88
- 89        Arguments:
- 90            value -- the string to escape
- 91
- 92        Returns:
- 93            _description_
- 94        """
- 95        return str.__new__(cls, re.escape(value))
- 96
- 97
- 98def re_escape(func: Callable[P, R]) -> Callable[P, R]:
- 99    """Automatically escape any string parameters as EscapedText.
-100
-101    Arguments:
-102        func -- The function to decorate.
-103
-104    Returns:
-105        The decorated function.
-106    """
-107
-108    @wraps(func)
-109    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
-110        escaped_args: List[Any] = []
-111        escaped_kwargs: Dict[str, Any] = {}
-112        for arg in cast(HasIter, args):
-113            if not isinstance(arg, EscapedText) and isinstance(arg, str):
-114                escaped_args.append(EscapedText(arg))
-115            else:
-116                escaped_args.append(arg)
-117        arg_k: str
-118        arg_v: Any
-119        for arg_k, arg_v in cast(HasItems, kwargs).items():
-120            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
-121                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
-122            else:
-123                escaped_kwargs[arg_k] = arg_v
-124        return func(*escaped_args, **escaped_kwargs)  # type: ignore
-125
-126    return inner
-127
-128
-129class CharClass(Enum):
-130    """Enum of character classes in regex.
-131
-132    Arguments:
-133        Enum -- Extends the Enum class.
-134    """
-135
-136    DIGIT = "\\d"
-137    LETTER = "\\w"
-138    UPPERCASE_LETTER = "\\u"
-139    LOWERCASE_LETTER = "\\l"
-140    WHITESPACE = "\\s"
-141    TAB = "\\t"
-142
-143    def __str__(self) -> str:
-144        """To string method based on Enum value.
-145
-146        Returns:
-147            value of Enum
-148        """
-149        return self.value
-150
-151
-152class SpecialChar(Enum):
-153    """Enum of special charaters, shorthand.
-154
-155    Arguments:
-156        Enum -- Extends the Enum class.
-157    """
-158
-159    # does not work  / should not be used in [ ]
-160    LINEBREAK = "(\\n|(\\r\\n))"
-161    START_OF_LINE = "^"
-162    END_OF_LINE = "$"
-163    TAB = "\t"
-164
-165    def __str__(self) -> str:
-166        """To string for special chars enum.
-167
-168        Returns:
-169            Return value of enum as string.
-170        """
-171        return self.value
-172
-173
-174CharClassOrChars: TypeAlias = Union[str, CharClass]
-175EscapedCharClassOrSpecial: TypeAlias = Union[str, CharClass, SpecialChar]
-176VerbexEscapedCharClassOrSpecial: TypeAlias = Union["Verbex", EscapedCharClassOrSpecial]
-177
-178
-179def _poseur_decorator(*poseur: Any) -> Any:
-180    """Positional-only arguments runtime checker."""
-181    import functools
-182
-183    def caller(func: Callable[P, R]) -> Callable[P, R]:  # type: ignore
-184        @functools.wraps(func)
-185        def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
-186            poseur_args = set(poseur).intersection(kwargs)  # type: ignore
-187            if poseur_args:
-188                raise TypeError(
-189                    "%s() got some positional-only arguments passed as keyword"
-190                    " arguments: %r" % (func.__name__, ", ".join(poseur_args)),
-191                )
-192            return func(*args, **kwargs)  # type: ignore
-193
-194        return wrapper
-195
-196    return caller
-197
-198
-199class Verbex:
-200    """
-201    VerbalExpressions class.
-202
-203    the following methods do not try to match the original js lib!
-204    """
-205
-206    EMPTY_REGEX_FLAG = re.RegexFlag(0)
-207
-208    @re_escape
-209    @beartype
-210    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
-211        """Create a Verbex object; setting any needed flags.
-212
-213        Keyword Arguments:
-214            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
-215        """
-216        # self._parts: List[str] = [text]
-217        self._parts: List[str] = []
-218        self._modifiers = modifiers
-219
-220    @property
-221    def modifiers(self) -> re.RegexFlag:
-222        """Return the modifiers for this Verbex object.
-223
-224        Returns:
-225            The modifiers applied to this object.
-226        """
-227        return self._modifiers
-228
-229    def __str__(self) -> str:
-230        """Return regex string representation."""
-231        return "".join(self._parts)
-232
-233    @beartype
-234    def _add(self, value: Union[str, List[str]]) -> Verbex:
-235        """
-236        Append a transformed value to internal expression to be compiled.
-237
-238        As possible, this method should be "private".
-239        """
-240        if isinstance(value, list):
-241            self._parts.extend(value)
-242        else:
-243            self._parts.append(value)
-244        return self
-245
-246    def regex(self) -> Pattern[str]:
-247        """Get a regular expression object."""
-248        return re.compile(
-249            str(self),
-250            self._modifiers,
-251        )
-252
-253    # allow VerbexEscapedCharClassOrSpecial
-254
-255    @re_escape
-256    @beartype
-257    def _capture_group_with_name(
-258        self,
-259        name: str,
-260        text: VerbexEscapedCharClassOrSpecial,
-261    ) -> Verbex:
-262        return self._add(f"(?<{name}>{str(text)})")
-263
-264    @re_escape
-265    @beartype
-266    def _capture_group_without_name(
-267        self,
-268        text: VerbexEscapedCharClassOrSpecial,
-269    ) -> Verbex:
-270        return self._add(f"({str(text)})")
-271
-272    @re_escape
-273    @beartype
-274    @_poseur_decorator("self")
-275    def capture_group(
-276        self,
-277        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
-278        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
-279    ) -> Verbex:
-280        """Create a capture group.
-281
-282        Name is optional if not specified then the first argument is the text.
-283
-284        Keyword Arguments:
-285            name_or_text -- The name of the group / text to search for (default: {None})
-286            text -- The text to search for (default: {None})
-287
-288        Raises:
-289            ValueError: If name is specified then text must be as well.
-290
-291        Returns:
-292            Verbex with added capture group.
-293        """
-294        if name_or_text is not None:
-295            if text is None:
-296                _text = name_or_text
-297                return self._capture_group_without_name(_text)
-298            if isinstance(name_or_text, str):
-299                return self._capture_group_with_name(name_or_text, text)
-300        raise ValueError("text must be specified with optional name")
-301
-302    @re_escape
-303    @beartype
-304    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa: N802
-305        """`or` is a python keyword so we use `OR` instead.
-306
-307        Arguments:
-308            text -- Text to find or a Verbex object.
-309
-310        Returns:
-311            Modified Verbex object.
-312        """
-313        return self._add("|").find(text)
-314
-315    @re_escape
-316    @beartype
-317    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-318        """Find the text or Verbex object zero or more times.
-319
-320        Arguments:
-321            text -- The text / Verbex object to look for.
-322
-323        Returns:
-324            Modified Verbex object.
-325        """
-326        return self._add(f"(?:{str(text)})*")
-327
-328    @re_escape
-329    @beartype
-330    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-331        """Find the text or Verbex object one or more times.
-332
-333        Arguments:
-334            text -- The text / Verbex object to look for.
-335
-336        Returns:
-337            Modified Verbex object.
-338        """
-339        return self._add(f"(?:{str(text)})+")
-340
-341    @re_escape
-342    @beartype
-343    def n_times(
-344        self,
-345        text: VerbexEscapedCharClassOrSpecial,
-346        n: int,  # noqa: VNE001
-347    ) -> Verbex:
-348        """Find the text or Verbex object n or more times.
-349
-350        Arguments:
-351            text -- The text / Verbex object to look for.
-352
-353        Returns:
-354            Modified Verbex object.
-355        """
-356        return self._add(f"(?:{str(text)}){{{n}}}")
-357
-358    @re_escape
-359    @beartype
-360    def n_times_or_more(
-361        self,
-362        text: VerbexEscapedCharClassOrSpecial,
-363        n: int,  # noqa: VNE001
-364    ) -> Verbex:
-365        """Find the text or Verbex object at least n times.
-366
-367        Arguments:
-368            text -- The text / Verbex object to look for.
-369
-370        Returns:
-371            Modified Verbex object.
-372        """
-373        return self._add(f"(?:{str(text)}){{{n},}}")
-374
-375    @re_escape
-376    @beartype
-377    def n_to_m_times(
-378        self,
-379        text: VerbexEscapedCharClassOrSpecial,
-380        n: int,  # noqa: VNE001
-381        m: int,  # noqa: VNE001
-382    ) -> Verbex:
-383        """Find the text or Verbex object between n and m times.
-384
-385        Arguments:
-386            text -- The text / Verbex object to look for.
-387
-388        Returns:
-389            Modified Verbex object.
-390        """
-391        return self._add(f"(?:{str(text)}){{{n},{m}}}")
-392
-393    @re_escape
-394    @beartype
-395    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-396        """Possibly find the text / Verbex object.
-397
-398        Arguments:
-399            text -- The text / Verbex object to possibly find.
-400
-401        Returns:
-402            Modified Verbex object.
-403        """
-404        return self._add(f"(?:{str(text)})?")
-405
-406    @re_escape
-407    @beartype
-408    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-409        """Find the text or Verbex object.
-410
-411        Arguments:
-412            text -- The text / Verbex object to look for.
-413
-414        Returns:
-415            Modified Verbex object.
-416        """
-417        return self._add(str(text))
-418
-419    @re_escape
-420    @beartype
-421    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-422        """Synonym for find.
-423
-424        Arguments:
-425            text -- The text / Verbex object to look for.
-426
-427        Returns:
-428            Modified Verbex object.
-429        """
-430        return self.find(text)
-431
-432    @re_escape
-433    @beartype
-434    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-435        """Match if string is followed by text.
-436
-437        Positive lookahead
-438
-439        Returns:
-440            Modified Verbex object.
-441        """
-442        return self._add(f"(?={text})")
-443
-444    @re_escape
-445    @beartype
-446    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-447        """Match if string is not followed by text.
-448
-449        Negative lookahead
-450
-451        Returns:
-452            Modified Verbex object.
-453        """
-454        return self._add(f"(?!{text})")
-455
-456    @re_escape
-457    @beartype
-458    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-459        """Match if string is not preceded by text.
-460
-461        Positive lookbehind
-462
-463        Returns:
-464            Modified Verbex object.
-465        """
-466        return self._add(f"(?<={text})")
-467
-468    @re_escape
-469    @beartype
-470    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-471        """Match if string is not preceded by text.
-472
-473        Negative Lookbehind
-474
-475        Returns:
-476            Modified Verbex object.
-477        """
-478        return self._add(f"(?<!{text})")
-479
-480    # only allow CharclassOrChars
-481
-482    @re_escape
-483    @beartype
-484    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
-485        """Find anything in this group of chars or char class.
-486
-487        Arguments:
-488            text -- The characters to look for.
-489
-490        Returns:
-491            Modified Verbex object.
-492        """
-493        return self._add(f"(?:[{chargroup}])")
-494
-495    @re_escape
-496    @beartype
-497    def not_any_of(self, text: CharClassOrChars) -> Verbex:
-498        """Find anything but this group of chars or char class.
-499
-500        Arguments:
-501            text -- The characters to not look for.
-502
-503        Returns:
-504            Modified Verbex object.
-505        """
-506        return self._add(f"(?:[^{text}])")
-507
-508    @re_escape
-509    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
-510        """Find anything one or more times but this group of chars or char class.
-511
-512        Arguments:
-513            text -- The characters to not look for.
-514
-515        Returns:
-516            Modified Verbex object.
-517        """
-518        return self._add(f"[^{chargroup}]+")
-519
-520    # no text input
-521
-522    def start_of_line(self) -> Verbex:
-523        """Find the start of the line.
-524
-525        Returns:
-526            Modified Verbex object.
-527        """
-528        return self.find(SpecialChar.START_OF_LINE)
-529
-530    def end_of_line(self) -> Verbex:
-531        """Find the end of the line.
-532
-533        Returns:
-534            Modified Verbex object.
-535        """
-536        return self.find(SpecialChar.END_OF_LINE)
-537
-538    def line_break(self) -> Verbex:
-539        """Find a line break.
-540
-541        Returns:
-542            Modified Verbex object.
-543        """
-544        return self.find(SpecialChar.LINEBREAK)
-545
-546    def tab(self) -> Verbex:
-547        """Find a tab.
-548
-549        Returns:
-550            Modified Verbex object.
-551        """
-552        return self.find(SpecialChar.TAB)
-553
-554    def anything(self) -> Verbex:
-555        """Find anything one or more time.
-556
-557        Returns:
-558            Modified Verbex object.
-559        """
-560        return self._add(".+")
-561
-562    def as_few(self) -> Verbex:
-563        """Modify previous search to not be greedy.
-564
-565        Returns:
-566            Modified Verbex object.
-567        """
-568        return self._add("?")
-569
-570    @beartype
-571    def number_range(self, start: int, end: int) -> Verbex:
-572        """Generate a range of numbers.
-573
-574        Arguments:
-575            start -- Start of the range
-576            end -- End of the range
-577
-578        Returns:
-579            Modified Verbex object.
-580        """
-581        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
-582
-583    @beartype
-584    def letter_range(self, start: Char, end: Char) -> Verbex:
-585        """Generate a range of letters.
-586
-587        Arguments:
-588            start -- Start of the range
-589            end -- End of the range
-590
-591        Returns:
-592            Modified Verbex object.
-593        """
-594        return self._add(f"[{start}-{end}]")
-595
-596    def word(self) -> Verbex:
-597        """Find a word on word boundary.
-598
-599        Returns:
-600            Modified Verbex object.
-601        """
-602        return self._add("(\\b\\w+\\b)")
-603
-604    # # --------------- modifiers ------------------------
-605
-606    def with_any_case(self) -> Verbex:
-607        """Modify Verbex object to be case insensitive.
-608
-609        Returns:
-610            Modified Verbex object.
-611        """
-612        self._modifiers |= re.IGNORECASE
-613        return self
-614
-615    def search_by_line(self) -> Verbex:
-616        """Search each line, ^ and $ match begining and end of line respectively.
-617
-618        Returns:
-619            Modified Verbex object.
-620        """
-621        self._modifiers |= re.MULTILINE
-622        return self
-623
-624    def with_ascii(self) -> Verbex:
-625        """Match ascii instead of unicode.
-626
-627        Returns:
-628            Modified Verbex object.
-629        """
-630        self._modifiers |= re.ASCII
-631        return self
-632
-633
-634# left over notes from original version
-635# def __getattr__(self, attr):
-636#     """ any other function will be sent to the regex object """
-637#     regex = self.regex()
-638#     return getattr(regex, attr)
-639
-640# def replace(self, string, repl):
-641#     return self.sub(repl, string)
-642
-643
-644if __name__ == "__main__":
-645    pass
-
- -
- -
-
-
#   - - P = ~P -
- - - - -
-
-
- #   - -
@runtime_checkable
- - class - HasIter(typing.Protocol): -
- -
- View Source - 
52@runtime_checkable
-53class HasIter(Protocol):
-54    """Workaround for mypy P.args."""
-55
-56    def __iter__(self) -> Iterator[Any]:
-57        """Object can be iterated.
-58
-59        Yields:
-60            Next object.
-61        """
-62        ...
-
- -
- -

Workaround for mypy P.args.

-
- - -
-
#   - - - HasIter(*args, **kwargs) -
- -
- View Source - 
1429def _no_init_or_replace_init(self, *args, **kwargs):
-1430    cls = type(self)
-1431
-1432    if cls._is_protocol:
-1433        raise TypeError('Protocols cannot be instantiated')
-1434
-1435    # Already using a custom `__init__`. No need to calculate correct
-1436    # `__init__` to call. This can lead to RecursionError. See bpo-45121.
-1437    if cls.__init__ is not _no_init_or_replace_init:
-1438        return
-1439
-1440    # Initially, `__init__` of a protocol subclass is set to `_no_init_or_replace_init`.
-1441    # The first instantiation of the subclass will call `_no_init_or_replace_init` which
-1442    # searches for a proper new `__init__` in the MRO. The new `__init__`
-1443    # replaces the subclass' old `__init__` (ie `_no_init_or_replace_init`). Subsequent
-1444    # instantiation of the protocol subclass will thus use the new
-1445    # `__init__` and no longer call `_no_init_or_replace_init`.
-1446    for base in cls.__mro__:
-1447        init = base.__dict__.get('__init__', _no_init_or_replace_init)
-1448        if init is not _no_init_or_replace_init:
-1449            cls.__init__ = init
-1450            break
-1451    else:
-1452        # should not happen
-1453        cls.__init__ = object.__init__
-1454
-1455    cls.__init__(self, *args, **kwargs)
-
- -
- - - -
-
-
-
- #   - -
@runtime_checkable
- - class - HasItems(typing.Protocol): -
- -
- View Source - 
67@runtime_checkable
-68class HasItems(Protocol):
-69    """Workaround for mypy P.kwargs."""
-70
-71    def items(self) -> Tuple[str, Any]:
-72        """Object has items method.
-73
-74        Returns:
-75            The dict of items.
-76        """
-77        ...
-
- -
- -

Workaround for mypy P.kwargs.

-
- - -
-
#   - - - HasItems(*args, **kwargs) -
- -
- View Source - 
1429def _no_init_or_replace_init(self, *args, **kwargs):
-1430    cls = type(self)
-1431
-1432    if cls._is_protocol:
-1433        raise TypeError('Protocols cannot be instantiated')
-1434
-1435    # Already using a custom `__init__`. No need to calculate correct
-1436    # `__init__` to call. This can lead to RecursionError. See bpo-45121.
-1437    if cls.__init__ is not _no_init_or_replace_init:
-1438        return
-1439
-1440    # Initially, `__init__` of a protocol subclass is set to `_no_init_or_replace_init`.
-1441    # The first instantiation of the subclass will call `_no_init_or_replace_init` which
-1442    # searches for a proper new `__init__` in the MRO. The new `__init__`
-1443    # replaces the subclass' old `__init__` (ie `_no_init_or_replace_init`). Subsequent
-1444    # instantiation of the protocol subclass will thus use the new
-1445    # `__init__` and no longer call `_no_init_or_replace_init`.
-1446    for base in cls.__mro__:
-1447        init = base.__dict__.get('__init__', _no_init_or_replace_init)
-1448        if init is not _no_init_or_replace_init:
-1449            cls.__init__ = init
-1450            break
-1451    else:
-1452        # should not happen
-1453        cls.__init__ = object.__init__
-1454
-1455    cls.__init__(self, *args, **kwargs)
-
- -
- - - -
-
-
#   - - - def - items(self) -> tuple[str, typing.Any]: -
- -
- View Source - 
71    def items(self) -> Tuple[str, Any]:
-72        """Object has items method.
-73
-74        Returns:
-75            The dict of items.
-76        """
-77        ...
-
- -
- -

Object has items method.

- -

Returns: - The dict of items.

-
- - -
-
-
-
- #   - - - class - EscapedText(builtins.str): -
- -
- View Source - 
80class EscapedText(str):
-81    """Text that has been escaped for regex.
-82
-83    Arguments:
-84        str -- Extend the string class.
-85    """
-86
-87    def __new__(cls, value: str) -> EscapedText:
-88        """Return a escaped regex string.
-89
-90        Arguments:
-91            value -- the string to escape
-92
-93        Returns:
-94            _description_
-95        """
-96        return str.__new__(cls, re.escape(value))
-
- -
- -

Text that has been escaped for regex.

- -

Arguments: - str -- Extend the string class.

-
- - -
-
#   - - - EscapedText(value: str) -
- -
- View Source - 
87    def __new__(cls, value: str) -> EscapedText:
-88        """Return a escaped regex string.
-89
-90        Arguments:
-91            value -- the string to escape
-92
-93        Returns:
-94            _description_
-95        """
-96        return str.__new__(cls, re.escape(value))
-
- -
- -

Return a escaped regex string.

- -

Arguments: - value -- the string to escape

- -

Returns: - _description_

-
- - -
-
-
Inherited Members
-
-
builtins.str
-
encode
-
replace
-
split
-
rsplit
-
join
-
capitalize
-
casefold
-
title
-
center
-
count
-
expandtabs
-
find
-
partition
-
index
-
ljust
-
lower
-
lstrip
-
rfind
-
rindex
-
rjust
-
rstrip
-
rpartition
-
splitlines
-
strip
-
swapcase
-
translate
-
upper
-
startswith
-
endswith
-
removeprefix
-
removesuffix
-
isascii
-
islower
-
isupper
-
istitle
-
isspace
-
isdecimal
-
isdigit
-
isnumeric
-
isalpha
-
isalnum
-
isidentifier
-
isprintable
-
zfill
-
format
-
format_map
-
maketrans
- -
-
-
-
-
-
#   - - - def - re_escape( - func: collections.abc.Callable[~P, ~R] -) -> collections.abc.Callable[~P, ~R]: -
- -
- View Source - 
 99def re_escape(func: Callable[P, R]) -> Callable[P, R]:
-100    """Automatically escape any string parameters as EscapedText.
-101
-102    Arguments:
-103        func -- The function to decorate.
-104
-105    Returns:
-106        The decorated function.
-107    """
-108
-109    @wraps(func)
-110    def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore
-111        escaped_args: List[Any] = []
-112        escaped_kwargs: Dict[str, Any] = {}
-113        for arg in cast(HasIter, args):
-114            if not isinstance(arg, EscapedText) and isinstance(arg, str):
-115                escaped_args.append(EscapedText(arg))
-116            else:
-117                escaped_args.append(arg)
-118        arg_k: str
-119        arg_v: Any
-120        for arg_k, arg_v in cast(HasItems, kwargs).items():
-121            if not isinstance(arg_v, EscapedText) and isinstance(arg_v, str):
-122                escaped_kwargs[arg_k] = EscapedText(str(arg_v))
-123            else:
-124                escaped_kwargs[arg_k] = arg_v
-125        return func(*escaped_args, **escaped_kwargs)  # type: ignore
-126
-127    return inner
-
- -
- -

Automatically escape any string parameters as EscapedText.

- -

Arguments: - func -- The function to decorate.

- -

Returns: - The decorated function.

-
- - -
-
-
- #   - - - class - CharClass(enum.Enum): -
- -
- View Source - 
130class CharClass(Enum):
-131    """Enum of character classes in regex.
-132
-133    Arguments:
-134        Enum -- Extends the Enum class.
-135    """
-136
-137    DIGIT = "\\d"
-138    LETTER = "\\w"
-139    UPPERCASE_LETTER = "\\u"
-140    LOWERCASE_LETTER = "\\l"
-141    WHITESPACE = "\\s"
-142    TAB = "\\t"
-143
-144    def __str__(self) -> str:
-145        """To string method based on Enum value.
-146
-147        Returns:
-148            value of Enum
-149        """
-150        return self.value
-
- -
- -

Enum of character classes in regex.

- -

Arguments: - Enum -- Extends the Enum class.

-
- - -
-
#   - - DIGIT = <CharClass.DIGIT: '\\d'> -
- - - - -
-
-
#   - - LETTER = <CharClass.LETTER: '\\w'> -
- - - - -
-
-
#   - - UPPERCASE_LETTER = <CharClass.UPPERCASE_LETTER: '\\u'> -
- - - - -
-
-
#   - - LOWERCASE_LETTER = <CharClass.LOWERCASE_LETTER: '\\l'> -
- - - - -
-
-
#   - - WHITESPACE = <CharClass.WHITESPACE: '\\s'> -
- - - - -
-
-
#   - - TAB = <CharClass.TAB: '\\t'> -
- - - - -
-
-
Inherited Members
-
-
enum.Enum
-
name
-
value
- -
-
-
-
-
-
- #   - - - class - SpecialChar(enum.Enum): -
- -
- View Source - 
153class SpecialChar(Enum):
-154    """Enum of special charaters, shorthand.
-155
-156    Arguments:
-157        Enum -- Extends the Enum class.
-158    """
-159
-160    # does not work  / should not be used in [ ]
-161    LINEBREAK = "(\\n|(\\r\\n))"
-162    START_OF_LINE = "^"
-163    END_OF_LINE = "$"
-164    TAB = "\t"
-165
-166    def __str__(self) -> str:
-167        """To string for special chars enum.
-168
-169        Returns:
-170            Return value of enum as string.
-171        """
-172        return self.value
-
- -
- -

Enum of special charaters, shorthand.

- -

Arguments: - Enum -- Extends the Enum class.

-
- - -
-
#   - - LINEBREAK = <SpecialChar.LINEBREAK: '(\\n|(\\r\\n))'> -
- - - - -
-
-
#   - - START_OF_LINE = <SpecialChar.START_OF_LINE: '^'> -
- - - - -
-
-
#   - - END_OF_LINE = <SpecialChar.END_OF_LINE: '$'> -
- - - - -
-
-
#   - - TAB = <SpecialChar.TAB: '\t'> -
- - - - -
-
-
Inherited Members
-
-
enum.Enum
-
name
-
value
- -
-
-
-
-
-
#   - - CharClassOrChars: TypeAlias = typing.Union[str, verbex.verbex.CharClass] -
- - - - -
-
-
#   - - EscapedCharClassOrSpecial: TypeAlias = typing.Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -
- - - - -
-
-
#   - - VerbexEscapedCharClassOrSpecial: TypeAlias = typing.Union[ForwardRef('Verbex'), str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -
- - - - -
-
-
- #   - - - class - Verbex: -
- -
- View Source - 
200class Verbex:
-201    """
-202    VerbalExpressions class.
-203
-204    the following methods do not try to match the original js lib!
-205    """
-206
-207    EMPTY_REGEX_FLAG = re.RegexFlag(0)
-208
-209    @re_escape
-210    @beartype
-211    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
-212        """Create a Verbex object; setting any needed flags.
-213
-214        Keyword Arguments:
-215            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
-216        """
-217        # self._parts: List[str] = [text]
-218        self._parts: List[str] = []
-219        self._modifiers = modifiers
-220
-221    @property
-222    def modifiers(self) -> re.RegexFlag:
-223        """Return the modifiers for this Verbex object.
-224
-225        Returns:
-226            The modifiers applied to this object.
-227        """
-228        return self._modifiers
-229
-230    def __str__(self) -> str:
-231        """Return regex string representation."""
-232        return "".join(self._parts)
-233
-234    @beartype
-235    def _add(self, value: Union[str, List[str]]) -> Verbex:
-236        """
-237        Append a transformed value to internal expression to be compiled.
-238
-239        As possible, this method should be "private".
-240        """
-241        if isinstance(value, list):
-242            self._parts.extend(value)
-243        else:
-244            self._parts.append(value)
-245        return self
-246
-247    def regex(self) -> Pattern[str]:
-248        """Get a regular expression object."""
-249        return re.compile(
-250            str(self),
-251            self._modifiers,
-252        )
-253
-254    # allow VerbexEscapedCharClassOrSpecial
-255
-256    @re_escape
-257    @beartype
-258    def _capture_group_with_name(
-259        self,
-260        name: str,
-261        text: VerbexEscapedCharClassOrSpecial,
-262    ) -> Verbex:
-263        return self._add(f"(?<{name}>{str(text)})")
-264
-265    @re_escape
-266    @beartype
-267    def _capture_group_without_name(
-268        self,
-269        text: VerbexEscapedCharClassOrSpecial,
-270    ) -> Verbex:
-271        return self._add(f"({str(text)})")
-272
-273    @re_escape
-274    @beartype
-275    @_poseur_decorator("self")
-276    def capture_group(
-277        self,
-278        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
-279        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
-280    ) -> Verbex:
-281        """Create a capture group.
-282
-283        Name is optional if not specified then the first argument is the text.
-284
-285        Keyword Arguments:
-286            name_or_text -- The name of the group / text to search for (default: {None})
-287            text -- The text to search for (default: {None})
-288
-289        Raises:
-290            ValueError: If name is specified then text must be as well.
-291
-292        Returns:
-293            Verbex with added capture group.
-294        """
-295        if name_or_text is not None:
-296            if text is None:
-297                _text = name_or_text
-298                return self._capture_group_without_name(_text)
-299            if isinstance(name_or_text, str):
-300                return self._capture_group_with_name(name_or_text, text)
-301        raise ValueError("text must be specified with optional name")
-302
-303    @re_escape
-304    @beartype
-305    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa: N802
-306        """`or` is a python keyword so we use `OR` instead.
-307
-308        Arguments:
-309            text -- Text to find or a Verbex object.
-310
-311        Returns:
-312            Modified Verbex object.
-313        """
-314        return self._add("|").find(text)
-315
-316    @re_escape
-317    @beartype
-318    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-319        """Find the text or Verbex object zero or more times.
-320
-321        Arguments:
-322            text -- The text / Verbex object to look for.
-323
-324        Returns:
-325            Modified Verbex object.
-326        """
-327        return self._add(f"(?:{str(text)})*")
-328
-329    @re_escape
-330    @beartype
-331    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-332        """Find the text or Verbex object one or more times.
-333
-334        Arguments:
-335            text -- The text / Verbex object to look for.
-336
-337        Returns:
-338            Modified Verbex object.
-339        """
-340        return self._add(f"(?:{str(text)})+")
-341
-342    @re_escape
-343    @beartype
-344    def n_times(
-345        self,
-346        text: VerbexEscapedCharClassOrSpecial,
-347        n: int,  # noqa: VNE001
-348    ) -> Verbex:
-349        """Find the text or Verbex object n or more times.
-350
-351        Arguments:
-352            text -- The text / Verbex object to look for.
-353
-354        Returns:
-355            Modified Verbex object.
-356        """
-357        return self._add(f"(?:{str(text)}){{{n}}}")
-358
-359    @re_escape
-360    @beartype
-361    def n_times_or_more(
-362        self,
-363        text: VerbexEscapedCharClassOrSpecial,
-364        n: int,  # noqa: VNE001
-365    ) -> Verbex:
-366        """Find the text or Verbex object at least n times.
-367
-368        Arguments:
-369            text -- The text / Verbex object to look for.
-370
-371        Returns:
-372            Modified Verbex object.
-373        """
-374        return self._add(f"(?:{str(text)}){{{n},}}")
-375
-376    @re_escape
-377    @beartype
-378    def n_to_m_times(
-379        self,
-380        text: VerbexEscapedCharClassOrSpecial,
-381        n: int,  # noqa: VNE001
-382        m: int,  # noqa: VNE001
-383    ) -> Verbex:
-384        """Find the text or Verbex object between n and m times.
-385
-386        Arguments:
-387            text -- The text / Verbex object to look for.
-388
-389        Returns:
-390            Modified Verbex object.
-391        """
-392        return self._add(f"(?:{str(text)}){{{n},{m}}}")
-393
-394    @re_escape
-395    @beartype
-396    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-397        """Possibly find the text / Verbex object.
-398
-399        Arguments:
-400            text -- The text / Verbex object to possibly find.
-401
-402        Returns:
-403            Modified Verbex object.
-404        """
-405        return self._add(f"(?:{str(text)})?")
-406
-407    @re_escape
-408    @beartype
-409    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-410        """Find the text or Verbex object.
-411
-412        Arguments:
-413            text -- The text / Verbex object to look for.
-414
-415        Returns:
-416            Modified Verbex object.
-417        """
-418        return self._add(str(text))
-419
-420    @re_escape
-421    @beartype
-422    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-423        """Synonym for find.
-424
-425        Arguments:
-426            text -- The text / Verbex object to look for.
-427
-428        Returns:
-429            Modified Verbex object.
-430        """
-431        return self.find(text)
-432
-433    @re_escape
-434    @beartype
-435    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-436        """Match if string is followed by text.
-437
-438        Positive lookahead
-439
-440        Returns:
-441            Modified Verbex object.
-442        """
-443        return self._add(f"(?={text})")
-444
-445    @re_escape
-446    @beartype
-447    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-448        """Match if string is not followed by text.
-449
-450        Negative lookahead
-451
-452        Returns:
-453            Modified Verbex object.
-454        """
-455        return self._add(f"(?!{text})")
-456
-457    @re_escape
-458    @beartype
-459    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-460        """Match if string is not preceded by text.
-461
-462        Positive lookbehind
-463
-464        Returns:
-465            Modified Verbex object.
-466        """
-467        return self._add(f"(?<={text})")
-468
-469    @re_escape
-470    @beartype
-471    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-472        """Match if string is not preceded by text.
-473
-474        Negative Lookbehind
-475
-476        Returns:
-477            Modified Verbex object.
-478        """
-479        return self._add(f"(?<!{text})")
-480
-481    # only allow CharclassOrChars
-482
-483    @re_escape
-484    @beartype
-485    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
-486        """Find anything in this group of chars or char class.
-487
-488        Arguments:
-489            text -- The characters to look for.
-490
-491        Returns:
-492            Modified Verbex object.
-493        """
-494        return self._add(f"(?:[{chargroup}])")
-495
-496    @re_escape
-497    @beartype
-498    def not_any_of(self, text: CharClassOrChars) -> Verbex:
-499        """Find anything but this group of chars or char class.
-500
-501        Arguments:
-502            text -- The characters to not look for.
-503
-504        Returns:
-505            Modified Verbex object.
-506        """
-507        return self._add(f"(?:[^{text}])")
-508
-509    @re_escape
-510    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
-511        """Find anything one or more times but this group of chars or char class.
-512
-513        Arguments:
-514            text -- The characters to not look for.
-515
-516        Returns:
-517            Modified Verbex object.
-518        """
-519        return self._add(f"[^{chargroup}]+")
-520
-521    # no text input
-522
-523    def start_of_line(self) -> Verbex:
-524        """Find the start of the line.
-525
-526        Returns:
-527            Modified Verbex object.
-528        """
-529        return self.find(SpecialChar.START_OF_LINE)
-530
-531    def end_of_line(self) -> Verbex:
-532        """Find the end of the line.
-533
-534        Returns:
-535            Modified Verbex object.
-536        """
-537        return self.find(SpecialChar.END_OF_LINE)
-538
-539    def line_break(self) -> Verbex:
-540        """Find a line break.
-541
-542        Returns:
-543            Modified Verbex object.
-544        """
-545        return self.find(SpecialChar.LINEBREAK)
-546
-547    def tab(self) -> Verbex:
-548        """Find a tab.
-549
-550        Returns:
-551            Modified Verbex object.
-552        """
-553        return self.find(SpecialChar.TAB)
-554
-555    def anything(self) -> Verbex:
-556        """Find anything one or more time.
-557
-558        Returns:
-559            Modified Verbex object.
-560        """
-561        return self._add(".+")
-562
-563    def as_few(self) -> Verbex:
-564        """Modify previous search to not be greedy.
-565
-566        Returns:
-567            Modified Verbex object.
-568        """
-569        return self._add("?")
-570
-571    @beartype
-572    def number_range(self, start: int, end: int) -> Verbex:
-573        """Generate a range of numbers.
-574
-575        Arguments:
-576            start -- Start of the range
-577            end -- End of the range
-578
-579        Returns:
-580            Modified Verbex object.
-581        """
-582        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
-583
-584    @beartype
-585    def letter_range(self, start: Char, end: Char) -> Verbex:
-586        """Generate a range of letters.
-587
-588        Arguments:
-589            start -- Start of the range
-590            end -- End of the range
-591
-592        Returns:
-593            Modified Verbex object.
-594        """
-595        return self._add(f"[{start}-{end}]")
-596
-597    def word(self) -> Verbex:
-598        """Find a word on word boundary.
-599
-600        Returns:
-601            Modified Verbex object.
-602        """
-603        return self._add("(\\b\\w+\\b)")
-604
-605    # # --------------- modifiers ------------------------
-606
-607    def with_any_case(self) -> Verbex:
-608        """Modify Verbex object to be case insensitive.
-609
-610        Returns:
-611            Modified Verbex object.
-612        """
-613        self._modifiers |= re.IGNORECASE
-614        return self
-615
-616    def search_by_line(self) -> Verbex:
-617        """Search each line, ^ and $ match begining and end of line respectively.
-618
-619        Returns:
-620            Modified Verbex object.
-621        """
-622        self._modifiers |= re.MULTILINE
-623        return self
-624
-625    def with_ascii(self) -> Verbex:
-626        """Match ascii instead of unicode.
-627
-628        Returns:
-629            Modified Verbex object.
-630        """
-631        self._modifiers |= re.ASCII
-632        return self
-
- -
- -

VerbalExpressions class.

- -

the following methods do not try to match the original js lib!

-
- - -
-
#   - -
@re_escape
-
@beartype
- - Verbex(modifiers: re.RegexFlag = ) -
- -
- View Source - 
209    @re_escape
-210    @beartype
-211    def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG):
-212        """Create a Verbex object; setting any needed flags.
-213
-214        Keyword Arguments:
-215            modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})
-216        """
-217        # self._parts: List[str] = [text]
-218        self._parts: List[str] = []
-219        self._modifiers = modifiers
-
- -
- -

Create a Verbex object; setting any needed flags.

- -

Keyword Arguments: - modifiers -- Regex modifying flags (default: {re.RegexFlag(0)})

-
- - -
-
-
#   - - EMPTY_REGEX_FLAG = -
- - - - -
-
-
#   - - modifiers: re.RegexFlag -
- - -

Return the modifiers for this Verbex object.

- -

Returns: - The modifiers applied to this object.

-
- - -
-
-
#   - - - def - regex(self) -> Pattern[str]: -
- -
- View Source - 
247    def regex(self) -> Pattern[str]:
-248        """Get a regular expression object."""
-249        return re.compile(
-250            str(self),
-251            self._modifiers,
-252        )
-
- -
- -

Get a regular expression object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - capture_group( - self, - name_or_text: Union[str, NoneType, verbex.verbex.Verbex, verbex.verbex.CharClass, verbex.verbex.SpecialChar] = None, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar, NoneType] = None -) -> verbex.verbex.Verbex: -
- -
- View Source - 
273    @re_escape
-274    @beartype
-275    @_poseur_decorator("self")
-276    def capture_group(
-277        self,
-278        name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None,
-279        text: Optional[VerbexEscapedCharClassOrSpecial] = None,
-280    ) -> Verbex:
-281        """Create a capture group.
-282
-283        Name is optional if not specified then the first argument is the text.
-284
-285        Keyword Arguments:
-286            name_or_text -- The name of the group / text to search for (default: {None})
-287            text -- The text to search for (default: {None})
-288
-289        Raises:
-290            ValueError: If name is specified then text must be as well.
-291
-292        Returns:
-293            Verbex with added capture group.
-294        """
-295        if name_or_text is not None:
-296            if text is None:
-297                _text = name_or_text
-298                return self._capture_group_without_name(_text)
-299            if isinstance(name_or_text, str):
-300                return self._capture_group_with_name(name_or_text, text)
-301        raise ValueError("text must be specified with optional name")
-
- -
- -

Create a capture group.

- -

Name is optional if not specified then the first argument is the text.

- -

Keyword Arguments: - name_or_text -- The name of the group / text to search for (default: {None}) - text -- The text to search for (default: {None})

- -

Raises: - ValueError: If name is specified then text must be as well.

- -

Returns: - Verbex with added capture group.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - OR( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
303    @re_escape
-304    @beartype
-305    def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:  # noqa: N802
-306        """`or` is a python keyword so we use `OR` instead.
-307
-308        Arguments:
-309            text -- Text to find or a Verbex object.
-310
-311        Returns:
-312            Modified Verbex object.
-313        """
-314        return self._add("|").find(text)
-
- -
- -

or is a python keyword so we use OR instead.

- -

Arguments: - text -- Text to find or a Verbex object.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - zero_or_more( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
316    @re_escape
-317    @beartype
-318    def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-319        """Find the text or Verbex object zero or more times.
-320
-321        Arguments:
-322            text -- The text / Verbex object to look for.
-323
-324        Returns:
-325            Modified Verbex object.
-326        """
-327        return self._add(f"(?:{str(text)})*")
-
- -
- -

Find the text or Verbex object zero or more times.

- -

Arguments: - text -- The text / Verbex object to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - one_or_more( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
329    @re_escape
-330    @beartype
-331    def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-332        """Find the text or Verbex object one or more times.
-333
-334        Arguments:
-335            text -- The text / Verbex object to look for.
-336
-337        Returns:
-338            Modified Verbex object.
-339        """
-340        return self._add(f"(?:{str(text)})+")
-
- -
- -

Find the text or Verbex object one or more times.

- -

Arguments: - text -- The text / Verbex object to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - n_times( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar], - n: int -) -> verbex.verbex.Verbex: -
- -
- View Source - 
342    @re_escape
-343    @beartype
-344    def n_times(
-345        self,
-346        text: VerbexEscapedCharClassOrSpecial,
-347        n: int,  # noqa: VNE001
-348    ) -> Verbex:
-349        """Find the text or Verbex object n or more times.
-350
-351        Arguments:
-352            text -- The text / Verbex object to look for.
-353
-354        Returns:
-355            Modified Verbex object.
-356        """
-357        return self._add(f"(?:{str(text)}){{{n}}}")
-
- -
- -

Find the text or Verbex object n or more times.

- -

Arguments: - text -- The text / Verbex object to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - n_times_or_more( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar], - n: int -) -> verbex.verbex.Verbex: -
- -
- View Source - 
359    @re_escape
-360    @beartype
-361    def n_times_or_more(
-362        self,
-363        text: VerbexEscapedCharClassOrSpecial,
-364        n: int,  # noqa: VNE001
-365    ) -> Verbex:
-366        """Find the text or Verbex object at least n times.
-367
-368        Arguments:
-369            text -- The text / Verbex object to look for.
-370
-371        Returns:
-372            Modified Verbex object.
-373        """
-374        return self._add(f"(?:{str(text)}){{{n},}}")
-
- -
- -

Find the text or Verbex object at least n times.

- -

Arguments: - text -- The text / Verbex object to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - n_to_m_times( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar], - n: int, - m: int -) -> verbex.verbex.Verbex: -
- -
- View Source - 
376    @re_escape
-377    @beartype
-378    def n_to_m_times(
-379        self,
-380        text: VerbexEscapedCharClassOrSpecial,
-381        n: int,  # noqa: VNE001
-382        m: int,  # noqa: VNE001
-383    ) -> Verbex:
-384        """Find the text or Verbex object between n and m times.
-385
-386        Arguments:
-387            text -- The text / Verbex object to look for.
-388
-389        Returns:
-390            Modified Verbex object.
-391        """
-392        return self._add(f"(?:{str(text)}){{{n},{m}}}")
-
- -
- -

Find the text or Verbex object between n and m times.

- -

Arguments: - text -- The text / Verbex object to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - maybe( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
394    @re_escape
-395    @beartype
-396    def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-397        """Possibly find the text / Verbex object.
-398
-399        Arguments:
-400            text -- The text / Verbex object to possibly find.
-401
-402        Returns:
-403            Modified Verbex object.
-404        """
-405        return self._add(f"(?:{str(text)})?")
-
- -
- -

Possibly find the text / Verbex object.

- -

Arguments: - text -- The text / Verbex object to possibly find.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - find( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
407    @re_escape
-408    @beartype
-409    def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-410        """Find the text or Verbex object.
-411
-412        Arguments:
-413            text -- The text / Verbex object to look for.
-414
-415        Returns:
-416            Modified Verbex object.
-417        """
-418        return self._add(str(text))
-
- -
- -

Find the text or Verbex object.

- -

Arguments: - text -- The text / Verbex object to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - then( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
420    @re_escape
-421    @beartype
-422    def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-423        """Synonym for find.
-424
-425        Arguments:
-426            text -- The text / Verbex object to look for.
-427
-428        Returns:
-429            Modified Verbex object.
-430        """
-431        return self.find(text)
-
- -
- -

Synonym for find.

- -

Arguments: - text -- The text / Verbex object to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - followed_by( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
433    @re_escape
-434    @beartype
-435    def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-436        """Match if string is followed by text.
-437
-438        Positive lookahead
-439
-440        Returns:
-441            Modified Verbex object.
-442        """
-443        return self._add(f"(?={text})")
-
- -
- -

Match if string is followed by text.

- -

Positive lookahead

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - not_followed_by( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
445    @re_escape
-446    @beartype
-447    def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-448        """Match if string is not followed by text.
-449
-450        Negative lookahead
-451
-452        Returns:
-453            Modified Verbex object.
-454        """
-455        return self._add(f"(?!{text})")
-
- -
- -

Match if string is not followed by text.

- -

Negative lookahead

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - preceded_by( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
457    @re_escape
-458    @beartype
-459    def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-460        """Match if string is not preceded by text.
-461
-462        Positive lookbehind
-463
-464        Returns:
-465            Modified Verbex object.
-466        """
-467        return self._add(f"(?<={text})")
-
- -
- -

Match if string is not preceded by text.

- -

Positive lookbehind

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - not_preceded_by( - self, - text: Union[verbex.verbex.Verbex, str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
469    @re_escape
-470    @beartype
-471    def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex:
-472        """Match if string is not preceded by text.
-473
-474        Negative Lookbehind
-475
-476        Returns:
-477            Modified Verbex object.
-478        """
-479        return self._add(f"(?<!{text})")
-
- -
- -

Match if string is not preceded by text.

- -

Negative Lookbehind

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - any_of( - self, - chargroup: Union[str, verbex.verbex.CharClass] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
483    @re_escape
-484    @beartype
-485    def any_of(self, chargroup: CharClassOrChars) -> Verbex:
-486        """Find anything in this group of chars or char class.
-487
-488        Arguments:
-489            text -- The characters to look for.
-490
-491        Returns:
-492            Modified Verbex object.
-493        """
-494        return self._add(f"(?:[{chargroup}])")
-
- -
- -

Find anything in this group of chars or char class.

- -

Arguments: - text -- The characters to look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
-
@beartype
- - def - not_any_of( - self, - text: Union[str, verbex.verbex.CharClass] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
496    @re_escape
-497    @beartype
-498    def not_any_of(self, text: CharClassOrChars) -> Verbex:
-499        """Find anything but this group of chars or char class.
-500
-501        Arguments:
-502            text -- The characters to not look for.
-503
-504        Returns:
-505            Modified Verbex object.
-506        """
-507        return self._add(f"(?:[^{text}])")
-
- -
- -

Find anything but this group of chars or char class.

- -

Arguments: - text -- The characters to not look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@re_escape
- - def - anything_but( - self, - chargroup: Union[str, verbex.verbex.CharClass, verbex.verbex.SpecialChar] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
509    @re_escape
-510    def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex:
-511        """Find anything one or more times but this group of chars or char class.
-512
-513        Arguments:
-514            text -- The characters to not look for.
-515
-516        Returns:
-517            Modified Verbex object.
-518        """
-519        return self._add(f"[^{chargroup}]+")
-
- -
- -

Find anything one or more times but this group of chars or char class.

- -

Arguments: - text -- The characters to not look for.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - start_of_line(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
523    def start_of_line(self) -> Verbex:
-524        """Find the start of the line.
-525
-526        Returns:
-527            Modified Verbex object.
-528        """
-529        return self.find(SpecialChar.START_OF_LINE)
-
- -
- -

Find the start of the line.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - end_of_line(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
531    def end_of_line(self) -> Verbex:
-532        """Find the end of the line.
-533
-534        Returns:
-535            Modified Verbex object.
-536        """
-537        return self.find(SpecialChar.END_OF_LINE)
-
- -
- -

Find the end of the line.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - line_break(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
539    def line_break(self) -> Verbex:
-540        """Find a line break.
-541
-542        Returns:
-543            Modified Verbex object.
-544        """
-545        return self.find(SpecialChar.LINEBREAK)
-
- -
- -

Find a line break.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - tab(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
547    def tab(self) -> Verbex:
-548        """Find a tab.
-549
-550        Returns:
-551            Modified Verbex object.
-552        """
-553        return self.find(SpecialChar.TAB)
-
- -
- -

Find a tab.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - anything(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
555    def anything(self) -> Verbex:
-556        """Find anything one or more time.
-557
-558        Returns:
-559            Modified Verbex object.
-560        """
-561        return self._add(".+")
-
- -
- -

Find anything one or more time.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - as_few(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
563    def as_few(self) -> Verbex:
-564        """Modify previous search to not be greedy.
-565
-566        Returns:
-567            Modified Verbex object.
-568        """
-569        return self._add("?")
-
- -
- -

Modify previous search to not be greedy.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@beartype
- - def - number_range(self, start: int, end: int) -> verbex.verbex.Verbex: -
- -
- View Source - 
571    @beartype
-572    def number_range(self, start: int, end: int) -> Verbex:
-573        """Generate a range of numbers.
-574
-575        Arguments:
-576            start -- Start of the range
-577            end -- End of the range
-578
-579        Returns:
-580            Modified Verbex object.
-581        """
-582        return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")")
-
- -
- -

Generate a range of numbers.

- -

Arguments: - start -- Start of the range - end -- End of the range

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - -
@beartype
- - def - letter_range( - self, - start: typing.Annotated[str, Is[_string_len_is_1]], - end: typing.Annotated[str, Is[_string_len_is_1]] -) -> verbex.verbex.Verbex: -
- -
- View Source - 
584    @beartype
-585    def letter_range(self, start: Char, end: Char) -> Verbex:
-586        """Generate a range of letters.
-587
-588        Arguments:
-589            start -- Start of the range
-590            end -- End of the range
-591
-592        Returns:
-593            Modified Verbex object.
-594        """
-595        return self._add(f"[{start}-{end}]")
-
- -
- -

Generate a range of letters.

- -

Arguments: - start -- Start of the range - end -- End of the range

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - word(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
597    def word(self) -> Verbex:
-598        """Find a word on word boundary.
-599
-600        Returns:
-601            Modified Verbex object.
-602        """
-603        return self._add("(\\b\\w+\\b)")
-
- -
- -

Find a word on word boundary.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - with_any_case(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
607    def with_any_case(self) -> Verbex:
-608        """Modify Verbex object to be case insensitive.
-609
-610        Returns:
-611            Modified Verbex object.
-612        """
-613        self._modifiers |= re.IGNORECASE
-614        return self
-
- -
- -

Modify Verbex object to be case insensitive.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - search_by_line(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
616    def search_by_line(self) -> Verbex:
-617        """Search each line, ^ and $ match begining and end of line respectively.
-618
-619        Returns:
-620            Modified Verbex object.
-621        """
-622        self._modifiers |= re.MULTILINE
-623        return self
-
- -
- -

Search each line, ^ and $ match begining and end of line respectively.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
#   - - - def - with_ascii(self) -> verbex.verbex.Verbex: -
- -
- View Source - 
625    def with_ascii(self) -> Verbex:
-626        """Match ascii instead of unicode.
-627
-628        Returns:
-629            Modified Verbex object.
-630        """
-631        self._modifiers |= re.ASCII
-632        return self
-
- -
- -

Match ascii instead of unicode.

- -

Returns: - Modified Verbex object.

-
- - -
-
-
- - \ No newline at end of file diff --git a/justfile b/justfile new file mode 100644 index 0000000..7856ca7 --- /dev/null +++ b/justfile @@ -0,0 +1,143 @@ +set ignore-comments +PACKAGE_SLUG := "src/precommithooks" +export PYTHON_VERSION := if env("CI","false") != "false" { `python --version|cut -d" " -f2` } else { `cat .python-version` } +PYTHON := if env("USE_SYSTEM_PYTHON", "false") != "false" { "python" } else { ".venv/bin/python" } +PYTHON_ENV := if env("USE_SYSTEM_PYTHON", "false") != "false" { "" } else { "sh .venv/bin/activate &&" } +NEWLINE:="$'\n'" +# print list of commands +help: + @just --list --unsorted +# install into the venv +install: + @# $(PYTHON_PYENV) + {{if env("CI","false") != "false" { "" } else { "pyenv install --skip-existing $PYTHON_VERSION "} }} + @# $(PYTHON_VENV) + {{ if env("USE_SYSTEM_PYTHON", "false") != "false" { "" } else { "python -m venv .venv" } }} + @# pip + {{PYTHON}} -m pip install -e .[dev,optional,docs] + +# Install pre-commit +pre-commit_install: + pre-commit install + +# Setup sphynx autodoc +setup_autodoc: + sphinx-apidoc -f -o docs/source {{PACKAGE_SLUG}} + +# copy as template +copy_as_template DEST: + rsync -r --exclude .mypy_cache --exclude .pytest_cache --exclude .ruff_cache --exclude .tox --exclude .venv --exclude *.egg* --exclude .git ./ {{DEST}} + cd {{DEST}} && git init . && git commit --allow-empty -m 'Make initial root commit' + +# profiling +profile: + python -m cProfile -s time -o timing.prof tests/timing.py --profile + snakeviz timing.prof + +# +# Formatting +# +# Run all linting and fixes +fixes: validate_pyproject ruff_fixes ruff_format_fixes pylint dapperdata_fixes tomlsort_fixes docs pytest + +_fixes_no_ruff: validate_pyproject dapperdata_fixes tomlsort_fixes docs pytest update_dependencies_quiet + +# Validate pyproject.toml format +validate_pyproject: + {{PYTHON}} -m validate_pyproject pyproject.toml + +# Run pylint +pylint: + {{PYTHON}} -m pylint {{PACKAGE_SLUG}} + +# Run Ruff and fix +ruff_fixes: + {{PYTHON}} -m ruff check . --fix + +alias black_check := ruff_format_fixes +#Run Ruff format fixes +ruff_format_fixes: + {{PYTHON}} -m ruff format . + +# Run dapperdata fixes +dapperdata_fixes: + {{PYTHON}} -m dapperdata.cli pretty . --no-dry-run + +# Run Tomlsort fixes +tomlsort_fixes: + {{PYTHON_ENV}} toml-sort `find . -not -path "./.venv/*" -not -path "./.tox/*" -name "*.toml"` -i + +# Generate Docs +docs: + make -C ./docs clean html + +# +# Testing +# +# Run all tests +tests: install pytest ruff_check ruff_format_check mypy dapperdata_check tomlsort_check + +# Run Pytest +pytest: + {{PYTHON}} -m pytest --cov=./{{PACKAGE_SLUG}} --cov-report=term-missing tests + +# Run Pytest verbose +pytestvv: + {{PYTHON}} -m pytest -vv --cov=./{{PACKAGE_SLUG}} --cov-report=term-missing tests + +# Run pytest show strings +pytest_loud: + {{PYTHON}} -m pytest -vv -rA --cov=./{{PACKAGE_SLUG}} --cov-report=term-missing tests + +# Run ruff in check mode +ruff_check: + {{PYTHON}} -m ruff check + +# Run ruff format in check mode +ruff_format_check: + {{PYTHON}} -m ruff format . --check + +# Run mypy check +mypy: + {{PYTHON}} -m mypy {{PACKAGE_SLUG}} + +# Run dapperdata check +dapperdata_check: + {{PYTHON}} -m dapperdata.cli pretty . + +# Run tomlsort_check +tomlsort_check: + {{PYTHON_ENV}} toml-sort `find . -not -path "./.venv/*" -not -path "./.tox/*" -name "*.toml"` --check + +# +# Dependencies +# + +# Rebuild dependencies +rebuild_dependencies: + {{PYTHON}} -m uv pip compile --output-file=requirements.txt pyproject.toml + {{PYTHON}} -m uv pip compile --output-file=requirements-dev.txt --extra=dev pyproject.toml + {{PYTHON}} -m uv pip compile --output-file=requirements-optional.txt --extra=optional pyproject.toml + +# Update dependencies +update_dependencies: + {{PYTHON}} -m uv pip compile --upgrade --output-file=requirements.txt pyproject.toml + {{PYTHON}} -m uv pip compile --upgrade --output-file=requirements-dev.txt --extra=dev pyproject.toml + {{PYTHON}} -m uv pip compile --upgrade --output-file=requirements-optional.txt --extra=optional pyproject.toml + +update_dependencies_quiet: + {{PYTHON}} -m uv pip compile --upgrade --output-file=requirements.txt pyproject.toml > /dev/null + {{PYTHON}} -m uv pip compile --upgrade --output-file=requirements-dev.txt --extra=dev pyproject.toml > /dev/null + {{PYTHON}} -m uv pip compile --upgrade --output-file=requirements-optional.txt --extra=optional pyproject.toml > /dev/null + +# +# Packaging +# + +# Build package +build: install + {{PYTHON}} -m build + +# Create Git tag for release +create_tag tag notes="": + git tag -a v{{tag}} -m "Release {{tag}} "{{NEWLINE}}" {{notes}})" diff --git a/pyproject.toml b/pyproject.toml index 9dd6e66..c5c5088 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,36 +1,303 @@ [build-system] -requires = [ "setuptools >= 35.0.2", "wheel >= 0.29.0"] build-backend = "setuptools.build_meta" +requires = ["setuptools>=67.0", "wheel"] + +[project] +authors = [{ "name" = "R.Broderick" }] +description = "Python verbal based regular expressions" +version = "2.0.0" +license = { "file" = "LICENSE" } +name = "verbex" +readme = { file = "README.md", content-type = "text/markdown" } +dependencies = ["beartype", "typing-extensions; python_version < '3.12'"] +requires-python = ">=3.10.0" + +[project.optional-dependencies] +dev = [ + "build", + "dapperdata", + "glom", + "mypy", + "pytest", + "pytest-cov", + "pytest-pretty", + "ruamel.yaml", + "ruff", + "toml-sort", + "uv", + "validate-pyproject", + "packaging", + "snakeviz", + "pre-commit", + "tox", + "tox-pyenv-redux", + "pylint", + "perflint", + "snakeviz", + "pip-audit", +] + +optional = [] +docs = [ + "Sphinx", + "sphinx-autodoc-typehints", + "sphinx-rtd-theme", + "sphinx-rtd-size", + "autodocsumm", + "sphinx-pyproject", +] +[tool.dapperdata] +exclude_paths = [".venv", ".mypy_cache", ".git", ".vscode"] + +[tool.pylint.format] +max-line-length = 200 + +[tool.pylint.main] +extension-pkg-allow-list = ["pyodbc", "win32gui"] +load-plugins = "perflint" + +[tool.pylint."messages control"] +disable = [ + "W0707", + "W0703", + "C0204", + "C0411", + "C0114", + "C0115", + "C0116", + "W0611", + "E0401", + "W2301", + "C0414", + "C0413", + "R0902", + "R0914", + "W8205", + "E0611", + "C0103", + "R0913", + "R0903", + "W0613", + "C0412", + "W8201", + "R0912", + "R0915", + "R0801", + "W8402", + "W0511", + "W0622", + "W0107", + "R0911", + "E1101", + "E1136", + "E1120", + "W8403", + "W0222", + "E1129", + "E0213", + "W0221", + "E1128", + "C0321", + "logging-fstring-interpolation", + "unnecessary-lambda-assignment", + "protected-access", + # codes in ruff + "C0105", + "C0131", + "C0132", + "C0205", + "C0208", + "C0414", + "C3002", + "E0100", + "E0101", + "E0116", + "E0117", + "E0118", + "E0237", + "E0241", + "E0302", + "E0307", + "E0604", + "E0605", + "E1142", + "E1205", + "E1206", + "E1300", + "E1307", + "E1310", + "E1507", + "E1700", + "E2502", + "E2510", + "E2512", + "E2513", + "E2514", + "E2515", + "R0124", + "R0133", + "R0206", + "R0402", + "R0911", + "R0912", + "R0913", + "R0915", + "R1701", + "R1711", + "R1714", + "R1722", + # "R2004", + # "R5501", + "W0120", + "W0127", + "W0129", + "W0131", + "W0406", + "W0602", + "W0603", + "W0711", + "W1508", + "W1509", + "W1510", + # "W2901", + "W3301", +] + +[tool.pytest.ini_options] +pythonpath = ["src"] + +[tool.ruff] +exclude = [".venv"] +line-length = 88 +indent-width = 4 +target-version = "py310" + +[tool.ruff.format] +# Like Black, use double quotes for strings. +quote-style = "double" +# Like Black, indent with spaces, rather than tabs. +indent-style = "space" +# Like Black, respect magic trailing commas. +skip-magic-trailing-comma = false +# Like Black, automatically detect the appropriate line ending. +line-ending = "auto" +# Enable auto-formatting of code examples in docstrings. Markdown, +# reStructuredText code/literal blocks and doctests are all supported. +# +# This is currently disabled by default, but it is planned for this +# to be opt-out in the future. +docstring-code-format = true +# Set the line length limit used when formatting code snippets in +# docstrings. +# +# This only has an effect when the `docstring-code-format` setting is +# enabled. +docstring-code-line-length = "dynamic" + +[tool.ruff.lint] +typing-modules = ["beartype.typing"] +select = ["ALL"] +ignore = [ + "B024", + "PIE790", + "T201", + "PYI013", + "ANN101", + "TCH003", + "PLC0414", + "ERA001", + "T203", + "ANN102", + "ANN401", + "TCH002", + "TD002", + "TD003", + "FIX002", + "D203", + "D213", + "COM812", + "ISC001", + "FBT001", + "FBT002", +] +fixable = ["ALL"] +unfixable = [] + +[tool.ruff.lint.isort] +force-single-line = true + +[tool.setuptools.dynamic] +readme = { file = ["README.md"] } + +[tool.setuptools.package-data] +library = ["py.typed"] + +[tool.setuptools.packages.find] +exclude = ["docs*", "tests*"] +where = ["src"] + +[tool.sphinx-pyproject] +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration +coverage_show_missing_items = true +extensions = [ + "sphinx.ext.autodoc", + "sphinx_autodoc_typehints", + "sphinx.ext.viewcode", + "sphinx.ext.coverage", + "autodocsumm", + "sphinx_rtd_theme", + 'sphinx_rtd_size', +] +sphinx_rtd_size_width = "90%" +templates_path = ["_templates"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] +auto_doc_default_options = { 'autosummary' = true } +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output +html_theme = "sphinx_rtd_theme" +html_style = "css/custom.css" +html_static_path = ["_static"] +html_theme_options = { 'display_version' = true, 'sticky_navigation' = true, 'includehidden' = true, 'titles_only' = false } +autosummary_generate = true + +[tool.sphinx-pyproject.autodoc_default_options] +exclude-members = """ + __weakref__, + __sizeof__, + __hash__, + __module__, + __dict__, + __annotations__, + __orig_bases__, + __parameters__, + __abstractmethods__, + __non_callable_proto_members__, + __protocol_attrs__, + __subclasshook__, + __dataclass_fields__, + __post_init__, + __dataclass_params__, + __match_args__, + __str__, + __repr__""" +members = true +member-order = 'bysource' +special-members = true +undoc-members = true [tool.tox] legacy_tox_ini = """ [tox] -envlist = py37, py38, py39, py310, py311 -isolated_build = true - -[gh-actions] -python = - 3.7: py37 - 3.8: py38 - 3.9: py39 - 3.10: py310 +skipsdist = True +isolated_build = True +envlist = py310, py311, py312 + [testenv] -setenv = - PYTHONPATH = {toxinidir} -deps = -r{toxinidir}/requirements_test.txt -commands = python -m unittest discover -v -""" +deps = + -rrequirements-dev.txt + -rrequirements-optional.txt -[tool.isort] -profile = "black" -sections = ["FUTURE","STDLIB","THIRDPARTY","FIRSTPARTY","LOCALFOLDER"] - -[tool.mypy] -plugins = "pydantic.mypy" -follow_imports = "silent" -warn_redundant_casts = true -warn_unused_ignores = false -disallow_any_generics = true -check_untyped_defs = true -no_implicit_reexport = true -disallow_untyped_defs = true +commands = + pytest tests +""" diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index a957fff..0000000 --- a/setup.cfg +++ /dev/null @@ -1,27 +0,0 @@ -[metadata] -name = Verbex -version = 1.2.0 -author = Victor Titor, Yan Wenjun, diogobeda, Mihai Ionut Vilcu, Peder Soholt, Sameer Raghuram, Kharms, Richard Broderick -license = GPLv3 -description = Make difficult regular expressions easy! Python fork based on of the awesome VerbalExpressions repo - https://github.com/jehna/VerbalExpressions -url = https://github.com/rbroderi/Verbex -long_description = file: README.md -long_description_content_type = text/markdown -classifiers = - License :: OSI Approved :: GNU General Public License v3 (GPLv3) - Programming Language :: Python - Programming Language :: Python :: 3.7 - Programming Language :: Python :: 3.8 - Programming Language :: Python :: 3.9 - Programming Language :: Python :: 3.10 - Programming Language :: Python :: 3.11 - Topic :: Software Development :: Libraries - Topic :: Text Processing - -[options] -packages = verbex -include_package_data = True - -[options.extras_require] -testing = - tox diff --git a/setup.py b/setup.py deleted file mode 100755 index 7f1a176..0000000 --- a/setup.py +++ /dev/null @@ -1,4 +0,0 @@ -from setuptools import setup - -if __name__ == "__main__": - setup() diff --git a/verbex/__init__.py b/src/verbex/__init__.py similarity index 100% rename from verbex/__init__.py rename to src/verbex/__init__.py diff --git a/verbex/py.typed b/src/verbex/py.typed similarity index 100% rename from verbex/py.typed rename to src/verbex/py.typed diff --git a/verbex/verbex.py b/src/verbex/verbex.py similarity index 56% rename from verbex/verbex.py rename to src/verbex/verbex.py index 1a2d9ac..9f7a3f5 100644 --- a/verbex/verbex.py +++ b/src/verbex/verbex.py @@ -1,39 +1,37 @@ """Generate regular expressions from an easier fluent verbal form.""" + from __future__ import annotations import re +from collections.abc import Callable +from collections.abc import Iterator from enum import Enum from functools import wraps +from typing import Annotated +from typing import Any +from typing import TypeAlias +from typing import Union +from typing import cast +from typing import runtime_checkable try: - from typing import ( # <--------------- if Python ≥ 3.9.0 - Annotated, - ParamSpec, - Protocol, - TypeAlias, - runtime_checkable, - ) + from typing import Self except ImportError: - from typing_extensions import TypeAlias, Protocol, Annotated, ParamSpec, runtime_checkable # type: ignore # <--- if Python < 3.9.0 # noqa E501 + from typing_extensions import Self + +try: + from typing import ParamSpec + from typing import Protocol -from typing import TYPE_CHECKING, Pattern, TypeVar +except ImportError: + from typing_extensions import ParamSpec + from typing_extensions import Protocol -if TYPE_CHECKING: - from typing import Protocol # noqa: F811 +from re import Pattern +from typing import TypeVar -from beartype import beartype # type: ignore -from beartype.typing import ( # type: ignore - Any, - Callable, - Dict, - Iterator, - List, - Optional, - Tuple, - Union, - cast, -) -from beartype.vale import Is # type: ignore +from beartype import beartype +from beartype.vale import Is def _string_len_is_1(text: object) -> bool: @@ -43,8 +41,8 @@ def _string_len_is_1(text: object) -> bool: Char = Annotated[str, Is[_string_len_is_1]] -P = ParamSpec("P") # noqa: VNE001 -R = TypeVar("R") # noqa: VNE001 +P = ParamSpec("P") +R = TypeVar("R") # work around for bug https://github.com/python/mypy/issues/12660 @@ -56,8 +54,10 @@ class HasIter(Protocol): def __iter__(self) -> Iterator[Any]: """Object can be iterated. - Yields: + Yields + ------ Next object. + """ ... @@ -68,11 +68,11 @@ def __iter__(self) -> Iterator[Any]: class HasItems(Protocol): """Workaround for mypy P.kwargs.""" - def items(self) -> Tuple[str, Any]: + def items(self) -> tuple[str, Any]: """Object has items method. - Returns: - The dict of items. + :returns: The dict of items. + :rtype: dict """ ... @@ -80,18 +80,21 @@ def items(self) -> Tuple[str, Any]: class EscapedText(str): """Text that has been escaped for regex. - Arguments: - str -- Extend the string class. + :param str value: the string to escape + :return: escaped regex string + :rtype: str + """ - def __new__(cls, value: str) -> EscapedText: - """Return a escaped regex string. + __slots__ = () + + def __new__(cls, value: str) -> Self: + """Return an escaped regex string. - Arguments: - value -- the string to escape + :param str value: the string to escape + :return: escaped regex string + :rtype: str - Returns: - _description_ """ return str.__new__(cls, re.escape(value)) @@ -99,17 +102,17 @@ def __new__(cls, value: str) -> EscapedText: def re_escape(func: Callable[P, R]) -> Callable[P, R]: """Automatically escape any string parameters as EscapedText. - Arguments: - func -- The function to decorate. + :param func: The function to decorate. + :type func: Callable[P, R] + :return: The decorated function. + :rtype: Callable[P, R] - Returns: - The decorated function. """ @wraps(func) - def inner(*args: P.args, **kwargs: P.kwargs) -> R: # type: ignore - escaped_args: List[Any] = [] - escaped_kwargs: Dict[str, Any] = {} + def inner(*args: P.args, **kwargs: P.kwargs) -> R: + escaped_args: list[Any] = [] + escaped_kwargs: dict[str, Any] = {} for arg in cast(HasIter, args): if not isinstance(arg, EscapedText) and isinstance(arg, str): escaped_args.append(EscapedText(arg)) @@ -122,7 +125,7 @@ def inner(*args: P.args, **kwargs: P.kwargs) -> R: # type: ignore escaped_kwargs[arg_k] = EscapedText(str(arg_v)) else: escaped_kwargs[arg_k] = arg_v - return func(*escaped_args, **escaped_kwargs) # type: ignore + return func(*escaped_args, **escaped_kwargs) # pyright: ignore[reportCallIssue] return inner @@ -130,8 +133,9 @@ def inner(*args: P.args, **kwargs: P.kwargs) -> R: # type: ignore class CharClass(Enum): """Enum of character classes in regex. - Arguments: - Enum -- Extends the Enum class. + :param Enum: Extends the Enum class. + :type Enum: class + """ DIGIT = "\\d" @@ -144,17 +148,19 @@ class CharClass(Enum): def __str__(self) -> str: """To string method based on Enum value. - Returns: - value of Enum + :return: value of Enum + :rtype: str + """ return self.value class SpecialChar(Enum): - """Enum of special charaters, shorthand. + """Enum of special characters, shorthand. + + :param Enum: Extends the Enum class. + :type Enum: class - Arguments: - Enum -- Extends the Enum class. """ # does not work / should not be used in [ ] @@ -166,77 +172,74 @@ class SpecialChar(Enum): def __str__(self) -> str: """To string for special chars enum. - Returns: - Return value of enum as string. + :return: Return value of enum as string. + :rtype: str + """ return self.value -CharClassOrChars: TypeAlias = Union[str, CharClass] -EscapedCharClassOrSpecial: TypeAlias = Union[str, CharClass, SpecialChar] +CharClassOrChars: TypeAlias = str | CharClass +EscapedCharClassOrSpecial: TypeAlias = str | CharClass | SpecialChar VerbexEscapedCharClassOrSpecial: TypeAlias = Union["Verbex", EscapedCharClassOrSpecial] -def _poseur_decorator(*poseur: Any) -> Any: - """Positional-only arguments runtime checker.""" - import functools - - def caller(func: Callable[P, R]) -> Callable[P, R]: # type: ignore - @functools.wraps(func) - def wrapper(*args: P.args, **kwargs: P.kwargs) -> R: - poseur_args = set(poseur).intersection(kwargs) # type: ignore - if poseur_args: - raise TypeError( - "%s() got some positional-only arguments passed as keyword" - " arguments: %r" % (func.__name__, ", ".join(poseur_args)), - ) - return func(*args, **kwargs) # type: ignore - - return wrapper - - return caller +class Verbex: + """VerbalExpressions class. + The following methods do not try to match the original js lib! -class Verbex: - """ - VerbalExpressions class. + .. note:: + This class is a modified version of the VerbalExpressions library. - the following methods do not try to match the original js lib! """ EMPTY_REGEX_FLAG = re.RegexFlag(0) @re_escape @beartype - def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG): + def __init__(self, modifiers: re.RegexFlag = EMPTY_REGEX_FLAG) -> None: """Create a Verbex object; setting any needed flags. - Keyword Arguments: - modifiers -- Regex modifying flags (default: {re.RegexFlag(0)}) + :param modifiers: Regex modifying flags (default: ``re.RegexFlag(0)``) + :type modifiers: re.RegexFlag + + :returns: The created Verbex object. + :rtype: Verbex + """ # self._parts: List[str] = [text] - self._parts: List[str] = [] + self._parts: list[str] = [] self._modifiers = modifiers @property def modifiers(self) -> re.RegexFlag: """Return the modifiers for this Verbex object. - Returns: - The modifiers applied to this object. + :return: The modifiers applied to this object. + :rtype: re.RegexFlag + """ return self._modifiers def __str__(self) -> str: - """Return regex string representation.""" + """Return regex string representation. + + :return: The regex string representation. + :rtype: str + + """ return "".join(self._parts) @beartype - def _add(self, value: Union[str, List[str]]) -> Verbex: - """ - Append a transformed value to internal expression to be compiled. + def _add(self, value: str | list[str]) -> Verbex: + """Append a transformed value to internal expression to be compiled. As possible, this method should be "private". + + :return: Modified Verbex object. + :rtype: Verbex + """ if isinstance(value, list): self._parts.extend(value) @@ -245,7 +248,12 @@ def _add(self, value: Union[str, List[str]]) -> Verbex: return self def regex(self) -> Pattern[str]: - """Get a regular expression object.""" + """Get a regular expression object. + + :return: A regular expression object. + :rtype: Pattern[str] + + """ return re.compile( str(self), self._modifiers, @@ -260,7 +268,7 @@ def _capture_group_with_name( name: str, text: VerbexEscapedCharClassOrSpecial, ) -> Verbex: - return self._add(f"(?<{name}>{str(text)})") + return self._add(f"(?<{name}>{text!s})") @re_escape @beartype @@ -268,29 +276,29 @@ def _capture_group_without_name( self, text: VerbexEscapedCharClassOrSpecial, ) -> Verbex: - return self._add(f"({str(text)})") + return self._add(f"({text!s})") @re_escape @beartype - @_poseur_decorator("self") def capture_group( self, - name_or_text: Union[Optional[str], VerbexEscapedCharClassOrSpecial] = None, - text: Optional[VerbexEscapedCharClassOrSpecial] = None, + name_or_text: str | None | VerbexEscapedCharClassOrSpecial = None, + text: VerbexEscapedCharClassOrSpecial | None = None, ) -> Verbex: """Create a capture group. - Name is optional if not specified then the first argument is the text. + Name is optional. If not specified, then the first argument is the text. - Keyword Arguments: - name_or_text -- The name of the group / text to search for (default: {None}) - text -- The text to search for (default: {None}) + :param name_or_text: The name of the group / text to search for (default: None) + :type name_or_text: str or None + :param text: The text to search for (default: None) + :type text: str or None - Raises: - ValueError: If name is specified then text must be as well. + :raises ValueError: If name is specified, then text must be as well. + + :returns: Verbex with added capture group. + :rtype: Verbex - Returns: - Verbex with added capture group. """ if name_or_text is not None: if text is None: @@ -298,18 +306,20 @@ def capture_group( return self._capture_group_without_name(_text) if isinstance(name_or_text, str): return self._capture_group_with_name(name_or_text, text) - raise ValueError("text must be specified with optional name") + msg = "text must be specified with optional name" + raise ValueError(msg) @re_escape @beartype def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: # noqa: N802 """`or` is a python keyword so we use `OR` instead. - Arguments: - text -- Text to find or a Verbex object. + :param text: Text to find or a Verbex object. + :type text: VerbexEscapedCharClassOrSpecial + + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ return self._add("|").find(text) @@ -318,102 +328,110 @@ def OR(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: # noqa: N802 def zero_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: """Find the text or Verbex object zero or more times. - Arguments: - text -- The text / Verbex object to look for. + :param text: The text / Verbex object to look for. + :type text: VerbexEscapedCharClassOrSpecial + + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ - return self._add(f"(?:{str(text)})*") + return self._add(f"(?:{text!s})*") @re_escape @beartype def one_or_more(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: """Find the text or Verbex object one or more times. - Arguments: - text -- The text / Verbex object to look for. + :param text: The text / Verbex object to look for. + :type text: VerbexEscapedCharClassOrSpecial + + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ - return self._add(f"(?:{str(text)})+") + return self._add(f"(?:{text!s})+") @re_escape @beartype def n_times( self, text: VerbexEscapedCharClassOrSpecial, - n: int, # noqa: VNE001 + n: int, ) -> Verbex: """Find the text or Verbex object n or more times. - Arguments: - text -- The text / Verbex object to look for. + :param text: The text / Verbex object to look for. + :type text: VerbexEscapedCharClassOrSpecial + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ - return self._add(f"(?:{str(text)}){{{n}}}") + return self._add(f"(?:{text!s}){{{n}}}") @re_escape @beartype def n_times_or_more( self, text: VerbexEscapedCharClassOrSpecial, - n: int, # noqa: VNE001 + n: int, ) -> Verbex: """Find the text or Verbex object at least n times. - Arguments: - text -- The text / Verbex object to look for. + :param text: The text / Verbex object to look for. + :type text: VerbexEscapedCharClassOrSpecial + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ - return self._add(f"(?:{str(text)}){{{n},}}") + return self._add(f"(?:{text!s}){{{n},}}") @re_escape @beartype def n_to_m_times( self, text: VerbexEscapedCharClassOrSpecial, - n: int, # noqa: VNE001 - m: int, # noqa: VNE001 + n: int, + m: int, ) -> Verbex: """Find the text or Verbex object between n and m times. - Arguments: - text -- The text / Verbex object to look for. + :param text: The text / Verbex object to look for. + :type text: VerbexEscapedCharClassOrSpecial + :param n: The minimum number of times to find the text. + :type n: int + :param m: The maximum number of times to find the text. + :type m: int + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ - return self._add(f"(?:{str(text)}){{{n},{m}}}") + return self._add(f"(?:{text!s}){{{n},{m}}}") @re_escape @beartype def maybe(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: """Possibly find the text / Verbex object. - Arguments: - text -- The text / Verbex object to possibly find. + :param text: The text / Verbex object to possibly find. + :type text: VerbexEscapedCharClassOrSpecial + + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ - return self._add(f"(?:{str(text)})?") + return self._add(f"(?:{text!s})?") @re_escape @beartype def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: """Find the text or Verbex object. - Arguments: - text -- The text / Verbex object to look for. + :param text: The text / Verbex object to look for. + :type text: VerbexEscapedCharClassOrSpecial + + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ return self._add(str(text)) @@ -422,11 +440,12 @@ def find(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: def then(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: """Synonym for find. - Arguments: - text -- The text / Verbex object to look for. + :param text: The text / Verbex object to look for. + :type text: VerbexEscapedCharClassOrSpecial + + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ return self.find(text) @@ -437,8 +456,9 @@ def followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: Positive lookahead - Returns: - Modified Verbex object. + :return: Modified Verbex object. + :rtype: Verbex + """ return self._add(f"(?={text})") @@ -449,8 +469,9 @@ def not_followed_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: Negative lookahead - Returns: - Modified Verbex object. + :return: Modified Verbex object. + :rtype: Verbex + """ return self._add(f"(?!{text})") @@ -461,8 +482,9 @@ def preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: Positive lookbehind - Returns: - Modified Verbex object. + :return: Modified Verbex object. + :rtype: Verbex + """ return self._add(f"(?<={text})") @@ -473,23 +495,23 @@ def not_preceded_by(self, text: VerbexEscapedCharClassOrSpecial) -> Verbex: Negative Lookbehind - Returns: - Modified Verbex object. + :return: Modified Verbex object. + :rtype: Verbex + """ return self._add(f"(? Verbex: """Find anything in this group of chars or char class. - Arguments: - text -- The characters to look for. + :param text: The characters to look for. + :type text: str + + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ return self._add(f"(?:[{chargroup}])") @@ -498,11 +520,12 @@ def any_of(self, chargroup: CharClassOrChars) -> Verbex: def not_any_of(self, text: CharClassOrChars) -> Verbex: """Find anything but this group of chars or char class. - Arguments: - text -- The characters to not look for. + :param text: The characters to not look for. + :type text: str + + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ return self._add(f"(?:[^{text}])") @@ -510,11 +533,12 @@ def not_any_of(self, text: CharClassOrChars) -> Verbex: def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex: """Find anything one or more times but this group of chars or char class. - Arguments: - text -- The characters to not look for. + :param text: The characters to not look for. + :type text: str + + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ return self._add(f"[^{chargroup}]+") @@ -523,48 +547,54 @@ def anything_but(self, chargroup: EscapedCharClassOrSpecial) -> Verbex: def start_of_line(self) -> Verbex: """Find the start of the line. - Returns: - Modified Verbex object. + :return: Modified Verbex object. + :rtype: Verbex + """ return self.find(SpecialChar.START_OF_LINE) def end_of_line(self) -> Verbex: """Find the end of the line. - Returns: - Modified Verbex object. + :return: Modified Verbex object. + :rtype: Verbex + """ return self.find(SpecialChar.END_OF_LINE) def line_break(self) -> Verbex: """Find a line break. - Returns: - Modified Verbex object. + :return: Modified Verbex object. + :rtype: Verbex + """ return self.find(SpecialChar.LINEBREAK) def tab(self) -> Verbex: """Find a tab. - Returns: - Modified Verbex object. + :return: Modified Verbex object. + :rtype: Verbex + """ return self.find(SpecialChar.TAB) def anything(self) -> Verbex: - """Find anything one or more time. + """Find anything one or more times. + + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ return self._add(".+") def as_few(self) -> Verbex: """Modify previous search to not be greedy. - Returns: - Modified Verbex object. + :return: Modified Verbex object. + :rtype: Verbex + """ return self._add("?") @@ -572,12 +602,13 @@ def as_few(self) -> Verbex: def number_range(self, start: int, end: int) -> Verbex: """Generate a range of numbers. - Arguments: - start -- Start of the range - end -- End of the range + :param start: Start of the range + :type start: int + :param end: End of the range + :type end: int + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ return self._add("(?:" + "|".join(str(i) for i in range(start, end + 1)) + ")") @@ -585,20 +616,22 @@ def number_range(self, start: int, end: int) -> Verbex: def letter_range(self, start: Char, end: Char) -> Verbex: """Generate a range of letters. - Arguments: - start -- Start of the range - end -- End of the range + :param start: Start of the range + :type start: Char + :param end: End of the range + :type end: Char + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ return self._add(f"[{start}-{end}]") def word(self) -> Verbex: """Find a word on word boundary. - Returns: - Modified Verbex object. + :return: Modified Verbex object. + :rtype: Verbex + """ return self._add("(\\b\\w+\\b)") @@ -607,17 +640,19 @@ def word(self) -> Verbex: def with_any_case(self) -> Verbex: """Modify Verbex object to be case insensitive. - Returns: - Modified Verbex object. + :return: Modified Verbex object. + :rtype: Verbex + """ self._modifiers |= re.IGNORECASE return self def search_by_line(self) -> Verbex: - """Search each line, ^ and $ match begining and end of line respectively. + """Search each line, ^ and $ match beginning and end of line respectively. + + :return: Modified Verbex object. + :rtype: Verbex - Returns: - Modified Verbex object. """ self._modifiers |= re.MULTILINE return self @@ -625,8 +660,9 @@ def search_by_line(self) -> Verbex: def with_ascii(self) -> Verbex: """Match ascii instead of unicode. - Returns: - Modified Verbex object. + :return: Modified Verbex object. + :rtype: Verbex + """ self._modifiers |= re.ASCII return self diff --git a/verbex/GPLv3_LICENSE.txt b/verbex/GPLv3_LICENSE.txt deleted file mode 100644 index f288702..0000000 --- a/verbex/GPLv3_LICENSE.txt +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/verbex/LICENSE.txt b/verbex/LICENSE.txt deleted file mode 100644 index 4b5ad82..0000000 --- a/verbex/LICENSE.txt +++ /dev/null @@ -1,39 +0,0 @@ -Verbal Expressions -Copyright (C) 2022 Richard Broderick - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see . - - This file incorporates work covered by the following copyright and - permission notice: - - The MIT License (MIT) - - Copyright (c) 2017 jehna - - Permission is hereby granted, free of charge, to any person obtaining a copy of - this software and associated documentation files (the "Software"), to deal in - the Software without restriction, including without limitation the rights to - use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of - the Software, and to permit persons to whom the Software is furnished to do so, - subject to the following conditions: - - The above copyright notice and this permission notice shall be included in all - copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS - FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR - COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER - IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN - CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. From 1ce407aabcabf2320ab8847e15286165c966f84b Mon Sep 17 00:00:00 2001 From: "R. Broderick" Date: Sun, 28 Apr 2024 01:17:30 -0400 Subject: [PATCH 65/85] cleanup and move to new dev enviroment. Drop support for python versions < 3.10 --- justfile | 2 +- pyproject.toml | 330 +++++++++++++++++++------------------- requirements-dev.txt | 194 ++++++++++++++++++++++ requirements-optional.txt | 3 + requirements.txt | 13 +- src/verbex/__init__.py | 12 +- src/verbex/verbex.py | 12 +- tests/__init__.py | 1 + tests/test_verbex.py | 9 +- 9 files changed, 382 insertions(+), 194 deletions(-) create mode 100644 requirements-dev.txt create mode 100644 requirements-optional.txt diff --git a/justfile b/justfile index 7856ca7..3d29723 100644 --- a/justfile +++ b/justfile @@ -1,5 +1,5 @@ set ignore-comments -PACKAGE_SLUG := "src/precommithooks" +PACKAGE_SLUG := "src/verbex" export PYTHON_VERSION := if env("CI","false") != "false" { `python --version|cut -d" " -f2` } else { `cat .python-version` } PYTHON := if env("USE_SYSTEM_PYTHON", "false") != "false" { "python" } else { ".venv/bin/python" } PYTHON_ENV := if env("USE_SYSTEM_PYTHON", "false") != "false" { "" } else { "sh .venv/bin/activate &&" } diff --git a/pyproject.toml b/pyproject.toml index c5c5088..39d4525 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,49 +3,49 @@ build-backend = "setuptools.build_meta" requires = ["setuptools>=67.0", "wheel"] [project] -authors = [{ "name" = "R.Broderick" }] +authors = [{"name" = "R.Broderick"}] description = "Python verbal based regular expressions" version = "2.0.0" -license = { "file" = "LICENSE" } +license = {"file" = "LICENSE"} name = "verbex" -readme = { file = "README.md", content-type = "text/markdown" } +readme = {file = "README.md", content-type = "text/markdown"} dependencies = ["beartype", "typing-extensions; python_version < '3.12'"] requires-python = ">=3.10.0" [project.optional-dependencies] dev = [ - "build", - "dapperdata", - "glom", - "mypy", - "pytest", - "pytest-cov", - "pytest-pretty", - "ruamel.yaml", - "ruff", - "toml-sort", - "uv", - "validate-pyproject", - "packaging", - "snakeviz", - "pre-commit", - "tox", - "tox-pyenv-redux", - "pylint", - "perflint", - "snakeviz", - "pip-audit", + "build", + "dapperdata", + "glom", + "mypy", + "pytest", + "pytest-cov", + "pytest-pretty", + "ruamel.yaml", + "ruff", + "toml-sort", + "uv", + "validate-pyproject", + "packaging", + "snakeviz", + "pre-commit", + "tox", + "tox-pyenv-redux", + "pylint", + "perflint", + "snakeviz", + "pip-audit" ] - optional = [] docs = [ - "Sphinx", - "sphinx-autodoc-typehints", - "sphinx-rtd-theme", - "sphinx-rtd-size", - "autodocsumm", - "sphinx-pyproject", + "Sphinx", + "sphinx-autodoc-typehints", + "sphinx-rtd-theme", + "sphinx-rtd-size", + "autodocsumm", + "sphinx-pyproject" ] + [tool.dapperdata] exclude_paths = [".venv", ".mypy_cache", ".git", ".vscode"] @@ -58,109 +58,109 @@ load-plugins = "perflint" [tool.pylint."messages control"] disable = [ - "W0707", - "W0703", - "C0204", - "C0411", - "C0114", - "C0115", - "C0116", - "W0611", - "E0401", - "W2301", - "C0414", - "C0413", - "R0902", - "R0914", - "W8205", - "E0611", - "C0103", - "R0913", - "R0903", - "W0613", - "C0412", - "W8201", - "R0912", - "R0915", - "R0801", - "W8402", - "W0511", - "W0622", - "W0107", - "R0911", - "E1101", - "E1136", - "E1120", - "W8403", - "W0222", - "E1129", - "E0213", - "W0221", - "E1128", - "C0321", - "logging-fstring-interpolation", - "unnecessary-lambda-assignment", - "protected-access", - # codes in ruff - "C0105", - "C0131", - "C0132", - "C0205", - "C0208", - "C0414", - "C3002", - "E0100", - "E0101", - "E0116", - "E0117", - "E0118", - "E0237", - "E0241", - "E0302", - "E0307", - "E0604", - "E0605", - "E1142", - "E1205", - "E1206", - "E1300", - "E1307", - "E1310", - "E1507", - "E1700", - "E2502", - "E2510", - "E2512", - "E2513", - "E2514", - "E2515", - "R0124", - "R0133", - "R0206", - "R0402", - "R0911", - "R0912", - "R0913", - "R0915", - "R1701", - "R1711", - "R1714", - "R1722", - # "R2004", - # "R5501", - "W0120", - "W0127", - "W0129", - "W0131", - "W0406", - "W0602", - "W0603", - "W0711", - "W1508", - "W1509", - "W1510", - # "W2901", - "W3301", + "W0707", + "W0703", + "C0204", + "C0411", + "C0114", + "C0115", + "C0116", + "W0611", + "E0401", + "W2301", + "C0414", + "C0413", + "R0902", + "R0914", + "W8205", + "E0611", + "C0103", + "R0913", + "R0903", + "W0613", + "C0412", + "W8201", + "R0912", + "R0915", + "R0801", + "W8402", + "W0511", + "W0622", + "W0107", + "R0911", + "E1101", + "E1136", + "E1120", + "W8403", + "W0222", + "E1129", + "E0213", + "W0221", + "E1128", + "C0321", + "logging-fstring-interpolation", + "unnecessary-lambda-assignment", + "protected-access", + # codes in ruff + "C0105", + "C0131", + "C0132", + "C0205", + "C0208", + "C0414", + "C3002", + "E0100", + "E0101", + "E0116", + "E0117", + "E0118", + "E0237", + "E0241", + "E0302", + "E0307", + "E0604", + "E0605", + "E1142", + "E1205", + "E1206", + "E1300", + "E1307", + "E1310", + "E1507", + "E1700", + "E2502", + "E2510", + "E2512", + "E2513", + "E2514", + "E2515", + "R0124", + "R0133", + "R0206", + "R0402", + "R0911", + "R0912", + "R0913", + "R0915", + "R1701", + "R1711", + "R1714", + "R1722", + # "R2004", + # "R5501", + "W0120", + "W0127", + "W0129", + "W0131", + "W0406", + "W0602", + "W0603", + "W0711", + "W1508", + "W1509", + "W1510", + # "W2901", + "W3301" ] [tool.pytest.ini_options] @@ -198,27 +198,27 @@ docstring-code-line-length = "dynamic" typing-modules = ["beartype.typing"] select = ["ALL"] ignore = [ - "B024", - "PIE790", - "T201", - "PYI013", - "ANN101", - "TCH003", - "PLC0414", - "ERA001", - "T203", - "ANN102", - "ANN401", - "TCH002", - "TD002", - "TD003", - "FIX002", - "D203", - "D213", - "COM812", - "ISC001", - "FBT001", - "FBT002", + "B024", + "PIE790", + "T201", + "PYI013", + "ANN101", + "TCH003", + "PLC0414", + "ERA001", + "T203", + "ANN102", + "ANN401", + "TCH002", + "TD002", + "TD003", + "FIX002", + "D203", + "D213", + "COM812", + "ISC001", + "FBT001", + "FBT002" ] fixable = ["ALL"] unfixable = [] @@ -227,7 +227,7 @@ unfixable = [] force-single-line = true [tool.setuptools.dynamic] -readme = { file = ["README.md"] } +readme = {file = ["README.md"]} [tool.setuptools.package-data] library = ["py.typed"] @@ -241,24 +241,24 @@ where = ["src"] # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration coverage_show_missing_items = true extensions = [ - "sphinx.ext.autodoc", - "sphinx_autodoc_typehints", - "sphinx.ext.viewcode", - "sphinx.ext.coverage", - "autodocsumm", - "sphinx_rtd_theme", - 'sphinx_rtd_size', + "sphinx.ext.autodoc", + "sphinx_autodoc_typehints", + "sphinx.ext.viewcode", + "sphinx.ext.coverage", + "autodocsumm", + "sphinx_rtd_theme", + 'sphinx_rtd_size' ] sphinx_rtd_size_width = "90%" templates_path = ["_templates"] exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] -auto_doc_default_options = { 'autosummary' = true } +auto_doc_default_options = {'autosummary' = true} # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = "sphinx_rtd_theme" html_style = "css/custom.css" html_static_path = ["_static"] -html_theme_options = { 'display_version' = true, 'sticky_navigation' = true, 'includehidden' = true, 'titles_only' = false } +html_theme_options = {'display_version' = true, 'sticky_navigation' = true, 'includehidden' = true, 'titles_only' = false} autosummary_generate = true [tool.sphinx-pyproject.autodoc_default_options] diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 0000000..1c12bc0 --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,194 @@ +# This file was autogenerated by uv via the following command: +# uv pip compile --output-file=requirements-dev.txt --extra=dev pyproject.toml +annotated-types==0.6.0 + # via pydantic +astroid==3.1.0 + # via pylint +attrs==23.2.0 + # via glom +beartype==0.18.5 +boltons==24.0.0 + # via + # face + # glom +boolean-py==4.0 + # via license-expression +build==1.2.1 +cachecontrol==0.14.0 + # via pip-audit +cachetools==5.3.3 + # via tox +certifi==2024.2.2 + # via requests +cfgv==3.4.0 + # via pre-commit +chardet==5.2.0 + # via tox +charset-normalizer==3.3.2 + # via requests +click==8.1.7 + # via typer +colorama==0.4.6 + # via tox +coverage==7.5.0 + # via pytest-cov +cyclonedx-python-lib==6.4.4 + # via pip-audit +dapperdata==0.4.0 +defusedxml==0.7.1 + # via py-serializable +dill==0.3.8 + # via pylint +distlib==0.3.8 + # via virtualenv +face==20.1.1 + # via glom +fastjsonschema==2.19.1 + # via validate-pyproject +filelock==3.13.4 + # via + # cachecontrol + # tox + # virtualenv +glom==23.5.0 +html5lib==1.1 + # via pip-audit +identify==2.5.36 + # via pre-commit +idna==3.7 + # via requests +iniconfig==2.0.0 + # via pytest +isort==5.13.2 + # via pylint +license-expression==30.3.0 + # via cyclonedx-python-lib +markdown-it-py==3.0.0 + # via rich +mccabe==0.7.0 + # via pylint +mdurl==0.1.2 + # via markdown-it-py +msgpack==1.0.8 + # via cachecontrol +mypy==1.10.0 +mypy-extensions==1.0.0 + # via mypy +nodeenv==1.8.0 + # via pre-commit +packageurl-python==0.15.0 + # via cyclonedx-python-lib +packaging==24.0 + # via + # build + # pip-audit + # pip-requirements-parser + # pyproject-api + # pytest + # tox +perflint==0.8.1 +pip==24.0 + # via pip-api +pip-api==0.0.33 + # via pip-audit +pip-audit==2.7.2 +pip-requirements-parser==32.0.1 + # via pip-audit +platformdirs==4.2.1 + # via + # pylint + # tox + # virtualenv +pluggy==1.5.0 + # via + # pytest + # tox +pre-commit==3.7.0 +py-serializable==1.0.3 + # via cyclonedx-python-lib +pydantic==2.7.1 + # via + # dapperdata + # pydantic-settings +pydantic-core==2.18.2 + # via pydantic +pydantic-settings==2.2.1 + # via dapperdata +pyenv-inspect==0.4.0 + # via virtualenv-pyenv +pygments==2.17.2 + # via rich +pylint==3.1.0 + # via perflint +pyparsing==3.1.2 + # via pip-requirements-parser +pyproject-api==1.6.1 + # via tox +pyproject-hooks==1.0.0 + # via build +pytest==8.2.0 + # via + # pytest-cov + # pytest-pretty +pytest-cov==5.0.0 +pytest-pretty==1.2.0 +python-dotenv==1.0.1 + # via pydantic-settings +pyyaml==6.0.1 + # via pre-commit +requests==2.31.0 + # via + # cachecontrol + # pip-audit +rich==13.7.1 + # via + # pip-audit + # pytest-pretty + # typer +ruamel-yaml==0.18.6 + # via dapperdata +ruamel-yaml-clib==0.2.8 + # via ruamel-yaml +ruff==0.4.2 +setuptools==69.5.1 + # via nodeenv +shellingham==1.5.4 + # via typer +six==1.16.0 + # via html5lib +snakeviz==2.2.0 +sortedcontainers==2.4.0 + # via cyclonedx-python-lib +toml==0.10.2 + # via pip-audit +toml-sort==0.23.1 +tomlkit==0.12.4 + # via + # pylint + # toml-sort +tornado==6.4 + # via snakeviz +tox==4.15.0 + # via tox-pyenv-redux +tox-pyenv-redux==1.1.0 +typer==0.12.3 + # via dapperdata +typing-extensions==4.11.0 + # via + # mypy + # pydantic + # pydantic-core + # typer +urllib3==2.2.1 + # via requests +uv==0.1.39 +validate-pyproject==0.16 +virtualenv==20.26.0 + # via + # pre-commit + # tox + # virtualenv-pyenv +virtualenv-pyenv==0.5.0 + # via tox-pyenv-redux +webencodings==0.5.1 + # via html5lib diff --git a/requirements-optional.txt b/requirements-optional.txt new file mode 100644 index 0000000..bbca596 --- /dev/null +++ b/requirements-optional.txt @@ -0,0 +1,3 @@ +# This file was autogenerated by uv via the following command: +# uv pip compile --output-file=requirements-optional.txt --extra=optional pyproject.toml +beartype==0.18.5 diff --git a/requirements.txt b/requirements.txt index d94285e..516c965 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,10 +1,3 @@ -# -# This file is autogenerated by pip-compile with python 3.10 -# To update, run: -# -# pip-compile requirements.in -# -beartype==0.10.4 - # via -r requirements.in -typing-extensions==4.2.0 - # via -r requirements.in +# This file was autogenerated by uv via the following command: +# uv pip compile --output-file=requirements.txt pyproject.toml +beartype==0.18.5 diff --git a/src/verbex/__init__.py b/src/verbex/__init__.py index 9d5e731..6ce3539 100644 --- a/src/verbex/__init__.py +++ b/src/verbex/__init__.py @@ -1,10 +1,12 @@ -try: - from importlib.metadata import version -except ImportError: - from importlib_metadata import version # type: ignore +"""Verbal regular expression library.""" + +# try: +# from importlib.metadata import version +# except ImportError: +# from importlib_metadata import version from .verbex import CharClass as CharClass from .verbex import SpecialChar as SpecialChar from .verbex import Verbex as Verbex -__version__ = version("verbex") +# __version__ = version("verbex") diff --git a/src/verbex/verbex.py b/src/verbex/verbex.py index 9f7a3f5..033ab28 100644 --- a/src/verbex/verbex.py +++ b/src/verbex/verbex.py @@ -19,15 +19,9 @@ except ImportError: from typing_extensions import Self -try: - from typing import ParamSpec - from typing import Protocol - -except ImportError: - from typing_extensions import ParamSpec - from typing_extensions import Protocol - from re import Pattern +from typing import ParamSpec +from typing import Protocol from typing import TypeVar from beartype import beartype @@ -184,7 +178,7 @@ def __str__(self) -> str: VerbexEscapedCharClassOrSpecial: TypeAlias = Union["Verbex", EscapedCharClassOrSpecial] -class Verbex: +class Verbex: # pylint: disable=too-many-public-methods """VerbalExpressions class. The following methods do not try to match the original js lib! diff --git a/tests/__init__.py b/tests/__init__.py index e69de29..aa0162f 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -0,0 +1 @@ +"""Unit tests for the Verbex package.""" diff --git a/tests/test_verbex.py b/tests/test_verbex.py index 9b7f81c..ca27a72 100644 --- a/tests/test_verbex.py +++ b/tests/test_verbex.py @@ -1,6 +1,7 @@ # pyright: reportPrivateUsage=false # flake8: noqa # type: ignore +# pylint: disable-all import re import unittest @@ -19,10 +20,10 @@ class verbexTest(unittest.TestCase): # # self.exp = None def test_should_render_verbex_as_string(self): - self.assertEqual(str(Verbex()._add("^$")), "^$") # noqa + self.assertEqual(str(Verbex()._add("^$")), "^$") def test_should_render_verbex_list_as_string(self): - self.assertEqual(str(Verbex()._add(["^", "[0-9]", "$"])), "^[0-9]$") # noqa + self.assertEqual(str(Verbex()._add(["^", "[0-9]", "$"])), "^[0-9]$") def test_should_match_characters_in_range(self): regex = Verbex().letter_range("a", "c").regex() @@ -45,14 +46,14 @@ def test_should_match_anything(self): regex = Verbex().anything().regex() self.assertIsNotNone(re.fullmatch(regex, "!@#$%¨&*()__+{}")) - def test_should_match_anything_but_specified_element_when_element_is_not_found( # noqa: E501 + def test_should_match_anything_but_specified_element_when_element_is_not_found( self, ): regex = Verbex().anything_but("X").find(" Files").regex() self.assertRegex("Y Files", regex) self.assertNotRegex("X Files", regex) - def test_should_not_match_anything_but_specified_element_when_specified_element_is_found( # noqa: E501 + def test_should_not_match_anything_but_specified_element_when_specified_element_is_found( self, ): regex = Verbex().anything_but("X").regex() From ff1d5a1e66a9526c8c3135efe7cb1112ddd54f04 Mon Sep 17 00:00:00 2001 From: "R. Broderick" Date: Sun, 28 Apr 2024 10:41:32 -0400 Subject: [PATCH 66/85] update readme --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1e7daa8..095148b 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ Verbex: Python verbal based regular expressions ================================================ -![Build Status](https://github.com/rbroderi/Verbex/actions/workflows/main.yml/badge.svg?event=push) -[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) + +[![Code style: black](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![PyPI license](https://img.shields.io/pypi/l/verbex)](https://www.gnu.org/licenses/gpl-3.0.en.html) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/verbex)](https://pypi.python.org/pypi/ansicolortags/) [![Generic badge](https://img.shields.io/badge/mypy-typed-purple.svg)](http://mypy-lang.org/) [![Generic badge](https://img.shields.io/badge/beartype-runtime_typed-cyan.svg)](https://github.com/beartype/beartype) [![Generic badge](https://img.shields.io/badge/bandit-checked-magenta.svg)](https://bandit.readthedocs.io/en/latest/) -[![Generic badge](https://img.shields.io/badge/flake8-linted-yellow.svg)](https://github.com/pycqa/flake8) +![Static Badge](https://img.shields.io/badge/:badgeContent) +![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Frbroderi%2FVerbex%2Fmaster%2Fpyproject.toml&query=%24.project.version&label=Version) + ## Installation ```bash From c898467ab50dde861017bc7735ed738470fd34b7 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 10:43:04 -0400 Subject: [PATCH 67/85] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 095148b..93ac4d8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ Verbex: Python verbal based regular expressions ================================================ - + [![Code style: black](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![PyPI license](https://img.shields.io/pypi/l/verbex)](https://www.gnu.org/licenses/gpl-3.0.en.html) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/verbex)](https://pypi.python.org/pypi/ansicolortags/) From 9436a14986b6afc33a0147a5b1fee2b615d7ae23 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 10:51:43 -0400 Subject: [PATCH 68/85] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 93ac4d8..0d3eb5f 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Verbex: Python verbal based regular expressions [![Generic badge](https://img.shields.io/badge/mypy-typed-purple.svg)](http://mypy-lang.org/) [![Generic badge](https://img.shields.io/badge/beartype-runtime_typed-cyan.svg)](https://github.com/beartype/beartype) [![Generic badge](https://img.shields.io/badge/bandit-checked-magenta.svg)](https://bandit.readthedocs.io/en/latest/) -![Static Badge](https://img.shields.io/badge/:badgeContent) +[![Generic badge](https://img.shields.io/badge/uv-requirements-yellow.svg)](https://shields.io/) ![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Frbroderi%2FVerbex%2Fmaster%2Fpyproject.toml&query=%24.project.version&label=Version) From 3433381bb25489afa9b47a7836ac9f1ed9993d86 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 10:54:21 -0400 Subject: [PATCH 69/85] Update gh_pages.yaml --- .github/workflows/gh_pages.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/gh_pages.yaml b/.github/workflows/gh_pages.yaml index ac6bda7..1a755b2 100644 --- a/.github/workflows/gh_pages.yaml +++ b/.github/workflows/gh_pages.yaml @@ -2,7 +2,7 @@ name: Deploy Sphinx documentation to Pages "on": push: - branches: [main] # branch to trigger deployment + branches: [master] # branch to trigger deployment jobs: pages: From d40c1eec980be4dc1de9904294450743b04e70b2 Mon Sep 17 00:00:00 2001 From: "R. Broderick" Date: Sun, 28 Apr 2024 10:58:49 -0400 Subject: [PATCH 70/85] update pypi workflow to publish --- .github/workflows/pypi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pypi.yaml b/.github/workflows/pypi.yaml index 241e314..0332979 100644 --- a/.github/workflows/pypi.yaml +++ b/.github/workflows/pypi.yaml @@ -36,7 +36,7 @@ jobs: runs-on: ubuntu-latest environment: name: pypi - url: https://pypi.org/project/protocol-implements-decorator/ # Replace with your PyPI project name + url: https://pypi.org/project/Verbex/ # Replace with your PyPI project name permissions: id-token: write # IMPORTANT: mandatory for trusted publishing From 18c63ac568b2b0e700508c0deb15dcd19cc7f3df Mon Sep 17 00:00:00 2001 From: "R. Broderick" Date: Sun, 28 Apr 2024 11:00:03 -0400 Subject: [PATCH 71/85] bump version --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 39d4525..8f8c570 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ requires = ["setuptools>=67.0", "wheel"] [project] authors = [{"name" = "R.Broderick"}] description = "Python verbal based regular expressions" -version = "2.0.0" +version = "2.0.1" license = {"file" = "LICENSE"} name = "verbex" readme = {file = "README.md", content-type = "text/markdown"} From b8c4fcab0cf1f8c3a35b42a27360a17dc56932cc Mon Sep 17 00:00:00 2001 From: "R. Broderick" Date: Sun, 28 Apr 2024 11:19:36 -0400 Subject: [PATCH 72/85] add classifiers --- pyproject.toml | 15 ++++++-- requirements.in | 3 -- requirements_dev.in | 5 --- requirements_dev.txt | 80 ------------------------------------------- requirements_test.txt | 4 --- 5 files changed, 13 insertions(+), 94 deletions(-) delete mode 100644 requirements.in delete mode 100644 requirements_dev.in delete mode 100644 requirements_dev.txt delete mode 100644 requirements_test.txt diff --git a/pyproject.toml b/pyproject.toml index 8f8c570..27a5520 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,12 +5,19 @@ requires = ["setuptools>=67.0", "wheel"] [project] authors = [{"name" = "R.Broderick"}] description = "Python verbal based regular expressions" -version = "2.0.1" +version = "2.0.2" license = {"file" = "LICENSE"} -name = "verbex" +name = "Verbex" readme = {file = "README.md", content-type = "text/markdown"} dependencies = ["beartype", "typing-extensions; python_version < '3.12'"] requires-python = ">=3.10.0" +classifiers = [ + "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12" +] [project.optional-dependencies] dev = [ @@ -46,6 +53,10 @@ docs = [ "sphinx-pyproject" ] +[project.urls] +homepage = "https://github.com/rbroderi/Verbex" +documentation = "https://rbroderi.github.io/Verbex/" + [tool.dapperdata] exclude_paths = [".venv", ".mypy_cache", ".git", ".vscode"] diff --git a/requirements.in b/requirements.in deleted file mode 100644 index 07ac3c6..0000000 --- a/requirements.in +++ /dev/null @@ -1,3 +0,0 @@ -beartype -typing-extensions -importlib-metadata; python_version < '3.7' diff --git a/requirements_dev.in b/requirements_dev.in deleted file mode 100644 index 31f1e1e..0000000 --- a/requirements_dev.in +++ /dev/null @@ -1,5 +0,0 @@ -tox -mypy>=0.950 -black -pre-commit -pdoc diff --git a/requirements_dev.txt b/requirements_dev.txt deleted file mode 100644 index ef02568..0000000 --- a/requirements_dev.txt +++ /dev/null @@ -1,80 +0,0 @@ -# -# This file is autogenerated by pip-compile with python 3.10 -# To update, run: -# -# pip-compile requirements_dev.in -# -black==22.3.0 - # via -r requirements_dev.in -cfgv==3.3.1 - # via pre-commit -click==8.1.3 - # via black -colorama==0.4.4 - # via - # click - # tox -distlib==0.3.4 - # via virtualenv -filelock==3.6.0 - # via - # tox - # virtualenv -identify==2.5.0 - # via pre-commit -jinja2==3.1.2 - # via pdoc -markupsafe==2.1.1 - # via - # jinja2 - # pdoc -mypy==0.950 - # via -r requirements_dev.in -mypy-extensions==0.4.3 - # via - # black - # mypy -nodeenv==1.6.0 - # via pre-commit -packaging==21.3 - # via tox -pathspec==0.9.0 - # via black -pdoc==11.2.0 - # via -r requirements_dev.in -platformdirs==2.5.2 - # via - # black - # virtualenv -pluggy==1.0.0 - # via tox -pre-commit==2.19.0 - # via -r requirements_dev.in -py==1.11.0 - # via tox -pygments==2.12.0 - # via pdoc -pyparsing==3.0.8 - # via packaging -pyyaml==6.0 - # via pre-commit -six==1.16.0 - # via - # tox - # virtualenv -toml==0.10.2 - # via - # pre-commit - # tox -tomli==2.0.1 - # via - # black - # mypy -tox==3.25.0 - # via -r requirements_dev.in -typing-extensions==4.2.0 - # via mypy -virtualenv==20.14.1 - # via - # pre-commit - # tox diff --git a/requirements_test.txt b/requirements_test.txt deleted file mode 100644 index 37fcfa7..0000000 --- a/requirements_test.txt +++ /dev/null @@ -1,4 +0,0 @@ -tox -typing-extensions -beartype -importlib-metadata; python_version < '3.7' From 75e672f72d8b8557102dcd306f0858a4bbba1f8d Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 11:35:46 -0400 Subject: [PATCH 73/85] Rename LICENSE.txt to LICENSE --- LICENSE.txt => LICENSE | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename LICENSE.txt => LICENSE (100%) diff --git a/LICENSE.txt b/LICENSE similarity index 100% rename from LICENSE.txt rename to LICENSE From df0e0e323d5ab2277a80f5559adda93948a83544 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 11:36:55 -0400 Subject: [PATCH 74/85] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0d3eb5f..d9add4d 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Verbex: Python verbal based regular expressions [![Code style: black](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) -[![PyPI license](https://img.shields.io/pypi/l/verbex)](https://www.gnu.org/licenses/gpl-3.0.en.html) +[![GitHub License](https://img.shields.io/github/license/rbroderi/Verbex)](https://raw.githubusercontent.com/rbroderi/Verbex/master/LICENSE) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/verbex)](https://pypi.python.org/pypi/ansicolortags/) [![Generic badge](https://img.shields.io/badge/mypy-typed-purple.svg)](http://mypy-lang.org/) [![Generic badge](https://img.shields.io/badge/beartype-runtime_typed-cyan.svg)](https://github.com/beartype/beartype) From 40b0bba1133c2cfb35696c13c9c586eccbbe3ee0 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 11:38:47 -0400 Subject: [PATCH 75/85] Update LICENSE --- LICENSE | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/LICENSE b/LICENSE index ba81a44..942046e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,4 @@ -Verbal Expressions -Copyright (C) 2022 Richard Broderick - - GNU GENERAL PUBLIC LICENSE + GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. From 209b4694b389f6482032c3cd859d36860b906de6 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 11:40:19 -0400 Subject: [PATCH 76/85] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index d9add4d..1e69064 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ Verbex: Python verbal based regular expressions [![Code style: black](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) -[![GitHub License](https://img.shields.io/github/license/rbroderi/Verbex)](https://raw.githubusercontent.com/rbroderi/Verbex/master/LICENSE) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/verbex)](https://pypi.python.org/pypi/ansicolortags/) [![Generic badge](https://img.shields.io/badge/mypy-typed-purple.svg)](http://mypy-lang.org/) [![Generic badge](https://img.shields.io/badge/beartype-runtime_typed-cyan.svg)](https://github.com/beartype/beartype) From 429f9b6ab7be349436e7edff802a018536424398 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 11:40:31 -0400 Subject: [PATCH 77/85] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 1e69064..b2a8762 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ Verbex: Python verbal based regular expressions ================================================ +[![GitHub License](https://img.shields.io/github/license/rbroderi/Verbex)](https://raw.githubusercontent.com/rbroderi/Verbex/master/LICENSE) [![Code style: black](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/verbex)](https://pypi.python.org/pypi/ansicolortags/) [![Generic badge](https://img.shields.io/badge/mypy-typed-purple.svg)](http://mypy-lang.org/) From a71bedccab2894cc90676066f40270464b06ddde Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 11:52:20 -0400 Subject: [PATCH 78/85] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b2a8762..0b061fb 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ Verbex: Python verbal based regular expressions ================================================ -[![GitHub License](https://img.shields.io/github/license/rbroderi/Verbex)](https://raw.githubusercontent.com/rbroderi/Verbex/master/LICENSE) +[![GitHub License](https://img.shields.io/github/license/rbroderi/Verbex)](https://github.com/rbroderi/Verbex/blob/master/LICENSE) [![Code style: black](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/verbex)](https://pypi.python.org/pypi/ansicolortags/) [![Generic badge](https://img.shields.io/badge/mypy-typed-purple.svg)](http://mypy-lang.org/) [![Generic badge](https://img.shields.io/badge/beartype-runtime_typed-cyan.svg)](https://github.com/beartype/beartype) [![Generic badge](https://img.shields.io/badge/bandit-checked-magenta.svg)](https://bandit.readthedocs.io/en/latest/) -[![Generic badge](https://img.shields.io/badge/uv-requirements-yellow.svg)](https://shields.io/) +[![Generic badge](https://img.shields.io/badge/uv-requirements-yellow.svg)](https://github.com/astral-sh/uv) ![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Frbroderi%2FVerbex%2Fmaster%2Fpyproject.toml&query=%24.project.version&label=Version) From 214583fb96d7d4ec40acd4269456621a8ec517b0 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 11:53:24 -0400 Subject: [PATCH 79/85] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0b061fb..5ff1bc3 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Verbex: Python verbal based regular expressions [![Generic badge](https://img.shields.io/badge/beartype-runtime_typed-cyan.svg)](https://github.com/beartype/beartype) [![Generic badge](https://img.shields.io/badge/bandit-checked-magenta.svg)](https://bandit.readthedocs.io/en/latest/) [![Generic badge](https://img.shields.io/badge/uv-requirements-yellow.svg)](https://github.com/astral-sh/uv) -![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Frbroderi%2FVerbex%2Fmaster%2Fpyproject.toml&query=%24.project.version&label=Version) +[![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Frbroderi%2FVerbex%2Fmaster%2Fpyproject.toml&query=%24.project.version&label=Version](https://github.com/rbroderi/Verbex/releases) ## Installation From f2088f91ec7b3277fc5c5c4a8f9893454bb01c60 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 11:53:46 -0400 Subject: [PATCH 80/85] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5ff1bc3..e206a76 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Verbex: Python verbal based regular expressions [![Generic badge](https://img.shields.io/badge/beartype-runtime_typed-cyan.svg)](https://github.com/beartype/beartype) [![Generic badge](https://img.shields.io/badge/bandit-checked-magenta.svg)](https://bandit.readthedocs.io/en/latest/) [![Generic badge](https://img.shields.io/badge/uv-requirements-yellow.svg)](https://github.com/astral-sh/uv) -[![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Frbroderi%2FVerbex%2Fmaster%2Fpyproject.toml&query=%24.project.version&label=Version](https://github.com/rbroderi/Verbex/releases) +[![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Frbroderi%2FVerbex%2Fmaster%2Fpyproject.toml&query=%24.project.version&label=Version)](https://github.com/rbroderi/Verbex/releases) ## Installation From 1cf8876f95bcf8c737da4520041177b518d471c5 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 12:04:05 -0400 Subject: [PATCH 81/85] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e206a76..bd587d8 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ Verbex: Python verbal based regular expressions ================================================ -[![GitHub License](https://img.shields.io/github/license/rbroderi/Verbex)](https://github.com/rbroderi/Verbex/blob/master/LICENSE) +[![Generic badge](https://img.shields.io/badge/license-GPL‐3.0-orange.svg)](https://github.com/rbroderi/Verbex/blob/master/LICENSE) + [![Code style: black](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/verbex)](https://pypi.python.org/pypi/ansicolortags/) [![Generic badge](https://img.shields.io/badge/mypy-typed-purple.svg)](http://mypy-lang.org/) From ff4b462cf9b2ae2bfc8d7a70490c1270ff25b80d Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 12:04:24 -0400 Subject: [PATCH 82/85] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bd587d8..d562698 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ Verbex: Python verbal based regular expressions ================================================ -[![Generic badge](https://img.shields.io/badge/license-GPL‐3.0-orange.svg)](https://github.com/rbroderi/Verbex/blob/master/LICENSE) +[![Generic badge](https://img.shields.io/badge/license-GPL‐3.0-orange.svg)](https://github.com/rbroderi/Verbex/blob/master/LICENSE) [![Code style: black](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/verbex)](https://pypi.python.org/pypi/ansicolortags/) [![Generic badge](https://img.shields.io/badge/mypy-typed-purple.svg)](http://mypy-lang.org/) From 90e4d49b955082ec71618306504abc1c8faacd7d Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 12:11:21 -0400 Subject: [PATCH 83/85] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d562698..57beb39 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Verbex: Python verbal based regular expressions [![Generic badge](https://img.shields.io/badge/license-GPL‐3.0-orange.svg)](https://github.com/rbroderi/Verbex/blob/master/LICENSE) [![Code style: black](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) -[![PyPI pyversions](https://img.shields.io/pypi/pyversions/verbex)](https://pypi.python.org/pypi/ansicolortags/) +[![PyPI pyversions](https://img.shields.io/pypi/pyversions/verbex)](https://pypi.python.org/pypi/Verbex/) [![Generic badge](https://img.shields.io/badge/mypy-typed-purple.svg)](http://mypy-lang.org/) [![Generic badge](https://img.shields.io/badge/beartype-runtime_typed-cyan.svg)](https://github.com/beartype/beartype) [![Generic badge](https://img.shields.io/badge/bandit-checked-magenta.svg)](https://bandit.readthedocs.io/en/latest/) From c0d2172257bcac5f9278e6c36328f7feaf3d35f0 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 12:21:23 -0400 Subject: [PATCH 84/85] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 57beb39..d2e3c47 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ verbex = Verbex() ``` ## Documentation -[API](https://rbroderi.github.io/Verbex/verbex/verbex.html) +[API](https://rbroderi.github.io/Verbex/) ## Examples ### Testing if we have a valid URL From 63f202793db4b53258ec86b11394aed432c415d0 Mon Sep 17 00:00:00 2001 From: rbroderi Date: Sun, 28 Apr 2024 12:22:03 -0400 Subject: [PATCH 85/85] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index d2e3c47..dc51965 100644 --- a/README.md +++ b/README.md @@ -68,8 +68,7 @@ print(result_re) ## Developer setup : running the tests ```bash -python setup.py develop -python setup.py test +just tests ``` ## Other implementations You can view all implementations on [VerbalExpressions.github.io](http://VerbalExpressions.github.io)

+ + +