babel/mirror: babel/messages/catalog.py annotate

annotate babel/messages/catalog.py @ 188:96f858026208 trunk

Fix adding new messages in catalog update.

author	cmlenz
date	Fri, 29 Jun 2007 13:47:10 +0000
parents	8a762ce37bf7
children	b38a6b220ea2

rev	line source
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	1 # -- coding: utf-8 --
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	2 #
f40fc143439c 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
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	4 # All rights reserved.
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	5 #
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	6 # This software is licensed as described in the file COPYING, which
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	7 # you should have received as part of this distribution. The terms
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	8 # are also available at http://babel.edgewall.org/wiki/License.
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	9 #
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	10 # This software consists of voluntary contributions made by many
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	11 # individuals. For the exact contribution history, see the revision
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	12 # history and logs, available at http://babel.edgewall.org/log/.
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	13
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	14 """Data structures for message catalogs."""
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	15
149 d62c63280e81 Respect charset specified in PO headers in `read_po()`. Fixes #17. cmlenz parents: 131 diff changeset	16 from cgi import parse_header
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	17 from datetime import datetime
165 628bc271ece4 Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 163 diff changeset	18 from difflib import get_close_matches
106 2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	19 from email import message_from_string
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	20 import re
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	21 try:
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	22 set
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	23 except NameError:
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	24 from sets import Set as set
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	25 import time
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	26
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	27 from babel import __version__ as VERSION
64 ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	28 from babel.core import Locale
131 6a284ad6c8ba Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows. cmlenz parents: 121 diff changeset	29 from babel.dates import format_datetime
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	30 from babel.messages.plurals import PLURALS
106 2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	31 from babel.util import odict, LOCALTZ, UTC, FixedOffsetTimezone
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	32
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	33 __all__ = ['Message', 'Catalog']
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	34 __docformat__ = 'restructuredtext en'
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	35
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	36 PYTHON_FORMAT = re.compile(r'\%($[\w]+$)?[diouxXeEfFgGcrs]').search
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	37
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	38
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	39 class Message(object):
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	40 """Representation of a single message in a catalog."""
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	41
149 d62c63280e81 Respect charset specified in PO headers in `read_po()`. Fixes #17. cmlenz parents: 131 diff changeset	42 def __init__(self, id, string=u'', locations=(), flags=(), auto_comments=(),
105 c62b68a0b65e `Message`, `read_po` and `write_po` now all handle user/auto comments correctly. palgarvio parents: 104 diff changeset	43 user_comments=()):
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	44 """Create the message object.
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	45
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	46 :param id: the message ID, or a ``(singular, plural)`` tuple for
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	47 pluralizable messages
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	48 :param string: the translated message string, or a
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	49 ``(singular, plural)`` tuple for pluralizable messages
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	50 :param locations: a sequence of ``(filenname, lineno)`` tuples
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	51 :param flags: a set or sequence of flags
106 2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	52 :param auto_comments: a sequence of automatic comments for the message
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	53 :param user_comments: a sequence of user comments for the message
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	54 """
107 fadbba1d89c8 Minor doc improvements. cmlenz parents: 106 diff changeset	55 self.id = id #: The message ID
68 269941aa0e55 Add back POT header broken in previous check-in. cmlenz parents: 67 diff changeset	56 if not string and self.pluralizable:
269941aa0e55 Add back POT header broken in previous check-in. cmlenz parents: 67 diff changeset	57 string = (u'', u'')
107 fadbba1d89c8 Minor doc improvements. cmlenz parents: 106 diff changeset	58 self.string = string #: The message translation
70 f016034ff635 Fix for mixed singular/plural messages, follow-up to [70]. cmlenz parents: 69 diff changeset	59 self.locations = list(locations)
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	60 self.flags = set(flags)
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	61 if id and self.python_format:
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	62 self.flags.add('python-format')
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	63 else:
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	64 self.flags.discard('python-format')
105 c62b68a0b65e `Message`, `read_po` and `write_po` now all handle user/auto comments correctly. palgarvio parents: 104 diff changeset	65 self.auto_comments = list(auto_comments)
c62b68a0b65e `Message`, `read_po` and `write_po` now all handle user/auto comments correctly. palgarvio parents: 104 diff changeset	66 self.user_comments = list(user_comments)
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	67
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	68 def __repr__(self):
175 5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	69 return '<%s %r (Flags: %r)>' % (type(self).__name__, self.id,
5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	70 ', '.join([flag for flag in self.flags]))
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	71
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	72 def fuzzy(self):
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	73 return 'fuzzy' in self.flags
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	74 fuzzy = property(fuzzy, doc="""\
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	75 Whether the translation is fuzzy.
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	76
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	77 >>> Message('foo').fuzzy
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	78 False
175 5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	79 >>> msg = Message('foo', 'foo', flags=['fuzzy'])
5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	80 >>> msg.fuzzy
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	81 True
175 5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	82 >>> msg
5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	83 <Message 'foo' (Flags: 'fuzzy')>
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	84
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	85 :type: `bool`
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	86 """)
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	87
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	88 def pluralizable(self):
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	89 return isinstance(self.id, (list, tuple))
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	90 pluralizable = property(pluralizable, doc="""\
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	91 Whether the message is plurizable.
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	92
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	93 >>> Message('foo').pluralizable
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	94 False
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	95 >>> Message(('foo', 'bar')).pluralizable
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	96 True
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	97
61 9d13b9a5d727 Move `Translations` and `LazyProxy` to new `babel.support` module, which should contain any convenience code that is useful for applications using Babel/I18n, but not used by Babel itself. cmlenz parents: 56 diff changeset	98 :type: `bool`
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	99 """)
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	100
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	101 def python_format(self):
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	102 ids = self.id
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	103 if not isinstance(ids, (list, tuple)):
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	104 ids = [ids]
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	105 return bool(filter(None, [PYTHON_FORMAT(id) for id in ids]))
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	106 python_format = property(python_format, doc="""\
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	107 Whether the message contains Python-style parameters.
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	108
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	109 >>> Message('foo %(name)s bar').python_format
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	110 True
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	111 >>> Message(('foo %(name)s', 'foo %(name)s')).python_format
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	112 True
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	113
61 9d13b9a5d727 Move `Translations` and `LazyProxy` to new `babel.support` module, which should contain any convenience code that is useful for applications using Babel/I18n, but not used by Babel itself. cmlenz parents: 56 diff changeset	114 :type: `bool`
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	115 """)
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	116
105 c62b68a0b65e `Message`, `read_po` and `write_po` now all handle user/auto comments correctly. palgarvio parents: 104 diff changeset	117
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	118 DEFAULT_HEADER = u"""\
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	119 # Translations template for PROJECT.
120 1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	120 # Copyright (C) YEAR ORGANIZATION
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	121 # This file is distributed under the same license as the PROJECT project.
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	122 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	123 #"""
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	124
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	125 class Catalog(object):
78 d0d8d6cd8601 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template. palgarvio parents: 70 diff changeset	126 """Representation of a message catalog."""
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	127
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	128 def __init__(self, locale=None, domain=None, header_comment=DEFAULT_HEADER,
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	129 project=None, version=None, copyright_holder=None,
78 d0d8d6cd8601 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template. palgarvio parents: 70 diff changeset	130 msgid_bugs_address=None, creation_date=None,
175 5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	131 revision_date=None, last_translator=None, charset='utf-8',
5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	132 fuzzy=True):
64 ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	133 """Initialize the catalog object.
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	134
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	135 :param locale: the locale identifier or `Locale` object, or `None`
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	136 if the catalog is not bound to a locale (which basically
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	137 means it's a template)
78 d0d8d6cd8601 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template. palgarvio parents: 70 diff changeset	138 :param domain: the message domain
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	139 :param header_comment: the header comment as string, or `None` for the
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	140 default header
78 d0d8d6cd8601 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template. palgarvio parents: 70 diff changeset	141 :param project: the project's name
d0d8d6cd8601 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template. palgarvio parents: 70 diff changeset	142 :param version: the project's version
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	143 :param copyright_holder: the copyright holder of the catalog
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	144 :param msgid_bugs_address: the email address or URL to submit bug
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	145 reports to
78 d0d8d6cd8601 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template. palgarvio parents: 70 diff changeset	146 :param creation_date: the date the catalog was created
d0d8d6cd8601 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template. palgarvio parents: 70 diff changeset	147 :param revision_date: the date the catalog was revised
d0d8d6cd8601 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template. palgarvio parents: 70 diff changeset	148 :param last_translator: the name and email of the last translator
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	149 :param charset: the encoding to use in the output
175 5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	150 :param fuzzy: the fuzzy bit on the catalog header
64 ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	151 """
107 fadbba1d89c8 Minor doc improvements. cmlenz parents: 106 diff changeset	152 self.domain = domain #: The message domain
64 ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	153 if locale:
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	154 locale = Locale.parse(locale)
107 fadbba1d89c8 Minor doc improvements. cmlenz parents: 106 diff changeset	155 self.locale = locale #: The locale or `None`
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	156 self._header_comment = header_comment
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	157 self._messages = odict()
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	158
107 fadbba1d89c8 Minor doc improvements. cmlenz parents: 106 diff changeset	159 self.project = project or 'PROJECT' #: The project name
fadbba1d89c8 Minor doc improvements. cmlenz parents: 106 diff changeset	160 self.version = version or 'VERSION' #: The project version
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	161 self.copyright_holder = copyright_holder or 'ORGANIZATION'
78 d0d8d6cd8601 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template. palgarvio parents: 70 diff changeset	162 self.msgid_bugs_address = msgid_bugs_address or 'EMAIL@ADDRESS'
106 2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	163
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	164 self.last_translator = last_translator or 'FULL NAME <EMAIL@ADDRESS>'
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	165 """Name and email address of the last translator."""
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	166
95 f9007588a860 Fix for #11 (use local timezone in timestamps of generated POT). cmlenz parents: 87 diff changeset	167 self.charset = charset or 'utf-8'
84 3ae316b58231 Some cosmetic changes for the new translator comments support. cmlenz parents: 80 diff changeset	168
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	169 if creation_date is None:
97 4e5c9dc57f1d Renamed `LOCAL` to `LOCALTZ`. cmlenz parents: 95 diff changeset	170 creation_date = datetime.now(LOCALTZ)
95 f9007588a860 Fix for #11 (use local timezone in timestamps of generated POT). cmlenz parents: 87 diff changeset	171 elif isinstance(creation_date, datetime) and not creation_date.tzinfo:
97 4e5c9dc57f1d Renamed `LOCAL` to `LOCALTZ`. cmlenz parents: 95 diff changeset	172 creation_date = creation_date.replace(tzinfo=LOCALTZ)
107 fadbba1d89c8 Minor doc improvements. cmlenz parents: 106 diff changeset	173 self.creation_date = creation_date #: Creation date of the template
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	174 if revision_date is None:
97 4e5c9dc57f1d Renamed `LOCAL` to `LOCALTZ`. cmlenz parents: 95 diff changeset	175 revision_date = datetime.now(LOCALTZ)
95 f9007588a860 Fix for #11 (use local timezone in timestamps of generated POT). cmlenz parents: 87 diff changeset	176 elif isinstance(revision_date, datetime) and not revision_date.tzinfo:
97 4e5c9dc57f1d Renamed `LOCAL` to `LOCALTZ`. cmlenz parents: 95 diff changeset	177 revision_date = revision_date.replace(tzinfo=LOCALTZ)
107 fadbba1d89c8 Minor doc improvements. cmlenz parents: 106 diff changeset	178 self.revision_date = revision_date #: Last revision date of the catalog
181 8a762ce37bf7 The frontends now provide ways to update existing translations catalogs from a template. Closes #22. cmlenz parents: 175 diff changeset	179 self.fuzzy = fuzzy #: Catalog header fuzzy bit (`True` or `False`)
8a762ce37bf7 The frontends now provide ways to update existing translations catalogs from a template. Closes #22. cmlenz parents: 175 diff changeset	180
8a762ce37bf7 The frontends now provide ways to update existing translations catalogs from a template. Closes #22. cmlenz parents: 175 diff changeset	181 self.obsolete = odict() #: Dictionary of obsolete messages
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	182
107 fadbba1d89c8 Minor doc improvements. cmlenz parents: 106 diff changeset	183 def _get_header_comment(self):
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	184 comment = self._header_comment
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	185 comment = comment.replace('PROJECT', self.project) \
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	186 .replace('VERSION', self.version) \
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	187 .replace('YEAR', self.revision_date.strftime('%Y')) \
120 1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	188 .replace('ORGANIZATION', self.copyright_holder)
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	189 if self.locale:
107 fadbba1d89c8 Minor doc improvements. cmlenz parents: 106 diff changeset	190 comment = comment.replace('Translations template', '%s translations'
fadbba1d89c8 Minor doc improvements. cmlenz parents: 106 diff changeset	191 % self.locale.english_name)
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	192 return comment
120 1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	193
107 fadbba1d89c8 Minor doc improvements. cmlenz parents: 106 diff changeset	194 def _set_header_comment(self, string):
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	195 self._header_comment = string
107 fadbba1d89c8 Minor doc improvements. cmlenz parents: 106 diff changeset	196
fadbba1d89c8 Minor doc improvements. cmlenz parents: 106 diff changeset	197 header_comment = property(_get_header_comment, _set_header_comment, doc="""\
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	198 The header comment for the catalog.
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	199
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	200 >>> catalog = Catalog(project='Foobar', version='1.0',
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	201 ... copyright_holder='Foo Company')
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	202 >>> print catalog.header_comment
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	203 # Translations template for Foobar.
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	204 # Copyright (C) 2007 Foo Company
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	205 # This file is distributed under the same license as the Foobar project.
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	206 # FIRST AUTHOR <EMAIL@ADDRESS>, 2007.
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	207 #
106 2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	208
120 1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	209 The header can also be set from a string. Any known upper-case variables
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	210 will be replaced when the header is retrieved again:
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	211
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	212 >>> catalog = Catalog(project='Foobar', version='1.0',
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	213 ... copyright_holder='Foo Company')
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	214 >>> catalog.header_comment = '''\\
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	215 ... # The POT for my really cool PROJECT project.
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	216 ... # Copyright (C) 1990-2003 ORGANIZATION
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	217 ... # This file is distributed under the same license as the PROJECT
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	218 ... # project.
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	219 ... #'''
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	220 >>> print catalog.header_comment
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	221 # The POT for my really cool Foobar project.
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	222 # Copyright (C) 1990-2003 Foo Company
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	223 # This file is distributed under the same license as the Foobar
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	224 # project.
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	225 #
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	226
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	227 :type: `unicode`
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	228 """)
395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	229
106 2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	230 def _get_mime_headers(self):
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	231 headers = []
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	232 headers.append(('Project-Id-Version',
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	233 '%s %s' % (self.project, self.version)))
78 d0d8d6cd8601 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template. palgarvio parents: 70 diff changeset	234 headers.append(('Report-Msgid-Bugs-To', self.msgid_bugs_address))
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	235 headers.append(('POT-Creation-Date',
131 6a284ad6c8ba Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows. cmlenz parents: 121 diff changeset	236 format_datetime(self.creation_date, 'yyyy-MM-dd HH:mmZ',
6a284ad6c8ba Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows. cmlenz parents: 121 diff changeset	237 locale='en')))
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	238 if self.locale is None:
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	239 headers.append(('PO-Revision-Date', 'YEAR-MO-DA HO:MI+ZONE'))
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	240 headers.append(('Last-Translator', 'FULL NAME <EMAIL@ADDRESS>'))
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	241 headers.append(('Language-Team', 'LANGUAGE <LL@li.org>'))
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	242 else:
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	243 headers.append(('PO-Revision-Date',
131 6a284ad6c8ba Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows. cmlenz parents: 121 diff changeset	244 format_datetime(self.revision_date,
6a284ad6c8ba Use `dates.format_datetime` for dates in PO(T) header, as `datetime.strftime` produces wrong results on windows. cmlenz parents: 121 diff changeset	245 'yyyy-MM-dd HH:mmZ', locale='en')))
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	246 headers.append(('Last-Translator', self.last_translator))
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	247 headers.append(('Language-Team', '%s <LL@li.org>' % self.locale))
84 3ae316b58231 Some cosmetic changes for the new translator comments support. cmlenz parents: 80 diff changeset	248 headers.append(('Plural-Forms', self.plural_forms))
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	249 headers.append(('MIME-Version', '1.0'))
68 269941aa0e55 Add back POT header broken in previous check-in. cmlenz parents: 67 diff changeset	250 headers.append(('Content-Type',
269941aa0e55 Add back POT header broken in previous check-in. cmlenz parents: 67 diff changeset	251 'text/plain; charset=%s' % self.charset))
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	252 headers.append(('Content-Transfer-Encoding', '8bit'))
105 c62b68a0b65e `Message`, `read_po` and `write_po` now all handle user/auto comments correctly. palgarvio parents: 104 diff changeset	253 headers.append(('Generated-By', 'Babel %s\n' % VERSION))
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	254 return headers
106 2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	255
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	256 def _set_mime_headers(self, headers):
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	257 for name, value in headers:
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	258 name = name.lower()
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	259 if name == 'project-id-version':
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	260 parts = value.split(' ')
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	261 self.project = ' '.join(parts[:-1])
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	262 self.version = parts[-1]
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	263 elif name == 'report-msgid-bugs-to':
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	264 self.msgid_bugs_address = value
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	265 elif name == 'last-translator':
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	266 self.last_translator = value
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	267 elif name == 'pot-creation-date':
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	268 # FIXME: this should use dates.parse_datetime as soon as that
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	269 # is ready
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	270 value, tzoffset, _ = re.split('[+-](\d{4})$', value, 1)
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	271 tt = time.strptime(value, '%Y-%m-%d %H:%M')
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	272 ts = time.mktime(tt)
120 1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	273 tzoffset = FixedOffsetTimezone(int(tzoffset[:2]) * 60 +
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	274 int(tzoffset[2:]))
121 d2ac14a7ea08 Fix parsing of timezone in POT creation date. cmlenz parents: 120 diff changeset	275 dt = datetime.fromtimestamp(ts)
d2ac14a7ea08 Fix parsing of timezone in POT creation date. cmlenz parents: 120 diff changeset	276 self.creation_date = dt.replace(tzinfo=tzoffset)
149 d62c63280e81 Respect charset specified in PO headers in `read_po()`. Fixes #17. cmlenz parents: 131 diff changeset	277 elif name == 'content-type':
d62c63280e81 Respect charset specified in PO headers in `read_po()`. Fixes #17. cmlenz parents: 131 diff changeset	278 mimetype, params = parse_header(value)
d62c63280e81 Respect charset specified in PO headers in `read_po()`. Fixes #17. cmlenz parents: 131 diff changeset	279 if 'charset' in params:
d62c63280e81 Respect charset specified in PO headers in `read_po()`. Fixes #17. cmlenz parents: 131 diff changeset	280 self.charset = params['charset'].lower()
106 2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	281
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	282 mime_headers = property(_get_mime_headers, _set_mime_headers, doc="""\
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	283 The MIME headers of the catalog, used for the special ``msgid ""`` entry.
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	284
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	285 The behavior of this property changes slightly depending on whether a locale
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	286 is set or not, the latter indicating that the catalog is actually a template
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	287 for actual translations.
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	288
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	289 Here's an example of the output for such a catalog template:
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	290
95 f9007588a860 Fix for #11 (use local timezone in timestamps of generated POT). cmlenz parents: 87 diff changeset	291 >>> created = datetime(1990, 4, 1, 15, 30, tzinfo=UTC)
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	292 >>> catalog = Catalog(project='Foobar', version='1.0',
95 f9007588a860 Fix for #11 (use local timezone in timestamps of generated POT). cmlenz parents: 87 diff changeset	293 ... creation_date=created)
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	294 >>> for name, value in catalog.mime_headers:
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	295 ... print '%s: %s' % (name, value)
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	296 Project-Id-Version: Foobar 1.0
78 d0d8d6cd8601 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template. palgarvio parents: 70 diff changeset	297 Report-Msgid-Bugs-To: EMAIL@ADDRESS
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	298 POT-Creation-Date: 1990-04-01 15:30+0000
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	299 PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	300 Last-Translator: FULL NAME <EMAIL@ADDRESS>
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	301 Language-Team: LANGUAGE <LL@li.org>
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	302 MIME-Version: 1.0
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	303 Content-Type: text/plain; charset=utf-8
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	304 Content-Transfer-Encoding: 8bit
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	305 Generated-By: Babel ...
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	306
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	307 And here's an example of the output when the locale is set:
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	308
95 f9007588a860 Fix for #11 (use local timezone in timestamps of generated POT). cmlenz parents: 87 diff changeset	309 >>> revised = datetime(1990, 8, 3, 12, 0, tzinfo=UTC)
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	310 >>> catalog = Catalog(locale='de_DE', project='Foobar', version='1.0',
95 f9007588a860 Fix for #11 (use local timezone in timestamps of generated POT). cmlenz parents: 87 diff changeset	311 ... creation_date=created, revision_date=revised,
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	312 ... last_translator='John Doe <jd@example.com>')
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	313 >>> for name, value in catalog.mime_headers:
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	314 ... print '%s: %s' % (name, value)
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	315 Project-Id-Version: Foobar 1.0
78 d0d8d6cd8601 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template. palgarvio parents: 70 diff changeset	316 Report-Msgid-Bugs-To: EMAIL@ADDRESS
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	317 POT-Creation-Date: 1990-04-01 15:30+0000
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	318 PO-Revision-Date: 1990-08-03 12:00+0000
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	319 Last-Translator: John Doe <jd@example.com>
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	320 Language-Team: de_DE <LL@li.org>
84 3ae316b58231 Some cosmetic changes for the new translator comments support. cmlenz parents: 80 diff changeset	321 Plural-Forms: nplurals=2; plural=(n != 1)
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	322 MIME-Version: 1.0
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	323 Content-Type: text/plain; charset=utf-8
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	324 Content-Transfer-Encoding: 8bit
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	325 Generated-By: Babel ...
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	326
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	327 :type: `list`
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	328 """)
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	329
68 269941aa0e55 Add back POT header broken in previous check-in. cmlenz parents: 67 diff changeset	330 def num_plurals(self):
269941aa0e55 Add back POT header broken in previous check-in. cmlenz parents: 67 diff changeset	331 num = 2
269941aa0e55 Add back POT header broken in previous check-in. cmlenz parents: 67 diff changeset	332 if self.locale:
269941aa0e55 Add back POT header broken in previous check-in. cmlenz parents: 67 diff changeset	333 if str(self.locale) in PLURALS:
269941aa0e55 Add back POT header broken in previous check-in. cmlenz parents: 67 diff changeset	334 num = PLURALS[str(self.locale)][0]
269941aa0e55 Add back POT header broken in previous check-in. cmlenz parents: 67 diff changeset	335 elif self.locale.language in PLURALS:
269941aa0e55 Add back POT header broken in previous check-in. cmlenz parents: 67 diff changeset	336 num = PLURALS[self.locale.language][0]
269941aa0e55 Add back POT header broken in previous check-in. cmlenz parents: 67 diff changeset	337 return num
84 3ae316b58231 Some cosmetic changes for the new translator comments support. cmlenz parents: 80 diff changeset	338 num_plurals = property(num_plurals, doc="""\
3ae316b58231 Some cosmetic changes for the new translator comments support. cmlenz parents: 80 diff changeset	339 The number of plurals used by the locale.
103 dacfbaf0d1e0 Implement wrapping of header comments in PO(T) output. Related to #14. cmlenz parents: 97 diff changeset	340
dacfbaf0d1e0 Implement wrapping of header comments in PO(T) output. Related to #14. cmlenz parents: 97 diff changeset	341 >>> Catalog(locale='en').num_plurals
dacfbaf0d1e0 Implement wrapping of header comments in PO(T) output. Related to #14. cmlenz parents: 97 diff changeset	342 2
dacfbaf0d1e0 Implement wrapping of header comments in PO(T) output. Related to #14. cmlenz parents: 97 diff changeset	343 >>> Catalog(locale='cs_CZ').num_plurals
dacfbaf0d1e0 Implement wrapping of header comments in PO(T) output. Related to #14. cmlenz parents: 97 diff changeset	344 3
dacfbaf0d1e0 Implement wrapping of header comments in PO(T) output. Related to #14. cmlenz parents: 97 diff changeset	345
dacfbaf0d1e0 Implement wrapping of header comments in PO(T) output. Related to #14. cmlenz parents: 97 diff changeset	346 :type: `int`
84 3ae316b58231 Some cosmetic changes for the new translator comments support. cmlenz parents: 80 diff changeset	347 """)
68 269941aa0e55 Add back POT header broken in previous check-in. cmlenz parents: 67 diff changeset	348
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	349 def plural_forms(self):
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	350 num, expr = ('INTEGER', 'EXPRESSION')
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	351 if self.locale:
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	352 if str(self.locale) in PLURALS:
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	353 num, expr = PLURALS[str(self.locale)]
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	354 elif self.locale.language in PLURALS:
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	355 num, expr = PLURALS[self.locale.language]
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	356 return 'nplurals=%s; plural=%s' % (num, expr)
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	357 plural_forms = property(plural_forms, doc="""\
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	358 Return the plural forms declaration for the locale.
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	359
103 dacfbaf0d1e0 Implement wrapping of header comments in PO(T) output. Related to #14. cmlenz parents: 97 diff changeset	360 >>> Catalog(locale='en').plural_forms
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	361 'nplurals=2; plural=(n != 1)'
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	362 >>> Catalog(locale='pt_BR').plural_forms
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	363 'nplurals=2; plural=(n > 1)'
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	364
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	365 :type: `str`
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	366 """)
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	367
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	368 def __contains__(self, id):
7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	369 """Return whether the catalog has a message with the specified ID."""
69 af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	370 return self._key_for(id) in self._messages
af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	371
af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	372 def __len__(self):
84 3ae316b58231 Some cosmetic changes for the new translator comments support. cmlenz parents: 80 diff changeset	373 """The number of messages in the catalog.
3ae316b58231 Some cosmetic changes for the new translator comments support. cmlenz parents: 80 diff changeset	374
3ae316b58231 Some cosmetic changes for the new translator comments support. cmlenz parents: 80 diff changeset	375 This does not include the special ``msgid ""`` entry.
3ae316b58231 Some cosmetic changes for the new translator comments support. cmlenz parents: 80 diff changeset	376 """
69 af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	377 return len(self._messages)
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	378
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	379 def __iter__(self):
64 ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	380 """Iterates through all the entries in the catalog, in the order they
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	381 were added, yielding a `Message` object for every entry.
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	382
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	383 :rtype: ``iterator``
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	384 """
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	385 buf = []
104 395704fda00b Merged `write_pot` and `write_po` functions by moving more functionality to the `Catalog` class. This is certainly not perfect yet, but moves us in the right direction. cmlenz parents: 103 diff changeset	386 for name, value in self.mime_headers:
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	387 buf.append('%s: %s' % (name, value))
175 5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	388 if self.fuzzy:
5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	389 flags = set(['fuzzy'])
5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	390 else:
5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	391 flags = set()
5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	392 yield Message('', '\n'.join(buf), flags=flags)
69 af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	393 for key in self._messages:
af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	394 yield self._messages[key]
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	395
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	396 def __repr__(self):
64 ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	397 locale = ''
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	398 if self.locale:
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	399 locale = ' %s' % self.locale
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	400 return '<%s %r%s>' % (type(self).__name__, self.domain, locale)
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	401
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	402 def __delitem__(self, id):
64 ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	403 """Delete the message with the specified ID."""
69 af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	404 key = self._key_for(id)
af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	405 if key in self._messages:
af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	406 del self._messages[key]
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	407
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	408 def __getitem__(self, id):
64 ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	409 """Return the message with the specified ID.
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	410
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	411 :param id: the message ID
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	412 :return: the message with the specified ID, or `None` if no such message
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	413 is in the catalog
67 7b2fcd6d6d26 Enhance catalog to also manage the MIME headers. cmlenz parents: 64 diff changeset	414 :rtype: `Message`
64 ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	415 """
69 af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	416 return self._messages.get(self._key_for(id))
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	417
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	418 def __setitem__(self, id, message):
64 ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	419 """Add or update the message with the specified ID.
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	420
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	421 >>> catalog = Catalog()
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	422 >>> catalog[u'foo'] = Message(u'foo')
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	423 >>> catalog[u'foo']
175 5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	424 <Message u'foo' (Flags: '')>
64 ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	425
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	426 If a message with that ID is already in the catalog, it is updated
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	427 to include the locations and flags of the new message.
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	428
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	429 >>> catalog = Catalog()
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	430 >>> catalog[u'foo'] = Message(u'foo', locations=[('main.py', 1)])
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	431 >>> catalog[u'foo'].locations
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	432 [('main.py', 1)]
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	433 >>> catalog[u'foo'] = Message(u'foo', locations=[('utils.py', 5)])
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	434 >>> catalog[u'foo'].locations
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	435 [('main.py', 1), ('utils.py', 5)]
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	436
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	437 :param id: the message ID
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	438 :param message: the `Message` object
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	439 """
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	440 assert isinstance(message, Message), 'expected a Message object'
69 af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	441 key = self._key_for(id)
af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	442 current = self._messages.get(key)
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	443 if current:
69 af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	444 if message.pluralizable and not current.pluralizable:
af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	445 # The new message adds pluralization
af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	446 current.id = message.id
70 f016034ff635 Fix for mixed singular/plural messages, follow-up to [70]. cmlenz parents: 69 diff changeset	447 current.string = message.string
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	448 current.locations.extend(message.locations)
105 c62b68a0b65e `Message`, `read_po` and `write_po` now all handle user/auto comments correctly. palgarvio parents: 104 diff changeset	449 current.auto_comments.extend(message.auto_comments)
c62b68a0b65e `Message`, `read_po` and `write_po` now all handle user/auto comments correctly. palgarvio parents: 104 diff changeset	450 current.user_comments.extend(message.user_comments)
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	451 current.flags \|= message.flags
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	452 message = current
106 2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	453 elif id == '':
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	454 # special treatment for the header message
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	455 headers = message_from_string(message.string.encode(self.charset))
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	456 self.mime_headers = headers.items()
120 1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	457 self.header_comment = '\n'.join(['# %s' % comment for comment
1741953aafd8 Added tests for `new_catalog` distutils command. cmlenz parents: 107 diff changeset	458 in message.user_comments])
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	459 else:
f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	460 if isinstance(id, (list, tuple)):
68 269941aa0e55 Add back POT header broken in previous check-in. cmlenz parents: 67 diff changeset	461 assert isinstance(message.string, (list, tuple))
69 af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	462 self._messages[key] = message
56 f40fc143439c Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	463
105 c62b68a0b65e `Message`, `read_po` and `write_po` now all handle user/auto comments correctly. palgarvio parents: 104 diff changeset	464 def add(self, id, string=None, locations=(), flags=(), auto_comments=(),
c62b68a0b65e `Message`, `read_po` and `write_po` now all handle user/auto comments correctly. palgarvio parents: 104 diff changeset	465 user_comments=()):
64 ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	466 """Add or update the message with the specified ID.
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	467
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	468 >>> catalog = Catalog()
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	469 >>> catalog.add(u'foo')
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	470 >>> catalog[u'foo']
175 5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	471 <Message u'foo' (Flags: '')>
64 ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	472
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	473 This method simply constructs a `Message` object with the given
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	474 arguments and invokes `__setitem__` with that object.
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	475
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	476 :param id: the message ID, or a ``(singular, plural)`` tuple for
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	477 pluralizable messages
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	478 :param string: the translated message string, or a
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	479 ``(singular, plural)`` tuple for pluralizable messages
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	480 :param locations: a sequence of ``(filenname, lineno)`` tuples
ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	481 :param flags: a set or sequence of flags
106 2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	482 :param auto_comments: a sequence of automatic comments
2cd83f77cc98 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 105 diff changeset	483 :param user_comments: a sequence of user comments
64 ef318245cfe5 `read_po` now returns a `Catalog`. cmlenz parents: 61 diff changeset	484 """
105 c62b68a0b65e `Message`, `read_po` and `write_po` now all handle user/auto comments correctly. palgarvio parents: 104 diff changeset	485 self[id] = Message(id, string, list(locations), flags, auto_comments,
c62b68a0b65e `Message`, `read_po` and `write_po` now all handle user/auto comments correctly. palgarvio parents: 104 diff changeset	486 user_comments)
69 af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	487
165 628bc271ece4 Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 163 diff changeset	488 def update(self, template, fuzzy_matching=True):
163 f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	489 """Update the catalog based on the given template catalog.
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	490
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	491 >>> from babel.messages import Catalog
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	492 >>> template = Catalog()
188 96f858026208 Fix adding new messages in catalog update. cmlenz parents: 181 diff changeset	493 >>> template.add('green', locations=[('main.py', 99)])
163 f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	494 >>> template.add('blue', locations=[('main.py', 100)])
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	495 >>> template.add(('salad', 'salads'), locations=[('util.py', 42)])
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	496 >>> catalog = Catalog(locale='de_DE')
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	497 >>> catalog.add('blue', u'blau', locations=[('main.py', 98)])
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	498 >>> catalog.add('head', u'Kopf', locations=[('util.py', 33)])
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	499 >>> catalog.add(('salad', 'salads'), (u'Salat', u'Salate'),
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	500 ... locations=[('util.py', 38)])
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	501
181 8a762ce37bf7 The frontends now provide ways to update existing translations catalogs from a template. Closes #22. cmlenz parents: 175 diff changeset	502 >>> catalog.update(template)
163 f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	503 >>> len(catalog)
188 96f858026208 Fix adding new messages in catalog update. cmlenz parents: 181 diff changeset	504 3
163 f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	505
188 96f858026208 Fix adding new messages in catalog update. cmlenz parents: 181 diff changeset	506 >>> msg1 = catalog['green']
163 f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	507 >>> msg1.string
188 96f858026208 Fix adding new messages in catalog update. cmlenz parents: 181 diff changeset	508 >>> msg1.locations
96f858026208 Fix adding new messages in catalog update. cmlenz parents: 181 diff changeset	509 [('main.py', 99)]
96f858026208 Fix adding new messages in catalog update. cmlenz parents: 181 diff changeset	510
96f858026208 Fix adding new messages in catalog update. cmlenz parents: 181 diff changeset	511 >>> msg2 = catalog['blue']
96f858026208 Fix adding new messages in catalog update. cmlenz parents: 181 diff changeset	512 >>> msg2.string
163 f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	513 u'blau'
188 96f858026208 Fix adding new messages in catalog update. cmlenz parents: 181 diff changeset	514 >>> msg2.locations
163 f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	515 [('main.py', 100)]
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	516
188 96f858026208 Fix adding new messages in catalog update. cmlenz parents: 181 diff changeset	517 >>> msg3 = catalog['salad']
96f858026208 Fix adding new messages in catalog update. cmlenz parents: 181 diff changeset	518 >>> msg3.string
163 f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	519 (u'Salat', u'Salate')
188 96f858026208 Fix adding new messages in catalog update. cmlenz parents: 181 diff changeset	520 >>> msg3.locations
163 f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	521 [('util.py', 42)]
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	522
181 8a762ce37bf7 The frontends now provide ways to update existing translations catalogs from a template. Closes #22. cmlenz parents: 175 diff changeset	523 Messages that are in the catalog but not in the template are removed
8a762ce37bf7 The frontends now provide ways to update existing translations catalogs from a template. Closes #22. cmlenz parents: 175 diff changeset	524 from the main collection, but can still be accessed via the `obsolete`
8a762ce37bf7 The frontends now provide ways to update existing translations catalogs from a template. Closes #22. cmlenz parents: 175 diff changeset	525 member:
8a762ce37bf7 The frontends now provide ways to update existing translations catalogs from a template. Closes #22. cmlenz parents: 175 diff changeset	526
163 f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	527 >>> 'head' in catalog
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	528 False
181 8a762ce37bf7 The frontends now provide ways to update existing translations catalogs from a template. Closes #22. cmlenz parents: 175 diff changeset	529 >>> catalog.obsolete.values()
175 5d32098d8352 Changed the `__repr__` output to include the flags(it can be changed back, but it was usefull to implement the fuzzy header parsing). palgarvio parents: 165 diff changeset	530 [<Message 'head' (Flags: '')>]
163 f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	531
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	532 :param template: the reference catalog, usually read from a POT file
165 628bc271ece4 Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 163 diff changeset	533 :param fuzzy_matching: whether to use fuzzy matching of message IDs
163 f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	534 """
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	535 messages = self._messages
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	536 self._messages = odict()
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	537
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	538 for message in template:
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	539 if message.id:
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	540 key = self._key_for(message.id)
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	541 if key in messages:
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	542 oldmsg = messages.pop(key)
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	543 message.string = oldmsg.string
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	544 message.flags \|= oldmsg.flags
f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	545 self[message.id] = message
165 628bc271ece4 Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 163 diff changeset	546
163 f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	547 else:
165 628bc271ece4 Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 163 diff changeset	548 if fuzzy_matching:
628bc271ece4 Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 163 diff changeset	549 # do some fuzzy matching with difflib
628bc271ece4 Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 163 diff changeset	550 matches = get_close_matches(key.lower().strip(),
628bc271ece4 Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 163 diff changeset	551 [self._key_for(msgid) for msgid in messages], 1)
628bc271ece4 Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 163 diff changeset	552 if matches:
628bc271ece4 Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 163 diff changeset	553 oldmsg = messages.pop(matches[0])
628bc271ece4 Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 163 diff changeset	554 message.string = oldmsg.string
628bc271ece4 Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 163 diff changeset	555 message.flags \|= oldmsg.flags \| set([u'fuzzy'])
628bc271ece4 Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 163 diff changeset	556 self[message.id] = message
188 96f858026208 Fix adding new messages in catalog update. cmlenz parents: 181 diff changeset	557 continue
163 f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	558
165 628bc271ece4 Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 163 diff changeset	559 self[message.id] = message
628bc271ece4 Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 163 diff changeset	560
181 8a762ce37bf7 The frontends now provide ways to update existing translations catalogs from a template. Closes #22. cmlenz parents: 175 diff changeset	561 self.obsolete = messages
163 f4ac63f27697 Added preliminary catalog updating/merging functionality. cmlenz parents: 149 diff changeset	562
69 af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	563 def _key_for(self, id):
af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	564 """The key for a message is just the singular ID even for pluralizable
af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	565 messages.
af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	566 """
af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	567 key = id
af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	568 if isinstance(key, (list, tuple)):
af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	569 key = id[0]
af75520471ed Message catalogs can have multiple messages with the same ID, where some of them have plural strings, and others don't. Still the same message. cmlenz parents: 68 diff changeset	570 return key

Mercurial > babel > mirror

annotate babel/messages/catalog.py @ 188:96f858026208 trunk