Py Idiomatic Regex (AKA iregex)
An easier way to write regex in Python using OOP instead of strings.
Makes the code much easier to read and understand while still using Regex under the hood.
Very easy to use, entirely contained within two files consts.py and regex.py.
Installation
pip install iregex
Examples
Imagine a regex to match variable names in most common languages.
They must start with an alphabetical character, then for the second character on they can contain numbers and underscores as well.
The regex for this would be:
[a-zA-Z][_\w]*
And in python you would compile this like so:
import re
re.compile(r"[a-zA-Z][_\w]*")
In this library the code would be:
from iregex import Regex
from iregex.consts import ALPHA, ALPHA_NUMERIC
(ALPHA + Regex().any_char("_", ALPHA_NUMERIC).zero_or_more_repetitions()).compile()
OR (Long, Functional form)
from iregex import Regex
from iregex.consts import ALPHA, ALPHA_NUMERIC
Regex(ALPHA).literal(
Regex().any_char("_", ALPHA_NUMERIC).zero_or_more_repetitions()
).compile()
Just take a look at the documentation for the Regex class to get an idea of all the methods you can use!
You chain methods together for sequential operations and nest literals for nested operations.
Contributions
Please make a contribution, this library is still growing!
Please download poetry and run poetry install to set up your build environment.
We use mypy (so be sure to type your code), flake8, and black so be sure to use pre-commit install before your first push to comply with git pre-commit standards. Otherwise your pull request will not make it past TravisCI.
Always pytest your code and make PR's with good code coverage.
249 Jan 2, 2023
1.3k Dec 22, 2022
260 Jan 1, 2023
36 Dec 9, 2022
8 Nov 25, 2022
48 Mar 7, 2022
12 Oct 20, 2022
12 Dec 5, 2022
60 Sep 26, 2022
19 Dec 27, 2022
35k Dec 31, 2022
32 Oct 10, 2022
0 Jun 2, 2022
57 Dec 16, 2022
3 Jan 1, 2023
5 Jun 25, 2021
324 Dec 27, 2022
1 Nov 12, 2021
259 Dec 13, 2022
12 Jan 8, 2023
185 Dec 29, 2022
7 Dec 13, 2021
16 Dec 1, 2022
2 Mar 3, 2022
78 Dec 27, 2022
1 Dec 24, 2021
18 Nov 15, 2021