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

annotate babel/messages/catalog.py @ 198:982d7e704fdc

Fix for #35, and a minor improvement to how we parse the catalog fuzzy bit.

author	cmlenz
date	Tue, 03 Jul 2007 12:52:44 +0000
parents	f5780e72eefc
children	2f0161df6a38

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

Mercurial > babel > old > mirror

annotate babel/messages/catalog.py @ 198:982d7e704fdc