Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 2.33 KB

README.md

File metadata and controls

62 lines (41 loc) · 2.33 KB
flpc logo

flpc: Lightning-Fast Python Regex

Star PyPI - Implementation GitHub Issues PyPI - Downloads GitHub License GitHub last commit

🚀 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

  1. Install flpc:

    pip install flpc
    
  2. 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.