Pyphen

Warnings

• breaking Pyphen regularly drops support for older Python versions. For instance, v0.17.0 dropped Python 3.8, v0.15.0 dropped 3.7, and v0.12.0 dropped 3.6. Ensure your Python environment meets the `requires_python` specification, which is currently `>=3.9`.
  Fix: Upgrade your Python environment to at least version 3.9 (or newer, as dictated by the specific Pyphen version you are using) to maintain compatibility. Check `requires_python` on PyPI or the official changelog for specific version requirements.
• gotcha Initializing a `Pyphen` instance, particularly with large dictionaries, can be a time-consuming operation, especially on resource-constrained devices like a Raspberry Pi Zero where it might take tens of seconds. The delay occurs during dictionary parsing and setup.
  Fix: Instantiate `Pyphen` once and reuse the object throughout your application rather than creating new instances repeatedly. Consider lazy loading if hyphenation is not immediately required.
• gotcha The correctness of hyphenation is dependent on the quality and rules of the underlying Hunspell dictionaries. Occasionally, certain words or language nuances might lead to unexpected hyphenation points or errors (e.g., specific issues reported for Polish or German words).
  Fix: For persistent issues with specific words or languages, it may be necessary to consult the upstream LibreOffice dictionaries or contribute fixes there. Pyphen itself uses these dictionaries without modification.
• deprecated Starting from version 0.15.0, Pyphen transitioned from `pkg_resources` to `importlib.resources` for resource management. While `pkg_resources` might still function in some older setups, it is officially deprecated in Python.
  Fix: If you are directly interacting with Pyphen's internal resource loading mechanisms (which is uncommon for typical usage), update your code to use `importlib.resources` for future compatibility. Standard usage `pyphen.Pyphen(lang='...')` is unaffected.

Install

• pip install pyphen Install stable version

Imports

• Pyphen

  from pyphen import Pyphen

  The primary class for creating a hyphenator instance.
• language_fallback

  import pyphen; pyphen.language_fallback(...)

  Utility function for language fallback logic, typically accessed via the module.
• LANGUAGES

  import pyphen; pyphen.LANGUAGES

  A dictionary containing available language codes and their dictionary paths, accessed via the module.

Quickstart

Initialize a `Pyphen` object for a desired language. The quickstart demonstrates basic hyphenation using `inserted()`, word wrapping with `wrap()`, and iterating through all possible hyphenation points with `iterate()`. It also shows how to check for available languages using `pyphen.LANGUAGES`. Dictionaries are automatically loaded upon instantiation.

import pyphen

# Instantiate Pyphen for a specific language (e.g., French)
dic = pyphen.Pyphen(lang='fr_FR')

# Check if a language is available
print(f"Is 'fr_FR' available? {'fr_FR' in pyphen.LANGUAGES}")

# Hyphenate a word, inserting hyphens
word = 'fromage'
hyphenated_word = dic.inserted(word)
print(f"'{word}' hyphenated: {hyphenated_word}") # Expected: 'fro-mage'

# Wrap a word to a certain width
long_word = 'autobandventieldopje'
wrapped_word = dic.wrap(long_word, 11)
print(f"'{long_word}' wrapped to 11 chars: {wrapped_word}") # Expected: ('autoband-', 'ventieldopje')

# Iterate over all possible hyphenation points
print(f"Hyphenation iterations for 'Amsterdam':")
for pair in dic.iterate('Amsterdam'):
    print(pair)