Oven logo

Oven

google-re21.1.20240702

Published

RE2 Python bindings

pip install google-re2

Package Downloads

Weekly DownloadsMonthly Downloads

Project URLs

Requires Python

~=3.8

Dependencies

    A drop-in replacement for the re module.
    
    It uses RE2 under the hood, of course, so various PCRE features
    (e.g. backreferences, look-around assertions) are not supported.
    See https://github.com/google/re2/wiki/Syntax for the canonical
    reference, but known syntactic "gotchas" relative to Python are:
    
      * PCRE supports \Z and \z; RE2 supports \z; Python supports \z,
        but calls it \Z. You must rewrite \Z to \z in pattern strings.
    
    Known differences between this module's API and the re module's API:
    
      * The error class does not provide any error information as attributes.
      * The Options class replaces the re module's flags with RE2's options as
        gettable/settable properties. Please see re2.h for their documentation.
      * The pattern string and the input string do not have to be the same type.
        Any str will be encoded to UTF-8.
      * The pattern string cannot be str if the options specify Latin-1 encoding.
    
    Known issues with regard to building the C++ extension:
    
      * Building requires RE2 to be installed on your system.
        On Debian, for example, install the libre2-dev package.
      * Building requires pybind11 to be installed on your system OR venv.
        On Debian, for example, install the pybind11-dev package.
        For a venv, install the pybind11 package from PyPI.
      * Building on macOS is known to work, but has been known to fail.
        For example, the system Python may not know which compiler flags
        to set when building bindings for software installed by Homebrew;
        see https://docs.brew.sh/Homebrew-and-Python#brewed-python-modules.
      * Building on Windows has not been tested yet and will probably fail.