babel/old/babel-test: babel/messages/catalog.py annotate

annotate babel/messages/catalog.py @ 198:74a346c7846d

Correctly handle non-ASCII chars in the catalog MIME headers.

author	cmlenz
date	Tue, 03 Jul 2007 16:01:41 +0000
parents	93a922d31eca
children	2983c718f6e2

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

Mercurial > babel > old > babel-test

annotate babel/messages/catalog.py @ 198:74a346c7846d