No project description provided

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for krakentechnologies from gravatar.com krakentechnologies

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License
  • Requires: Python >=3.11
Classifiers
Report project as malware

Project description

rustfluent

A Python interface to the Rust Fluent Library.

This project is a small shim around fluent-rs, so it can be used from Python.

[!WARNING] This package is under active development, and breaking changes may be released at any time. Be sure to pin to specific versions if you're using this package in a production environment.

Prerequisites

This package supports:

  • Python 3.11
  • Python 3.12

Installation

pip install rustfluent

Usage

import rustfluent

# First load a bundle
bundle = rustfluent.Bundle(
    "en",
    [
        # Multiple FTL files can be specified. Entries in later
        # files overwrite earlier ones.
        "en.ftl",
    ],
)

# Fetch a translation
assert bundle.get_translation("hello-world") == "Hello World"

# Fetch a translation that includes variables
assert bundle.get_translation("hello-user", variables={"user": "Bob"}) == "Hello, \u2068Bob\u2069"

The Unicode characters around "Bob" in the above example are for Unicode bidirectional handling.

API reference

Bundle class

A set of translations for a specific language.

import rustfluent

bundle = rustfluent.Bundle(
    language="en-US",
    ftl_files=[
        "/path/to/messages.ftl",
        "/path/to/more/messages.ftl",
    ],
)

Parameters

Name Type Description
language str Unicode Language Identifier for the language.
ftl_files list[str] Full paths to the FTL files containing the translations. Entries in later files overwrite earlier ones.
strict bool, optional In strict mode, a ParserError will be raised if there are any errors in the file. In non-strict mode, invalid Fluent messages will be excluded from the Bundle.

Raises

  • FileNotFoundError if any of the FTL files could not be found.
  • rustfluent.ParserError if any of the FTL files contain errors (strict mode only).

Bundle.get_translation

>>> bundle.get_translation(identifier="hello-world")
"Hello, world!"
>>> bundle.get_translation(identifier="hello-user", variables={"user": "Bob"})
"Hello, Bob!"

Parameters

Name Type Description
identifier str The identifier for the Fluent message.
variables `dict[str, str int ]`, optional

Return value

str: the translated message.

Raises

  • ValueError if the message could not be found or has no translation available.
  • TypeError if a passed variable is not an instance of str or int, or if the int overflows a signed long integer (i.e. it's not in the range -2,147,483,648 to 2,147,483,647).

Contributing

See Contributing.

Supported by

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