rtfunicode

2.3 · active · verified Thu Apr 16

rtfunicode is a Python library (version 2.3) that provides an encoder for Unicode to RTF 1.5 command sequences. It allows for generating valid RTF output that includes international characters by registering a new `rtfunicode` codec, which can then be used directly with `str.encode()`. The library is actively maintained, with a focus on modern Python versions.

Common errors

```
LookupError: unknown encoding: rtfunicode
```
cause The 'rtfunicode' codec is not registered. This occurs when the `rtfunicode` module has not been imported.

fix Add `import rtfunicode` at the beginning of your script. Importing the module registers the codec.
```
ERROR: Package 'rtfunicode' requires Python '>=3.10' but the running Python is 3.9.x
```
cause Attempting to install `rtfunicode` version 2.1 or newer on a Python environment older than 3.10.

fix Upgrade your Python environment to 3.10 or newer. Alternatively, install a compatible older version like `pip install rtfunicode==2.2` for Python 3.9.
```
SyntaxError: invalid syntax (when running code from rtfunicode)
```
cause rtfunicode versions 2.1+ utilize modern Python syntax (e.g., type annotations) compatible with Python 3.10+. Running these versions on older Python interpreters will result in syntax errors.

fix Ensure your Python environment is 3.10 or newer when using rtfunicode versions 2.1+. Upgrade Python if necessary.

Warnings

breaking rtfunicode version 2.3 dropped support for Python 3.9. Users on Python 3.9 must use `rtfunicode==2.2` or upgrade their Python environment.
Fix: Upgrade Python to 3.10+ or install `pip install rtfunicode==2.2` for Python 3.9.
breaking rtfunicode version 2.1 and later require Python 3.10 or newer. Earlier versions (pre-2.1) supported Python 3.3-3.9. Attempting to install or run v2.1+ on Python versions older than 3.10 will fail.
Fix: Ensure your Python environment is 3.10 or newer. If legacy Python is required, use `rtfunicode<2.1`.
gotcha In version 2.1, rtfunicode was converted from a single module to a package. While the primary `import rtfunicode` remains functional, any tools or custom setups relying on `rtfunicode.py` as a direct file or internal module paths might require adjustments.
Fix: Verify that custom tooling or internal module references are compatible with the package structure. The main usage (`import rtfunicode`) is unaffected.
gotcha The RTF standard uses `\uN?` where `N` is a signed 16-bit integer and `?` is a placeholder for older RTF readers. rtfunicode consistently sets this placeholder to `'?'`. If strict compliance with specific RTF readers requires a different fallback character (e.g., `\uN\'` plus a hex value), post-processing might be needed.
Fix: Be aware of the fixed placeholder. For specific fallback character requirements, inspect the RTF output and implement post-processing if necessary.

Install

pip install rtfunicode Install latest version

Imports

rtfunicode
```
import rtfunicode
```
Importing the rtfunicode module registers the 'rtfunicode' codec, making it available for string encoding.

Quickstart

This quickstart demonstrates how to import `rtfunicode` to register its codec, and then use the `encode('rtfunicode')` method on a standard Python string to convert Unicode characters into their RTF 1.5 command sequences.

import rtfunicode

# Encode a Unicode string to RTF using the 'rtfunicode' codec
unicode_string = 'Hello, RTF and unicode mix just fine! \u263A'
rtf_output = unicode_string.encode('rtfunicode')

print(f"Original Unicode: {unicode_string}")
print(f"Encoded RTF: {rtf_output!r}")

# The output includes the \uN? sequence for Unicode characters
# For example, \u263A (smiling face) becomes \u9786? (N=9786 in signed 16-bit int)
assert rtf_output == b'Hello, RTF and unicode mix just fine! \\u9786?'

view raw JSON →