annotate babel/messages/catalog.py @ 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.
author cmlenz
date Fri, 08 Jun 2007 16:16:08 +0000
parents 7e64668126d9
children 2b0e18a04856
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
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
38 def __init__(self, id, string='', locations=(), flags=()):
56
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
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
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
47 """
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 self.id = id
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
49 if not string and self.pluralizable:
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
50 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
51 self.string = string
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.locations = 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
53 self.flags = set(flags)
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
54 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
55 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
56 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
57 self.flags.discard('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
58
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
59 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
60 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
61
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
62 def fuzzy(self):
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
63 return 'fuzzy' in self.flags
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
64 fuzzy = property(fuzzy, doc="""\
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
65 Whether the translation is fuzzy.
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
66
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
67 >>> Message('foo').fuzzy
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
68 False
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
69 >>> Message('foo', 'foo', flags=['fuzzy']).fuzzy
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
70 True
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
71
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
72 :type: `bool`
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
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
75 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
76 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
77 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
78 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
79
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 >>> 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
81 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
82 >>> 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
83 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
84
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
85 :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
86 """)
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
87
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 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
89 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
90 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
91 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
92 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
93 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
94 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
95
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 >>> 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
97 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
98 >>> 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
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
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
101 :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
102 """)
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
103
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 class Catalog(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
106 """Representation a 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
107
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
108 def __init__(self, locale=None, domain=None, project=None, version=None,
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
109 creation_date=None, revision_date=None, last_translator=None,
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
110 charset='utf-8'):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
111 """Initialize the catalog object.
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
112
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
113 :param domain: the message domain
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
114 :param locale: the locale identifier or `Locale` object, or `None`
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
115 if the catalog is not bound to a locale (which basically
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
116 means it's a template)
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
117 """
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
118 self.domain = domain #: the message domain
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
119 if locale:
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
120 locale = Locale.parse(locale)
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
121 self.locale = locale #: the locale or `None`
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
122 self._messages = odict()
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
123
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
124 self.project = project or 'PROJECT' #: the project name
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
125 self.version = version or 'VERSION' #: the project version
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
126
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
127 if creation_date is None:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
128 creation_date = time.localtime()
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
129 elif isinstance(creation_date, datetime):
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
130 if creation_date.tzinfo is None:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
131 creation_date = creation_date.replace(tzinfo=UTC)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
132 creation_date = creation_date.timetuple()
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
133 self.creation_date = creation_date #: creation date of the template
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
134 if revision_date is None:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
135 revision_date = time.localtime()
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
136 elif isinstance(revision_date, datetime):
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
137 if revision_date.tzinfo is None:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
138 revision_date = revision_date.replace(tzinfo=UTC)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
139 revision_date = revision_date.timetuple()
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
140 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
141 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
142 self.charset = charset or 'utf-8'
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
143
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
144 def headers(self):
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
145 headers = []
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
146 headers.append(('Project-Id-Version',
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
147 '%s %s' % (self.project, self.version)))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
148 headers.append(('POT-Creation-Date',
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
149 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
150 if self.locale is None:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
151 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
152 headers.append(('Last-Translator', 'FULL NAME <EMAIL@ADDRESS>'))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
153 headers.append(('Language-Team', 'LANGUAGE <LL@li.org>'))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
154 else:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
155 headers.append(('PO-Revision-Date',
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
156 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
157 headers.append(('Last-Translator', self.last_translator))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
158 headers.append(('Language-Team', '%s <LL@li.org>' % self.locale))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
159 headers.append(('Plural-Forms', self.plural_forms))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
160 headers.append(('MIME-Version', '1.0'))
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
161 headers.append(('Content-Type',
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
162 'text/plain; charset=%s' % self.charset))
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
163 headers.append(('Content-Transfer-Encoding', '8bit'))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
164 headers.append(('Generated-By', 'Babel %s' % VERSION))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
165 return headers
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
166 headers = property(headers, doc="""\
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
167 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
168
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
169 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
170 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
171 for actual translations.
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
172
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
173 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
174
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
175 >>> catalog = Catalog(project='Foobar', version='1.0',
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
176 ... creation_date=datetime(1990, 4, 1, 15, 30))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
177 >>> for name, value in catalog.headers:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
178 ... print '%s: %s' % (name, value)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
179 Project-Id-Version: Foobar 1.0
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
180 POT-Creation-Date: 1990-04-01 15:30+0000
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
181 PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
182 Last-Translator: FULL NAME <EMAIL@ADDRESS>
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
183 Language-Team: LANGUAGE <LL@li.org>
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
184 Plural-Forms: nplurals=INTEGER; plural=EXPRESSION
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
185 MIME-Version: 1.0
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
186 Content-Type: text/plain; charset=utf-8
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
187 Content-Transfer-Encoding: 8bit
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
188 Generated-By: Babel ...
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
189
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
190 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
191
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
192 >>> catalog = Catalog(locale='de_DE', project='Foobar', version='1.0',
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
193 ... creation_date=datetime(1990, 4, 1, 15, 30),
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
194 ... revision_date=datetime(1990, 8, 3, 12, 0),
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
195 ... last_translator='John Doe <jd@example.com>')
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
196 >>> for name, value in catalog.headers:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
197 ... print '%s: %s' % (name, value)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
198 Project-Id-Version: Foobar 1.0
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
199 POT-Creation-Date: 1990-04-01 15:30+0000
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
200 PO-Revision-Date: 1990-08-03 12:00+0000
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
201 Last-Translator: John Doe <jd@example.com>
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
202 Language-Team: de_DE <LL@li.org>
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
203 Plural-Forms: nplurals=2; plural=(n != 1)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
204 MIME-Version: 1.0
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
205 Content-Type: text/plain; charset=utf-8
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
206 Content-Transfer-Encoding: 8bit
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
207 Generated-By: Babel ...
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
208
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
209 :type: `list`
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
210 """)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
211
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
212 def num_plurals(self):
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
213 num = 2
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
214 if self.locale:
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
215 if str(self.locale) in PLURALS:
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
216 num = PLURALS[str(self.locale)][0]
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
217 elif self.locale.language in PLURALS:
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
218 num = PLURALS[self.locale.language][0]
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
219 return num
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
220 num_plurals = property(num_plurals)
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
221
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
222 def plural_forms(self):
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
223 num, expr = ('INTEGER', 'EXPRESSION')
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
224 if self.locale:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
225 if str(self.locale) in PLURALS:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
226 num, expr = PLURALS[str(self.locale)]
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
227 elif self.locale.language in PLURALS:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
228 num, expr = PLURALS[self.locale.language]
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
229 return 'nplurals=%s; plural=%s' % (num, expr)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
230 plural_forms = property(plural_forms, doc="""\
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
231 Return the plural forms declaration for the locale.
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
232
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
233 >>> Catalog(locale='en_US').plural_forms
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
234 'nplurals=2; plural=(n != 1)'
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
235 >>> Catalog(locale='pt_BR').plural_forms
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
236 'nplurals=2; plural=(n > 1)'
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
237
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
238 :type: `str`
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
239 """)
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
240
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
241 def __contains__(self, id):
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
242 """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
243 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
244
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
245 def __len__(self):
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
246 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
247
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
248 def __iter__(self):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
249 """Iterates through all the entries in the catalog, in the order they
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
250 were added, yielding a `Message` object for every entry.
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
251
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
252 :rtype: ``iterator``
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
253 """
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
254 buf = []
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
255 for name, value in self.headers:
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
256 buf.append('%s: %s' % (name, value))
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
257 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
258 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
259 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
260
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
261 def __repr__(self):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
262 locale = ''
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
263 if self.locale:
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
264 locale = ' %s' % self.locale
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
265 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
266
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
267 def __delitem__(self, id):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
268 """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
269 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
270 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
271 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
272
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
273 def __getitem__(self, id):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
274 """Return the message with the specified ID.
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
275
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
276 :param id: the message ID
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
277 :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
278 is in the catalog
67
5496b9127a07 Enhance catalog to also manage the MIME headers.
cmlenz
parents: 64
diff changeset
279 :rtype: `Message`
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
280 """
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
281 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
282
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 def __setitem__(self, id, message):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
284 """Add or update the message with the specified ID.
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
285
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
286 >>> catalog = Catalog()
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
287 >>> catalog[u'foo'] = Message(u'foo')
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
288 >>> catalog[u'foo']
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
289 <Message u'foo'>
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
290
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
291 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
292 to include the locations and flags of the new message.
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
293
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
294 >>> catalog = Catalog()
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
295 >>> catalog[u'foo'] = Message(u'foo', locations=[('main.py', 1)])
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
296 >>> catalog[u'foo'].locations
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
297 [('main.py', 1)]
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
298 >>> catalog[u'foo'] = Message(u'foo', locations=[('utils.py', 5)])
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
299 >>> catalog[u'foo'].locations
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
300 [('main.py', 1), ('utils.py', 5)]
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
301
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
302 :param id: the message ID
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
303 :param message: the `Message` object
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
304 """
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
305 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
306 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
307 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
308 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
309 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
310 # 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
311 current.id = message.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
312 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
313 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
314 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
315 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
316 if isinstance(id, (list, tuple)):
68
7e64668126d9 Add back POT header broken in previous check-in.
cmlenz
parents: 67
diff changeset
317 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
318 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
319
27fba894d3ca Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends.
cmlenz
parents:
diff changeset
320 def add(self, id, string=None, locations=(), flags=()):
64
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
321 """Add or update the message with the specified ID.
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
322
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
323 >>> catalog = Catalog()
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
324 >>> catalog.add(u'foo')
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
325 >>> catalog[u'foo']
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
326 <Message u'foo'>
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
327
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
328 This method simply constructs a `Message` object with the given
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
329 arguments and invokes `__setitem__` with that object.
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
330
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
331 :param id: the message ID, or a ``(singular, plural)`` tuple for
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
332 pluralizable messages
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
333 :param string: the translated message string, or a
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
334 ``(singular, plural)`` tuple for pluralizable messages
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
335 :param locations: a sequence of ``(filenname, lineno)`` tuples
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
336 :param flags: a set or sequence of flags
0406c51c5463 `read_po` now returns a `Catalog`.
cmlenz
parents: 61
diff changeset
337 """
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
338 self[id] = Message(id, string, list(locations), flags)
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
339
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
340 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
341 """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
342 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
343 """
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
344 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
345 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
346 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
347 return key
Copyright (C) 2012-2017 Edgewall Software