flpc's Introduction

flpc: Lightning-Fast Python Regex

🚀 Supercharge your Python regex with Rust-powered performance!

🌟 Why flpc?

Being in experimental stage. The code structure and dependencies may change. If your project is using this. You will have to manually configure the migrations to latest versions.

flpc is a powerful Python library that wraps the blazing-fast Rust regex crate, bringing enhanced speed to your regular expression operations. It's designed to be a drop-in replacement for Python's native re module, with some minor syntax differences.

🚀 Quick Start

Install flpc:
```
pip install flpc
```
Use it in your code as shown in the API

🔧 API

flpc mirrors the re module's API, with a few small exceptions:

Use fmatch() instead of match() (to avoid conflicts with Python's keyword)
When using group() on a match object, always provide an index (e.g., group(0) for the entire match)

Common functions include:

compile()
search()
findall()
finditer()
split()
sub()
subn()

💡 Pro Tips

Pre-compile your patterns for faster execution
Use raw strings (r'') for cleaner regex patterns
Always check if a match is found before accessing groups
Remember to use group(0) to get the entire match

🤝 Contributing

We welcome contributions! Whether it's bug reports, feature requests, or code contributions, please feel free to reach out. Check our contribution guidelines to get started.

📄 License

flpc is open-source software licensed under the MIT license.

flpc's People

Contributors

Stargazers

Watchers

Forkers

bopo

flpc's Issues

add support for the regex-split crate to add split_inclusive functionality

In the python split if a capture group is used the split returns the split character in addition to the delimited tokens. The default rust regex crate does not do this. I believe this is used pretty extensively in python and would be a great add IMO.

Unexpected error in version 0.2.4

I just upgraded flpc from 0.2.1 to 0.2.4 in my python 3.11 environment and for this code:

text = "The fox jumps over the dog. Poor dog!"
pattern = flpc.compile(r'(\s|.|!)', flags=0)
matches_iter = flpc.finditer(pattern, text)
for match in matches_iter:
span_start = match.start(0)
span_end = match.end(0)
print(span_start, span_end)

I know get an error message:

PanicException Traceback (most recent call last)
Cell In [17], line 5
3 matches_iter = flpc.finditer(pattern, text)
4 for match in matches_iter:
----> 5 span_start = match.start(0)
6 span_end = match.end(0)
7 print(span_start, span_end)

PanicException: byte index 3 is out of bounds of

If I go back to 0.2.1 it's fine. Is there a dependency on my side I am not aware of?

itsmeadarsh2008 / flpc Goto Github PK