annotate babel/messages/catalog.py @ 546:10de195cfb04

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