Mercurial > babel > old > babel-test

annotate babel/messages/catalog.py @ 84:4ff9cc26c11b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Some cosmetic changes for the new translator comments support.
author cmlenz
date Sun, 10 Jun 2007 18:03:46 +0000
parents 9c84b9fa5d30
children f259182f9baf
rev   line source
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
1 # -*- coding: utf-8 -*-
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
2 #
27fba894d3ca 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
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
4 # All rights reserved.
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
5 #
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
6 # This software is licensed as described in the file COPYING, which
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
7 # you should have received as part of this distribution. The terms
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
8 # are also available at http://babel.edgewall.org/wiki/License.
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
9 #
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
10 # This software consists of voluntary contributions made by many
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
11 # individuals. For the exact contribution history, see the revision
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
12 # history and logs, available at http://babel.edgewall.org/log/.
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
13
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
14 """Data structures for message catalogs."""
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
15
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
16 from datetime import datetime
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
17 import re
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
18 try:
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
19 set
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
20 except NameError:
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
21 from sets import Set as set
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
22 import time
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
23
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
24 from babel import __version__ as VERSION
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
25 from babel.core import Locale
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
26 from babel.messages.plurals import PLURALS
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
27 from babel.util import odict, UTC
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
28
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
29 __all__ = ['Message', 'Catalog']
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
30 __docformat__ = 'restructuredtext en'
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
31
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
32 PYTHON_FORMAT = re.compile(r'\%(\([\w]+\))?[diouxXeEfFgGcrs]').search
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
33
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
34
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
35 class Message(object):
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
36 """Representation of a single message in a catalog."""
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
37
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
38 def __init__(self, id, string='', locations=(), flags=(), comments=()):
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
39 """Create the message object.
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
40
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
41 :param id: the message ID, or a ``(singular, plural)`` tuple for
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
42 pluralizable messages
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
43 :param string: the translated message string, or a
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
44 ``(singular, plural)`` tuple for pluralizable messages
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
45 :param locations: a sequence of ``(filenname, lineno)`` tuples
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
46 :param flags: a set or sequence of flags
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
47 :param comments: a sequence of translator comments for the message
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
48 """
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
49 self.id = id
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
50 if not string and self.pluralizable:
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
51 string = (u'', u'')
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
52 self.string = string
70
2b0e18a04856 Fix for mixed singular/plural messages, follow-up to [70].
cmlenz
parents: 69
diff changeset
53 self.locations = list(locations)
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
54 self.flags = set(flags)
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
55 if id and self.python_format:
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
56 self.flags.add('python-format')
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
57 else:
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
58 self.flags.discard('python-format')
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
59 self.comments = list(comments)
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
60
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
61 def __repr__(self):
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
62 return '<%s %r>' % (type(self).__name__, self.id)
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
63
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
64 def fuzzy(self):
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
65 return 'fuzzy' in self.flags
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
66 fuzzy = property(fuzzy, doc="""\
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
67 Whether the translation is fuzzy.
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
68
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
69 >>> Message('foo').fuzzy
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
70 False
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
71 >>> Message('foo', 'foo', flags=['fuzzy']).fuzzy
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
72 True
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
73
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
74 :type: `bool`
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
75 """)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
76
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
77 def pluralizable(self):
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
78 return isinstance(self.id, (list, tuple))
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
79 pluralizable = property(pluralizable, doc="""\
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
80 Whether the message is plurizable.
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
81
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
82 >>> Message('foo').pluralizable
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
83 False
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
84 >>> Message(('foo', 'bar')).pluralizable
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
85 True
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
86
61
da7efa40a9e2 Move `Translations` and `LazyProxy` to new `babel.support` module, which should contain any convenience code that is useful for applications using Babel/I18n, but not used by Babel itself.
cmlenz
parents: 56
diff changeset
87 :type: `bool`
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
88 """)
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
89
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
90 def python_format(self):
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
91 ids = self.id
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
92 if not isinstance(ids, (list, tuple)):
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
93 ids = [ids]
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
94 return bool(filter(None, [PYTHON_FORMAT(id) for id in ids]))
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
95 python_format = property(python_format, doc="""\
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
96 Whether the message contains Python-style parameters.
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
97
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
98 >>> Message('foo %(name)s bar').python_format
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
99 True
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
100 >>> Message(('foo %(name)s', 'foo %(name)s')).python_format
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
101 True
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
102
61
da7efa40a9e2 Move `Translations` and `LazyProxy` to new `babel.support` module, which should contain any convenience code that is useful for applications using Babel/I18n, but not used by Babel itself.
cmlenz
parents: 56
diff changeset
103 :type: `bool`
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
104 """)
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
105
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
106
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
107 class Catalog(object):
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
108 """Representation of a message catalog."""
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
109
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
110 def __init__(self, locale=None, domain=None, project=None, version=None,
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
111 msgid_bugs_address=None, creation_date=None,
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
112 revision_date=None, last_translator=None, charset='utf-8'):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
113 """Initialize the catalog object.
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
114
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
115 :param locale: the locale identifier or `Locale` object, or `None`
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
116 if the catalog is not bound to a locale (which basically
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
117 means it's a template)
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
118 :param domain: the message domain
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
119 :param project: the project's name
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
120 :param version: the project's version
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
121 :param msgid_bugs_address: the address to report bugs about the catalog
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
122 :param creation_date: the date the catalog was created
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
123 :param revision_date: the date the catalog was revised
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
124 :param last_translator: the name and email of the last translator
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
125 """
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
126 self.domain = domain #: the message domain
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
127 if locale:
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
128 locale = Locale.parse(locale)
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
129 self.locale = locale #: the locale or `None`
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
130 self._messages = odict()
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
131
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
132 self.project = project or 'PROJECT' #: the project name
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
133 self.version = version or 'VERSION' #: the project version
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
134 self.msgid_bugs_address = msgid_bugs_address or 'EMAIL@ADDRESS'
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
135
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
136 if creation_date is None:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
137 creation_date = time.localtime()
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
138 elif isinstance(creation_date, datetime):
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
139 if creation_date.tzinfo is None:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
140 creation_date = creation_date.replace(tzinfo=UTC)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
141 creation_date = creation_date.timetuple()
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
142 self.creation_date = creation_date #: creation date of the template
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
143 if revision_date is None:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
144 revision_date = time.localtime()
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
145 elif isinstance(revision_date, datetime):
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
146 if revision_date.tzinfo is None:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
147 revision_date = revision_date.replace(tzinfo=UTC)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
148 revision_date = revision_date.timetuple()
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
149 self.revision_date = revision_date #: last revision date of the catalog
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
150 self.last_translator = last_translator #: last translator name + email
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
151 self.charset = charset or 'utf-8'
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
152
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
153 def headers(self):
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
154 headers = []
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
155 headers.append(('Project-Id-Version',
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
156 '%s %s' % (self.project, self.version)))
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
157 headers.append(('Report-Msgid-Bugs-To', self.msgid_bugs_address))
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
158 headers.append(('POT-Creation-Date',
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
159 time.strftime('%Y-%m-%d %H:%M%z', self.creation_date)))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
160 if self.locale is None:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
161 headers.append(('PO-Revision-Date', 'YEAR-MO-DA HO:MI+ZONE'))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
162 headers.append(('Last-Translator', 'FULL NAME <EMAIL@ADDRESS>'))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
163 headers.append(('Language-Team', 'LANGUAGE <LL@li.org>'))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
164 else:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
165 headers.append(('PO-Revision-Date',
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
166 time.strftime('%Y-%m-%d %H:%M%z', self.revision_date)))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
167 headers.append(('Last-Translator', self.last_translator))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
168 headers.append(('Language-Team', '%s <LL@li.org>' % self.locale))
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
169 headers.append(('Plural-Forms', self.plural_forms))
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
170 headers.append(('MIME-Version', '1.0'))
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
171 headers.append(('Content-Type',
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
172 'text/plain; charset=%s' % self.charset))
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
173 headers.append(('Content-Transfer-Encoding', '8bit'))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
174 headers.append(('Generated-By', 'Babel %s' % VERSION))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
175 return headers
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
176 headers = property(headers, doc="""\
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
177 The MIME headers of the catalog, used for the special ``msgid ""`` entry.
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
178
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
179 The behavior of this property changes slightly depending on whether a locale
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
180 is set or not, the latter indicating that the catalog is actually a template
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
181 for actual translations.
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
182
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
183 Here's an example of the output for such a catalog template:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
184
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
185 >>> catalog = Catalog(project='Foobar', version='1.0',
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
186 ... creation_date=datetime(1990, 4, 1, 15, 30))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
187 >>> for name, value in catalog.headers:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
188 ... print '%s: %s' % (name, value)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
189 Project-Id-Version: Foobar 1.0
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
190 Report-Msgid-Bugs-To: EMAIL@ADDRESS
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
191 POT-Creation-Date: 1990-04-01 15:30+0000
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
192 PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
193 Last-Translator: FULL NAME <EMAIL@ADDRESS>
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
194 Language-Team: LANGUAGE <LL@li.org>
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
195 MIME-Version: 1.0
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
196 Content-Type: text/plain; charset=utf-8
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
197 Content-Transfer-Encoding: 8bit
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
198 Generated-By: Babel ...
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
199
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
200 And here's an example of the output when the locale is set:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
201
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
202 >>> catalog = Catalog(locale='de_DE', project='Foobar', version='1.0',
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
203 ... creation_date=datetime(1990, 4, 1, 15, 30),
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
204 ... revision_date=datetime(1990, 8, 3, 12, 0),
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
205 ... last_translator='John Doe <jd@example.com>')
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
206 >>> for name, value in catalog.headers:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
207 ... print '%s: %s' % (name, value)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
208 Project-Id-Version: Foobar 1.0
78
ee043bb666f0 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 70
diff changeset
209 Report-Msgid-Bugs-To: EMAIL@ADDRESS
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
210 POT-Creation-Date: 1990-04-01 15:30+0000
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
211 PO-Revision-Date: 1990-08-03 12:00+0000
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
212 Last-Translator: John Doe <jd@example.com>
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
213 Language-Team: de_DE <LL@li.org>
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
214 Plural-Forms: nplurals=2; plural=(n != 1)
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
215 MIME-Version: 1.0
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
216 Content-Type: text/plain; charset=utf-8
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
217 Content-Transfer-Encoding: 8bit
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
218 Generated-By: Babel ...
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
219
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
220 :type: `list`
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
221 """)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
222
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
223 def num_plurals(self):
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
224 num = 2
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
225 if self.locale:
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
226 if str(self.locale) in PLURALS:
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
227 num = PLURALS[str(self.locale)][0]
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
228 elif self.locale.language in PLURALS:
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
229 num = PLURALS[self.locale.language][0]
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
230 return num
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
231 num_plurals = property(num_plurals, doc="""\
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
232 The number of plurals used by the locale.
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
233 """)
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
234
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
235 def plural_forms(self):
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
236 num, expr = ('INTEGER', 'EXPRESSION')
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
237 if self.locale:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
238 if str(self.locale) in PLURALS:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
239 num, expr = PLURALS[str(self.locale)]
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
240 elif self.locale.language in PLURALS:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
241 num, expr = PLURALS[self.locale.language]
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
242 return 'nplurals=%s; plural=%s' % (num, expr)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
243 plural_forms = property(plural_forms, doc="""\
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
244 Return the plural forms declaration for the locale.
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
245
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
246 >>> Catalog(locale='en_US').plural_forms
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
247 'nplurals=2; plural=(n != 1)'
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
248 >>> Catalog(locale='pt_BR').plural_forms
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
249 'nplurals=2; plural=(n > 1)'
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
250
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
251 :type: `str`
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
252 """)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
253
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
254 def __contains__(self, id):
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
255 """Return whether the catalog has a message with the specified ID."""
69
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
256 return self._key_for(id) in self._messages
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
257
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
258 def __len__(self):
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
259 """The number of messages in the catalog.
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
260
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
261 This does not include the special ``msgid ""`` entry.
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
262 """
69
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
263 return len(self._messages)
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
264
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
265 def __iter__(self):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
266 """Iterates through all the entries in the catalog, in the order they
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
267 were added, yielding a `Message` object for every entry.
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
268
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
269 :rtype: ``iterator``
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
270 """
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
271 buf = []
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
272 for name, value in self.headers:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
273 buf.append('%s: %s' % (name, value))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
274 yield Message('', '\n'.join(buf), flags=set(['fuzzy']))
69
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
275 for key in self._messages:
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
276 yield self._messages[key]
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
277
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
278 def __repr__(self):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
279 locale = ''
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
280 if self.locale:
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
281 locale = ' %s' % self.locale
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
282 return '<%s %r%s>' % (type(self).__name__, self.domain, locale)
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
283
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
284 def __delitem__(self, id):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
285 """Delete the message with the specified ID."""
69
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
286 key = self._key_for(id)
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
287 if key in self._messages:
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
288 del self._messages[key]
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
289
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
290 def __getitem__(self, id):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
291 """Return the message with the specified ID.
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
292
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
293 :param id: the message ID
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
294 :return: the message with the specified ID, or `None` if no such message
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
295 is in the catalog
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
296 :rtype: `Message`
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
297 """
69
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
298 return self._messages.get(self._key_for(id))
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
299
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
300 def __setitem__(self, id, message):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
301 """Add or update the message with the specified ID.
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
302
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
303 >>> catalog = Catalog()
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
304 >>> catalog[u'foo'] = Message(u'foo')
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
305 >>> catalog[u'foo']
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
306 <Message u'foo'>
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
307
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
308 If a message with that ID is already in the catalog, it is updated
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
309 to include the locations and flags of the new message.
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
310
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
311 >>> catalog = Catalog()
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
312 >>> catalog[u'foo'] = Message(u'foo', locations=[('main.py', 1)])
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
313 >>> catalog[u'foo'].locations
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
314 [('main.py', 1)]
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
315 >>> catalog[u'foo'] = Message(u'foo', locations=[('utils.py', 5)])
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
316 >>> catalog[u'foo'].locations
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
317 [('main.py', 1), ('utils.py', 5)]
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
318
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
319 :param id: the message ID
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
320 :param message: the `Message` object
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
321 """
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
322 assert isinstance(message, Message), 'expected a Message object'
69
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
323 key = self._key_for(id)
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
324 current = self._messages.get(key)
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
325 if current:
69
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
326 if message.pluralizable and not current.pluralizable:
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
327 # The new message adds pluralization
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
328 current.id = message.id
70
2b0e18a04856 Fix for mixed singular/plural messages, follow-up to [70].
cmlenz
parents: 69
diff changeset
329 current.string = message.string
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
330 current.locations.extend(message.locations)
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
331 current.flags |= message.flags
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
332 message = current
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
333 else:
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
334 if isinstance(id, (list, tuple)):
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
335 assert isinstance(message.string, (list, tuple))
69
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
336 self._messages[key] = message
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
337
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
338 def add(self, id, string=None, locations=(), flags=(), comments=()):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
339 """Add or update the message with the specified ID.
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
340
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
341 >>> catalog = Catalog()
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
342 >>> catalog.add(u'foo')
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
343 >>> catalog[u'foo']
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
344 <Message u'foo'>
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
345
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
346 This method simply constructs a `Message` object with the given
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
347 arguments and invokes `__setitem__` with that object.
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
348
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
349 :param id: the message ID, or a ``(singular, plural)`` tuple for
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
350 pluralizable messages
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
351 :param string: the translated message string, or a
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
352 ``(singular, plural)`` tuple for pluralizable messages
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
353 :param locations: a sequence of ``(filenname, lineno)`` tuples
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
354 :param flags: a set or sequence of flags
84
4ff9cc26c11b Some cosmetic changes for the new translator comments support.
cmlenz
parents: 80
diff changeset
355 :param comments: a list of translator comments
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
356 """
80
9c84b9fa5d30 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 78
diff changeset
357 self[id] = Message(id, string, list(locations), flags, comments)
69
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
358
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
359 def _key_for(self, id):
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
360 """The key for a message is just the singular ID even for pluralizable
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
361 messages.
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
362 """
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
363 key = id
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
364 if isinstance(key, (list, tuple)):
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
365 key = id[0]
9b8079807245 Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message.
cmlenz
parents: 68
diff changeset
366 return key
Copyright (C) 2012-2017 Edgewall Software