annotate babel/messages/mofile.py @ 173:743abd4ca3c3

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