Comprehensive Guide to Pyphen Enhancing Your Applications with Hyphenation

Introduction to Pyphen

Pyphen is a pure Python library used to hyphenate words according to the hyphenation rules of a specific language. Suitable for applications that require text formatting, text-to-speech, or any other tasks where hyphenation might prove useful.

Installation

pip install pyphen

Basic Usage

Below is a quick example of how to use Pyphen to hyphenate words:

import pyphen

dic = pyphen.Pyphen(lang='en')
word = 'hyphenation'
hyphenated_word = dic.inserted(word)
print(hyphenated_word)  # Output: hy-phen-a-tion

API Examples

Loading Dictionaries

You can load dictionaries for different languages:

dic_en = pyphen.Pyphen(lang='en')
dic_fr = pyphen.Pyphen(lang='fr')

Hyphenating Text

Hyphenate an entire paragraph of text:

text = 'This is an example of hyphenated text.'
hyphenated_text = ' '.join([dic.inserted(word) for word in text.split()])
print(hyphenated_text)

Customizing Hyphenation Pattern

You can customize the hyphenation pattern used for your text:

custom_patterns = {'1en2':'1-2'}
dic_custom = pyphen.Pyphen(lang='en', left=2, right=2, custom=custom_patterns)

Advanced Example

Here’s an advanced example of using Pyphen in a simple text formatting application that hyphenates words in a given text:

import pyphen
import textwrap

def hyphenate_text(text: str, lang: str = 'en', width: int = 50) -> str:
 dic = pyphen.Pyphen(lang=lang)
 words = text.split()
 hyphenated_words = [dic.inserted(word) for word in words]
 hyphenated_text = ' '.join(hyphenated_words)
 wrapped_text = '\n'.join(textwrap.wrap(hyphenated_text, width=width))
 return wrapped_text

sample_text = 'Pyphen is a powerful library for hyphenating text in different languages.'
print(hyphenate_text(sample_text))

In this example, the hyphenate_text function hyphenates and formats the input text so that it fits within a specified width.

Hash: fb362a7deb585b4b1b1ee5e40459e3eb6b522c8b03915993dfbc7502b9d1b31d