annotate babel/messages/catalog.py @ 229:85340bec3a97

Fix tests broken by [233], and add new tests.
author cmlenz
date Fri, 20 Jul 2007 16:20:43 +0000
parents 629357c88d59
children aaf36f409166
rev   line source
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
1 # -*- coding: utf-8 -*-
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
2 #
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
3 # Copyright (C) 2007 Edgewall Software
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
4 # All rights reserved.
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
5 #
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
6 # This software is licensed as described in the file COPYING, which
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
7 # you should have received as part of this distribution. The terms
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
8 # are also available at http://babel.edgewall.org/wiki/License.
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
9 #
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
10 # This software consists of voluntary contributions made by many
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
11 # individuals. For the exact contribution history, see the revision
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
12 # history and logs, available at http://babel.edgewall.org/log/.
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
13
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
14 """Data structures for message catalogs."""
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
15
151
12e5f21dfcda Respect charset specified in PO headers in `read_po()`. Fixes #17.
cmlenz
parents: 133
diff changeset
16 from cgi import parse_header
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
17 from datetime import datetime
167
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
18 from difflib import get_close_matches
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
19 from email import message_from_string
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
20 import re
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
21 try:
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
22 set
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
23 except NameError:
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
24 from sets import Set as set
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
25 import time
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
26
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
27 from babel import __version__ as VERSION
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
28 from babel.core import Locale
133
9d58665d134c Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows.
cmlenz
parents: 123
diff changeset
29 from babel.dates import format_datetime
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
30 from babel.messages.plurals import PLURALS
229
85340bec3a97 Fix tests broken by [233], and add new tests.
cmlenz
parents: 228
diff changeset
31 from babel.util import odict, distinct, LOCALTZ, UTC, FixedOffsetTimezone
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
32
222
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
33 __all__ = ['Message', 'Catalog', 'TranslationError']
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
34 __docformat__ = 'restructuredtext en'
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
35
227
f358dd40a960 Applied patch by Ramiro Morales for more extensive detection of Python string formatting specifiers. Closes #57.
cmlenz
parents: 222
diff changeset
36 PYTHON_FORMAT = re.compile(r'\%(\([\w]+\))?([-#0\ +])?(\*|[\d]+)?(\.(\*|[\d]+))?([hlL])?[diouxXeEfFgGcrs]')
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
37
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
38
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
39 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
40 """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
41
151
12e5f21dfcda Respect charset specified in PO headers in `read_po()`. Fixes #17.
cmlenz
parents: 133
diff changeset
42 def __init__(self, id, string=u'', locations=(), flags=(), auto_comments=(),
222
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
43 user_comments=(), previous_id=(), lineno=None):
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
44 """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
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 :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
47 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
48 :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
49 ``(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
50 :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
51 :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
52 :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
53 :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
54 :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
55 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
56 :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
57 PO file, if any
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
58 """
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
59 self.id = id #: The message ID
70
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
60 if not string and self.pluralizable:
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
61 string = (u'', u'')
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
62 self.string = string #: The message translation
72
f5a6bf38df89 Fix for mixed singular/plural messages, follow-up to [70].
cmlenz
parents: 71
diff changeset
63 self.locations = list(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
64 self.flags = set(flags)
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
65 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
66 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
67 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
68 self.flags.discard('python-format')
229
85340bec3a97 Fix tests broken by [233], and add new tests.
cmlenz
parents: 228
diff changeset
69 self.auto_comments = list(distinct(auto_comments))
85340bec3a97 Fix tests broken by [233], and add new tests.
cmlenz
parents: 228
diff changeset
70 self.user_comments = list(distinct(user_comments))
205
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
71 if isinstance(previous_id, basestring):
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
72 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
73 else:
205
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
74 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
75 self.lineno = lineno
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
76
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
77 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
78 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
79 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
80
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
81 def fuzzy(self):
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
82 return 'fuzzy' in self.flags
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
83 fuzzy = property(fuzzy, doc="""\
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
84 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
85
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
86 >>> Message('foo').fuzzy
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
87 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
88 >>> 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
89 >>> msg.fuzzy
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
90 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
91 >>> msg
198
982d7e704fdc Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 190
diff changeset
92 <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
93
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
94 :type: `bool`
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
95 """)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
96
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
97 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
98 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
99 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
100 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
101
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
102 >>> 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
103 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
104 >>> 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
105 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
106
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
107 :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
108 """)
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
109
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
110 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
111 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
112 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
113 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
114 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
115 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
116 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
117
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
118 >>> 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
119 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
120 >>> 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
121 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
122
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
123 :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
124 """)
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
125
107
4b42e23644e5 `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 106
diff changeset
126
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
127 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
128 """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
129 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
130
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
131
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
132 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
133 # Translations template for PROJECT.
122
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
134 # 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
135 # 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
136 # 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
137 #"""
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
138
198
982d7e704fdc Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.
cmlenz
parents: 190
diff changeset
139
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
140 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
141 """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
142
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
143 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
144 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
145 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
146 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
147 charset='utf-8', fuzzy=True):
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
148 """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
149
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
150 :param locale: the locale identifier or `Locale` object, or `None`
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
151 if the catalog is not bound to a locale (which basically
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
152 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
153 :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
154 :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
155 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
156 :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
157 :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
158 :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
159 :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
160 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
161 :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
162 :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
163 :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
164 :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
165 :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
166 :param fuzzy: the fuzzy bit on the catalog header
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
167 """
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
168 self.domain = domain #: The message domain
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
169 if locale:
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
170 locale = Locale.parse(locale)
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
171 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
172 self._header_comment = header_comment
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
173 self._messages = odict()
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
174
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
175 self.project = project or 'PROJECT' #: The project name
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
176 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
177 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
178 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
179
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
180 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
181 """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
182 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
183 """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
184
97
debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 89
diff changeset
185 self.charset = charset or 'utf-8'
86
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
186
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
187 if creation_date is None:
99
b6b5992daa6c Renamed `LOCAL` to `LOCALTZ`.
cmlenz
parents: 97
diff changeset
188 creation_date = datetime.now(LOCALTZ)
97
debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 89
diff changeset
189 elif isinstance(creation_date, datetime) and not creation_date.tzinfo:
99
b6b5992daa6c Renamed `LOCAL` to `LOCALTZ`.
cmlenz
parents: 97
diff changeset
190 creation_date = creation_date.replace(tzinfo=LOCALTZ)
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
191 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
192 if revision_date is None:
99
b6b5992daa6c Renamed `LOCAL` to `LOCALTZ`.
cmlenz
parents: 97
diff changeset
193 revision_date = datetime.now(LOCALTZ)
97
debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 89
diff changeset
194 elif isinstance(revision_date, datetime) and not revision_date.tzinfo:
99
b6b5992daa6c Renamed `LOCAL` to `LOCALTZ`.
cmlenz
parents: 97
diff changeset
195 revision_date = revision_date.replace(tzinfo=LOCALTZ)
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
196 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
197 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
198
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 177
diff changeset
199 self.obsolete = odict() #: Dictionary of obsolete messages
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
200
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
201 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
202 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
203 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
204 .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
205 .replace('YEAR', self.revision_date.strftime('%Y')) \
122
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
206 .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
207 if self.locale:
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
208 comment = comment.replace('Translations template', '%s translations'
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
209 % 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
210 return comment
122
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
211
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
212 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
213 self._header_comment = string
109
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
214
7a5a7bf39d3d Minor doc improvements.
cmlenz
parents: 108
diff changeset
215 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
216 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
217
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
218 >>> 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
219 ... copyright_holder='Foo Company')
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
220 >>> print catalog.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
221 # Translations template for Foobar.
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
222 # Copyright (C) 2007 Foo Company
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
223 # This file is distributed under the same license as the Foobar 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
224 # FIRST AUTHOR <EMAIL@ADDRESS>, 2007.
2a00e352c986 Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction.
cmlenz
parents: 105
diff changeset
225 #
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
226
122
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
227 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
228 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
229
122
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
230 >>> catalog = Catalog(project='Foobar', version='1.0',
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
231 ... copyright_holder='Foo Company')
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
232 >>> catalog.header_comment = '''\\
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
233 ... # The POT for my really cool PROJECT project.
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
234 ... # Copyright (C) 1990-2003 ORGANIZATION
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
235 ... # This file is distributed under the same license as the PROJECT
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
236 ... # project.
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
237 ... #'''
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
238 >>> print catalog.header_comment
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
239 # The POT for my really cool Foobar project.
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
240 # Copyright (C) 1990-2003 Foo Company
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
241 # This file is distributed under the same license as the Foobar
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
242 # project.
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
243 #
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
244
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
245 :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
246 """)
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
247
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
248 def _get_mime_headers(self):
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
249 headers = []
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
250 headers.append(('Project-Id-Version',
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
251 '%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
252 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
253 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
254 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
255 locale='en')))
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
256 if self.locale is None:
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
257 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
258 headers.append(('Last-Translator', 'FULL NAME <EMAIL@ADDRESS>'))
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
259 headers.append(('Language-Team', 'LANGUAGE <LL@li.org>'))
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
260 else:
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
261 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
262 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
263 'yyyy-MM-dd HH:mmZ', locale='en')))
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
264 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
265 headers.append(('Language-Team',
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
266 self.language_team.replace('LANGUAGE',
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
267 str(self.locale))))
86
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
268 headers.append(('Plural-Forms', self.plural_forms))
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
269 headers.append(('MIME-Version', '1.0'))
70
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
270 headers.append(('Content-Type',
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
271 'text/plain; charset=%s' % self.charset))
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
272 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
273 headers.append(('Generated-By', 'Babel %s\n' % VERSION))
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
274 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
275
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
276 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
277 for name, value in headers:
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
278 if name == 'content-type':
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
279 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
280 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
281 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
282 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
283 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
284 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
285 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
286 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
287 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
288 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
289 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
290 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
291 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
292 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
293 self.last_translator = value
208
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
294 elif name == 'language-team':
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
295 self.language_team = value
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
296 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
297 # 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
298 # is ready
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
299 value, tzoffset, _ = re.split('[+-](\d{4})$', value, 1)
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
300 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
301 ts = time.mktime(tt)
122
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
302 tzoffset = FixedOffsetTimezone(int(tzoffset[:2]) * 60 +
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
303 int(tzoffset[2:]))
123
5b4f302abf53 Fix parsing of timezone in POT creation date.
cmlenz
parents: 122
diff changeset
304 dt = datetime.fromtimestamp(ts)
5b4f302abf53 Fix parsing of timezone in POT creation date.
cmlenz
parents: 122
diff changeset
305 self.creation_date = dt.replace(tzinfo=tzoffset)
108
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
306
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
307 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
308 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
309
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
310 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
311 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
312 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
313
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
314 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
315
97
debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 89
diff changeset
316 >>> created = datetime(1990, 4, 1, 15, 30, tzinfo=UTC)
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
317 >>> 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
318 ... 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
319 >>> for name, value in catalog.mime_headers:
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
320 ... print '%s: %s' % (name, value)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
321 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
322 Report-Msgid-Bugs-To: EMAIL@ADDRESS
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
323 POT-Creation-Date: 1990-04-01 15:30+0000
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
324 PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
325 Last-Translator: FULL NAME <EMAIL@ADDRESS>
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
326 Language-Team: LANGUAGE <LL@li.org>
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
327 MIME-Version: 1.0
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
328 Content-Type: text/plain; charset=utf-8
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
329 Content-Transfer-Encoding: 8bit
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
330 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
331
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
332 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
333
97
debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT).
cmlenz
parents: 89
diff changeset
334 >>> revised = datetime(1990, 8, 3, 12, 0, tzinfo=UTC)
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
335 >>> 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
336 ... creation_date=created, revision_date=revised,
208
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
337 ... last_translator='John Doe <jd@example.com>',
6cd31048eb5c Preserve language-team header in catalogs on update. Closes #35 again.
cmlenz
parents: 205
diff changeset
338 ... 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
339 >>> for name, value in catalog.mime_headers:
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
340 ... print '%s: %s' % (name, value)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
341 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
342 Report-Msgid-Bugs-To: EMAIL@ADDRESS
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
343 POT-Creation-Date: 1990-04-01 15:30+0000
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
344 PO-Revision-Date: 1990-08-03 12:00+0000
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
345 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
346 Language-Team: de_DE <de@example.com>
86
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
347 Plural-Forms: nplurals=2; plural=(n != 1)
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
348 MIME-Version: 1.0
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
349 Content-Type: text/plain; charset=utf-8
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
350 Content-Transfer-Encoding: 8bit
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
351 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
352
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
353 :type: `list`
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
354 """)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
355
70
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
356 def num_plurals(self):
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
357 num = 2
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
358 if self.locale:
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
359 if str(self.locale) in PLURALS:
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
360 num = PLURALS[str(self.locale)][0]
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
361 elif self.locale.language in PLURALS:
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
362 num = PLURALS[self.locale.language][0]
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
363 return num
86
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
364 num_plurals = property(num_plurals, doc="""\
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
365 The number of plurals used by 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
366
105
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 99
diff changeset
367 >>> Catalog(locale='en').num_plurals
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 99
diff changeset
368 2
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 99
diff changeset
369 >>> Catalog(locale='cs_CZ').num_plurals
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 99
diff changeset
370 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
371
105
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 99
diff changeset
372 :type: `int`
86
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
373 """)
70
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
374
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
375 def plural_forms(self):
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
376 num, expr = ('INTEGER', 'EXPRESSION')
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
377 if self.locale:
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
378 if str(self.locale) in PLURALS:
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
379 num, expr = PLURALS[str(self.locale)]
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
380 elif self.locale.language in PLURALS:
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
381 num, expr = PLURALS[self.locale.language]
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
382 return 'nplurals=%s; plural=%s' % (num, expr)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
383 plural_forms = property(plural_forms, doc="""\
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
384 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
385
105
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14.
cmlenz
parents: 99
diff changeset
386 >>> Catalog(locale='en').plural_forms
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
387 'nplurals=2; plural=(n != 1)'
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
388 >>> Catalog(locale='pt_BR').plural_forms
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
389 '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
390
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
391 :type: `str`
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
392 """)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
393
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
394 def __contains__(self, id):
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
395 """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
396 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
397
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
398 def __len__(self):
86
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
399 """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
400
86
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
401 This does not include the special ``msgid ""`` entry.
8a703ecdba91 Some cosmetic changes for the new translator comments support.
cmlenz
parents: 82
diff changeset
402 """
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
403 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
404
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
405 def __iter__(self):
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
406 """Iterates through all the entries in the catalog, in the order they
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
407 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
408
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
409 :rtype: ``iterator``
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
410 """
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
411 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
412 for name, value in self.mime_headers:
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
413 buf.append('%s: %s' % (name, value))
200
2f0161df6a38 Correctly handle non-ASCII chars in the catalog MIME headers.
cmlenz
parents: 198
diff changeset
414 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
415 if self.fuzzy:
200
2f0161df6a38 Correctly handle non-ASCII chars in the catalog MIME headers.
cmlenz
parents: 198
diff changeset
416 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
417 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
418 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
419 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
420
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
421 def __repr__(self):
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
422 locale = ''
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
423 if self.locale:
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
424 locale = ' %s' % self.locale
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
425 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
426
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
427 def __delitem__(self, id):
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
428 """Delete the message with the specified ID."""
71
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
429 key = self._key_for(id)
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
430 if key in self._messages:
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
431 del self._messages[key]
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
432
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
433 def __getitem__(self, id):
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
434 """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
435
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
436 :param id: the message ID
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
437 :return: the message with the specified ID, or `None` if no such message
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
438 is in the catalog
69
1d8e81bfedf9 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 66
diff changeset
439 :rtype: `Message`
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
440 """
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
441 return self._messages.get(self._key_for(id))
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
442
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
443 def __setitem__(self, id, message):
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
444 """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
445
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
446 >>> catalog = Catalog()
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
447 >>> catalog[u'foo'] = Message(u'foo')
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
448 >>> 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
449 <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
450
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
451 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
452 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
453
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
454 >>> catalog = Catalog()
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
455 >>> catalog[u'foo'] = Message(u'foo', locations=[('main.py', 1)])
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
456 >>> catalog[u'foo'].locations
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
457 [('main.py', 1)]
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
458 >>> catalog[u'foo'] = Message(u'foo', locations=[('utils.py', 5)])
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
459 >>> catalog[u'foo'].locations
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
460 [('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
461
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
462 :param id: the message ID
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
463 :param message: the `Message` object
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
464 """
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
465 assert isinstance(message, Message), 'expected a Message object'
71
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
466 key = self._key_for(id)
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
467 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
468 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
469 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
470 # 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
471 current.id = message.id
72
f5a6bf38df89 Fix for mixed singular/plural messages, follow-up to [70].
cmlenz
parents: 71
diff changeset
472 current.string = message.string
58
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
473 current.locations.extend(message.locations)
107
4b42e23644e5 `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 106
diff changeset
474 current.auto_comments.extend(message.auto_comments)
4b42e23644e5 `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 106
diff changeset
475 current.user_comments.extend(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
476 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
477 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
478 elif id == '':
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`.
cmlenz
parents: 107
diff changeset
479 # 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
480 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
481 self.mime_headers = headers.items()
122
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
482 self.header_comment = '\n'.join(['# %s' % comment for comment
03f106700f02 Added tests for `new_catalog` distutils command.
cmlenz
parents: 109
diff changeset
483 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
484 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
485 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
486 if isinstance(id, (list, tuple)):
70
620fdd25657a Add back POT header broken in previous check-in.
cmlenz
parents: 69
diff changeset
487 assert isinstance(message.string, (list, tuple))
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
488 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
489
107
4b42e23644e5 `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 106
diff changeset
490 def add(self, id, string=None, locations=(), flags=(), auto_comments=(),
222
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
491 user_comments=(), previous_id=(), lineno=None):
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
492 """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
493
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
494 >>> catalog = Catalog()
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
495 >>> catalog.add(u'foo')
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
496 >>> 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
497 <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
498
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
499 This method simply constructs a `Message` object with the given
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
500 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
501
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
502 :param id: the message ID, or a ``(singular, plural)`` tuple for
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
503 pluralizable messages
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
504 :param string: the translated message string, or a
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
505 ``(singular, plural)`` tuple for pluralizable messages
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
506 :param locations: a sequence of ``(filenname, lineno)`` tuples
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
507 :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
508 :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
509 :param user_comments: a sequence of user comments
205
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
510 :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
511 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
512 :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
513 PO file, if any
66
d1a7425739d3 `read_po` now returns a `Catalog`.
cmlenz
parents: 63
diff changeset
514 """
107
4b42e23644e5 `Message`, `read_po` and `write_po` now all handle user/auto comments correctly.
palgarvio
parents: 106
diff changeset
515 self[id] = Message(id, string, list(locations), flags, auto_comments,
222
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
516 user_comments, previous_id, lineno=lineno)
bd8b1301b27e Added infrastructure for adding catalog checkers, and implement a checker that validations Python format parameters in translations, closing #19.
cmlenz
parents: 212
diff changeset
517
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
518 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
519 """Run various validation checks on the translations in the catalog.
228
629357c88d59 Only write unique comments, no duplicates.
palgarvio
parents: 227
diff changeset
520
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
521 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
522 ``(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
523 and ``errors`` is a sequence of `TranslationError` objects.
228
629357c88d59 Only write unique comments, no duplicates.
palgarvio
parents: 227
diff changeset
524
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
525 :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
526 """
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
527 checkers = []
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
528 from pkg_resources import working_set
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
529 for entry_point in working_set.iter_entry_points('babel.checkers'):
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
530 checkers.append(entry_point.load())
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
531
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
532 for message in self._messages.values():
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
533 errors = []
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
534 for checker in checkers:
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
535 try:
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
536 checker(self, 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
537 except TranslationError, e:
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
538 errors.append(e)
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
539 if errors:
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
540 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
541
205
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
542 def update(self, template, no_fuzzy_matching=False):
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
543 """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
544
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
545 >>> from babel.messages import Catalog
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
546 >>> template = Catalog()
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
547 >>> template.add('green', locations=[('main.py', 99)])
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
548 >>> template.add('blue', locations=[('main.py', 100)])
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
549 >>> template.add(('salad', 'salads'), locations=[('util.py', 42)])
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
550 >>> catalog = Catalog(locale='de_DE')
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
551 >>> catalog.add('blue', u'blau', locations=[('main.py', 98)])
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
552 >>> catalog.add('head', u'Kopf', locations=[('util.py', 33)])
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
553 >>> catalog.add(('salad', 'salads'), (u'Salat', u'Salate'),
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
554 ... locations=[('util.py', 38)])
202
d3c272492053 Added `--no-fuzzy-matching` to the frontends and also `--previous` which adds the old msgid's as comments. The latest closes #31.
palgarvio
parents: 200
diff changeset
555
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 177
diff changeset
556 >>> catalog.update(template)
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
557 >>> len(catalog)
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
558 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
559
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
560 >>> msg1 = catalog['green']
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
561 >>> msg1.string
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
562 >>> msg1.locations
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
563 [('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
564
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
565 >>> msg2 = catalog['blue']
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
566 >>> msg2.string
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
567 u'blau'
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
568 >>> msg2.locations
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
569 [('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
570
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
571 >>> msg3 = catalog['salad']
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
572 >>> msg3.string
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
573 (u'Salat', u'Salate')
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
574 >>> msg3.locations
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
575 [('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
576
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 177
diff changeset
577 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
578 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
579 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
580
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
581 >>> 'head' in catalog
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
582 False
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 177
diff changeset
583 >>> 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
584 [<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
585
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
586 :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
587 :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
588 """
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
589 messages = self._messages
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
590 self._messages = odict()
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
591
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
592 for message in template:
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
593 if message.id:
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
594 key = self._key_for(message.id)
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
595 if key in messages:
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
596 oldmsg = messages.pop(key)
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
597 message.string = oldmsg.string
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
598 message.flags |= oldmsg.flags
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
599 self[message.id] = message
167
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
600
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
601 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
602 if no_fuzzy_matching is False:
167
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
603 # do some fuzzy matching with difflib
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
604 matches = get_close_matches(key.lower().strip(),
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
605 [self._key_for(msgid) for msgid in messages], 1)
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
606 if matches:
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
607 oldmsg = messages.pop(matches[0])
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
608 message.string = oldmsg.string
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
609 message.flags |= oldmsg.flags | set([u'fuzzy'])
205
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
610 if isinstance(oldmsg.id, basestring):
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
611 message.previous_id = [oldmsg.id]
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
612 else:
aefe4ac123a2 Minor changes to how previous msgids are processed.
cmlenz
parents: 204
diff changeset
613 message.previous_id = list(oldmsg.id)
167
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
614 self[message.id] = message
190
f5780e72eefc Fix adding new messages in catalog update.
cmlenz
parents: 183
diff changeset
615 continue
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
616
167
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
617 self[message.id] = message
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet.
cmlenz
parents: 165
diff changeset
618
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 177
diff changeset
619 self.obsolete = messages
165
eafaa302dde1 Added preliminary catalog updating/merging functionality.
cmlenz
parents: 151
diff changeset
620
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
621 def _key_for(self, id):
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
622 """The key for a message is just the singular ID even for pluralizable
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
623 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
624 """
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
625 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
626 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
627 key = id[0]
b260ffa01a2d Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 70
diff changeset
628 return key
Copyright (C) 2012-2017 Edgewall Software