Unicode RBNF

A pure Python implementation of rule based number formatting (RBNF) using the Unicode Common Locale Data Repository (CLDR).

This lets you spell out numbers for a large number of locales:

from unicode_rbnf import RbnfEngine

engine = RbnfEngine.for_language("en")
assert engine.format_number(1234).text == "one thousand two hundred thirty-four"

Different formatting purposes are supported as well, depending on the locale:

from unicode_rbnf import RbnfEngine, FormatPurpose

engine = RbnfEngine.for_language("en")
assert engine.format_number(1999, FormatPurpose.CARDINAL).text == "one thousand nine hundred ninety-nine"
assert engine.format_number(1999, FormatPurpose.YEAR).text == "nineteen ninety-nine"
assert engine.format_number(11, FormatPurpose.ORDINAL).text == "eleventh"

For locales with multiple genders, cases, etc., the different texts are accessible in the result of format_number:

from unicode_rbnf import RbnfEngine

engine = RbnfEngine.for_language("de")
print(engine.format_number(1))

Result:

FormatResult(
  text='eins',
  text_by_ruleset={
    'spellout-numbering': 'eins',
    'spellout-cardinal-neuter': 'ein',
    'spellout-cardinal-masculine': 'ein',
    'spellout-cardinal-feminine': 'eine',
    'spellout-cardinal-n': 'einen',
    'spellout-cardinal-r': 'einer',
    'spellout-cardinal-s': 'eines',
    'spellout-cardinal-m': 'einem'
  }
)

The text property of the result holds the text of the ruleset with the shortest name (least specific).

Supported locales

See: https://github.com/unicode-org/cldr/tree/release-44/common/rbnf

Engine implementation

Not all features of the RBNF engine are implemented. The following features are available:

Literal text (hundred)
Quotient substitution (<< or ←←)
Reminder substitution (>> or →→)
Optional substitution ([...])
Rule substituton (←%ruleset_name←)
Rule replacement (=%ruleset_name=)
Special rules:
- Negative numbers (-x)
- Improper fractions (x.x)
- Not a number (NaN)
- Infinity (Inf)

Some features that will need to be added eventually:

Proper fraction rules (0.x)
Preceding reminder substitution (>>> or →→→)
Number format strings (==)
Decimal format patterns (#,##0.00)
Plural replacements ($(ordinal,one{st}...))

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unicode_rbnf-2.4.0.tar.gz (89.1 kB view details)

Uploaded Oct 7, 2025 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

unicode_rbnf-2.4.0-py3-none-any.whl (141.7 kB view details)

Uploaded Oct 7, 2025 Python 3

File details

Details for the file unicode_rbnf-2.4.0.tar.gz.

File metadata

Download URL: unicode_rbnf-2.4.0.tar.gz
Upload date: Oct 7, 2025
Size: 89.1 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for unicode_rbnf-2.4.0.tar.gz
Algorithm	Hash digest
SHA256	`6d2f12a7581c69ea6218ee61fafcd2da46e1f9986bdcd0964c5151f7c2a938ac`
MD5	`c2f0d56cc18fa79f064fd58f17ecdb00`
BLAKE2b-256	`571fd952ba97832647e608700c36b22d1c4476016076c9ed1ce74ae814bea55a`

See more details on using hashes here.

Provenance

The following attestation bundles were made for unicode_rbnf-2.4.0.tar.gz:

Publisher: publish.yml on rhasspy/unicode-rbnf

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: unicode_rbnf-2.4.0.tar.gz
- Subject digest: 6d2f12a7581c69ea6218ee61fafcd2da46e1f9986bdcd0964c5151f7c2a938ac
- Sigstore transparency entry: 590958380
- Sigstore integration time: Oct 7, 2025
Source repository:
- Permalink: rhasspy/unicode-rbnf@e117d4b74a09b094509e836ee3294a6680be26ee
- Branch / Tag: refs/tags/v2.4.0
- Owner: https://github.com/rhasspy
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@e117d4b74a09b094509e836ee3294a6680be26ee
- Trigger Event: push