annotate babel/messages/catalog.py @ 335:355a977c92aa

Change Catalog class to retain the plural forms set in the MIME headers.
author cmlenz
date Tue, 10 Jun 2008 16:57:15 +0000
parents 654b632e5482
children 662d332c0a2b
rev   line source
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
1 # -*- coding: utf-8 -*-
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
2 #
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
3 # Copyright (C) 2007 Edgewall Software
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
4 # All rights reserved.
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
5 #
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
6 # This software is licensed as described in the file COPYING, which
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
7 # you should have received as part of this distribution. The terms
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
8 # are also available at http://babel.edgewall.org/wiki/License.
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
9 #
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
10 # This software consists of voluntary contributions made by many
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
11 # individuals. For the exact contribution history, see the revision
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
12 # history and logs, available at http://babel.edgewall.org/log/.
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
13
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
14 """Data structures for message catalogs."""
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
15
151
12e5f21dfcda Respect charset specified in PO headers in `read_po()`. Fixes #17.
cmlenz
parents: 133
diff changeset
16 from cgi import parse_header
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
17 from datetime import datetime
167
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
18 from difflib import get_close_matches
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
19 from email import message_from_string
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
20 import re
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
21 try:
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
22 set
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
23 except NameError:
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
24 from sets import Set as set
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
25 import time
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
26
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
27 from babel import __version__ as VERSION
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
28 from babel.core import Locale
133
9d58665d134c Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows.
cmlenz
parents: 123
diff changeset
29 from babel.dates import format_datetime
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
30 from babel.messages.plurals import PLURALS
229
85340bec3a97 Fix tests broken by [233], and add new tests.
cmlenz
parents: 228
diff changeset
31 from babel.util import odict, distinct, LOCALTZ, UTC, FixedOffsetTimezone
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
32
222
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
33 __all__ = ['Message', 'Catalog', 'TranslationError']
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
34 __docformat__ = 'restructuredtext en'
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
35
231
fc8b8c2bba53 Remove duplicate locations of catalog messages.
cmlenz
parents: 230
diff changeset
36 PYTHON_FORMAT = re.compile(r'\%(\([\w]+\))?([-#0\ +])?(\*|[\d]+)?'
fc8b8c2bba53 Remove duplicate locations of catalog messages.
cmlenz
parents: 230
diff changeset
37 r'(\.(\*|[\d]+))?([hlL])?[diouxXeEfFgGcrs]')
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
38
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
39
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
40 class Message(object):
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
41 """Representation of a single message in a catalog."""
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
42
151
12e5f21dfcda Respect charset specified in PO headers in `read_po()`. Fixes #17.
cmlenz
parents: 133
diff changeset
43 def __init__(self, id, string=u'', locations=(), flags=(), auto_comments=(),
222
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
44 user_comments=(), previous_id=(), lineno=None):
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
45 """Create the message object.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
46
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
47 :param id: the message ID, or a ``(singular, plural)`` tuple for
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
48 pluralizable messages
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
49 :param string: the translated message string, or a
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
50 ``(singular, plural)`` tuple for pluralizable messages
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
51 :param locations: a sequence of ``(filenname, lineno)`` tuples
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
52 :param flags: a set or sequence of flags
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
53 :param auto_comments: a sequence of automatic comments for the message
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
54 :param user_comments: a sequence of user comments for the message
205
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
55 :param previous_id: the previous message ID, or a ``(singular, plural)``
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
56 tuple for pluralizable messages
222
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
57 :param lineno: the line number on which the msgid line was found in the
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
58 PO file, if any
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
59 """
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
60 self.id = id #: The message ID
70
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
61 if not string and self.pluralizable:
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
62 string = (u'', u'')
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
63 self.string = string #: The message translation
231
fc8b8c2bba53 Remove duplicate locations of catalog messages.
cmlenz
parents: 230
diff changeset
64 self.locations = list(distinct(locations))
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
65 self.flags = set(flags)
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
66 if id and self.python_format:
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
67 self.flags.add('python-format')
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
68 else:
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
69 self.flags.discard('python-format')
229
85340bec3a97 Fix tests broken by [233], and add new tests.
cmlenz
parents: 228
diff changeset
70 self.auto_comments = list(distinct(auto_comments))
85340bec3a97 Fix tests broken by [233], and add new tests.
cmlenz
parents: 228
diff changeset
71 self.user_comments = list(distinct(user_comments))
205
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
72 if isinstance(previous_id, basestring):
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
73 self.previous_id = [previous_id]
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
74 else:
205
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
75 self.previous_id = list(previous_id)
222
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
76 self.lineno = lineno
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
77
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
78 def __repr__(self):
198
982d7e704fdc Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 190
diff changeset
79 return '<%s %r (flags: %r)>' % (type(self).__name__, self.id,
982d7e704fdc Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 190
diff changeset
80 list(self.flags))
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
81
250
194f927d8c5a add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 231
diff changeset
82 def __cmp__(self, obj):
194f927d8c5a add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 231
diff changeset
83 """Compare Messages, taking into account plural ids"""
194f927d8c5a add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 231
diff changeset
84 if isinstance(obj, Message):
194f927d8c5a add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 231
diff changeset
85 plural = self.pluralizable
194f927d8c5a add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 231
diff changeset
86 obj_plural = obj.pluralizable
194f927d8c5a add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 231
diff changeset
87 if plural and obj_plural:
194f927d8c5a add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 231
diff changeset
88 return cmp(self.id[0], obj.id[0])
194f927d8c5a add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 231
diff changeset
89 elif plural:
194f927d8c5a add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 231
diff changeset
90 return cmp(self.id[0], obj.id)
194f927d8c5a add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 231
diff changeset
91 elif obj_plural:
194f927d8c5a add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 231
diff changeset
92 return cmp(self.id, obj.id[0])
194f927d8c5a add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 231
diff changeset
93 return cmp(self.id, obj.id)
194f927d8c5a add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 231
diff changeset
94
315
654b632e5482 Merging catalogs would sometimes mix translations from different runs.
cmlenz
parents: 314
diff changeset
95 def clone(self):
654b632e5482 Merging catalogs would sometimes mix translations from different runs.
cmlenz
parents: 314
diff changeset
96 return Message(self.id, self.string, self.locations, self.flags,
654b632e5482 Merging catalogs would sometimes mix translations from different runs.
cmlenz
parents: 314
diff changeset
97 self.auto_comments, self.user_comments,
654b632e5482 Merging catalogs would sometimes mix translations from different runs.
cmlenz
parents: 314
diff changeset
98 self.previous_id, self.lineno)
654b632e5482 Merging catalogs would sometimes mix translations from different runs.
cmlenz
parents: 314
diff changeset
99
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
100 def fuzzy(self):
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
101 return 'fuzzy' in self.flags
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
102 fuzzy = property(fuzzy, doc="""\
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
103 Whether the translation is fuzzy.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
104
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
105 >>> Message('foo').fuzzy
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
106 False
177
47f6c31e9a24 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing).
palgarvio
parents: 167
diff changeset
107 >>> msg = Message('foo', 'foo', flags=['fuzzy'])
47f6c31e9a24 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing).
palgarvio
parents: 167
diff changeset
108 >>> msg.fuzzy
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
109 True
177
47f6c31e9a24 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing).
palgarvio
parents: 167
diff changeset
110 >>> msg
198
982d7e704fdc Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 190
diff changeset
111 <Message 'foo' (flags: ['fuzzy'])>
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
112
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
113 :type: `bool`
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
114 """)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
115
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
116 def pluralizable(self):
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
117 return isinstance(self.id, (list, tuple))
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
118 pluralizable = property(pluralizable, doc="""\
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
119 Whether the message is plurizable.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
120
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
121 >>> Message('foo').pluralizable
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
122 False
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
123 >>> Message(('foo', 'bar')).pluralizable
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
124 True
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
125
63
a60ecd4a4954 Move `Translations` and `LazyProxy` to new `babel.support` module, which should contain any convenience code that is useful for applications using Babel/I18n, but not used by Babel itself.
cmlenz
parents: 58
diff changeset
126 :type: `bool`
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
127 """)
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
128
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
129 def python_format(self):
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
130 ids = self.id
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
131 if not isinstance(ids, (list, tuple)):
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
132 ids = [ids]
222
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
133 return bool(filter(None, [PYTHON_FORMAT.search(id) for id in ids]))
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
134 python_format = property(python_format, doc="""\
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
135 Whether the message contains Python-style parameters.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
136
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
137 >>> Message('foo %(name)s bar').python_format
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
138 True
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
139 >>> Message(('foo %(name)s', 'foo %(name)s')).python_format
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
140 True
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
141
63
a60ecd4a4954 Move `Translations` and `LazyProxy` to new `babel.support` module, which should contain any convenience code that is useful for applications using Babel/I18n, but not used by Babel itself.
cmlenz
parents: 58
diff changeset
142 :type: `bool`
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
143 """)
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
144
107
4b42e23644e5 `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 106
diff changeset
145
222
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
146 class TranslationError(Exception):
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
147 """Exception thrown by translation checkers when invalid message
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
148 translations are encountered."""
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
149
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
150
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
151 DEFAULT_HEADER = u"""\
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
152 # Translations template for PROJECT.
122
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
153 # Copyright (C) YEAR ORGANIZATION
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
154 # This file is distributed under the same license as the PROJECT project.
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
155 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
156 #"""
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
157
198
982d7e704fdc Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 190
diff changeset
158
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
159 class Catalog(object):
80
8e2e9d549693 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 72
diff changeset
160 """Representation of a message catalog."""
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
161
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
162 def __init__(self, locale=None, domain=None, header_comment=DEFAULT_HEADER,
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
163 project=None, version=None, copyright_holder=None,
80
8e2e9d549693 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 72
diff changeset
164 msgid_bugs_address=None, creation_date=None,
208
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
165 revision_date=None, last_translator=None, language_team=None,
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
166 charset='utf-8', fuzzy=True):
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
167 """Initialize the catalog object.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
168
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
169 :param locale: the locale identifier or `Locale` object, or `None`
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
170 if the catalog is not bound to a locale (which basically
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
171 means it's a template)
80
8e2e9d549693 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 72
diff changeset
172 :param domain: the message domain
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
173 :param header_comment: the header comment as string, or `None` for the
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
174 default header
80
8e2e9d549693 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 72
diff changeset
175 :param project: the project's name
8e2e9d549693 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 72
diff changeset
176 :param version: the project's version
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
177 :param copyright_holder: the copyright holder of the catalog
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
178 :param msgid_bugs_address: the email address or URL to submit bug
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
179 reports to
80
8e2e9d549693 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 72
diff changeset
180 :param creation_date: the date the catalog was created
8e2e9d549693 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 72
diff changeset
181 :param revision_date: the date the catalog was revised
8e2e9d549693 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 72
diff changeset
182 :param last_translator: the name and email of the last translator
208
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
183 :param language_team: the name and email of the language team
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
184 :param charset: the encoding to use in the output
177
47f6c31e9a24 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing).
palgarvio
parents: 167
diff changeset
185 :param fuzzy: the fuzzy bit on the catalog header
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
186 """
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
187 self.domain = domain #: The message domain
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
188 if locale:
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
189 locale = Locale.parse(locale)
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
190 self.locale = locale #: The locale or `None`
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
191 self._header_comment = header_comment
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
192 self._messages = odict()
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
193
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
194 self.project = project or 'PROJECT' #: The project name
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
195 self.version = version or 'VERSION' #: The project version
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
196 self.copyright_holder = copyright_holder or 'ORGANIZATION'
80
8e2e9d549693 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 72
diff changeset
197 self.msgid_bugs_address = msgid_bugs_address or 'EMAIL@ADDRESS'
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
198
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
199 self.last_translator = last_translator or 'FULL NAME <EMAIL@ADDRESS>'
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
200 """Name and email address of the last translator."""
208
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
201 self.language_team = language_team or 'LANGUAGE <LL@li.org>'
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
202 """Name and email address of the language team."""
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
203
97
debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 89
diff changeset
204 self.charset = charset or 'utf-8'
86
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
205
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
206 if creation_date is None:
99
b6b5992daa6c Renamed `LOCAL` to `LOCALTZ`.
cmlenz
parents: 97
diff changeset
207 creation_date = datetime.now(LOCALTZ)
97
debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 89
diff changeset
208 elif isinstance(creation_date, datetime) and not creation_date.tzinfo:
99
b6b5992daa6c Renamed `LOCAL` to `LOCALTZ`.
cmlenz
parents: 97
diff changeset
209 creation_date = creation_date.replace(tzinfo=LOCALTZ)
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
210 self.creation_date = creation_date #: Creation date of the template
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
211 if revision_date is None:
99
b6b5992daa6c Renamed `LOCAL` to `LOCALTZ`.
cmlenz
parents: 97
diff changeset
212 revision_date = datetime.now(LOCALTZ)
97
debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 89
diff changeset
213 elif isinstance(revision_date, datetime) and not revision_date.tzinfo:
99
b6b5992daa6c Renamed `LOCAL` to `LOCALTZ`.
cmlenz
parents: 97
diff changeset
214 revision_date = revision_date.replace(tzinfo=LOCALTZ)
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
215 self.revision_date = revision_date #: Last revision date of the catalog
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 177
diff changeset
216 self.fuzzy = fuzzy #: Catalog header fuzzy bit (`True` or `False`)
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 177
diff changeset
217
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 177
diff changeset
218 self.obsolete = odict() #: Dictionary of obsolete messages
335
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
219 self._num_plurals = None
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
220 self._plural_expr = None
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
221
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
222 def _get_header_comment(self):
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
223 comment = self._header_comment
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
224 comment = comment.replace('PROJECT', self.project) \
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
225 .replace('VERSION', self.version) \
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
226 .replace('YEAR', self.revision_date.strftime('%Y')) \
122
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
227 .replace('ORGANIZATION', self.copyright_holder)
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
228 if self.locale:
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
229 comment = comment.replace('Translations template', '%s translations'
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
230 % self.locale.english_name)
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
231 return comment
122
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
232
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
233 def _set_header_comment(self, string):
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
234 self._header_comment = string
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
235
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
236 header_comment = property(_get_header_comment, _set_header_comment, doc="""\
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
237 The header comment for the catalog.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
238
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
239 >>> catalog = Catalog(project='Foobar', version='1.0',
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
240 ... copyright_holder='Foo Company')
314
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
241 >>> print catalog.header_comment #doctest: +ELLIPSIS
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
242 # Translations template for Foobar.
314
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
243 # Copyright (C) ... Foo Company
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
244 # This file is distributed under the same license as the Foobar project.
314
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
245 # FIRST AUTHOR <EMAIL@ADDRESS>, ....
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
246 #
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
247
122
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
248 The header can also be set from a string. Any known upper-case variables
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
249 will be replaced when the header is retrieved again:
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
250
122
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
251 >>> catalog = Catalog(project='Foobar', version='1.0',
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
252 ... copyright_holder='Foo Company')
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
253 >>> catalog.header_comment = '''\\
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
254 ... # The POT for my really cool PROJECT project.
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
255 ... # Copyright (C) 1990-2003 ORGANIZATION
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
256 ... # This file is distributed under the same license as the PROJECT
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
257 ... # project.
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
258 ... #'''
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
259 >>> print catalog.header_comment
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
260 # The POT for my really cool Foobar project.
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
261 # Copyright (C) 1990-2003 Foo Company
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
262 # This file is distributed under the same license as the Foobar
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
263 # project.
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
264 #
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
265
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
266 :type: `unicode`
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
267 """)
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
268
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
269 def _get_mime_headers(self):
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
270 headers = []
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
271 headers.append(('Project-Id-Version',
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
272 '%s %s' % (self.project, self.version)))
80
8e2e9d549693 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 72
diff changeset
273 headers.append(('Report-Msgid-Bugs-To', self.msgid_bugs_address))
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
274 headers.append(('POT-Creation-Date',
133
9d58665d134c Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows.
cmlenz
parents: 123
diff changeset
275 format_datetime(self.creation_date, 'yyyy-MM-dd HH:mmZ',
9d58665d134c Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows.
cmlenz
parents: 123
diff changeset
276 locale='en')))
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
277 if self.locale is None:
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
278 headers.append(('PO-Revision-Date', 'YEAR-MO-DA HO:MI+ZONE'))
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
279 headers.append(('Last-Translator', 'FULL NAME <EMAIL@ADDRESS>'))
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
280 headers.append(('Language-Team', 'LANGUAGE <LL@li.org>'))
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
281 else:
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
282 headers.append(('PO-Revision-Date',
133
9d58665d134c Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows.
cmlenz
parents: 123
diff changeset
283 format_datetime(self.revision_date,
9d58665d134c Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows.
cmlenz
parents: 123
diff changeset
284 'yyyy-MM-dd HH:mmZ', locale='en')))
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
285 headers.append(('Last-Translator', self.last_translator))
208
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
286 headers.append(('Language-Team',
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
287 self.language_team.replace('LANGUAGE',
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
288 str(self.locale))))
86
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
289 headers.append(('Plural-Forms', self.plural_forms))
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
290 headers.append(('MIME-Version', '1.0'))
70
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
291 headers.append(('Content-Type',
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
292 'text/plain; charset=%s' % self.charset))
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
293 headers.append(('Content-Transfer-Encoding', '8bit'))
107
4b42e23644e5 `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 106
diff changeset
294 headers.append(('Generated-By', 'Babel %s\n' % VERSION))
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
295 return headers
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
296
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
297 def _set_mime_headers(self, headers):
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
298 for name, value in headers:
293
62d4f85d33ea fix catalogs' charset values not being recognized
pjenvey
parents: 279
diff changeset
299 if name.lower() == 'content-type':
212
2c00a52bc073 When parsing catalog headers, look for the content-type first, to be able to use a specified encoding on all other headers.
cmlenz
parents: 208
diff changeset
300 mimetype, params = parse_header(value)
2c00a52bc073 When parsing catalog headers, look for the content-type first, to be able to use a specified encoding on all other headers.
cmlenz
parents: 208
diff changeset
301 if 'charset' in params:
2c00a52bc073 When parsing catalog headers, look for the content-type first, to be able to use a specified encoding on all other headers.
cmlenz
parents: 208
diff changeset
302 self.charset = params['charset'].lower()
2c00a52bc073 When parsing catalog headers, look for the content-type first, to be able to use a specified encoding on all other headers.
cmlenz
parents: 208
diff changeset
303 break
2c00a52bc073 When parsing catalog headers, look for the content-type first, to be able to use a specified encoding on all other headers.
cmlenz
parents: 208
diff changeset
304 for name, value in headers:
2c00a52bc073 When parsing catalog headers, look for the content-type first, to be able to use a specified encoding on all other headers.
cmlenz
parents: 208
diff changeset
305 name = name.lower().decode(self.charset)
2c00a52bc073 When parsing catalog headers, look for the content-type first, to be able to use a specified encoding on all other headers.
cmlenz
parents: 208
diff changeset
306 value = value.decode(self.charset)
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
307 if name == 'project-id-version':
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
308 parts = value.split(' ')
212
2c00a52bc073 When parsing catalog headers, look for the content-type first, to be able to use a specified encoding on all other headers.
cmlenz
parents: 208
diff changeset
309 self.project = u' '.join(parts[:-1])
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
310 self.version = parts[-1]
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
311 elif name == 'report-msgid-bugs-to':
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
312 self.msgid_bugs_address = value
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
313 elif name == 'last-translator':
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
314 self.last_translator = value
208
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
315 elif name == 'language-team':
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
316 self.language_team = value
335
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
317 elif name == 'plural-forms':
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
318 _, params = parse_header(' ;' + value)
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
319 self._num_plurals = int(params.get('nplurals', 2))
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
320 self._plural_expr = params.get('plural', '(n != 1)')
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
321 elif name == 'pot-creation-date':
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
322 # FIXME: this should use dates.parse_datetime as soon as that
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
323 # is ready
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
324 value, tzoffset, _ = re.split('[+-](\d{4})$', value, 1)
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
325 tt = time.strptime(value, '%Y-%m-%d %H:%M')
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
326 ts = time.mktime(tt)
122
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
327 tzoffset = FixedOffsetTimezone(int(tzoffset[:2]) * 60 +
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
328 int(tzoffset[2:]))
123
5b4f302abf53 Fix parsing of timezone in POT creation date.
cmlenz
parents: 122
diff changeset
329 dt = datetime.fromtimestamp(ts)
5b4f302abf53 Fix parsing of timezone in POT creation date.
cmlenz
parents: 122
diff changeset
330 self.creation_date = dt.replace(tzinfo=tzoffset)
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
331
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
332 mime_headers = property(_get_mime_headers, _set_mime_headers, doc="""\
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
333 The MIME headers of the catalog, used for the special ``msgid ""`` entry.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
334
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
335 The behavior of this property changes slightly depending on whether a locale
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
336 is set or not, the latter indicating that the catalog is actually a template
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
337 for actual translations.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
338
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
339 Here's an example of the output for such a catalog template:
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
340
97
debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 89
diff changeset
341 >>> created = datetime(1990, 4, 1, 15, 30, tzinfo=UTC)
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
342 >>> catalog = Catalog(project='Foobar', version='1.0',
97
debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 89
diff changeset
343 ... creation_date=created)
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
344 >>> for name, value in catalog.mime_headers:
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
345 ... print '%s: %s' % (name, value)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
346 Project-Id-Version: Foobar 1.0
80
8e2e9d549693 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 72
diff changeset
347 Report-Msgid-Bugs-To: EMAIL@ADDRESS
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
348 POT-Creation-Date: 1990-04-01 15:30+0000
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
349 PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
350 Last-Translator: FULL NAME <EMAIL@ADDRESS>
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
351 Language-Team: LANGUAGE <LL@li.org>
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
352 MIME-Version: 1.0
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
353 Content-Type: text/plain; charset=utf-8
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
354 Content-Transfer-Encoding: 8bit
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
355 Generated-By: Babel ...
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
356
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
357 And here's an example of the output when the locale is set:
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
358
97
debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 89
diff changeset
359 >>> revised = datetime(1990, 8, 3, 12, 0, tzinfo=UTC)
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
360 >>> catalog = Catalog(locale='de_DE', project='Foobar', version='1.0',
97
debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 89
diff changeset
361 ... creation_date=created, revision_date=revised,
208
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
362 ... last_translator='John Doe <jd@example.com>',
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
363 ... language_team='de_DE <de@example.com>')
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
364 >>> for name, value in catalog.mime_headers:
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
365 ... print '%s: %s' % (name, value)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
366 Project-Id-Version: Foobar 1.0
80
8e2e9d549693 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 72
diff changeset
367 Report-Msgid-Bugs-To: EMAIL@ADDRESS
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
368 POT-Creation-Date: 1990-04-01 15:30+0000
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
369 PO-Revision-Date: 1990-08-03 12:00+0000
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
370 Last-Translator: John Doe <jd@example.com>
208
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
371 Language-Team: de_DE <de@example.com>
86
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
372 Plural-Forms: nplurals=2; plural=(n != 1)
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
373 MIME-Version: 1.0
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
374 Content-Type: text/plain; charset=utf-8
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
375 Content-Transfer-Encoding: 8bit
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
376 Generated-By: Babel ...
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
377
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
378 :type: `list`
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
379 """)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
380
70
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
381 def num_plurals(self):
335
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
382 if not self._num_plurals:
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
383 num = 2
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
384 if self.locale:
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
385 if str(self.locale) in PLURALS:
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
386 num = PLURALS[str(self.locale)][0]
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
387 elif self.locale.language in PLURALS:
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
388 num = PLURALS[self.locale.language][0]
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
389 self._num_plurals = num
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
390 return self._num_plurals
86
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
391 num_plurals = property(num_plurals, doc="""\
335
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
392 The number of plurals used by the catalog or locale.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
393
105
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 99
diff changeset
394 >>> Catalog(locale='en').num_plurals
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 99
diff changeset
395 2
335
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
396 >>> Catalog(locale='ga').num_plurals
105
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 99
diff changeset
397 3
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
398
105
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 99
diff changeset
399 :type: `int`
86
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
400 """)
70
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
401
335
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
402 def plural_expr(self):
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
403 if not self._plural_expr:
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
404 expr = '(n != 1)'
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
405 if self.locale:
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
406 if str(self.locale) in PLURALS:
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
407 expr = PLURALS[str(self.locale)][1]
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
408 elif self.locale.language in PLURALS:
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
409 expr = PLURALS[self.locale.language][1]
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
410 self._plural_expr = expr
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
411 return self._plural_expr
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
412 plural_expr = property(plural_expr, doc="""\
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
413 The plural expression used by the catalog or locale.
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
414
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
415 >>> Catalog(locale='en').plural_expr
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
416 '(n != 1)'
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
417 >>> Catalog(locale='ga').plural_expr
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
418 '(n==1 ? 0 : n==2 ? 1 : 2)'
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
419
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
420 :type: `basestring`
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
421 """)
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
422
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
423 def plural_forms(self):
335
355a977c92aa Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 315
diff changeset
424 return 'nplurals=%s; plural=%s' % (self.num_plurals, self.plural_expr)
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
425 plural_forms = property(plural_forms, doc="""\
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
426 Return the plural forms declaration for the locale.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
427
105
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 99
diff changeset
428 >>> Catalog(locale='en').plural_forms
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
429 'nplurals=2; plural=(n != 1)'
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
430 >>> Catalog(locale='pt_BR').plural_forms
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
431 'nplurals=2; plural=(n > 1)'
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
432
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
433 :type: `str`
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
434 """)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
435
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
436 def __contains__(self, id):
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
437 """Return whether the catalog has a message with the specified ID."""
71
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
438 return self._key_for(id) in self._messages
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
439
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
440 def __len__(self):
86
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
441 """The number of messages in the catalog.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
442
86
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
443 This does not include the special ``msgid ""`` entry.
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
444 """
71
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
445 return len(self._messages)
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
446
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
447 def __iter__(self):
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
448 """Iterates through all the entries in the catalog, in the order they
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
449 were added, yielding a `Message` object for every entry.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
450
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
451 :rtype: ``iterator``
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
452 """
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
453 buf = []
106
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
454 for name, value in self.mime_headers:
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
455 buf.append('%s: %s' % (name, value))
200
2f0161df6a38 Correctly handle non-ASCII chars in the catalog MIME headers.
cmlenz
parents: 198
diff changeset
456 flags = set()
177
47f6c31e9a24 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing).
palgarvio
parents: 167
diff changeset
457 if self.fuzzy:
200
2f0161df6a38 Correctly handle non-ASCII chars in the catalog MIME headers.
cmlenz
parents: 198
diff changeset
458 flags |= set(['fuzzy'])
212
2c00a52bc073 When parsing catalog headers, look for the content-type first, to be able to use a specified encoding on all other headers.
cmlenz
parents: 208
diff changeset
459 yield Message(u'', '\n'.join(buf), flags=flags)
71
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
460 for key in self._messages:
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
461 yield self._messages[key]
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
462
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
463 def __repr__(self):
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
464 locale = ''
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
465 if self.locale:
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
466 locale = ' %s' % self.locale
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
467 return '<%s %r%s>' % (type(self).__name__, self.domain, locale)
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
468
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
469 def __delitem__(self, id):
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
470 """Delete the message with the specified ID."""
71
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
471 key = self._key_for(id)
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
472 if key in self._messages:
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
473 del self._messages[key]
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
474
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
475 def __getitem__(self, id):
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
476 """Return the message with the specified ID.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
477
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
478 :param id: the message ID
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
479 :return: the message with the specified ID, or `None` if no such message
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
480 is in the catalog
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
481 :rtype: `Message`
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
482 """
71
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
483 return self._messages.get(self._key_for(id))
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
484
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
485 def __setitem__(self, id, message):
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
486 """Add or update the message with the specified ID.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
487
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
488 >>> catalog = Catalog()
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
489 >>> catalog[u'foo'] = Message(u'foo')
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
490 >>> catalog[u'foo']
198
982d7e704fdc Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 190
diff changeset
491 <Message u'foo' (flags: [])>
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
492
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
493 If a message with that ID is already in the catalog, it is updated
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
494 to include the locations and flags of the new message.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
495
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
496 >>> catalog = Catalog()
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
497 >>> catalog[u'foo'] = Message(u'foo', locations=[('main.py', 1)])
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
498 >>> catalog[u'foo'].locations
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
499 [('main.py', 1)]
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
500 >>> catalog[u'foo'] = Message(u'foo', locations=[('utils.py', 5)])
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
501 >>> catalog[u'foo'].locations
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
502 [('main.py', 1), ('utils.py', 5)]
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
503
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
504 :param id: the message ID
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
505 :param message: the `Message` object
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
506 """
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
507 assert isinstance(message, Message), 'expected a Message object'
71
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
508 key = self._key_for(id)
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
509 current = self._messages.get(key)
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
510 if current:
71
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
511 if message.pluralizable and not current.pluralizable:
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
512 # The new message adds pluralization
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
513 current.id = message.id
72
f5a6bf38df89 Fix for mixed singular/plural messages, follow-up to [70].
cmlenz
parents: 71
diff changeset
514 current.string = message.string
231
fc8b8c2bba53 Remove duplicate locations of catalog messages.
cmlenz
parents: 230
diff changeset
515 current.locations = list(distinct(current.locations +
fc8b8c2bba53 Remove duplicate locations of catalog messages.
cmlenz
parents: 230
diff changeset
516 message.locations))
230
aaf36f409166 Follow-up to [239]: also combine duplicate comments when writing PO files.
cmlenz
parents: 229
diff changeset
517 current.auto_comments = list(distinct(current.auto_comments +
aaf36f409166 Follow-up to [239]: also combine duplicate comments when writing PO files.
cmlenz
parents: 229
diff changeset
518 message.auto_comments))
aaf36f409166 Follow-up to [239]: also combine duplicate comments when writing PO files.
cmlenz
parents: 229
diff changeset
519 current.user_comments = list(distinct(current.user_comments +
aaf36f409166 Follow-up to [239]: also combine duplicate comments when writing PO files.
cmlenz
parents: 229
diff changeset
520 message.user_comments))
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
521 current.flags |= message.flags
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
522 message = current
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
523 elif id == '':
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
524 # special treatment for the header message
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
525 headers = message_from_string(message.string.encode(self.charset))
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
526 self.mime_headers = headers.items()
122
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
527 self.header_comment = '\n'.join(['# %s' % comment for comment
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
528 in message.user_comments])
198
982d7e704fdc Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 190
diff changeset
529 self.fuzzy = message.fuzzy
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
530 else:
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
531 if isinstance(id, (list, tuple)):
279
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
532 assert isinstance(message.string, (list, tuple)), \
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
533 'Expected sequence but got %s' % type(message.string)
71
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
534 self._messages[key] = message
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
535
107
4b42e23644e5 `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 106
diff changeset
536 def add(self, id, string=None, locations=(), flags=(), auto_comments=(),
222
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
537 user_comments=(), previous_id=(), lineno=None):
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
538 """Add or update the message with the specified ID.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
539
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
540 >>> catalog = Catalog()
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
541 >>> catalog.add(u'foo')
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
542 >>> catalog[u'foo']
198
982d7e704fdc Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 190
diff changeset
543 <Message u'foo' (flags: [])>
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
544
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
545 This method simply constructs a `Message` object with the given
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
546 arguments and invokes `__setitem__` with that object.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
547
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
548 :param id: the message ID, or a ``(singular, plural)`` tuple for
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
549 pluralizable messages
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
550 :param string: the translated message string, or a
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
551 ``(singular, plural)`` tuple for pluralizable messages
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
552 :param locations: a sequence of ``(filenname, lineno)`` tuples
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
553 :param flags: a set or sequence of flags
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
554 :param auto_comments: a sequence of automatic comments
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
555 :param user_comments: a sequence of user comments
205
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
556 :param previous_id: the previous message ID, or a ``(singular, plural)``
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
557 tuple for pluralizable messages
222
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
558 :param lineno: the line number on which the msgid line was found in the
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
559 PO file, if any
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
560 """
107
4b42e23644e5 `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 106
diff changeset
561 self[id] = Message(id, string, list(locations), flags, auto_comments,
222
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
562 user_comments, previous_id, lineno=lineno)
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
563
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
564 def check(self):
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
565 """Run various validation checks on the translations in the catalog.
228
629357c88d59 Only write unique comments, no duplicates.
palgarvio
parents: 227
diff changeset
566
222
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
567 For every message which fails validation, this method yield a
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
568 ``(message, errors)`` tuple, where ``message`` is the `Message` object
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
569 and ``errors`` is a sequence of `TranslationError` objects.
228
629357c88d59 Only write unique comments, no duplicates.
palgarvio
parents: 227
diff changeset
570
252
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
571 :note: this feature requires ``setuptools``/``pkg_resources`` to be
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
572 installed; if it is not, this method will simply return an empty
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
573 iterator
222
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
574 :rtype: ``iterator``
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
575 """
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
576 checkers = []
252
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
577 try:
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
578 from pkg_resources import working_set
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
579 except ImportError:
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
580 return
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
581 else:
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
582 for entry_point in working_set.iter_entry_points('babel.checkers'):
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
583 checkers.append(entry_point.load())
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
584 for message in self._messages.values():
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
585 errors = []
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
586 for checker in checkers:
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
587 try:
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
588 checker(self, message)
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
589 except TranslationError, e:
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
590 errors.append(e)
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
591 if errors:
2398fc97675b Soften dependency on setuptools. Extraction methods can now be referenced using a special section in the mapping configuration, mapping short names to fully-qualified function references.
cmlenz
parents: 250
diff changeset
592 yield message, errors
71
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
593
205
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
594 def update(self, template, no_fuzzy_matching=False):
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
595 """Update the catalog based on the given template catalog.
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
596
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
597 >>> from babel.messages import Catalog
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
598 >>> template = Catalog()
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
599 >>> template.add('green', locations=[('main.py', 99)])
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
600 >>> template.add('blue', locations=[('main.py', 100)])
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
601 >>> template.add(('salad', 'salads'), locations=[('util.py', 42)])
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
602 >>> catalog = Catalog(locale='de_DE')
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
603 >>> catalog.add('blue', u'blau', locations=[('main.py', 98)])
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
604 >>> catalog.add('head', u'Kopf', locations=[('util.py', 33)])
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
605 >>> catalog.add(('salad', 'salads'), (u'Salat', u'Salate'),
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
606 ... locations=[('util.py', 38)])
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
607
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 177
diff changeset
608 >>> catalog.update(template)
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
609 >>> len(catalog)
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
610 3
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
611
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
612 >>> msg1 = catalog['green']
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
613 >>> msg1.string
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
614 >>> msg1.locations
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
615 [('main.py', 99)]
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
616
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
617 >>> msg2 = catalog['blue']
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
618 >>> msg2.string
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
619 u'blau'
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
620 >>> msg2.locations
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
621 [('main.py', 100)]
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
622
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
623 >>> msg3 = catalog['salad']
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
624 >>> msg3.string
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
625 (u'Salat', u'Salate')
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
626 >>> msg3.locations
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
627 [('util.py', 42)]
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
628
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 177
diff changeset
629 Messages that are in the catalog but not in the template are removed
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 177
diff changeset
630 from the main collection, but can still be accessed via the `obsolete`
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 177
diff changeset
631 member:
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
632
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
633 >>> 'head' in catalog
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
634 False
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 177
diff changeset
635 >>> catalog.obsolete.values()
198
982d7e704fdc Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 190
diff changeset
636 [<Message 'head' (flags: [])>]
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
637
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
638 :param template: the reference catalog, usually read from a POT file
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
639 :param no_fuzzy_matching: whether to use fuzzy matching of message IDs
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
640 """
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
641 messages = self._messages
314
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
642 remaining = messages.copy()
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
643 self._messages = odict()
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
644
314
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
645 # Prepare for fuzzy matching
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
646 fuzzy_candidates = []
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
647 if not no_fuzzy_matching:
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
648 fuzzy_candidates = [
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
649 self._key_for(msgid) for msgid in messages
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
650 if msgid and messages[msgid].string
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
651 ]
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
652 fuzzy_matches = set()
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
653
279
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
654 def _merge(message, oldkey, newkey):
315
654b632e5482 Merging catalogs would sometimes mix translations from different runs.
cmlenz
parents: 314
diff changeset
655 message = message.clone()
279
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
656 fuzzy = False
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
657 if oldkey != newkey:
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
658 fuzzy = True
314
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
659 fuzzy_matches.add(oldkey)
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
660 oldmsg = messages.get(oldkey)
279
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
661 if isinstance(oldmsg.id, basestring):
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
662 message.previous_id = [oldmsg.id]
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
663 else:
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
664 message.previous_id = list(oldmsg.id)
314
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
665 else:
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
666 oldmsg = remaining.pop(oldkey)
279
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
667 message.string = oldmsg.string
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
668 if isinstance(message.id, (list, tuple)):
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
669 if not isinstance(message.string, (list, tuple)):
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
670 fuzzy = True
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
671 message.string = tuple(
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
672 [message.string] + ([u''] * (len(message.id) - 1))
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
673 )
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
674 elif len(message.string) != len(message.id):
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
675 fuzzy = True
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
676 message.string = tuple(message.string[:len(oldmsg.string)])
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
677 elif isinstance(message.string, (list, tuple)):
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
678 fuzzy = True
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
679 message.string = message.string[0]
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
680 message.flags |= oldmsg.flags
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
681 if fuzzy:
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
682 message.flags |= set([u'fuzzy'])
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
683 self[message.id] = message
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
684
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
685 for message in template:
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
686 if message.id:
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
687 key = self._key_for(message.id)
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
688 if key in messages:
279
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
689 _merge(message, key, key)
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
690 else:
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
691 if no_fuzzy_matching is False:
167
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
692 # do some fuzzy matching with difflib
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
693 matches = get_close_matches(key.lower().strip(),
314
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
694 fuzzy_candidates, 1)
167
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
695 if matches:
279
3308e9971fab Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 252
diff changeset
696 _merge(message, matches[0], key)
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
697 continue
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
698
167
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
699 self[message.id] = message
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
700
314
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
701 self.obsolete = odict()
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
702 for msgid in remaining:
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
703 if no_fuzzy_matching or msgid not in fuzzy_matches:
5c0bda4f20b1 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 293
diff changeset
704 self.obsolete[msgid] = remaining[msgid]
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
705
71
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
706 def _key_for(self, id):
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
707 """The key for a message is just the singular ID even for pluralizable
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
708 messages.
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
709 """
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
710 key = id
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
711 if isinstance(key, (list, tuple)):
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
712 key = id[0]
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
713 return key
Copyright (C) 2012-2017 Edgewall Software