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.2.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.2-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: contraction_fix-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 e693289d2c84c10935408579d53d48998fbd9fee5447300a3871cd71291d7cb6
MD5 e65a9ee3e41a980b5b0fc0008b6dd892
BLAKE2b-256 dc993d39a3bc41461d73133fac55c2f3e34bc99cf1b026caec3e1116b7ec2458

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for contraction_fix-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 55dcd6ad17cc022ba328ac403150a2402596562223fe5b4fe6301e6eee38b366
MD5 dcfba0ad9e0f1442ac4abc6ba9175298
BLAKE2b-256 2a5b84207885ebf017f0b1a3ae5f0b5984f0a33520f40be8d91b5a86e238a62a

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