File: quickstart.rst

package info (click to toggle)
sqlalchemy-i18n 1.1.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 396 kB
  • sloc: python: 2,164; makefile: 157
file content (59 lines) | stat: -rw-r--r-- 1,317 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
QuickStart
----------


In order to make your models use SQLAlchemy-i18n you need two things:

1. Assign get_locale function sqlalchemy_utils.i18n module. The following example shows how to do this using flask.ext.babel::


    import sqlalchemy_utils
    from flask.ext.babel import get_locale


    sqlalchemy_utils.i18n.get_locale = get_locale



2. Call make_translatable() before your models are defined.
3. Define translation model and make it inherit mixin provided by translation_base function


::


    import sqlalchemy as sa

    from sqlalchemy_i18n import (
        make_translatable,
        translation_base,
        Translatable,
    )


    make_translatable(options={'locales': ['fi', 'en']})


    class Article(Translatable, Base):
        __tablename__ = 'article'
        __translatable__ = {'locales': ['fi', 'en']}

        locale = 'en'  # this defines the default locale

        id = sa.Column(sa.Integer, primary_key=True, autoincrement=True)
        author = sa.Column(sa.Unicode(255))


    class ArticleTranslation(translation_base(Article)):
        __tablename__ = 'article_translation'

        name = sa.Column(sa.Unicode(255))

        content = sa.Column(sa.UnicodeText)


    article = Article()
    article.name = u'Some article'

    session.add(article)
    session.commit()