annotate babel/messages/catalog.py @ 351:0d287b3c935e trunk

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