Skip to main content

python cffi bindings for the oniguruma regex engine

Project description

Build Status Azure DevOps coverage

onigurumacffi

python cffi bindings for the oniguruma regex engine

installation

pip install onigurumacffi
  • wheels should be available on pypi in most cases
  • to build from source, libonig-dev must be installed prior to installation

api

the api is currently very limited (basically just enough to support what I needed).

compile(pattern: str) -> _Pattern

make a compiled pattern

compile_regset(*patterns: str) -> _RegSet

make a compiled RegSet

OnigSearchOption

an enum listing the search-time options for oniguruma

the current set of options are:

class OnigSearchOption(enum.IntEnum):
    NONE = ...
    NOTBOL = ...
    NOTEOL = ...
    POSIX_REGION = ...
    CHECK_VALIDITY_OF_STRING = ...
    NOT_BEGIN_STRING = ...
    NOT_BEGIN_POSITION = ...

_Pattern.match(s: str, start: int = 0, flags: OnigSearchOption = OnigSearchOption.NONE) -> Optional[_Match]

match a string using the pattern. optionally set start to adjust the offset which is searched from

_Pattern.search(s: str, start: int = 0, flags: OnigSearchOption = OnigSearchOption.NONE) -> Optional[_Match]

search a string using the pattern. optionally set start to adjust the offset which is searched from

_Pattern.number_of_captures() -> int

return the number of captures in the regex

_RegSet.search(s: str, start: int = 0, flags: OnigSearchOption = OnigSearchOption.NONE) -> Tuple[int, Optional[_Match]]

search a string using the RegSet. optionally set start to adjust the offset which is searched from

the leftmost regex index and match is returned or (-1, None) if there is no match

_Match.group(n: int = 0) -> str

return the string of the matched group, defaults to 0 (the whole match)

_Match[n: int] -> str

a shorthand alias for _Match.group(...)

_Match.start(n: int = 0) -> int

return the character position of the start of the matched group, defaults to 0 (the whole match)

_Match.end(n: int = 0) -> int

return the character position of the end of the matched group, defaults to 0 (the whole match)

_Match.span(n: int = 0) -> int

return (start, end) character position of the matched group, defaults to 0 (the whole match)

_Match.expand(s: str) -> str

expand numeric groups in s via the groups in the match

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for onigurumacffi, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size onigurumacffi-1.0.0-cp36-abi3-macosx_10_14_x86_64.whl (221.9 kB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size onigurumacffi-1.0.0-cp36-abi3-manylinux1_x86_64.whl (529.8 kB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size onigurumacffi-1.0.0-cp36-abi3-win32.whl (166.6 kB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size onigurumacffi-1.0.0-cp36-abi3-win_amd64.whl (183.4 kB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size onigurumacffi-1.0.0-pp36-pypy36_pp73-manylinux1_x86_64.whl (560.2 kB) File type Wheel Python version pp36 Upload date Hashes View
Filename, size onigurumacffi-1.0.0-pp36-pypy36_pp73-manylinux2010_x86_64.whl (560.2 kB) File type Wheel Python version pp36 Upload date Hashes View
Filename, size onigurumacffi-1.0.0-pp37-pypy37_pp73-manylinux1_x86_64.whl (560.2 kB) File type Wheel Python version pp37 Upload date Hashes View
Filename, size onigurumacffi-1.0.0-pp37-pypy37_pp73-manylinux2010_x86_64.whl (560.2 kB) File type Wheel Python version pp37 Upload date Hashes View
Filename, size onigurumacffi-1.0.0.tar.gz (5.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page