Overview

The goal of reagex (from “readable regular expression”) is to suggest a way for writing complex regular expressions with many capturing groups in a readable way.

At the moment, it contains just one very simple function (called reagex) and an utility function, but any function which could be useful for writing readable patterns is welcome.

Note: Publishing this ridiculously small project is an excuse to familiarize with python packaging, DevOps tools and the entire workflow behind the publication of an open-source project. The project template was generated using https://github.com/ionelmc/cookiecutter-pylibrary/ which is obviously an overkill for a “one-function-project”.

Free software: BSD 2-Clause License

Usage

The core function reagex is just a wrapper of str.format and it works in the same way. See the example

import re
from reagex import reagex

# A sloppy pattern for an italian address (just to show how it works)
pattern = reagex(
    '{_address}, {postcode} {city} {province}',
    # groups starting with "_" are non-capturing
    _address = reagex(
        '{street} {number}',
        street = '(via|contrada|c/da|c[.]da|piazza|p[.]za|p[.]zza) [a-zA-Z]+',
        number = 'snc|[0-9]+'
    ),
    postcode = '[0-9]{5}',
    city = '[A-Za-z]+',
    province = '[A-Z]{2}'
)

matcher = re.compile(pattern)
match = matcher.fullmatch('via Roma 123, 12345 Napoli NA')
print(match.groupdict())

# prints:
#   {'city': 'Napoli',
#    'number': '123',
#    'postcode': '12345',
#    'province': 'NA',
#    'street': 'via Roma'}

Groups starting by '_' are non-capturing. The rest are all named capturing groups.

Why not…

Why not using just re.VERBOSE?

I think reagex is easier to write and to read:

with reagex, you first describe the structure of the pattern in terms of groups, then you provide a pattern for each group; with re.VERBOSE you have to define the groups in the exact position they must be matched: to get the high-level structure of the pattern you may need to read multiple lines at the same indentation level
with re.VERBOSE you just write a big string; with reagex you get syntax highlighting which helps readability
white-spaces don’t need any special treatment
“{group_name}” is nicer than “(?P<group_name>)”

Installation

pip install reagex

Documentation

https://python-reagex.readthedocs.io/

Development

Possible improvements:

make some meaningful use of the format_spec in {group_name:format_spec}
add utility functions like repeated to help writing common patterns in a readable way

Testing

To run all the tests:

tox

Note, to combine the coverage data from all the tox environments run:

Windows	set PYTEST_ADDOPTS=--cov-append tox
Other	PYTEST_ADDOPTS=--cov-append tox

Changelog

0.1.2 (2018-12-16)

Fix little mistake in the example (which is showed in PyPI, so a release was necessary to update the PyPI page).

0.1.1 (2018-12-12)

Minor fixes and modifications to documentation

0.1.0 (2018-12-08)

First release on PyPI.

Metadata

Release files for reagex 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for reagex 0.1.2
File	Size	Uploaded	Provenance
reagex-0.1.2.tar.gz	18.8 kB	Dec 16, 2018	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for reagex 0.1.2
File	Interpreter	ABI	Platform	Reset
reagex-0.1.2-py2.py3-none-any.whl 5.6 kB Dec 16, 2018 Without provenance	Python 2, Python 3	none	any	Details

Total release size: 24.4 kB

Release files / reagex-0.1.2.tar.gz

Download URL	reagex-0.1.2.tar.gz
Size	18.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`8d820d3b0bf2cc6fc14081d66d5deeff7a2cdd38a98851af04094f68fa2bdeaa`
BLAKE2b-256 checksum How to use checksums	`5343a02d3cf3f02b967c83ce8928fa463f6430fa4afff812a523fdf158422b54`
Upload date	Dec 16, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1`

Release files / reagex-0.1.2-py2.py3-none-any.whl

Download URL	reagex-0.1.2-py2.py3-none-any.whl
Size	5.6 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`44edb7325d04ede2889b2b64c80a06254bd75d24038868561c63b428ea5070b4`
BLAKE2b-256 checksum How to use checksums	`e4f9996cb53eee8082620b6184c3de91af56bc5e16919ca0229de481c86d2a01`
Upload date	Dec 16, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1`

Security for reagex 0.1.2

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.