Internationalization extension for SQLAlchemy models.
- Stores translations in separate tables.
- Reflects translation table structures based on parent model table structure.
- Supports forcing of given locale.
- Good performance (uses proxy dicts and other advanced SQLAlchemy concepts for performance optimization)
Consider you have already defined SQLAlchemy connections and declarative base as follows:
import sqlalchemy as sa
from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
engine = create_engine(
'postgres://postgres@localhost/sqlalchemy_i18n'
)
Base = declarative_base()You only need to define two things, first you have to make the desired mapper translatable using make_translatable() function. Internally this function attaches two sqlalchemy event listeners for given mapper.
NOTICE: Calling make_translatable() for given mapper should happen only once per application.
from sqlalchemy_i18n import make_translatable
make_translatable(sa.orm.mapper)Secondly you need to define translatable models. You can achieve this by making you models extend Translatable mixin and defining __translated_columns__ class property.
class Article(Base, Translatable):
__translated_columns__ = [
sa.Column('name', sa.Unicode(255)),
sa.Column('content', sa.UnicodeText)
]
id = sa.Column(sa.Integer, autoincrement=True, primary_key=True)
description = sa.Column(sa.UnicodeText)