annotate babel/messages/mofile.py @ 250:194f927d8c5a

add a __cmp__ to Message that correctly sorts by id, taking into account plurals thanks zepolen
author pjenvey
date Mon, 13 Aug 2007 00:59:09 +0000
parents bf9579c4b0ee
children a7dff175b14f
rev   line source
162
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
1 # -*- coding: utf-8 -*-
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
2 #
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
3 # Copyright (C) 2007 Edgewall Software
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
4 # All rights reserved.
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
5 #
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
6 # This software is licensed as described in the file COPYING, which
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
7 # you should have received as part of this distribution. The terms
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
8 # are also available at http://babel.edgewall.org/wiki/License.
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
9 #
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
10 # This software consists of voluntary contributions made by many
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
11 # individuals. For the exact contribution history, see the revision
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
12 # history and logs, available at http://babel.edgewall.org/log/.
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
13
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
14 """Writing of files in the ``gettext`` MO (machine object) format.
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
15
236
bf9579c4b0ee Add more `since` tags to stuff added in trunk.
cmlenz
parents: 176
diff changeset
16 :since: version 0.9
162
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
17 :see: `The Format of MO Files
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
18 <http://www.gnu.org/software/gettext/manual/gettext.html#MO-Files>`_
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
19 """
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
20
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
21 import array
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
22 import struct
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
23
163
2faa5dc63068 Slightly simplified CLI-frontend class.
cmlenz
parents: 162
diff changeset
24 __all__ = ['write_mo']
2faa5dc63068 Slightly simplified CLI-frontend class.
cmlenz
parents: 162
diff changeset
25 __docformat__ = 'restructuredtext en'
2faa5dc63068 Slightly simplified CLI-frontend class.
cmlenz
parents: 162
diff changeset
26
162
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
27 def write_mo(fileobj, catalog, use_fuzzy=False):
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
28 """Write a catalog to the specified file-like object using the GNU MO file
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
29 format.
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
30
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
31 >>> from babel.messages import Catalog
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
32 >>> from gettext import GNUTranslations
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
33 >>> from StringIO import StringIO
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
34
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
35 >>> catalog = Catalog(locale='en_US')
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
36 >>> catalog.add('foo', 'Voh')
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
37 >>> catalog.add((u'bar', u'baz'), (u'Bahr', u'Batz'))
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
38 >>> catalog.add('fuz', 'Futz', flags=['fuzzy'])
174
aed3b2b06d19 Fix for #28 with updated doctest.
palgarvio
parents: 163
diff changeset
39 >>> catalog.add('Fizz', '')
176
b29bb8629a68 Extended the doctest to include tests for the fix on [176].
palgarvio
parents: 175
diff changeset
40 >>> catalog.add(('Fuzz', 'Fuzzes'), ('', ''))
162
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
41 >>> buf = StringIO()
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
42
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
43 >>> write_mo(buf, catalog)
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
44 >>> buf.seek(0)
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
45 >>> translations = GNUTranslations(fp=buf)
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
46 >>> translations.ugettext('foo')
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
47 u'Voh'
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
48 >>> translations.ungettext('bar', 'baz', 1)
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
49 u'Bahr'
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
50 >>> translations.ungettext('bar', 'baz', 2)
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
51 u'Batz'
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
52 >>> translations.ugettext('fuz')
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
53 u'fuz'
174
aed3b2b06d19 Fix for #28 with updated doctest.
palgarvio
parents: 163
diff changeset
54 >>> translations.ugettext('Fizz')
aed3b2b06d19 Fix for #28 with updated doctest.
palgarvio
parents: 163
diff changeset
55 u'Fizz'
176
b29bb8629a68 Extended the doctest to include tests for the fix on [176].
palgarvio
parents: 175
diff changeset
56 >>> translations.ugettext('Fuzz')
b29bb8629a68 Extended the doctest to include tests for the fix on [176].
palgarvio
parents: 175
diff changeset
57 u'Fuzz'
b29bb8629a68 Extended the doctest to include tests for the fix on [176].
palgarvio
parents: 175
diff changeset
58 >>> translations.ugettext('Fuzzes')
b29bb8629a68 Extended the doctest to include tests for the fix on [176].
palgarvio
parents: 175
diff changeset
59 u'Fuzzes'
162
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
60
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
61 :param fileobj: the file-like object to write to
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
62 :param catalog: the `Catalog` instance
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
63 :param use_fuzzy: whether translations marked as "fuzzy" should be included
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
64 in the output
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
65 """
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
66 messages = list(catalog)
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
67 if not use_fuzzy:
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
68 messages[1:] = [m for m in messages[1:] if not m.fuzzy]
250
194f927d8c5a add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 236
diff changeset
69 messages.sort()
162
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
70
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
71 ids = strs = ''
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
72 offsets = []
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
73
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
74 for message in messages:
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
75 # For each string, we need size and file offset. Each string is NUL
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
76 # terminated; the NUL does not count into the size.
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
77 if message.pluralizable:
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
78 msgid = '\x00'.join([
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
79 msgid.encode(catalog.charset) for msgid in message.id
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
80 ])
175
c223445fdb82 Forgot to fix the pluralizable messages, regarding #28.
palgarvio
parents: 174
diff changeset
81 msgstrs = []
c223445fdb82 Forgot to fix the pluralizable messages, regarding #28.
palgarvio
parents: 174
diff changeset
82 for idx, string in enumerate(message.string):
c223445fdb82 Forgot to fix the pluralizable messages, regarding #28.
palgarvio
parents: 174
diff changeset
83 if not string:
c223445fdb82 Forgot to fix the pluralizable messages, regarding #28.
palgarvio
parents: 174
diff changeset
84 msgstrs.append(message.id[idx])
c223445fdb82 Forgot to fix the pluralizable messages, regarding #28.
palgarvio
parents: 174
diff changeset
85 else:
c223445fdb82 Forgot to fix the pluralizable messages, regarding #28.
palgarvio
parents: 174
diff changeset
86 msgstrs.append(string)
162
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
87 msgstr = '\x00'.join([
175
c223445fdb82 Forgot to fix the pluralizable messages, regarding #28.
palgarvio
parents: 174
diff changeset
88 msgstr.encode(catalog.charset) for msgstr in msgstrs
162
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
89 ])
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
90 else:
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
91 msgid = message.id.encode(catalog.charset)
174
aed3b2b06d19 Fix for #28 with updated doctest.
palgarvio
parents: 163
diff changeset
92 if not message.string:
aed3b2b06d19 Fix for #28 with updated doctest.
palgarvio
parents: 163
diff changeset
93 msgstr = message.id.encode(catalog.charset)
aed3b2b06d19 Fix for #28 with updated doctest.
palgarvio
parents: 163
diff changeset
94 else:
aed3b2b06d19 Fix for #28 with updated doctest.
palgarvio
parents: 163
diff changeset
95 msgstr = message.string.encode(catalog.charset)
162
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
96 offsets.append((len(ids), len(msgid), len(strs), len(msgstr)))
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
97 ids += msgid + '\x00'
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
98 strs += msgstr + '\x00'
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
99
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
100 # The header is 7 32-bit unsigned integers. We don't use hash tables, so
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
101 # the keys start right after the index tables.
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
102 keystart = 7 * 4 + 16 * len(messages)
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
103 valuestart = keystart + len(ids)
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
104
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
105 # The string table first has the list of keys, then the list of values.
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
106 # Each entry has first the size of the string, then the file offset.
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
107 koffsets = []
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
108 voffsets = []
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
109 for o1, l1, o2, l2 in offsets:
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
110 koffsets += [l1, o1 + keystart]
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
111 voffsets += [l2, o2 + valuestart]
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
112 offsets = koffsets + voffsets
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
113
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
114 fileobj.write(struct.pack('Iiiiiii',
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
115 0x950412deL, # magic
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
116 0, # version
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
117 len(messages), # number of entries
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
118 7 * 4, # start of key index
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
119 7 * 4 + len(messages) * 8, # start of value index
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
120 0, 0 # size and offset of hash table
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents:
diff changeset
121 ) + array.array("i", offsets).tostring() + ids + strs)
Copyright (C) 2012-2017 Edgewall Software