Skip to main content

A fast and efficient library for fixing contractions in text

Project description

Contraction Fix

A fast and efficient library for fixing contractions in text. This package provides tools to expand contractions in English text while maintaining high performance and accuracy.

Features

  • Fast text processing using precompiled regex patterns
  • Support for standard contractions, informal contractions, and internet slang
  • Configurable dictionary usage
  • Caching for improved performance
  • Preview functionality to see contractions before fixing
  • Easy addition and removal of custom contractions

Installation

pip install contraction-fix

Usage

Basic Usage

from contraction_fix import fix

text = "I can't believe it's not butter!"
fixed_text = fix(text)
print(fixed_text)  # "I cannot believe it is not butter!"

Advanced Usage

from contraction_fix import ContractionFixer

# Create a custom fixer instance
fixer = ContractionFixer(use_informal=True, use_slang=False)

# Fix text
text = "I'd like to see y'all tomorrow"
fixed_text = fixer.fix(text)
print(fixed_text)  # "I would like to see you all tomorrow"

# Preview contractions
matches = fixer.preview(text, context_size=5)
for match in matches:
    print(f"Found '{match['match']}' at position {match['start']}")
    print(f"Context: '{match['context']}'")
    print(f"Will be replaced with: '{match['replacement']}'")

# Add custom contraction
fixer.add_contraction("gonna", "going to")

# Remove contraction
fixer.remove_contraction("won't")

Dictionary Types

The package uses three types of dictionaries:

  1. Standard Contractions: Common English contractions like "can't", "won't", etc.
  2. Informal Contractions: Less formal contractions and patterns like "goin'", "doin'", etc.
  3. Internet Slang: Modern internet slang and abbreviations like "lol", "btw", etc.

Performance

The package is optimized for speed through:

  • Precompiled regex patterns
  • LRU caching of results
  • Efficient dictionary lookups
  • Minimal memory usage

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

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

Source Distribution

contraction_fix-0.1.1.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

contraction_fix-0.1.1-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file contraction_fix-0.1.1.tar.gz.

File metadata

  • Download URL: contraction_fix-0.1.1.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for contraction_fix-0.1.1.tar.gz
Algorithm Hash digest
SHA256 84ddc991dea99a2ad2455ecb21c7b143c28f2cf90f1d7b4e9ff4422f4e307d95
MD5 75a552f80d27ff37d41cdcf34ed7ac06
BLAKE2b-256 33d083a7deeea408089c5e21685e6e79072c7f83427ee2c10eacfd2fe89aa79f

See more details on using hashes here.

File details

Details for the file contraction_fix-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for contraction_fix-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5634e156546df0ead405dd194b1c0b932e5e6e307b81bbc3b848f990b1f17afe
MD5 f376280c5869b2508089c29e00fb8c78
BLAKE2b-256 4b3cae7432fe8fe38293bbeccf61a8381c8856cde775ebf48332c8d88a94a9e3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page