annotate babel/messages/catalog.py @ 545:afdab04b8527

Catalog class should not do decoding of input strings (fixes #256)
author fschwarz
date Sat, 19 Mar 2011 19:34:40 +0000
parents 030ddf3f5b13
children
rev   line source
56
27fba894d3ca 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 -*-
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
2 #
530
85e1beadacb0 Update the copyright line.
jruigrok
parents: 525
diff changeset
3 # Copyright (C) 2007-2011 Edgewall Software
56
27fba894d3ca 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.
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
5 #
27fba894d3ca 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
27fba894d3ca 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
27fba894d3ca 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.
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
9 #
27fba894d3ca 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
27fba894d3ca 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
27fba894d3ca 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/.
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
13
27fba894d3ca 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."""
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
15
149
ba5150e9544e Respect charset specified in PO headers in `read_po()`. Fixes #17.
cmlenz
parents: 131
diff changeset
16 from cgi import parse_header
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
17 from datetime import datetime
165
650a6e996ede Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 163
diff changeset
18 from difflib import get_close_matches
106
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
19 from email import message_from_string
358
6ea52d9bdab1 Message.clone doesn't return a shallow copy any longer. This fixes a bug with update where flags where shared.
aronacher
parents: 355
diff changeset
20 from copy import copy
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
21 import re
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
22 import time
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
23
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
24 from babel import __version__ as VERSION
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
25 from babel.core import Locale
131
a63812008056 Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows.
cmlenz
parents: 121
diff changeset
26 from babel.dates import format_datetime
373
2316a7fd75d9 Added babel.messages.plurals.get_plural which returns a special tuple with the plural information.
aronacher
parents: 358
diff changeset
27 from babel.messages.plurals import get_plural
525
eef19ada4296 Cleanup round #1: get rid of the frozenset/set utility code and imports.
jruigrok
parents: 478
diff changeset
28 from babel.util import odict, distinct, LOCALTZ, UTC, FixedOffsetTimezone
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
29
220
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
30 __all__ = ['Message', 'Catalog', 'TranslationError']
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
31 __docformat__ = 'restructuredtext en'
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
32
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
33
354
1355e4014496 Moved PYTHON_FORMAT back to catalog.
aronacher
parents: 352
diff changeset
34 PYTHON_FORMAT = re.compile(r'''(?x)
1355e4014496 Moved PYTHON_FORMAT back to catalog.
aronacher
parents: 352
diff changeset
35 \%
1355e4014496 Moved PYTHON_FORMAT back to catalog.
aronacher
parents: 352
diff changeset
36 (?:\(([\w]*)\))?
1355e4014496 Moved PYTHON_FORMAT back to catalog.
aronacher
parents: 352
diff changeset
37 (
1355e4014496 Moved PYTHON_FORMAT back to catalog.
aronacher
parents: 352
diff changeset
38 [-#0\ +]?(?:\*|[\d]+)?
1355e4014496 Moved PYTHON_FORMAT back to catalog.
aronacher
parents: 352
diff changeset
39 (?:\.(?:\*|[\d]+))?
1355e4014496 Moved PYTHON_FORMAT back to catalog.
aronacher
parents: 352
diff changeset
40 [hlL]?
1355e4014496 Moved PYTHON_FORMAT back to catalog.
aronacher
parents: 352
diff changeset
41 )
1355e4014496 Moved PYTHON_FORMAT back to catalog.
aronacher
parents: 352
diff changeset
42 ([diouxXeEfFgGcrs%])
1355e4014496 Moved PYTHON_FORMAT back to catalog.
aronacher
parents: 352
diff changeset
43 ''')
1355e4014496 Moved PYTHON_FORMAT back to catalog.
aronacher
parents: 352
diff changeset
44
1355e4014496 Moved PYTHON_FORMAT back to catalog.
aronacher
parents: 352
diff changeset
45
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
46 class Message(object):
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
47 """Representation of a single message in a catalog."""
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
48
149
ba5150e9544e Respect charset specified in PO headers in `read_po()`. Fixes #17.
cmlenz
parents: 131
diff changeset
49 def __init__(self, id, string=u'', locations=(), flags=(), auto_comments=(),
335
9c41fe73e2e6 More preparation for msgctxt support (#54).
cmlenz
parents: 333
diff changeset
50 user_comments=(), previous_id=(), lineno=None, context=None):
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
51 """Create the message object.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
52
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
53 :param id: the message ID, or a ``(singular, plural)`` tuple for
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
54 pluralizable messages
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
55 :param string: the translated message string, or a
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
56 ``(singular, plural)`` tuple for pluralizable messages
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
57 :param locations: a sequence of ``(filenname, lineno)`` tuples
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
58 :param flags: a set or sequence of flags
106
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
59 :param auto_comments: a sequence of automatic comments for the message
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
60 :param user_comments: a sequence of user comments for the message
203
e50aaaabb3d3 Minor changes to how previous msgids are processed.
cmlenz
parents: 202
diff changeset
61 :param previous_id: the previous message ID, or a ``(singular, plural)``
e50aaaabb3d3 Minor changes to how previous msgids are processed.
cmlenz
parents: 202
diff changeset
62 tuple for pluralizable messages
220
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
63 :param lineno: the line number on which the msgid line was found in the
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
64 PO file, if any
335
9c41fe73e2e6 More preparation for msgctxt support (#54).
cmlenz
parents: 333
diff changeset
65 :param context: the message context
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
66 """
107
be19f079ee51 Minor doc improvements.
cmlenz
parents: 106
diff changeset
67 self.id = id #: The message ID
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
68 if not string and self.pluralizable:
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
69 string = (u'', u'')
107
be19f079ee51 Minor doc improvements.
cmlenz
parents: 106
diff changeset
70 self.string = string #: The message translation
229
9a3f2acb55e6 Remove duplicate locations of catalog messages.
cmlenz
parents: 228
diff changeset
71 self.locations = list(distinct(locations))
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
72 self.flags = set(flags)
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
73 if id and self.python_format:
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
74 self.flags.add('python-format')
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
75 else:
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
76 self.flags.discard('python-format')
227
01dd895f396c Fix tests broken by [233], and add new tests.
cmlenz
parents: 226
diff changeset
77 self.auto_comments = list(distinct(auto_comments))
01dd895f396c Fix tests broken by [233], and add new tests.
cmlenz
parents: 226
diff changeset
78 self.user_comments = list(distinct(user_comments))
203
e50aaaabb3d3 Minor changes to how previous msgids are processed.
cmlenz
parents: 202
diff changeset
79 if isinstance(previous_id, basestring):
e50aaaabb3d3 Minor changes to how previous msgids are processed.
cmlenz
parents: 202
diff changeset
80 self.previous_id = [previous_id]
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
81 else:
203
e50aaaabb3d3 Minor changes to how previous msgids are processed.
cmlenz
parents: 202
diff changeset
82 self.previous_id = list(previous_id)
220
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
83 self.lineno = lineno
335
9c41fe73e2e6 More preparation for msgctxt support (#54).
cmlenz
parents: 333
diff changeset
84 self.context = context
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
85
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
86 def __repr__(self):
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 188
diff changeset
87 return '<%s %r (flags: %r)>' % (type(self).__name__, self.id,
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 188
diff changeset
88 list(self.flags))
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
89
248
bedaaeadc1db add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 229
diff changeset
90 def __cmp__(self, obj):
bedaaeadc1db add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 229
diff changeset
91 """Compare Messages, taking into account plural ids"""
bedaaeadc1db add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 229
diff changeset
92 if isinstance(obj, Message):
bedaaeadc1db add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 229
diff changeset
93 plural = self.pluralizable
bedaaeadc1db add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 229
diff changeset
94 obj_plural = obj.pluralizable
bedaaeadc1db add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 229
diff changeset
95 if plural and obj_plural:
bedaaeadc1db add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 229
diff changeset
96 return cmp(self.id[0], obj.id[0])
bedaaeadc1db add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 229
diff changeset
97 elif plural:
bedaaeadc1db add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 229
diff changeset
98 return cmp(self.id[0], obj.id)
bedaaeadc1db add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 229
diff changeset
99 elif obj_plural:
bedaaeadc1db add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 229
diff changeset
100 return cmp(self.id, obj.id[0])
bedaaeadc1db add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 229
diff changeset
101 return cmp(self.id, obj.id)
bedaaeadc1db add a __cmp__ to Message that correctly sorts by id, taking into account plurals
pjenvey
parents: 229
diff changeset
102
313
559c80b1ffb2 Merging catalogs would sometimes mix translations from different runs.
cmlenz
parents: 312
diff changeset
103 def clone(self):
358
6ea52d9bdab1 Message.clone doesn't return a shallow copy any longer. This fixes a bug with update where flags where shared.
aronacher
parents: 355
diff changeset
104 return Message(*map(copy, (self.id, self.string, self.locations,
6ea52d9bdab1 Message.clone doesn't return a shallow copy any longer. This fixes a bug with update where flags where shared.
aronacher
parents: 355
diff changeset
105 self.flags, self.auto_comments,
6ea52d9bdab1 Message.clone doesn't return a shallow copy any longer. This fixes a bug with update where flags where shared.
aronacher
parents: 355
diff changeset
106 self.user_comments, self.previous_id,
6ea52d9bdab1 Message.clone doesn't return a shallow copy any longer. This fixes a bug with update where flags where shared.
aronacher
parents: 355
diff changeset
107 self.lineno, self.context)))
313
559c80b1ffb2 Merging catalogs would sometimes mix translations from different runs.
cmlenz
parents: 312
diff changeset
108
355
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
109 def check(self, catalog=None):
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
110 """Run various validation checks on the message. Some validations
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
111 are only performed if the catalog is provided. This method returns
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
112 a sequence of `TranslationError` objects.
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
113
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
114 :rtype: ``iterator``
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
115 :param catalog: A catalog instance that is passed to the checkers
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
116 :see: `Catalog.check` for a way to perform checks for all messages
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
117 in a catalog.
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
118 """
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
119 from babel.messages.checkers import checkers
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
120 errors = []
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
121 for checker in checkers:
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
122 try:
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
123 checker(catalog, self)
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
124 except TranslationError, e:
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
125 errors.append(e)
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
126 return errors
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
127
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
128 def fuzzy(self):
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
129 return 'fuzzy' in self.flags
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
130 fuzzy = property(fuzzy, doc="""\
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
131 Whether the translation is fuzzy.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
132
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
133 >>> Message('foo').fuzzy
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
134 False
175
3c4718fb7435 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: 165
diff changeset
135 >>> msg = Message('foo', 'foo', flags=['fuzzy'])
3c4718fb7435 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: 165
diff changeset
136 >>> msg.fuzzy
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
137 True
175
3c4718fb7435 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: 165
diff changeset
138 >>> msg
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 188
diff changeset
139 <Message 'foo' (flags: ['fuzzy'])>
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
140
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
141 :type: `bool`
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
142 """)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
143
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
144 def pluralizable(self):
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
145 return isinstance(self.id, (list, tuple))
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
146 pluralizable = property(pluralizable, doc="""\
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
147 Whether the message is plurizable.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
148
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
149 >>> Message('foo').pluralizable
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
150 False
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
151 >>> Message(('foo', 'bar')).pluralizable
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
152 True
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
153
61
da7efa40a9e2 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: 56
diff changeset
154 :type: `bool`
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
155 """)
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
156
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
157 def python_format(self):
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
158 ids = self.id
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
159 if not isinstance(ids, (list, tuple)):
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
160 ids = [ids]
220
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
161 return bool(filter(None, [PYTHON_FORMAT.search(id) for id in ids]))
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
162 python_format = property(python_format, doc="""\
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
163 Whether the message contains Python-style parameters.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
164
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
165 >>> Message('foo %(name)s bar').python_format
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
166 True
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
167 >>> Message(('foo %(name)s', 'foo %(name)s')).python_format
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
168 True
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
169
61
da7efa40a9e2 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: 56
diff changeset
170 :type: `bool`
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
171 """)
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
172
105
f744dd56573d `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 104
diff changeset
173
220
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
174 class TranslationError(Exception):
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
175 """Exception thrown by translation checkers when invalid message
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
176 translations are encountered."""
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
177
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
178
104
22f222e23b86 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: 103
diff changeset
179 DEFAULT_HEADER = u"""\
22f222e23b86 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: 103
diff changeset
180 # Translations template for PROJECT.
120
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
181 # Copyright (C) YEAR ORGANIZATION
104
22f222e23b86 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: 103
diff changeset
182 # This file is distributed under the same license as the PROJECT project.
22f222e23b86 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: 103
diff changeset
183 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
22f222e23b86 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: 103
diff changeset
184 #"""
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
185
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 188
diff changeset
186
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
187 class Catalog(object):
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
188 """Representation of a message catalog."""
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
189
104
22f222e23b86 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: 103
diff changeset
190 def __init__(self, locale=None, domain=None, header_comment=DEFAULT_HEADER,
22f222e23b86 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: 103
diff changeset
191 project=None, version=None, copyright_holder=None,
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
192 msgid_bugs_address=None, creation_date=None,
206
2fe580515695 Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 203
diff changeset
193 revision_date=None, last_translator=None, language_team=None,
2fe580515695 Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 203
diff changeset
194 charset='utf-8', fuzzy=True):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
195 """Initialize the catalog object.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
196
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
197 :param locale: the locale identifier or `Locale` object, or `None`
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
198 if the catalog is not bound to a locale (which basically
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
199 means it's a template)
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
200 :param domain: the message domain
104
22f222e23b86 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: 103
diff changeset
201 :param header_comment: the header comment as string, or `None` for the
22f222e23b86 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: 103
diff changeset
202 default header
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
203 :param project: the project's name
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
204 :param version: the project's version
104
22f222e23b86 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: 103
diff changeset
205 :param copyright_holder: the copyright holder of the catalog
22f222e23b86 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: 103
diff changeset
206 :param msgid_bugs_address: the email address or URL to submit bug
22f222e23b86 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: 103
diff changeset
207 reports to
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
208 :param creation_date: the date the catalog was created
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
209 :param revision_date: the date the catalog was revised
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
210 :param last_translator: the name and email of the last translator
206
2fe580515695 Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 203
diff changeset
211 :param language_team: the name and email of the language team
104
22f222e23b86 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: 103
diff changeset
212 :param charset: the encoding to use in the output
175
3c4718fb7435 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: 165
diff changeset
213 :param fuzzy: the fuzzy bit on the catalog header
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
214 """
107
be19f079ee51 Minor doc improvements.
cmlenz
parents: 106
diff changeset
215 self.domain = domain #: The message domain
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
216 if locale:
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
217 locale = Locale.parse(locale)
107
be19f079ee51 Minor doc improvements.
cmlenz
parents: 106
diff changeset
218 self.locale = locale #: The locale or `None`
104
22f222e23b86 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: 103
diff changeset
219 self._header_comment = header_comment
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
220 self._messages = odict()
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
221
107
be19f079ee51 Minor doc improvements.
cmlenz
parents: 106
diff changeset
222 self.project = project or 'PROJECT' #: The project name
be19f079ee51 Minor doc improvements.
cmlenz
parents: 106
diff changeset
223 self.version = version or 'VERSION' #: The project version
104
22f222e23b86 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: 103
diff changeset
224 self.copyright_holder = copyright_holder or 'ORGANIZATION'
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
225 self.msgid_bugs_address = msgid_bugs_address or 'EMAIL@ADDRESS'
106
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
226
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
227 self.last_translator = last_translator or 'FULL NAME <EMAIL@ADDRESS>'
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
228 """Name and email address of the last translator."""
206
2fe580515695 Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 203
diff changeset
229 self.language_team = language_team or 'LANGUAGE <LL@li.org>'
2fe580515695 Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 203
diff changeset
230 """Name and email address of the language team."""
106
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
231
95
008cd3f7d485 Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 87
diff changeset
232 self.charset = charset or 'utf-8'
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
233
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
234 if creation_date is None:
97
a02952b73cf1 Renamed `LOCAL` to `LOCALTZ`.
cmlenz
parents: 95
diff changeset
235 creation_date = datetime.now(LOCALTZ)
95
008cd3f7d485 Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 87
diff changeset
236 elif isinstance(creation_date, datetime) and not creation_date.tzinfo:
97
a02952b73cf1 Renamed `LOCAL` to `LOCALTZ`.
cmlenz
parents: 95
diff changeset
237 creation_date = creation_date.replace(tzinfo=LOCALTZ)
107
be19f079ee51 Minor doc improvements.
cmlenz
parents: 106
diff changeset
238 self.creation_date = creation_date #: Creation date of the template
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
239 if revision_date is None:
97
a02952b73cf1 Renamed `LOCAL` to `LOCALTZ`.
cmlenz
parents: 95
diff changeset
240 revision_date = datetime.now(LOCALTZ)
95
008cd3f7d485 Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 87
diff changeset
241 elif isinstance(revision_date, datetime) and not revision_date.tzinfo:
97
a02952b73cf1 Renamed `LOCAL` to `LOCALTZ`.
cmlenz
parents: 95
diff changeset
242 revision_date = revision_date.replace(tzinfo=LOCALTZ)
107
be19f079ee51 Minor doc improvements.
cmlenz
parents: 106
diff changeset
243 self.revision_date = revision_date #: Last revision date of the catalog
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 175
diff changeset
244 self.fuzzy = fuzzy #: Catalog header fuzzy bit (`True` or `False`)
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 175
diff changeset
245
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 175
diff changeset
246 self.obsolete = odict() #: Dictionary of obsolete messages
333
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
247 self._num_plurals = None
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
248 self._plural_expr = None
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
249
107
be19f079ee51 Minor doc improvements.
cmlenz
parents: 106
diff changeset
250 def _get_header_comment(self):
104
22f222e23b86 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: 103
diff changeset
251 comment = self._header_comment
22f222e23b86 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: 103
diff changeset
252 comment = comment.replace('PROJECT', self.project) \
22f222e23b86 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: 103
diff changeset
253 .replace('VERSION', self.version) \
22f222e23b86 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: 103
diff changeset
254 .replace('YEAR', self.revision_date.strftime('%Y')) \
120
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
255 .replace('ORGANIZATION', self.copyright_holder)
104
22f222e23b86 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: 103
diff changeset
256 if self.locale:
107
be19f079ee51 Minor doc improvements.
cmlenz
parents: 106
diff changeset
257 comment = comment.replace('Translations template', '%s translations'
be19f079ee51 Minor doc improvements.
cmlenz
parents: 106
diff changeset
258 % self.locale.english_name)
104
22f222e23b86 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: 103
diff changeset
259 return comment
120
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
260
107
be19f079ee51 Minor doc improvements.
cmlenz
parents: 106
diff changeset
261 def _set_header_comment(self, string):
104
22f222e23b86 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: 103
diff changeset
262 self._header_comment = string
107
be19f079ee51 Minor doc improvements.
cmlenz
parents: 106
diff changeset
263
be19f079ee51 Minor doc improvements.
cmlenz
parents: 106
diff changeset
264 header_comment = property(_get_header_comment, _set_header_comment, doc="""\
104
22f222e23b86 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: 103
diff changeset
265 The header comment for the catalog.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
266
104
22f222e23b86 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: 103
diff changeset
267 >>> catalog = Catalog(project='Foobar', version='1.0',
22f222e23b86 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: 103
diff changeset
268 ... copyright_holder='Foo Company')
312
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
269 >>> print catalog.header_comment #doctest: +ELLIPSIS
104
22f222e23b86 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: 103
diff changeset
270 # Translations template for Foobar.
312
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
271 # Copyright (C) ... Foo Company
104
22f222e23b86 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: 103
diff changeset
272 # This file is distributed under the same license as the Foobar project.
312
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
273 # FIRST AUTHOR <EMAIL@ADDRESS>, ....
104
22f222e23b86 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: 103
diff changeset
274 #
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
275
120
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
276 The header can also be set from a string. Any known upper-case variables
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
277 will be replaced when the header is retrieved again:
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
278
120
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
279 >>> catalog = Catalog(project='Foobar', version='1.0',
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
280 ... copyright_holder='Foo Company')
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
281 >>> catalog.header_comment = '''\\
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
282 ... # The POT for my really cool PROJECT project.
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
283 ... # Copyright (C) 1990-2003 ORGANIZATION
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
284 ... # This file is distributed under the same license as the PROJECT
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
285 ... # project.
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
286 ... #'''
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
287 >>> print catalog.header_comment
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
288 # The POT for my really cool Foobar project.
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
289 # Copyright (C) 1990-2003 Foo Company
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
290 # This file is distributed under the same license as the Foobar
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
291 # project.
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
292 #
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
293
104
22f222e23b86 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: 103
diff changeset
294 :type: `unicode`
22f222e23b86 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: 103
diff changeset
295 """)
22f222e23b86 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: 103
diff changeset
296
106
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
297 def _get_mime_headers(self):
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
298 headers = []
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
299 headers.append(('Project-Id-Version',
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
300 '%s %s' % (self.project, self.version)))
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
301 headers.append(('Report-Msgid-Bugs-To', self.msgid_bugs_address))
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
302 headers.append(('POT-Creation-Date',
131
a63812008056 Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows.
cmlenz
parents: 121
diff changeset
303 format_datetime(self.creation_date, 'yyyy-MM-dd HH:mmZ',
a63812008056 Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows.
cmlenz
parents: 121
diff changeset
304 locale='en')))
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
305 if self.locale is None:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
306 headers.append(('PO-Revision-Date', 'YEAR-MO-DA HO:MI+ZONE'))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
307 headers.append(('Last-Translator', 'FULL NAME <EMAIL@ADDRESS>'))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
308 headers.append(('Language-Team', 'LANGUAGE <LL@li.org>'))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
309 else:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
310 headers.append(('PO-Revision-Date',
131
a63812008056 Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows.
cmlenz
parents: 121
diff changeset
311 format_datetime(self.revision_date,
a63812008056 Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows.
cmlenz
parents: 121
diff changeset
312 'yyyy-MM-dd HH:mmZ', locale='en')))
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
313 headers.append(('Last-Translator', self.last_translator))
206
2fe580515695 Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 203
diff changeset
314 headers.append(('Language-Team',
2fe580515695 Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 203
diff changeset
315 self.language_team.replace('LANGUAGE',
2fe580515695 Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 203
diff changeset
316 str(self.locale))))
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
317 headers.append(('Plural-Forms', self.plural_forms))
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
318 headers.append(('MIME-Version', '1.0'))
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
319 headers.append(('Content-Type',
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
320 'text/plain; charset=%s' % self.charset))
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
321 headers.append(('Content-Transfer-Encoding', '8bit'))
105
f744dd56573d `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 104
diff changeset
322 headers.append(('Generated-By', 'Babel %s\n' % VERSION))
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
323 return headers
106
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
324
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
325 def _set_mime_headers(self, headers):
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
326 for name, value in headers:
545
afdab04b8527 Catalog class should not do decoding of input strings (fixes #256)
fschwarz
parents: 544
diff changeset
327 name = name.lower()
106
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
328 if name == 'project-id-version':
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
329 parts = value.split(' ')
210
6c8b69e150a9 When parsing catalog headers, look for the content-type first, to be able to use a specified encoding on all other headers.
cmlenz
parents: 206
diff changeset
330 self.project = u' '.join(parts[:-1])
106
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
331 self.version = parts[-1]
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
332 elif name == 'report-msgid-bugs-to':
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
333 self.msgid_bugs_address = value
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
334 elif name == 'last-translator':
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
335 self.last_translator = value
206
2fe580515695 Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 203
diff changeset
336 elif name == 'language-team':
2fe580515695 Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 203
diff changeset
337 self.language_team = value
545
afdab04b8527 Catalog class should not do decoding of input strings (fixes #256)
fschwarz
parents: 544
diff changeset
338 elif name == 'content-type':
afdab04b8527 Catalog class should not do decoding of input strings (fixes #256)
fschwarz
parents: 544
diff changeset
339 mimetype, params = parse_header(value)
afdab04b8527 Catalog class should not do decoding of input strings (fixes #256)
fschwarz
parents: 544
diff changeset
340 if 'charset' in params:
afdab04b8527 Catalog class should not do decoding of input strings (fixes #256)
fschwarz
parents: 544
diff changeset
341 self.charset = params['charset'].lower()
333
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
342 elif name == 'plural-forms':
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
343 _, params = parse_header(' ;' + value)
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
344 self._num_plurals = int(params.get('nplurals', 2))
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
345 self._plural_expr = params.get('plural', '(n != 1)')
106
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
346 elif name == 'pot-creation-date':
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
347 # FIXME: this should use dates.parse_datetime as soon as that
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
348 # is ready
427
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
349 value, tzoffset, _ = re.split('([+-]\d{4})$', value, 1)
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
350
106
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
351 tt = time.strptime(value, '%Y-%m-%d %H:%M')
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
352 ts = time.mktime(tt)
427
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
353
478
b3cda9211fb7 Fix typos.
jruigrok
parents: 427
diff changeset
354 # Separate the offset into a sign component, hours, and minutes
427
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
355 plus_minus_s, rest = tzoffset[0], tzoffset[1:]
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
356 hours_offset_s, mins_offset_s = rest[:2], rest[2:]
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
357
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
358 # Make them all integers
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
359 plus_minus = int(plus_minus_s + '1')
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
360 hours_offset = int(hours_offset_s)
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
361 mins_offset = int(mins_offset_s)
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
362
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
363 # Calculate net offset
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
364 net_mins_offset = hours_offset * 60
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
365 net_mins_offset += mins_offset
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
366 net_mins_offset *= plus_minus
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
367
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
368 # Create an offset object
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
369 tzoffset = FixedOffsetTimezone(net_mins_offset)
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
370
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
371 # Store the offset in a datetime object
121
78a9033b6839 Fix parsing of timezone in POT creation date.
cmlenz
parents: 120
diff changeset
372 dt = datetime.fromtimestamp(ts)
78a9033b6839 Fix parsing of timezone in POT creation date.
cmlenz
parents: 120
diff changeset
373 self.creation_date = dt.replace(tzinfo=tzoffset)
422
3dd226bb3ec3 Final and complete fix for #148.
palgarvio
parents: 418
diff changeset
374 elif name == 'po-revision-date':
3dd226bb3ec3 Final and complete fix for #148.
palgarvio
parents: 418
diff changeset
375 # Keep the value if it's not the default one
3dd226bb3ec3 Final and complete fix for #148.
palgarvio
parents: 418
diff changeset
376 if 'YEAR' not in value:
3dd226bb3ec3 Final and complete fix for #148.
palgarvio
parents: 418
diff changeset
377 # FIXME: this should use dates.parse_datetime as soon as
3dd226bb3ec3 Final and complete fix for #148.
palgarvio
parents: 418
diff changeset
378 # that is ready
427
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
379 value, tzoffset, _ = re.split('([+-]\d{4})$', value, 1)
422
3dd226bb3ec3 Final and complete fix for #148.
palgarvio
parents: 418
diff changeset
380 tt = time.strptime(value, '%Y-%m-%d %H:%M')
3dd226bb3ec3 Final and complete fix for #148.
palgarvio
parents: 418
diff changeset
381 ts = time.mktime(tt)
427
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
382
478
b3cda9211fb7 Fix typos.
jruigrok
parents: 427
diff changeset
383 # Separate the offset into a sign component, hours, and
427
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
384 # minutes
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
385 plus_minus_s, rest = tzoffset[0], tzoffset[1:]
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
386 hours_offset_s, mins_offset_s = rest[:2], rest[2:]
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
387
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
388 # Make them all integers
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
389 plus_minus = int(plus_minus_s + '1')
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
390 hours_offset = int(hours_offset_s)
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
391 mins_offset = int(mins_offset_s)
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
392
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
393 # Calculate net offset
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
394 net_mins_offset = hours_offset * 60
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
395 net_mins_offset += mins_offset
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
396 net_mins_offset *= plus_minus
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
397
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
398 # Create an offset object
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
399 tzoffset = FixedOffsetTimezone(net_mins_offset)
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
400
912e21ea527d Fix Catalog._set_mime_headers' handing of negative offsets.
jruigrok
parents: 425
diff changeset
401 # Store the offset in a datetime object
422
3dd226bb3ec3 Final and complete fix for #148.
palgarvio
parents: 418
diff changeset
402 dt = datetime.fromtimestamp(ts)
3dd226bb3ec3 Final and complete fix for #148.
palgarvio
parents: 418
diff changeset
403 self.revision_date = dt.replace(tzinfo=tzoffset)
106
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
404
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
405 mime_headers = property(_get_mime_headers, _set_mime_headers, doc="""\
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
406 The MIME headers of the catalog, used for the special ``msgid ""`` entry.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
407
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
408 The behavior of this property changes slightly depending on whether a locale
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
409 is set or not, the latter indicating that the catalog is actually a template
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
410 for actual translations.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
411
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
412 Here's an example of the output for such a catalog template:
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
413
95
008cd3f7d485 Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 87
diff changeset
414 >>> created = datetime(1990, 4, 1, 15, 30, tzinfo=UTC)
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
415 >>> catalog = Catalog(project='Foobar', version='1.0',
95
008cd3f7d485 Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 87
diff changeset
416 ... creation_date=created)
104
22f222e23b86 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: 103
diff changeset
417 >>> for name, value in catalog.mime_headers:
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
418 ... print '%s: %s' % (name, value)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
419 Project-Id-Version: Foobar 1.0
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
420 Report-Msgid-Bugs-To: EMAIL@ADDRESS
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
421 POT-Creation-Date: 1990-04-01 15:30+0000
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
422 PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
423 Last-Translator: FULL NAME <EMAIL@ADDRESS>
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
424 Language-Team: LANGUAGE <LL@li.org>
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
425 MIME-Version: 1.0
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
426 Content-Type: text/plain; charset=utf-8
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
427 Content-Transfer-Encoding: 8bit
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
428 Generated-By: Babel ...
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
429
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
430 And here's an example of the output when the locale is set:
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
431
95
008cd3f7d485 Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 87
diff changeset
432 >>> revised = datetime(1990, 8, 3, 12, 0, tzinfo=UTC)
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
433 >>> catalog = Catalog(locale='de_DE', project='Foobar', version='1.0',
95
008cd3f7d485 Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 87
diff changeset
434 ... creation_date=created, revision_date=revised,
206
2fe580515695 Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 203
diff changeset
435 ... last_translator='John Doe <jd@example.com>',
2fe580515695 Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 203
diff changeset
436 ... language_team='de_DE <de@example.com>')
104
22f222e23b86 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: 103
diff changeset
437 >>> for name, value in catalog.mime_headers:
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
438 ... print '%s: %s' % (name, value)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
439 Project-Id-Version: Foobar 1.0
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
440 Report-Msgid-Bugs-To: EMAIL@ADDRESS
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
441 POT-Creation-Date: 1990-04-01 15:30+0000
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
442 PO-Revision-Date: 1990-08-03 12:00+0000
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
443 Last-Translator: John Doe <jd@example.com>
206
2fe580515695 Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 203
diff changeset
444 Language-Team: de_DE <de@example.com>
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
445 Plural-Forms: nplurals=2; plural=(n != 1)
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
446 MIME-Version: 1.0
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
447 Content-Type: text/plain; charset=utf-8
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
448 Content-Transfer-Encoding: 8bit
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
449 Generated-By: Babel ...
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
450
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
451 :type: `list`
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
452 """)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
453
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
454 def num_plurals(self):
373
2316a7fd75d9 Added babel.messages.plurals.get_plural which returns a special tuple with the plural information.
aronacher
parents: 358
diff changeset
455 if self._num_plurals is None:
333
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
456 num = 2
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
457 if self.locale:
373
2316a7fd75d9 Added babel.messages.plurals.get_plural which returns a special tuple with the plural information.
aronacher
parents: 358
diff changeset
458 num = get_plural(self.locale)[0]
333
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
459 self._num_plurals = num
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
460 return self._num_plurals
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
461 num_plurals = property(num_plurals, doc="""\
333
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
462 The number of plurals used by the catalog or locale.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
463
103
7cdf89eb9007 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 97
diff changeset
464 >>> Catalog(locale='en').num_plurals
7cdf89eb9007 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 97
diff changeset
465 2
333
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
466 >>> Catalog(locale='ga').num_plurals
103
7cdf89eb9007 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 97
diff changeset
467 3
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
468
103
7cdf89eb9007 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 97
diff changeset
469 :type: `int`
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
470 """)
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
471
333
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
472 def plural_expr(self):
373
2316a7fd75d9 Added babel.messages.plurals.get_plural which returns a special tuple with the plural information.
aronacher
parents: 358
diff changeset
473 if self._plural_expr is None:
333
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
474 expr = '(n != 1)'
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
475 if self.locale:
373
2316a7fd75d9 Added babel.messages.plurals.get_plural which returns a special tuple with the plural information.
aronacher
parents: 358
diff changeset
476 expr = get_plural(self.locale)[1]
333
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
477 self._plural_expr = expr
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
478 return self._plural_expr
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
479 plural_expr = property(plural_expr, doc="""\
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
480 The plural expression used by the catalog or locale.
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
481
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
482 >>> Catalog(locale='en').plural_expr
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
483 '(n != 1)'
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
484 >>> Catalog(locale='ga').plural_expr
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
485 '(n==1 ? 0 : n==2 ? 1 : 2)'
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
486
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
487 :type: `basestring`
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
488 """)
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
489
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
490 def plural_forms(self):
333
c5f215e893ef Change Catalog class to retain the plural forms set in the MIME headers.
cmlenz
parents: 313
diff changeset
491 return 'nplurals=%s; plural=%s' % (self.num_plurals, self.plural_expr)
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
492 plural_forms = property(plural_forms, doc="""\
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
493 Return the plural forms declaration for the locale.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
494
103
7cdf89eb9007 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 97
diff changeset
495 >>> Catalog(locale='en').plural_forms
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
496 'nplurals=2; plural=(n != 1)'
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
497 >>> Catalog(locale='pt_BR').plural_forms
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
498 'nplurals=2; plural=(n > 1)'
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
499
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
500 :type: `str`
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
501 """)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
502
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
503 def __contains__(self, id):
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
504 """Return whether the catalog has a message with the specified ID."""
69
9b8079807245 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: 68
diff changeset
505 return self._key_for(id) in self._messages
9b8079807245 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: 68
diff changeset
506
9b8079807245 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: 68
diff changeset
507 def __len__(self):
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
508 """The number of messages in the catalog.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
509
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
510 This does not include the special ``msgid ""`` entry.
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
511 """
69
9b8079807245 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: 68
diff changeset
512 return len(self._messages)
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
513
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
514 def __iter__(self):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
515 """Iterates through all the entries in the catalog, in the order they
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
516 were added, yielding a `Message` object for every entry.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
517
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
518 :rtype: ``iterator``
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
519 """
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
520 buf = []
104
22f222e23b86 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: 103
diff changeset
521 for name, value in self.mime_headers:
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
522 buf.append('%s: %s' % (name, value))
198
74a346c7846d Correctly handle non-ASCII chars in the catalog MIME headers.
cmlenz
parents: 196
diff changeset
523 flags = set()
175
3c4718fb7435 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: 165
diff changeset
524 if self.fuzzy:
198
74a346c7846d Correctly handle non-ASCII chars in the catalog MIME headers.
cmlenz
parents: 196
diff changeset
525 flags |= set(['fuzzy'])
210
6c8b69e150a9 When parsing catalog headers, look for the content-type first, to be able to use a specified encoding on all other headers.
cmlenz
parents: 206
diff changeset
526 yield Message(u'', '\n'.join(buf), flags=flags)
69
9b8079807245 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: 68
diff changeset
527 for key in self._messages:
9b8079807245 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: 68
diff changeset
528 yield self._messages[key]
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
529
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
530 def __repr__(self):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
531 locale = ''
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
532 if self.locale:
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
533 locale = ' %s' % self.locale
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
534 return '<%s %r%s>' % (type(self).__name__, self.domain, locale)
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
535
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
536 def __delitem__(self, id):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
537 """Delete the message with the specified ID."""
350
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
538 self.delete(id)
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
539
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
540 def __getitem__(self, id):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
541 """Return the message with the specified ID.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
542
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
543 :param id: the message ID
350
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
544 :return: the message with the specified ID, or `None` if no such
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
545 message is in the catalog
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
546 :rtype: `Message`
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
547 """
350
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
548 return self.get(id)
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
549
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
550 def __setitem__(self, id, message):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
551 """Add or update the message with the specified ID.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
552
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
553 >>> catalog = Catalog()
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
554 >>> catalog[u'foo'] = Message(u'foo')
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
555 >>> catalog[u'foo']
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 188
diff changeset
556 <Message u'foo' (flags: [])>
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
557
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
558 If a message with that ID is already in the catalog, it is updated
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
559 to include the locations and flags of the new message.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
560
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
561 >>> catalog = Catalog()
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
562 >>> catalog[u'foo'] = Message(u'foo', locations=[('main.py', 1)])
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
563 >>> catalog[u'foo'].locations
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
564 [('main.py', 1)]
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
565 >>> catalog[u'foo'] = Message(u'foo', locations=[('utils.py', 5)])
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
566 >>> catalog[u'foo'].locations
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
567 [('main.py', 1), ('utils.py', 5)]
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
568
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
569 :param id: the message ID
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
570 :param message: the `Message` object
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
571 """
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
572 assert isinstance(message, Message), 'expected a Message object'
350
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
573 key = self._key_for(id, message.context)
69
9b8079807245 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: 68
diff changeset
574 current = self._messages.get(key)
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
575 if current:
69
9b8079807245 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: 68
diff changeset
576 if message.pluralizable and not current.pluralizable:
9b8079807245 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: 68
diff changeset
577 # The new message adds pluralization
9b8079807245 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: 68
diff changeset
578 current.id = message.id
70
2b0e18a04856 Fix for mixed singular/plural messages, follow-up to [70].
cmlenz
parents: 69
diff changeset
579 current.string = message.string
229
9a3f2acb55e6 Remove duplicate locations of catalog messages.
cmlenz
parents: 228
diff changeset
580 current.locations = list(distinct(current.locations +
9a3f2acb55e6 Remove duplicate locations of catalog messages.
cmlenz
parents: 228
diff changeset
581 message.locations))
228
fd29fabdc986 Follow-up to [239]: also combine duplicate comments when writing PO files.
cmlenz
parents: 227
diff changeset
582 current.auto_comments = list(distinct(current.auto_comments +
fd29fabdc986 Follow-up to [239]: also combine duplicate comments when writing PO files.
cmlenz
parents: 227
diff changeset
583 message.auto_comments))
fd29fabdc986 Follow-up to [239]: also combine duplicate comments when writing PO files.
cmlenz
parents: 227
diff changeset
584 current.user_comments = list(distinct(current.user_comments +
fd29fabdc986 Follow-up to [239]: also combine duplicate comments when writing PO files.
cmlenz
parents: 227
diff changeset
585 message.user_comments))
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
586 current.flags |= message.flags
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
587 message = current
106
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
588 elif id == '':
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
589 # special treatment for the header message
545
afdab04b8527 Catalog class should not do decoding of input strings (fixes #256)
fschwarz
parents: 544
diff changeset
590 def _parse_header(header_string):
afdab04b8527 Catalog class should not do decoding of input strings (fixes #256)
fschwarz
parents: 544
diff changeset
591 # message_from_string only works for str, not for unicode
afdab04b8527 Catalog class should not do decoding of input strings (fixes #256)
fschwarz
parents: 544
diff changeset
592 headers = message_from_string(header_string.encode('utf8'))
afdab04b8527 Catalog class should not do decoding of input strings (fixes #256)
fschwarz
parents: 544
diff changeset
593 decoded_headers = {}
afdab04b8527 Catalog class should not do decoding of input strings (fixes #256)
fschwarz
parents: 544
diff changeset
594 for name, value in headers.items():
afdab04b8527 Catalog class should not do decoding of input strings (fixes #256)
fschwarz
parents: 544
diff changeset
595 name = name.decode('utf8')
afdab04b8527 Catalog class should not do decoding of input strings (fixes #256)
fschwarz
parents: 544
diff changeset
596 value = value.decode('utf8')
afdab04b8527 Catalog class should not do decoding of input strings (fixes #256)
fschwarz
parents: 544
diff changeset
597 decoded_headers[name] = value
afdab04b8527 Catalog class should not do decoding of input strings (fixes #256)
fschwarz
parents: 544
diff changeset
598 return decoded_headers
afdab04b8527 Catalog class should not do decoding of input strings (fixes #256)
fschwarz
parents: 544
diff changeset
599 self.mime_headers = _parse_header(message.string).items()
120
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
600 self.header_comment = '\n'.join(['# %s' % comment for comment
733cca7ff6a5 Added tests for `new_catalog` distutils command.
cmlenz
parents: 107
diff changeset
601 in message.user_comments])
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 188
diff changeset
602 self.fuzzy = message.fuzzy
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
603 else:
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
604 if isinstance(id, (list, tuple)):
277
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
605 assert isinstance(message.string, (list, tuple)), \
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
606 'Expected sequence but got %s' % type(message.string)
69
9b8079807245 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: 68
diff changeset
607 self._messages[key] = message
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
608
105
f744dd56573d `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 104
diff changeset
609 def add(self, id, string=None, locations=(), flags=(), auto_comments=(),
335
9c41fe73e2e6 More preparation for msgctxt support (#54).
cmlenz
parents: 333
diff changeset
610 user_comments=(), previous_id=(), lineno=None, context=None):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
611 """Add or update the message with the specified ID.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
612
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
613 >>> catalog = Catalog()
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
614 >>> catalog.add(u'foo')
544
030ddf3f5b13 catalog.add() now returns the message instance (closes #245)
fschwarz
parents: 530
diff changeset
615 <Message ...>
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
616 >>> catalog[u'foo']
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 188
diff changeset
617 <Message u'foo' (flags: [])>
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
618
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
619 This method simply constructs a `Message` object with the given
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
620 arguments and invokes `__setitem__` with that object.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
621
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
622 :param id: the message ID, or a ``(singular, plural)`` tuple for
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
623 pluralizable messages
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
624 :param string: the translated message string, or a
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
625 ``(singular, plural)`` tuple for pluralizable messages
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
626 :param locations: a sequence of ``(filenname, lineno)`` tuples
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
627 :param flags: a set or sequence of flags
106
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
628 :param auto_comments: a sequence of automatic comments
9b22b36066f6 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 105
diff changeset
629 :param user_comments: a sequence of user comments
203
e50aaaabb3d3 Minor changes to how previous msgids are processed.
cmlenz
parents: 202
diff changeset
630 :param previous_id: the previous message ID, or a ``(singular, plural)``
e50aaaabb3d3 Minor changes to how previous msgids are processed.
cmlenz
parents: 202
diff changeset
631 tuple for pluralizable messages
220
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
632 :param lineno: the line number on which the msgid line was found in the
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
633 PO file, if any
335
9c41fe73e2e6 More preparation for msgctxt support (#54).
cmlenz
parents: 333
diff changeset
634 :param context: the message context
544
030ddf3f5b13 catalog.add() now returns the message instance (closes #245)
fschwarz
parents: 530
diff changeset
635 :return: the newly added message
030ddf3f5b13 catalog.add() now returns the message instance (closes #245)
fschwarz
parents: 530
diff changeset
636 :rtype: `Message`
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
637 """
544
030ddf3f5b13 catalog.add() now returns the message instance (closes #245)
fschwarz
parents: 530
diff changeset
638 message = Message(id, string, list(locations), flags, auto_comments,
030ddf3f5b13 catalog.add() now returns the message instance (closes #245)
fschwarz
parents: 530
diff changeset
639 user_comments, previous_id, lineno=lineno,
030ddf3f5b13 catalog.add() now returns the message instance (closes #245)
fschwarz
parents: 530
diff changeset
640 context=context)
030ddf3f5b13 catalog.add() now returns the message instance (closes #245)
fschwarz
parents: 530
diff changeset
641 self[id] = message
030ddf3f5b13 catalog.add() now returns the message instance (closes #245)
fschwarz
parents: 530
diff changeset
642 return message
220
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
643
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
644 def check(self):
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
645 """Run various validation checks on the translations in the catalog.
226
236a640d02a6 Only write unique comments, no duplicates.
palgarvio
parents: 225
diff changeset
646
220
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
647 For every message which fails validation, this method yield a
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
648 ``(message, errors)`` tuple, where ``message`` is the `Message` object
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
649 and ``errors`` is a sequence of `TranslationError` objects.
226
236a640d02a6 Only write unique comments, no duplicates.
palgarvio
parents: 225
diff changeset
650
220
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
651 :rtype: ``iterator``
677147547e2d Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 210
diff changeset
652 """
352
20d10066a42a The builtin checkers don't require setuptools any longer, validate_format and python_format from the checkers module are merged into one now.
aronacher
parents: 351
diff changeset
653 for message in self._messages.values():
355
e989a5f2fdff Refactored the checker system. It's now possible to partially validate translations on a per-message level.
aronacher
parents: 354
diff changeset
654 errors = message.check(catalog=self)
352
20d10066a42a The builtin checkers don't require setuptools any longer, validate_format and python_format from the checkers module are merged into one now.
aronacher
parents: 351
diff changeset
655 if errors:
20d10066a42a The builtin checkers don't require setuptools any longer, validate_format and python_format from the checkers module are merged into one now.
aronacher
parents: 351
diff changeset
656 yield message, errors
69
9b8079807245 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: 68
diff changeset
657
350
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
658 def get(self, id, context=None):
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
659 """Return the message with the specified ID and context.
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
660
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
661 :param id: the message ID
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
662 :param context: the message context, or ``None`` for no context
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
663 :return: the message with the specified ID, or `None` if no such
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
664 message is in the catalog
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
665 :rtype: `Message`
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
666 """
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
667 return self._messages.get(self._key_for(id, context))
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
668
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
669 def delete(self, id, context=None):
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
670 """Delete the message with the specified ID and context.
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
671
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
672 :param id: the message ID
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
673 :param context: the message context, or ``None`` for no context
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
674 """
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
675 key = self._key_for(id, context)
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
676 if key in self._messages:
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
677 del self._messages[key]
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
678
203
e50aaaabb3d3 Minor changes to how previous msgids are processed.
cmlenz
parents: 202
diff changeset
679 def update(self, template, no_fuzzy_matching=False):
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
680 """Update the catalog based on the given template catalog.
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
681
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
682 >>> from babel.messages import Catalog
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
683 >>> template = Catalog()
188
6df39fb2699e Fix adding new messages in catalog update.
cmlenz
parents: 181
diff changeset
684 >>> template.add('green', locations=[('main.py', 99)])
544
030ddf3f5b13 catalog.add() now returns the message instance (closes #245)
fschwarz
parents: 530
diff changeset
685 <Message ...>
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
686 >>> template.add('blue', locations=[('main.py', 100)])
544
030ddf3f5b13 catalog.add() now returns the message instance (closes #245)
fschwarz
parents: 530
diff changeset
687 <Message ...>
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
688 >>> template.add(('salad', 'salads'), locations=[('util.py', 42)])
544
030ddf3f5b13 catalog.add() now returns the message instance (closes #245)
fschwarz
parents: 530
diff changeset
689 <Message ...>
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
690 >>> catalog = Catalog(locale='de_DE')
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
691 >>> catalog.add('blue', u'blau', locations=[('main.py', 98)])
544
030ddf3f5b13 catalog.add() now returns the message instance (closes #245)
fschwarz
parents: 530
diff changeset
692 <Message ...>
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
693 >>> catalog.add('head', u'Kopf', locations=[('util.py', 33)])
544
030ddf3f5b13 catalog.add() now returns the message instance (closes #245)
fschwarz
parents: 530
diff changeset
694 <Message ...>
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
695 >>> catalog.add(('salad', 'salads'), (u'Salat', u'Salate'),
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
696 ... locations=[('util.py', 38)])
544
030ddf3f5b13 catalog.add() now returns the message instance (closes #245)
fschwarz
parents: 530
diff changeset
697 <Message ...>
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
698
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 175
diff changeset
699 >>> catalog.update(template)
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
700 >>> len(catalog)
188
6df39fb2699e Fix adding new messages in catalog update.
cmlenz
parents: 181
diff changeset
701 3
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
702
188
6df39fb2699e Fix adding new messages in catalog update.
cmlenz
parents: 181
diff changeset
703 >>> msg1 = catalog['green']
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
704 >>> msg1.string
188
6df39fb2699e Fix adding new messages in catalog update.
cmlenz
parents: 181
diff changeset
705 >>> msg1.locations
6df39fb2699e Fix adding new messages in catalog update.
cmlenz
parents: 181
diff changeset
706 [('main.py', 99)]
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
707
188
6df39fb2699e Fix adding new messages in catalog update.
cmlenz
parents: 181
diff changeset
708 >>> msg2 = catalog['blue']
6df39fb2699e Fix adding new messages in catalog update.
cmlenz
parents: 181
diff changeset
709 >>> msg2.string
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
710 u'blau'
188
6df39fb2699e Fix adding new messages in catalog update.
cmlenz
parents: 181
diff changeset
711 >>> msg2.locations
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
712 [('main.py', 100)]
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
713
188
6df39fb2699e Fix adding new messages in catalog update.
cmlenz
parents: 181
diff changeset
714 >>> msg3 = catalog['salad']
6df39fb2699e Fix adding new messages in catalog update.
cmlenz
parents: 181
diff changeset
715 >>> msg3.string
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
716 (u'Salat', u'Salate')
188
6df39fb2699e Fix adding new messages in catalog update.
cmlenz
parents: 181
diff changeset
717 >>> msg3.locations
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
718 [('util.py', 42)]
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
719
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 175
diff changeset
720 Messages that are in the catalog but not in the template are removed
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 175
diff changeset
721 from the main collection, but can still be accessed via the `obsolete`
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 175
diff changeset
722 member:
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
723
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
724 >>> 'head' in catalog
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
725 False
181
9a1acb41e7dd The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 175
diff changeset
726 >>> catalog.obsolete.values()
196
93a922d31eca Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 188
diff changeset
727 [<Message 'head' (flags: [])>]
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
728
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
729 :param template: the reference catalog, usually read from a POT file
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
730 :param no_fuzzy_matching: whether to use fuzzy matching of message IDs
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
731 """
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
732 messages = self._messages
312
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
733 remaining = messages.copy()
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
734 self._messages = odict()
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
735
312
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
736 # Prepare for fuzzy matching
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
737 fuzzy_candidates = []
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
738 if not no_fuzzy_matching:
350
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
739 fuzzy_candidates = dict([
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
740 (self._key_for(msgid), messages[msgid].context)
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
741 for msgid in messages if msgid and messages[msgid].string
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
742 ])
312
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
743 fuzzy_matches = set()
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
744
277
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
745 def _merge(message, oldkey, newkey):
313
559c80b1ffb2 Merging catalogs would sometimes mix translations from different runs.
cmlenz
parents: 312
diff changeset
746 message = message.clone()
277
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
747 fuzzy = False
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
748 if oldkey != newkey:
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
749 fuzzy = True
312
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
750 fuzzy_matches.add(oldkey)
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
751 oldmsg = messages.get(oldkey)
277
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
752 if isinstance(oldmsg.id, basestring):
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
753 message.previous_id = [oldmsg.id]
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
754 else:
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
755 message.previous_id = list(oldmsg.id)
312
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
756 else:
337
568170eb7580 Fix iterkeys/iteritems/itervalues/pop/popitem methods on the `odict` utility class. Thanks to Armin Ronacher for the patch.
cmlenz
parents: 335
diff changeset
757 oldmsg = remaining.pop(oldkey, None)
277
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
758 message.string = oldmsg.string
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
759 if isinstance(message.id, (list, tuple)):
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
760 if not isinstance(message.string, (list, tuple)):
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
761 fuzzy = True
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
762 message.string = tuple(
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
763 [message.string] + ([u''] * (len(message.id) - 1))
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
764 )
425
4c8a5e533722 Fuzzy matching regarding plurals should *NOT* be checked against `len(message.id)` because this is always 2, instead, it's should be checked against `catalog.num_plurals`.
palgarvio
parents: 422
diff changeset
765 elif len(message.string) != self.num_plurals:
277
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
766 fuzzy = True
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
767 message.string = tuple(message.string[:len(oldmsg.string)])
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
768 elif isinstance(message.string, (list, tuple)):
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
769 fuzzy = True
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
770 message.string = message.string[0]
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
771 message.flags |= oldmsg.flags
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
772 if fuzzy:
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
773 message.flags |= set([u'fuzzy'])
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
774 self[message.id] = message
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
775
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
776 for message in template:
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
777 if message.id:
350
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
778 key = self._key_for(message.id, message.context)
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
779 if key in messages:
277
7a3f4ca113e4 Fix for updating catalog messages that changed from gettext to ngettext or vice versa.
cmlenz
parents: 250
diff changeset
780 _merge(message, key, key)
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
781 else:
200
2983c718f6e2 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 198
diff changeset
782 if no_fuzzy_matching is False:
165
650a6e996ede Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 163
diff changeset
783 # do some fuzzy matching with difflib
350
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
784 if isinstance(key, tuple):
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
785 matchkey = key[0] # just the msgid, no context
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
786 else:
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
787 matchkey = key
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
788 matches = get_close_matches(matchkey.lower().strip(),
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
789 fuzzy_candidates.keys(), 1)
165
650a6e996ede Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 163
diff changeset
790 if matches:
350
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
791 newkey = matches[0]
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
792 newctxt = fuzzy_candidates[newkey]
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
793 if newctxt is not None:
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
794 newkey = newkey, newctxt
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
795 _merge(message, newkey, key)
188
6df39fb2699e Fix adding new messages in catalog update.
cmlenz
parents: 181
diff changeset
796 continue
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
797
165
650a6e996ede Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 163
diff changeset
798 self[message.id] = message
650a6e996ede Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 163
diff changeset
799
312
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
800 self.obsolete = odict()
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
801 for msgid in remaining:
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
802 if no_fuzzy_matching or msgid not in fuzzy_matches:
61e6b1933af4 Fix catalog updating with fuzzy matches. Closes #82.
cmlenz
parents: 291
diff changeset
803 self.obsolete[msgid] = remaining[msgid]
418
d7ac8fb6b025 Make the `POT-Creation-Date` of the catalog being updated equal to `POT-Creation-Date` of the template used to update. Fixes #148.
palgarvio
parents: 414
diff changeset
804 # Make updated catalog's POT-Creation-Date equal to the template
d7ac8fb6b025 Make the `POT-Creation-Date` of the catalog being updated equal to `POT-Creation-Date` of the template used to update. Fixes #148.
palgarvio
parents: 414
diff changeset
805 # used to update the catalog
d7ac8fb6b025 Make the `POT-Creation-Date` of the catalog being updated equal to `POT-Creation-Date` of the template used to update. Fixes #148.
palgarvio
parents: 414
diff changeset
806 self.creation_date = template.creation_date
163
f2c78a271159 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 149
diff changeset
807
350
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
808 def _key_for(self, id, context=None):
69
9b8079807245 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: 68
diff changeset
809 """The key for a message is just the singular ID even for pluralizable
350
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
810 messages, but is a ``(msgid, msgctxt)`` tuple for context-specific
69
9b8079807245 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: 68
diff changeset
811 messages.
9b8079807245 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: 68
diff changeset
812 """
9b8079807245 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: 68
diff changeset
813 key = id
9b8079807245 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: 68
diff changeset
814 if isinstance(key, (list, tuple)):
9b8079807245 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: 68
diff changeset
815 key = id[0]
350
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
816 if context is not None:
24b8e5ca7a76 More work on msgctxt support (#54).
cmlenz
parents: 337
diff changeset
817 key = (key, context)
69
9b8079807245 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: 68
diff changeset
818 return key
Copyright (C) 2012-2017 Edgewall Software