fastapi-easy-i18n 1.0.3

Простой и быстрый i18n для FastAPI без внешних зависимостей

FastAPI Easy i18n

🇷🇺 Русский | 🇬🇧 English

A simple, fast, and fully independent internationalization (i18n) library for FastAPI.

Add multilingual support to your project in just a few minutes. No heavy libraries — only pure Python and an intuitive API.

💡 Features

• 🔧 Minimal setup
• ⚡ Fast access to translations
• 🌍 Global and local locale setting
• 📝 String parameter support
• 📦 No external dependencies

---

📥 Installation

pip install fastapi-easy-i18n

🚀 Usage

Basic example

from fastapi_easy_i18n import t, set_locale

set_locale('en')
print(t('common.hello'))  # → Hello!

🌐 Locale Management

Sett a global locale

The default use locale 'ru'.

set_locale('it')
print(get_locale())  # → 'it'

set_locale('fr')
print(get_locale())  # → 'fr'

Arguments:

• locale: locale code ('ru', 'en', 'it', 'de', 'fr', ...)

---

Get the current locale

print(get_locale())  # → 'ru'
set_locale('en')
print(get_locale())  # → 'en'

---

Temp locale (context manager)

Used for temporarily changing the locale within a block:

with locale_context('en'):
    print(t('common.hello'))  # → Hello!

# after exiting, the locale is restored automatically

---

✨ Translation Functions

Translates a message for the selected locale.

t(key, params=None, locale=None)

# alias
_(key, params=None, locale=None)

Parameters:

• key — key in the format "file.key" For example: "pagination.next", "errors.not_found"
• params — dictionary of parameters for string formatting For example: {'name': 'Alice'}
• locale — locale for this specific call (optional)

Examples:

t('pagination.next')
# → 'вперёд'

t('common.greeting', {'name': 'Alice'})
# → 'Привет, Alice!'

_('pagination.next', locale='en')
# → 'next'

_('unknown.key')
# → 'unknown.key'

---

📁 Translation File Structure

Create the following directory structure in your project to store translation files:

your_fastapi_project/
└── app/
    └── core/
        └── i18n/
            ├── en/
            │   ├── common.json
            │   ├── errors.json
            │   └── pagination.json
            └── ru/
                ├── common.json
                ├── errors.json
                └── pagination.json

If your application architecture is different, you can choose any directory to store translation files.

Simply inform the library about it by calling the set_patch('patch') method, for example:

set_path('backend/app/core')               # add to search paths
set_path('backend/app/core', replace=True) # replace all paths

---